checkly 9.5.0 → 10.0.0-prerelease-4f88d60

package/dist/services/deploy-diff/legacy-payload.d.ts

@@ -0,0 +1,22 @@
+import type { ProjectSync } from '../../rest/projects.js';
+/**
+ * The deploy payload as a Checkly API without the preview endpoint accepts it.
+ *
+ * `sourceFile`, each snapshot's `sha256` and a Playwright check's
+ * `codeBundleSha256` were all added alongside that endpoint. Older deploy
+ * schemas reject a key they do not know rather than ignoring it, so a CLI
+ * talking to one has to take them back out — otherwise every deploy against
+ * such an API fails validation.
+ *
+ * A snapshot with no storage key is dropped: it describes a file that has not
+ * been uploaded, which only a preview accepts, and an older API has no
+ * preview. Dropping the entry leaves the check's snapshots as they are rather
+ * than failing the deploy.
+ *
+ * Returns a copy, so the caller can still send the full payload to an API that
+ * does support the endpoint.
+ *
+ * Temporary by design: once every API a supported CLI talks to accepts these
+ * fields, this function and its call site go away.
+ */
+export declare function stripUnsupportedDeployFields(payload: ProjectSync): ProjectSync;

package/dist/services/deploy-diff/legacy-payload.js

@@ -0,0 +1,51 @@
+import { stripContentHashes } from '../snapshot-service.js';
+/**
+ * The deploy payload as a Checkly API without the preview endpoint accepts it.
+ *
+ * `sourceFile`, each snapshot's `sha256` and a Playwright check's
+ * `codeBundleSha256` were all added alongside that endpoint. Older deploy
+ * schemas reject a key they do not know rather than ignoring it, so a CLI
+ * talking to one has to take them back out — otherwise every deploy against
+ * such an API fails validation.
+ *
+ * A snapshot with no storage key is dropped: it describes a file that has not
+ * been uploaded, which only a preview accepts, and an older API has no
+ * preview. Dropping the entry leaves the check's snapshots as they are rather
+ * than failing the deploy.
+ *
+ * Returns a copy, so the caller can still send the full payload to an API that
+ * does support the endpoint.
+ *
+ * Temporary by design: once every API a supported CLI talks to accepts these
+ * fields, this function and its call site go away.
+ */
+export function stripUnsupportedDeployFields(payload) {
+    return {
+        ...payload,
+        resources: payload.resources.map(resource => {
+            const stripped = { ...resource };
+            delete stripped.sourceFile;
+            if (stripped.payload === null || typeof stripped.payload !== 'object') {
+                return stripped;
+            }
+            // The content hashes go the same way they do on a run request.
+            stripped.payload = stripContentHashes(stripped.payload);
+            const snapshots = stripped.payload.snapshots;
+            if (Array.isArray(snapshots)) {
+                const uploaded = snapshots.filter((snapshot) => typeof snapshot.key === 'string');
+                if (uploaded.length || snapshots.length === 0) {
+                    // An empty array is meaningful — "this check has no snapshots" — and
+                    // has always been sent, so it is kept as it is. The key is dropped
+                    // only when every entry had to go, which would otherwise turn "none
+                    // of these are uploaded yet" into "this check has none".
+                    stripped.payload.snapshots = uploaded;
+                }
+                else {
+                    delete stripped.payload.snapshots;
+                }
+            }
+            return stripped;
+        }),
+    };
+}
+//# sourceMappingURL=legacy-payload.js.map

package/dist/services/deploy-diff/legacy-payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"legacy-payload.js","sourceRoot":"","sources":["../../../src/services/deploy-diff/legacy-payload.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAE3D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,4BAA4B,CAAE,OAAoB;IAChE,OAAO;QACL,GAAG,OAAO;QACV,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YAC1C,MAAM,QAAQ,GAAuB,EAAE,GAAG,QAAQ,EAAE,CAAA;YACpD,OAAO,QAAQ,CAAC,UAAU,CAAA;YAE1B,IAAI,QAAQ,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACtE,OAAO,QAAQ,CAAA;YACjB,CAAC;YAED,+DAA+D;YAC/D,QAAQ,CAAC,OAAO,GAAG,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;YAEvD,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAA;YAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7B,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,QAA0B,EAAE,EAAE,CAAC,OAAO,QAAQ,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAA;gBACnG,IAAI,QAAQ,CAAC,MAAM,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC9C,qEAAqE;oBACrE,mEAAmE;oBACnE,oEAAoE;oBACpE,yDAAyD;oBACzD,QAAQ,CAAC,OAAO,CAAC,SAAS,GAAG,QAAQ,CAAA;gBACvC,CAAC;qBAAM,CAAC;oBACN,OAAO,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAA;gBACnC,CAAC;YACH,CAAC;YAED,OAAO,QAAQ,CAAA;QACjB,CAAC,CAAC;KACH,CAAA;AACH,CAAC"}

package/dist/services/deploy-diff/plan-summary.d.ts

@@ -0,0 +1,81 @@
+import type { DiffEntry } from '../../rest/projects.js';
+export interface PlanSummaryOptions {
+    /** Display names per resource type, for the types a user declares. */
+    prettyTypes: Record<string, string>;
+    /** Types reported as part of their owning check or group rather than on their own. */
+    foldedTypes: readonly string[];
+}
+/** A relation the project does not manage, which this deploy will delete. */
+export declare function isPrunedRelation(entry: DiffEntry): boolean;
+/**
+ * True when every change reported on a resource is a relation the project does
+ * not manage. Checkly reports those on the owning check or group whether or not
+ * the deploy would delete them, and without `--prune-unmanaged-relations` it deletes
+ * nothing — so the resource itself is untouched and naming it as an update
+ * would describe a write that never happens.
+ */
+export declare function onlyUnmanagedChanges(entry: DiffEntry): boolean;
+/**
+ * True for a resource the deploy writes only to set a baseline: Checkly
+ * compared it with what is live for want of an earlier planned deploy
+ * (`basis: 'live'`) and found nothing to report, or nothing but relations the
+ * project does not manage. The write happens whatever was found, and the
+ * reported changes are not exhaustive (a secret or content Checkly does not
+ * return may differ), so the plan lists the resource; but as a baseline, not
+ * as the update a resource with a difference to show is. Relations the
+ * project does not manage count for nothing here whether or not the deploy
+ * prunes them: pruned, each is deleted on an entry of its own, which the plan
+ * lists; not pruned, they are left alone, which the `!` row says.
+ */
+export declare function writtenForBaseline(entry: DiffEntry): boolean;
+/**
+ * True when the plan gives the deploy nothing to write: no resource to create,
+ * update, delete or detach, and no relation to prune. Relations the project
+ * does not manage and is not pruning do not count, since the deploy leaves
+ * them alone.
+ */
+export declare function planHasNoChanges(diff: DiffEntry[], options: PlanSummaryOptions): boolean;
+/**
+ * One line per resource the deploy would touch, deletions first and in full,
+ * for the confirmation prompt and the agent envelope.
+ */
+export declare function planChangeLines(diff: DiffEntry[], options: PlanSummaryOptions): string[];
+/**
+ * A resource the plan reports as changed in Checkly since the last planned
+ * deploy, which the deploy would overwrite: properties edited in Checkly
+ * (`paths`), or the resource deleted there, which the deploy creates again.
+ */
+export interface DriftedResource {
+    type: string;
+    logicalId: string;
+    deleted: boolean;
+    paths: string[];
+}
+/**
+ * The resources the plan reports as changed in Checkly, one per check, group
+ * or other declared resource: a relation's drift (an alert channel
+ * subscription removed in Checkly, say) is reported on the resource it is
+ * folded into. Relations the project does not manage are not drift: they are
+ * left alone unless `--prune-unmanaged-relations` asks for them to be deleted.
+ *
+ * Blind to a resource without a baseline (`basis: 'live'`): Checkly compares
+ * it with what is deployed, so code changes and edits made in Checkly look
+ * the same. {@link unbaselinedResources} counts those. Also blind to a
+ * resource the code removes: Checkly reports no changes on a deletion.
+ */
+export declare function findDrift(diff: readonly DiffEntry[], { foldedTypes }: PlanSummaryOptions): DriftedResource[];
+/**
+ * How many declared resources Checkly had no earlier planned deploy to
+ * compare with (`basis: 'live'`), which {@link findDrift} cannot check.
+ */
+export declare function unbaselinedResources(diff: readonly DiffEntry[], { foldedTypes }: PlanSummaryOptions): number;
+/** One line per drifted resource, saying what changed in Checkly and what the deploy would do about it. */
+export declare function driftLines(drift: readonly DriftedResource[], options: PlanSummaryOptions): string[];
+/**
+ * The plan as the agent envelope carries it: every entry and every changed
+ * property, but without the resources' full current state and without the
+ * large values the rendered diff needs. Rendering happens in the terminal
+ * output; the envelope is there to be read, and it is the same plan, pinned by
+ * the same `planToken`.
+ */
+export declare function reducePlanForAgent(diff: DiffEntry[]): DiffEntry[];

package/dist/services/deploy-diff/plan-summary.js

@@ -0,0 +1,262 @@
+import { isDeepStrictEqual } from 'node:util';
+/**
+ * Turns a deploy plan into the two forms `confirmOrAbort` needs: the
+ * human-readable `changes` lines of its preview, and the machine-readable plan
+ * that goes into the agent envelope next to them.
+ */
+/**
+ * How many create/update lines the confirmation prompt lists before summing up
+ * the rest. A first deploy of a large project would otherwise scroll its own
+ * question off the screen. Deletions are never summarized away: they are the
+ * part of a plan that loses data, so every one of them is named.
+ */
+const MAX_LISTED_CHANGES = 20;
+/**
+ * Largest value the agent envelope carries inline, serialized. Repeating a
+ * whole script, response body or environment-variable list in a confirmation
+ * envelope helps nobody and can be megabytes; what is left in its place says
+ * how long it was.
+ */
+const MAX_INLINE_VALUE = 256;
+/** A relation the project does not manage, which this deploy will delete. */
+export function isPrunedRelation(entry) {
+    return entry.action === 'DELETE' && entry.origin === 'unmanaged';
+}
+/**
+ * True when every change reported on a resource is a relation the project does
+ * not manage. Checkly reports those on the owning check or group whether or not
+ * the deploy would delete them, and without `--prune-unmanaged-relations` it deletes
+ * nothing — so the resource itself is untouched and naming it as an update
+ * would describe a write that never happens.
+ */
+export function onlyUnmanagedChanges(entry) {
+    return (entry.changes?.length ?? 0) > 0 && entry.changes.every(change => change.origin === 'unmanaged');
+}
+/**
+ * True for a resource the deploy writes only to set a baseline: Checkly
+ * compared it with what is live for want of an earlier planned deploy
+ * (`basis: 'live'`) and found nothing to report, or nothing but relations the
+ * project does not manage. The write happens whatever was found, and the
+ * reported changes are not exhaustive (a secret or content Checkly does not
+ * return may differ), so the plan lists the resource; but as a baseline, not
+ * as the update a resource with a difference to show is. Relations the
+ * project does not manage count for nothing here whether or not the deploy
+ * prunes them: pruned, each is deleted on an entry of its own, which the plan
+ * lists; not pruned, they are left alone, which the `!` row says.
+ */
+export function writtenForBaseline(entry) {
+    return entry.basis === 'live' && entry.action === 'UPDATE'
+        && (entry.changes ?? []).every(change => change.origin === 'unmanaged');
+}
+/** A relation reported as part of the check or group it belongs to, not as a resource of its own. */
+function isFolded(entry, foldedTypes) {
+    return entry.foldedInto !== undefined || foldedTypes.includes(entry.type);
+}
+/**
+ * Entries worth showing: a resource the deploy touches. An `UNCHANGED` entry
+ * with no changes of its own is the converged case and says nothing, a relation
+ * folded into its parent is already reported there, and a resource whose only
+ * reported changes are unmanaged relations is not written either, unless the
+ * deploy writes it to set the baseline for later plans.
+ */
+function reportable(entry, { foldedTypes }) {
+    // A relation the deploy would delete is reported on its own entry, folded
+    // into its parent for display. It is the one folded entry worth a line of its
+    // own: nothing else in the plan says which relations are about to go.
+    if (isPrunedRelation(entry)) {
+        return true;
+    }
+    if (isFolded(entry, foldedTypes)) {
+        return false;
+    }
+    // Whether or not the relations are pruned, the resource they hang off is not
+    // written: with `--prune-unmanaged-relations` the relation's own entry carries the line.
+    // Except when Checkly had no usable state from an earlier planned deploy and
+    // compared the resource with what is deployed (`basis: 'live'`): the deploy
+    // writes it whatever was found, so it is never "nothing to apply".
+    if (onlyUnmanagedChanges(entry) && entry.basis !== 'live') {
+        return false;
+    }
+    return entry.action !== 'UNCHANGED' || (entry.changes?.length ?? 0) > 0;
+}
+/**
+ * True when the plan gives the deploy nothing to write: no resource to create,
+ * update, delete or detach, and no relation to prune. Relations the project
+ * does not manage and is not pruning do not count, since the deploy leaves
+ * them alone.
+ */
+export function planHasNoChanges(diff, options) {
+    return !diff.some(entry => reportable(entry, options));
+}
+function label(entry, { prettyTypes }) {
+    return `${prettyTypes[entry.type] ?? entry.type}: ${entry.logicalId}`;
+}
+/**
+ * One line per resource the deploy would touch, deletions first and in full,
+ * for the confirmation prompt and the agent envelope.
+ */
+export function planChangeLines(diff, options) {
+    const shown = diff.filter(entry => reportable(entry, options));
+    const deletions = shown.filter(entry => entry.action === 'DELETE');
+    // `DETACHED` is what an API older than the deploy diff calls the same thing.
+    const detached = (entry) => entry.action === 'DETACH' || entry.action === 'DETACHED';
+    const detachments = shown.filter(detached);
+    // What the deploy changes comes first, so that a long first plan does not
+    // push its few real edits past the window with resources it only baselines.
+    const rest = [
+        ...shown.filter(entry => entry.action !== 'DELETE' && !detached(entry) && !writtenForBaseline(entry)),
+        ...shown.filter(writtenForBaseline),
+    ];
+    const lines = [
+        ...deletions.map(entry => (isPrunedRelation(entry)
+            // Not a resource the project declared, so it has no run history to lose;
+            // what it names is the check or group it hangs off, when the plan says.
+            ? `Delete the ${options.prettyTypes[entry.type] ?? entry.type} `
+                + (entry.foldedInto
+                    ? `on ${options.prettyTypes[entry.foldedInto.type] ?? entry.foldedInto.type}: `
+                        + `${entry.foldedInto.logicalId}, `
+                    : `${entry.logicalId}, `)
+                + 'which this project does not manage'
+            : `Permanently delete ${label(entry, options)}, losing its run history`)),
+        ...detachments.map(entry => `Keep ${label(entry, options)} in your Checkly account, managed from the web app`),
+        ...rest.slice(0, MAX_LISTED_CHANGES).map(entry => {
+            const verb = entry.action === 'CREATE'
+                ? 'Create'
+                : writtenForBaseline(entry) ? 'Set a baseline for' : 'Update';
+            return `${verb} ${label(entry, options)}`;
+        }),
+    ];
+    const hidden = rest.slice(MAX_LISTED_CHANGES);
+    const hiddenBaselines = hidden.filter(writtenForBaseline).length;
+    const hiddenChanges = hidden.length - hiddenBaselines;
+    const summed = [
+        ...(hiddenChanges > 0 ? [`Create or update ${hiddenChanges} more resource(s)`] : []),
+        ...(hiddenBaselines > 0 ? [`Set a baseline for ${hiddenBaselines} more resource(s)`] : []),
+    ];
+    if (summed.length > 0) {
+        lines.push(`${summed.join(' and ')}; run with --preview to see them all`);
+    }
+    return lines;
+}
+/**
+ * Whether the deploy would overwrite a value changed in Checkly. A path both
+ * sides moved is settled when the code now holds what Checkly holds (the
+ * user copied the edit into the code), and Checkly can still report it then.
+ * A secret or a change reported by cause alone carries no comparable values,
+ * so it counts.
+ */
+function overwritesRemoteChange(change) {
+    if (change.origin === 'remote') {
+        return true;
+    }
+    if (change.origin !== 'both') {
+        return false;
+    }
+    return change.secret === true || change.cause !== undefined || !isDeepStrictEqual(change.after, change.remote?.after);
+}
+/**
+ * The resources the plan reports as changed in Checkly, one per check, group
+ * or other declared resource: a relation's drift (an alert channel
+ * subscription removed in Checkly, say) is reported on the resource it is
+ * folded into. Relations the project does not manage are not drift: they are
+ * left alone unless `--prune-unmanaged-relations` asks for them to be deleted.
+ *
+ * Blind to a resource without a baseline (`basis: 'live'`): Checkly compares
+ * it with what is deployed, so code changes and edits made in Checkly look
+ * the same. {@link unbaselinedResources} counts those. Also blind to a
+ * resource the code removes: Checkly reports no changes on a deletion.
+ */
+export function findDrift(diff, { foldedTypes }) {
+    const byResource = new Map();
+    for (const entry of diff) {
+        const remotePaths = (entry.changes ?? [])
+            .filter(overwritesRemoteChange)
+            .map(change => change.path);
+        // Checkly marks a creation `remote` when the resource the last deploy
+        // wrote was deleted in Checkly since.
+        const recreated = entry.action === 'CREATE' && entry.origin === 'remote';
+        if (remotePaths.length === 0 && !recreated) {
+            continue;
+        }
+        const owner = entry.foldedInto ?? entry;
+        const key = `${owner.type}:${owner.logicalId}`;
+        const resource = byResource.get(key)
+            ?? { type: owner.type, logicalId: owner.logicalId, deleted: false, paths: [] };
+        byResource.set(key, resource);
+        if (recreated && !isFolded(entry, foldedTypes)) {
+            resource.deleted = true;
+        }
+        else if (recreated) {
+            // A relation has no path on its owner; its type says what was removed.
+            resource.paths.push(entry.type);
+        }
+        resource.paths.push(...remotePaths);
+    }
+    return [...byResource.values()]
+        .map(resource => ({ ...resource, paths: [...new Set(resource.paths)] }))
+        .sort((a, b) => a.type.localeCompare(b.type) || a.logicalId.localeCompare(b.logicalId));
+}
+/**
+ * How many declared resources Checkly had no earlier planned deploy to
+ * compare with (`basis: 'live'`), which {@link findDrift} cannot check.
+ */
+export function unbaselinedResources(diff, { foldedTypes }) {
+    return diff.filter(entry => entry.basis === 'live' && !isFolded(entry, foldedTypes)).length;
+}
+/** One line per drifted resource, saying what changed in Checkly and what the deploy would do about it. */
+export function driftLines(drift, options) {
+    return drift.map(resource => {
+        const name = `${options.prettyTypes[resource.type] ?? resource.type}: ${resource.logicalId}`;
+        return resource.deleted
+            ? `${name} was deleted in Checkly; this deploy would create it again`
+            : `${name} was changed in Checkly (${resource.paths.join(', ')}); this deploy would overwrite it`;
+    });
+}
+/**
+ * A value small enough to carry, or `{ $omitted: <length> }` in its place.
+ */
+function reduceValue(value) {
+    if (value === null || value === undefined || typeof value === 'boolean' || typeof value === 'number') {
+        return value;
+    }
+    // Not only strings: a leaf can be a whole collection (a check group's
+    // environment variables, a status page's cards), and one of those holding a
+    // large value would otherwise go into the envelope in full.
+    const size = typeof value === 'string' ? value.length : JSON.stringify(value)?.length ?? 0;
+    return size > MAX_INLINE_VALUE ? { $omitted: size } : value;
+}
+function reduceChange(change) {
+    return {
+        ...change,
+        ...'before' in change ? { before: reduceValue(change.before) } : {},
+        ...'after' in change ? { after: reduceValue(change.after) } : {},
+        ...change.remote !== undefined
+            ? {
+                remote: {
+                    ...'before' in change.remote ? { before: reduceValue(change.remote.before) } : {},
+                    ...'after' in change.remote ? { after: reduceValue(change.remote.after) } : {},
+                },
+            }
+            : {},
+    };
+}
+/**
+ * The plan as the agent envelope carries it: every entry and every changed
+ * property, but without the resources' full current state and without the
+ * large values the rendered diff needs. Rendering happens in the terminal
+ * output; the envelope is there to be read, and it is the same plan, pinned by
+ * the same `planToken`.
+ */
+export function reducePlanForAgent(diff) {
+    return diff.map(entry => {
+        const reduced = { ...entry };
+        // The rule table is applied to `before`; without the state, it is dead weight.
+        delete reduced.before;
+        delete reduced.redactions;
+        if (entry.changes !== undefined) {
+            reduced.changes = entry.changes.map(reduceChange);
+        }
+        return reduced;
+    });
+}
+//# sourceMappingURL=plan-summary.js.map

package/dist/services/deploy-diff/plan-summary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan-summary.js","sourceRoot":"","sources":["../../../src/services/deploy-diff/plan-summary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAI7C;;;;GAIG;AAEH;;;;;GAKG;AACH,MAAM,kBAAkB,GAAG,EAAE,CAAA;AAE7B;;;;;GAKG;AACH,MAAM,gBAAgB,GAAG,GAAG,CAAA;AAS5B,6EAA6E;AAC7E,MAAM,UAAU,gBAAgB,CAAE,KAAgB;IAChD,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,KAAK,WAAW,CAAA;AAClE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAAE,KAAgB;IACpD,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,OAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,WAAW,CAAC,CAAA;AAC1G,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,kBAAkB,CAAE,KAAgB;IAClD,OAAO,KAAK,CAAC,KAAK,KAAK,MAAM,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ;WACrD,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,WAAW,CAAC,CAAA;AAC3E,CAAC;AAED,qGAAqG;AACrG,SAAS,QAAQ,CAAE,KAAgB,EAAE,WAA8B;IACjE,OAAO,KAAK,CAAC,UAAU,KAAK,SAAS,IAAI,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;AAC3E,CAAC;AAED;;;;;;GAMG;AACH,SAAS,UAAU,CAAE,KAAgB,EAAE,EAAE,WAAW,EAAsB;IACxE,0EAA0E;IAC1E,8EAA8E;IAC9E,sEAAsE;IACtE,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAA;IACb,CAAC;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAA;IACd,CAAC;IACD,6EAA6E;IAC7E,yFAAyF;IACzF,6EAA6E;IAC7E,4EAA4E;IAC5E,mEAAmE;IACnE,IAAI,oBAAoB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;QAC1D,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,KAAK,WAAW,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;AACzE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAE,IAAiB,EAAE,OAA2B;IAC9E,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AACxD,CAAC;AAED,SAAS,KAAK,CAAE,KAAgB,EAAE,EAAE,WAAW,EAAsB;IACnE,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,EAAE,CAAA;AACvE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAE,IAAiB,EAAE,OAA2B;IAC7E,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;IAC9D,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAA;IAClE,6EAA6E;IAC7E,MAAM,QAAQ,GAAG,CAAC,KAAgB,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,KAAK,UAAU,CAAA;IAC/F,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IAC1C,0EAA0E;IAC1E,4EAA4E;IAC5E,MAAM,IAAI,GAAG;QACX,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACrG,GAAG,KAAK,CAAC,MAAM,CAAC,kBAAkB,CAAC;KACpC,CAAA;IAED,MAAM,KAAK,GAAG;QACZ,GAAG,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC;YAChD,yEAAyE;YACzE,wEAAwE;YACxE,CAAC,CAAC,cAAc,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,GAAG;kBAC9D,CAAC,KAAK,CAAC,UAAU;oBACjB,CAAC,CAAC,MAAM,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,IAAI;0BAC7E,GAAG,KAAK,CAAC,UAAU,CAAC,SAAS,IAAI;oBACnC,CAAC,CAAC,GAAG,KAAK,CAAC,SAAS,IAAI,CAAC;kBACzB,oCAAoC;YACtC,CAAC,CAAC,sBAAsB,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAC;QAC3E,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,QAAQ,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,oDAAoD,CAAC;QAC9G,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;YAC/C,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,KAAK,QAAQ;gBACpC,CAAC,CAAC,QAAQ;gBACV,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,QAAQ,CAAA;YAC/D,OAAO,GAAG,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAA;QAC3C,CAAC,CAAC;KACH,CAAA;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAA;IAC7C,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAA;IAChE,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,GAAG,eAAe,CAAA;IACrD,MAAM,MAAM,GAAG;QACb,GAAG,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAoB,aAAa,mBAAmB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACpF,GAAG,CAAC,eAAe,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,sBAAsB,eAAe,mBAAmB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KAC3F,CAAA;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,sCAAsC,CAAC,CAAA;IAC3E,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAcD;;;;;;GAMG;AACH,SAAS,sBAAsB,CAAE,MAAkB;IACjD,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAA;IACb,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AACvH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,SAAS,CAAE,IAA0B,EAAE,EAAE,WAAW,EAAsB;IACxF,MAAM,UAAU,GAAG,IAAI,GAAG,EAA2B,CAAA;IACrD,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;QACzB,MAAM,WAAW,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC;aACtC,MAAM,CAAC,sBAAsB,CAAC;aAC9B,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAC7B,sEAAsE;QACtE,sCAAsC;QACtC,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAA;QACxE,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YAC3C,SAAQ;QACV,CAAC;QACD,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,IAAI,KAAK,CAAA;QACvC,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,SAAS,EAAE,CAAA;QAC9C,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC;eAC/B,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAAA;QAChF,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;QAC7B,IAAI,SAAS,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC;YAC/C,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAA;QACzB,CAAC;aAAM,IAAI,SAAS,EAAE,CAAC;YACrB,uEAAuE;YACvE,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACjC,CAAC;QACD,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAA;IACrC,CAAC;IACD,OAAO,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;SAC5B,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;SACvE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAA;AAC3F,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAE,IAA0B,EAAE,EAAE,WAAW,EAAsB;IACnG,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACzB,KAAK,CAAC,KAAK,KAAK,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,CACxD,CAAC,MAAM,CAAA;AACV,CAAC;AAED,2GAA2G;AAC3G,MAAM,UAAU,UAAU,CAAE,KAAiC,EAAE,OAA2B;IACxF,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;QAC1B,MAAM,IAAI,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,SAAS,EAAE,CAAA;QAC5F,OAAO,QAAQ,CAAC,OAAO;YACrB,CAAC,CAAC,GAAG,IAAI,4DAA4D;YACrE,CAAC,CAAC,GAAG,IAAI,4BAA4B,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,mCAAmC,CAAA;IACrG,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAE,KAAc;IAClC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrG,OAAO,KAAK,CAAA;IACd,CAAC;IACD,sEAAsE;IACtE,4EAA4E;IAC5E,4DAA4D;IAC5D,MAAM,IAAI,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC,CAAA;IAC1F,OAAO,IAAI,GAAG,gBAAgB,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;AAC7D,CAAC;AAED,SAAS,YAAY,CAAE,MAAkB;IACvC,OAAO;QACL,GAAG,MAAM;QACT,GAAG,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;QACnE,GAAG,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;QAChE,GAAG,MAAM,CAAC,MAAM,KAAK,SAAS;YAC5B,CAAC,CAAC;gBACE,MAAM,EAAE;oBACN,GAAG,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;oBACjF,GAAG,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;iBAC/E;aACF;YACH,CAAC,CAAC,EAAE;KACP,CAAA;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAE,IAAiB;IACnD,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QACtB,MAAM,OAAO,GAAc,EAAE,GAAG,KAAK,EAAE,CAAA;QACvC,+EAA+E;QAC/E,OAAO,OAAO,CAAC,MAAM,CAAA;QACrB,OAAO,OAAO,CAAC,UAAU,CAAA;QACzB,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;QACnD,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/services/deploy-diff/preview-output.d.ts

@@ -0,0 +1,63 @@
+import { Project } from '../../constructs/index.js';
+import type { DeployResourceSync, DiffEntry } from '../../rest/projects.js';
+import { type RenderedLine } from './render.js';
+/**
+ * The text `checkly deploy` prints for a plan: what `--preview` shows, what
+ * `--output` prints after a deploy, and what a deploy refused for a stale plan
+ * prints in its place. Shaped like a plan: an overview of every touched
+ * resource with a marker per action, the construct diff of each updated
+ * resource, and the totals. The markers carry the meaning; colour is for a
+ * terminal and chalk drops it for a pipe or under `NO_COLOR`.
+ */
+export declare enum ResourceDeployStatus {
+    UPDATE = "UPDATE",
+    CREATE = "CREATE",
+    DELETE = "DELETE",
+    DETACH = "DETACH",
+    DETACHED = "DETACHED",
+    UNCHANGED = "UNCHANGED"
+}
+/** How a resource type reads when there is no construct to name it by (a deleted resource, a relation). */
+export declare const PRETTY_RESOURCE_TYPES: Record<string, string>;
+export declare const NON_REPORTED_TYPES: string[];
+export interface PreviewOutputInput {
+    /** The heading line; none when the lines that follow name the deploy already. */
+    heading?: {
+        title: string;
+        projectName: string;
+        accountName?: string;
+    };
+    diff: DiffEntry[];
+    /** The plan was carried out: the totals read as what happened, not what would. */
+    done?: boolean;
+    project: Project;
+    /** Print each resource's name and id under its row. */
+    verbose?: boolean;
+    /** Whether this deploy deletes the relations it does not manage. */
+    pruneRelations?: boolean;
+    /**
+     * The preview plan with each changed resource's deployed state, and the
+     * local payload it was computed for: with these, every updated resource
+     * prints the diff of its construct as deployed against as in code.
+     */
+    rendering?: {
+        plan: DiffEntry[];
+        local: DeployResourceSync[];
+    };
+    /** Printed with the command that deploys exactly this plan. */
+    planToken?: string;
+}
+export declare const MARKER: {
+    create: string;
+    update: string;
+    delete: string;
+    detach: string;
+    prune: string;
+    warn: string;
+    skip: string;
+    /** Written once to set the baseline; nothing differs that the comparison can show. */
+    baseline: string;
+};
+export declare function formatPreview(input: PreviewOutputInput): string;
+/** One rendered line with its marker and colour; a nested line sits two columns further in. */
+export declare function styled(line: RenderedLine): string;