@seanmars/tospec 0.23.0 → 0.26.0-beta

package/dist/core/specs-apply.d.ts

@@ -4,20 +4,100 @@ export interface SpecUpdate {
     target: string;
     exists: boolean;
 }
+/**
+ * A merge refused for what the main spec holds, not the delta. Typed so the
+ * caller can point its fix at the main spec: every merge error used to read
+ * "Fix the change delta specs", including a structural fault in the main spec,
+ * where no edit to the delta helps.
+ */
+export declare class MainSpecMergeError extends Error {
+    /** Project-relative POSIX path of the main spec to edit. */
+    readonly specPath: string;
+    constructor(message: string, 
+    /** Project-relative POSIX path of the main spec to edit. */
+    specPath: string);
+}
+/**
+ * A MODIFIED, REMOVED or RENAMED aimed at a capability that has no main spec. Typed so
+ * validate can tell this refusal from the others: it is the one another
+ * in-progress change's archive can resolve, and validate names that change.
+ */
+export declare class MissingTargetSpecError extends Error {
+    constructor(message: string);
+}
+/**
+ * A MODIFIED or RENAMED whose requirement the main spec lacks, with no near
+ * miss to blame. Typed for the reason `MissingTargetSpecError` is: a sister
+ * change may still be adding that requirement, and validate names it.
+ */
+export declare class MissingTargetRequirementError extends Error {
+    /** The requirement name as the delta wrote it. */
+    readonly requirement: string;
+    /** Which entry named it, so validate reads it as the delta touch it is. */
+    readonly operation: 'MODIFIED' | 'RENAMED';
+    constructor(message: string, 
+    /** The requirement name as the delta wrote it. */
+    requirement: string, 
+    /** Which entry named it, so validate reads it as the delta touch it is. */
+    operation: 'MODIFIED' | 'RENAMED');
+}
+/**
+ * A MODIFIED, REMOVED or RENAMED (FROM) name the main spec holds only under
+ * a spelling that differs in case or spacing. Typed so validate can hand the
+ * main spec's exact name on as `suggestedHeader`: reading it back out of the
+ * message would break on any rewording of it.
+ */
+export declare class RequirementNearMissError extends Error {
+    /** The requirement name as the delta wrote it. */
+    readonly requirement: string;
+    /** The main spec's exact name, the one the delta has to use. */
+    readonly existing: string;
+    readonly operation: 'MODIFIED' | 'REMOVED' | 'RENAMED';
+    constructor(message: string, 
+    /** The requirement name as the delta wrote it. */
+    requirement: string, 
+    /** The main spec's exact name, the one the delta has to use. */
+    existing: string, operation: 'MODIFIED' | 'REMOVED' | 'RENAMED');
+}
 export declare function findSpecUpdates(changeDir: string, mainSpecsDir: string): Promise<SpecUpdate[]>;
+/**
+ * The delta files the merge reads, one per capability folder. `show` reads
+ * this list too: with a walk of its own it listed a `SPEC.md` (on a
+ * case-insensitive file system) and a dot folder's spec.md as deltas, which
+ * validate and archive never read.
+ */
+export declare function findDeltaSpecSources(changeSpecsDir: string): Promise<Array<{
+    capability: string;
+    source: string;
+}>>;
 /**
  * A non-fatal merge outcome. Returned rather than printed because `silent` is
  * set exactly when the caller is `--json`, so console-only warnings were
  * dropped for the callers that cannot see the console.
- * tospec/decisions/20260916_153000-spec-merge-notices-are-returned.md
  */
 export interface SpecApplyNotice {
     /** Stable identifier for the `status[]` contract; lower_snake. */
     code: string;
     message: string;
 }
+/**
+ * The capability directory's real name on disk, or `fallback` when absent.
+ * Differs only on a case-insensitive filesystem, where `specs/RegexCap` and
+ * `specs/regexcap` are one directory — this normalises a message, it does not
+ * merge anything.
+ */
+export declare function resolveOnDiskSpecName(targetPath: string, fallback: string): Promise<string>;
 export declare function buildUpdatedSpec(update: SpecUpdate, changeName: string, options?: {
     silent?: boolean;
+    /**
+     * For validate's dry run only. The failures validate's structural pass
+     * reports on its own (the delta contradicting itself, a section that parsed
+     * to nothing, a MODIFIED dropping a scenario, a REMOVED Scenarios entry that
+     * matches nothing) are collected in `structuralFailures` instead of thrown,
+     * so the merge goes on to the preconditions only it checks. Archive never
+     * sets this: the first failure still aborts before anything is written.
+     */
+    deferStructural?: boolean;
 }): Promise<{
     rebuilt: string;
     crlf: boolean;
@@ -29,6 +109,11 @@ export declare function buildUpdatedSpec(update: SpecUpdate, changeName: string,
         removed: number;
         renamed: number;
     };
+    original?: {
+        path: string;
+        content: string;
+    };
+    structuralFailures: string[];
 }>;
 export declare function writeUpdatedSpec(update: SpecUpdate, rebuilt: string, counts: {
     added: number;
@@ -40,6 +125,18 @@ export declare function writeUpdatedSpec(update: SpecUpdate, rebuilt: string, co
     displayPath?: string;
     crlf?: boolean;
 }): Promise<void>;
+/**
+ * Checks a prepared update against the project boundary before anything is
+ * written. A capability directory (or `tospec/specs` itself) linked outside the
+ * project made archive write — and on retire, `fs.rm` — a file the project does
+ * not own.
+ *
+ * A write is allowed and named, since a shared specs directory is a legitimate
+ * setup; a delete is refused, since removing a file outside the project is
+ * never what archiving a change means. Throws so the caller's all-or-nothing
+ * prepare pass aborts with nothing changed.
+ */
+export declare function checkTargetWithinProject(update: SpecUpdate, projectRoot: string, retired: boolean): Promise<SpecApplyNotice | null>;
 /**
  * Delete an emptied capability's `spec.md` and prune the directories that
  * leaves empty. Pruning stops at `specsRoot` (a project with no capabilities

package/dist/core/specs-apply.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"specs-apply.d.ts","sourceRoot":"","sources":["../../src/core/specs-apply.ts"],"names":[],"mappings":"AAAA,oFAAoF;AAoBpF,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,wBAAsB,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CA+CpG;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,kEAAkE;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAkBD,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,UAAU,EAClB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GACjC,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,eAAe,EAAE,CAAC;IAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAC,CAyY1K;AA8BD,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,EAC7E,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CAAO,GACvE,OAAO,CAAC,IAAI,CAAC,CAgBf;AAuBD;;;;;GAKG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,UAAU,EAClB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAO,GACvD,OAAO,CAAC,IAAI,CAAC,CAqBf;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAOtG;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAuBlE"}
+{"version":3,"file":"specs-apply.d.ts","sourceRoot":"","sources":["../../src/core/specs-apply.ts"],"names":[],"mappings":"AAAA,oFAAoF;AAwBpF,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;IAGzC,4DAA4D;IAC5D,QAAQ,CAAC,QAAQ,EAAE,MAAM;IAH3B,YACE,OAAO,EAAE,MAAM;IACf,4DAA4D;IACnD,QAAQ,EAAE,MAAM,EAI1B;CACF;AAED;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,KAAK;IAC/C,YAAY,OAAO,EAAE,MAAM,EAG1B;CACF;AAED;;;;GAIG;AACH,qBAAa,6BAA8B,SAAQ,KAAK;IAGpD,kDAAkD;IAClD,QAAQ,CAAC,WAAW,EAAE,MAAM;IAC5B,2EAA2E;IAC3E,QAAQ,CAAC,SAAS,EAAE,UAAU,GAAG,SAAS;IAL5C,YACE,OAAO,EAAE,MAAM;IACf,kDAAkD;IACzC,WAAW,EAAE,MAAM;IAC5B,2EAA2E;IAClE,SAAS,EAAE,UAAU,GAAG,SAAS,EAI3C;CACF;AAED;;;;;GAKG;AACH,qBAAa,wBAAyB,SAAQ,KAAK;IAG/C,kDAAkD;IAClD,QAAQ,CAAC,WAAW,EAAE,MAAM;IAC5B,gEAAgE;IAChE,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACzB,QAAQ,CAAC,SAAS,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS;IANxD,YACE,OAAO,EAAE,MAAM;IACf,kDAAkD;IACzC,WAAW,EAAE,MAAM;IAC5B,gEAAgE;IACvD,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,EAIvD;CACF;AAED,wBAAsB,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAuBpG;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CACxC,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,KAAK,CAAC;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC,CAmDxD;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,kEAAkE;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,wBAAsB,qBAAqB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAQjG;AAED,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,UAAU,EAClB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE;IACP,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CACtB,GACL,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,eAAe,EAAE,CAAC;IAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAAC,QAAQ,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAAC,kBAAkB,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CA0hBtP;AA6ED,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,EAC7E,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CAAO,GACvE,OAAO,CAAC,IAAI,CAAC,CAgBf;AAkFD;;;;;;;;;;GAUG;AACH,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,UAAU,EAClB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,CAejC;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,UAAU,EAClB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAO,GACvD,OAAO,CAAC,IAAI,CAAC,CAqBf;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAOtG;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CA0BlE"}