checkly 9.5.0 → 10.0.0-rc.1

package/dist/services/write-back/output.js

@@ -0,0 +1,110 @@
+import path from 'node:path';
+import chalk from 'chalk';
+import { padColumn, visWidth } from '../../formatters/render.js';
+import { diffLines } from '../deploy-diff/diff-lines.js';
+import { pathToPosix } from '../util.js';
+import { pointerSegments } from '../deploy-diff/import-shape.js';
+import { MARKER, PRETTY_RESOURCE_TYPES, styled } from '../deploy-diff/preview-output.js';
+const counted = (count, one, many) => `${count} ${count === 1 ? one : many}`;
+const sameResource = (a, b) => a.type === b.type && a.logicalId === b.logicalId;
+/** The header line of a resource: marker, class, logical id, and the file when it is known. */
+function header(marker, { type, logicalId }, file, project) {
+    const construct = project.data[type]?.[logicalId];
+    const name = construct?.constructor.name ?? PRETTY_RESOURCE_TYPES[type] ?? type;
+    // With forward slashes on every platform, as the plan names the file.
+    return `${marker} ${chalk.bold(name)} ${chalk.bold(logicalId)}`
+        + (file !== undefined ? `  ${chalk.dim(pathToPosix(file))}` : '');
+}
+/** A property's old and new source on one line, for a construct whose source cannot be shown as a diff. */
+function propertyLine({ property, previous, rendered }) {
+    const oneLine = (text) => text.replace(/\s*\r?\n\s*/g, ' ');
+    return `    ${property}: ${previous === undefined ? 'not set' : oneLine(previous)} → ${oneLine(rendered)}`;
+}
+/**
+ * The block for the code that was updated: per construct, the diff of its
+ * source, then what a diff cannot say (a property that replaced an edit the
+ * code had made too, a helper the file now imports).
+ */
+export function formatWriteBackUpdated({ writeBack, project }) {
+    const { applied, constructs, files, imports } = writeBack;
+    const output = [
+        `${chalk.bold('Updated your code')} ${chalk.dim('·')} `
+            + `${counted(applied.length, 'property', 'properties')} in ${counted(files.length, 'file', 'files')}`,
+        '',
+    ];
+    constructs.forEach((construct, index) => {
+        const lines = applied.filter(line => line.file === construct.file && sameResource(line, construct));
+        output.push(header(MARKER.update, construct, construct.file, project));
+        const diff = diffLines(construct.before, construct.after);
+        if (diff === undefined || diff.length === 0) {
+            // Too long to diff, which a construct's own source never is in
+            // practice: the properties are listed with their values instead.
+            output.push(...lines.map(propertyLine));
+        }
+        else {
+            // A diff opens with a hunk boundary, which is shown as the gap between
+            // two hunks, so the first one is left out.
+            output.push(...diff.slice(1).map(line => `  ${styled(line)}`.trimEnd()));
+        }
+        for (const line of lines.filter(line => line.replacesLocalEdit)) {
+            output.push(`  ${styled({ kind: 'note', text: `${line.property}: replaced a local edit` })}`);
+        }
+        // The import belongs to the file, so it is said once, under the last
+        // construct of that file.
+        const lastOfFile = !constructs.slice(index + 1).some(other => other.file === construct.file);
+        const imported = imports.find(entry => entry.file === construct.file);
+        if (lastOfFile && imported !== undefined) {
+            output.push(`  ${styled({ kind: 'note', text: `imported ${imported.names.join(', ')} from 'checkly/constructs'` })}`);
+        }
+        output.push('');
+    });
+    return output.join('\n');
+}
+/**
+ * A skipped property as the reader's code names it. A change refused before
+ * it was matched to a construct property is known by the path Checkly reports
+ * (`/runParallel`), which is shown dotted like the others.
+ */
+function propertyName(property) {
+    if (!property.startsWith('/')) {
+        return property;
+    }
+    try {
+        return pointerSegments(property).join('.');
+    }
+    catch {
+        return property;
+    }
+}
+/**
+ * The block for what was not written: per resource, each property with the
+ * reason, or the reason alone when it is about the whole resource.
+ */
+export function formatWriteBackSkipped({ writeBack, project, cwd }) {
+    const groups = [];
+    for (const skip of writeBack.skipped) {
+        const group = groups.find(candidate => sameResource(candidate.resource, skip));
+        if (group === undefined) {
+            groups.push({ resource: skip, skips: [skip] });
+        }
+        else {
+            group.skips.push(skip);
+        }
+    }
+    const output = [`${chalk.bold('Not updated')} ${chalk.dim('·')} edit these by hand`, ''];
+    for (const { resource, skips } of groups) {
+        const declaredIn = project.data[resource.type]?.[resource.logicalId]?.checkFileAbsolutePath;
+        const file = declaredIn === undefined ? undefined : path.relative(cwd, declaredIn);
+        output.push(header(MARKER.warn, resource, file, project));
+        const rows = skips.map(({ property, reason }) => ({ property: property === undefined ? undefined : propertyName(property), reason }));
+        const width = Math.max(0, ...rows.map(row => visWidth(row.property ?? '')));
+        for (const { property, reason } of rows) {
+            output.push(property === undefined
+                ? `    ${reason}`
+                : `    ${padColumn(property, width)}  ${chalk.dim(reason)}`);
+        }
+        output.push('');
+    }
+    return output.join('\n');
+}
+//# sourceMappingURL=output.js.map

package/dist/services/write-back/output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.js","sourceRoot":"","sources":["../../../src/services/write-back/output.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAA;AAE5B,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAChE,OAAO,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AAkBxF,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,GAAW,EAAE,IAAY,EAAU,EAAE,CAAC,GAAG,KAAK,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;AAE5G,MAAM,YAAY,GAAG,CAAC,CAAsC,EAAE,CAAsC,EAAW,EAAE,CAC/G,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS,CAAA;AAElD,+FAA+F;AAC/F,SAAS,MAAM,CACb,MAAc,EACd,EAAE,IAAI,EAAE,SAAS,EAAuC,EACxD,IAAwB,EACxB,OAAgB;IAEhB,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,IAAyB,CAAC,EAAE,CAAC,SAAS,CAAC,CAAA;IACtE,MAAM,IAAI,GAAG,SAAS,EAAE,WAAW,CAAC,IAAI,IAAI,qBAAqB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAA;IAC/E,sEAAsE;IACtE,OAAO,GAAG,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;UAC3D,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;AACrE,CAAC;AAED,2GAA2G;AAC3G,SAAS,YAAY,CAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAiB;IACpE,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,CAAC,CAAA;IACnE,OAAO,OAAO,QAAQ,KAAK,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAA;AAC5G,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAE,EAAE,SAAS,EAAE,OAAO,EAAwB;IAClF,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,SAAS,CAAA;IACzD,MAAM,MAAM,GAAa;QACvB,GAAG,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG;cACrD,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,YAAY,CAAC,OAAO,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QACrG,EAAE;KACH,CAAA;IACD,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;QACtC,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,IAAI,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAA;QACnG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;QACtE,MAAM,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,CAAC,CAAA;QACzD,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5C,+DAA+D;YAC/D,iEAAiE;YACjE,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAA;QACzC,CAAC;aAAM,CAAC;YACN,uEAAuE;YACvE,2CAA2C;YAC3C,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;QAC1E,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAChE,MAAM,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,QAAQ,yBAAyB,EAAE,CAAC,EAAE,CAAC,CAAA;QAC/F,CAAC;QACD,qEAAqE;QACrE,0BAA0B;QAC1B,MAAM,UAAU,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,CAAA;QAC5F,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,CAAA;QACrE,IAAI,UAAU,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzC,MAAM,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE,CAAC,EAAE,CAAC,CAAA;QACvH,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACjB,CAAC,CAAC,CAAA;IACF,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AAC1B,CAAC;AAED;;;;GAIG;AACH,SAAS,YAAY,CAAE,QAAgB;IACrC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9B,OAAO,QAAQ,CAAA;IACjB,CAAC;IACD,IAAI,CAAC;QACH,OAAO,eAAe,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAC5C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,QAAQ,CAAA;IACjB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAE,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,EAAwB;IACvF,MAAM,MAAM,GAA0D,EAAE,CAAA;IACxE,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;QAC9E,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAChD,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACxB,CAAC;IACH,CAAC;IACD,MAAM,MAAM,GAAa,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAA;IAClG,KAAK,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,MAAM,EAAE,CAAC;QACzC,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAyB,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,qBAAqB,CAAA;QAChH,MAAM,IAAI,GAAG,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;QAClF,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;QACzD,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,CAC9C,CAAC,EAAE,QAAQ,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAA;QACtF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;QAC3E,KAAK,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC;YACxC,MAAM,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS;gBAChC,CAAC,CAAC,OAAO,MAAM,EAAE;gBACjB,CAAC,CAAC,OAAO,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QAChE,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACjB,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AAC1B,CAAC"}

package/dist/services/write-back/plan.d.ts

@@ -0,0 +1,173 @@
+import type { Construct } from '../../constructs/construct.js';
+import type { Project } from '../../constructs/project.js';
+import type { DiffEntry } from '../../rest/projects.js';
+import type { AssertionBuilderName } from './helper-edit.js';
+/**
+ * Turns the remote changes of a deploy plan into edits of the construct
+ * source files, and applies them: checks, groups, alert channels, private
+ * locations, dashboards, maintenance windows and status pages with their
+ * services, components and automation rules.
+ *
+ * A remote change is a property that moved in the Checkly account since the
+ * last deploy (`origin: 'remote'`, or `'both'` when the code moved too). The
+ * value written is the account's current one, read from the entry's `before`
+ * — the deployed resource in the import format, which a full-detail preview
+ * carries — at the path the change names. The change list decides *which*
+ * paths are written; `before` supplies the values, because a change can
+ * carry a hash where `before` carries the text, and a set element change
+ * names one element where the code holds the whole list.
+ *
+ * Only what can be written without guessing is written. A property has to
+ * be one this module knows the construct's spelling of (the table below): a
+ * literal of the same shape, or a helper expression — `Frequency.EVERY_*`,
+ * `RetryStrategyBuilder`, `AlertEscalationBuilder`, an assertion builder —
+ * that `helper-edit.ts` renders from the value the way `checkly import`
+ * would; a value Checkly withholds — a credential the redaction table
+ * blanks, a masked secret, a hash — is never written; and when the change's
+ * own report of the current value disagrees with `before`, neither is
+ * trusted. Everything refused is listed with its reason.
+ */
+export interface WriteBackOptions {
+    diff: readonly DiffEntry[];
+    project: Project;
+    /** The directory file names are shown relative to. */
+    cwd: string;
+}
+export interface WriteBackLine {
+    /** The edited file, relative to `cwd`. */
+    file: string;
+    type: string;
+    logicalId: string;
+    /** The construct property, dotted. */
+    property: string;
+    /** The source text replaced, or undefined when the property was added. */
+    previous?: string;
+    /** The source text written. */
+    rendered: string;
+    /** Whether the code had moved too (`origin: 'both'`), so a local edit is being replaced. */
+    replacesLocalEdit: boolean;
+}
+/** A remote change that was not written, or a resource none could be written for. */
+export interface WriteBackSkip {
+    type: string;
+    logicalId: string;
+    /** The property or path the reason is about; none when it is about the whole resource. */
+    property?: string;
+    reason: string;
+}
+/**
+ * The source of one edited construct, from the line its options open on to
+ * the line they close on, before its edits and after them: what a reader
+ * needs to see the edits in place.
+ */
+export interface WriteBackConstruct {
+    /** The edited file, relative to `cwd`. */
+    file: string;
+    type: string;
+    logicalId: string;
+    before: string;
+    after: string;
+}
+export interface WriteBackPlan {
+    /** Each file's new text, with the text it was planned from. */
+    files: {
+        path: string;
+        text: string;
+        original: string;
+    }[];
+    applied: WriteBackLine[];
+    /** One entry per construct `applied` has lines for, in the order they were edited. */
+    constructs: WriteBackConstruct[];
+    skipped: WriteBackSkip[];
+    /** The helper classes added to each edited file's `checkly/constructs` import. */
+    imports: {
+        file: string;
+        names: string[];
+    }[];
+}
+/** How an import-format path maps onto a construct property. */
+export interface Rule {
+    /** Segments of the import-format pointer. */
+    pointer: string[];
+    /** The construct property path the pointer maps to. */
+    target: string[];
+    /** A list the API reports per element rather than whole; the code holds the whole list. */
+    set?: boolean;
+    /** Properties that only mean something together are written together or not at all. */
+    group?: string;
+    /** The helper the construct spells the property with; the value is written as its expression. */
+    helper?: {
+        kind: 'frequency' | 'retryStrategy' | 'date';
+    } | {
+        kind: 'alertEscalation';
+        policy: AlertPolicyHolder;
+    } | {
+        kind: 'assertions';
+        builder: AssertionBuilderName;
+    };
+    /** Further pointers whose `before` values the expression needs (`frequencyOffset` beside `frequency`). */
+    reads?: string[][];
+    /** Sibling keys of the property that make the edit wrong (`doubleCheck` beside `retryStrategy`). */
+    unless?: string[];
+    /**
+     * A rule that routes the changes at its pointer onto another rule's
+     * target (the one whose `target` it shares) rather than anchoring a
+     * candidate of its own: `/frequencyOffset` belongs to `frequency`,
+     * `/useGlobalAlertSettings` to `alertEscalationPolicy`, and a code-origin
+     * `/doubleCheck` marks `retryStrategy` as locally changed.
+     */
+    companion?: true;
+    /** For a companion, the reason its changes are refused given the deployed resource, if they are. */
+    refuse?: (before: unknown) => string | undefined;
+}
+/**
+ * Who holds the alert policy: a check or a v1 group spells "the global
+ * policy" by having none, which nothing is ever removed from the code for;
+ * a v2 group has the word `'global'` for it, and a group of either version
+ * can also have no policy of its own while its checks keep theirs.
+ */
+type AlertPolicyHolder = 'check' | 'group' | 'group-v2';
+/**
+ * The properties this module writes, per construct class: the ones whose
+ * import-format spelling and construct spelling are both literals with the
+ * same shape, and the ones the construct spells with a helper this module
+ * can render (`frequency`, `retryStrategy`, `alertEscalationPolicy`, the
+ * `assertions` of a request), and the SSL request whose wire keys map onto
+ * the construct's (`SSL_REQUEST_RULES`). A rule may likewise map a wire
+ * pointer onto a prop spelled or nested differently in the construct (an
+ * alert channel's `config/<key>` onto its flat prop, a component's
+ * `configuration/<key>`, `coolDownWindowMinutes` onto `coolDownMinutes`),
+ * and a `refusing` rule names the reason for a leaf the construct fixes or
+ * derives. Anything else — references, scripts, a request key the
+ * construct does not take — is left to the user.
+ *
+ * Keyed by the exact class, not by `instanceof`: a class this table does not
+ * name gets nothing rather than a base class's rules, so a construct that
+ * omits one of them (`PlaywrightCheck` takes no `retryStrategy`, as its
+ * codegen's omitted props say) can never be handed it. The spec checks that every
+ * construct class `checkly/constructs` exports is listed here or excluded
+ * on purpose, and that the omitted props are absent.
+ */
+/** A construct class, as a map key. */
+export type ConstructClass = abstract new (...args: any[]) => Construct;
+export declare const RULES_BY_CLASS: ReadonlyMap<ConstructClass, readonly Rule[]>;
+/** The top-level props keys each class's rules write, as the build-time assertion above knows them; the spec holds `RULES_BY_CLASS` to it. */
+export declare const WRITTEN_BY_CLASS: ReadonlyMap<ConstructClass, readonly string[]>;
+/**
+ * Whether the plan holds at least one change the planner would try to
+ * write: a remote change on a construct of a known class, at a path the
+ * class's table covers. Cheap enough to decide whether to offer the
+ * write-back at all, without reading any file.
+ */
+export declare function hasWritableChanges(diff: readonly DiffEntry[], project: Project): boolean;
+export declare function planWriteBack({ diff, project, cwd }: WriteBackOptions): Promise<WriteBackPlan>;
+/**
+ * Writes every planned file through a temporary file in the same directory,
+ * flushed to disk and then renamed over the target, so an interrupted write
+ * leaves the old file or the new one rather than a torn one. The target is
+ * the file itself, not a symlink to it, and it keeps its mode.
+ *
+ * @throws Error naming the files already rewritten when a later one fails.
+ */
+export declare function applyWriteBack(plan: Pick<WriteBackPlan, 'files'>): Promise<void>;
+export {};