@zapier/zapier-sdk 0.8.2 → 0.9.0

package/dist/plugins/lockVersion/index.test.js

@@ -1,129 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from "vitest";
-import { lockVersionPlugin } from "./index";
-import { createSdk } from "../../sdk";
-// Mock fs module
-vi.mock("fs", () => ({
-    readFileSync: vi.fn(),
-    writeFileSync: vi.fn(),
-    existsSync: vi.fn(),
-}));
-// Mock path module
-vi.mock("path", () => ({
-    resolve: vi.fn((path) => `/resolved/${path}`),
-}));
-import { readFileSync, writeFileSync, existsSync } from "fs";
-import { resolve } from "path";
-import { apiPlugin } from "../api";
-const mockReadFileSync = vi.mocked(readFileSync);
-const mockWriteFileSync = vi.mocked(writeFileSync);
-const mockExistsSync = vi.mocked(existsSync);
-const mockResolve = vi.mocked(resolve);
-describe("lockVersion plugin", () => {
-    let mockSdk;
-    beforeEach(() => {
-        vi.clearAllMocks();
-        mockSdk = {
-            listApps: vi.fn().mockReturnValue({
-                items: vi.fn().mockReturnValue([
-                    {
-                        title: "Gmail",
-                        key: "GmailCLIAPI",
-                        current_implementation_id: "GmailCLIAPI@2.1.0",
-                        description: "Email service",
-                    },
-                ][Symbol.iterator]()),
-            }),
-        };
-    });
-    const listAppsPlugin = () => ({
-        listApps: mockSdk.listApps,
-        context: {
-            meta: {
-                listApps: {
-                    inputSchema: {},
-                },
-            },
-        },
-    });
-    function createTestSdk() {
-        return createSdk()
-            .addPlugin(apiPlugin)
-            .addPlugin(listAppsPlugin)
-            .addPlugin(lockVersionPlugin);
-    }
-    describe("version locking", () => {
-        it("should extract implementation name and version and write to file", async () => {
-            mockExistsSync.mockReturnValue(false);
-            mockResolve.mockReturnValue("/resolved/.zapierrc");
-            const sdk = createTestSdk();
-            const result = await sdk.lockVersion({ appKey: "gmail" });
-            expect(result.data.implementationName).toBe("GmailCLIAPI");
-            expect(result.data.version).toBe("2.1.0");
-            expect(result.data.current_implementation_id).toBe("GmailCLIAPI@2.1.0");
-            expect(result.configPath).toBe("/resolved/.zapierrc");
-            // Verify file was written
-            expect(mockWriteFileSync).toHaveBeenCalledWith("/resolved/.zapierrc", JSON.stringify({
-                apps: {
-                    gmail: {
-                        implementationName: "GmailCLIAPI",
-                        version: "2.1.0",
-                    },
-                },
-            }, null, 2));
-        });
-        it("should update existing .zapierrc file", async () => {
-            const existingConfig = {
-                apps: {
-                    slack: {
-                        implementationName: "SlackCLIAPI",
-                        version: "1.27.1",
-                    },
-                },
-            };
-            mockExistsSync.mockReturnValue(true);
-            mockReadFileSync.mockReturnValue(JSON.stringify(existingConfig));
-            mockResolve.mockReturnValue("/resolved/.zapierrc");
-            const sdk = createTestSdk();
-            const result = await sdk.lockVersion({ appKey: "gmail" });
-            expect(mockReadFileSync).toHaveBeenCalledWith("/resolved/.zapierrc", "utf8");
-            expect(result.configPath).toBe("/resolved/.zapierrc");
-            // Verify file was updated with both apps
-            expect(mockWriteFileSync).toHaveBeenCalledWith("/resolved/.zapierrc", JSON.stringify({
-                apps: {
-                    slack: {
-                        implementationName: "SlackCLIAPI",
-                        version: "1.27.1",
-                    },
-                    gmail: {
-                        implementationName: "GmailCLIAPI",
-                        version: "2.1.0",
-                    },
-                },
-            }, null, 2));
-        });
-        it("should handle invalid implementation ID format", async () => {
-            mockSdk.listApps = vi.fn().mockReturnValue({
-                items: vi.fn().mockReturnValue([
-                    {
-                        title: "Invalid App",
-                        key: "InvalidApp",
-                        current_implementation_id: "InvalidFormat",
-                    },
-                ][Symbol.iterator]()),
-            });
-            const sdk = createTestSdk();
-            await expect(sdk.lockVersion({ appKey: "invalid" })).rejects.toThrow("Invalid implementation ID format: InvalidFormat. Expected format: <implementationName>@<version>");
-        });
-        it("should use custom config path when provided", async () => {
-            mockExistsSync.mockReturnValue(false);
-            mockResolve.mockReturnValue("/resolved/custom-config.json");
-            const sdk = createTestSdk();
-            const result = await sdk.lockVersion({
-                appKey: "gmail",
-                configPath: "custom-config.json",
-            });
-            expect(mockResolve).toHaveBeenCalledWith("custom-config.json");
-            expect(result.configPath).toBe("/resolved/custom-config.json");
-        });
-    });
-});

package/dist/plugins/lockVersion/schemas.d.ts

@@ -1,10 +0,0 @@
-import { z } from "zod";
-export declare const LockVersionSchema: z.ZodObject<{
-    appKey: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    appKey: string;
-}, {
-    appKey: string;
-}>;
-export type LockVersionOptions = z.infer<typeof LockVersionSchema>;
-//# sourceMappingURL=schemas.d.ts.map

package/dist/plugins/lockVersion/schemas.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../src/plugins/lockVersion/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,iBAAiB;;;;;;EAI5B,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC"}

package/dist/plugins/lockVersion/schemas.js

@@ -1,6 +0,0 @@
-import { z } from "zod";
-export const LockVersionSchema = z.object({
-    appKey: z
-        .string()
-        .describe("The app key to lock version for (e.g., 'slack', 'gmail')"),
-});

package/src/plugins/lockVersion/index.test.ts

@@ -1,176 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from "vitest";
-import { lockVersionPlugin } from "./index";
-import { createSdk } from "../../sdk";
-
-// Mock fs module
-vi.mock("fs", () => ({
-  readFileSync: vi.fn(),
-  writeFileSync: vi.fn(),
-  existsSync: vi.fn(),
-}));
-
-// Mock path module
-vi.mock("path", () => ({
-  resolve: vi.fn((path) => `/resolved/${path}`),
-}));
-
-import { readFileSync, writeFileSync, existsSync } from "fs";
-import { resolve } from "path";
-import { apiPlugin } from "../api";
-
-const mockReadFileSync = vi.mocked(readFileSync);
-const mockWriteFileSync = vi.mocked(writeFileSync);
-const mockExistsSync = vi.mocked(existsSync);
-const mockResolve = vi.mocked(resolve);
-
-describe("lockVersion plugin", () => {
-  let mockSdk: any;
-
-  beforeEach(() => {
-    vi.clearAllMocks();
-
-    mockSdk = {
-      listApps: vi.fn().mockReturnValue({
-        items: vi.fn().mockReturnValue(
-          [
-            {
-              title: "Gmail",
-              key: "GmailCLIAPI",
-              current_implementation_id: "GmailCLIAPI@2.1.0",
-              description: "Email service",
-            },
-          ][Symbol.iterator](),
-        ),
-      }),
-    };
-  });
-
-  const listAppsPlugin = () => ({
-    listApps: mockSdk.listApps,
-    context: {
-      meta: {
-        listApps: {
-          inputSchema: {} as any,
-        },
-      },
-    },
-  });
-
-  function createTestSdk() {
-    return createSdk()
-      .addPlugin(apiPlugin)
-      .addPlugin(listAppsPlugin)
-      .addPlugin(lockVersionPlugin);
-  }
-
-  describe("version locking", () => {
-    it("should extract implementation name and version and write to file", async () => {
-      mockExistsSync.mockReturnValue(false);
-      mockResolve.mockReturnValue("/resolved/.zapierrc");
-
-      const sdk = createTestSdk();
-      const result = await sdk.lockVersion({ appKey: "gmail" });
-
-      expect((result.data as any).implementationName).toBe("GmailCLIAPI");
-      expect((result.data as any).version).toBe("2.1.0");
-      expect(result.data.current_implementation_id).toBe("GmailCLIAPI@2.1.0");
-      expect(result.configPath).toBe("/resolved/.zapierrc");
-
-      // Verify file was written
-      expect(mockWriteFileSync).toHaveBeenCalledWith(
-        "/resolved/.zapierrc",
-        JSON.stringify(
-          {
-            apps: {
-              gmail: {
-                implementationName: "GmailCLIAPI",
-                version: "2.1.0",
-              },
-            },
-          },
-          null,
-          2,
-        ),
-      );
-    });
-
-    it("should update existing .zapierrc file", async () => {
-      const existingConfig = {
-        apps: {
-          slack: {
-            implementationName: "SlackCLIAPI",
-            version: "1.27.1",
-          },
-        },
-      };
-
-      mockExistsSync.mockReturnValue(true);
-      mockReadFileSync.mockReturnValue(JSON.stringify(existingConfig));
-      mockResolve.mockReturnValue("/resolved/.zapierrc");
-
-      const sdk = createTestSdk();
-      const result = await sdk.lockVersion({ appKey: "gmail" });
-
-      expect(mockReadFileSync).toHaveBeenCalledWith(
-        "/resolved/.zapierrc",
-        "utf8",
-      );
-      expect(result.configPath).toBe("/resolved/.zapierrc");
-
-      // Verify file was updated with both apps
-      expect(mockWriteFileSync).toHaveBeenCalledWith(
-        "/resolved/.zapierrc",
-        JSON.stringify(
-          {
-            apps: {
-              slack: {
-                implementationName: "SlackCLIAPI",
-                version: "1.27.1",
-              },
-              gmail: {
-                implementationName: "GmailCLIAPI",
-                version: "2.1.0",
-              },
-            },
-          },
-          null,
-          2,
-        ),
-      );
-    });
-
-    it("should handle invalid implementation ID format", async () => {
-      mockSdk.listApps = vi.fn().mockReturnValue({
-        items: vi.fn().mockReturnValue(
-          [
-            {
-              title: "Invalid App",
-              key: "InvalidApp",
-              current_implementation_id: "InvalidFormat",
-            },
-          ][Symbol.iterator](),
-        ),
-      });
-
-      const sdk = createTestSdk();
-
-      await expect(sdk.lockVersion({ appKey: "invalid" })).rejects.toThrow(
-        "Invalid implementation ID format: InvalidFormat. Expected format: <implementationName>@<version>",
-      );
-    });
-
-    it("should use custom config path when provided", async () => {
-      mockExistsSync.mockReturnValue(false);
-      mockResolve.mockReturnValue("/resolved/custom-config.json");
-
-      const sdk = createTestSdk();
-      const result = await sdk.lockVersion({
-        appKey: "gmail",
-        configPath: "custom-config.json",
-      });
-
-      expect(mockResolve).toHaveBeenCalledWith("custom-config.json");
-      expect(result.configPath).toBe("/resolved/custom-config.json");
-    });
-  });
-});

package/src/plugins/lockVersion/index.ts

@@ -1,112 +0,0 @@
-import type { Plugin, GetSdkType } from "../../types/plugin";
-import { createFunction } from "../../utils/function-utils";
-import { LockVersionSchema } from "./schemas";
-import type { LockVersionOptions } from "./schemas";
-import type { AppItem } from "../../types/domain";
-import { readFileSync, writeFileSync, existsSync } from "fs";
-import { resolve } from "path";
-import { z } from "zod";
-import type { ListAppsPluginProvides } from "../listApps";
-
-export interface LockVersionPluginProvides {
-  lockVersion: (
-    options: LockVersionOptions & { configPath?: string },
-  ) => Promise<{ data: AppItem; configPath: string }>;
-  context: {
-    meta: {
-      lockVersion: {
-        inputSchema: typeof LockVersionSchema;
-      };
-    };
-  };
-}
-
-export const lockVersionPlugin: Plugin<
-  GetSdkType<ListAppsPluginProvides>, // requires getApp in SDK
-  {}, // requires manifest context
-  LockVersionPluginProvides
-> = ({ sdk }) => {
-  const lockVersion = createFunction(
-    async function lockVersion(
-      options: LockVersionOptions & { configPath?: string },
-    ) {
-      const { appKey, configPath = ".zapierrc" } = options;
-      const resolvedPath = resolve(configPath);
-
-      // Get the current app information
-      const appsIterator = sdk.listApps({ appKeys: [appKey] }).items();
-      const apps = [];
-      for await (const app of appsIterator) {
-        apps.push(app);
-        break; // Only need the first result
-      }
-      const app = apps[0];
-
-      // Extract implementation name and version from current_implementation_id
-      const currentImplementationId = app.current_implementation_id;
-      const [implementationName, version] = currentImplementationId.split("@");
-
-      if (!implementationName || !version) {
-        throw new Error(
-          `Invalid implementation ID format: ${currentImplementationId}. Expected format: <implementationName>@<version>`,
-        );
-      }
-
-      // Read existing config or create new one
-      let config: { apps: Record<string, any> } = { apps: {} };
-
-      if (existsSync(resolvedPath)) {
-        try {
-          const configContent = readFileSync(resolvedPath, "utf8");
-          config = JSON.parse(configContent);
-
-          // Ensure apps property exists
-          if (!config.apps) {
-            config.apps = {};
-          }
-        } catch (error) {
-          console.warn(
-            `⚠️ Failed to parse existing config file, creating new one: ${error}`,
-          );
-          config = { apps: {} };
-        }
-      }
-
-      // Update the apps section
-      config.apps[appKey] = {
-        implementationName,
-        version,
-      };
-
-      // Write the updated config
-      writeFileSync(resolvedPath, JSON.stringify(config, null, 2));
-
-      return {
-        data: {
-          ...app,
-          implementationName,
-          version,
-        },
-        configPath: resolvedPath,
-      };
-    },
-    LockVersionSchema.extend({
-      configPath: z
-        .string()
-        .optional()
-        .describe("Path to .zapierrc file (defaults to '.zapierrc')"),
-    }),
-  );
-
-  return {
-    lockVersion,
-    context: {
-      meta: {
-        lockVersion: {
-          categories: ["utility"],
-          inputSchema: LockVersionSchema,
-        },
-      },
-    },
-  };
-};

package/src/plugins/lockVersion/schemas.ts

@@ -1,9 +0,0 @@
-import { z } from "zod";
-
-export const LockVersionSchema = z.object({
-  appKey: z
-    .string()
-    .describe("The app key to lock version for (e.g., 'slack', 'gmail')"),
-});
-
-export type LockVersionOptions = z.infer<typeof LockVersionSchema>;