@nangohq/runner-sdk 0.48.3

package/dist/paginate.service.d.ts

@@ -0,0 +1,12 @@
+import type { AxiosResponse } from 'axios';
+import type { CursorPagination, LinkPagination, OffsetPagination, Pagination, UserProvidedProxyConfiguration } from '@nangohq/types';
+declare class PaginationService {
+    validateConfiguration(paginationConfig: Pagination): void;
+    cursor<T>(config: UserProvidedProxyConfiguration, paginationConfig: CursorPagination, updatedBodyOrParams: Record<string, any>, passPaginationParamsInBody: boolean, proxy: (config: UserProvidedProxyConfiguration) => Promise<AxiosResponse>): AsyncGenerator<T[], undefined, void>;
+    link<T>(config: UserProvidedProxyConfiguration, paginationConfig: LinkPagination, updatedBodyOrParams: Record<string, any>, passPaginationParamsInBody: boolean, proxy: (config: UserProvidedProxyConfiguration) => Promise<AxiosResponse>): AsyncGenerator<T[], undefined, void>;
+    offset<T>(config: UserProvidedProxyConfiguration, paginationConfig: OffsetPagination, updatedBodyOrParams: Record<string, any>, passPaginationParamsInBody: boolean, proxy: (config: UserProvidedProxyConfiguration) => Promise<AxiosResponse>): AsyncGenerator<T[], undefined, void>;
+    private updateConfigBodyOrParams;
+    private getNextPageLinkFromBodyOrHeaders;
+}
+declare const _default: PaginationService;
+export default _default;

package/dist/paginate.service.js

@@ -0,0 +1,146 @@
+import parseLinksHeader from 'parse-link-header';
+import get from 'lodash-es/get.js';
+function isValidURL(str) {
+    try {
+        new URL(str); // TODO: replace with canParse after we drop node v18
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+class PaginationService {
+    validateConfiguration(paginationConfig) {
+        if (!paginationConfig.type) {
+            throw new Error('Pagination type is required');
+        }
+        const { type } = paginationConfig;
+        if (paginationConfig.type === 'cursor') {
+            const cursorPagination = paginationConfig;
+            if (!cursorPagination.cursor_name_in_request) {
+                throw new Error('Param cursor_name_in_request is required for cursor pagination');
+            }
+            if (!cursorPagination.cursor_path_in_response) {
+                throw new Error('Param cursor_path_in_response is required for cursor pagination');
+            }
+            if (paginationConfig.limit && !paginationConfig.limit_name_in_request) {
+                throw new Error('Param limit_name_in_request is required for cursor pagination when limit is set');
+            }
+        }
+        else if (type === 'link') {
+            const linkPagination = paginationConfig;
+            if (!linkPagination.link_rel_in_response_header && !linkPagination.link_path_in_response_body) {
+                throw new Error('Either param link_rel_in_response_header or link_path_in_response_body is required for link pagination');
+            }
+        }
+        else if (type === 'offset') {
+            const offsetPagination = paginationConfig;
+            if (!offsetPagination.offset_name_in_request) {
+                throw new Error('Param offset_name_in_request is required for offset pagination');
+            }
+        }
+        else {
+            throw new Error(`Pagination type ${type} is not supported. Only cursor, link and offset pagination types are supported.`);
+        }
+    }
+    async *cursor(config, paginationConfig, updatedBodyOrParams, passPaginationParamsInBody, proxy) {
+        const cursorPagination = paginationConfig;
+        let nextCursor;
+        do {
+            if (typeof nextCursor !== 'undefined') {
+                updatedBodyOrParams[cursorPagination.cursor_name_in_request] = nextCursor;
+            }
+            this.updateConfigBodyOrParams(passPaginationParamsInBody, config, updatedBodyOrParams);
+            const response = await proxy(config);
+            const responseData = cursorPagination.response_path ? get(response.data, cursorPagination.response_path) : response.data;
+            if (!responseData || !responseData.length) {
+                return;
+            }
+            yield responseData;
+            nextCursor = get(response.data, cursorPagination.cursor_path_in_response);
+            if (typeof nextCursor === 'string') {
+                nextCursor = nextCursor.trim();
+                if (!nextCursor) {
+                    nextCursor = undefined;
+                }
+            }
+            else if (typeof nextCursor !== 'number') {
+                nextCursor = undefined;
+            }
+        } while (typeof nextCursor !== 'undefined');
+    }
+    async *link(config, paginationConfig, updatedBodyOrParams, passPaginationParamsInBody, proxy) {
+        const linkPagination = paginationConfig;
+        this.updateConfigBodyOrParams(passPaginationParamsInBody, config, updatedBodyOrParams);
+        while (true) {
+            const response = await proxy(config);
+            const responseData = paginationConfig.response_path ? get(response.data, paginationConfig.response_path) : response.data;
+            if (!responseData.length) {
+                return;
+            }
+            yield responseData;
+            const nextPageLink = this.getNextPageLinkFromBodyOrHeaders(linkPagination, response, paginationConfig);
+            if (!nextPageLink) {
+                return;
+            }
+            if (!isValidURL(nextPageLink)) {
+                // some providers only send path+query params in the link so we can immediately assign those to the endpoint
+                config.endpoint = nextPageLink;
+            }
+            else {
+                const url = new URL(nextPageLink);
+                config.endpoint = url.pathname + url.search;
+            }
+            delete config.params;
+        }
+    }
+    async *offset(config, paginationConfig, updatedBodyOrParams, passPaginationParamsInBody, proxy) {
+        const offsetPagination = paginationConfig;
+        const offsetParameterName = offsetPagination.offset_name_in_request;
+        const offsetCalculationMethod = offsetPagination.offset_calculation_method || 'by-response-size';
+        let offset = offsetPagination.offset_start_value || 0;
+        while (true) {
+            updatedBodyOrParams[offsetParameterName] = passPaginationParamsInBody ? offset : String(offset);
+            this.updateConfigBodyOrParams(passPaginationParamsInBody, config, updatedBodyOrParams);
+            const response = await proxy(config);
+            const responseData = paginationConfig.response_path ? get(response.data, paginationConfig.response_path) : response.data;
+            if (!responseData || !responseData.length) {
+                return;
+            }
+            yield responseData;
+            if (paginationConfig['limit'] && responseData.length < paginationConfig['limit']) {
+                return;
+            }
+            if (responseData.length < 1) {
+                // Last page was empty so no need to fetch further
+                return;
+            }
+            if (offsetCalculationMethod === 'per-page') {
+                offset++;
+            }
+            else {
+                offset += responseData.length;
+            }
+        }
+    }
+    updateConfigBodyOrParams(passPaginationParamsInBody, config, updatedBodyOrParams) {
+        if (passPaginationParamsInBody) {
+            config.data = updatedBodyOrParams;
+        }
+        else {
+            config.params = updatedBodyOrParams;
+        }
+    }
+    getNextPageLinkFromBodyOrHeaders(linkPagination, response, paginationConfig) {
+        if (linkPagination.link_rel_in_response_header) {
+            const linkHeader = parseLinksHeader(response.headers['link']);
+            return linkHeader?.[linkPagination.link_rel_in_response_header]?.url;
+        }
+        else if (linkPagination.link_path_in_response_body) {
+            return get(response.data, linkPagination.link_path_in_response_body);
+        }
+        throw Error(`Either 'link_rel_in_response_header' or 'link_path_in_response_body' should be specified for '${paginationConfig.type}' pagination`);
+    }
+}
+export default new PaginationService();
+//# sourceMappingURL=paginate.service.js.map

package/dist/paginate.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginate.service.js","sourceRoot":"","sources":["../lib/paginate.service.ts"],"names":[],"mappings":"AACA,OAAO,gBAAgB,MAAM,mBAAmB,CAAC;AACjD,OAAO,GAAG,MAAM,kBAAkB,CAAC;AAGnC,SAAS,UAAU,CAAC,GAAW;IAC3B,IAAI,CAAC;QACD,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,qDAAqD;QACnE,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED,MAAM,iBAAiB;IACZ,qBAAqB,CAAC,gBAA4B;QACrD,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACnD,CAAC;QAED,MAAM,EAAE,IAAI,EAAE,GAAG,gBAAgB,CAAC;QAElC,IAAI,gBAAgB,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACrC,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;YAC1C,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,EAAE,CAAC;gBAC3C,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;YACtF,CAAC;YACD,IAAI,CAAC,gBAAgB,CAAC,uBAAuB,EAAE,CAAC;gBAC5C,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;YACvF,CAAC;YAED,IAAI,gBAAgB,CAAC,KAAK,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,CAAC;gBACpE,MAAM,IAAI,KAAK,CAAC,iFAAiF,CAAC,CAAC;YACvG,CAAC;QACL,CAAC;aAAM,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YACzB,MAAM,cAAc,GAAG,gBAAgB,CAAC;YACxC,IAAI,CAAC,cAAc,CAAC,2BAA2B,IAAI,CAAC,cAAc,CAAC,0BAA0B,EAAE,CAAC;gBAC5F,MAAM,IAAI,KAAK,CAAC,wGAAwG,CAAC,CAAC;YAC9H,CAAC;QACL,CAAC;aAAM,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;YAC1C,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,EAAE,CAAC;gBAC3C,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;YACtF,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,iFAAiF,CAAC,CAAC;QAC9H,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,CAAC,MAAM,CAChB,MAAsC,EACtC,gBAAkC,EAClC,mBAAwC,EACxC,0BAAmC,EACnC,KAAyE;QAEzE,MAAM,gBAAgB,GAAqB,gBAAgB,CAAC;QAE5D,IAAI,UAAuC,CAAC;QAE5C,GAAG,CAAC;YACA,IAAI,OAAO,UAAU,KAAK,WAAW,EAAE,CAAC;gBACpC,mBAAmB,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,GAAG,UAAU,CAAC;YAC9E,CAAC;YAED,IAAI,CAAC,wBAAwB,CAAC,0BAA0B,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC;YAEvF,MAAM,QAAQ,GAAkB,MAAM,KAAK,CAAC,MAAM,CAAC,CAAC;YAEpD,MAAM,YAAY,GAAQ,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;YAE9H,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;gBACxC,OAAO;YACX,CAAC;YAED,MAAM,YAAY,CAAC;YAEnB,UAAU,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;YAC1E,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;gBACjC,UAAU,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;gBAC/B,IAAI,CAAC,UAAU,EAAE,CAAC;oBACd,UAAU,GAAG,SAAS,CAAC;gBAC3B,CAAC;YACL,CAAC;iBAAM,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;gBACxC,UAAU,GAAG,SAAS,CAAC;YAC3B,CAAC;QACL,CAAC,QAAQ,OAAO,UAAU,KAAK,WAAW,EAAE;IAChD,CAAC;IAEM,KAAK,CAAC,CAAC,IAAI,CACd,MAAsC,EACtC,gBAAgC,EAChC,mBAAwC,EACxC,0BAAmC,EACnC,KAAyE;QAEzE,MAAM,cAAc,GAAmB,gBAAgB,CAAC;QAExD,IAAI,CAAC,wBAAwB,CAAC,0BAA0B,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAEvF,OAAO,IAAI,EAAE,CAAC;YACV,MAAM,QAAQ,GAAkB,MAAM,KAAK,CAAC,MAAM,CAAC,CAAC;YAEpD,MAAM,YAAY,GAAQ,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC9H,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;gBACvB,OAAO;YACX,CAAC;YAED,MAAM,YAAY,CAAC;YAEnB,MAAM,YAAY,GAAuB,IAAI,CAAC,gCAAgC,CAAC,cAAc,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAC;YAE3H,IAAI,CAAC,YAAY,EAAE,CAAC;gBAChB,OAAO;YACX,CAAC;YAED,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC5B,4GAA4G;gBAC5G,MAAM,CAAC,QAAQ,GAAG,YAAY,CAAC;YACnC,CAAC;iBAAM,CAAC;gBACJ,MAAM,GAAG,GAAQ,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;gBACvC,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC;YAChD,CAAC;YAED,OAAO,MAAM,CAAC,MAAM,CAAC;QACzB,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,CAAC,MAAM,CAChB,MAAsC,EACtC,gBAAkC,EAClC,mBAAwC,EACxC,0BAAmC,EACnC,KAAyE;QAEzE,MAAM,gBAAgB,GAAqB,gBAAgB,CAAC;QAC5D,MAAM,mBAAmB,GAAW,gBAAgB,CAAC,sBAAsB,CAAC;QAC5E,MAAM,uBAAuB,GAA4B,gBAAgB,CAAC,yBAAyB,IAAI,kBAAkB,CAAC;QAC1H,IAAI,MAAM,GAAG,gBAAgB,CAAC,kBAAkB,IAAI,CAAC,CAAC;QAEtD,OAAO,IAAI,EAAE,CAAC;YACV,mBAAmB,CAAC,mBAAmB,CAAC,GAAG,0BAA0B,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAEhG,IAAI,CAAC,wBAAwB,CAAC,0BAA0B,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC;YAEvF,MAAM,QAAQ,GAAkB,MAAM,KAAK,CAAC,MAAM,CAAC,CAAC;YAEpD,MAAM,YAAY,GAAQ,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC9H,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;gBACxC,OAAO;YACX,CAAC;YAED,MAAM,YAAY,CAAC;YAEnB,IAAI,gBAAgB,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/E,OAAO;YACX,CAAC;YAED,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,kDAAkD;gBAClD,OAAO;YACX,CAAC;YAED,IAAI,uBAAuB,KAAK,UAAU,EAAE,CAAC;gBACzC,MAAM,EAAE,CAAC;YACb,CAAC;iBAAM,CAAC;gBACJ,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC;YAClC,CAAC;QACL,CAAC;IACL,CAAC;IAEO,wBAAwB,CAAC,0BAAmC,EAAE,MAAsC,EAAE,mBAA2C;QACrJ,IAAI,0BAA0B,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,GAAG,mBAAmB,CAAC;QACtC,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,MAAM,GAAG,mBAAmB,CAAC;QACxC,CAAC;IACL,CAAC;IAEO,gCAAgC,CAAC,cAA8B,EAAE,QAAuB,EAAE,gBAA4B;QAC1H,IAAI,cAAc,CAAC,2BAA2B,EAAE,CAAC;YAC7C,MAAM,UAAU,GAAG,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;YAC9D,OAAO,UAAU,EAAE,CAAC,cAAc,CAAC,2BAA2B,CAAC,EAAE,GAAG,CAAC;QACzE,CAAC;aAAM,IAAI,cAAc,CAAC,0BAA0B,EAAE,CAAC;YACnD,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,0BAA0B,CAAC,CAAC;QACzE,CAAC;QAED,MAAM,KAAK,CAAC,iGAAiG,gBAAgB,CAAC,IAAI,cAAc,CAAC,CAAC;IACtJ,CAAC;CACJ;AAED,eAAe,IAAI,iBAAiB,EAAE,CAAC"}

package/dist/sdk.d.ts

@@ -0,0 +1,111 @@
+import type { Nango } from '@nangohq/node';
+import type { AxiosResponse } from 'axios';
+import type { ApiKeyCredentials, ApiPublicConnectionFull, AppCredentials, AppStoreCredentials, BasicApiCredentials, BillCredentials, CustomCredentials, EnvironmentVariable, GetPublicConnection, GetPublicIntegration, JwtCredentials, MaybePromise, Metadata, NangoProps, OAuth1Token, OAuth2ClientCredentials, SetMetadata, SignatureCredentials, TableauCredentials, TbaCredentials, TwoStepCredentials, UnauthCredentials, UpdateMetadata, UserLogParameters, UserProvidedProxyConfiguration } from '@nangohq/types';
+import type { ValidateDataError } from './dataValidation.js';
+export declare const oldLevelToNewLevel: {
+    readonly debug: "debug";
+    readonly info: "info";
+    readonly warn: "warn";
+    readonly error: "error";
+    readonly verbose: "debug";
+    readonly silly: "debug";
+    readonly http: "info";
+};
+export type ProxyConfiguration = Omit<UserProvidedProxyConfiguration, 'files' | 'providerConfigKey' | 'connectionId'> & {
+    providerConfigKey?: string;
+    connectionId?: string;
+};
+export declare class ActionError<T = Record<string, unknown>> extends Error {
+    type: string;
+    payload?: Record<string, unknown>;
+    constructor(payload?: T);
+}
+export declare abstract class NangoActionBase {
+    abstract nango: Nango;
+    private attributes;
+    activityLogId?: string | undefined;
+    syncId?: string;
+    nangoConnectionId?: number;
+    environmentId: number;
+    environmentName?: string;
+    syncJobId?: number;
+    abortSignal?: NangoProps['abortSignal'];
+    syncConfig?: NangoProps['syncConfig'];
+    runnerFlags: NangoProps['runnerFlags'];
+    connectionId: string;
+    providerConfigKey: string;
+    provider?: string;
+    ActionError: typeof ActionError;
+    protected memoizedConnections: Map<string, {
+        connection: ApiPublicConnectionFull;
+        timestamp: number;
+    }>;
+    protected memoizedIntegration: Map<string, {
+        integration: GetPublicIntegration["Success"]["data"];
+        timestamp: number;
+    }>;
+    constructor(config: NangoProps);
+    protected stringify(): string;
+    protected proxyConfig(config: ProxyConfiguration): UserProvidedProxyConfiguration;
+    protected throwIfAborted(): void;
+    abstract proxy<T = any>(config: ProxyConfiguration): Promise<AxiosResponse<T>>;
+    get<T = any>(config: Omit<ProxyConfiguration, 'method'>): Promise<AxiosResponse<T>>;
+    post<T = any>(config: Omit<ProxyConfiguration, 'method'>): Promise<AxiosResponse<T>>;
+    put<T = any>(config: Omit<ProxyConfiguration, 'method'>): Promise<AxiosResponse<T>>;
+    patch<T = any>(config: Omit<ProxyConfiguration, 'method'>): Promise<AxiosResponse<T>>;
+    delete<T = any>(config: Omit<ProxyConfiguration, 'method'>): Promise<AxiosResponse<T>>;
+    getToken(): Promise<string | OAuth1Token | OAuth2ClientCredentials | BasicApiCredentials | ApiKeyCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials | TbaCredentials | TableauCredentials | JwtCredentials | BillCredentials | TwoStepCredentials | SignatureCredentials>;
+    /**
+     * Get current integration
+     */
+    getIntegration(queries?: GetPublicIntegration['Querystring']): Promise<GetPublicIntegration['Success']['data']>;
+    getConnection(providerConfigKeyOverride?: string, connectionIdOverride?: string): Promise<GetPublicConnection['Success']>;
+    setMetadata(metadata: Metadata): Promise<AxiosResponse<SetMetadata['Success']>>;
+    updateMetadata(metadata: Metadata): Promise<AxiosResponse<UpdateMetadata['Success']>>;
+    /**
+     * @deprecated please use setMetadata instead.
+     */
+    setFieldMapping(fieldMapping: Record<string, string>): Promise<AxiosResponse<object>>;
+    getMetadata<T = Metadata>(): Promise<T>;
+    getWebhookURL(): Promise<string | null | undefined>;
+    /**
+     * @deprecated please use getMetadata instead.
+     */
+    getFieldMapping(): Promise<Metadata>;
+    /**
+     * Log
+     * @desc Log a message to the activity log which shows up in the Nango Dashboard
+     * note that the last argument can be an object with a level property to specify the log level
+     * @example
+     * ```ts
+     * await nango.log('This is a log message', { level: 'error' })
+     * ```
+     */
+    abstract log(message: any, options?: UserLogParameters | {
+        [key: string]: any;
+        level?: never;
+    }): MaybePromise<void>;
+    abstract log(message: string, ...args: [any, UserLogParameters]): MaybePromise<void>;
+    abstract log(...args: [...any]): MaybePromise<void>;
+    getEnvironmentVariables(): Promise<EnvironmentVariable[] | null>;
+    getFlowAttributes<A = object>(): A | null;
+    paginate<T = any>(config: ProxyConfiguration): AsyncGenerator<T[], undefined, void>;
+    triggerAction<In = unknown, Out = object>(providerConfigKey: string, connectionId: string, actionName: string, input?: In): Promise<Out>;
+    abstract triggerSync(providerConfigKey: string, connectionId: string, syncName: string, fullResync?: boolean): Promise<void | string>;
+}
+export declare abstract class NangoSyncBase extends NangoActionBase {
+    lastSyncDate?: Date;
+    track_deletes: boolean;
+    constructor(config: NangoProps);
+    /**
+     * @deprecated please use batchSave
+     */
+    batchSend<T = any>(results: T[], model: string): Promise<boolean | null>;
+    abstract batchSave<T = any>(results: T[], model: string): MaybePromise<boolean>;
+    abstract batchDelete<T = any>(results: T[], model: string): MaybePromise<boolean>;
+    abstract batchUpdate<T = any>(results: T[], model: string): MaybePromise<boolean>;
+    protected validateRecords(model: string, records: unknown[]): {
+        data: any;
+        validation: ValidateDataError[];
+    }[];
+}

package/dist/sdk.js

@@ -0,0 +1,303 @@
+import paginateService from './paginate.service.js';
+import { getProvider } from '@nangohq/providers';
+import { AbortedSDKError, UnknownProviderSDKError } from './errors.js';
+import { validateData } from './dataValidation.js';
+export const oldLevelToNewLevel = {
+    debug: 'debug',
+    info: 'info',
+    warn: 'warn',
+    error: 'error',
+    verbose: 'debug',
+    silly: 'debug',
+    http: 'info'
+};
+export class ActionError extends Error {
+    type;
+    payload;
+    constructor(payload) {
+        super();
+        this.type = 'action_script_runtime_error';
+        if (payload) {
+            this.payload = payload;
+        }
+    }
+}
+const MEMOIZED_CONNECTION_TTL = 60000;
+const MEMOIZED_INTEGRATION_TTL = 10 * 60 * 1000;
+export class NangoActionBase {
+    attributes = {};
+    activityLogId;
+    syncId;
+    nangoConnectionId;
+    environmentId;
+    environmentName;
+    syncJobId;
+    abortSignal;
+    syncConfig;
+    runnerFlags;
+    connectionId;
+    providerConfigKey;
+    provider;
+    ActionError = ActionError;
+    memoizedConnections = new Map();
+    memoizedIntegration = new Map();
+    constructor(config) {
+        this.connectionId = config.connectionId;
+        this.environmentId = config.environmentId;
+        this.providerConfigKey = config.providerConfigKey;
+        this.runnerFlags = config.runnerFlags;
+        if (config.activityLogId) {
+            this.activityLogId = config.activityLogId;
+        }
+        if (config.syncId) {
+            this.syncId = config.syncId;
+        }
+        if (config.nangoConnectionId) {
+            this.nangoConnectionId = config.nangoConnectionId;
+        }
+        if (config.syncJobId) {
+            this.syncJobId = config.syncJobId;
+        }
+        if (config.environmentName) {
+            this.environmentName = config.environmentName;
+        }
+        if (config.provider) {
+            this.provider = config.provider;
+        }
+        if (config.attributes) {
+            this.attributes = config.attributes;
+        }
+        if (config.abortSignal) {
+            this.abortSignal = config.abortSignal;
+        }
+        if (config.syncConfig) {
+            this.syncConfig = config.syncConfig;
+        }
+    }
+    stringify() {
+        return JSON.stringify(this, (key, value) => {
+            if (key === 'secretKey') {
+                return '********';
+            }
+            return value;
+        });
+    }
+    proxyConfig(config) {
+        if (!config.connectionId && this.connectionId) {
+            config.connectionId = this.connectionId;
+        }
+        if (!config.providerConfigKey && this.providerConfigKey) {
+            config.providerConfigKey = this.providerConfigKey;
+        }
+        if (!config.connectionId) {
+            throw new Error('Missing connection id');
+        }
+        if (!config.providerConfigKey) {
+            throw new Error('Missing provider config key');
+        }
+        return {
+            method: 'GET',
+            ...config,
+            providerConfigKey: config.providerConfigKey,
+            connectionId: config.connectionId,
+            headers: {
+                ...(config.headers || {}),
+                'user-agent': this.nango.userAgent
+            }
+        };
+    }
+    throwIfAborted() {
+        if (this.abortSignal?.aborted) {
+            throw new AbortedSDKError();
+        }
+    }
+    async get(config) {
+        return this.proxy({
+            ...config,
+            method: 'GET'
+        });
+    }
+    async post(config) {
+        return this.proxy({
+            ...config,
+            method: 'POST'
+        });
+    }
+    async put(config) {
+        return this.proxy({
+            ...config,
+            method: 'PUT'
+        });
+    }
+    async patch(config) {
+        return this.proxy({
+            ...config,
+            method: 'PATCH'
+        });
+    }
+    async delete(config) {
+        return this.proxy({
+            ...config,
+            method: 'DELETE'
+        });
+    }
+    async getToken() {
+        this.throwIfAborted();
+        return this.nango.getToken(this.providerConfigKey, this.connectionId);
+    }
+    /**
+     * Get current integration
+     */
+    async getIntegration(queries) {
+        this.throwIfAborted();
+        const key = queries?.include?.join(',') || 'default';
+        const has = this.memoizedIntegration.get(key);
+        if (has && MEMOIZED_INTEGRATION_TTL > Date.now() - has.timestamp) {
+            return has.integration;
+        }
+        const { data: integration } = await this.nango.getIntegration({ uniqueKey: this.providerConfigKey }, queries);
+        this.memoizedIntegration.set(key, { integration, timestamp: Date.now() });
+        return integration;
+    }
+    async getConnection(providerConfigKeyOverride, connectionIdOverride) {
+        this.throwIfAborted();
+        const providerConfigKey = providerConfigKeyOverride || this.providerConfigKey;
+        const connectionId = connectionIdOverride || this.connectionId;
+        const credentialsPair = `${providerConfigKey}${connectionId}`;
+        const cachedConnection = this.memoizedConnections.get(credentialsPair);
+        if (!cachedConnection || Date.now() - cachedConnection.timestamp > MEMOIZED_CONNECTION_TTL) {
+            const connection = await this.nango.getConnection(providerConfigKey, connectionId);
+            this.memoizedConnections.set(credentialsPair, { connection, timestamp: Date.now() });
+            return connection;
+        }
+        return cachedConnection.connection;
+    }
+    async setMetadata(metadata) {
+        this.throwIfAborted();
+        try {
+            return await this.nango.setMetadata(this.providerConfigKey, this.connectionId, metadata);
+        }
+        finally {
+            this.memoizedConnections.delete(`${this.providerConfigKey}${this.connectionId}`);
+        }
+    }
+    async updateMetadata(metadata) {
+        this.throwIfAborted();
+        try {
+            return await this.nango.updateMetadata(this.providerConfigKey, this.connectionId, metadata);
+        }
+        finally {
+            this.memoizedConnections.delete(`${this.providerConfigKey}${this.connectionId}`);
+        }
+    }
+    /**
+     * @deprecated please use setMetadata instead.
+     */
+    async setFieldMapping(fieldMapping) {
+        console.warn('setFieldMapping is deprecated. Please use setMetadata instead.');
+        return this.setMetadata(fieldMapping);
+    }
+    async getMetadata() {
+        this.throwIfAborted();
+        return (await this.getConnection(this.providerConfigKey, this.connectionId)).metadata;
+    }
+    async getWebhookURL() {
+        this.throwIfAborted();
+        const integration = await this.getIntegration({ include: ['webhook'] });
+        return integration.webhook_url;
+    }
+    /**
+     * @deprecated please use getMetadata instead.
+     */
+    async getFieldMapping() {
+        console.warn('getFieldMapping is deprecated. Please use getMetadata instead.');
+        const metadata = await this.getMetadata();
+        return metadata['fieldMapping'] || {};
+    }
+    async getEnvironmentVariables() {
+        return await this.nango.getEnvironmentVariables();
+    }
+    getFlowAttributes() {
+        if (!this.syncJobId) {
+            throw new Error('There is no current sync to get attributes from');
+        }
+        return this.attributes;
+    }
+    async *paginate(config) {
+        const provider = getProvider(this.provider);
+        if (!provider) {
+            throw new UnknownProviderSDKError({ provider: this.provider });
+        }
+        const templatePaginationConfig = provider.proxy?.paginate;
+        if (!templatePaginationConfig && (!config.paginate || !config.paginate.type)) {
+            throw Error('There was no pagination configuration for this integration or configuration passed in.');
+        }
+        const paginationConfig = {
+            ...(templatePaginationConfig || {}),
+            ...(config.paginate || {})
+        };
+        paginateService.validateConfiguration(paginationConfig);
+        config.method = config.method || 'GET';
+        const configMethod = config.method.toLocaleLowerCase();
+        const passPaginationParamsInBody = ['post', 'put', 'patch'].includes(configMethod);
+        const updatedBodyOrParams = (passPaginationParamsInBody ? config.data : config.params) ?? {};
+        const limitParameterName = paginationConfig.limit_name_in_request;
+        if (paginationConfig['limit']) {
+            updatedBodyOrParams[limitParameterName] = paginationConfig['limit'];
+        }
+        const proxyConfig = this.proxyConfig(config);
+        switch (paginationConfig.type) {
+            case 'cursor':
+                return yield* paginateService.cursor(proxyConfig, paginationConfig, updatedBodyOrParams, passPaginationParamsInBody, this.proxy.bind(this));
+            case 'link':
+                return yield* paginateService.link(proxyConfig, paginationConfig, updatedBodyOrParams, passPaginationParamsInBody, this.proxy.bind(this));
+            case 'offset':
+                return yield* paginateService.offset(proxyConfig, paginationConfig, updatedBodyOrParams, passPaginationParamsInBody, this.proxy.bind(this));
+            default:
+                throw Error(`'${paginationConfig['type']}' pagination is not supported.}`);
+        }
+    }
+    async triggerAction(providerConfigKey, connectionId, actionName, input) {
+        return await this.nango.triggerAction(providerConfigKey, connectionId, actionName, input);
+    }
+}
+export class NangoSyncBase extends NangoActionBase {
+    lastSyncDate;
+    track_deletes = false;
+    constructor(config) {
+        super(config);
+        if (config.lastSyncDate) {
+            this.lastSyncDate = config.lastSyncDate;
+        }
+        if (config.track_deletes) {
+            this.track_deletes = config.track_deletes;
+        }
+    }
+    /**
+     * @deprecated please use batchSave
+     */
+    async batchSend(results, model) {
+        return this.batchSave(results, model);
+    }
+    validateRecords(model, records) {
+        // Validate records
+        const hasErrors = [];
+        for (const record of records) {
+            const validation = validateData({
+                version: this.syncConfig?.version || '1',
+                input: JSON.parse(JSON.stringify(record)),
+                jsonSchema: this.syncConfig.models_json_schema,
+                modelName: model
+            });
+            if (validation === true) {
+                continue;
+            }
+            hasErrors.push({ data: record, validation });
+            if (this.runnerFlags?.validateSyncRecords) {
+                break;
+            }
+        }
+        return hasErrors;
+    }
+}
+//# sourceMappingURL=sdk.js.map

package/dist/sdk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../lib/sdk.ts"],"names":[],"mappings":"AAEA,OAAO,eAAe,MAAM,uBAAuB,CAAC;AA8BpD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAGnD,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAC9B,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;CACN,CAAC;AAOX,MAAM,OAAO,WAAyC,SAAQ,KAAK;IAC/D,IAAI,CAAS;IACb,OAAO,CAA2B;IAElC,YAAY,OAAW;QACnB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,6BAA6B,CAAC;QAC1C,IAAI,OAAO,EAAE,CAAC;YACV,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAC3B,CAAC;IACL,CAAC;CACJ;AAED,MAAM,uBAAuB,GAAG,KAAK,CAAC;AACtC,MAAM,wBAAwB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAEhD,MAAM,OAAgB,eAAe;IAEzB,UAAU,GAAG,EAAE,CAAC;IACxB,aAAa,CAAsB;IACnC,MAAM,CAAU;IAChB,iBAAiB,CAAU;IAC3B,aAAa,CAAS;IACtB,eAAe,CAAU;IACzB,SAAS,CAAU;IACnB,WAAW,CAA6B;IACxC,UAAU,CAA4B;IACtC,WAAW,CAA4B;IAEhC,YAAY,CAAS;IACrB,iBAAiB,CAAS;IAC1B,QAAQ,CAAU;IAElB,WAAW,GAAG,WAAW,CAAC;IAEvB,mBAAmB,GAAG,IAAI,GAAG,EAAsE,CAAC;IACpG,mBAAmB,GAAG,IAAI,GAAG,EAAuF,CAAC;IAE/H,YAAY,MAAkB;QAC1B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QAClD,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QAEtC,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC9C,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAChC,CAAC;QAED,IAAI,MAAM,CAAC,iBAAiB,EAAE,CAAC;YAC3B,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QACtD,CAAC;QAED,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QACtC,CAAC;QAED,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;YACzB,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QAClD,CAAC;QAED,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QACpC,CAAC;QAED,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACpB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACxC,CAAC;QAED,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QAC1C,CAAC;QAED,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACpB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACxC,CAAC;IACL,CAAC;IAES,SAAS;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACvC,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;gBACtB,OAAO,UAAU,CAAC;YACtB,CAAC;YACD,OAAO,KAAK,CAAC;QACjB,CAAC,CAAC,CAAC;IACP,CAAC;IAES,WAAW,CAAC,MAA0B;QAC5C,IAAI,CAAC,MAAM,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAC5C,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,iBAAiB,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACtD,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACnD,CAAC;QACD,OAAO;YACH,MAAM,EAAE,KAAK;YACb,GAAG,MAAM;YACT,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;YAC3C,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,OAAO,EAAE;gBACL,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;gBACzB,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS;aACrC;SACJ,CAAC;IACN,CAAC;IAES,cAAc;QACpB,IAAI,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC;YAC5B,MAAM,IAAI,eAAe,EAAE,CAAC;QAChC,CAAC;IACL,CAAC;IAIM,KAAK,CAAC,GAAG,CAAU,MAA0C;QAChE,OAAO,IAAI,CAAC,KAAK,CAAC;YACd,GAAG,MAAM;YACT,MAAM,EAAE,KAAK;SAChB,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,IAAI,CAAU,MAA0C;QACjE,OAAO,IAAI,CAAC,KAAK,CAAC;YACd,GAAG,MAAM;YACT,MAAM,EAAE,MAAM;SACjB,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,GAAG,CAAU,MAA0C;QAChE,OAAO,IAAI,CAAC,KAAK,CAAC;YACd,GAAG,MAAM;YACT,MAAM,EAAE,KAAK;SAChB,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,KAAK,CAAU,MAA0C;QAClE,OAAO,IAAI,CAAC,KAAK,CAAC;YACd,GAAG,MAAM;YACT,MAAM,EAAE,OAAO;SAClB,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,MAAM,CAAU,MAA0C;QACnE,OAAO,IAAI,CAAC,KAAK,CAAC;YACd,GAAG,MAAM;YACT,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,QAAQ;QAiBjB,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,OAA6C;QACrE,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,MAAM,GAAG,GAAG,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC;QACrD,MAAM,GAAG,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI,GAAG,IAAI,wBAAwB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;YAC/D,OAAO,GAAG,CAAC,WAAW,CAAC;QAC3B,CAAC;QAED,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,iBAAiB,EAAE,EAAE,OAAO,CAAC,CAAC;QAC9G,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC1E,OAAO,WAAW,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,yBAAkC,EAAE,oBAA6B;QACxF,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,MAAM,iBAAiB,GAAG,yBAAyB,IAAI,IAAI,CAAC,iBAAiB,CAAC;QAC9E,MAAM,YAAY,GAAG,oBAAoB,IAAI,IAAI,CAAC,YAAY,CAAC;QAE/D,MAAM,eAAe,GAAG,GAAG,iBAAiB,GAAG,YAAY,EAAE,CAAC;QAC9D,MAAM,gBAAgB,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAEvE,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,gBAAgB,CAAC,SAAS,GAAG,uBAAuB,EAAE,CAAC;YACzF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;YACnF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACrF,OAAO,UAAU,CAAC;QACtB,CAAC;QAED,OAAO,gBAAgB,CAAC,UAAU,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,QAAkB;QACvC,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC;YACD,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAC7F,CAAC;gBAAS,CAAC;YACP,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QACrF,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,QAAkB;QAC1C,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC;YACD,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAChG,CAAC;gBAAS,CAAC;YACP,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QACrF,CAAC;IACL,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,eAAe,CAAC,YAAoC;QAC7D,OAAO,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAC;QAC/E,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAC1C,CAAC;IAEM,KAAK,CAAC,WAAW;QACpB,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,OAAO,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,QAAa,CAAC;IAC/F,CAAC;IAEM,KAAK,CAAC,aAAa;QACtB,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACxE,OAAO,WAAW,CAAC,WAAW,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,eAAe;QACxB,OAAO,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAC;QAC/E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1C,OAAQ,QAAQ,CAAC,cAAc,CAAc,IAAI,EAAE,CAAC;IACxD,CAAC;IAeM,KAAK,CAAC,uBAAuB;QAChC,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,uBAAuB,EAAE,CAAC;IACtD,CAAC;IAEM,iBAAiB;QACpB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACvE,CAAC;QAED,OAAO,IAAI,CAAC,UAAe,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,CAAC,QAAQ,CAAU,MAA0B;QACtD,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,QAAkB,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,MAAM,IAAI,uBAAuB,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,wBAAwB,GAAG,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;QAE1D,IAAI,CAAC,wBAAwB,IAAI,CAAC,CAAC,MAAM,CAAC,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3E,MAAM,KAAK,CAAC,wFAAwF,CAAC,CAAC;QAC1G,CAAC;QAED,MAAM,gBAAgB,GAAG;YACrB,GAAG,CAAC,wBAAwB,IAAI,EAAE,CAAC;YACnC,GAAG,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;SACf,CAAC;QAEhB,eAAe,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;QAExD,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC;QAEvC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;QACvD,MAAM,0BAA0B,GAAY,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAE5F,MAAM,mBAAmB,GAAyB,CAAC,0BAA0B,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAyB,IAAI,EAAE,CAAC;QAC3I,MAAM,kBAAkB,GAAW,gBAAgB,CAAC,qBAAqB,CAAC;QAE1E,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,mBAAmB,CAAC,kBAAkB,CAAC,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACxE,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC7C,QAAQ,gBAAgB,CAAC,IAAI,EAAE,CAAC;YAC5B,KAAK,QAAQ;gBACT,OAAO,KAAK,CAAC,CAAC,eAAe,CAAC,MAAM,CAAI,WAAW,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACnJ,KAAK,MAAM;gBACP,OAAO,KAAK,CAAC,CAAC,eAAe,CAAC,IAAI,CAAI,WAAW,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACjJ,KAAK,QAAQ;gBACT,OAAO,KAAK,CAAC,CAAC,eAAe,CAAC,MAAM,CAAI,WAAW,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACnJ;gBACI,MAAM,KAAK,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC,iCAAiC,CAAC,CAAC;QACnF,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,aAAa,CAA6B,iBAAyB,EAAE,YAAoB,EAAE,UAAkB,EAAE,KAAU;QAClI,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,iBAAiB,EAAE,YAAY,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IAC9F,CAAC;CAGJ;AAED,MAAM,OAAgB,aAAc,SAAQ,eAAe;IACvD,YAAY,CAAQ;IACpB,aAAa,GAAG,KAAK,CAAC;IAEtB,YAAY,MAAkB;QAC1B,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QAC5C,CAAC;QAED,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC9C,CAAC;IACL,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAU,OAAY,EAAE,KAAa;QACvD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;IAQS,eAAe,CAAC,KAAa,EAAE,OAAkB;QACvD,mBAAmB;QACnB,MAAM,SAAS,GAAqD,EAAE,CAAC;QACvE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,YAAY,CAAC;gBAC5B,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,IAAI,GAAG;gBACxC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACzC,UAAU,EAAE,IAAI,CAAC,UAAW,CAAC,kBAAkB;gBAC/C,SAAS,EAAE,KAAK;aACnB,CAAC,CAAC;YACH,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;gBACtB,SAAS;YACb,CAAC;YAED,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;YAE7C,IAAI,IAAI,CAAC,WAAW,EAAE,mBAAmB,EAAE,CAAC;gBACxC,MAAM;YACV,CAAC;QACL,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ"}

package/dist/sync.d.ts

@@ -0,0 +1,19 @@
+import type { MaybePromise, NangoProps } from '@nangohq/types';
+import type { ValidateDataError } from './dataValidation.js';
+import { NangoActionBase } from './action.js';
+export declare abstract class NangoSyncBase extends NangoActionBase {
+    lastSyncDate?: Date;
+    track_deletes: boolean;
+    constructor(config: NangoProps);
+    /**
+     * @deprecated please use batchSave
+     */
+    batchSend<T = any>(results: T[], model: string): Promise<boolean | null>;
+    abstract batchSave<T = any>(results: T[], model: string): MaybePromise<boolean>;
+    abstract batchDelete<T = any>(results: T[], model: string): MaybePromise<boolean>;
+    abstract batchUpdate<T = any>(results: T[], model: string): MaybePromise<boolean>;
+    protected validateRecords(model: string, records: unknown[]): {
+        data: any;
+        validation: ValidateDataError[];
+    }[];
+}

package/dist/sync.js

@@ -0,0 +1,42 @@
+import { validateData } from './dataValidation.js';
+import { NangoActionBase } from './action.js';
+export class NangoSyncBase extends NangoActionBase {
+    lastSyncDate;
+    track_deletes = false;
+    constructor(config) {
+        super(config);
+        if (config.lastSyncDate) {
+            this.lastSyncDate = config.lastSyncDate;
+        }
+        if (config.track_deletes) {
+            this.track_deletes = config.track_deletes;
+        }
+    }
+    /**
+     * @deprecated please use batchSave
+     */
+    async batchSend(results, model) {
+        return this.batchSave(results, model);
+    }
+    validateRecords(model, records) {
+        // Validate records
+        const hasErrors = [];
+        for (const record of records) {
+            const validation = validateData({
+                version: this.syncConfig?.version || '1',
+                input: JSON.parse(JSON.stringify(record)),
+                jsonSchema: this.syncConfig.models_json_schema,
+                modelName: model
+            });
+            if (validation === true) {
+                continue;
+            }
+            hasErrors.push({ data: record, validation });
+            if (this.runnerFlags?.validateSyncRecords) {
+                break;
+            }
+        }
+        return hasErrors;
+    }
+}
+//# sourceMappingURL=sync.js.map