@wildo-ai/saas-technical-doc 1.1.4 → 1.1.5

package/dist/esm/companion/application-documentation/technical-documentation-engine-content-bundle.d.ts

@@ -78,20 +78,34 @@ export declare const APPLICATION_DOMAIN_RESOURCE_PAGE_UNIT_REF_PREFIX = "technic
  * silent gap, because a kind nobody authors looks exactly like a kind nobody needed (#474). RUNBOOK
  * now has one. CHANGE does not, and the reason is structural rather than editorial:
  *
- * A CHANGE unit is a record of what changed in ONE application, so only that application could
- * author it — and an application-authored unit cannot be routed. `pathForUnit` admits engine-
- * namespaced slugs and the reserved `unit/manages/` namespace, and refuses everything else with
- * "has no consumer navigation category". Application material reaches the site only as an ENGINE
- * unit carrying application-projected facts, never as an application-authored page. So the engine
- * cannot write a changelog it has no knowledge of, and the party that could has no door.
+ * A CHANGE unit is a record of what changed in ONE application, so only that application can
+ * author it. Until #874 that party had no door: an application-authored unit could not be routed.
+ * It now can — a chapter the application's documentation plan declares, authored in its
+ * specifications package and routed under `guides/` (`application-documentation-chapters.ts`) —
+ * so a CHANGE page has a producer, and it is the application.
  *
- * The member is therefore kept rather than retired: what is missing is a route for
- * application-authored units, not the concept. When that route exists, this entry is removed in the
- * same change — and `technical-documentation-engine-content-bundle.test.ts` fails until it is,
- * because the partition below is asserted total over the enum.
+ * The entry STAYS in this map, because this map describes the ENGINE catalogue and the partition
+ * test below is total over it: the engine still authors no CHANGE unit, and must not — it has no
+ * knowledge of what any one application changed. The reason text is what moved, from "no door" to
+ * "the door belongs to the application".
  */
 export declare const ENGINE_CONTENT_UNIT_KINDS_WITHOUT_PRODUCER: Readonly<Partial<Record<TechnicalDocumentationUnitKind, string>>>;
 export declare const ENGINE_CONTENT_UNIT_DEFINITIONS: Readonly<Record<string, EngineContentUnitDefinition>>;
+/**
+ * The one Markdown-to-unit parser, shared by every tier that turns authored prose into a unit: the
+ * engine's own pages, and the chapters an application authors (#874). One parser means one rule for
+ * what a title, a summary and a section ARE — a second copy would let an application's guide and an
+ * engine page split the same text differently, and the difference would surface as a portal whose
+ * two halves summarize themselves by two conventions.
+ */
+export declare function parseTechnicalDocumentationUnitMarkdown(markdown: string, unitRef: string): {
+    readonly title: string;
+    readonly summary: string;
+    readonly sections: readonly {
+        readonly heading: string;
+        readonly bodyMarkdown: string;
+    }[];
+};
 /**
  * The facts only the application knows, which the companion measures and passes in.
  *

package/dist/esm/companion/application-documentation/technical-documentation-engine-content-bundle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"technical-documentation-engine-content-bundle.d.ts","sourceRoot":"","sources":["../../../../src/companion/application-documentation/technical-documentation-engine-content-bundle.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,sCAAsC,EAC5C,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAGL,KAAK,0CAA0C,EAChD,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAGL,KAAK,uCAAuC,EAC7C,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAGL,KAAK,kCAAkC,EACxC,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAGL,KAAK,0CAA0C,EAChD,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAEL,iCAAiC,EAKjC,qCAAqC,EAGrC,oCAAoC,EAEpC,KAAK,oCAAoC,EAEzC,8BAA8B,EAE9B,KAAK,gDAAgD,EACrD,KAAK,0CAA0C,EAG/C,KAAK,4BAA4B,EAClC,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EAGL,KAAK,yCAAyC,EAC/C,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,EAAE,qDAAqD,EAAE,MAAM,8DAA8D,CAAC;AAC1I,OAAO,EACL,qEAAqE,EAGtE,MAAM,2EAA2E,CAAC;AAKnF,OAAO,EAEL,KAAK,qDAAqD,EAC3D,MAAM,wDAAwD,CAAC;AAEhE,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,IAAI,EAAE,8BAA8B,CAAC;IAC9C,QAAQ,CAAC,eAAe,EAAE,SAAS,oCAAoC,EAAE,CAAC;IAC1E,QAAQ,CAAC,WAAW,EAAE,iCAAiC,CAAC;IACxD,QAAQ,CAAC,yBAAyB,EAAE,SAAS,gDAAgD,EAAE,CAAC;IAChG,QAAQ,CAAC,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5C,QAAQ,CAAC,mBAAmB,CAAC,EAAE,SAAS;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,EAAE,0CAA0C,CAAA;KAAE,EAAE,CAAC;IAClI;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,qCAAqC,CAAC;IACjE;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,SAAS,oCAAoC,EAAE,CAAC;CAC1E;AAiED,sFAAsF;AACtF,MAAM,WAAW,6CAA6C;IAC5D,QAAQ,CAAC,SAAS,EAAE,GAAG,OAAO,qEAAqE,GAAG,MAAM,EAAE,CAAC;IAC/G,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CAChC;AAgFD;;;;;;;GAOG;AACH;;;;;;GAMG;AACH,wBAAgB,oCAAoC,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAEvF;AAED,qFAAqF;AACrF,eAAO,MAAM,gDAAgD,0CAA0C,CAAC;AAoCxG;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,0CAA0C,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC,CAIxH,CAAC;AAEF,eAAO,MAAM,+BAA+B,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAi2ChG,CAAC;AAyXH;;;;;GAKG;AACH,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,6CAA6C,CAAC;IAC3E,QAAQ,CAAC,yBAAyB,CAAC,EAAE,qDAAqD,CAAC;IAC3F,QAAQ,CAAC,UAAU,CAAC,EAAE,sCAAsC,CAAC;IAC7D,QAAQ,CAAC,cAAc,CAAC,EAAE,0CAA0C,CAAC;IACrE,QAAQ,CAAC,cAAc,CAAC,EAAE,0CAA0C,CAAC;IACrE,QAAQ,CAAC,WAAW,CAAC,EAAE,uCAAuC,CAAC;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,kCAAkC,CAAC;CACtD;AAED;;;GAGG;AACH,wBAAgB,6CAA6C,CAC3D,MAAM,EAAE,qDAAqD,EAC7D,0BAA0B,EAAE,yCAAyC,EACrE,eAAe,GAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAmC,EACxG,gBAAgB,GAAE,6BAAkC,GACnD,4BAA4B,EAAE,CA+LhC"}
+{"version":3,"file":"technical-documentation-engine-content-bundle.d.ts","sourceRoot":"","sources":["../../../../../src/companion/application-documentation/technical-documentation-engine-content-bundle.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,sCAAsC,EAC5C,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAGL,KAAK,0CAA0C,EAChD,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAGL,KAAK,uCAAuC,EAC7C,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAGL,KAAK,kCAAkC,EACxC,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAGL,KAAK,0CAA0C,EAChD,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAEL,iCAAiC,EAKjC,qCAAqC,EAGrC,oCAAoC,EAEpC,KAAK,oCAAoC,EAEzC,8BAA8B,EAE9B,KAAK,gDAAgD,EACrD,KAAK,0CAA0C,EAG/C,KAAK,4BAA4B,EAClC,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EAGL,KAAK,yCAAyC,EAC/C,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,EAAE,qDAAqD,EAAE,MAAM,8DAA8D,CAAC;AAC1I,OAAO,EACL,qEAAqE,EAGtE,MAAM,2EAA2E,CAAC;AAKnF,OAAO,EAEL,KAAK,qDAAqD,EAC3D,MAAM,wDAAwD,CAAC;AAEhE,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,IAAI,EAAE,8BAA8B,CAAC;IAC9C,QAAQ,CAAC,eAAe,EAAE,SAAS,oCAAoC,EAAE,CAAC;IAC1E,QAAQ,CAAC,WAAW,EAAE,iCAAiC,CAAC;IACxD,QAAQ,CAAC,yBAAyB,EAAE,SAAS,gDAAgD,EAAE,CAAC;IAChG,QAAQ,CAAC,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5C,QAAQ,CAAC,mBAAmB,CAAC,EAAE,SAAS;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,EAAE,0CAA0C,CAAA;KAAE,EAAE,CAAC;IAClI;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,qCAAqC,CAAC;IACjE;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,SAAS,oCAAoC,EAAE,CAAC;CAC1E;AAiED,sFAAsF;AACtF,MAAM,WAAW,6CAA6C;IAC5D,QAAQ,CAAC,SAAS,EAAE,GAAG,OAAO,qEAAqE,GAAG,MAAM,EAAE,CAAC;IAC/G,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CAChC;AAgFD;;;;;;;GAOG;AACH;;;;;;GAMG;AACH,wBAAgB,oCAAoC,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAEvF;AAED,qFAAqF;AACrF,eAAO,MAAM,gDAAgD,0CAA0C,CAAC;AAoCxG;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,0CAA0C,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC,CAIxH,CAAC;AAEF,eAAO,MAAM,+BAA+B,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAi2ChG,CAAC;AAOH;;;;;;GAMG;AACH,wBAAgB,uCAAuC,CACrD,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GACd;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,CAEjJ;AAoXD;;;;;GAKG;AACH,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,6CAA6C,CAAC;IAC3E,QAAQ,CAAC,yBAAyB,CAAC,EAAE,qDAAqD,CAAC;IAC3F,QAAQ,CAAC,UAAU,CAAC,EAAE,sCAAsC,CAAC;IAC7D,QAAQ,CAAC,cAAc,CAAC,EAAE,0CAA0C,CAAC;IACrE,QAAQ,CAAC,cAAc,CAAC,EAAE,0CAA0C,CAAC;IACrE,QAAQ,CAAC,WAAW,CAAC,EAAE,uCAAuC,CAAC;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,kCAAkC,CAAC;CACtD;AAED;;;GAGG;AACH,wBAAgB,6CAA6C,CAC3D,MAAM,EAAE,qDAAqD,EAC7D,0BAA0B,EAAE,yCAAyC,EACrE,eAAe,GAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAmC,EACxG,gBAAgB,GAAE,6BAAkC,GACnD,4BAA4B,EAAE,CAgMhC"}

package/dist/esm/companion/application-documentation/technical-documentation-engine-content-bundle.js

@@ -174,21 +174,20 @@ const GENERATED_RESOURCE_UNIT_DEFINITION = Object.freeze({
  * silent gap, because a kind nobody authors looks exactly like a kind nobody needed (#474). RUNBOOK
  * now has one. CHANGE does not, and the reason is structural rather than editorial:
  *
- * A CHANGE unit is a record of what changed in ONE application, so only that application could
- * author it — and an application-authored unit cannot be routed. `pathForUnit` admits engine-
- * namespaced slugs and the reserved `unit/manages/` namespace, and refuses everything else with
- * "has no consumer navigation category". Application material reaches the site only as an ENGINE
- * unit carrying application-projected facts, never as an application-authored page. So the engine
- * cannot write a changelog it has no knowledge of, and the party that could has no door.
+ * A CHANGE unit is a record of what changed in ONE application, so only that application can
+ * author it. Until #874 that party had no door: an application-authored unit could not be routed.
+ * It now can — a chapter the application's documentation plan declares, authored in its
+ * specifications package and routed under `guides/` (`application-documentation-chapters.ts`) —
+ * so a CHANGE page has a producer, and it is the application.
  *
- * The member is therefore kept rather than retired: what is missing is a route for
- * application-authored units, not the concept. When that route exists, this entry is removed in the
- * same change — and `technical-documentation-engine-content-bundle.test.ts` fails until it is,
- * because the partition below is asserted total over the enum.
+ * The entry STAYS in this map, because this map describes the ENGINE catalogue and the partition
+ * test below is total over it: the engine still authors no CHANGE unit, and must not — it has no
+ * knowledge of what any one application changed. The reason text is what moved, from "no door" to
+ * "the door belongs to the application".
  */
 export const ENGINE_CONTENT_UNIT_KINDS_WITHOUT_PRODUCER = {
-    [TechnicalDocumentationUnitKind.CHANGE]: 'A change record belongs to one application, and an application-authored unit has no route — `pathForUnit` '
-        + 'admits only engine-namespaced slugs and the reserved `unit/manages/` namespace. Blocked on routing, not on authoring.',
+    [TechnicalDocumentationUnitKind.CHANGE]: 'A change record belongs to one application, so the engine cannot author it. Its producer is the application: '
+        + 'a CHANGE chapter in the documentation plan, authored in the specifications package and routed under `guides/` (#874).',
 };
 export const ENGINE_CONTENT_UNIT_DEFINITIONS = Object.freeze({
     'technical-documentation:unit/application-orientation': {
@@ -1568,6 +1567,16 @@ export const ENGINE_CONTENT_UNIT_DEFINITIONS = Object.freeze({
         ],
     },
 });
+/**
+ * The one Markdown-to-unit parser, shared by every tier that turns authored prose into a unit: the
+ * engine's own pages, and the chapters an application authors (#874). One parser means one rule for
+ * what a title, a summary and a section ARE — a second copy would let an application's guide and an
+ * engine page split the same text differently, and the difference would surface as a portal whose
+ * two halves summarize themselves by two conventions.
+ */
+export function parseTechnicalDocumentationUnitMarkdown(markdown, unitRef) {
+    return parseEngineMarkdown(markdown, unitRef);
+}
 function parseEngineMarkdown(markdown, unitRef) {
     const lines = markdown.trim().split('\n');
     const titleLine = lines.shift();
@@ -1948,9 +1957,10 @@ export function projectEngineApplicationConsumerContentBundle(bundle, engineSpec
      *
      * So these units are projected whole, from the same domain fact the overview page uses. They are
      * still ENGINE units, and deliberately: the engine owns the page's shape, its sections and its
-     * words, while the application supplies only the subject. That is what keeps `pathForUnit`'s
-     * refusal of application-owned units intact — nothing here asks it to route a unit an
-     * application named.
+     * words, while the application supplies only the subject. The pages whose WORDS an application
+     * owns are its authored chapters, which enter through their own reserved namespace
+     * (`application-documentation-chapters.ts`, #874) — not through here — so `pathForUnit` still
+     * refuses any unit whose ref an application chose freely.
      */
     const generatedResourceUnits = (applicationFacts.domain?.resourcePages ?? []).map((page) => {
         const unitRef = applicationDomainResourcePageUnitRef(page.resourceIdentifier);