Module: Core¶
The core components of the Pack SDK. These functions and types are used to define your Pack, its building blocks, and their logic.
This module is imported using the following code:
import * as sdk from "@codahq/packs-sdk";
Namespaces¶
Enumerations¶
- AttributionNodeType
- AuthenticationType
- ConnectionRequirement
- CurrencyFormat
- DataIndexing
- DurationUnit
- EmailDisplayType
- HttpStatusCode
- ImageCornerStyle
- ImageOutline
- ImageShapeStyle
- InvocationErrorType
- InvocationSource
- KnowledgeToolSourceType
- LinkDisplayType
NetworkConnection- OptionsType
- ParameterType
- PermissionSyncMode
- PostSetupType
- PrecannedDateRange
- ScaleIconSet
- ScreenAnnotationType
- SkillModel
- TokenExchangeCredentialsLocation
- ToolType
- Type
- ValueHintType
- ValueType
Classes¶
Interfaces¶
- ArraySchema
- ArrayType
- AWSAccessKeyAuthentication
- AWSAssumeRoleAuthentication
- BaseAuthentication
- BaseFormulaDef
- BooleanSchema
- CodaApiBearerTokenAuthentication
- CommonPackFormulaDef
- ContactResolutionTool
- Continuation
- CrawlStrategy
- CurrencySchema
- CustomAuthentication
- CustomAuthParameter
- CustomHeaderTokenAuthentication
- CustomIndexDefinition
- DurationSchema
- DynamicOptions
- DynamicSyncTableDef
- DynamicSyncTableOptions
- EmailSchema
- EmptyFormulaDef
- ExecutionContext
- Fetcher
- FetchRequest
- FetchResponse
- Format
- HeaderBearerTokenAuthentication
- Identity
- IdentityDefinition
- ImageAttributionNode
- ImageSchema
- InvalidParameterValidationResult
- InvocationLocation
- KnowledgeTool
- LinkAttributionNode
- LinkSchema
- MCPServer
- MCPTool
- MetadataFormulaObjectResultType
- MultiHeaderTokenAuthentication
- MultiQueryParamTokenAuthentication
Network- NoAuthentication
- NumericDateSchema
- NumericDateTimeSchema
- NumericDurationSchema
- NumericSchema
- NumericTimeSchema
- OAuth2ClientCredentialsAuthentication
- OAuth2DynamicCodeAuthentication
- OAuth2StaticCodeAuthentication
- ObjectArrayFormulaDef
- ObjectSchemaDefinition
- ObjectSchemaProperty
- OptionalParamDef
PackDefinition- PackFormulaDef
- PackKnowledgeToolSource
- PackTool
- PackVersionDefinition
- ParamDef
- ParameterValidationDetail
- ProgressBarSchema
- PropertyIdentifierDetails
- PropertyOptionsExecutionContext
- PropertyWithOptions
- QueryParamTokenAuthentication
- RequestHandlerTemplate
- RequiredParamDef
- ResponseHandlerTemplate
- RewriteScreenAnnotation
- ScaleSchema
- ScreenAnnotationTool
- SetEndpoint
- SimpleAutocompleteOption
- SimpleStringSchema
- Skill
SkillEntrypointConfigSkillEntrypoints- SkillModelConfiguration
- SliderSchema
- StatusCodeErrorResponse
- StringDateSchema
- StringDateTimeSchema
- StringEmbedSchema
- StringTimeSchema
- StringWithOptionsSchema
SuggestedPrompt- SyncBase
- SyncCompletionMetadata
- SyncCompletionMetadataIncomplete
- SyncExecutionContext
- SyncFormulaDef
- SyncFormulaResult
- SyncFull
- SyncIncremental
- SyncTableDef
- SyncTableOptions
- SyncTableRelation
- SyncUpdate
- SyncUpdateResult
- TemporaryBlobStorage
- TextAttributionNode
- UpdateSync
- UpdateSyncExecutionContext
- ValidParameterValidationResult
- WebBasicAuthentication
- WebSearchTool
Type Aliases¶
- ArrayFormulaDef
- AttributionNode
- Authentication
- AuthenticationDef
- BaseFormula
- BasicIndexedProperty
- BasicPackDefinition
- BooleanFormulaDef
- BooleanHintTypes
- BooleanPackFormula
- ContextProperties
- FetchMethodType
- FilterableProperty
- Formula
- FormulaDefinitionOptions
- FormulaOptions
- GenericDynamicSyncTable
- GenericSyncFormula
- GenericSyncFormulaResult
- GenericSyncTable
- GenericSyncUpdate
- GenericSyncUpdateSingleResult
- HttpStatusInvocationError
- IndexDefinition
- IndexedProperty
- InferrableTypes
- InvocationError
- KnowledgeToolSource
- LegacyDefaultMetadataReturnType
- MetadataContext
- MetadataFormula
- MetadataFormulaDef
- MetadataFormulaResultType
- MetadataFunction
- NumberHintTypes
- NumberSchema
- NumericFormulaDef
- NumericPackFormula
- OAuth2Authentication
- ObjectFormulaDef
- ObjectHintTypes
- ObjectPackFormula
- ObjectSchemaProperties
- PackFormulaResult
- PackFormulaValue
PackId- ParamDefFromOptionsUnion
- ParamDefs
- ParameterOptions
- ParameterValidationResult
- ParamValues
PartialSkillDef- PostSetup
- PostSetupDef
- PropertyIdentifier
- PropertyOptionsMetadataFunction
- PropertyOptionsMetadataResult
- PropertySchemaOptions
- RateLimitExceededInvocationError
- ResponseTooLargeInvocationError
- Schema
- SchemaType
- ScreenAnnotation
- SetEndpointDef
- StringFormulaDef
- StringHintTypes
- StringPackFormula
- StringSchema
- SuggestedValueType
- Sync
- SyncCompletionMetadataResult
- SyncFormula
- SyncTable
- SyncUpdateSingleResult
- SystemAuthentication
- SystemAuthenticationDef
- TimeoutInvocationError
- TypedPackFormula
- UnknownInvocationError
- UserAuthenticationDef
Variables¶
Functions¶
- assertCondition
- autocompleteSearchObjects
- ensureExists
- ensureNonEmptyString
- ensureUnreachable
- generateSchema
- getEffectivePropertyKeysFromSchema
- getQueryParams
- joinUrl
- makeAttributionNode
- makeDynamicSyncTable
- makeEmptyFormula
- makeFormula
- makeMetadataFormula
- makeObjectSchema
- makeParameter
- makeReferenceSchemaFromObjectSchema
- makeSchema
makeSimpleAutocompleteMetadataFormula- makeSyncTable
- makeTranslateObjectFormula
- newPack
- simpleAutocomplete
- withIdentity
- withQueryParams