Skip to content

Interface: PackDefinition

core.PackDefinition

Deprecated

use #PackVersionDefinition

The legacy complete definition of a Pack including un-versioned metadata. This should only be used by legacy Coda pack implementations.

Hierarchy

PackDefinition

Properties

category

Optional category: PackCategory

Defined in

types.ts:913


defaultAuthentication

Optional defaultAuthentication: Authentication

If specified, the user must provide personal authentication credentials before using the pack.

Inherited from

PackVersionDefinition.defaultAuthentication

Defined in

types.ts:860


description

description: string

Defined in

types.ts:911


exampleImages

Optional exampleImages: string[]

Defined in

types.ts:915


exampleVideoIds

Optional exampleVideoIds: string[]

Defined in

types.ts:916


formats

Optional formats: Format[]

Definitions of this pack's column formats. See Format.

Inherited from

PackVersionDefinition.formats

Defined in

types.ts:894


formulaNamespace

Optional formulaNamespace: string

Deprecated

Inherited from

PackVersionDefinition.formulaNamespace

Defined in

types.ts:882


formulas

Optional formulas: (BooleanPackFormula<ParamDefs> | NumericPackFormula<ParamDefs> | StringPackFormula<ParamDefs> | ObjectPackFormula<ParamDefs, ArraySchema<Schema>> | ObjectPackFormula<ParamDefs, Schema>)[]

Definitions of this pack's formulas. See Formula.

Note that button actions are also defined here. Buttons are simply formulas with isAction: true.

Inherited from

PackVersionDefinition.formulas

Defined in

types.ts:890


id

id: number

Defined in

types.ts:908


isSystem

Optional isSystem: boolean

Whether this is a pack that will be used by Coda internally and not exposed directly to users.

Defined in

types.ts:923


logoPath

logoPath: string

Defined in

types.ts:914


minimumFeatureSet

Optional minimumFeatureSet: FeatureSet

Defined in

types.ts:917


name

name: string

Defined in

types.ts:909


networkDomains

Optional networkDomains: string[]

Any domain(s) to which this pack makes fetcher requests. The domains this pack connects to must be declared up front here, both to clearly communicate to users what a pack is capable of connecting to, and for security reasons. These network domains are enforced at execution time: any fetcher request to a domain not listed here will be rejected.

Only one network domain is allowed by default. If your pack has needs to connect to multiple domains contact Coda support for approval.

Inherited from

PackVersionDefinition.networkDomains

Defined in

types.ts:875


permissionsDescription

Optional permissionsDescription: string

Defined in

types.ts:912


quotas

Optional quotas: Partial<{ Basic: Quota ; Enterprise: Quota ; Pro: Quota ; Team: Quota }>

Defined in

types.ts:918


rateLimits

Optional rateLimits: RateLimits

Defined in

types.ts:919


shortDescription

shortDescription: string

Defined in

types.ts:910


syncTables

Optional syncTables: SyncTable[]

Definitions of this pack's sync tables. See SyncTable.

Inherited from

PackVersionDefinition.syncTables

Defined in

types.ts:898


systemConnectionAuthentication

Optional systemConnectionAuthentication: SystemAuthentication

If specified, this pack requires system credentials to be set up via Coda's admin console in order to work when no explicit connection is specified by the user.

Inherited from

PackVersionDefinition.systemConnectionAuthentication

Defined in

types.ts:865


version

version: string

The semantic version of the pack. This must be valid semantic version of the form 1, 1.2, or 1.2.3. When uploading a pack version, the semantic version must be greater than any previously uploaded version.

Inherited from

PackVersionDefinition.version

Defined in

types.ts:856