@nangohq/runner-sdk 0.64.0 → 0.64.1

package/dist/scripts.d.ts

@@ -45,10 +45,21 @@ export interface CreateSyncProps<TModels extends Record<string, ZodModel>, TMeta
      * @example 'every hour'
      */
     frequency: string;
+    /**
+     * The models that will be synced by this script.
+     * You need one endpoint per model.
+     *
+     * @example
+     * ```ts
+     * models: {
+     *     GithubIssue: z.object({
+     *         id: z.string(),
+     *     }),
+     * },
+     */
     models: TModels;
     /**
      * The type of the sync.
-     * @default 'full'
      */
     syncType: 'full' | 'incremental';
     /**
@@ -257,10 +268,45 @@ export interface CreateActionResponse<TInput extends z.ZodTypeAny, TOutput exten
  */
 export declare function createAction<TInput extends z.ZodTypeAny, TOutput extends z.ZodTypeAny, TMetadata extends ZodMetadata = undefined>(params: CreateActionProps<TInput, TOutput, TMetadata>): CreateActionResponse<TInput, TOutput, TMetadata>;
 export interface CreateOnEventProps<TMetadata extends ZodMetadata = undefined> {
+    /**
+     * The version of the onEvent script.
+     * Use it to track changes to the onEvent script inside Nango's UI.
+     *
+     * @default '0.0.1'
+     * @example '1.0.0'
+     */
     version?: string;
+    /**
+     * The description of the onEvent script.
+     *
+     * @example 'Fetch id from GitHub'
+     */
     description: string;
+    /**
+     * The event that will trigger this script.
+     */
     event: 'post-connection-creation' | 'pre-connection-deletion';
+    /**
+     * The connection's metadata of the script.
+     *
+     * @default z.void();
+     * @example
+     * ```ts
+     * metadata: z.object({
+     *     userId: z.string(),
+     * });
+     * ```
+     */
     metadata?: TMetadata;
+    /**
+     * The function that will be called when the onEvent script is triggered.
+     * @example
+     * ```ts
+     * exec: async (nango) => {
+     *  await nango.log('Hello, world!');
+     * }
+     * ```
+     */
     exec: (nango: NangoActionBase<TMetadata>) => MaybePromise<void>;
 }
 export interface CreateOnEventResponse<TMetadata extends ZodMetadata = undefined> extends CreateOnEventProps<TMetadata> {

package/dist/scripts.js.map

@@ -1 +1 @@
-{"version":3,"file":"scripts.js","sourceRoot":"","sources":["../lib/scripts.ts"],"names":[],"mappings":"AA+IA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,UAAU,CACtB,MAA2C;IAE3C,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;AACvC,CAAC;AAuGD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,YAAY,CACxB,MAAqD;IAErD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;AACzC,CAAC;AAaD;;GAEG;AACH,MAAM,UAAU,aAAa,CAA4C,MAAqC;IAC1G,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,EAAE,CAAC;AAC1C,CAAC"}
+{"version":3,"file":"scripts.js","sourceRoot":"","sources":["../lib/scripts.ts"],"names":[],"mappings":"AA0JA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,UAAU,CACtB,MAA2C;IAE3C,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;AACvC,CAAC;AAuGD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,YAAY,CACxB,MAAqD;IAErD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;AACzC,CAAC;AAoDD;;GAEG;AACH,MAAM,UAAU,aAAa,CAA4C,MAAqC;IAC1G,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,EAAE,CAAC;AAC1C,CAAC"}

package/package.json

@@ -1,19 +1,19 @@
 {
     "name": "@nangohq/runner-sdk",
-    "version": "0.64.0",
+    "version": "0.64.1",
     "description": "Nango's Runner SDK",
     "type": "module",
     "main": "dist/index.js",
     "dependencies": {
-        "@nangohq/node": "0.64.0",
-        "@nangohq/providers": "0.64.0",
+        "@nangohq/node": "0.64.1",
+        "@nangohq/providers": "0.64.1",
         "ajv": "8.17.1",
         "ajv-formats": "3.0.1",
         "lodash-es": "4.17.21",
         "parse-link-header": "2.0.0"
     },
     "devDependencies": {
-        "@nangohq/types": "0.64.0",
+        "@nangohq/types": "0.64.1",
         "@types/json-schema": "7.0.15",
         "axios": "1.9.0",
         "json-schema": "0.4.0",