@zapier/zapier-sdk-cli 0.13.2 → 0.13.4

package/dist/index.d.ts

@@ -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 };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { createFunction, OutputPropertySchema, DEFAULT_CONFIG_PATH, createZapierSdkWithoutRegistry, registryPlugin, toSnakeCase } from '@zapier/zapier-sdk';
+import { createFunction, OutputPropertySchema, DEFAULT_CONFIG_PATH, getOsInfo, getPlatformVersions, getCiPlatform, isCi, createZapierSdkWithoutRegistry, registryPlugin, getReleaseId, getCurrentTimestamp, generateEventId, toSnakeCase } from '@zapier/zapier-sdk';
 import open from 'open';
 import crypto from 'crypto';
 import express from 'express';
@@ -230,7 +230,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) {
@@ -241,17 +300,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
@@ -1106,7 +1204,8 @@ var addPlugin = ({ sdk, context }) => {
 // src/sdk.ts
 function createZapierCliSdk(options = {}) {
   let sdk = createZapierSdkWithoutRegistry({
-    debug: options.debug
+    debug: options.debug,
+    eventEmission: options.eventEmission
   });
   sdk = sdk.addPlugin(bundleCodePlugin);
   sdk = sdk.addPlugin(getLoginConfigPathPlugin);
@@ -1118,4 +1217,4 @@ function createZapierCliSdk(options = {}) {
   return finalSdk;
 }
 
-export { createZapierCliSdk };
+export { buildCliCommandExecutedEvent, createZapierCliSdk };

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zapier/zapier-sdk-cli",
-    "version": "0.13.2",
+    "version": "0.13.4",
     "description": "Command line interface for Zapier SDK",
     "main": "dist/index.cjs",
     "module": "dist/index.mjs",

package/dist/src/index.d.ts

@@ -1 +1,4 @@
 export { createZapierCliSdk, type ZapierCliSdkOptions } from "./sdk";
+export type { CliEventContext, CliCommandExecutedEventData, } from "./telemetry/builders";
+export { buildCliCommandExecutedEvent } from "./telemetry/builders";
+export type { CliCommandExecutedEvent } from "./telemetry/events";

package/dist/src/index.js

@@ -1,3 +1,4 @@
 // Main exports for the CLI package
 export { createZapierCliSdk } from "./sdk";
+export { buildCliCommandExecutedEvent } from "./telemetry/builders";
 // All CLI functionality is now schema-driven via generateCLICommands

package/dist/src/plugins/login/index.d.ts

@@ -1,5 +1,12 @@
 import type { Plugin } from "@zapier/zapier-sdk";
+import type { EventEmissionContext } from "@zapier/zapier-sdk";
 import { LoginSchema, type LoginOptions } from "./schemas";
+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>;
     context: {
@@ -11,5 +18,5 @@ interface LoginPluginProvides {
         };
     };
 }
-export declare const loginPlugin: Plugin<{}, {}, LoginPluginProvides>;
+export declare const loginPlugin: Plugin<{}, EventEmissionContext & CliContext, LoginPluginProvides>;
 export type { LoginPluginProvides };

package/dist/src/plugins/login/index.js

@@ -2,6 +2,9 @@ import { createFunction } from "@zapier/zapier-sdk";
 import login from "../../utils/auth/login";
 import { getLoggedInUser } from "@zapier/zapier-sdk-cli-login";
 import { LoginSchema } from "./schemas";
+import { buildCliCommandExecutedEvent } from "../../telemetry/builders";
+import cliPackageJson from "../../../package.json";
+const CLI_COMMAND_EXECUTED_EVENT_SUBJECT = "platform.sdk.CliCommandExecutedEvent";
 const loginWithSdk = createFunction(async function loginWithSdk(options) {
     const timeoutSeconds = options.timeout ? parseInt(options.timeout, 10) : 300;
     if (isNaN(timeoutSeconds) || timeoutSeconds <= 0) {
@@ -13,14 +16,57 @@ const loginWithSdk = createFunction(async function loginWithSdk(options) {
     // Force immediate exit to prevent hanging (especially in development with tsx)
     setTimeout(() => process.exit(0), 100);
 }, LoginSchema);
-export const loginPlugin = () => ({
-    login: loginWithSdk,
-    context: {
-        meta: {
-            login: {
-                categories: ["account"],
-                inputSchema: LoginSchema,
+export const loginPlugin = ({ context }) => {
+    // Wrap the login function to emit telemetry events
+    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 {
+            // 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),
+                },
+                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,
+                },
             },
         },
-    },
-});
+    };
+};

package/dist/src/sdk.d.ts

@@ -1,6 +1,14 @@
 import { type ZapierSdk } from "@zapier/zapier-sdk";
 export 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

package/dist/src/sdk.js

@@ -8,6 +8,7 @@ export function createZapierCliSdk(options = {}) {
     // Create SDK instance without registry
     let sdk = createZapierSdkWithoutRegistry({
         debug: options.debug,
+        eventEmission: options.eventEmission,
     });
     // Add CLI-specific plugins before registry
     sdk = sdk.addPlugin(bundleCodePlugin);

package/dist/src/telemetry/builders.d.ts

@@ -0,0 +1,42 @@
+/**
+ * CLI-specific event builders
+ *
+ * Provides builder functions for CLI command telemetry that auto-populate
+ * common CLI fields and system information.
+ */
+import type { CliCommandExecutedEvent } from "./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;
+}
+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;
+    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 declare function buildCliCommandExecutedEvent({ data, context, cliVersion, }: {
+    data: CliCommandExecutedEventData;
+    context?: CliEventContext;
+    cliVersion?: string;
+}): CliCommandExecutedEvent;

package/dist/src/telemetry/builders.js

@@ -0,0 +1,56 @@
+/**
+ * CLI-specific event builders
+ *
+ * Provides builder functions for CLI command telemetry that auto-populate
+ * common CLI fields and system information.
+ */
+import { generateEventId, getCurrentTimestamp, getReleaseId, getOsInfo, getPlatformVersions, isCi, getCiPlatform, } from "@zapier/zapier-sdk";
+import cliPackageJson from "../../package.json";
+// Create base event for CLI events
+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,
+    };
+}
+export function buildCliCommandExecutedEvent({ data, context = {}, cliVersion = cliPackageJson.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,
+    };
+}

package/dist/src/telemetry/events.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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/dist/src/telemetry/events.js

@@ -0,0 +1,4 @@
+/**
+ * CLI-specific telemetry event definitions
+ */
+export {};

package/dist/src/utils/schema-formatter.js

@@ -46,15 +46,21 @@ export function formatItemsFromSchema(functionInfo, items, startingNumber = 0) {
 function formatSingleItem(formatted, itemNumber) {
     // Build the main title line with optional subtitle
     let titleLine = `${chalk.gray(`${itemNumber + 1}.`)} ${chalk.cyan(formatted.title)}`;
-    // Generate subtitle from id or key
-    if (formatted.id) {
-        titleLine += ` ${chalk.gray(`(ID: ${formatted.id})`)}`;
-    }
-    else if (formatted.keys) {
-        titleLine += ` ${chalk.gray(`(${formatted.keys.join(", ")})`)}`;
+    // Generate subtitle - always show key if available, then ID if available
+    const subtitleParts = [];
+    if (formatted.keys) {
+        subtitleParts.push(...formatted.keys);
     }
     else if (formatted.key) {
-        titleLine += ` ${chalk.gray(`(${formatted.key})`)}`;
+        subtitleParts.push(formatted.key);
+    }
+    if (formatted.id) {
+        subtitleParts.push(formatted.id);
+    }
+    // Remove duplicates while preserving order
+    const uniqueParts = [...new Set(subtitleParts)];
+    if (uniqueParts.length > 0) {
+        titleLine += ` ${chalk.gray(`(${uniqueParts.join(", ")})`)}`;
     }
     console.log(titleLine);
     // Show description if available