@zapier/zapier-sdk-cli 0.13.3 → 0.13.4

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @zapier/zapier-sdk-cli
 
+## 0.13.4
+
+### Patch Changes
+
+- 80732ea: Add basic event-driven telemetry for key lifecycle events and CLI logins
+- Updated dependencies [80732ea]
+  - @zapier/zapier-sdk@0.13.4
+  - @zapier/zapier-sdk-mcp@0.3.17
+
 ## 0.13.3
 
 ### Patch Changes

package/dist/cli.cjs

@@ -1405,7 +1405,66 @@ var LoginSchema = zod.z.object({
   timeout: zod.z.string().optional().describe("Login timeout in seconds (default: 300)")
 }).describe("Log in to Zapier to access your account");
 
+// package.json
+var package_default = {
+  version: "0.13.4"};
+
+// src/telemetry/builders.ts
+function createCliBaseEvent(context = {}) {
+  return {
+    event_id: zapierSdk.generateEventId(),
+    timestamp_ms: zapierSdk.getCurrentTimestamp(),
+    release_id: zapierSdk.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
+  };
+}
+function buildCliCommandExecutedEvent({
+  data,
+  context = {},
+  cliVersion = package_default.version
+}) {
+  const osInfo = zapierSdk.getOsInfo();
+  const platformVersions = zapierSdk.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: zapierSdk.isCi(),
+    ci_platform: zapierSdk.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
+  };
+}
+
 // src/plugins/login/index.ts
+var CLI_COMMAND_EXECUTED_EVENT_SUBJECT = "platform.sdk.CliCommandExecutedEvent";
 var loginWithSdk = zapierSdk.createFunction(async function loginWithSdk2(options) {
   const timeoutSeconds = options.timeout ? parseInt(options.timeout, 10) : 300;
   if (isNaN(timeoutSeconds) || timeoutSeconds <= 0) {
@@ -1416,17 +1475,56 @@ var loginWithSdk = zapierSdk.createFunction(async function loginWithSdk2(options
   console.log(`\u2705 Successfully logged in as ${user.email}`);
   setTimeout(() => process.exit(0), 100);
 }, LoginSchema);
-var loginPlugin = () => ({
-  login: loginWithSdk,
-  context: {
-    meta: {
-      login: {
-        categories: ["account"],
-        inputSchema: LoginSchema
+var loginPlugin = ({ context }) => {
+  const loginWithTelemetry = async (options) => {
+    const startTime = Date.now();
+    let success = false;
+    let errorMessage = null;
+    try {
+      await loginWithSdk(options);
+      success = true;
+    } catch (error) {
+      success = false;
+      errorMessage = error instanceof Error ? error.message : "Login failed";
+      throw error;
+    } finally {
+      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)
+        },
+        context: {
+          session_id: context.session_id,
+          selected_api: context.selected_api,
+          app_id: context.app_id,
+          app_version_id: context.app_version_id
+        },
+        cliVersion: package_default.version
+      });
+      context.eventEmission.emit(CLI_COMMAND_EXECUTED_EVENT_SUBJECT, event);
+    }
+  };
+  return {
+    login: loginWithTelemetry,
+    context: {
+      meta: {
+        login: {
+          categories: ["account"],
+          inputSchema: LoginSchema
+        }
       }
     }
-  }
-});
+  };
+};
 var LogoutSchema = zod.z.object({}).describe("Log out of your Zapier account");
 
 // src/plugins/logout/index.ts
@@ -2281,7 +2379,8 @@ var addPlugin = ({ sdk: sdk2, context }) => {
 // src/sdk.ts
 function createZapierCliSdk(options = {}) {
   let sdk2 = zapierSdk.createZapierSdkWithoutRegistry({
-    debug: options.debug
+    debug: options.debug,
+    eventEmission: options.eventEmission
   });
   sdk2 = sdk2.addPlugin(bundleCodePlugin);
   sdk2 = sdk2.addPlugin(getLoginConfigPathPlugin);
@@ -2293,13 +2392,13 @@ function createZapierCliSdk(options = {}) {
   return finalSdk;
 }
 
-// package.json
-var package_default = {
-  version: "0.13.3"};
+// package.json with { type: 'json' }
+var package_default2 = {
+  version: "0.13.4"};
 
 // src/cli.ts
 var program = new commander.Command();
-program.name("zapier-sdk").description("CLI for Zapier SDK").version(package_default.version, "-v, --version", "display version number").option("--debug", "Enable debug logging");
+program.name("zapier-sdk").description("CLI for Zapier SDK").version(package_default2.version, "-v, --version", "display version number").option("--debug", "Enable debug logging");
 var isDebugMode = process.env.DEBUG === "true" || process.argv.includes("--debug");
 var sdk = createZapierCliSdk({
   debug: isDebugMode

package/dist/cli.mjs

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import { Command } from 'commander';
 import { z } from 'zod';
-import { createFunction, OutputPropertySchema, DEFAULT_CONFIG_PATH, createZapierSdkWithoutRegistry, registryPlugin, toSnakeCase, ZapierError, formatErrorMessage, isPositional } from '@zapier/zapier-sdk';
+import { createFunction, OutputPropertySchema, DEFAULT_CONFIG_PATH, createZapierSdkWithoutRegistry, registryPlugin, toSnakeCase, ZapierError, formatErrorMessage, getOsInfo, getPlatformVersions, getCiPlatform, isCi, isPositional, getReleaseId, getCurrentTimestamp, generateEventId } from '@zapier/zapier-sdk';
 import inquirer from 'inquirer';
 import chalk3 from 'chalk';
 import util from 'util';
@@ -1372,7 +1372,66 @@ var LoginSchema = z.object({
   timeout: z.string().optional().describe("Login timeout in seconds (default: 300)")
 }).describe("Log in to Zapier to access your account");
 
+// package.json
+var package_default = {
+  version: "0.13.4"};
+
+// src/telemetry/builders.ts
+function createCliBaseEvent(context = {}) {
+  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
+  };
+}
+function buildCliCommandExecutedEvent({
+  data,
+  context = {},
+  cliVersion = package_default.version
+}) {
+  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
+  };
+}
+
 // src/plugins/login/index.ts
+var CLI_COMMAND_EXECUTED_EVENT_SUBJECT = "platform.sdk.CliCommandExecutedEvent";
 var loginWithSdk = createFunction(async function loginWithSdk2(options) {
   const timeoutSeconds = options.timeout ? parseInt(options.timeout, 10) : 300;
   if (isNaN(timeoutSeconds) || timeoutSeconds <= 0) {
@@ -1383,17 +1442,56 @@ var loginWithSdk = createFunction(async function loginWithSdk2(options) {
   console.log(`\u2705 Successfully logged in as ${user.email}`);
   setTimeout(() => process.exit(0), 100);
 }, LoginSchema);
-var loginPlugin = () => ({
-  login: loginWithSdk,
-  context: {
-    meta: {
-      login: {
-        categories: ["account"],
-        inputSchema: LoginSchema
+var loginPlugin = ({ context }) => {
+  const loginWithTelemetry = async (options) => {
+    const startTime = Date.now();
+    let success = false;
+    let errorMessage = null;
+    try {
+      await loginWithSdk(options);
+      success = true;
+    } catch (error) {
+      success = false;
+      errorMessage = error instanceof Error ? error.message : "Login failed";
+      throw error;
+    } finally {
+      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)
+        },
+        context: {
+          session_id: context.session_id,
+          selected_api: context.selected_api,
+          app_id: context.app_id,
+          app_version_id: context.app_version_id
+        },
+        cliVersion: package_default.version
+      });
+      context.eventEmission.emit(CLI_COMMAND_EXECUTED_EVENT_SUBJECT, event);
+    }
+  };
+  return {
+    login: loginWithTelemetry,
+    context: {
+      meta: {
+        login: {
+          categories: ["account"],
+          inputSchema: LoginSchema
+        }
       }
     }
-  }
-});
+  };
+};
 var LogoutSchema = z.object({}).describe("Log out of your Zapier account");
 
 // src/plugins/logout/index.ts
@@ -2248,7 +2346,8 @@ var addPlugin = ({ sdk: sdk2, context }) => {
 // src/sdk.ts
 function createZapierCliSdk(options = {}) {
   let sdk2 = createZapierSdkWithoutRegistry({
-    debug: options.debug
+    debug: options.debug,
+    eventEmission: options.eventEmission
   });
   sdk2 = sdk2.addPlugin(bundleCodePlugin);
   sdk2 = sdk2.addPlugin(getLoginConfigPathPlugin);
@@ -2260,13 +2359,13 @@ function createZapierCliSdk(options = {}) {
   return finalSdk;
 }
 
-// package.json
-var package_default = {
-  version: "0.13.3"};
+// package.json with { type: 'json' }
+var package_default2 = {
+  version: "0.13.4"};
 
 // src/cli.ts
 var program = new Command();
-program.name("zapier-sdk").description("CLI for Zapier SDK").version(package_default.version, "-v, --version", "display version number").option("--debug", "Enable debug logging");
+program.name("zapier-sdk").description("CLI for Zapier SDK").version(package_default2.version, "-v, --version", "display version number").option("--debug", "Enable debug logging");
 var isDebugMode = process.env.DEBUG === "true" || process.argv.includes("--debug");
 var sdk = createZapierCliSdk({
   debug: isDebugMode

package/dist/index.cjs

@@ -261,7 +261,66 @@ var LoginSchema = zod.z.object({
   timeout: zod.z.string().optional().describe("Login timeout in seconds (default: 300)")
 }).describe("Log in to Zapier to access your account");
 
+// package.json
+var package_default = {
+  version: "0.13.4"};
+
+// src/telemetry/builders.ts
+function createCliBaseEvent(context = {}) {
+  return {
+    event_id: zapierSdk.generateEventId(),
+    timestamp_ms: zapierSdk.getCurrentTimestamp(),
+    release_id: zapierSdk.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
+  };
+}
+function buildCliCommandExecutedEvent({
+  data,
+  context = {},
+  cliVersion = package_default.version
+}) {
+  const osInfo = zapierSdk.getOsInfo();
+  const platformVersions = zapierSdk.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: zapierSdk.isCi(),
+    ci_platform: zapierSdk.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
+  };
+}
+
 // src/plugins/login/index.ts
+var CLI_COMMAND_EXECUTED_EVENT_SUBJECT = "platform.sdk.CliCommandExecutedEvent";
 var loginWithSdk = zapierSdk.createFunction(async function loginWithSdk2(options) {
   const timeoutSeconds = options.timeout ? parseInt(options.timeout, 10) : 300;
   if (isNaN(timeoutSeconds) || timeoutSeconds <= 0) {
@@ -272,17 +331,56 @@ var loginWithSdk = zapierSdk.createFunction(async function loginWithSdk2(options
   console.log(`\u2705 Successfully logged in as ${user.email}`);
   setTimeout(() => process.exit(0), 100);
 }, LoginSchema);
-var loginPlugin = () => ({
-  login: loginWithSdk,
-  context: {
-    meta: {
-      login: {
-        categories: ["account"],
-        inputSchema: LoginSchema
+var loginPlugin = ({ context }) => {
+  const loginWithTelemetry = async (options) => {
+    const startTime = Date.now();
+    let success = false;
+    let errorMessage = null;
+    try {
+      await loginWithSdk(options);
+      success = true;
+    } catch (error) {
+      success = false;
+      errorMessage = error instanceof Error ? error.message : "Login failed";
+      throw error;
+    } finally {
+      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)
+        },
+        context: {
+          session_id: context.session_id,
+          selected_api: context.selected_api,
+          app_id: context.app_id,
+          app_version_id: context.app_version_id
+        },
+        cliVersion: package_default.version
+      });
+      context.eventEmission.emit(CLI_COMMAND_EXECUTED_EVENT_SUBJECT, event);
+    }
+  };
+  return {
+    login: loginWithTelemetry,
+    context: {
+      meta: {
+        login: {
+          categories: ["account"],
+          inputSchema: LoginSchema
+        }
       }
     }
-  }
-});
+  };
+};
 var LogoutSchema = zod.z.object({}).describe("Log out of your Zapier account");
 
 // src/plugins/logout/index.ts
@@ -1137,7 +1235,8 @@ var addPlugin = ({ sdk, context }) => {
 // src/sdk.ts
 function createZapierCliSdk(options = {}) {
   let sdk = zapierSdk.createZapierSdkWithoutRegistry({
-    debug: options.debug
+    debug: options.debug,
+    eventEmission: options.eventEmission
   });
   sdk = sdk.addPlugin(bundleCodePlugin);
   sdk = sdk.addPlugin(getLoginConfigPathPlugin);
@@ -1149,4 +1248,5 @@ function createZapierCliSdk(options = {}) {
   return finalSdk;
 }
 
+exports.buildCliCommandExecutedEvent = buildCliCommandExecutedEvent;
 exports.createZapierCliSdk = createZapierCliSdk;

package/dist/index.d.mts

@@ -1,7 +1,15 @@
-import { ZapierSdk } from '@zapier/zapier-sdk';
+import { ZapierSdk, BaseEvent } from '@zapier/zapier-sdk';
 
 interface ZapierCliSdkOptions {
     debug?: boolean;
+    eventEmission?: {
+        enabled?: boolean;
+        transport?: {
+            type: "http" | "console" | "noop";
+            endpoint?: string;
+            headers?: Record<string, string>;
+        };
+    };
 }
 /**
  * Create a Zapier SDK instance configured specifically for the CLI
@@ -9,4 +17,85 @@ interface ZapierCliSdkOptions {
  */
 declare function createZapierCliSdk(options?: ZapierCliSdkOptions): ZapierSdk;
 
-export { type ZapierCliSdkOptions, createZapierCliSdk };
+/**
+ * CLI-specific telemetry event definitions
+ */
+
+/**
+ * Event emitted when a CLI command is executed
+ */
+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;
+}
+
+/**
+ * CLI-specific event builders
+ *
+ * Provides builder functions for CLI command telemetry that auto-populate
+ * common CLI fields and system information.
+ */
+
+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;
+}
+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;
+    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;
+}
+declare function buildCliCommandExecutedEvent({ data, context, cliVersion, }: {
+    data: CliCommandExecutedEventData;
+    context?: CliEventContext;
+    cliVersion?: string;
+}): CliCommandExecutedEvent;
+
+export { type CliCommandExecutedEvent, type CliCommandExecutedEventData, type CliEventContext, type ZapierCliSdkOptions, buildCliCommandExecutedEvent, createZapierCliSdk };