@zapier/zapier-sdk 0.15.10 → 0.15.11

package/dist/utils/function-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"function-utils.d.ts","sourceRoot":"","sources":["../../src/utils/function-utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAK7B;;GAEG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GAAG,IAAI,GAAG,SAAS,GAChD,MAAM,GAAG,SAAS,CAYpB;AAcD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EACR,OAAO,EACP,cAAc,SAAS,QAAQ,GAAG,QAAQ,EAE1C,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,OAAO,CAAC,OAAO,CAAC,EAC/C,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,cAMQ,QAAQ,KAAG,OAAO,CAAC,OAAO,CAAC,CAqBxE;AAiDD;;;;;GAKG;AACH,KAAK,eAAe,CAAC,OAAO,IAAI,OAAO,SAAS;IAC9C,IAAI,EAAE,GAAG,CAAC;IACV,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,GACG,OAAO,GACP;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3C,KAAK,QAAQ,CAAC,OAAO,IAAI,OAAO,SAAS;IAAE,IAAI,EAAE,MAAM,KAAK,CAAA;CAAE,GAC1D,KAAK,SAAS,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,GACpC,KAAK,GACL,KAAK,GACP,OAAO,SAAS,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,GACtC,KAAK,GACL,OAAO,CAAC;AAEd,wBAAgB,uBAAuB,CACrC,QAAQ,EACR,OAAO,EACP,cAAc,SAAS,QAAQ,GAAG,QAAQ,EAE1C,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,KAAK,OAAO,CAAC,OAAO,CAAC,EACtE,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,GACnC,CACD,OAAO,CAAC,EAAE,QAAQ,GAAG;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,KACE,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GACpC,aAAa,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GAAG;IACxC,KAAK,IAAI,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;CAC3C,CA8EF"}
+{"version":3,"file":"function-utils.d.ts","sourceRoot":"","sources":["../../src/utils/function-utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;EAMhC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,cAAc,CAAC,EAAE,CAAC,IAAI,EAAE;QACtB,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,OAAO,CAAC;QACjB,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,aAAa,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,OAAO,CAAC;KACtB,KAAK,IAAI,CAAC;CACZ;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GAAG,IAAI,GAAG,SAAS,GAChD,MAAM,GAAG,SAAS,CAYpB;AAcD;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EACR,OAAO,EACP,cAAc,SAAS,QAAQ,GAAG,QAAQ,EAE1C,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,OAAO,CAAC,OAAO,CAAC,EAC/C,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,EACpC,SAAS,CAAC,EAAE,kBAAkB,cAMc,QAAQ,KAAG,OAAO,CAAC,OAAO,CAAC,CAsExE;AAiDD;;;;;GAKG;AACH,KAAK,eAAe,CAAC,OAAO,IAAI,OAAO,SAAS;IAC9C,IAAI,EAAE,GAAG,CAAC;IACV,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,GACG,OAAO,GACP;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3C,KAAK,QAAQ,CAAC,OAAO,IAAI,OAAO,SAAS;IAAE,IAAI,EAAE,MAAM,KAAK,CAAA;CAAE,GAC1D,KAAK,SAAS,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,GACpC,KAAK,GACL,KAAK,GACP,OAAO,SAAS,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,GACtC,KAAK,GACL,OAAO,CAAC;AAEd,wBAAgB,uBAAuB,CACrC,QAAQ,EACR,OAAO,EACP,cAAc,SAAS,QAAQ,GAAG,QAAQ,EAE1C,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,KAAK,OAAO,CAAC,OAAO,CAAC,EACtE,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,EACpC,SAAS,CAAC,EAAE,kBAAkB,GAC7B,CACD,OAAO,CAAC,EAAE,QAAQ,GAAG;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,KACE,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GACpC,aAAa,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GAAG;IACxC,KAAK,IAAI,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;CAC3C,CAgHF"}

package/dist/utils/function-utils.js

@@ -1,9 +1,21 @@
 /**
  * Generic utility functions for creating paginated SDK functions
  */
+import { z } from "zod";
 import { ZapierError, ZapierUnknownError } from "../types/errors";
 import { paginate } from "./pagination-utils";
 import { createValidator, validateOptions } from "./validation";
+/**
+ * Zod schema for telemetry marker to prevent nested telemetry emissions.
+ * Used to extend options schemas with proper typing.
+ */
+export const TelemetryMarkerSchema = z.object({
+    _telemetry: z
+        .object({
+        isNested: z.boolean().optional(),
+    })
+        .optional(),
+});
 /**
  * Helper function to extract cursor from pagination data
  */
@@ -35,28 +47,64 @@ function normalizeError(error) {
  *
  * @param coreFn - Function that returns T directly or throws errors
  * @param schema - Optional Zod schema for validation
+ * @param telemetry - Optional telemetry callbacks
  * @returns A function that normalizes and rethrows errors
  */
-export function createFunction(coreFn, schema) {
+export function createFunction(coreFn, schema, telemetry) {
     const functionName = coreFn.name;
     // Create a named function using dynamic property access
     const namedFunctions = {
         [functionName]: async function (options) {
+            const startTime = Date.now();
+            const normalizedOptions = (options ?? {});
+            const isNested = normalizedOptions?._telemetry?.isNested === true;
             try {
-                // Convert undefined options to empty object
-                const normalizedOptions = (options ?? {});
                 if (schema) {
                     const validatedOptions = validateOptions(schema, normalizedOptions);
-                    return await coreFn({
+                    const result = await coreFn({
                         ...normalizedOptions,
                         ...validatedOptions,
                     });
+                    // Emit telemetry only for top-level calls
+                    if (!isNested && telemetry?.onMethodCalled) {
+                        const argumentCount = Object.keys(normalizedOptions).filter((k) => k !== "_telemetry").length;
+                        telemetry.onMethodCalled({
+                            methodName: functionName,
+                            durationMs: Date.now() - startTime,
+                            success: true,
+                            argumentCount,
+                            isPaginated: false,
+                        });
+                    }
+                    return result;
                 }
-                return await coreFn(normalizedOptions);
+                const result = await coreFn(normalizedOptions);
+                if (!isNested && telemetry?.onMethodCalled) {
+                    const argumentCount = Object.keys(normalizedOptions).filter((k) => k !== "_telemetry").length;
+                    telemetry.onMethodCalled({
+                        methodName: functionName,
+                        durationMs: Date.now() - startTime,
+                        success: true,
+                        argumentCount,
+                        isPaginated: false,
+                    });
+                }
+                return result;
             }
             catch (error) {
-                // Catch and normalize any errors, then rethrow
-                throw normalizeError(error);
+                const normalizedError = normalizeError(error);
+                if (!isNested && telemetry?.onMethodCalled) {
+                    const argumentCount = Object.keys(normalizedOptions).filter((k) => k !== "_telemetry").length;
+                    telemetry.onMethodCalled({
+                        methodName: functionName,
+                        durationMs: Date.now() - startTime,
+                        success: false,
+                        error: normalizedError,
+                        argumentCount,
+                        isPaginated: false,
+                    });
+                }
+                throw normalizedError;
             }
         },
     };
@@ -96,15 +144,17 @@ function createPageFunction(coreFn) {
     };
     return namedFunctions[functionName];
 }
-export function createPaginatedFunction(coreFn, schema) {
+export function createPaginatedFunction(coreFn, schema, telemetry) {
     const pageFunction = createPageFunction(coreFn);
     const functionName = coreFn.name;
     const validator = schema ? createValidator(schema) : null;
     // Create the main paginated function
     const namedFunctions = {
         [functionName]: function (options) {
+            const startTime = Date.now();
             // Convert undefined options to empty object
             const normalizedOptions = (options ?? {});
+            const isNested = normalizedOptions?._telemetry?.isNested === true;
             // Validate options if schema provided (validated fields take precedence)
             const validatedOptions = {
                 ...normalizedOptions,
@@ -124,6 +174,31 @@ export function createPaginatedFunction(coreFn, schema) {
                 }
                 return result.value;
             });
+            // Emit telemetry after first page completes
+            if (!isNested && telemetry?.onMethodCalled) {
+                firstPagePromise
+                    .then(() => {
+                    const argumentCount = Object.keys(normalizedOptions).filter((k) => k !== "_telemetry").length;
+                    telemetry.onMethodCalled({
+                        methodName: functionName,
+                        durationMs: Date.now() - startTime,
+                        success: true,
+                        argumentCount,
+                        isPaginated: true,
+                    });
+                })
+                    .catch((error) => {
+                    const argumentCount = Object.keys(normalizedOptions).filter((k) => k !== "_telemetry").length;
+                    telemetry.onMethodCalled({
+                        methodName: functionName,
+                        durationMs: Date.now() - startTime,
+                        success: false,
+                        error: error instanceof Error ? error : new Error(String(error)),
+                        argumentCount,
+                        isPaginated: true,
+                    });
+                });
+            }
             // Add Symbol.asyncIterator to make the promise iterable
             return Object.assign(firstPagePromise, {
                 [Symbol.asyncIterator]: async function* () {

package/dist/utils/telemetry-utils.d.ts

@@ -0,0 +1,32 @@
+import type { TelemetryCallbacks } from "./function-utils";
+import type { EventEmissionContext } from "../plugins/eventEmission";
+/**
+ * Creates a standardized telemetry callback for SDK method invocations.
+ *
+ * This factory eliminates boilerplate by providing a consistent implementation
+ * of the onMethodCalled callback used by createFunction and createPaginatedFunction.
+ *
+ * @param emitMethodCalled - The event emission function from EventEmissionContext
+ * @param methodName - The explicit method name to use in telemetry. This avoids bundler
+ *   mangling where esbuild/tsup renames inner functions to avoid collisions. For example:
+ *   ```typescript
+ *   // Source code:
+ *   const getAction = createFunction(async function getAction(options) { ... });
+ *
+ *   // Bundled output (inner function renamed to avoid collision with outer const):
+ *   const getAction = createFunction(async function getAction2(options) { ... });
+ *   ```
+ *   Without an explicit methodName, telemetry would report "getAction2" instead of "getAction".
+ * @returns TelemetryCallbacks object with standardized onMethodCalled implementation
+ *
+ * @example
+ * ```typescript
+ * const listApps = createFunction(
+ *   async function listApps(options) { ... },
+ *   ListAppsSchema,
+ *   createTelemetryCallback(context.eventEmission.emitMethodCalled, "listApps"),
+ * );
+ * ```
+ */
+export declare function createTelemetryCallback(emitMethodCalled: EventEmissionContext["eventEmission"]["emitMethodCalled"], methodName: string): TelemetryCallbacks;
+//# sourceMappingURL=telemetry-utils.d.ts.map

package/dist/utils/telemetry-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry-utils.d.ts","sourceRoot":"","sources":["../../src/utils/telemetry-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,uBAAuB,CACrC,gBAAgB,EAAE,oBAAoB,CAAC,eAAe,CAAC,CAAC,kBAAkB,CAAC,EAC3E,UAAU,EAAE,MAAM,GACjB,kBAAkB,CAcpB"}

package/dist/utils/telemetry-utils.js

@@ -0,0 +1,43 @@
+/**
+ * Creates a standardized telemetry callback for SDK method invocations.
+ *
+ * This factory eliminates boilerplate by providing a consistent implementation
+ * of the onMethodCalled callback used by createFunction and createPaginatedFunction.
+ *
+ * @param emitMethodCalled - The event emission function from EventEmissionContext
+ * @param methodName - The explicit method name to use in telemetry. This avoids bundler
+ *   mangling where esbuild/tsup renames inner functions to avoid collisions. For example:
+ *   ```typescript
+ *   // Source code:
+ *   const getAction = createFunction(async function getAction(options) { ... });
+ *
+ *   // Bundled output (inner function renamed to avoid collision with outer const):
+ *   const getAction = createFunction(async function getAction2(options) { ... });
+ *   ```
+ *   Without an explicit methodName, telemetry would report "getAction2" instead of "getAction".
+ * @returns TelemetryCallbacks object with standardized onMethodCalled implementation
+ *
+ * @example
+ * ```typescript
+ * const listApps = createFunction(
+ *   async function listApps(options) { ... },
+ *   ListAppsSchema,
+ *   createTelemetryCallback(context.eventEmission.emitMethodCalled, "listApps"),
+ * );
+ * ```
+ */
+export function createTelemetryCallback(emitMethodCalled, methodName) {
+    return {
+        onMethodCalled: (data) => {
+            emitMethodCalled({
+                method_name: methodName,
+                execution_duration_ms: data.durationMs,
+                success_flag: data.success,
+                error_message: data.error?.message ?? null,
+                error_type: data.error?.constructor.name ?? null,
+                argument_count: data.argumentCount,
+                is_paginated: data.isPaginated,
+            });
+        },
+    };
+}

package/dist/utils/telemetry-utils.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=telemetry-utils.test.d.ts.map

package/dist/utils/telemetry-utils.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry-utils.test.d.ts","sourceRoot":"","sources":["../../src/utils/telemetry-utils.test.ts"],"names":[],"mappings":""}

package/dist/utils/telemetry-utils.test.js

@@ -0,0 +1,94 @@
+import { describe, it, expect, vi } from "vitest";
+import { createTelemetryCallback } from "./telemetry-utils";
+describe("createTelemetryCallback", () => {
+    it("should create callback that emits telemetry with explicit method name", () => {
+        const mockEmit = vi.fn();
+        const callback = createTelemetryCallback(mockEmit, "testMethod");
+        callback.onMethodCalled({
+            methodName: "ignoredName",
+            durationMs: 123,
+            success: true,
+            argumentCount: 2,
+            isPaginated: false,
+        });
+        expect(mockEmit).toHaveBeenCalledWith({
+            method_name: "testMethod",
+            execution_duration_ms: 123,
+            success_flag: true,
+            error_message: null,
+            error_type: null,
+            argument_count: 2,
+            is_paginated: false,
+        });
+    });
+    it("should include error details when method fails", () => {
+        const mockEmit = vi.fn();
+        const callback = createTelemetryCallback(mockEmit, "failingMethod");
+        const testError = new Error("Test failure");
+        callback.onMethodCalled({
+            methodName: "ignoredName",
+            durationMs: 50,
+            success: false,
+            error: testError,
+            argumentCount: 1,
+            isPaginated: false,
+        });
+        expect(mockEmit).toHaveBeenCalledWith({
+            method_name: "failingMethod",
+            execution_duration_ms: 50,
+            success_flag: false,
+            error_message: "Test failure",
+            error_type: "Error",
+            argument_count: 1,
+            is_paginated: false,
+        });
+    });
+    it("should handle paginated method calls", () => {
+        const mockEmit = vi.fn();
+        const callback = createTelemetryCallback(mockEmit, "listItems");
+        callback.onMethodCalled({
+            methodName: "ignoredName",
+            durationMs: 200,
+            success: true,
+            argumentCount: 1,
+            isPaginated: true,
+        });
+        expect(mockEmit).toHaveBeenCalledWith({
+            method_name: "listItems",
+            execution_duration_ms: 200,
+            success_flag: true,
+            error_message: null,
+            error_type: null,
+            argument_count: 1,
+            is_paginated: true,
+        });
+    });
+    it("should handle custom error types", () => {
+        const mockEmit = vi.fn();
+        const callback = createTelemetryCallback(mockEmit, "customFailMethod");
+        class CustomError extends Error {
+            constructor(message) {
+                super(message);
+                this.name = "CustomError";
+            }
+        }
+        const customError = new CustomError("Custom failure");
+        callback.onMethodCalled({
+            methodName: "ignoredName",
+            durationMs: 75,
+            success: false,
+            error: customError,
+            argumentCount: 3,
+            isPaginated: false,
+        });
+        expect(mockEmit).toHaveBeenCalledWith({
+            method_name: "customFailMethod",
+            execution_duration_ms: 75,
+            success_flag: false,
+            error_message: "Custom failure",
+            error_type: "CustomError",
+            argument_count: 3,
+            is_paginated: false,
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zapier/zapier-sdk",
-  "version": "0.15.10",
+  "version": "0.15.11",
   "description": "Complete Zapier SDK - combines all Zapier SDK packages",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",