@zapier/zapier-sdk 0.13.6 → 0.13.8

package/src/types/telemetry-events.ts

@@ -1,85 +0,0 @@
-/**
- * Event emission types matching Avro schemas for SDK telemetry
- *
- * These interfaces correspond to the Avro schemas:
- * - application_lifecycle_event.avsc
- * - error_occurred_event.avsc
- */
-
-// Common fields present in all events
-export interface BaseEvent {
-  event_id: string;
-  timestamp_ms: number;
-  release_id: string;
-  customuser_id?: number | null;
-  account_id?: number | null;
-  identity_id?: number | null;
-  visitor_id?: string | null;
-  correlation_id?: string | null;
-}
-
-// Error Event - tracks SDK errors and exceptions
-export interface ErrorOccurredEvent extends BaseEvent {
-  zap_id?: number | null;
-  node_id?: number | null;
-  selected_api?: string | null;
-  app_id?: number | null;
-  app_version_id?: number | null;
-  error_message: string;
-  error_type?: string | null;
-  error_status_code?: number | null;
-  error_stack_trace?: string | null;
-  error_source_method?: string | null;
-  error_source_file?: string | null;
-  error_line_number?: number | null;
-  operation_type?: string | null;
-  operation_key?: string | null;
-  error_severity?: string | null;
-  is_user_facing: boolean;
-  is_recoverable?: boolean | null;
-  sdk_version?: string | null;
-  error_metadata?: Record<string, string | null> | null;
-  parent_error_id?: string | null;
-  error_occurred_timestamp_ms?: number | null;
-  error_code?: string | null;
-  recovery_attempted?: boolean | null;
-  recovery_action?: string | null;
-  recovery_successful?: boolean | null;
-  environment?: string | null;
-  execution_time_before_error_ms?: number | null;
-}
-
-// Application Lifecycle Event - tracks SDK application lifecycle transitions
-export interface ApplicationLifecycleEvent extends BaseEvent {
-  lifecycle_event_type: "startup" | "exit" | "signal_termination";
-  selected_api?: string | null;
-  app_id?: number | null;
-  app_version_id?: number | null;
-  sdk_version?: string | null;
-  cli_version?: string | null;
-  exit_code?: number | null;
-  signal_name?: string | null;
-  uptime_ms?: number | null;
-  memory_usage_bytes?: number | null;
-  peak_memory_usage_bytes?: number | null;
-  cpu_time_ms?: number | null;
-  os_platform?: string | null;
-  os_release?: string | null;
-  os_architecture?: string | null;
-  platform_versions?: Record<string, string | null> | null;
-  environment?: string | null;
-  is_ci_environment?: boolean | null;
-  ci_platform?: string | null;
-  session_id?: string | null;
-  metadata?: Record<string, string | null> | null;
-  process_argv?: (string | null)[] | null;
-  is_graceful_shutdown?: boolean | null;
-  shutdown_duration_ms?: number | null;
-  active_requests_count?: number | null;
-}
-
-// Union type for all telemetry events
-export type TelemetryEvent = ErrorOccurredEvent | ApplicationLifecycleEvent;
-
-// Event type discriminator
-export type TelemetryEventType = "error_occurred" | "application_lifecycle";

package/src/utils/array-utils.test.ts

@@ -1,131 +0,0 @@
-import { describe, it, expect } from "vitest";
-import { toArrayFromAsync } from "./array-utils";
-
-describe("array-utils", () => {
-  describe("fromAsync", () => {
-    it("should convert async generator to array", async () => {
-      async function* generateNumbers() {
-        yield 1;
-        yield 2;
-        yield 3;
-      }
-
-      const result = await toArrayFromAsync(generateNumbers());
-      expect(result).toEqual([1, 2, 3]);
-    });
-
-    it("should handle empty async generator", async () => {
-      async function* generateNothing() {
-        // yield nothing
-      }
-
-      const result = await toArrayFromAsync(generateNothing());
-      expect(result).toEqual([]);
-    });
-
-    it("should handle async generator with async operations", async () => {
-      async function* generateWithDelay() {
-        for (let i = 1; i <= 3; i++) {
-          await new Promise((resolve) => setTimeout(resolve, 1)); // Small delay
-          yield i * 10;
-        }
-      }
-
-      const result = await toArrayFromAsync(generateWithDelay());
-      expect(result).toEqual([10, 20, 30]);
-    });
-
-    it("should handle async generator that yields different types", async () => {
-      async function* generateMixed() {
-        yield "hello";
-        yield 42;
-        yield { name: "test" };
-        yield [1, 2, 3];
-      }
-
-      const result = await toArrayFromAsync(generateMixed());
-      expect(result).toEqual(["hello", 42, { name: "test" }, [1, 2, 3]]);
-    });
-
-    it("should handle async generator with error", async () => {
-      async function* generateWithError() {
-        yield 1;
-        yield 2;
-        throw new Error("Test error");
-      }
-
-      await expect(toArrayFromAsync(generateWithError())).rejects.toThrow(
-        "Test error",
-      );
-    });
-
-    it("should handle async iterable from array with Symbol.asyncIterator", async () => {
-      const asyncIterable = {
-        async *[Symbol.asyncIterator]() {
-          for (const item of ["a", "b", "c"]) {
-            yield item;
-          }
-        },
-      };
-
-      const result = await toArrayFromAsync(asyncIterable);
-      expect(result).toEqual(["a", "b", "c"]);
-    });
-
-    it("should handle large async generator efficiently", async () => {
-      async function* generateLargeSequence() {
-        for (let i = 0; i < 1000; i++) {
-          yield i;
-        }
-      }
-
-      const result = await toArrayFromAsync(generateLargeSequence());
-      expect(result).toHaveLength(1000);
-      expect(result[0]).toBe(0);
-      expect(result[999]).toBe(999);
-    });
-
-    it("should handle async generator that yields promises (promises are auto-awaited)", async () => {
-      async function* generatePromises() {
-        yield Promise.resolve("first");
-        yield Promise.resolve("second");
-      }
-
-      const result = await toArrayFromAsync(generatePromises());
-      // for await automatically awaits promises, so we get resolved values
-      expect(result).toEqual(["first", "second"]);
-    });
-
-    it("should handle async generator that yields already resolved values", async () => {
-      async function* generateResolvedValues() {
-        yield await Promise.resolve("first");
-        yield await Promise.resolve("second");
-      }
-
-      const result = await toArrayFromAsync(generateResolvedValues());
-      // The resolved values are yielded directly
-      expect(result).toEqual(["first", "second"]);
-    });
-
-    it("should maintain order of async generator items", async () => {
-      async function* generateInOrder() {
-        for (let i = 1; i <= 5; i++) {
-          // Simulate varying delays
-          await new Promise((resolve) =>
-            setTimeout(resolve, Math.random() * 10),
-          );
-          yield `item-${i}`;
-        }
-      }
-
-      const result = await toArrayFromAsync(generateInOrder());
-      expect(result).toEqual([
-        "item-1",
-        "item-2",
-        "item-3",
-        "item-4",
-        "item-5",
-      ]);
-    });
-  });
-});

package/src/utils/array-utils.ts

@@ -1,41 +0,0 @@
-/**
- * Array utility functions for working with async iterators and arrays
- */
-
-/**
- * Creates an array from an async iterable, similar to Array.from() but for async iterables
- *
- * @param asyncIterable - An async iterable to convert to an array
- * @returns Promise that resolves to an array containing all items from the async iterable
- *
- * @example
- * async function* generateNumbers() {
- *   yield 1;
- *   yield 2;
- *   yield 3;
- * }
- *
- * const numbers = await fromAsync(generateNumbers()); // [1, 2, 3]
- *
- * @example
- * // With async generator that fetches data
- * async function* fetchUsers() {
- *   for (let page = 1; page <= 3; page++) {
- *     const users = await fetchUsersPage(page);
- *     yield* users;
- *   }
- * }
- *
- * const allUsers = await fromAsync(fetchUsers());
- */
-export async function toArrayFromAsync<T>(
-  asyncIterable: AsyncIterable<T>,
-): Promise<T[]> {
-  const result: T[] = [];
-
-  for await (const item of asyncIterable) {
-    result.push(item);
-  }
-
-  return result;
-}

package/src/utils/domain-utils.test.ts

@@ -1,433 +0,0 @@
-import { describe, it, expect } from "vitest";
-import {
-  groupVersionedAppKeysByType,
-  groupAppKeysByType,
-  toAppLocator,
-} from "./domain-utils";
-
-describe("domain-utils", () => {
-  describe("groupVersionedAppKeysByType", () => {
-    it("should reject UUID app keys", () => {
-      expect(() => {
-        groupVersionedAppKeysByType(["61e47557-af91-4b0c-a3e0-c28606357664"]);
-      }).toThrow(
-        "UUID app keys are not supported. Use app slug or implementation ID instead of: 61e47557-af91-4b0c-a3e0-c28606357664",
-      );
-    });
-
-    it("should categorize *API as selectedApi", () => {
-      const result = groupVersionedAppKeysByType(["FormatterCLIAPI"]);
-
-      expect(result).toEqual({
-        selectedApi: ["FormatterCLIAPI"],
-        slug: [],
-      });
-    });
-
-    it("should categorize various API types as selectedApi", () => {
-      const result = groupVersionedAppKeysByType([
-        "FormatterCLIAPI",
-        "SlackAPI",
-        "GmailRESTAPI",
-        "WebhookAPI",
-        "AnythingWithUppercase",
-      ]);
-
-      expect(result).toEqual({
-        selectedApi: [
-          "FormatterCLIAPI",
-          "SlackAPI",
-          "GmailRESTAPI",
-          "WebhookAPI",
-          "AnythingWithUppercase",
-        ],
-        slug: [],
-      });
-    });
-
-    it("should categorize lower-case strings as slugs, converting underscores to dashes", () => {
-      const result = groupVersionedAppKeysByType([
-        "slack",
-        "google-sheets",
-        "_100hires_ats",
-        "amazon_redshift",
-      ]);
-
-      expect(result).toEqual({
-        selectedApi: [],
-        slug: ["slack", "google-sheets", "100hires-ats", "amazon-redshift"],
-      });
-    });
-
-    it("should preserve version from API implementations", () => {
-      const result = groupVersionedAppKeysByType(["FormatterCLIAPI@1.0.0"]);
-
-      expect(result).toEqual({
-        selectedApi: ["FormatterCLIAPI@1.0.0"],
-        slug: [],
-      });
-    });
-
-    it("should preserve version from slugs", () => {
-      const result = groupVersionedAppKeysByType(["slack@2.1.0"]);
-
-      expect(result).toEqual({
-        selectedApi: [],
-        slug: ["slack@2.1.0"],
-      });
-    });
-
-    it("should handle mixed types correctly", () => {
-      const result = groupVersionedAppKeysByType([
-        "FormatterCLIAPI@1.0.0",
-        "slack",
-        "AnotherAPI",
-        "gmail@3.0.1",
-      ]);
-
-      expect(result).toEqual({
-        selectedApi: ["FormatterCLIAPI@1.0.0", "AnotherAPI"],
-        slug: ["slack", "gmail@3.0.1"],
-      });
-    });
-
-    it("should handle empty array", () => {
-      const result = groupVersionedAppKeysByType([]);
-
-      expect(result).toEqual({
-        selectedApi: [],
-        slug: [],
-      });
-    });
-
-    it("should reject uppercase and lowercase UUIDs", () => {
-      expect(() => {
-        groupVersionedAppKeysByType(["61E47557-AF91-4B0C-A3E0-C28606357664"]);
-      }).toThrow(
-        "UUID app keys are not supported. Use app slug or implementation ID instead of: 61E47557-AF91-4B0C-A3E0-C28606357664",
-      );
-
-      expect(() => {
-        groupVersionedAppKeysByType(["f47ac10b-58cc-4372-a567-0e02b2c3d479"]);
-      }).toThrow(
-        "UUID app keys are not supported. Use app slug or implementation ID instead of: f47ac10b-58cc-4372-a567-0e02b2c3d479",
-      );
-    });
-
-    it("should categorize partial UUIDs as slugs", () => {
-      const result = groupVersionedAppKeysByType([
-        "61e47557-af91-4b0c-a3e0", // too short
-        "61e47557-af91-4b0c-a3e0-c28606357664-extra", // too long
-      ]);
-
-      expect(result).toEqual({
-        selectedApi: [],
-        slug: [
-          "61e47557-af91-4b0c-a3e0",
-          "61e47557-af91-4b0c-a3e0-c28606357664-extra",
-        ],
-      });
-    });
-
-    it("should dedupe exact duplicate versioned keys", () => {
-      const result = groupVersionedAppKeysByType([
-        "slack@2.1.0",
-        "FormatterCLIAPI@1.0.0",
-        "slack@2.1.0", // exact duplicate
-        "FormatterCLIAPI@1.0.0", // exact duplicate
-        "slack@2.1.1",
-        "FormatterCLIAPI@1.0.1",
-      ]);
-
-      expect(result).toEqual({
-        selectedApi: ["FormatterCLIAPI@1.0.0", "FormatterCLIAPI@1.0.1"],
-        slug: ["slack@2.1.0", "slack@2.1.1"],
-      });
-    });
-  });
-
-  describe("groupAppKeysByType", () => {
-    it("should strip versions from API implementations", () => {
-      const result = groupAppKeysByType(["FormatterCLIAPI@1.0.0"]);
-
-      expect(result).toEqual({
-        selectedApi: ["FormatterCLIAPI"],
-        slug: [],
-      });
-    });
-
-    it("should strip versions from slugs", () => {
-      const result = groupAppKeysByType(["slack@2.1.0"]);
-
-      expect(result).toEqual({
-        selectedApi: [],
-        slug: ["slack"],
-      });
-    });
-
-    it("should handle mixed types and strip versions", () => {
-      const result = groupAppKeysByType([
-        "FormatterCLIAPI@1.0.0",
-        "slack",
-        "AnotherAPI@2.3.4",
-        "gmail@3.0.1",
-      ]);
-
-      expect(result).toEqual({
-        selectedApi: ["FormatterCLIAPI", "AnotherAPI"],
-        slug: ["slack", "gmail"],
-      });
-    });
-
-    it("should handle keys without versions", () => {
-      const result = groupAppKeysByType([
-        "FormatterCLIAPI",
-        "slack",
-        "AnotherAPI",
-      ]);
-
-      expect(result).toEqual({
-        selectedApi: ["FormatterCLIAPI", "AnotherAPI"],
-        slug: ["slack"],
-      });
-    });
-
-    it("should reject UUID app keys (delegated to versioned function)", () => {
-      expect(() => {
-        groupAppKeysByType(["61e47557-af91-4b0c-a3e0-c28606357664"]);
-      }).toThrow(
-        "UUID app keys are not supported. Use app slug or implementation ID instead of: 61e47557-af91-4b0c-a3e0-c28606357664",
-      );
-    });
-
-    it("should handle empty array", () => {
-      const result = groupAppKeysByType([]);
-
-      expect(result).toEqual({
-        selectedApi: [],
-        slug: [],
-      });
-    });
-
-    it("should dedupe multiple versions of same base key", () => {
-      const result = groupAppKeysByType([
-        "slack@1.0.0",
-        "FormatterCLIAPI@2.1.0",
-        "slack@1.2.3", // different version of slack
-        "FormatterCLIAPI@1.0.0", // different version of FormatterCLIAPI
-        "gmail",
-      ]);
-
-      expect(result).toEqual({
-        selectedApi: ["FormatterCLIAPI"], // only one instance despite multiple versions
-        slug: ["slack", "gmail"], // only one slack despite multiple versions
-      });
-    });
-
-    it("should dedupe exact duplicates after version stripping", () => {
-      const result = groupAppKeysByType([
-        "slack@1.0.0",
-        "slack", // no version
-        "slack@2.0.0", // different version
-        "FormatterCLIAPI",
-        "FormatterCLIAPI@1.5.0",
-      ]);
-
-      expect(result).toEqual({
-        selectedApi: ["FormatterCLIAPI"],
-        slug: ["slack"],
-      });
-    });
-  });
-
-  describe("toAppLocator", () => {
-    it("should reject UUID app keys", () => {
-      expect(() => {
-        toAppLocator("61e47557-af91-4b0c-a3e0-c28606357664");
-      }).toThrow(
-        "UUID app keys are not supported. Use app slug or implementation ID instead of: 61e47557-af91-4b0c-a3e0-c28606357664",
-      );
-    });
-
-    it("should reject UUID app keys with versions", () => {
-      expect(() => {
-        toAppLocator("61e47557-af91-4b0c-a3e0-c28606357664@1.0.0");
-      }).toThrow(
-        "UUID app keys are not supported. Use app slug or implementation ID instead of: 61e47557-af91-4b0c-a3e0-c28606357664@1.0.0",
-      );
-    });
-
-    it("should reject uppercase UUID app keys", () => {
-      expect(() => {
-        toAppLocator("61E47557-AF91-4B0C-A3E0-C28606357664");
-      }).toThrow(
-        "UUID app keys are not supported. Use app slug or implementation ID instead of: 61E47557-AF91-4B0C-A3E0-C28606357664",
-      );
-    });
-
-    it("should handle simple slug without version", () => {
-      const result = toAppLocator("slack");
-
-      expect(result).toEqual({
-        lookupAppKey: "slack",
-        slug: "slack",
-        implementationName: undefined,
-        version: undefined,
-      });
-    });
-
-    it("should handle slug with version", () => {
-      const result = toAppLocator("slack@1.0.0");
-
-      expect(result).toEqual({
-        lookupAppKey: "slack",
-        slug: "slack",
-        implementationName: undefined,
-        version: "1.0.0",
-      });
-    });
-
-    it("should handle dashified slug", () => {
-      const result = toAppLocator("google-sheets");
-
-      expect(result).toEqual({
-        lookupAppKey: "google-sheets",
-        slug: "google-sheets",
-        implementationName: undefined,
-        version: undefined,
-      });
-    });
-
-    it("should handle dashified slug with version", () => {
-      const result = toAppLocator("google-sheets@2.1.3");
-
-      expect(result).toEqual({
-        lookupAppKey: "google-sheets",
-        slug: "google-sheets",
-        implementationName: undefined,
-        version: "2.1.3",
-      });
-    });
-
-    it("should handle snake_cased slug and convert to dash", () => {
-      const result = toAppLocator("google_sheets");
-
-      expect(result).toEqual({
-        lookupAppKey: "google_sheets",
-        slug: "google-sheets",
-        implementationName: undefined,
-        version: undefined,
-      });
-    });
-
-    it("should handle snake_cased slug with version and convert to dash", () => {
-      const result = toAppLocator("google_sheets@2.1.3");
-
-      expect(result).toEqual({
-        lookupAppKey: "google_sheets",
-        slug: "google-sheets",
-        implementationName: undefined,
-        version: "2.1.3",
-      });
-    });
-
-    it("should handle leading underscore snake_cased slug", () => {
-      const result = toAppLocator("_100hires_ats");
-
-      expect(result).toEqual({
-        lookupAppKey: "_100hires_ats",
-        slug: "100hires-ats",
-        implementationName: undefined,
-        version: undefined,
-      });
-    });
-
-    it("should handle leading underscore snake_cased slug with version", () => {
-      const result = toAppLocator("_100hires_ats@3.0.0");
-
-      expect(result).toEqual({
-        lookupAppKey: "_100hires_ats",
-        slug: "100hires-ats",
-        implementationName: undefined,
-        version: "3.0.0",
-      });
-    });
-
-    it("should handle implementation name without version", () => {
-      const result = toAppLocator("SlackCLIAPI");
-
-      expect(result).toEqual({
-        lookupAppKey: "SlackCLIAPI",
-        slug: undefined,
-        implementationName: "SlackCLIAPI",
-        version: undefined,
-      });
-    });
-
-    it("should handle implementation name with version", () => {
-      const result = toAppLocator("SlackCLIAPI@1.29.0");
-
-      expect(result).toEqual({
-        lookupAppKey: "SlackCLIAPI",
-        slug: undefined,
-        implementationName: "SlackCLIAPI",
-        version: "1.29.0",
-      });
-    });
-
-    it("should handle edge cases with complex version numbers", () => {
-      const result = toAppLocator("slack@1.2.3-beta.4+build.5");
-
-      expect(result).toEqual({
-        lookupAppKey: "slack",
-        slug: "slack",
-        implementationName: undefined,
-        version: "1.2.3-beta.4+build.5",
-      });
-    });
-
-    it("should handle single character app keys", () => {
-      const result = toAppLocator("a");
-
-      expect(result).toEqual({
-        lookupAppKey: "a",
-        slug: "a",
-        implementationName: undefined,
-        version: undefined,
-      });
-    });
-
-    it("should handle app keys with numbers", () => {
-      const result = toAppLocator("app123");
-
-      expect(result).toEqual({
-        lookupAppKey: "app123",
-        slug: "app123",
-        implementationName: undefined,
-        version: undefined,
-      });
-    });
-
-    it("should handle mixed case app keys that aren't implementation names", () => {
-      const result = toAppLocator("SlackBot");
-
-      expect(result).toEqual({
-        lookupAppKey: "SlackBot",
-        slug: undefined,
-        implementationName: "SlackBot",
-        version: undefined,
-      });
-    });
-
-    it("should handle empty version (app key ending with @)", () => {
-      const result = toAppLocator("slack@");
-
-      expect(result).toEqual({
-        lookupAppKey: "slack",
-        slug: "slack",
-        implementationName: undefined,
-        version: "",
-      });
-    });
-  });
-});