@ethlete/cli 3.0.0-next.25 → 3.0.0-next.27

package/src/lib/design/system/part-ready.d.ts

@@ -0,0 +1,90 @@
+import { DesignConfig } from '../paths';
+import { Blocker } from './build-ready-contract';
+import { FileHashes } from './design-hash';
+import { EmbeddedHashes } from './embedded-actions';
+import { OpenPoint } from './open-points';
+import { ResolvedProduct } from './resolve-product';
+export declare const READY_FILE = "ready.json";
+/**
+ * The check record of a build-ready part: the design hash it was checked at, with the hash of each file it covers; it
+ * holds only while the hash does. `embedded` holds the app hash of each embedded part its actions ran against. `by`
+ * appears only in records written before the record became tool-written.
+ */
+export type PartReady = {
+    hash: string;
+    files?: FileHashes;
+    embedded?: EmbeddedHashes;
+    actions?: string[];
+    at: string;
+    by?: string;
+};
+export type ReadyRefusal = {
+    status: number;
+    error: string;
+    points?: OpenPoint[];
+    actions?: string[];
+    blockers?: Blocker[];
+};
+export declare const readReady: (dir: string) => Record<string, PartReady>;
+/** The design hash of a part and the directory whose ready.json holds it, or why the product has no such part. */
+export declare const readyPartOf: (options: {
+    product: ResolvedProduct;
+    part: string;
+}) => string | {
+    dir: string;
+    hash: string;
+    design: import("./design-hash").DesignHash;
+    resolved: import("./resolve-product").ResolvedPart;
+};
+/** The ready mark of a part while its hash still matches, `null` when it has none or the part changed since. */
+export declare const readyMarkOf: (options: {
+    product: ResolvedProduct;
+    part: string;
+}) => PartReady | null;
+/**
+ * The embedded parts whose app files changed since the actions of `part` ran for its ready mark, `[]` while the mark
+ * does not hold or predates the embedded record.
+ */
+export declare const actionsRerunOf: (options: {
+    product: ResolvedProduct;
+    part: string;
+}) => string[];
+/** Draws a part and answers its whole open-point list, or why it could not be drawn. */
+export declare const drawnPartPointsOf: (options: {
+    target: string;
+    config: DesignConfig;
+    product: ResolvedProduct;
+    part: string;
+}) => Promise<OpenPoint[] | {
+    unavailable: string;
+}>;
+/** The parts of a product whose ready mark still holds. */
+export declare const readyPartsOf: (product: ResolvedProduct) => string[];
+/** Writes the check record of a part at its current design hash; a record already at that hash keeps its `at`. */
+export declare const writePartRecord: (options: {
+    product: ResolvedProduct;
+    part: string;
+    at?: string;
+}) => PartReady | null;
+/** Drops the check record of a part, whatever hash it holds; true when there was one. */
+export declare const dropPartRecord: (options: {
+    product: ResolvedProduct;
+    part: string;
+}) => boolean;
+/**
+ * Checks a part at `hash` and writes its check record, or answers why not: 400 without `hash`, 404 for an unknown
+ * part, 409 when the part changed since `hash`, 422 while `pointsOf` lists any open point, `blockersOf` any other
+ * blocker or `actionsOf` any failed action check. The failed-actions refusal names the embedded parts whose app files
+ * changed since the last record. `pointsOf` runs only after the hash holds, `blockersOf` only after the open-point list
+ * is empty, `actionsOf` only after the blocker list is.
+ */
+export declare const markPartReady: (options: {
+    product: ResolvedProduct;
+    part: string;
+    hash: unknown;
+    pointsOf: () => Promise<OpenPoint[] | ReadyRefusal>;
+    blockersOf?: () => Promise<Blocker[]>;
+    actionsOf: () => Promise<string[] | ReadyRefusal>;
+    actionsNote?: string;
+    at?: string;
+}) => Promise<PartReady | ReadyRefusal>;

package/src/lib/design/system/part-ready.js

@@ -0,0 +1,172 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.markPartReady = exports.dropPartRecord = exports.writePartRecord = exports.readyPartsOf = exports.drawnPartPointsOf = exports.actionsRerunOf = exports.readyMarkOf = exports.readyPartOf = exports.readReady = exports.READY_FILE = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const json_file_1 = require("../../json-file");
+const design_hash_1 = require("./design-hash");
+const drawn_open_points_1 = require("./drawn-open-points");
+const embedded_actions_1 = require("./embedded-actions");
+const inventory_approval_1 = require("./inventory-approval");
+const read_open_points_1 = require("./read-open-points");
+const resolve_product_1 = require("./resolve-product");
+exports.READY_FILE = 'ready.json';
+const readyFileOf = (dir) => (0, path_1.resolve)(dir, exports.READY_FILE);
+const isReady = (value) => {
+    if (!value || typeof value !== 'object' || Array.isArray(value))
+        return false;
+    const { hash, by, at, files, embedded, actions } = value;
+    return (typeof hash === 'string' &&
+        (by === undefined || typeof by === 'string') &&
+        typeof at === 'string' &&
+        (0, design_hash_1.isOptionalFileHashes)(files) &&
+        (0, design_hash_1.isOptionalFileHashes)(embedded) &&
+        (actions === undefined || (Array.isArray(actions) && actions.every((key) => typeof key === 'string'))));
+};
+const readReady = (dir) => {
+    const file = readyFileOf(dir);
+    if (!(0, fs_1.existsSync)(file))
+        return {};
+    try {
+        const parsed = JSON.parse((0, fs_1.readFileSync)(file, 'utf8'));
+        return parsed && typeof parsed === 'object' && !Array.isArray(parsed)
+            ? Object.fromEntries(Object.entries(parsed).filter((entry) => isReady(entry[1])))
+            : {};
+    }
+    catch (_a) {
+        return {};
+    }
+};
+exports.readReady = readReady;
+/** The design hash of a part and the directory whose ready.json holds it, or why the product has no such part. */
+const readyPartOf = (options) => {
+    const resolved = options.product.parts.find((candidate) => (0, resolve_product_1.partKeyOf)(candidate) === options.part);
+    if (!resolved)
+        return `product "${options.product.name}" has no part "${options.part}"`;
+    const owner = (0, inventory_approval_1.partOwnerOf)({ product: options.product, part: resolved });
+    const design = (0, design_hash_1.designHashOf)({ product: options.product, part: resolved });
+    return { dir: owner.dir, hash: design.hash, design, resolved };
+};
+exports.readyPartOf = readyPartOf;
+/** The ready mark of a part while its hash still matches, `null` when it has none or the part changed since. */
+const readyMarkOf = (options) => {
+    const found = (0, exports.readyPartOf)(options);
+    if (typeof found === 'string')
+        return null;
+    const mark = (0, exports.readReady)(found.dir)[options.part];
+    return mark && (0, design_hash_1.recordHolds)(mark, found.design) ? mark : null;
+};
+exports.readyMarkOf = readyMarkOf;
+/**
+ * The embedded parts whose app files changed since the actions of `part` ran for its ready mark, `[]` while the mark
+ * does not hold or predates the embedded record.
+ */
+const actionsRerunOf = (options) => {
+    const found = (0, exports.readyPartOf)(options);
+    if (typeof found === 'string')
+        return [];
+    const mark = (0, exports.readReady)(found.dir)[options.part];
+    if (!(mark === null || mark === void 0 ? void 0 : mark.embedded) || !(0, design_hash_1.recordHolds)(mark, found.design))
+        return [];
+    return (0, embedded_actions_1.changedEmbeddedOf)(mark.embedded, (0, embedded_actions_1.embeddedHashesOf)({ product: options.product, part: found.resolved }));
+};
+exports.actionsRerunOf = actionsRerunOf;
+/** Draws a part and answers its whole open-point list, or why it could not be drawn. */
+const drawnPartPointsOf = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    const findings = yield (0, drawn_open_points_1.drawnFindingsOf)(Object.assign(Object.assign({}, options), { parts: [options.part] }));
+    return 'unavailable' in findings ? findings : (0, read_open_points_1.partPointsOf)((0, read_open_points_1.readOpenPoints)(options.product, findings), options.part);
+});
+exports.drawnPartPointsOf = drawnPartPointsOf;
+/** The parts of a product whose ready mark still holds. */
+const readyPartsOf = (product) => product.parts.map(resolve_product_1.partKeyOf).filter((part) => (0, exports.readyMarkOf)({ product, part }) !== null);
+exports.readyPartsOf = readyPartsOf;
+const writeReady = (dir, records) => (0, json_file_1.writeJsonFile)({
+    file: readyFileOf(dir),
+    value: Object.fromEntries(Object.entries(records).sort(([a], [b]) => a.localeCompare(b))),
+});
+/** Writes the check record of a part at its current design hash; a record already at that hash keeps its `at`. */
+const writePartRecord = (options) => {
+    var _a, _b;
+    const found = (0, exports.readyPartOf)(options);
+    if (typeof found === 'string')
+        return null;
+    const existing = (0, exports.readReady)(found.dir);
+    const previous = existing[options.part];
+    const embedded = (0, embedded_actions_1.embeddedHashesOf)({ product: options.product, part: found.resolved });
+    const record = Object.assign(Object.assign(Object.assign({ hash: found.hash, files: found.design.files }, (Object.keys(embedded).length > 0 ? { embedded } : {})), ((previous === null || previous === void 0 ? void 0 : previous.actions) ? { actions: previous.actions } : {})), { at: (_b = (_a = ((previous === null || previous === void 0 ? void 0 : previous.hash) === found.hash ? previous.at : undefined)) !== null && _a !== void 0 ? _a : options.at) !== null && _b !== void 0 ? _b : new Date().toISOString() });
+    writeReady(found.dir, Object.assign(Object.assign({}, existing), { [options.part]: record }));
+    return record;
+};
+exports.writePartRecord = writePartRecord;
+/** Drops the check record of a part, whatever hash it holds; true when there was one. */
+const dropPartRecord = (options) => {
+    const found = (0, exports.readyPartOf)(options);
+    if (typeof found === 'string')
+        return false;
+    const existing = (0, exports.readReady)(found.dir);
+    if (!(options.part in existing))
+        return false;
+    writeReady(found.dir, Object.fromEntries(Object.entries(existing).filter(([key]) => key !== options.part)));
+    return true;
+};
+exports.dropPartRecord = dropPartRecord;
+/**
+ * Checks a part at `hash` and writes its check record, or answers why not: 400 without `hash`, 404 for an unknown
+ * part, 409 when the part changed since `hash`, 422 while `pointsOf` lists any open point, `blockersOf` any other
+ * blocker or `actionsOf` any failed action check. The failed-actions refusal names the embedded parts whose app files
+ * changed since the last record. `pointsOf` runs only after the hash holds, `blockersOf` only after the open-point list
+ * is empty, `actionsOf` only after the blocker list is.
+ */
+const markPartReady = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c;
+    const { product, part, hash } = options;
+    if (typeof hash !== 'string' || hash === '')
+        return { status: 400, error: 'hash is required' };
+    const found = (0, exports.readyPartOf)({ product, part });
+    if (typeof found === 'string')
+        return { status: 404, error: found };
+    if (hash !== found.hash)
+        return { status: 409, error: `${part} changed since its open points were shown - reload and check it again` };
+    const points = yield options.pointsOf();
+    if (!Array.isArray(points))
+        return points;
+    if (points.length > 0)
+        return {
+            status: 422,
+            error: `${part} has ${points.length} open point${points.length === 1 ? '' : 's'} - close them before ready`,
+            points,
+        };
+    const blockers = (_b = (yield ((_a = options.blockersOf) === null || _a === void 0 ? void 0 : _a.call(options)))) !== null && _b !== void 0 ? _b : [];
+    if (blockers.length > 0)
+        return {
+            status: 422,
+            error: `${part} has ${blockers.length} blocker${blockers.length === 1 ? '' : 's'} - fix them before ready`,
+            blockers,
+        };
+    const rerun = (0, exports.actionsRerunOf)({ product, part });
+    const actions = yield options.actionsOf();
+    const notes = [
+        ...(rerun.length > 0 ? [(0, embedded_actions_1.actionsRerunReasonOf)(rerun)] : []),
+        ...(options.actionsNote ? [options.actionsNote] : []),
+    ];
+    if (!Array.isArray(actions))
+        return actions;
+    if (actions.length > 0)
+        return {
+            status: 422,
+            error: `${part} fails ${actions.length} action check${actions.length === 1 ? '' : 's'} - fix them before ready${notes.length > 0 ? ` (${notes.join('; ')})` : ''}`,
+            actions,
+        };
+    return (_c = (0, exports.writePartRecord)({ product, part, at: options.at })) !== null && _c !== void 0 ? _c : { status: 404, error: `unknown part ${part}` };
+});
+exports.markPartReady = markPartReady;
+//# sourceMappingURL=part-ready.js.map

package/src/lib/design/system/part-ready.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"part-ready.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/design/system/part-ready.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2BAA8C;AAC9C,+BAA+B;AAC/B,+CAAgD;AAGhD,+CAA4F;AAC5F,2DAAsD;AACtD,yDAA+G;AAC/G,6DAAmD;AAEnD,yDAAkE;AAClE,uDAA+D;AAElD,QAAA,UAAU,GAAG,YAAY,CAAC;AAwBvC,MAAM,WAAW,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,IAAA,cAAO,EAAC,GAAG,EAAE,kBAAU,CAAC,CAAC;AAE9D,MAAM,OAAO,GAAG,CAAC,KAAc,EAAsB,EAAE;IACrD,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAE9E,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,KAAgC,CAAC;IAEpF,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,CAAC,EAAE,KAAK,SAAS,IAAI,OAAO,EAAE,KAAK,QAAQ,CAAC;QAC5C,OAAO,EAAE,KAAK,QAAQ;QACtB,IAAA,kCAAoB,EAAC,KAAK,CAAC;QAC3B,IAAA,kCAAoB,EAAC,QAAQ,CAAC;QAC9B,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,CACvG,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,SAAS,GAAG,CAAC,GAAW,EAA6B,EAAE;IAClE,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IAE9B,IAAI,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC;IAEjC,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QAE/D,OAAO,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YACnE,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAgC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/G,CAAC,CAAC,EAAE,CAAC;IACT,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC,CAAC;AAdW,QAAA,SAAS,aAcpB;AAEF,kHAAkH;AAC3G,MAAM,WAAW,GAAG,CAAC,OAAmD,EAAE,EAAE;IACjF,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,2BAAS,EAAC,SAAS,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAElG,IAAI,CAAC,QAAQ;QAAE,OAAO,YAAY,OAAO,CAAC,OAAO,CAAC,IAAI,kBAAkB,OAAO,CAAC,IAAI,GAAG,CAAC;IAExF,MAAM,KAAK,GAAG,IAAA,gCAAW,EAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;IAExE,MAAM,MAAM,GAAG,IAAA,0BAAY,EAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;IAE1E,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AACjE,CAAC,CAAC;AAVW,QAAA,WAAW,eAUtB;AAEF,gHAAgH;AACzG,MAAM,WAAW,GAAG,CAAC,OAAmD,EAAoB,EAAE;IACnG,MAAM,KAAK,GAAG,IAAA,mBAAW,EAAC,OAAO,CAAC,CAAC;IAEnC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAE3C,MAAM,IAAI,GAAG,IAAA,iBAAS,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD,OAAO,IAAI,IAAI,IAAA,yBAAW,EAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/D,CAAC,CAAC;AARW,QAAA,WAAW,eAQtB;AAEF;;;GAGG;AACI,MAAM,cAAc,GAAG,CAAC,OAAmD,EAAY,EAAE;IAC9F,MAAM,KAAK,GAAG,IAAA,mBAAW,EAAC,OAAO,CAAC,CAAC;IAEnC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IAEzC,MAAM,IAAI,GAAG,IAAA,iBAAS,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD,IAAI,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAA,IAAI,CAAC,IAAA,yBAAW,EAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,CAAC;IAEnE,OAAO,IAAA,oCAAiB,EAAC,IAAI,CAAC,QAAQ,EAAE,IAAA,mCAAgB,EAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;AAChH,CAAC,CAAC;AAVW,QAAA,cAAc,kBAUzB;AAEF,wFAAwF;AACjF,MAAM,iBAAiB,GAAG,CAAO,OAKvC,EAAkD,EAAE;IACnD,MAAM,QAAQ,GAAG,MAAM,IAAA,mCAAe,kCAAM,OAAO,KAAE,KAAK,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAG,CAAC;IAE9E,OAAO,aAAa,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAA,+BAAY,EAAC,IAAA,iCAAc,EAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AACtH,CAAC,CAAA,CAAC;AATW,QAAA,iBAAiB,qBAS5B;AAEF,2DAA2D;AACpD,MAAM,YAAY,GAAG,CAAC,OAAwB,EAAE,EAAE,CACvD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,2BAAS,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAW,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC;AAD5E,QAAA,YAAY,gBACgE;AAEzF,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,OAAkC,EAAE,EAAE,CACrE,IAAA,yBAAa,EAAC;IACZ,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CAC1F,CAAC,CAAC;AAEL,kHAAkH;AAC3G,MAAM,eAAe,GAAG,CAAC,OAAgE,EAAoB,EAAE;;IACpH,MAAM,KAAK,GAAG,IAAA,mBAAW,EAAC,OAAO,CAAC,CAAC;IAEnC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAE3C,MAAM,QAAQ,GAAG,IAAA,iBAAS,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,QAAQ,GAAG,IAAA,mCAAgB,EAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IACtF,MAAM,MAAM,+CACV,IAAI,EAAE,KAAK,CAAC,IAAI,EAChB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,IACtB,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GACtD,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,EAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KAC3D,EAAE,EAAE,MAAA,MAAA,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,MAAK,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,mCAAI,OAAO,CAAC,EAAE,mCAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,GACxG,CAAC;IAEF,UAAU,CAAC,KAAK,CAAC,GAAG,kCAAO,QAAQ,KAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,IAAG,CAAC;IAE/D,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAnBW,QAAA,eAAe,mBAmB1B;AAEF,yFAAyF;AAClF,MAAM,cAAc,GAAG,CAAC,OAAmD,EAAE,EAAE;IACpF,MAAM,KAAK,GAAG,IAAA,mBAAW,EAAC,OAAO,CAAC,CAAC;IAEnC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE5C,MAAM,QAAQ,GAAG,IAAA,iBAAS,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEtC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,IAAI,QAAQ,CAAC;QAAE,OAAO,KAAK,CAAC;IAE9C,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAE5G,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAZW,QAAA,cAAc,kBAYzB;AAEF;;;;;;GAMG;AACI,MAAM,aAAa,GAAG,CAAO,OASnC,EAAqC,EAAE;;IACtC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAExC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;IAE/F,MAAM,KAAK,GAAG,IAAA,mBAAW,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAE7C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IACpE,IAAI,IAAI,KAAK,KAAK,CAAC,IAAI;QACrB,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,IAAI,uEAAuE,EAAE,CAAC;IAEhH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC;IAExC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,OAAO,MAAM,CAAC;IAC1C,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QACnB,OAAO;YACL,MAAM,EAAE,GAAG;YACX,KAAK,EAAE,GAAG,IAAI,QAAQ,MAAM,CAAC,MAAM,cAAc,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,4BAA4B;YAC3G,MAAM;SACP,CAAC;IAEJ,MAAM,QAAQ,GAAG,MAAA,CAAC,MAAM,CAAA,MAAA,OAAO,CAAC,UAAU,uDAAI,CAAA,CAAC,mCAAI,EAAE,CAAC;IAEtD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QACrB,OAAO;YACL,MAAM,EAAE,GAAG;YACX,KAAK,EAAE,GAAG,IAAI,QAAQ,QAAQ,CAAC,MAAM,WAAW,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,0BAA0B;YAC1G,QAAQ;SACT,CAAC;IAEJ,MAAM,KAAK,GAAG,IAAA,sBAAc,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAChD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;IAC1C,MAAM,KAAK,GAAG;QACZ,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,uCAAoB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1D,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KACtD,CAAC;IAEF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IAC5C,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QACpB,OAAO;YACL,MAAM,EAAE,GAAG;YACX,KAAK,EAAE,GAAG,IAAI,UAAU,OAAO,CAAC,MAAM,gBAAgB,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,2BAA2B,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAClK,OAAO;SACR,CAAC;IAEJ,OAAO,MAAA,IAAA,uBAAe,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,mCAAI,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,gBAAgB,IAAI,EAAE,EAAE,CAAC;AAC9G,CAAC,CAAA,CAAC;AAvDW,QAAA,aAAa,iBAuDxB"}

package/src/lib/design/system/part-task.d.ts

@@ -0,0 +1,147 @@
+import { FileHashes } from './design-hash';
+import { BuildReadyInputs } from './part-build-ready';
+import { ResolvedProduct } from './resolve-product';
+export declare const IMPLEMENTED_FILE = "implemented.json";
+/**
+ * The design hash a part was last implemented at, when, the props hash of each state it had then, and the hash of
+ * each repository file its app component reached.
+ */
+export type PartImplemented = {
+    hash: string;
+    at: string;
+    states: Record<string, string>;
+    app?: FileHashes;
+};
+/** A part a task can build: its design hash, the component path its `implements` names, and the directory of its records. */
+export type TaskPart = {
+    part: string;
+    hash: string;
+    dir: string;
+    component: string;
+};
+/** The states a task names: added since the implemented record, with changed props, or all when only the rest changed. */
+export type TaskStates = {
+    added: string[];
+    changed: string[];
+    all: boolean;
+};
+/** The hash of a state's props as JSON with sorted keys, so reordering keys is no change. */
+export declare const stateHashOf: (props: unknown) => string;
+export declare const readImplemented: (dir: string) => Record<string, PartImplemented>;
+/**
+ * Records a part as implemented at its current hash with the props hash of each of its `states` and the `app` file
+ * hashes, or says why not.
+ */
+export declare const markImplemented: (options: {
+    product: ResolvedProduct;
+    part: string;
+    states: Record<string, unknown>;
+    app?: FileHashes;
+    at?: string;
+}) => PartImplemented | string;
+/** The part an `implements` link names at its current design hash, or why a task cannot build it: unknown part, no or a route-only link. */
+export declare const linkedTaskPartOf: (options: {
+    product: ResolvedProduct;
+    part: string;
+}) => TaskPart | string;
+/** The part a task builds, or why not: what `linkedTaskPartOf` refuses, or each blocker while the part is not build-ready. */
+export declare const taskPartOf: (options: {
+    product: ResolvedProduct;
+    part: string;
+    inputs: BuildReadyInputs;
+}) => TaskPart | string;
+/** The part `task --verify` checks, or why not: what `linkedTaskPartOf` refuses, or a check record that does not hold. */
+export declare const verifiedTaskPartOf: (options: {
+    product: ResolvedProduct;
+    part: string;
+}) => TaskPart | string;
+/** The states added or changed since the implemented record; without a record every state is added. */
+export declare const taskStatesOf: (options: {
+    states: Record<string, unknown>;
+    hash: string;
+    record: PartImplemented | undefined;
+}) => TaskStates;
+/**
+ * The repo paths a task may change: the component folder, a changeset, the harness map, the app files the harness
+ * shares with the design, and for `sdk` a docs guide.
+ */
+export declare const allowedFilesOf: (options: {
+    product: string;
+    component: string;
+    harnessMap: string | null;
+    shared?: string[];
+}) => string[];
+/** The files of a diff outside the allowed patterns of `allowedFilesOf`. */
+export declare const filesOutsideOf: (options: {
+    files: string[];
+    allowed: string[];
+}) => string[];
+/**
+ * The files of a diff that import the part - a relative import of its component file, folder or a sibling in it - and
+ * the spec next to each importer.
+ */
+export declare const importersOf: (options: {
+    files: string[];
+    component: string;
+    read: (file: string) => string | null;
+}) => string[];
+/** The files of a diff under the design folder, which never count as implementation. */
+export declare const designFilesOf: (files: string[]) => string[];
+/**
+ * The app files that wire the part in: each non-spec file under the app's `src` folder that imports the part's component
+ * folder, directly or through other such files, the part's own spec, and the non-spec app files its direct importers
+ * import.
+ */
+export declare const wiringFilesOf: (options: {
+    files: string[];
+    component: string;
+    read: (file: string) => string | null;
+}) => string[];
+/** The files git tracks under a folder at a revision. */
+export declare const gitTreeFilesOf: (options: {
+    root: string;
+    rev: string;
+    dir: string;
+}) => string[];
+/** The content of a file at the end of a git range, or null when it is gone. */
+export declare const gitFileAtOf: (options: {
+    root: string;
+    range: string;
+    file: string;
+}) => string | null;
+/** Whether a `git diff -U0` patch adds or removes only Tailwind `@source` lines. */
+export declare const changesOnlySourceLines: (patch: string) => boolean;
+/** The `git diff -U0` patch of one file in a range. */
+export declare const gitDiffPatchOf: (options: {
+    root: string;
+    range: string;
+    file: string;
+}) => string;
+/** The git range `--verify` checks: a range as given, a single commit `x` as `x^..x`. */
+export declare const verifyRangeOf: (rev: string) => string;
+/** The files `git diff --name-only` names for a range, from the repository root. */
+export declare const gitDiffFilesOf: (options: {
+    root: string;
+    range: string;
+}) => string[];
+/**
+ * Each theming attribute a part's source uses, mapped to the `@ethlete/core` API the implementation puts there: the
+ * surface directives, and per semantic colour type `[etProvideColor]` bound to `injectSemanticColorTheme(<type>)`.
+ */
+export declare const themingDirectivesOf: (source: string) => string[];
+/** The component an `implements` link names for compare, or `null` for none, an unreadable or a route-only link. */
+export declare const linkedComponentOf: (source: string) => string | null;
+/** The repository files of a part's app component that changed since its implemented record, `[]` without app hashes. */
+export declare const changedAppFilesOf: (options: {
+    product: ResolvedProduct;
+    part: string;
+    record: PartImplemented;
+}) => string[];
+/**
+ * The parts of a product whose implemented record is at the hash of their holding check record, and whose app files did
+ * not change since.
+ */
+export declare const doneParts: (options: {
+    product: ResolvedProduct;
+    parts: string[];
+}) => string[];