@zapier/zapier-sdk 0.13.5 → 0.13.7

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: "",
-      });
-    });
-  });
-});

package/src/utils/domain-utils.ts

@@ -1,267 +0,0 @@
-/**
- * Domain utility functions for working with app identifiers and data normalization
- */
-
-import type { Action, Authentication, ImplementationMeta } from "../api/types";
-import type { ActionItem, AppItem, AuthenticationItem } from "../types/domain";
-
-/**
- * Splits a versioned key to extract the base key and version
- *
- * @param versionedKey - Versioned key in format "KeyName@version" (e.g., "SlackCLIAPI@1.21.1")
- * @returns Tuple of [baseKey, version] or [versionedKey, undefined] if no @ symbol
- *
- * @example
- * splitVersionedKey("SlackCLIAPI@1.21.1") // ["SlackCLIAPI", "1.21.1"]
- * splitVersionedKey("SomeAPI") // ["SomeAPI", undefined]
- */
-export function splitVersionedKey(
-  versionedKey: string,
-): [string, string | undefined] {
-  const parts = versionedKey.split("@");
-  if (parts.length >= 2) {
-    const baseKey = parts[0];
-    const version = parts.slice(1).join("@"); // Handle edge case of multiple @ symbols
-    return [baseKey, version];
-  }
-  return [versionedKey, undefined];
-}
-
-/**
- * Converts a lightweight ImplementationMeta to a slimmed AppItem
- *
- * @param implementationMeta - Raw ImplementationMeta from API
- * @returns Normalized AppItem with essential fields only
- */
-export function normalizeImplementationMetaToAppItem(
-  implementationMeta: ImplementationMeta,
-): AppItem {
-  const [selectedApi, appVersion] = splitVersionedKey(implementationMeta.id);
-
-  const { id, name, ...restOfImplementationMeta } = implementationMeta;
-
-  return {
-    ...restOfImplementationMeta,
-    title: name,
-    key: selectedApi,
-    implementation_id: id,
-    version: appVersion,
-  };
-}
-
-/**
- * Converts an API Authentication to an AuthenticationItem with normalized field names
- *
- * @param auth - Raw Authentication from API
- * @param options - Additional fields to include
- * @param options.app_key - selected_api from implementations endpoint
- * @param options.app_version - Version extracted from selected_api
- * @returns Normalized AuthenticationItem
- */
-export function normalizeAuthenticationItem(
-  auth: Authentication,
-  options: { app_key?: string; app_version?: string } = {},
-): AuthenticationItem {
-  // Extract app key and version from selected_api if not provided
-  let appKey = options.app_key;
-  let appVersion = options.app_version;
-
-  if (auth.selected_api) {
-    const [extractedAppKey, extractedVersion] = splitVersionedKey(
-      auth.selected_api,
-    );
-
-    // Use extracted app key if not provided in options
-    if (!appKey) {
-      appKey = extractedAppKey;
-    }
-
-    // Use extracted version if not provided in options
-    if (!appVersion) {
-      appVersion = extractedVersion;
-    }
-  }
-
-  const {
-    selected_api: selectedApi,
-    customuser_id: userId,
-    ...restOfAuth
-  } = auth;
-
-  return {
-    ...restOfAuth, // Pass through all other API response fields except selected_api
-    implementation_id: selectedApi, // Rename selected_api to implementation_id
-    title: auth.title || (auth as any).label || undefined, // Coerce title from label if missing
-    is_expired: auth.is_stale, // Map is_stale to is_expired
-    expired_at: auth.marked_stale_at, // Map marked_stale_at to expired_at
-    app_key: appKey, // App key from implementations endpoint or parsed from selected_api
-    app_version: appVersion, // Version from selected_api or provided
-    user_id: userId, // Map customuser_id to user_id
-  };
-}
-
-export function normalizeActionItem(action: Action): ActionItem {
-  const { name, type, selected_api: selectedApi } = action;
-
-  // Split version from selected_api
-  const [appKey, appVersion] = selectedApi
-    ? splitVersionedKey(selectedApi)
-    : ["", undefined];
-
-  return {
-    // Only include the fields we want - explicitly list them
-    id: action.id,
-    key: action.key,
-    description: action.description,
-    is_important: action.is_important,
-    is_hidden: action.is_hidden,
-    // Transformed fields
-    app_key: appKey,
-    app_version: appVersion,
-    action_type: type,
-    title: name, // Map name to title
-    type: "action",
-  };
-}
-
-/**
- * Groups app keys by their type based on format patterns
- *
- * @param appKeys Array of app key strings to categorize
- * @returns Object with arrays of keys grouped by type: selectedApi (CLI APIs), slug (everything else)
- *
- * @example
- * groupVersionedAppKeysByType([
- *   'FormatterCLIAPI@1.0.0',
- *   'slack',
- *   'AnotherAPI'
- * ])
- * // Returns: {
- * //   selectedApi: ['FormatterCLIAPI@1.0.0', 'AnotherAPI'],
- * //   slug: ['slack']
- * // }
- */
-export function groupVersionedAppKeysByType(appKeys: string[]): {
-  selectedApi: string[];
-  slug: string[];
-} {
-  const result = {
-    selectedApi: [] as string[],
-    slug: [] as string[],
-  };
-
-  // Use Sets to track seen keys for deduplication
-  const seenSelectedApi = new Set<string>();
-  const seenSlugs = new Set<string>();
-
-  for (const key of appKeys) {
-    const appLocator = toAppLocator(key);
-
-    if (appLocator.slug) {
-      // For slugs, we need to reconstruct the versioned slug
-      const versionedSlug = appLocator.version
-        ? `${appLocator.slug}@${appLocator.version}`
-        : appLocator.slug;
-      if (!seenSlugs.has(versionedSlug)) {
-        seenSlugs.add(versionedSlug);
-        result.slug.push(versionedSlug);
-      }
-    } else {
-      // For implementation names (selectedApi)
-      if (!seenSelectedApi.has(key)) {
-        seenSelectedApi.add(key);
-        result.selectedApi.push(key);
-      }
-    }
-  }
-
-  return result;
-}
-
-export function groupAppKeysByType(appKeys: string[]): {
-  selectedApi: string[];
-  slug: string[];
-} {
-  const grouped = groupVersionedAppKeysByType(appKeys);
-
-  // Extract base keys and dedupe by using Set
-  return {
-    selectedApi: [
-      ...new Set(grouped.selectedApi.map((key) => key.split("@")[0])),
-    ],
-    slug: [...new Set(grouped.slug.map((key) => key.split("@")[0]))],
-  };
-}
-
-export function isSlug(slug: string): boolean {
-  return !!slug.match(/^[a-z0-9]+(?:-[a-z0-9]+)*$/);
-}
-
-export function isSnakeCasedSlug(slug: string): boolean {
-  // Allow leading underscore for slugs starting with a number.
-  if (slug.match(/^_[0-9]/)) {
-    slug = slug.slice(1);
-  }
-
-  return !!slug.match(/^[a-z0-9]+(?:_[a-z0-9]+)*$/);
-}
-
-export function dashifySnakeCasedSlug(slug: string): string {
-  // Only dashify if it's a valid snake_cased slug.
-  if (!isSnakeCasedSlug(slug)) {
-    return slug;
-  }
-
-  // Allow one leading underscore for slugs starting with a number.
-  if (slug.startsWith("_")) {
-    slug = slug.slice(1);
-  }
-
-  return slug.replace(/_/g, "-");
-}
-
-export interface AppLocator {
-  lookupAppKey: string;
-  slug?: string;
-  implementationName?: string;
-  version?: string;
-}
-export interface ResolvedAppLocator extends AppLocator {
-  implementationName: string;
-}
-
-export function isUuid(appKey: string): boolean {
-  return /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(
-    appKey,
-  );
-}
-
-export function toAppLocator(appKey: string): AppLocator {
-  const [appKeyWithoutVersion, version] = splitVersionedKey(appKey);
-  if (isUuid(appKeyWithoutVersion)) {
-    throw new Error(
-      `UUID app keys are not supported. Use app slug or implementation ID instead of: ${appKey}`,
-    );
-  }
-  const slug = isSlug(appKeyWithoutVersion)
-    ? appKeyWithoutVersion
-    : isSnakeCasedSlug(appKeyWithoutVersion)
-      ? dashifySnakeCasedSlug(appKeyWithoutVersion)
-      : undefined;
-  return {
-    lookupAppKey: appKeyWithoutVersion,
-    slug,
-    implementationName: slug ? undefined : appKeyWithoutVersion,
-    version,
-  };
-}
-
-export function isResolvedAppLocator(
-  appLocator: AppLocator,
-): appLocator is ResolvedAppLocator {
-  return !!appLocator.implementationName;
-}
-
-export function toImplementationId(appLocator: ResolvedAppLocator): string {
-  return `${appLocator.implementationName}@${appLocator.version || "latest"}`;
-}