codapack-dev/references/index.yaml

593 lines
22 KiB
YAML

---
# Coda Pack SDK Documentation Structure
# Complete file tree of all documentation (370+ files)
root: docs/
structure:
# Main landing page
index.md: Home page
# Agents section
agents:
index.md: Agents overview
development.md: Agent development
examples.md: Agent examples
quickstart.md: Agent quickstart
troubleshooting.md: Agent troubleshooting
upgrade.md: Agent upgrade guide
features:
chat.md: Chat features
context.md: Context management
mcp.md: MCP (Model Context Protocol)
skills.md: Skills system
tools.md: Agent tools
indexing:
index.md: Indexing overview
crawling.md: Content crawling
incremental.md: Incremental indexing
schema.md: Index schema
# Blog
blog:
index.md: Blog index
posts:
new_agent_features.md: New agent features announcement
# Guides - main documentation
guides:
overview.md: Pack development overview
design.md: Pack design guidelines
best-practices.md: Best practices
# Basics
basics:
data-types.md: Working with data types
fetcher.md: Making HTTP requests
authentication:
index.md: Authentication overview
oauth2.md: OAuth2 authentication
aws.md: AWS authentication
parameters:
index.md: Parameters overview
autocomplete.md: Parameter autocomplete
# Building blocks
blocks:
formulas.md: Creating formulas
actions.md: Building actions
cards.md: Creating cards
column-formats.md: Custom column formats
sync-tables:
index.md: Sync tables overview
dynamic.md: Dynamic sync tables
two-way.md: Two-way sync
# Advanced topics
advanced:
schemas.md: Advanced schema patterns
caching.md: Caching strategies
errors.md: Error handling
images.md: Working with images
embeds.md: Embedded content
timezones.md: Timezone handling
.card_schema.md: Card schema (internal)
# Development
development:
cli.md: Command line interface
testing.md: Testing packs
troubleshooting.md: Troubleshooting
libraries.md: Using libraries
pack-maker-tools.md: Pack maker tools
versions.md: Version management
# Tutorials
tutorials:
index.md: Tutorials index
videos.md: Video tutorials
get-started:
web.md: Web IDE tutorial
cli.md: CLI tutorial
github.md: GitHub development
gitpod.md: Gitpod development
replit.md: Replit development
.cli.md: CLI (internal)
.cli-before.md: CLI setup (internal)
.cli-test.md: CLI testing (internal)
.rebuild.md: Rebuild (internal)
.use.md: Usage (internal)
build:
formula.md: Building formulas
fetcher.md: Using fetcher
sync-table.md: Building sync tables
oauth.md: Implementing OAuth
# Code samples
samples:
index.md: Samples index
# Full pack examples
full:
hello-world.md: Hello World pack
cats.md: Cat photos pack
math.md: Math pack
github.md: GitHub pack
todoist.md: Todoist pack
daylight.md: Daylight pack
dnd.md: D&D pack
# Topic-specific samples
topic:
formula.md: Formula examples
action.md: Action examples
sync-table.md: Sync table examples
dynamic-sync-table.md: Dynamic sync table examples
two-way.md: Two-way sync examples
authentication.md: Authentication examples
fetcher.md: Fetcher examples
parameter.md: Parameter examples
autocomplete.md: Autocomplete examples
schema.md: Schema examples
data-type.md: Data type examples
column-format.md: Column format examples
card.md: Card examples
image.md: Image examples
dates.md: Date handling examples
apis.md: API integration examples
# SDK Reference
reference:
sdk:
index.md: SDK reference index
# Core SDK
core:
index.md: Core SDK index
# Classes
classes:
PackDefinitionBuilder.md: Pack definition builder
UserVisibleError.md: User visible error
StatusCodeError.md: Status code error
MissingScopesError.md: Missing scopes error
ResponseSizeTooLargeError.md: Response size error
# Enumerations
enumerations:
AuthenticationType.md: Authentication types
ParameterType.md: Parameter types
ValueType.md: Value types
ValueHintType.md: Value hint types
ConnectionRequirement.md: Connection requirements
Type.md: Schema types
HttpStatusCode.md: HTTP status codes
InvocationErrorType.md: Invocation error types
InvocationSource.md: Invocation sources
PostSetupType.md: Post-setup types
OptionsType.md: Options types
NetworkConnection.md: Network connection types
PermissionSyncMode.md: Permission sync modes
EmbeddedContentType.md: Embedded content types
AttributionNodeType.md: Attribution node types
LinkDisplayType.md: Link display types
EmailDisplayType.md: Email display types
CurrencyFormat.md: Currency formats
DurationUnit.md: Duration units
PrecannedDateRange.md: Precanned date ranges
ImageCornerStyle.md: Image corner styles
ImageOutline.md: Image outlines
ImageShapeStyle.md: Image shape styles
ScaleIconSet.md: Scale icon sets
ToolType.md: Tool types
TokenExchangeCredentialsLocation.md: Token exchange locations
ScreenAnnotationType.md: Screen annotation types
KnowledgeToolSourceType.md: Knowledge tool source types
SkillModel.md: Skill models
# Functions
functions:
newPack.md: Create new pack
makeFormula.md: Make formula
makeParameter.md: Make parameter
makeSchema.md: Make schema
makeObjectSchema.md: Make object schema
makeSyncTable.md: Make sync table
makeDynamicSyncTable.md: Make dynamic sync table
makeMetadataFormula.md: Make metadata formula
makeEmptyFormula.md: Make empty formula
makeAttributionNode.md: Make attribution node
makeReferenceSchemaFromObjectSchema.md: Make reference schema
makeTranslateObjectFormula.md: Make translate object formula
makeSimpleAutocompleteMetadataFormula.md: Simple autocomplete metadata
simpleAutocomplete.md: Simple autocomplete
autocompleteSearchObjects.md: Autocomplete search objects
generateSchema.md: Generate schema
getEffectivePropertyKeysFromSchema.md: Get effective property keys
joinUrl.md: Join URL
getQueryParams.md: Get query params
withQueryParams.md: With query params
withIdentity.md: With identity
assertCondition.md: Assert condition
ensureExists.md: Ensure exists
ensureNonEmptyString.md: Ensure non-empty string
ensureUnreachable.md: Ensure unreachable
# Interfaces (100+ interfaces)
interfaces:
# Core interfaces
PackDefinition.md: Pack definition
PackVersionDefinition.md: Pack version definition
ExecutionContext.md: Execution context
SyncExecutionContext.md: Sync execution context
UpdateSyncExecutionContext.md: Update sync execution context
Fetcher.md: Fetcher interface
FetchRequest.md: Fetch request
FetchResponse.md: Fetch response
Network.md: Network interface
TemporaryBlobStorage.md: Temporary blob storage
InvocationLocation.md: Invocation location
# Formula interfaces
BaseFormulaDef.md: Base formula definition
CommonPackFormulaDef.md: Common pack formula definition
PackFormulaDef.md: Pack formula definition
ObjectArrayFormulaDef.md: Object array formula definition
EmptyFormulaDef.md: Empty formula definition
MetadataFormulaObjectResultType.md: Metadata formula result type
# Parameter interfaces
ParamDef.md: Parameter definition
RequiredParamDef.md: Required parameter
OptionalParamDef.md: Optional parameter
CustomAuthParameter.md: Custom auth parameter
DynamicOptions.md: Dynamic options
PropertyWithOptions.md: Property with options
PropertyOptionsExecutionContext.md: Property options context
# Schema interfaces
ObjectSchemaDefinition.md: Object schema definition
ObjectSchemaProperty.md: Object schema property
ArraySchema.md: Array schema
BooleanSchema.md: Boolean schema
NumericSchema.md: Numeric schema
StringEmbedSchema.md: String embed schema
SimpleStringSchema.md: Simple string schema
StringWithOptionsSchema.md: String with options
ImageSchema.md: Image schema
LinkSchema.md: Link schema
EmailSchema.md: Email schema
CurrencySchema.md: Currency schema
DurationSchema.md: Duration schema
NumericDurationSchema.md: Numeric duration schema
StringDateSchema.md: String date schema
StringDateTimeSchema.md: String datetime schema
StringTimeSchema.md: String time schema
NumericDateSchema.md: Numeric date schema
NumericDateTimeSchema.md: Numeric datetime schema
NumericTimeSchema.md: Numeric time schema
ProgressBarSchema.md: Progress bar schema
ScaleSchema.md: Scale schema
SliderSchema.md: Slider schema
ArrayType.md: Array type
Format.md: Format interface
# Authentication interfaces
BaseAuthentication.md: Base authentication
NoAuthentication.md: No authentication
CustomAuthentication.md: Custom authentication
CustomHeaderTokenAuthentication.md: Custom header token
HeaderBearerTokenAuthentication.md: Header bearer token
MultiHeaderTokenAuthentication.md: Multi-header token
QueryParamTokenAuthentication.md: Query param token
MultiQueryParamTokenAuthentication.md: Multi-query param token
WebBasicAuthentication.md: Web basic auth
OAuth2Authentication.md: OAuth2 authentication
OAuth2ClientCredentialsAuthentication.md: OAuth2 client credentials
CodaApiBearerTokenAuthentication.md: Coda API bearer token
AWSAccessKeyAuthentication.md: AWS access key
AWSAssumeRoleAuthentication.md: AWS assume role
# Sync table interfaces
SyncTableDef.md: Sync table definition
SyncTableOptions.md: Sync table options
SyncFormulaDef.md: Sync formula definition
SyncFormulaResult.md: Sync formula result
DynamicSyncTableDef.md: Dynamic sync table definition
DynamicSyncTableOptions.md: Dynamic sync table options
SyncBase.md: Sync base
SyncFull.md: Full sync
SyncIncremental.md: Incremental sync
SyncUpdate.md: Sync update
UpdateSync.md: Update sync
SyncUpdateResult.md: Sync update result
SyncTableRelation.md: Sync table relation
SyncCompletionMetadata.md: Sync completion metadata
SyncCompletionMetadataIncomplete.md: Incomplete sync metadata
# Identity and indexing
Identity.md: Identity interface
IdentityDefinition.md: Identity definition
PropertyIdentifierDetails.md: Property identifier details
CustomIndexDefinition.md: Custom index definition
CrawlStrategy.md: Crawl strategy
# Embedded content
EmbeddedContentTool.md: Embedded content tool
CopyableBlockEmbeddedContent.md: Copyable block content
CarouselViewEmbeddedContent.md: Carousel view content
TabViewEmbeddedContent.md: Tab view content
# Attribution
ImageAttributionNode.md: Image attribution node
LinkAttributionNode.md: Link attribution node
TextAttributionNode.md: Text attribution node
# Tools and skills
PackTool.md: Pack tool
ContactResolutionTool.md: Contact resolution tool
KnowledgeTool.md: Knowledge tool
PackKnowledgeToolSource.md: Pack knowledge source
ScreenAnnotationTool.md: Screen annotation tool
RewriteScreenAnnotation.md: Rewrite screen annotation
Skill.md: Skill interface
SkillEntrypoints.md: Skill entrypoints
SkillEntrypointConfig.md: Skill entrypoint config
SkillModelConfiguration.md: Skill model configuration
MCPServer.md: MCP server interface
# Validation and errors
ParameterValidationDetail.md: Parameter validation detail
ValidParameterValidationResult.md: Valid parameter validation
InvalidParameterValidationResult.md: Invalid parameter validation
StatusCodeErrorResponse.md: Status code error response
# Post-setup and endpoints
SetEndpoint.md: Set endpoint
RequestHandlerTemplate.md: Request handler template
ResponseHandlerTemplate.md: Response handler template
# Autocomplete
SimpleAutocompleteOption.md: Simple autocomplete option
# Continuation
Continuation.md: Continuation interface
# Type aliases (100+ type aliases)
type-aliases:
# Formula type aliases
Formula.md: Formula type
BaseFormula.md: Base formula
PackFormulaResult.md: Pack formula result
PackFormulaValue.md: Pack formula value
StringFormulaDef.md: String formula definition
NumericFormulaDef.md: Numeric formula definition
BooleanFormulaDef.md: Boolean formula definition
ArrayFormulaDef.md: Array formula definition
ObjectFormulaDef.md: Object formula definition
TypedPackFormula.md: Typed pack formula
StringPackFormula.md: String pack formula
NumericPackFormula.md: Numeric pack formula
BooleanPackFormula.md: Boolean pack formula
ObjectPackFormula.md: Object pack formula
# Schema type aliases
Schema.md: Schema type
SchemaType.md: Schema type enum
NumberSchema.md: Number schema
StringSchema.md: String schema
StringHintTypes.md: String hint types
NumberHintTypes.md: Number hint types
BooleanHintTypes.md: Boolean hint types
ObjectHintTypes.md: Object hint types
ObjectSchemaProperties.md: Object schema properties
PropertySchemaOptions.md: Property schema options
# Sync table type aliases
SyncTable.md: Sync table
GenericSyncTable.md: Generic sync table
GenericDynamicSyncTable.md: Generic dynamic sync table
SyncFormula.md: Sync formula
GenericSyncFormula.md: Generic sync formula
GenericSyncFormulaResult.md: Generic sync formula result
Sync.md: Sync type
SyncCompletionMetadataResult.md: Sync completion metadata result
GenericSyncUpdate.md: Generic sync update
GenericSyncUpdateSingleResult.md: Generic sync update single
SyncUpdateSingleResult.md: Sync update single result
# Authentication type aliases
Authentication.md: Authentication type
AuthenticationDef.md: Authentication definition
SystemAuthentication.md: System authentication
SystemAuthenticationDef.md: System authentication definition
UserAuthenticationDef.md: User authentication definition
# Metadata type aliases
MetadataFormula.md: Metadata formula
MetadataFormulaDef.md: Metadata formula definition
MetadataFormulaResultType.md: Metadata formula result
MetadataFunction.md: Metadata function
MetadataContext.md: Metadata context
LegacyDefaultMetadataReturnType.md: Legacy metadata return
PropertyOptionsMetadataFunction.md: Property options metadata function
PropertyOptionsMetadataResult.md: Property options metadata result
# Parameter type aliases
ParamDefs.md: Parameter definitions
ParamValues.md: Parameter values
ParameterOptions.md: Parameter options
ParameterValidationResult.md: Parameter validation result
ParamDefFromOptionsUnion.md: Param def from options
SuggestedValueType.md: Suggested value type
# Pack definition type aliases
BasicPackDefinition.md: Basic pack definition
PackId.md: Pack ID
# Error type aliases
InvocationError.md: Invocation error
HttpStatusInvocationError.md: HTTP status error
TimeoutInvocationError.md: Timeout error
RateLimitExceededInvocationError.md: Rate limit error
ResponseTooLargeInvocationError.md: Response too large error
UnknownInvocationError.md: Unknown error
# Formula options type aliases
FormulaDefinitionOptions.md: Formula definition options
FormulaOptions.md: Formula options
# Post-setup type aliases
PostSetup.md: Post-setup type
PostSetupDef.md: Post-setup definition
SetEndpointDef.md: Set endpoint definition
# Attribution type aliases
AttributionNode.md: Attribution node
# Embedded content type aliases
EmbeddedContent.md: Embedded content type
# Indexing type aliases
IndexDefinition.md: Index definition
BasicIndexedProperty.md: Basic indexed property
IndexedProperty.md: Indexed property
FilterableProperty.md: Filterable property
PropertyIdentifier.md: Property identifier
# Context type aliases
ContextProperties.md: Context properties
# Screen annotation type aliases
ScreenAnnotation.md: Screen annotation
# Knowledge tool type aliases
KnowledgeToolSource.md: Knowledge tool source
# Skills type aliases
PartialSkillDef.md: Partial skill definition
# Fetch type aliases
FetchMethodType.md: Fetch method type
# Inference type aliases
InferrableTypes.md: Inferrable types
# Variables
variables:
PropertyLabelValueTemplate.md: Property label value template
ValidFetchMethods.md: Valid fetch methods
# Namespaces
namespaces:
SvgConstants:
index.md: SVG constants
variables:
DataUrlPrefix.md: Data URL prefix
DataUrlPrefixWithDarkModeSupport.md: Data URL with dark mode
DarkModeFragmentId.md: Dark mode fragment ID
# Testing SDK
testing:
index.md: Testing SDK index
# Testing functions
functions:
executeFormulaFromPackDef.md: Execute formula from pack
executeFormulaOrSyncWithVM.md: Execute with VM
executeSyncFormula.md: Execute sync formula
executeSyncFormulaFromPackDef.md: Execute sync from pack
executeSyncFormulaFromPackDefSingleIteration.md: Execute single iteration
executeMetadataFormula.md: Execute metadata formula
newMockExecutionContext.md: New mock execution context
newMockSyncExecutionContext.md: New mock sync context
newRealFetcherExecutionContext.md: New real fetcher context
newRealFetcherSyncExecutionContext.md: New real fetcher sync context
newJsonFetchResponse.md: New JSON fetch response
# Testing interfaces
interfaces:
MockExecutionContext.md: Mock execution context
MockSyncExecutionContext.md: Mock sync execution context
ExecuteOptions.md: Execute options
ContextOptions.md: Context options
# Testing type aliases
type-aliases:
SyncExecutionContextAsMock.md: Sync execution context as mock
# Support
support:
index.md: Support index
faq.md: Frequently asked questions
errors.md: Common errors
changes.md: Changelog
contributing:
index.md: Contributing guide
style.md: Style guide
migration:
index.md: Migration guide
v0.11.0.md: Migrate to v0.11.0
# Quick reference paths
quick_paths:
# Getting started
getting_started: docs/tutorials/get-started/web.md
overview: docs/guides/overview.md
# Core building blocks
formulas: docs/guides/blocks/formulas.md
actions: docs/guides/blocks/actions.md
sync_tables: docs/guides/blocks/sync-tables/index.md
dynamic_sync_tables: docs/guides/blocks/sync-tables/dynamic.md
two_way_sync: docs/guides/blocks/sync-tables/two-way.md
column_formats: docs/guides/blocks/column-formats.md
cards: docs/guides/blocks/cards.md
# Basics
authentication: docs/guides/basics/authentication/index.md
oauth2: docs/guides/basics/authentication/oauth2.md
fetcher: docs/guides/basics/fetcher.md
data_types: docs/guides/basics/data-types.md
parameters: docs/guides/basics/parameters/index.md
autocomplete: docs/guides/basics/parameters/autocomplete.md
# Advanced
schemas: docs/guides/advanced/schemas.md
caching: docs/guides/advanced/caching.md
errors: docs/guides/advanced/errors.md
images: docs/guides/advanced/images.md
embeds: docs/guides/advanced/embeds.md
timezones: docs/guides/advanced/timezones.md
# Development
cli: docs/guides/development/cli.md
testing: docs/guides/development/testing.md
troubleshooting: docs/guides/development/troubleshooting.md
libraries: docs/guides/development/libraries.md
versions: docs/guides/development/versions.md
# SDK Reference
sdk_core: docs/reference/sdk/core/index.md
sdk_testing: docs/reference/sdk/testing/index.md
new_pack: docs/reference/sdk/core/functions/newPack.md
make_formula: docs/reference/sdk/core/functions/makeFormula.md
make_sync_table: docs/reference/sdk/core/functions/makeSyncTable.md
make_dynamic_sync_table: docs/reference/sdk/core/functions/makeDynamicSyncTable.md
# Samples
samples_index: docs/samples/index.md
hello_world: docs/samples/full/hello-world.md
formula_samples: docs/samples/topic/formula.md
sync_table_samples: docs/samples/topic/sync-table.md
auth_samples: docs/samples/topic/authentication.md
# Support
faq: docs/support/faq.md
best_practices: docs/guides/best-practices.md
design: docs/guides/design.md
# Statistics
total_files: 370
total_directories: 40