@camunda8/cli 3.1.0 → 3.2.0-alpha.10

package/dist/commands/helpers/deploy-helpers.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Shared deployment helpers — resource collection, deployment execution,
+ * and process-application detection.
+ *
+ * Consumed by:
+ * - `src/commands/deploy.ts` (the `deployCommand` handler)
+ * - `src/commands/watch.ts` (change-triggered re-deploys)
+ */
+import type { CamundaClient } from "@camunda8/orchestration-cluster-api";
+/**
+ * Helper to output messages that respect JSON mode for Unix pipe compatibility
+ */
+export declare function logMessage(message: string): void;
+/**
+ * Format and log a hint about skipped file extensions.
+ * Shared between the dry-run preview and the execute path so the
+ * message stays consistent. See https://github.com/camunda/c8ctl/issues/350
+ */
+export declare function logSkippedExtensions(skippedExtensions: Set<string>): void;
+/**
+ * Check whether the connected Camunda server supports extended file extensions.
+ * Returns `true` for 8.10+, `false` for older versions.
+ * Falls back to `false` on any error (network, auth, unparseable version)
+ * so unsupported resource types are not deployed to older clusters.
+ */
+export declare function checkServerSupportsExtensions(client: CamundaClient): Promise<boolean>;
+interface ResourceFile {
+    path: string;
+    name: string;
+    content: Buffer;
+    isBuildingBlock: boolean;
+    isProcessApplication: boolean;
+    groupPath?: string;
+    relativePath?: string;
+}
+/**
+ * Walk up from `startDir` looking for a `.process-application` marker
+ * file. Returns the directory that contains the marker, or `null` if
+ * none is found before reaching the filesystem root.
+ *
+ * `startDir` may be a file path — the walk starts from its parent
+ * directory in that case (the initial `hasProcessApplicationFile` call
+ * harmlessly returns false for non-directories).
+ *
+ * Unlike `findGroupRoot()` (which tags individual files for display),
+ * this function determines the *deploy scope*: when a PA root is found,
+ * `collectResourcesForPaths` expands the input to the PA root so that
+ * the entire application is deployed.
+ */
+export declare function findProcessApplicationRoot(startDir: string): string | null;
+/**
+ * Result of collecting deployable resources, including any extensions
+ * that were skipped during directory walks (for user feedback).
+ */
+interface CollectResult {
+    resources: ResourceFile[];
+    skippedExtensions: Set<string>;
+    skippedFiles: string[];
+    /** Resolved base paths used for resource collection and display.
+     *  When PA detection fires, these are expanded to the PA root(s)
+     *  rather than the user-supplied input paths. Used downstream for
+     *  `ignoreBaseDir` resolution and `basePaths` in `deployResources`. */
+    effectivePaths: string[];
+}
+/**
+ * Collect deployable resources from the given paths, applying `.c8ignore`
+ * rules. Throws on the two pre-API guard failures so callers (deploy
+ * handler, watch, dry-run preview) all surface the same errors with the
+ * same wording.
+ *
+ * Shared between `deployCommand` (used for both the dry-run preview and
+ * the execute path via `deployResources`) and `deployResources` itself.
+ *
+ * @param extensionList - Active allow-list for directory discovery.
+ *   Defaults to `DEPLOYABLE_EXTENSIONS` (.bpmn, .dmn, .form).
+ */
+export declare function collectResourcesForPaths(paths: string[], force?: boolean, extensionList?: readonly string[], 
+/** When false, skip loading deploy-always negation rules from .c8ignore.
+ *  Used to suppress them on servers <8.10 that don't support extended extensions. */
+loadDeployAlways?: boolean): CollectResult;
+/**
+ * Internal helper: deploy the given paths to the cluster and render the
+ * result table. Used by `deployCommand` (the standard CLI entry point)
+ * and by `watchCommand` (for change-triggered re-deploys).
+ *
+ * Does NOT consult dry-run state — dry-run handling lives in the
+ * `deployCommand` handler so the context's `ctx.dryRun()` helper owns
+ * preview emission. Watch never triggers a dry-run, so this split also
+ * removes a footgun where a stale dry-run flag could suppress a watch
+ * deploy.
+ */
+export declare function deployResources(paths: string[], options: {
+    profile?: string;
+    continueOnError?: boolean;
+    continueOnUserError?: boolean;
+    force?: boolean;
+    extensionList?: readonly string[];
+    /**
+     * Optional cancellation signal. When aborted, an in-flight
+     * `createDeployment` HTTP request is cancelled via the SDK's
+     * `CancelablePromise.cancel()`. Cancellation is handled internally:
+     * if the signal is aborted, `deployResources()` returns early
+     * without surfacing the cancellation as a deploy failure (no
+     * "Deployment failed" log, no rejection from the awaited promise).
+     * Callers do not need their own try/catch to suppress aborts.
+     */
+    signal?: AbortSignal;
+    /** When true, skip the skipped-extensions log (caller already handled it). */
+    suppressSkippedLog?: boolean;
+    /** When false, skip loading deploy-always negation rules from .c8ignore.
+     *  Used to suppress them on servers <8.10 that don't support extended extensions. */
+    loadDeployAlways?: boolean;
+    /** Override base path for relative path display. When set, used instead
+     *  of inferring from paths (avoids regression when extra file paths are appended). */
+    basePath?: string;
+    /** Whether --verbose was set (surfaces raw errors with stack traces). */
+    verbose?: boolean;
+}): Promise<void>;
+export {};
+//# sourceMappingURL=deploy-helpers.d.ts.map

package/dist/commands/helpers/deploy-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy-helpers.d.ts","sourceRoot":"","sources":["../../../src/commands/helpers/deploy-helpers.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAUH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAsBzE;;GAEG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAMhD;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,iBAAiB,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI,CAOzE;AAED;;;;;GAKG;AACH,wBAAsB,6BAA6B,CAClD,MAAM,EAAE,aAAa,GACnB,OAAO,CAAC,OAAO,CAAC,CAuBlB;AA2BD,UAAU,YAAY;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,OAAO,CAAC;IACzB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AA6DD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAc1E;AA+LD;;;GAGG;AACH,UAAU,aAAa;IACtB,SAAS,EAAE,YAAY,EAAE,CAAC;IAC1B,iBAAiB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/B,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;;2EAGuE;IACvE,cAAc,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,wBAAwB,CACvC,KAAK,EAAE,MAAM,EAAE,EACf,KAAK,CAAC,EAAE,OAAO,EACf,aAAa,GAAE,SAAS,MAAM,EAA0B;AACxD;qFACqF;AACrF,gBAAgB,UAAO,GACrB,aAAa,CAyHf;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,eAAe,CACpC,KAAK,EAAE,MAAM,EAAE,EACf,OAAO,EAAE;IACR,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,8EAA8E;IAC9E,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;yFACqF;IACrF,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;0FACsF;IACtF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB,GACC,OAAO,CAAC,IAAI,CAAC,CAwVf"}