@zapier/zapier-sdk-cli 0.16.1 → 0.16.3

package/src/telemetry/builders.ts

@@ -1,113 +0,0 @@
-/**
- * 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,
-    cpu_time_ms: data.cpu_time_ms ?? null,
-    subprocess_count: data.subprocess_count ?? null,
-  };
-}

package/src/telemetry/events.ts

@@ -1,39 +0,0 @@
-/**
- * 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/types/sdk.ts

@@ -1,8 +0,0 @@
-import type { GetSdkType, ZapierSdk } from "@zapier/zapier-sdk";
-import type { BuildManifestPluginProvides } from "../plugins/buildManifest";
-import type { GenerateAppTypesPluginProvides } from "../plugins/generateAppTypes";
-
-export interface ZapierSdkCli
-  extends GetSdkType<
-    ZapierSdk & BuildManifestPluginProvides & GenerateAppTypesPluginProvides
-  > {}

package/src/utils/api/client.ts

@@ -1,44 +0,0 @@
-// Simple HTTP client for OAuth authentication
-export interface ApiResponse<T = unknown> {
-  data: T;
-  status: number;
-}
-
-export const createApiClient = () => {
-  const post = async <T = unknown>(
-    url: string,
-    data: Record<string, string>,
-    options: {
-      headers?: Record<string, string>;
-    } = {},
-  ): Promise<ApiResponse<T>> => {
-    const { headers = {} } = options;
-
-    const response = await fetch(url, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/x-www-form-urlencoded",
-        Connection: "close",
-        ...headers,
-      },
-      body: new URLSearchParams(data),
-    });
-
-    if (!response.ok) {
-      throw new Error(`${response.status} ${response.statusText}`);
-    }
-
-    const responseData = await response.json();
-    return {
-      data: responseData,
-      status: response.status,
-    };
-  };
-
-  return {
-    post,
-  };
-};
-
-const api = createApiClient();
-export default api;

package/src/utils/auth/login.ts

@@ -1,214 +0,0 @@
-import open from "open";
-import crypto from "node:crypto";
-import express from "express";
-import pkceChallenge from "pkce-challenge";
-import type { Socket } from "net";
-
-import {
-  AUTH_MODE_HEADER,
-  ZAPIER_AUTH_CLIENT_ID,
-  LOGIN_PORTS,
-  LOGIN_TIMEOUT_MS,
-} from "../constants";
-import { spinPromise } from "../spinner";
-import log from "../log";
-import api from "../api/client";
-import getCallablePromise from "../getCallablePromise";
-import {
-  updateLogin,
-  logout,
-  getAuthTokenUrl,
-  getAuthAuthorizeUrl,
-} from "@zapier/zapier-sdk-cli-login";
-import { ZapierCliUserCancellationError } from "../errors";
-
-const findAvailablePort = (): Promise<number> => {
-  return new Promise((resolve, reject) => {
-    let portIndex = 0;
-
-    const tryPort = (port: number) => {
-      const server = express().listen(port, () => {
-        server.close();
-        resolve(port);
-      });
-
-      server.on("error", (err: NodeJS.ErrnoException) => {
-        if (err.code === "EADDRINUSE") {
-          if (portIndex < LOGIN_PORTS.length) {
-            // Try next predefined port
-            tryPort(LOGIN_PORTS[portIndex++]);
-          } else {
-            // All configured ports are busy
-            reject(
-              new Error(
-                `All configured OAuth callback ports are busy: ${LOGIN_PORTS.join(", ")}. Please try again later or close applications using these ports.`,
-              ),
-            );
-          }
-        } else {
-          reject(err);
-        }
-      });
-    };
-
-    if (LOGIN_PORTS.length > 0) {
-      tryPort(LOGIN_PORTS[portIndex++]);
-    } else {
-      reject(new Error("No OAuth callback ports configured"));
-    }
-  });
-};
-
-const generateRandomString = () => {
-  const array = new Uint32Array(28);
-  crypto.getRandomValues(array);
-  return Array.from(array, (dec) =>
-    ("0" + dec.toString(16)).substring(-2),
-  ).join("");
-};
-
-interface LoginOptions {
-  timeoutMs?: number;
-  baseUrl?: string;
-  authBaseUrl?: string;
-  authClientId?: string;
-}
-
-const login = async ({
-  timeoutMs = LOGIN_TIMEOUT_MS,
-  baseUrl,
-  authBaseUrl,
-  authClientId,
-}: LoginOptions): Promise<string> => {
-  const authOptions = { baseUrl, authBaseUrl };
-  const tokenUrl = getAuthTokenUrl(authOptions);
-  const authorizeUrl = getAuthAuthorizeUrl(authOptions);
-  // Force logout
-  logout();
-
-  // Find an available port
-  const availablePort = await findAvailablePort();
-  const redirectUri = `http://localhost:${availablePort}/oauth`;
-
-  log.info(`Using port ${availablePort} for OAuth callback`);
-
-  const {
-    promise: promisedCode,
-    resolve: setCode,
-    reject: rejectCode,
-  } = getCallablePromise<string>();
-
-  const app = express();
-
-  app.get("/oauth", (req, res) => {
-    setCode(String(req.query.code));
-    // Set headers to prevent keep-alive
-    res.setHeader("Connection", "close");
-    res.end("You can now close this tab and return to the CLI.");
-  });
-
-  const server = app.listen(availablePort);
-
-  // Track connections to force close them if needed
-  const connections = new Set<Socket>();
-  server.on("connection", (conn) => {
-    connections.add(conn);
-    conn.on("close", () => connections.delete(conn));
-  });
-
-  // Set up signal handlers for graceful shutdown
-  const cleanup = () => {
-    server.close();
-    log.info("\n❌ Login cancelled by user");
-    rejectCode(new ZapierCliUserCancellationError());
-  };
-
-  process.on("SIGINT", cleanup);
-  process.on("SIGTERM", cleanup);
-
-  const { code_verifier: codeVerifier, code_challenge: codeChallenge } =
-    await pkceChallenge();
-
-  const authUrl = `${authorizeUrl}?${new URLSearchParams({
-    response_type: "code",
-    client_id: authClientId || ZAPIER_AUTH_CLIENT_ID,
-    redirect_uri: redirectUri,
-    scope: "internal offline_access",
-    state: generateRandomString(),
-    code_challenge: codeChallenge,
-    code_challenge_method: "S256",
-  }).toString()}`;
-
-  log.info("Opening your browser to log in.");
-  log.info("If it doesn't open, visit:", authUrl);
-
-  open(authUrl);
-
-  try {
-    await spinPromise(
-      Promise.race([
-        promisedCode,
-        new Promise<string>((_resolve, reject) =>
-          setTimeout(() => {
-            reject(
-              new Error(
-                `Login timed out after ${Math.round(timeoutMs / 1000)} seconds.`,
-              ),
-            );
-          }, timeoutMs),
-        ),
-      ]),
-      "Waiting for you to login and authorize",
-    );
-  } finally {
-    // Remove signal handlers
-    process.off("SIGINT", cleanup);
-    process.off("SIGTERM", cleanup);
-
-    // Close server with timeout and force-close connections if needed
-    await new Promise<void>((resolve) => {
-      const timeout = setTimeout(() => {
-        log.info("Server close timed out, forcing connection shutdown...");
-        // Force close all connections
-        connections.forEach((conn) => conn.destroy());
-        resolve();
-      }, 1000); // 1 second timeout
-
-      server.close(() => {
-        clearTimeout(timeout);
-        resolve();
-      });
-    });
-  }
-
-  log.info("Exchanging authorization code for tokens...");
-
-  const { data } = await api.post<{
-    access_token: string;
-    refresh_token: string;
-    expires_in: number;
-  }>(
-    tokenUrl,
-    {
-      grant_type: "authorization_code",
-      code: await promisedCode,
-      redirect_uri: redirectUri,
-      client_id: authClientId || ZAPIER_AUTH_CLIENT_ID,
-      code_verifier: codeVerifier,
-    },
-    {
-      headers: {
-        [AUTH_MODE_HEADER]: "no",
-        "Content-Type": "application/x-www-form-urlencoded",
-      },
-    },
-  );
-
-  updateLogin(data);
-
-  log.info("Token exchange completed successfully");
-
-  return data.access_token;
-};
-
-export default login;

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

@@ -1,169 +0,0 @@
-import { z } from "zod";
-import { isPositional, type FunctionRegistryEntry } from "@zapier/zapier-sdk";
-
-// ============================================================================
-// Types
-// ============================================================================
-
-export interface CliParameter {
-  name: string;
-  type: "string" | "number" | "boolean" | "array";
-  required: boolean;
-  description?: string;
-  default?: unknown;
-  choices?: string[];
-  hasResolver?: boolean;
-  isPositional?: boolean;
-}
-
-// ============================================================================
-// Schema Analysis
-// ============================================================================
-
-export function analyzeZodSchema(
-  schema: z.ZodSchema,
-  functionInfo?: FunctionRegistryEntry,
-): CliParameter[] {
-  const parameters: CliParameter[] = [];
-
-  if (schema instanceof z.ZodObject) {
-    const shape = schema.shape;
-
-    for (const [key, fieldSchema] of Object.entries<z.ZodSchema>(shape)) {
-      const param = analyzeZodField(key, fieldSchema, functionInfo);
-      if (param) {
-        parameters.push(param);
-      }
-    }
-  }
-
-  return parameters;
-}
-
-function analyzeZodField(
-  name: string,
-  schema: z.ZodSchema,
-  functionInfo?: FunctionRegistryEntry,
-): CliParameter | null {
-  let baseSchema = schema;
-  let required = true;
-  let defaultValue: unknown = undefined;
-
-  // Unwrap optional and default wrappers
-  if (baseSchema instanceof z.ZodOptional) {
-    required = false;
-    baseSchema = baseSchema._zod.def.innerType as z.ZodSchema;
-  }
-
-  if (baseSchema instanceof z.ZodDefault) {
-    required = false;
-    defaultValue = (baseSchema._zod.def.defaultValue as () => unknown)();
-    baseSchema = baseSchema._zod.def.innerType as z.ZodSchema;
-  }
-
-  // Determine parameter type
-  let paramType: CliParameter["type"] = "string";
-  let choices: string[] | undefined;
-
-  if (baseSchema instanceof z.ZodString) {
-    paramType = "string";
-  } else if (baseSchema instanceof z.ZodNumber) {
-    paramType = "number";
-  } else if (baseSchema instanceof z.ZodBoolean) {
-    paramType = "boolean";
-  } else if (baseSchema instanceof z.ZodArray) {
-    paramType = "array";
-  } else if (baseSchema instanceof z.ZodEnum) {
-    paramType = "string";
-    choices = baseSchema.options as string[];
-  } else if (baseSchema instanceof z.ZodRecord) {
-    // Handle Record<string, any> as JSON string input
-    paramType = "string";
-  }
-
-  // Check if this parameter has a resolver
-  let paramHasResolver = false;
-
-  // Check function-specific resolvers first
-  if (functionInfo?.resolvers?.[name]) {
-    paramHasResolver = true;
-  }
-
-  // Extract resolver metadata
-  return {
-    name,
-    type: paramType,
-    required,
-    description: schema.description,
-    default: defaultValue,
-    choices,
-    hasResolver: paramHasResolver,
-    isPositional: isPositional(schema),
-  };
-}
-
-// ============================================================================
-// Parameter Conversion
-// ============================================================================
-
-export function convertCliArgsToSdkParams(
-  parameters: CliParameter[],
-  positionalArgs: unknown[],
-  options: Record<string, unknown>,
-): Record<string, unknown> {
-  const sdkParams: Record<string, unknown> = {};
-
-  // Handle positional arguments (required parameters or optional positional parameters)
-  let argIndex = 0;
-  parameters.forEach((param) => {
-    if (
-      (param.required || param.isPositional) &&
-      argIndex < positionalArgs.length
-    ) {
-      // Use the original camelCase parameter name for the SDK
-      sdkParams[param.name] = convertValue(
-        positionalArgs[argIndex],
-        param.type,
-      );
-      argIndex++;
-    }
-  });
-
-  // Handle option flags
-  Object.entries(options).forEach(([key, value]) => {
-    // Convert kebab-case back to camelCase
-    const camelKey = key.replace(/-([a-z])/g, (g) => g[1].toUpperCase());
-    const param = parameters.find((p) => p.name === camelKey);
-
-    if (param && value !== undefined) {
-      sdkParams[camelKey] = convertValue(value, param.type);
-    }
-  });
-
-  return sdkParams;
-}
-
-function convertValue(value: unknown, type: CliParameter["type"]): unknown {
-  switch (type) {
-    case "number":
-      return Number(value);
-    case "boolean":
-      return Boolean(value);
-    case "array":
-      return Array.isArray(value) ? value : [value];
-    case "string":
-    default:
-      // Handle JSON string for objects
-      if (
-        typeof value === "string" &&
-        (value.startsWith("{") || value.startsWith("["))
-      ) {
-        try {
-          return JSON.parse(value);
-        } catch {
-          return value;
-        }
-      }
-      return value;
-  }
-}