@quiltdata/benchling-webhook 0.7.4 → 0.7.5-20251113T182945Z

package/dist/lib/next-steps-generator.js

@@ -0,0 +1,180 @@
+"use strict";
+/**
+ * Next steps message generator
+ *
+ * Generates context-appropriate command suggestions after setup completion.
+ * Supports both repository context (npm scripts) and npx context, and handles
+ * deployment results for Phase 3 command chaining.
+ *
+ * @module lib/next-steps-generator
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateNextSteps = generateNextSteps;
+const context_detector_1 = require("./context-detector");
+/**
+ * Generate next steps message after setup completion
+ *
+ * Produces context-appropriate command suggestions based on the
+ * deployment profile, execution context, and deployment results.
+ * Commands are formatted differently for repository context (npm scripts)
+ * vs npx context.
+ *
+ * @param options - Configuration for next steps generation
+ * @param options.profile - Deployment profile name (default, dev, prod, or custom)
+ * @param options.stage - Deployment stage (optional)
+ * @param options.context - Execution context (optional, auto-detected if not provided)
+ * @param options.deployment - Deployment result (optional, for post-deploy next steps)
+ * @param options.skipDeployment - Whether deployment was skipped (optional)
+ * @returns Formatted next steps message with commands
+ *
+ * @example
+ * ```typescript
+ * // After setup only (no deployment)
+ * const steps = generateNextSteps({ profile: 'default', skipDeployment: true });
+ * console.log(steps);
+ * // Output:
+ * // Next steps:
+ * //   1. Deploy to AWS: npm run deploy
+ * //   2. Test integration: npm run test
+ *
+ * // After successful deployment
+ * const steps = generateNextSteps({
+ *     profile: 'default',
+ *     deployment: {
+ *         success: true,
+ *         webhookUrl: 'https://example.com/webhook'
+ *     }
+ * });
+ * // Output:
+ * // Webhook URL: https://example.com/webhook
+ * // Next steps:
+ * //   1. Configure webhook URL in Benchling
+ * //   2. Test webhook: npm run test
+ * ```
+ */
+function generateNextSteps(options) {
+    const { profile = "default", deployment, skipDeployment = false, context } = options;
+    // Auto-detect context if not provided (backward compatibility)
+    const execContext = context || (0, context_detector_1.detectExecutionContext)();
+    const lines = [];
+    // Handle deployment results (Phase 3)
+    if (deployment) {
+        if (deployment.success && deployment.webhookUrl) {
+            // Successful deployment - show webhook URL
+            lines.push("");
+            lines.push(`Webhook URL: ${deployment.webhookUrl}`);
+            lines.push("");
+            lines.push("Next steps:");
+            lines.push("  1. Configure webhook URL in Benchling app settings");
+            lines.push(`  2. Test webhook: ${formatTestCommand(profile, execContext)}`);
+            lines.push(`  3. Check logs: ${formatHealthCheckCommand(profile, execContext)}`);
+        }
+        else if (!deployment.success) {
+            // Failed deployment - show recovery steps
+            lines.push("");
+            lines.push("Setup was successful, but deployment failed.");
+            if (deployment.error) {
+                lines.push(`Error: ${deployment.error}`);
+            }
+            lines.push("");
+            lines.push("Next steps:");
+            lines.push("  1. Fix the error above");
+            lines.push(`  2. Retry deployment: ${formatDeployCommand(profile, execContext)}`);
+            lines.push(`  3. Check configuration: ${formatHealthCheckCommand(profile, execContext)}`);
+        }
+    }
+    else if (skipDeployment) {
+        // Setup complete, deployment skipped - show deploy command
+        lines.push("Next steps:");
+        lines.push(`  1. Deploy to AWS: ${formatDeployCommand(profile, execContext)}`);
+        lines.push(`  2. Test integration: ${formatTestCommand(profile, execContext)}`);
+        lines.push(`  3. Check configuration: ${formatHealthCheckCommand(profile, execContext)}`);
+    }
+    else {
+        // Default: setup complete without deployment info (backward compatibility)
+        lines.push("Next steps:");
+        lines.push(`  1. Deploy to AWS: ${formatDeployCommand(profile, execContext)}`);
+        lines.push(`  2. Test integration: ${formatTestCommand(profile, execContext)}`);
+    }
+    return lines.join("\n");
+}
+/**
+ * Format deploy command for given profile and context
+ *
+ * @param profile - Profile name
+ * @param context - Execution context
+ * @returns Formatted deploy command
+ */
+function formatDeployCommand(profile, context) {
+    if (context.isRepository) {
+        // Repository context - use npm scripts
+        if (profile === "default")
+            return "npm run deploy";
+        if (profile === "dev")
+            return "npm run deploy:dev";
+        if (profile === "prod")
+            return "npm run deploy:prod";
+        return `npm run deploy -- --profile ${profile} --stage ${profile}`;
+    }
+    else {
+        // NPX context - use npx commands
+        if (profile === "default")
+            return `npx ${context.packageName} deploy`;
+        if (profile === "dev")
+            return `npx ${context.packageName} deploy --profile ${profile} --stage dev`;
+        if (profile === "prod")
+            return `npx ${context.packageName} deploy --profile ${profile} --stage prod`;
+        return `npx ${context.packageName} deploy --profile ${profile} --stage ${profile}`;
+    }
+}
+/**
+ * Format test/logs command for given profile and context
+ *
+ * @param profile - Profile name
+ * @param context - Execution context
+ * @returns Formatted test or logs command
+ */
+function formatTestCommand(profile, context) {
+    if (context.isRepository) {
+        // Repository context - use npm scripts
+        if (profile === "default")
+            return "npm run test";
+        if (profile === "dev")
+            return "npm run test:dev";
+        if (profile === "prod")
+            return "npm run test:prod";
+        return `npx ts-node scripts/check-logs.ts --profile ${profile}`;
+    }
+    else {
+        // NPX context - use npx commands
+        if (profile === "default")
+            return `npx ${context.packageName} test`;
+        if (profile === "dev")
+            return `npx ${context.packageName} test --profile ${profile}`;
+        if (profile === "prod")
+            return `npx ${context.packageName} test --profile ${profile}`;
+        return `npx ${context.packageName} test --profile ${profile}`;
+    }
+}
+/**
+ * Format health check command for given profile and context
+ *
+ * @param profile - Profile name
+ * @param context - Execution context
+ * @returns Formatted health check command
+ */
+function formatHealthCheckCommand(profile, context) {
+    if (context.isRepository) {
+        // Repository context - use npm scripts
+        if (profile === "default")
+            return "npm run setup:health";
+        return `npm run setup:health -- --profile ${profile}`;
+    }
+    else {
+        // NPX context - use npx commands
+        if (profile === "default")
+            return `npx ${context.packageName} health-check`;
+        return `npx ${context.packageName} health-check --profile ${profile}`;
+    }
+}
+//# sourceMappingURL=next-steps-generator.js.map

package/dist/lib/next-steps-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"next-steps-generator.js","sourceRoot":"","sources":["../../lib/next-steps-generator.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;AA8CH,8CA8CC;AAzFD,yDAA4D;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,SAAgB,iBAAiB,CAAC,OAAyB;IACvD,MAAM,EAAE,OAAO,GAAG,SAAS,EAAE,UAAU,EAAE,cAAc,GAAG,KAAK,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAErF,+DAA+D;IAC/D,MAAM,WAAW,GAAG,OAAO,IAAI,IAAA,yCAAsB,GAAE,CAAC;IAExD,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,sCAAsC;IACtC,IAAI,UAAU,EAAE,CAAC;QACb,IAAI,UAAU,CAAC,OAAO,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;YAC9C,2CAA2C;YAC3C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,gBAAgB,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;YACpD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC1B,KAAK,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;YACnE,KAAK,CAAC,IAAI,CAAC,sBAAsB,iBAAiB,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;YAC5E,KAAK,CAAC,IAAI,CAAC,oBAAoB,wBAAwB,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;QACrF,CAAC;aAAM,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;YAC7B,0CAA0C;YAC1C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;YAC3D,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;gBACnB,KAAK,CAAC,IAAI,CAAC,UAAU,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC;YAC7C,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC1B,KAAK,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;YACvC,KAAK,CAAC,IAAI,CAAC,0BAA0B,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;YAClF,KAAK,CAAC,IAAI,CAAC,6BAA6B,wBAAwB,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;QAC9F,CAAC;IACL,CAAC;SAAM,IAAI,cAAc,EAAE,CAAC;QACxB,2DAA2D;QAC3D,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,uBAAuB,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;QAC/E,KAAK,CAAC,IAAI,CAAC,0BAA0B,iBAAiB,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;QAChF,KAAK,CAAC,IAAI,CAAC,6BAA6B,wBAAwB,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;IAC9F,CAAC;SAAM,CAAC;QACJ,2EAA2E;QAC3E,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,uBAAuB,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;QAC/E,KAAK,CAAC,IAAI,CAAC,0BAA0B,iBAAiB,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;GAMG;AACH,SAAS,mBAAmB,CAAC,OAAe,EAAE,OAAuD;IACjG,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACvB,uCAAuC;QACvC,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,gBAAgB,CAAC;QACnD,IAAI,OAAO,KAAK,KAAK;YAAE,OAAO,oBAAoB,CAAC;QACnD,IAAI,OAAO,KAAK,MAAM;YAAE,OAAO,qBAAqB,CAAC;QACrD,OAAO,+BAA+B,OAAO,YAAY,OAAO,EAAE,CAAC;IACvE,CAAC;SAAM,CAAC;QACJ,iCAAiC;QACjC,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,OAAO,OAAO,CAAC,WAAW,SAAS,CAAC;QACtE,IAAI,OAAO,KAAK,KAAK;YAAE,OAAO,OAAO,OAAO,CAAC,WAAW,qBAAqB,OAAO,cAAc,CAAC;QACnG,IAAI,OAAO,KAAK,MAAM;YAAE,OAAO,OAAO,OAAO,CAAC,WAAW,qBAAqB,OAAO,eAAe,CAAC;QACrG,OAAO,OAAO,OAAO,CAAC,WAAW,qBAAqB,OAAO,YAAY,OAAO,EAAE,CAAC;IACvF,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,iBAAiB,CAAC,OAAe,EAAE,OAAuD;IAC/F,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACvB,uCAAuC;QACvC,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,cAAc,CAAC;QACjD,IAAI,OAAO,KAAK,KAAK;YAAE,OAAO,kBAAkB,CAAC;QACjD,IAAI,OAAO,KAAK,MAAM;YAAE,OAAO,mBAAmB,CAAC;QACnD,OAAO,+CAA+C,OAAO,EAAE,CAAC;IACpE,CAAC;SAAM,CAAC;QACJ,iCAAiC;QACjC,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,OAAO,OAAO,CAAC,WAAW,OAAO,CAAC;QACpE,IAAI,OAAO,KAAK,KAAK;YAAE,OAAO,OAAO,OAAO,CAAC,WAAW,mBAAmB,OAAO,EAAE,CAAC;QACrF,IAAI,OAAO,KAAK,MAAM;YAAE,OAAO,OAAO,OAAO,CAAC,WAAW,mBAAmB,OAAO,EAAE,CAAC;QACtF,OAAO,OAAO,OAAO,CAAC,WAAW,mBAAmB,OAAO,EAAE,CAAC;IAClE,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,wBAAwB,CAAC,OAAe,EAAE,OAAuD;IACtG,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACvB,uCAAuC;QACvC,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,sBAAsB,CAAC;QACzD,OAAO,qCAAqC,OAAO,EAAE,CAAC;IAC1D,CAAC;SAAM,CAAC;QACJ,iCAAiC;QACjC,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,OAAO,OAAO,CAAC,WAAW,eAAe,CAAC;QAC5E,OAAO,OAAO,OAAO,CAAC,WAAW,2BAA2B,OAAO,EAAE,CAAC;IAC1E,CAAC;AACL,CAAC"}

package/dist/lib/types/next-steps.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Type definitions for next steps generation
+ *
+ * @module types/next-steps
+ */
+/**
+ * Execution context for command suggestions
+ *
+ * Determines whether to show npm script commands (repository context)
+ * or npx commands (package user context).
+ */
+export interface ExecutionContext {
+    /**
+     * True if running in repository (has matching package.json with source files)
+     */
+    isRepository: boolean;
+    /**
+     * True if running via npx (installed as package)
+     */
+    isNpx: boolean;
+    /**
+     * Package name for npx commands
+     * @example "@quiltdata/benchling-webhook"
+     */
+    packageName: string;
+    /**
+     * Available npm scripts (if repository context)
+     * @example ["deploy", "deploy:dev", "deploy:prod", "test", "test:dev"]
+     */
+    availableScripts: string[];
+}
+/**
+ * Deployment result information
+ *
+ * Contains outputs from a deployment operation for display in next steps.
+ */
+export interface DeploymentResult {
+    /**
+     * Whether deployment succeeded
+     */
+    success: boolean;
+    /**
+     * Webhook URL (if deployment succeeded)
+     * @example "https://abc123.execute-api.us-east-1.amazonaws.com/prod/webhook"
+     */
+    webhookUrl?: string;
+    /**
+     * CloudFormation stack ARN
+     * @example "arn:aws:cloudformation:us-east-1:123456789012:stack/BenchlingWebhook/abc123"
+     */
+    stackArn?: string;
+    /**
+     * AWS region where deployed
+     * @example "us-east-1"
+     */
+    region?: string;
+    /**
+     * Error message (if deployment failed)
+     */
+    error?: string;
+}
+/**
+ * Options for generating next steps message
+ */
+export interface NextStepsOptions {
+    /**
+     * Profile name (default, dev, prod, or custom)
+     */
+    profile: string;
+    /**
+     * Deployment stage (dev or prod)
+     * @default Inferred from profile
+     */
+    stage?: string;
+    /**
+     * Execution context (optional in Phase 1, required in Phase 2)
+     *
+     * If not provided, defaults to repository context for backward compatibility.
+     */
+    context?: ExecutionContext;
+    /**
+     * Deployment result (optional, for Phase 3)
+     *
+     * If provided, next steps will include deployment-specific information.
+     */
+    deployment?: DeploymentResult;
+    /**
+     * Whether deployment was skipped
+     * @default false
+     */
+    skipDeployment?: boolean;
+}
+//# sourceMappingURL=next-steps.d.ts.map

package/dist/lib/types/next-steps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"next-steps.d.ts","sourceRoot":"","sources":["../../../lib/types/next-steps.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAE3B;;;;OAIG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAE9B;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B"}

package/dist/lib/types/next-steps.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Type definitions for next steps generation
+ *
+ * @module types/next-steps
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=next-steps.js.map

package/dist/lib/types/next-steps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"next-steps.js","sourceRoot":"","sources":["../../../lib/types/next-steps.ts"],"names":[],"mappings":";AAAA;;;;GAIG"}

package/dist/package.json

@@ -1,11 +1,12 @@
 {
     "name": "@quiltdata/benchling-webhook",
-    "version": "0.7.4",
+    "version": "0.7.5-20251113T182945Z",
     "description": "AWS CDK deployment for Benchling webhook processing using Fargate - Deploy directly with npx",
     "main": "dist/lib/index.js",
     "types": "dist/lib/index.d.ts",
     "files": [
         "dist/",
+        "cdk.json",
         "README.md",
         "LICENSE",
         "env.template"
@@ -75,7 +76,7 @@
         "aws-sdk-client-mock": "^4.1.0",
         "cross-env": "^10.1.0",
         "dotenv": "^17.2.3",
-        "esbuild": "0.25.12",
+        "esbuild": "0.27.0",
         "eslint": "^9.22.0",
         "globals": "^16.0.0",
         "jest": "^30.0.0",
@@ -95,7 +96,6 @@
         "ajv": "^8.17.1",
         "ajv-formats": "^3.0.1",
         "aws-cdk-lib": "2.222.0",
-        "aws-sdk": "^2.1574.0",
         "boxen": "^8.0.0",
         "chalk": "^5.0.0",
         "commander": "^14.0.2",

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@quiltdata/benchling-webhook",
-  "version": "0.7.4",
+  "version": "0.7.5-20251113T182945Z",
   "description": "AWS CDK deployment for Benchling webhook processing using Fargate - Deploy directly with npx",
   "main": "dist/lib/index.js",
   "types": "dist/lib/index.d.ts",
   "files": [
     "dist/",
+    "cdk.json",
     "README.md",
     "LICENSE",
     "env.template"
@@ -75,7 +76,7 @@
     "aws-sdk-client-mock": "^4.1.0",
     "cross-env": "^10.1.0",
     "dotenv": "^17.2.3",
-    "esbuild": "0.25.12",
+    "esbuild": "0.27.0",
     "eslint": "^9.22.0",
     "globals": "^16.0.0",
     "jest": "^30.0.0",
@@ -95,7 +96,6 @@
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
     "aws-cdk-lib": "2.222.0",
-    "aws-sdk": "^2.1574.0",
     "boxen": "^8.0.0",
     "chalk": "^5.0.0",
     "commander": "^14.0.2",