@segment/actions-core 2.0.3-next.0 → 2.1.0

package/dist/cjs/time.js

@@ -1,16 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.duration = exports.time = void 0;
-/**
- * Gets hrtime for logging/metrics.
- */
 function time() {
     return process.hrtime.bigint();
 }
 exports.time = time;
-/**
- * Calculates the duration in decimal milliseconds for logging/metrics purposes.
- */
 function duration(start, stop) {
     return Number(stop - start) / 1000000;
 }

package/dist/cjs/time.js.map

@@ -1 +1 @@
-{"version":3,"file":"time.js","sourceRoot":"","sources":["../../src/time.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,SAAgB,IAAI;IAClB,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAA;AAChC,CAAC;AAFD,oBAEC;AAED;;GAEG;AACH,SAAgB,QAAQ,CAAC,KAAa,EAAE,IAAY;IAClD,OAAO,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,OAAO,CAAA;AACvC,CAAC;AAFD,4BAEC"}
+{"version":3,"file":"time.js","sourceRoot":"","sources":["../../src/time.ts"],"names":[],"mappings":";;;AAGA,SAAgB,IAAI;IAClB,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAA;AAChC,CAAC;AAFD,oBAEC;AAKD,SAAgB,QAAQ,CAAC,KAAa,EAAE,IAAY;IAClD,OAAO,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,OAAO,CAAA;AACvC,CAAC;AAFD,4BAEC"}

package/dist/cjs/types.d.ts

@@ -1,10 +1,6 @@
-/** A modified response object that is handled by the `prepareResponse` hook */
 export interface ModifiedResponse<T = unknown> extends Response {
-    /** The raw response content as a string – same as `await response.text()` */
     content: string;
-    /** The parsed content string into a JavaScript object, if applicable */
     data: unknown extends T ? undefined | unknown : T;
-    /** The headers object with a shortcut method to get headers as an object */
     headers: Headers & {
         toJSON: () => Record<string, string>;
     };

package/dist/esm/create-request-client.d.ts

@@ -1,7 +1,4 @@
 import { AllRequestOptions, RequestOptions } from './request-client';
 import type { ModifiedResponse } from './types';
 export declare type RequestClient = ReturnType<typeof createRequestClient>;
-/**
- * Creates a request client instance with Segment's default configuration + custom options
- */
 export default function createRequestClient(...requestOptions: AllRequestOptions[]): <Data = unknown>(url: string, options?: RequestOptions | undefined) => Promise<ModifiedResponse<Data>>;

package/dist/esm/create-request-client.js

@@ -8,22 +8,15 @@ const baseClient = createInstance({
         'user-agent': 'Segment'
     },
     beforeRequest: [
-        // Automatically handle username/password -> basic auth header
         addBasicAuthHeader
     ],
     afterResponse: [prepareResponse, prepareHeaders]
 });
-/**
- * Creates a request client instance with Segment's default configuration + custom options
- */
 export default function createRequestClient(...requestOptions) {
     let client = baseClient;
-    // TODO include `data` bundle in before/after hooks
-    // TODO expose before/after hooks to destination definition and action definition?
     for (const options of requestOptions !== null && requestOptions !== void 0 ? requestOptions : []) {
         client = client.extend(options);
     }
-    // Limit request client interface and handle basic auth scheme
     return (url, options) => {
         return client(url, options);
     };

package/dist/esm/create-request-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-request-client.js","sourceRoot":"","sources":["../../src/create-request-client.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,mDAAmD,CAAA;AAClF,OAAO,cAAc,MAAM,6CAA6C,CAAA;AACxE,OAAO,eAAe,MAAM,8CAA8C,CAAA;AAC1E,OAAO,cAAqD,MAAM,kBAAkB,CAAA;AAGpF,MAAM,UAAU,GAAG,cAAc,CAAC;IAChC,OAAO,EAAE,KAAK;IACd,OAAO,EAAE;QACP,YAAY,EAAE,SAAS;KACxB;IACD,aAAa,EAAE;QACb,8DAA8D;QAC9D,kBAAkB;KACnB;IACD,aAAa,EAAE,CAAC,eAAe,EAAE,cAAc,CAAC;CACjD,CAAC,CAAA;AAIF;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,GAAG,cAAmC;IAChF,IAAI,MAAM,GAAG,UAAU,CAAA;IAEvB,mDAAmD;IACnD,kFAAkF;IAClF,KAAK,MAAM,OAAO,IAAI,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,EAAE,EAAE;QAC1C,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;KAChC;IAED,8DAA8D;IAC9D,OAAO,CAAiB,GAAW,EAAE,OAAwB,EAAE,EAAE;QAC/D,OAAO,MAAM,CAAyB,GAAG,EAAE,OAAO,CAAC,CAAA;IACrD,CAAC,CAAA;AACH,CAAC"}
+{"version":3,"file":"create-request-client.js","sourceRoot":"","sources":["../../src/create-request-client.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,mDAAmD,CAAA;AAClF,OAAO,cAAc,MAAM,6CAA6C,CAAA;AACxE,OAAO,eAAe,MAAM,8CAA8C,CAAA;AAC1E,OAAO,cAAqD,MAAM,kBAAkB,CAAA;AAGpF,MAAM,UAAU,GAAG,cAAc,CAAC;IAChC,OAAO,EAAE,KAAK;IACd,OAAO,EAAE;QACP,YAAY,EAAE,SAAS;KACxB;IACD,aAAa,EAAE;QAEb,kBAAkB;KACnB;IACD,aAAa,EAAE,CAAC,eAAe,EAAE,cAAc,CAAC;CACjD,CAAC,CAAA;AAOF,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,GAAG,cAAmC;IAChF,IAAI,MAAM,GAAG,UAAU,CAAA;IAIvB,KAAK,MAAM,OAAO,IAAI,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,EAAE,EAAE;QAC1C,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;KAChC;IAGD,OAAO,CAAiB,GAAW,EAAE,OAAwB,EAAE,EAAE;QAC/D,OAAO,MAAM,CAAyB,GAAG,EAAE,OAAO,CAAC,CAAA;IACrD,CAAC,CAAA;AACH,CAAC"}

package/dist/esm/create-test-event.js

@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { v4 as uuidv4 } from '@lukeed/uuid';
 export function createTestEvent(event = {}) {
     return {
         anonymousId: uuidv4(),

package/dist/esm/create-test-event.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-test-event.js","sourceRoot":"","sources":["../../src/create-test-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAA;AAGnC,MAAM,UAAU,eAAe,CAAC,QAA+B,EAAE;IAC/D,OAAO;QACL,WAAW,EAAE,MAAM,EAAE;QACrB,OAAO,EAAE;YACP,EAAE,EAAE,SAAS;YACb,OAAO,EAAE;gBACP,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,QAAQ;aAClB;YACD,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE;gBACR,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,eAAe;gBACxB,QAAQ,EAAE,UAAU;gBACpB,SAAS,EAAE,CAAC,UAAU;gBACtB,KAAK,EAAE,CAAC;aACT;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,EAAE;gBACZ,MAAM,EAAE,EAAE;gBACV,KAAK,EAAE,mBAAmB;gBAC1B,GAAG,EAAE,8BAA8B;aACpC;YACD,QAAQ,EAAE,kBAAkB;YAC5B,SAAS,EACP,uIAAuI;SAC1I;QACD,KAAK,EAAE,YAAY;QACnB,SAAS,EAAE,MAAM,EAAE;QACnB,UAAU,EAAE,EAAE;QACd,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACpC,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QAChC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,OAAO;QACb,MAAM,EAAE,UAAU;QAClB,GAAG,KAAK;KACT,CAAA;AACH,CAAC"}
+{"version":3,"file":"create-test-event.js","sourceRoot":"","sources":["../../src/create-test-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,cAAc,CAAA;AAG3C,MAAM,UAAU,eAAe,CAAC,QAA+B,EAAE;IAC/D,OAAO;QACL,WAAW,EAAE,MAAM,EAAE;QACrB,OAAO,EAAE;YACP,EAAE,EAAE,SAAS;YACb,OAAO,EAAE;gBACP,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,QAAQ;aAClB;YACD,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE;gBACR,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,eAAe;gBACxB,QAAQ,EAAE,UAAU;gBACpB,SAAS,EAAE,CAAC,UAAU;gBACtB,KAAK,EAAE,CAAC;aACT;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,EAAE;gBACZ,MAAM,EAAE,EAAE;gBACV,KAAK,EAAE,mBAAmB;gBAC1B,GAAG,EAAE,8BAA8B;aACpC;YACD,QAAQ,EAAE,kBAAkB;YAC5B,SAAS,EACP,uIAAuI;SAC1I;QACD,KAAK,EAAE,YAAY;QACnB,SAAS,EAAE,MAAM,EAAE;QACnB,UAAU,EAAE,EAAE;QACd,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACpC,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QAChC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,OAAO;QACb,MAAM,EAAE,UAAU;QAClB,GAAG,KAAK;KACT,CAAA;AACH,CAAC"}

package/dist/esm/create-test-integration.d.ts

@@ -3,33 +3,14 @@ import type { DestinationDefinition } from './destination-kit';
 import type { JSONObject } from './json-object';
 import type { SegmentEvent } from './segment-event';
 interface InputData<Settings> {
-    /**
-     * The Segment event. You can use `createTestEvent` if you want
-     * to construct an event from partial data.
-     */
     event?: Partial<SegmentEvent>;
-    /**
-     * The raw input - this is what customers define. It may include
-     * literal values as well as mapping-kit directives.
-     */
     mapping?: JSONObject;
-    /**
-     * The settings for a destination instance. Includes things like
-     * `apiKey` or `subdomain`. Any fields that are used across all actions
-     * in a destination.
-     */
     settings?: Settings;
-    /**
-     * Whether or not to use default mappings in the test.
-     * Set to `false` or omit if you want to explicitly provide the raw input.
-     * Set to `true` if you want to test the defaultMappings (along with any mapping passed in)
-     */
     useDefaultMappings?: boolean;
 }
 declare class TestDestination<T> extends Destination<T> {
     responses: Destination['responses'];
     constructor(destination: DestinationDefinition<T>);
-    /** Testing method that runs an action e2e while allowing slightly more flexible inputs */
     testAction(action: string, { event, mapping, settings, useDefaultMappings }: InputData<T>): Promise<Destination['responses']>;
 }
 export declare function createTestIntegration<T>(destination: DestinationDefinition<T>): TestDestination<T>;

package/dist/esm/create-test-integration.js

@@ -6,7 +6,6 @@ class TestDestination extends Destination {
         super(destination);
         this.responses = [];
     }
-    /** Testing method that runs an action e2e while allowing slightly more flexible inputs */
     async testAction(action, { event, mapping, settings, useDefaultMappings }) {
         mapping = mapping !== null && mapping !== void 0 ? mapping : {};
         if (useDefaultMappings) {

package/dist/esm/create-test-integration.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-test-integration.js","sourceRoot":"","sources":["../../src/create-test-integration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AA8BxC,MAAM,eAAmB,SAAQ,WAAc;IAG7C,YAAY,WAAqC;QAC/C,KAAK,CAAC,WAAW,CAAC,CAAA;QAHpB,cAAS,GAA6B,EAAE,CAAA;IAIxC,CAAC;IAED,0FAA0F;IAC1F,KAAK,CAAC,UAAU,CACd,MAAc,EACd,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAgB;QAE9D,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAA;QAEvB,IAAI,kBAAkB,EAAE;YACtB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAA;YACrD,MAAM,eAAe,GAAG,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;YACpD,OAAO,GAAG,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,EAAE,CAAA;SAC7C;QAED,MAAM,KAAK,CAAC,aAAa,CAAC,MAAM,EAAE;YAChC,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC;YAC7B,OAAO;YACP,QAAQ,EAAE,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAK,EAAQ;SAChC,CAAC,CAAA;QAEF,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;QAEnB,OAAO,SAAS,CAAA;IAClB,CAAC;CACF;AAED,MAAM,UAAU,qBAAqB,CAAI,WAAqC;IAC5E,OAAO,IAAI,eAAe,CAAC,WAAW,CAAC,CAAA;AACzC,CAAC"}
+{"version":3,"file":"create-test-integration.js","sourceRoot":"","sources":["../../src/create-test-integration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AA8BxC,MAAM,eAAmB,SAAQ,WAAc;IAG7C,YAAY,WAAqC;QAC/C,KAAK,CAAC,WAAW,CAAC,CAAA;QAHpB,cAAS,GAA6B,EAAE,CAAA;IAIxC,CAAC;IAGD,KAAK,CAAC,UAAU,CACd,MAAc,EACd,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAgB;QAE9D,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAA;QAEvB,IAAI,kBAAkB,EAAE;YACtB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAA;YACrD,MAAM,eAAe,GAAG,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;YACpD,OAAO,GAAG,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,EAAgB,CAAA;SAC3D;QAED,MAAM,KAAK,CAAC,aAAa,CAAC,MAAM,EAAE;YAChC,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC;YAC7B,OAAO;YACP,QAAQ,EAAE,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAK,EAAQ;SAChC,CAAC,CAAA;QAEF,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;QAEnB,OAAO,SAAS,CAAA;IAClB,CAAC;CACF;AAED,MAAM,UAAU,qBAAqB,CAAI,WAAqC;IAC5E,OAAO,IAAI,eAAe,CAAC,WAAW,CAAC,CAAA;AACzC,CAAC"}

package/dist/esm/destination-kit/action.d.ts

@@ -4,44 +4,19 @@ import { EventEmitter } from 'events';
 import createRequestClient from '../create-request-client';
 import { JSONLikeObject } from '../json-object';
 import { ExecuteInput, Step, StepResult, Steps } from './step';
-import type { AutocompleteResponse, InputField, RequestExtension } from './types';
+import type { DynamicFieldResponse, InputField, RequestExtension } from './types';
 declare type MaybePromise<T> = T | Promise<T>;
 declare type RequestClient = ReturnType<typeof createRequestClient>;
 export declare type RequestFn<Settings, Payload, Return = any> = (request: RequestClient, data: ExecuteInput<Settings, Payload>) => MaybePromise<Return>;
 export interface ActionDefinition<Settings, Payload = any> {
-    /** The unique identifier for the action, e.g. `postToChannel` */
-    /** The display title of the action */
     title: string;
-    /** The display description of the action */
     description: string;
-    /** Whether the action is recommended for quick setup */
-    recommended?: boolean;
-    /** An optional fql query that will be used to prepopulate the action when it is first set up */
     defaultSubscription?: string;
-    /** Whether or not this action should be visible/configurable in the UI */
     hidden?: boolean;
-    /**
-     * The fields used to perform the action. These fields should match what the partner API expects.
-     *
-     * This is a set of JSON Schema properties right now.
-     * We may eventually auto-generate the JSON Schema from a definition object
-     * instead of requiring devs to build and modify JSON Schema directly.
-     *
-     * Plus, JSON Schema cannot fully represent our action or field definitions
-     * without many custom keywords.
-     */
     fields: Record<string, InputField>;
-    /**
-     * Temporary way to "register" autocomplete fields.
-     * This is likely going to change as we productionalize the data model and definition object
-     */
-    autocompleteFields?: {
-        [K in keyof Payload]?: RequestFn<Settings, Payload, AutocompleteResponse>;
+    dynamicFields?: {
+        [K in keyof Payload]?: RequestFn<Settings, Payload, DynamicFieldResponse>;
     };
-    /**
-     * Register fields that should be executed, cached and provided
-     * to the action's `perform` function
-     */
     cachedFields?: {
         [field: string]: {
             key: (data: ExecuteInput<Settings, Payload>) => string;
@@ -50,7 +25,6 @@ export interface ActionDefinition<Settings, Payload = any> {
             negative?: boolean;
         };
     };
-    /** The operation to perform when this action is triggered */
     perform: RequestFn<Settings, Payload>;
 }
 export declare class Validate<Settings, Payload> extends Step<Settings, Payload> {
@@ -59,7 +33,7 @@ export declare class Validate<Settings, Payload> extends Step<Settings, Payload>
     constructor(field: ExecuteInputField, schema: object);
     executeStep(data: ExecuteInput<Settings, Payload>): Promise<string>;
 }
-interface ExecuteAutocompleteInput<Settings, Payload> {
+interface ExecuteDynamicFieldInput<Settings, Payload> {
     settings: Settings;
     payload: Payload;
     cachedFields: {
@@ -68,20 +42,16 @@ interface ExecuteAutocompleteInput<Settings, Payload> {
     page?: string;
 }
 declare type ExecuteInputField = 'payload' | 'settings';
-/**
- * Action is the beginning step for all partner actions. Entrypoints always start with the
- * MapAndValidateInput step.
- */
 export declare class Action<Settings, Payload extends JSONLikeObject> extends EventEmitter {
     readonly steps: Steps<Settings, Payload>;
     private extendRequest;
-    private autocompleteCache;
+    private dynamicFieldCache;
     constructor(definition: ActionDefinition<Settings, Payload>, extendRequest?: RequestExtension<Settings, Payload>);
     execute(data: ExecuteInput<Settings, Payload>): Promise<StepResult[]>;
-    executeAutocomplete(field: string, data: ExecuteAutocompleteInput<Settings, Payload>): any;
+    executeDynamicField(field: string, data: ExecuteDynamicFieldInput<Settings, Payload>): any;
     private loadDefinition;
     private validatePayload;
-    private autocomplete;
+    private dynamicField;
     private request;
     private cachedRequest;
 }

package/dist/esm/destination-kit/action.js

@@ -1,6 +1,6 @@
-// @ts-ignore no types
 import { AggregateAjvError } from '@segment/ajv-human-errors';
 import Ajv from 'ajv';
+import dayjs from 'dayjs';
 import { EventEmitter } from 'events';
 import NodeCache from 'node-cache';
 import createRequestClient from '../create-request-client';
@@ -11,46 +11,44 @@ import { Response } from '../fetch';
 import { Step, Steps } from './step';
 class MapInput extends Step {
     executeStep(data) {
-        // Transforms the initial payload (event) + action settings (from `subscriptions[0].mapping`)
-        // into input data that the action can use to talk to partner apis
         if (data.mapping) {
-            // Technically we can't know whether or not `transform` returns the exact shape of Payload here, hence the casting
-            // It will be validated in subsequent steps
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             data.payload = transform(data.mapping, data.payload);
         }
         return Promise.resolve('MapInput completed');
     }
 }
+const ajv = new Ajv({
+    coerceTypes: true,
+    allErrors: true,
+    verbose: true,
+    removeAdditional: true,
+    jsonPointers: true
+});
+ajv.addFormat('password', () => true);
+ajv.addFormat('text', () => true);
+ajv.addFormat('date-like', (data) => {
+    let date = dayjs(data);
+    if (String(Number(data)) === data) {
+        if (data.length === 13) {
+            date = dayjs(Number(data));
+        }
+        date = dayjs.unix(Number(data));
+    }
+    return date.isValid();
+});
 export class Validate extends Step {
     constructor(field, schema) {
         super();
         this.field = field;
-        const ajv = new Ajv({
-            // Coerce types to be a bit more liberal.
-            coerceTypes: true,
-            // Return all validation errors, not just the first.
-            allErrors: true,
-            // Include reference to schema and data in error values.
-            verbose: true,
-            // Use a more parse-able format for JSON paths.
-            jsonPointers: true
-        });
         this.validate = ajv.compile(schema);
     }
     executeStep(data) {
         if (!this.validate(data[this.field])) {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-call
             throw new AggregateAjvError(this.validate.errors);
         }
         return Promise.resolve('Validate completed');
     }
 }
-/**
- * Request handles delivering a payload to an external API. It uses the `fetch` API under the hood.
- *
- * The callback should be able to return the raw request instead of needing to do `return response.data` etc.
- */
 class Request extends Step {
     constructor(extendRequest, requestFn) {
         super();
@@ -64,26 +62,17 @@ class Request extends Step {
         }
         const requestClient = this.createRequestClient(data);
         const response = await this.requestFn(requestClient, data);
-        /**
-         * Try to use the parsed response `.data` or `.content` string
-         * @see {@link ../middleware/after-response/prepare-response.ts}
-         */
         if (response instanceof Response) {
             return (_a = response.data) !== null && _a !== void 0 ? _a : response.content;
         }
-        // otherwise, we don't really know what this is, so return as-is
         return response;
     }
     createRequestClient(data) {
         var _a, _b;
-        // TODO turn `extendRequest` into a beforeRequest hook
         const options = (_b = (_a = this.extendRequest) === null || _a === void 0 ? void 0 : _a.call(this, data)) !== null && _b !== void 0 ? _b : {};
         const client = createRequestClient(options, {
             afterResponse: [
-                // Keep track of the request(s) associated with a response
                 (request, options, response) => {
-                    // TODO figure out the types here...
-                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
                     const modifiedResponse = response;
                     modifiedResponse.request = request;
                     modifiedResponse.options = options;
@@ -95,7 +84,6 @@ class Request extends Step {
         return client;
     }
 }
-// CachedRequest is like Request but cached. Next question.
 class CachedRequest extends Request {
     constructor(extension, config) {
         super(extension);
@@ -127,31 +115,20 @@ class CachedRequest extends Request {
                 throw e;
             }
         }
-        // Only cache if value is not negative *or* negative option is set. Negative caching is off by
-        // default because the common cases are: A) auth token generation, which should never be
-        // negative, and B) create-or-update patterns, where the resource should exist after the first
-        // negative value.
         if ((v !== null && v !== undefined) || this.negative) {
             this.cache.set(k, v);
         }
         return 'cache miss';
     }
 }
-/**
- * Action is the beginning step for all partner actions. Entrypoints always start with the
- * MapAndValidateInput step.
- */
 export class Action extends EventEmitter {
     constructor(definition, extendRequest) {
         super();
         this.steps = new Steps();
         const step = new MapInput();
         this.steps.push(step);
-        this.autocompleteCache = {};
+        this.dynamicFieldCache = {};
         if (extendRequest) {
-            // This must come before we load the definition because
-            // it instantiates "steps" with whatever request extensions
-            // are defined at that moment in time
             this.extendRequest = extendRequest;
         }
         this.loadDefinition(definition);
@@ -164,15 +141,14 @@ export class Action extends EventEmitter {
         }
         return results;
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    executeAutocomplete(field, data) {
-        if (!this.autocompleteCache[field]) {
+    executeDynamicField(field, data) {
+        if (!this.dynamicFieldCache[field]) {
             return {
                 data: [],
                 pagination: {}
             };
         }
-        const step = new Request(this.extendRequest, this.autocompleteCache[field]);
+        const step = new Request(this.extendRequest, this.dynamicFieldCache[field]);
         return step.executeStep(data);
     }
     loadDefinition(definition) {
@@ -180,8 +156,8 @@ export class Action extends EventEmitter {
         if (definition.fields) {
             this.validatePayload(definition.fields);
         }
-        Object.entries((_a = definition.autocompleteFields) !== null && _a !== void 0 ? _a : {}).forEach(([field, callback]) => {
-            this.autocomplete(field, callback);
+        Object.entries((_a = definition.dynamicFields) !== null && _a !== void 0 ? _a : {}).forEach(([field, callback]) => {
+            this.dynamicField(field, callback);
         });
         Object.entries((_b = definition.cachedFields) !== null && _b !== void 0 ? _b : {}).forEach(([field, cacheConfig]) => {
             this.cachedRequest({
@@ -197,8 +173,8 @@ export class Action extends EventEmitter {
         const step = new Validate('payload', fieldsToJsonSchema(fields));
         this.steps.push(step);
     }
-    autocomplete(field, callback) {
-        this.autocompleteCache[field] = callback;
+    dynamicField(field, callback) {
+        this.dynamicFieldCache[field] = callback;
     }
     request(requestFn) {
         const step = new Request(this.extendRequest, requestFn);

package/dist/esm/destination-kit/action.js.map

@@ -1 +1 @@
-{"version":3,"file":"action.js","sourceRoot":"","sources":["../../../src/destination-kit/action.ts"],"names":[],"mappings":"AAAA,sBAAsB;AACtB,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,GAAG,MAAM,KAAK,CAAA;AACrB,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AACrC,OAAO,SAAS,MAAM,YAAY,CAAA;AAClC,OAAO,mBAAmB,MAAM,0BAA0B,CAAA;AAC1D,OAAO,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAA;AAE5B,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACnC,OAAO,EAAgB,IAAI,EAAc,KAAK,EAAE,MAAM,QAAQ,CAAA;AAsE9D,MAAM,QAAmD,SAAQ,IAAuB;IACtF,WAAW,CAAC,IAAqC;QAC/C,6FAA6F;QAC7F,kEAAkE;QAClE,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,kHAAkH;YAClH,2CAA2C;YAC3C,8DAA8D;YAC9D,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAc,CAAY,CAAA;SACvE;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAC9C,CAAC;CACF;AAED,MAAM,OAAO,QAA4B,SAAQ,IAAuB;IAItE,YAAY,KAAwB,EAAE,MAAc;QAClD,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAElB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC;YAClB,yCAAyC;YACzC,WAAW,EAAE,IAAI;YACjB,oDAAoD;YACpD,SAAS,EAAE,IAAI;YACf,wDAAwD;YACxD,OAAO,EAAE,IAAI;YACb,+CAA+C;YAC/C,YAAY,EAAE,IAAI;SACnB,CAAC,CAAA;QAEF,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACrC,CAAC;IAED,WAAW,CAAC,IAAqC;QAC/C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE;YACpC,6DAA6D;YAC7D,MAAM,IAAI,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;SAClD;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAC9C,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAA2B,SAAQ,IAAuB;IAI9D,YACE,aAA8D,EAC9D,SAAwC;QAExC,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAqC;;QACrD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,OAAO,EAAE,CAAA;SACV;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;QAEpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,CAAA;QAE1D;;;WAGG;QACH,IAAI,QAAQ,YAAY,QAAQ,EAAE;YAChC,OAAO,MAAE,QAA6B,CAAC,IAAmB,mCAAK,QAA6B,CAAC,OAAO,CAAA;SACrG;QAED,gEAAgE;QAChE,OAAO,QAAQ,CAAA;IACjB,CAAC;IAES,mBAAmB,CAAC,IAAqC;;QACjE,sDAAsD;QACtD,MAAM,OAAO,GAAG,MAAA,MAAA,IAAI,CAAC,aAAa,+CAAlB,IAAI,EAAiB,IAAI,CAAC,mCAAI,EAAE,CAAA;QAChD,MAAM,MAAM,GAAG,mBAAmB,CAAC,OAAO,EAAE;YAC1C,aAAa,EAAE;gBACb,0DAA0D;gBAC1D,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE;oBAC7B,oCAAoC;oBACpC,8DAA8D;oBAC9D,MAAM,gBAAgB,GAAQ,QAAQ,CAAA;oBACtC,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAA;oBAClC,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAA;oBAElC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAA;oBAEvC,OAAO,gBAAgB,CAAA;gBACzB,CAAC;aACF;SACF,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAUD,2DAA2D;AAC3D,MAAM,aAAiC,SAAQ,OAA0B;IAOvE,YACE,SAA0D,EAC1D,MAA8C;QAE9C,KAAK,CAAC,SAAS,CAAC,CAAA;QAEhB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAA;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAA;QAC3B,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,CAAA;QACnB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,KAAK,CAAA;QAExC,IAAI,CAAC,KAAK,GAAG,IAAI,SAAS,CAAC;YACzB,MAAM,EAAE,MAAM,CAAC,GAAG;YAClB,OAAO,EAAE,IAAI;SACd,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAqC;QACrD,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAC1B,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAS,CAAC,CAAC,CAAA;QAEjC,IAAI,CAAC,KAAK,SAAS,EAAE;YACnB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAA;YAC9B,OAAO,WAAW,CAAA;SACnB;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;QAE9C,IAAI;YACF,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;SACtC;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,GAAG,CAAC,CAAC,EAAE,iBAAiB,CAAC,KAAK,GAAG,EAAE;gBACrC,CAAC,GAAG,SAAS,CAAA;aACd;iBAAM;gBACL,MAAM,CAAC,CAAA;aACR;SACF;QAED,8FAA8F;QAC9F,wFAAwF;QACxF,8FAA8F;QAC9F,kBAAkB;QAClB,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;YACpD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;SACrB;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;CACF;AAWD;;;GAGG;AACH,MAAM,OAAO,MAAiD,SAAQ,YAAY;IAKhF,YAAY,UAA+C,EAAE,aAAmD;QAC9G,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAE,CAAA;QACxB,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAqB,CAAA;QAC9C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAErB,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAA;QAE3B,IAAI,aAAa,EAAE;YACjB,uDAAuD;YACvD,2DAA2D;YAC3D,qCAAqC;YACrC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;SACnC;QAED,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;IACjC,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAqC;QACjD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAE9C,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC/C,IAAI,WAAW,CAAC,KAAK,EAAE;YACrB,MAAM,WAAW,CAAC,KAAK,CAAA;SACxB;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,8DAA8D;IAC9D,mBAAmB,CAAC,KAAa,EAAE,IAAiD;QAClF,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE;YAClC,OAAO;gBACL,IAAI,EAAE,EAAE;gBACR,UAAU,EAAE,EAAE;aACf,CAAA;SACF;QAED,MAAM,IAAI,GAAG,IAAI,OAAO,CAAoB,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAA;QAE9F,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;IAEO,cAAc,CAAC,UAA+C;;QACpE,IAAI,UAAU,CAAC,MAAM,EAAE;YACrB,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;SACxC;QAED,MAAM,CAAC,OAAO,CAAC,MAAA,UAAU,CAAC,kBAAkB,mCAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YAChF,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,QAAwC,CAAC,CAAA;QACpE,CAAC,CAAC,CAAA;QAEF,MAAM,CAAC,OAAO,CAAC,MAAA,UAAU,CAAC,YAAY,mCAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,EAAE;YAC7E,IAAI,CAAC,aAAa,CAAC;gBACjB,GAAG,WAAW;gBACd,EAAE,EAAE,KAAK;aACV,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAI,UAAU,CAAC,OAAO,EAAE;YACtB,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;SACjC;IACH,CAAC;IAEO,eAAe,CAAC,MAAkC;QACxD,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAA;QAChE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC;IAEO,YAAY,CAAC,KAAa,EAAE,QAAsC;QACxE,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAA;IAC1C,CAAC;IAEO,OAAO,CAAC,SAAuC;QACrD,MAAM,IAAI,GAAG,IAAI,OAAO,CAAoB,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;QAC1E,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAA;QAClE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC;IAEO,aAAa,CAAC,MAA8C;QAClE,MAAM,IAAI,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;QAC1D,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC;CACF"}
+{"version":3,"file":"action.js","sourceRoot":"","sources":["../../../src/destination-kit/action.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,GAAG,MAAM,KAAK,CAAA;AACrB,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AACrC,OAAO,SAAS,MAAM,YAAY,CAAA;AAClC,OAAO,mBAAmB,MAAM,0BAA0B,CAAA;AAC1D,OAAO,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAA;AAE5B,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACnC,OAAO,EAAgB,IAAI,EAAc,KAAK,EAAE,MAAM,QAAQ,CAAA;AA4D9D,MAAM,QAAmD,SAAQ,IAAuB;IACtF,WAAW,CAAC,IAAqC;QAG/C,IAAI,IAAI,CAAC,OAAO,EAAE;YAIhB,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAc,CAAY,CAAA;SACvE;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAC9C,CAAC;CACF;AAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC;IAElB,WAAW,EAAE,IAAI;IAEjB,SAAS,EAAE,IAAI;IAEf,OAAO,EAAE,IAAI;IAEb,gBAAgB,EAAE,IAAI;IAEtB,YAAY,EAAE,IAAI;CACnB,CAAC,CAAA;AAGF,GAAG,CAAC,SAAS,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;AACrC,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;AACjC,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,IAAY,EAAE,EAAE;IAC1C,IAAI,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAA;IAEtB,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,EAAE;QAEjC,IAAI,IAAI,CAAC,MAAM,KAAK,EAAE,EAAE;YACtB,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;SAC3B;QAED,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;KAChC;IAED,OAAO,IAAI,CAAC,OAAO,EAAE,CAAA;AACvB,CAAC,CAAC,CAAA;AAEF,MAAM,OAAO,QAA4B,SAAQ,IAAuB;IAItE,YAAY,KAAwB,EAAE,MAAc;QAClD,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACrC,CAAC;IAED,WAAW,CAAC,IAAqC;QAC/C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE;YAEpC,MAAM,IAAI,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;SAClD;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAC9C,CAAC;CACF;AAOD,MAAM,OAA2B,SAAQ,IAAuB;IAI9D,YACE,aAA8D,EAC9D,SAAwC;QAExC,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAqC;;QACrD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,OAAO,EAAE,CAAA;SACV;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;QAEpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,CAAA;QAM1D,IAAI,QAAQ,YAAY,QAAQ,EAAE;YAChC,OAAO,MAAE,QAA6B,CAAC,IAAmB,mCAAK,QAA6B,CAAC,OAAO,CAAA;SACrG;QAGD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAES,mBAAmB,CAAC,IAAqC;;QAEjE,MAAM,OAAO,GAAG,MAAA,MAAA,IAAI,CAAC,aAAa,+CAAlB,IAAI,EAAiB,IAAI,CAAC,mCAAI,EAAE,CAAA;QAChD,MAAM,MAAM,GAAG,mBAAmB,CAAC,OAAO,EAAE;YAC1C,aAAa,EAAE;gBAEb,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE;oBAG7B,MAAM,gBAAgB,GAAQ,QAAQ,CAAA;oBACtC,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAA;oBAClC,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAA;oBAElC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAA;oBAEvC,OAAO,gBAAgB,CAAA;gBACzB,CAAC;aACF;SACF,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAWD,MAAM,aAAiC,SAAQ,OAA0B;IAOvE,YACE,SAA0D,EAC1D,MAA8C;QAE9C,KAAK,CAAC,SAAS,CAAC,CAAA;QAEhB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAA;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAA;QAC3B,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,CAAA;QACnB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,KAAK,CAAA;QAExC,IAAI,CAAC,KAAK,GAAG,IAAI,SAAS,CAAC;YACzB,MAAM,EAAE,MAAM,CAAC,GAAG;YAClB,OAAO,EAAE,IAAI;SACd,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAqC;QACrD,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAC1B,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAS,CAAC,CAAC,CAAA;QAEjC,IAAI,CAAC,KAAK,SAAS,EAAE;YACnB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAA;YAC9B,OAAO,WAAW,CAAA;SACnB;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;QAE9C,IAAI;YACF,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;SACtC;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,GAAG,CAAC,CAAC,EAAE,iBAAiB,CAAC,KAAK,GAAG,EAAE;gBACrC,CAAC,GAAG,SAAS,CAAA;aACd;iBAAM;gBACL,MAAM,CAAC,CAAA;aACR;SACF;QAMD,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;YACpD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;SACrB;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;CACF;AAeD,MAAM,OAAO,MAAiD,SAAQ,YAAY;IAKhF,YAAY,UAA+C,EAAE,aAAmD;QAC9G,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,EAAE,CAAA;QACxB,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAqB,CAAA;QAC9C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAErB,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAA;QAE3B,IAAI,aAAa,EAAE;YAIjB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;SACnC;QAED,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;IACjC,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAqC;QACjD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAE9C,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC/C,IAAI,WAAW,CAAC,KAAK,EAAE;YACrB,MAAM,WAAW,CAAC,KAAK,CAAA;SACxB;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAGD,mBAAmB,CAAC,KAAa,EAAE,IAAiD;QAClF,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE;YAClC,OAAO;gBACL,IAAI,EAAE,EAAE;gBACR,UAAU,EAAE,EAAE;aACf,CAAA;SACF;QAED,MAAM,IAAI,GAAG,IAAI,OAAO,CAAoB,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAA;QAE9F,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;IAEO,cAAc,CAAC,UAA+C;;QACpE,IAAI,UAAU,CAAC,MAAM,EAAE;YACrB,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;SACxC;QAED,MAAM,CAAC,OAAO,CAAC,MAAA,UAAU,CAAC,aAAa,mCAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YAC3E,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,QAAwC,CAAC,CAAA;QACpE,CAAC,CAAC,CAAA;QAEF,MAAM,CAAC,OAAO,CAAC,MAAA,UAAU,CAAC,YAAY,mCAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,EAAE;YAC7E,IAAI,CAAC,aAAa,CAAC;gBACjB,GAAG,WAAW;gBACd,EAAE,EAAE,KAAK;aACV,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAI,UAAU,CAAC,OAAO,EAAE;YACtB,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;SACjC;IACH,CAAC;IAEO,eAAe,CAAC,MAAkC;QACxD,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAA;QAChE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC;IAEO,YAAY,CAAC,KAAa,EAAE,QAAsC;QACxE,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAA;IAC1C,CAAC;IAEO,OAAO,CAAC,SAAuC;QACrD,MAAM,IAAI,GAAG,IAAI,OAAO,CAAoB,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;QAC1E,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAA;QAClE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC;IAEO,aAAa,CAAC,MAA8C;QAClE,MAAM,IAAI,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;QAC1D,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC;CACF"}

package/dist/esm/destination-kit/fields-to-jsonschema.js

@@ -1,12 +1,60 @@
+function toJsonSchemaType(type) {
+    switch (type) {
+        case 'string':
+        case 'text':
+        case 'password':
+            return 'string';
+        case 'datetime':
+            return ['string', 'number'];
+        default:
+            return type;
+    }
+}
 export function fieldsToJsonSchema(fields = {}) {
     const required = [];
     const properties = {};
-    for (const key of Object.keys(fields)) {
-        const field = fields[key];
-        // Remove the `required` property from fields because it'll get lifted up into an array of required keys
-        properties[key] = Object.assign({}, field);
-        delete properties[key].required;
-        // Grab all the field keys with `required: true`
+    for (const [key, field] of Object.entries(fields)) {
+        const schemaType = toJsonSchemaType(field.type);
+        let schema = {
+            title: field.label,
+            description: field.description,
+            type: schemaType,
+            format: field.format,
+            default: field.default
+        };
+        if (field.type === 'datetime') {
+            schema.format = 'date-like';
+            schema.tsType = 'string | number';
+        }
+        else if (field.type === 'password') {
+            schema.format = 'password';
+        }
+        else if (field.type === 'text') {
+            schema.format = 'text';
+        }
+        if (field.dynamic) {
+            schema.autocomplete = true;
+            schema.dynamic = true;
+        }
+        if (field.allowNull) {
+            schema.type = [].concat(schemaType, 'null');
+            if (typeof schema.tsType === 'string' && !schema.tsType.includes('null')) {
+                schema.tsType += ' | null';
+            }
+        }
+        if (field.multiple) {
+            schema.items = { type: schemaType };
+            schema.type = 'array';
+        }
+        if (schemaType === 'object' && field.properties) {
+            if (field.multiple) {
+                schema.items = fieldsToJsonSchema(field.properties);
+            }
+            else {
+                schema = { ...schema, ...fieldsToJsonSchema(field.properties) };
+            }
+        }
+        properties[key] = schema;
         if (field.required) {
             required.push(key);
         }
@@ -19,15 +67,35 @@ export function fieldsToJsonSchema(fields = {}) {
         required
     };
 }
+function extractType(schema) {
+    var _a;
+    if (schema.type === 'array') {
+        return (_a = schema.items) === null || _a === void 0 ? void 0 : _a.type;
+    }
+    if (Array.isArray(schema.type)) {
+        return schema.type.find((t) => t !== 'null');
+    }
+    else {
+        return schema.type;
+    }
+}
 export function jsonSchemaToFields(schema = {}) {
-    var _a, _b;
+    var _a, _b, _c, _d;
     const requiredFields = (_a = schema.required) !== null && _a !== void 0 ? _a : [];
     const properties = (_b = schema.properties) !== null && _b !== void 0 ? _b : {};
-    for (const key of Object.keys(properties)) {
-        if (requiredFields.includes(key)) {
-            properties[key].required = true;
-        }
+    const fields = {};
+    for (const [key, property] of Object.entries(properties)) {
+        const field = {
+            label: (_c = property.title) !== null && _c !== void 0 ? _c : '',
+            description: (_d = property.description) !== null && _d !== void 0 ? _d : '',
+            default: property.default,
+            type: extractType(schema),
+            allowNull: Array.isArray(property.type) ? property.type.includes('null') : property.type === 'null',
+            multiple: schema.type === 'array',
+            required: requiredFields.includes(key)
+        };
+        fields[key] = field;
     }
-    return properties;
+    return fields;
 }
 //# sourceMappingURL=fields-to-jsonschema.js.map

package/dist/esm/destination-kit/fields-to-jsonschema.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields-to-jsonschema.js","sourceRoot":"","sources":["../../../src/destination-kit/fields-to-jsonschema.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,kBAAkB,CAAC,SAAqC,EAAE;IACxE,MAAM,QAAQ,GAAa,EAAE,CAAA;IAC7B,MAAM,UAAU,GAAgC,EAAE,CAAA;IAElD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;QACrC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;QAEzB,wGAAwG;QACxG,UAAU,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAgB,CAAA;QACzD,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAA;QAE/B,gDAAgD;QAChD,IAAI,KAAK,CAAC,QAAQ,EAAE;YAClB,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;SACnB;KACF;IAED,OAAO;QACL,OAAO,EAAE,gCAAgC;QACzC,IAAI,EAAE,QAAQ;QACd,oBAAoB,EAAE,KAAK;QAC3B,UAAU;QACV,QAAQ;KACT,CAAA;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,SAAsB,EAAE;;IACzD,MAAM,cAAc,GAAG,MAAC,MAAM,CAAC,QAAqB,mCAAI,EAAE,CAAA;IAC1D,MAAM,UAAU,GAAG,MAAC,MAAM,CAAC,UAAyC,mCAAI,EAAE,CAAA;IAE1E,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;QACzC,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAChC,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAA;SAChC;KACF;IAED,OAAO,UAAU,CAAA;AACnB,CAAC"}
+{"version":3,"file":"fields-to-jsonschema.js","sourceRoot":"","sources":["../../../src/destination-kit/fields-to-jsonschema.ts"],"names":[],"mappings":"AAGA,SAAS,gBAAgB,CAAC,IAAmB;IAC3C,QAAQ,IAAI,EAAE;QACZ,KAAK,QAAQ,CAAC;QACd,KAAK,MAAM,CAAC;QACZ,KAAK,UAAU;YACb,OAAO,QAAQ,CAAA;QACjB,KAAK,UAAU;YACb,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;QAC7B;YACE,OAAO,IAAI,CAAA;KACd;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,SAAqC,EAAE;IACxE,MAAM,QAAQ,GAAa,EAAE,CAAA;IAC7B,MAAM,UAAU,GAAgC,EAAE,CAAA;IAElD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACjD,MAAM,UAAU,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAE/C,IAAI,MAAM,GAAgB;YACxB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,OAAO,EAAE,KAAK,CAAC,OAA0B;SAC1C,CAAA;QAED,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE;YAC7B,MAAM,CAAC,MAAM,GAAG,WAAW,CAAA;YAE3B,MAAM,CAAC,MAAM,GAAG,iBAAiB,CAAA;SAClC;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE;YACpC,MAAM,CAAC,MAAM,GAAG,UAAU,CAAA;SAC3B;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE;YAChC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAA;SACvB;QAED,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,MAAM,CAAC,YAAY,GAAG,IAAI,CAAA;YAC1B,MAAM,CAAC,OAAO,GAAG,IAAI,CAAA;SACtB;QAED,IAAI,KAAK,CAAC,SAAS,EAAE;YACnB,MAAM,CAAC,IAAI,GAAI,EAA4B,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;YAEtE,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACxE,MAAM,CAAC,MAAM,IAAI,SAAS,CAAA;aAC3B;SACF;QAED,IAAI,KAAK,CAAC,QAAQ,EAAE;YAClB,MAAM,CAAC,KAAK,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,CAAA;YACnC,MAAM,CAAC,IAAI,GAAG,OAAO,CAAA;SACtB;QAID,IAAI,UAAU,KAAK,QAAQ,IAAI,KAAK,CAAC,UAAU,EAAE;YAC/C,IAAI,KAAK,CAAC,QAAQ,EAAE;gBAClB,MAAM,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;aACpD;iBAAM;gBACL,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,GAAG,kBAAkB,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAA;aAChE;SACF;QAED,UAAU,CAAC,GAAG,CAAC,GAAG,MAAM,CAAA;QAGxB,IAAI,KAAK,CAAC,QAAQ,EAAE;YAClB,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;SACnB;KACF;IAED,OAAO;QACL,OAAO,EAAE,gCAAgC;QACzC,IAAI,EAAE,QAAQ;QACd,oBAAoB,EAAE,KAAK;QAC3B,UAAU;QACV,QAAQ;KACT,CAAA;AACH,CAAC;AAED,SAAS,WAAW,CAAC,MAAmB;;IACtC,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE;QAC3B,OAAO,MAAC,MAAM,CAAC,KAAqB,0CAAE,IAA0B,CAAA;KACjE;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;QAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAuB,CAAA;KACnE;SAAM;QACL,OAAO,MAAM,CAAC,IAA0B,CAAA;KACzC;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,SAAsB,EAAE;;IACzD,MAAM,cAAc,GAAG,MAAC,MAAM,CAAC,QAAqB,mCAAI,EAAE,CAAA;IAC1D,MAAM,UAAU,GAAG,MAAA,MAAM,CAAC,UAAU,mCAAI,EAAE,CAAA;IAC1C,MAAM,MAAM,GAA+B,EAAE,CAAA;IAE7C,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;QACxD,MAAM,KAAK,GAAe;YACxB,KAAK,EAAE,MAAA,QAAQ,CAAC,KAAK,mCAAI,EAAE;YAC3B,WAAW,EAAE,MAAA,QAAQ,CAAC,WAAW,mCAAI,EAAE;YACvC,OAAO,EAAE,QAAQ,CAAC,OAAqB;YACvC,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC;YACzB,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,MAAM;YACnG,QAAQ,EAAE,MAAM,CAAC,IAAI,KAAK,OAAO;YACjC,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC;SACvC,CAAA;QAED,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;KACpB;IAED,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/esm/destination-kit/index.d.ts

@@ -23,17 +23,12 @@ interface PartnerActions<Settings, Payload extends JSONLikeObject> {
     [key: string]: Action<Settings, Payload>;
 }
 export interface DestinationDefinition<Settings = unknown> {
-    /** The name of the destination */
     name: string;
-    /** An optional function to extend requests sent from the destination (including all actions) */
     extendRequest?: RequestExtension<Settings>;
-    /** Optional authentication configuration */
     authentication?: AuthenticationScheme<Settings>;
-    /** Actions */
     actions: {
         [key: string]: ActionDefinition<Settings>;
     };
-    /** Subscription presets automatically applied in quick setup */
     presets?: Subscription[];
 }
 export interface Subscription {
@@ -51,7 +46,6 @@ interface Authentication<Settings> {
     testAuthentication: (request: RequestClient, input: TestAuthSettings<Settings>) => Promise<unknown> | unknown;
 }
 export interface CustomAuthentication<Settings> extends Authentication<Settings> {
-    /** Typically used for "API Key" authentication. */
     scheme: 'custom';
 }
 export interface BasicAuthentication<Settings> extends Authentication<Settings> {
@@ -80,10 +74,6 @@ export declare class Destination<Settings = JSONObject> {
     private partnerAction;
     protected executeAction(actionSlug: string, { event, mapping, settings }: EventInput<Settings>): Promise<StepResult[]>;
     private onSubscription;
-    /**
-     * Note: Until we move subscriptions upstream (into int-consumer) we've opted
-     * to have failures abort the set of subscriptions and get potentially retried by centrifuge
-     */
     onEvent(event: SegmentEvent, settings: JSONObject, onComplete?: (stats: SubscriptionStats) => void): Promise<StepResult[]>;
     private getSubscriptions;
     private getDestinationSettings;