Skip to content

Class: PackDefinitionBuilder

core.PackDefinitionBuilder

A class that assists in constructing a pack definition. Use newPack to create one.

Implements

Constructors

constructor

new PackDefinitionBuilder(definition?)

Constructs a PackDefinitionBuilder. However, coda.newPack() should be used instead rather than constructing a builder directly.

Parameters

Name Type
definition? Partial<PackVersionDefinition>

Defined in

builder.ts:86

Properties

defaultAuthentication

Optional defaultAuthentication: Authentication

See defaultAuthentication.

Implementation of

BasicPackDefinition.defaultAuthentication

Defined in

builder.ts:67


formats

formats: Format[]

See formats.

Implementation of

BasicPackDefinition.formats

Defined in

builder.ts:54


formulaNamespace

Optional formulaNamespace: string

Deprecated

Implementation of

BasicPackDefinition.formulaNamespace

Defined in

builder.ts:78


formulas

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

See formulas.

Implementation of

BasicPackDefinition.formulas

Defined in

builder.ts:50


networkDomains

networkDomains: string[]

See networkDomains.

Implementation of

BasicPackDefinition.networkDomains

Defined in

builder.ts:62


syncTables

syncTables: SyncTable[]

See syncTables.

Implementation of

BasicPackDefinition.syncTables

Defined in

builder.ts:58


systemConnectionAuthentication

Optional systemConnectionAuthentication: SystemAuthentication

See systemConnectionAuthentication.

Implementation of

BasicPackDefinition.systemConnectionAuthentication

Defined in

builder.ts:71


version

Optional version: string

See version.

Defined in

builder.ts:76

Methods

addColumnFormat

addColumnFormat(format): PackDefinitionBuilder

Adds a column format definition to this pack.

In the web editor, the /ColumnFormat shortcut will insert a snippet of a skeleton format.

Example

pack.addColumnFormat({
  name: 'MyColumn',
  formulaName: 'MyFormula',
});

Parameters

Name Type
format Format

Returns

PackDefinitionBuilder

Defined in

builder.ts:232


addDynamicSyncTable

addDynamicSyncTable<K, L, ParamDefsT, SchemaT>(definition): PackDefinitionBuilder

Adds a dynamic sync table definition to this pack.

In the web editor, the /DynamicSyncTable shortcut will insert a snippet of a skeleton sync table.

Example

pack.addDynamicSyncTable({
  name: "MySyncTable",
  getName: async funciton (context) => {
    const response = await context.fetcher.fetch({method: "GET", url: context.sync.dynamicUrl});
    return response.body.name;
  },
  getName: async function (context) => {
    const response = await context.fetcher.fetch({method: "GET", url: context.sync.dynamicUrl});
    return response.body.browserLink;
  },
  ...
});

Type parameters

Name Type
K extends string
L extends string
ParamDefsT extends ParamDefs
SchemaT extends ObjectSchemaDefinition<K, L, SchemaT>

Parameters

Name Type
definition DynamicSyncTableOptions<K, L, ParamDefsT, SchemaT>

Returns

PackDefinitionBuilder

Defined in

builder.ts:205


addFormula

addFormula<ParamDefsT, ResultT, SchemaT>(definition): PackDefinitionBuilder

Adds a formula definition to this pack.

In the web editor, the /Formula shortcut will insert a snippet of a skeleton formula.

Example

pack.addFormula({
  resultType: ValueType.String,
   name: 'MyFormula',
   description: 'My description.',
   parameters: [
     makeParameter({
       type: ParameterType.String,
       name: 'myParam',
       description: 'My param description.',
     }),
   ],
   execute: async ([param]) => {
     return `Hello ${param}`;
   },
});

Type parameters

Name Type
ParamDefsT extends ParamDefs
ResultT extends ValueType
SchemaT extends Schema

Parameters

Name Type
definition { resultType: ResultT } & FormulaDefinition<ParamDefsT, ResultT, SchemaT>

Returns

PackDefinitionBuilder

Defined in

builder.ts:131


addNetworkDomain

addNetworkDomain(...domain): PackDefinitionBuilder

Adds the domain that this pack makes HTTP requests to. For example, if your pack makes HTTP requests to "api.example.com", use "example.com" as your network domain.

If your pack make HTTP requests, it must declare a network domain, for security purposes. Coda enforces that your pack cannot make requests to any undeclared domains.

You are allowed one network domain per pack by default. If your pack needs to connect to multiple domains, contact Coda Support for approval.

Example

pack.addNetworkDomain('example.com');

Parameters

Name Type
...domain string[]

Returns

PackDefinitionBuilder

Defined in

builder.ts:340


addSyncTable

addSyncTable<K, L, ParamDefsT, SchemaT>(__namedParameters): PackDefinitionBuilder

Adds a sync table definition to this pack.

In the web editor, the /SyncTable shortcut will insert a snippet of a skeleton sync table.

Example

pack.addSyncTable({
  name: 'MySyncTable',
  identityName: 'EntityName',
  schema: coda.makeObjectSchema({
    ...
  }),
  formula: {
    ...
  },
});

Type parameters

Name Type
K extends string
L extends string
ParamDefsT extends ParamDefs
SchemaT extends ObjectSchema<K, L, SchemaT>

Parameters

Name Type
__namedParameters SyncTableOptions<K, L, ParamDefsT, SchemaT>

Returns

PackDefinitionBuilder

Defined in

builder.ts:161


setSystemAuthentication

setSystemAuthentication(systemAuthentication): PackDefinitionBuilder

Sets this pack to use authentication provided by you as the maker of this pack.

You will need to register credentials to use with this pack. When users use the pack, their requests will be authenticated with those system credentials, they need not register their own account.

In the web editor, the /SystemAuthentication shortcut will insert a snippet of a skeleton authentication definition.

Example

pack.setSystemAuthentication({
  type: AuthenticationType.HeaderBearerToken,
});

Parameters

Name Type
systemAuthentication SystemAuthenticationDef

Returns

PackDefinitionBuilder

Defined in

builder.ts:301


setUserAuthentication

setUserAuthentication(authDef): PackDefinitionBuilder

Sets this pack to use authentication for individual users, using the authentication method is the given definition.

Each user will need to register an account in order to use this pack.

In the web editor, the /UserAuthentication shortcut will insert a snippet of a skeleton authentication definition.

By default, this will set a default connection (account) requirement, making a user account required to invoke all formulas in this pack unless you specify differently on a particular formula. To change the default, you can pass a defaultConnectionRequirement option into this method.

Example

pack.setUserAuthentication({
  type: AuthenticationType.HeaderBearerToken,
});

Parameters

Name Type
authDef NoAuthentication & { defaultConnectionRequirement?: ConnectionRequirement } & VariousAuthentication & { defaultConnectionRequirement?: ConnectionRequirement } & Omit<HeaderBearerTokenAuthentication, "getConnectionName" | "getConnectionUserId" | "postSetup"> & { getConnectionName?: MetadataFormulaDef ; postSetup?: SetEndpointDef[] } & { defaultConnectionRequirement?: ConnectionRequirement } & Omit<CodaApiBearerTokenAuthentication, "getConnectionName" | "getConnectionUserId" | "postSetup"> & { getConnectionName?: MetadataFormulaDef ; postSetup?: SetEndpointDef[] } & { defaultConnectionRequirement?: ConnectionRequirement } & Omit<CustomHeaderTokenAuthentication, "getConnectionName" | "getConnectionUserId" | "postSetup"> & { getConnectionName?: MetadataFormulaDef ; postSetup?: SetEndpointDef[] } & { defaultConnectionRequirement?: ConnectionRequirement } & Omit<QueryParamTokenAuthentication, "getConnectionName" | "getConnectionUserId" | "postSetup"> & { getConnectionName?: MetadataFormulaDef ; postSetup?: SetEndpointDef[] } & { defaultConnectionRequirement?: ConnectionRequirement } & Omit<MultiQueryParamTokenAuthentication, "getConnectionName" | "getConnectionUserId" | "postSetup"> & { getConnectionName?: MetadataFormulaDef ; postSetup?: SetEndpointDef[] } & { defaultConnectionRequirement?: ConnectionRequirement } & Omit<OAuth2Authentication, "getConnectionName" | "getConnectionUserId" | "postSetup"> & { getConnectionName?: MetadataFormulaDef ; postSetup?: SetEndpointDef[] } & { defaultConnectionRequirement?: ConnectionRequirement } & Omit<WebBasicAuthentication, "getConnectionName" | "getConnectionUserId" | "postSetup"> & { getConnectionName?: MetadataFormulaDef ; postSetup?: SetEndpointDef[] } & { defaultConnectionRequirement?: ConnectionRequirement } & Omit<AWSAccessKeyAuthentication, "getConnectionName" | "getConnectionUserId" | "postSetup"> & { getConnectionName?: MetadataFormulaDef ; postSetup?: SetEndpointDef[] } & { defaultConnectionRequirement?: ConnectionRequirement } & Omit<AWSAssumeRoleAuthentication, "getConnectionName" | "getConnectionUserId" | "postSetup"> & { getConnectionName?: MetadataFormulaDef ; postSetup?: SetEndpointDef[] } & { defaultConnectionRequirement?: ConnectionRequirement } & Omit<CustomAuthentication, "getConnectionName" | "getConnectionUserId" | "postSetup"> & { getConnectionName?: MetadataFormulaDef ; postSetup?: SetEndpointDef[] } & { defaultConnectionRequirement?: ConnectionRequirement }

Returns

PackDefinitionBuilder

Defined in

builder.ts:258


setVersion

setVersion(version): PackDefinitionBuilder

Sets the semantic version of this pack version, e.g. '1.2.3'.

This is optional, and you only need to provide a version if you are manually doing semantic versioning, or using the CLI. If using the web editor, you can omit this and the web editor will automatically provide an appropriate semantic version each time you build a version.

Example

pack.setVersion('1.2.3');

Parameters

Name Type
version string

Returns

PackDefinitionBuilder

Defined in

builder.ts:358