@zapier/zapier-sdk-cli 0.13.3 → 0.13.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zapier/zapier-sdk-cli",
-  "version": "0.13.3",
+  "version": "0.13.4",
   "description": "Command line interface for Zapier SDK",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -42,9 +42,9 @@
     "ora": "^8.2.0",
     "pkce-challenge": "^5.0.0",
     "zod": "^3.25.67",
-    "@zapier/zapier-sdk": "0.13.3",
-    "@zapier/zapier-sdk-cli-login": "0.3.2",
-    "@zapier/zapier-sdk-mcp": "0.3.16"
+    "@zapier/zapier-sdk": "0.13.4",
+    "@zapier/zapier-sdk-mcp": "0.3.17",
+    "@zapier/zapier-sdk-cli-login": "0.3.2"
   },
   "devDependencies": {
     "@types/express": "^5.0.3",

package/src/index.ts

@@ -1,4 +1,12 @@
 // Main exports for the CLI package
 export { createZapierCliSdk, type ZapierCliSdkOptions } from "./sdk";
 
+// Export CLI telemetry builders and types
+export type {
+  CliEventContext,
+  CliCommandExecutedEventData,
+} from "./telemetry/builders";
+export { buildCliCommandExecutedEvent } from "./telemetry/builders";
+export type { CliCommandExecutedEvent } from "./telemetry/events";
+
 // All CLI functionality is now schema-driven via generateCLICommands

package/src/plugins/login/index.ts

@@ -1,8 +1,18 @@
 import { createFunction } from "@zapier/zapier-sdk";
 import type { Plugin } from "@zapier/zapier-sdk";
+import type { EventEmissionContext } from "@zapier/zapier-sdk";
 import login from "../../utils/auth/login";
 import { getLoggedInUser } from "@zapier/zapier-sdk-cli-login";
 import { LoginSchema, type LoginOptions } from "./schemas";
+import { buildCliCommandExecutedEvent } from "../../telemetry/builders";
+import cliPackageJson from "../../../package.json";
+
+interface CliContext {
+  session_id?: string | null;
+  selected_api?: string | null;
+  app_id?: number | null;
+  app_version_id?: number | null;
+}
 
 interface LoginPluginProvides {
   login: (options: LoginOptions) => Promise<void>;
@@ -16,6 +26,9 @@ interface LoginPluginProvides {
   };
 }
 
+const CLI_COMMAND_EXECUTED_EVENT_SUBJECT =
+  "platform.sdk.CliCommandExecutedEvent";
+
 const loginWithSdk = createFunction(async function loginWithSdk(
   options: LoginOptions,
 ): Promise<void> {
@@ -33,16 +46,63 @@ const loginWithSdk = createFunction(async function loginWithSdk(
   setTimeout(() => process.exit(0), 100);
 }, LoginSchema);
 
-export const loginPlugin: Plugin<{}, {}, LoginPluginProvides> = () => ({
-  login: loginWithSdk,
-  context: {
-    meta: {
-      login: {
-        categories: ["account"],
-        inputSchema: LoginSchema,
+export const loginPlugin: Plugin<
+  {},
+  EventEmissionContext & CliContext,
+  LoginPluginProvides
+> = ({ context }) => {
+  // Wrap the login function to emit telemetry events
+  const loginWithTelemetry = async (options: LoginOptions): Promise<void> => {
+    const startTime = Date.now();
+    let success = false;
+    let errorMessage: string | null = null;
+
+    try {
+      await loginWithSdk(options);
+      success = true;
+    } catch (error) {
+      success = false;
+      errorMessage = error instanceof Error ? error.message : "Login failed";
+      throw error;
+    } finally {
+      // Emit CLI command executed event if event emission is available
+      const event = buildCliCommandExecutedEvent({
+        data: {
+          cli_primary_command: "login",
+          success_flag: success,
+          execution_duration_ms: Date.now() - startTime,
+          exit_code: success ? 0 : 1,
+          error_message: errorMessage,
+          command_category: "authentication",
+          requires_auth: false,
+          cli_arguments: [
+            "login",
+            options.timeout ? `--timeout=${options.timeout}` : null,
+          ].filter(Boolean) as string[],
+        },
+        context: {
+          session_id: context.session_id,
+          selected_api: context.selected_api,
+          app_id: context.app_id,
+          app_version_id: context.app_version_id,
+        },
+        cliVersion: cliPackageJson.version,
+      });
+      context.eventEmission.emit(CLI_COMMAND_EXECUTED_EVENT_SUBJECT, event);
+    }
+  };
+
+  return {
+    login: loginWithTelemetry,
+    context: {
+      meta: {
+        login: {
+          categories: ["account"],
+          inputSchema: LoginSchema,
+        },
       },
     },
-  },
-});
+  };
+};
 
 export type { LoginPluginProvides };

package/src/sdk.ts

@@ -14,6 +14,14 @@ import {
 
 export interface ZapierCliSdkOptions {
   debug?: boolean;
+  eventEmission?: {
+    enabled?: boolean;
+    transport?: {
+      type: "http" | "console" | "noop";
+      endpoint?: string;
+      headers?: Record<string, string>;
+    };
+  };
 }
 
 /**
@@ -26,6 +34,7 @@ export function createZapierCliSdk(
   // Create SDK instance without registry
   let sdk = createZapierSdkWithoutRegistry({
     debug: options.debug,
+    eventEmission: options.eventEmission,
   });
 
   // Add CLI-specific plugins before registry

package/src/telemetry/builders.ts

@@ -0,0 +1,114 @@
+/**
+ * CLI-specific event builders
+ *
+ * Provides builder functions for CLI command telemetry that auto-populate
+ * common CLI fields and system information.
+ */
+
+import type { BaseEvent } from "@zapier/zapier-sdk";
+import {
+  generateEventId,
+  getCurrentTimestamp,
+  getReleaseId,
+  getOsInfo,
+  getPlatformVersions,
+  isCi,
+  getCiPlatform,
+} from "@zapier/zapier-sdk";
+import type { CliCommandExecutedEvent } from "./events";
+import cliPackageJson from "../../package.json";
+
+// CLI context that can be injected into events
+export interface CliEventContext {
+  customuser_id?: number | null;
+  account_id?: number | null;
+  identity_id?: number | null;
+  visitor_id?: string | null;
+  correlation_id?: string | null;
+  session_id?: string | null;
+  selected_api?: string | null;
+  app_id?: number | null;
+  app_version_id?: number | null;
+}
+
+// Create base event for CLI events
+function createCliBaseEvent(context: CliEventContext = {}): BaseEvent {
+  return {
+    event_id: generateEventId(),
+    timestamp_ms: getCurrentTimestamp(),
+    release_id: getReleaseId(),
+    customuser_id: context.customuser_id ?? null,
+    account_id: context.account_id ?? null,
+    identity_id: context.identity_id ?? null,
+    visitor_id: context.visitor_id ?? null,
+    correlation_id: context.correlation_id ?? null,
+  };
+}
+
+// CLI Command Executed Event Builder
+// This interface corresponds to the cli_command_executed_event.avsc Avro schema
+export interface CliCommandExecutedEventData {
+  cli_primary_command: string;
+  success_flag: boolean;
+  execution_duration_ms?: number | null;
+  exit_code?: number | null;
+  error_message?: string | null;
+  command_category?: string | null;
+  requires_auth?: boolean | null;
+  cli_arguments?: (string | null)[] | null;
+  // Allow overriding auto-detected values if needed
+  cli_version?: string | null;
+  made_network_requests?: boolean | null;
+  files_modified_count?: number | null;
+  files_created_count?: number | null;
+  files_processed_size_bytes?: number | null;
+  peak_memory_usage_bytes?: number | null;
+  cpu_time_ms?: number | null;
+  subprocess_count?: number | null;
+  package_manager?: string | null;
+}
+
+export function buildCliCommandExecutedEvent({
+  data,
+  context = {},
+  cliVersion = cliPackageJson.version,
+}: {
+  data: CliCommandExecutedEventData;
+  context?: CliEventContext;
+  cliVersion?: string;
+}): CliCommandExecutedEvent {
+  const osInfo = getOsInfo();
+  const platformVersions = getPlatformVersions();
+
+  return {
+    ...createCliBaseEvent(context),
+    system_name: "zapier-sdk-cli",
+    session_id: context.session_id ?? null,
+    cli_version: data.cli_version ?? cliVersion,
+    cli_arguments: data.cli_arguments ?? null,
+    cli_primary_command: data.cli_primary_command,
+    os_platform: osInfo.platform,
+    os_release: osInfo.release,
+    os_architecture: osInfo.architecture,
+    platform_versions: platformVersions,
+    selected_api: context.selected_api ?? null,
+    app_id: context.app_id ?? null,
+    app_version_id: context.app_version_id ?? null,
+    execution_duration_ms: data.execution_duration_ms ?? null,
+    success_flag: data.success_flag,
+    exit_code: data.exit_code ?? (data.success_flag ? 0 : 1),
+    error_message: data.error_message ?? null,
+    command_category: data.command_category ?? null,
+    requires_auth: data.requires_auth ?? null,
+    is_ci_environment: isCi(),
+    ci_platform: getCiPlatform(),
+    package_manager: data.package_manager ?? "pnpm", // Default based on project setup
+    made_network_requests: data.made_network_requests ?? null,
+    files_modified_count: data.files_modified_count ?? null,
+    files_created_count: data.files_created_count ?? null,
+    files_processed_size_bytes: data.files_processed_size_bytes ?? null,
+    peak_memory_usage_bytes: data.peak_memory_usage_bytes ?? null,
+    cpu_time_ms: data.cpu_time_ms ?? null,
+    subprocess_count: data.subprocess_count ?? null,
+  };
+}

package/src/telemetry/events.ts

@@ -0,0 +1,39 @@
+/**
+ * CLI-specific telemetry event definitions
+ */
+
+import type { BaseEvent } from "@zapier/zapier-sdk";
+
+/**
+ * Event emitted when a CLI command is executed
+ */
+export interface CliCommandExecutedEvent extends BaseEvent {
+  system_name: string;
+  session_id?: string | null;
+  cli_version?: string | null;
+  cli_arguments?: (string | null)[] | null;
+  cli_primary_command?: string | null;
+  os_platform?: string | null;
+  os_release?: string | null;
+  os_architecture?: string | null;
+  platform_versions?: Record<string, string | null> | null;
+  selected_api?: string | null;
+  app_id?: number | null;
+  app_version_id?: number | null;
+  execution_duration_ms?: number | null;
+  success_flag: boolean;
+  exit_code?: number | null;
+  error_message?: string | null;
+  command_category?: string | null;
+  requires_auth?: boolean | null;
+  is_ci_environment?: boolean | null;
+  ci_platform?: string | null;
+  package_manager?: string | null;
+  made_network_requests?: boolean | null;
+  files_modified_count?: number | null;
+  files_created_count?: number | null;
+  files_processed_size_bytes?: number | null;
+  peak_memory_usage_bytes?: number | null;
+  cpu_time_ms?: number | null;
+  subprocess_count?: number | null;
+}

package/src/utils/cli-generator.test.ts

@@ -1,5 +1,9 @@
 import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
 import chalk from "chalk";
+import { generateCliCommands } from "./cli-generator";
+import { Command } from "commander";
+import type { ZapierSdk } from "@zapier/zapier-sdk";
+import { z } from "zod";
 
 // We need to create a test for the formatItemsGeneric function that's defined in cli-generator.ts
 // Since it's not exported, we'll create a simple test that verifies the numbering logic
@@ -91,3 +95,101 @@ describe("CLI Generator Pagination Numbering", () => {
     expect(output.some((line) => line.includes("2."))).toBe(true);
   });
 });
+
+// Create proper Zod schema for testing
+const testSchema = z
+  .object({
+    maxItems: z.number().optional(),
+    pageSize: z.number().optional(),
+  })
+  .describe("List all apps");
+
+// Mock SDK for CLI tests
+const mockSdk = {
+  getRegistry: vi.fn(() => ({
+    functions: [
+      {
+        name: "listApps",
+        type: "list",
+        inputSchema: testSchema,
+      },
+    ],
+    categories: [],
+  })),
+  listApps: vi.fn().mockResolvedValue({ data: [] }),
+} as unknown as ZapierSdk;
+
+describe("CLI Command Generation", () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it("should execute CLI commands successfully", async () => {
+    const program = new Command();
+    program.exitOverride(); // Prevent process.exit() in tests
+
+    // Generate CLI commands
+    generateCliCommands(program, mockSdk);
+
+    // Execute the command through Commander.js parsing
+    await program.parseAsync(["node", "test", "list-apps", "--json"]);
+
+    // Verify the SDK method was called
+    expect(mockSdk.listApps).toHaveBeenCalled();
+  });
+
+  it("should handle CLI command failures gracefully", async () => {
+    const program = new Command();
+    program.exitOverride(); // Prevent process.exit() in tests
+    const consoleSpy = vi.spyOn(console, "error").mockImplementation(() => {});
+
+    // Generate CLI commands
+    generateCliCommands(program, mockSdk);
+
+    // Mock the SDK method to throw an error
+    (mockSdk as unknown).listApps = vi
+      .fn()
+      .mockRejectedValue(new Error("API error"));
+
+    try {
+      // Execute the command through Commander.js parsing
+      await program.parseAsync(["node", "test", "list-apps", "--json"]);
+    } catch {
+      // Expected due to exitOverride throwing CommanderError
+    }
+
+    // Verify the SDK method was attempted
+    expect(mockSdk.listApps).toHaveBeenCalled();
+
+    // Cleanup
+    consoleSpy.mockRestore();
+  });
+
+  it("should generate commands for SDK without event emission", async () => {
+    const mockSdkWithoutEvents = {
+      getRegistry: vi.fn(() => ({
+        functions: [
+          {
+            name: "listApps",
+            type: "list",
+            inputSchema: testSchema,
+          },
+        ],
+        categories: [],
+      })),
+      listApps: vi.fn().mockResolvedValue({ data: [] }),
+    } as unknown as ZapierSdk;
+
+    const program = new Command();
+    program.exitOverride(); // Prevent process.exit() in tests
+
+    // Generate CLI commands
+    generateCliCommands(program, mockSdkWithoutEvents);
+
+    // Should not throw even without event emission capability
+    await program.parseAsync(["node", "test", "list-apps", "--json"]);
+
+    // Verify the command executed successfully
+    expect(mockSdkWithoutEvents.listApps).toHaveBeenCalled();
+  });
+});