@voxgig/sdkgen 4.16.0 → 4.17.0

package/dist/cmp/Docs.js

@@ -1,98 +0,0 @@
-"use strict";
-// GENERATING A DOCS ITEM. See docs/design/sdkgen-packages.md §20.3.
-//
-// A docs item is dispatched by the same convention a target is —
-// `cmp/docs/<n>/Main_<n>` — so an item's package supplies the emitter and
-// sdkgen supplies only the call.
-//
-// WHY THIS IS NOT RENDERED BY THE CONSUMER'S Root.ts
-//
-// A project's `Root.ts` is written once, by create-sdkgen, and is never
-// touched again (doctor has an `unwired` category precisely because of it).
-// So a kind introduced later can reach generation in one of two ways: every
-// existing project edits its Root, or sdkgen runs the kind's own pass. The
-// second is what happens here — `docs add` in a project scaffolded years ago
-// generates with no scaffold change at all, which is the whole point of
-// putting the destinations in packages.
-//
-// The cost is honest and small: a second `generate()` call over the same
-// root, so the changes report arrives in two parts.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocsItem = exports.Docs = void 0;
-exports.prepareModel = prepareModel;
-const jostraca_1 = require("jostraca");
-const utility_1 = require("../utility");
-const stdrep_1 = require("../helpers/stdrep");
-const types_1 = require("../types");
-// The model preamble every pass performs before rendering: the case-variant
-// name constants (`Name`, `NAME`, …) and the ProjectName replacement map that
-// template substitution reads.
-//
-// Done HERE rather than relied upon, because a docs pass does NOT go through
-// the consumer's Root — nothing else has set `ctx$.model`, and when there are
-// out-of-tree items the Root was handed a FILTERED COPY, so the preamble it
-// performed did not touch this object at all.
-function prepareModel(model, ctx$) {
-    ctx$.model = model;
-    model.const = model.const || { name: model.name };
-    (0, jostraca_1.names)(model.const, model.name);
-    if (null == model.const.year) {
-        model.const.year = new Date().getFullYear();
-    }
-    (0, jostraca_1.names)(model, model.name);
-    ctx$.stdrep = ctx$.stdrep || {};
-    (0, jostraca_1.names)(ctx$.stdrep, model.Name, 'Project' + 'Name');
-}
-// One item: its emitter, called with the item and the shared replace map.
-//
-// No Folder here — WHERE it lands is the caller's business, because that is
-// exactly what differs between the two passes: in-tree the item owns
-// `<sdk-repo>/<name>/`, out-of-tree the destination IS the item's root.
-const DocsItem = (0, jostraca_1.cmp)(function DocsItem(props) {
-    const { item, ctx$ } = props;
-    const log = ctx$.log;
-    const model = props.model ?? ctx$.model;
-    const stdrep = (0, stdrep_1.ensureStdrep)(ctx$);
-    // The MODEL KEY is the fallback, and it is not paranoia: `name` comes from
-    // the base schema's `name: key()`, so an item whose project has not
-    // included that schema — or whose own definition omits it — reached
-    // `require('cmp/docs/undefined/Main_undefined')`, a message naming nothing
-    // the author wrote. Seen in the first real install of a docs package.
-    const name = item.name ?? item.key$;
-    if (null == name || '' === name) {
-        throw new Error('Docs item has no name and no model key, so its component cannot be ' +
-            'located: ' + JSON.stringify(Object.keys(item ?? {})));
-    }
-    const Main_docs = (0, utility_1.requirePath)(ctx$, `cmp/docs/${name}/Main_${name}`);
-    Main_docs['Main']({ model, docs: item, stdrep });
-    log.info({
-        point: 'generate-docs', docs: name, note: 'docs:' + name
-    });
-});
-exports.DocsItem = DocsItem;
-// Every IN-TREE docs item, each in its own folder.
-//
-// Items with `output: path` are excluded: they get their own pass rooted at
-// that path, and rendering them here as well would ALSO write them into
-// `<sdk-repo>/<name>/` — the same reason `withoutExternal` exists for
-// targets.
-const Docs = (0, jostraca_1.cmp)(function Docs(props) {
-    const { ctx$ } = props;
-    const model = props.model ?? ctx$.model;
-    prepareModel(model, ctx$);
-    const items = model?.main?.[types_1.KIT]?.docs ?? {};
-    (0, jostraca_1.each)(items, (item) => {
-        if (false === item.active) {
-            return;
-        }
-        const path = item.output?.path;
-        if (null != path && '' !== path) {
-            return;
-        }
-        const name = item.name ?? item.key$;
-        (0, jostraca_1.names)(item, name);
-        (0, jostraca_1.Folder)({ name }, () => DocsItem({ item }));
-    });
-});
-exports.Docs = Docs;
-//# sourceMappingURL=Docs.js.map

package/dist/cmp/Docs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Docs.js","sourceRoot":"","sources":["../../src/cmp/Docs.ts"],"names":[],"mappings":";AAAA,oEAAoE;AACpE,EAAE;AACF,iEAAiE;AACjE,0EAA0E;AAC1E,iCAAiC;AACjC,EAAE;AACF,qDAAqD;AACrD,EAAE;AACF,wEAAwE;AACxE,4EAA4E;AAC5E,4EAA4E;AAC5E,2EAA2E;AAC3E,6EAA6E;AAC7E,wEAAwE;AACxE,wCAAwC;AACxC,EAAE;AACF,yEAAyE;AACzE,oDAAoD;;;QA0GlD,YAAY;AAxGd,uCAAmD;AAEnD,wCAAwC;AAExC,8CAAgD;AAEhD,oCAA8B;AAG9B,4EAA4E;AAC5E,8EAA8E;AAC9E,+BAA+B;AAC/B,EAAE;AACF,6EAA6E;AAC7E,8EAA8E;AAC9E,4EAA4E;AAC5E,8CAA8C;AAC9C,SAAS,YAAY,CAAC,KAAU,EAAE,IAAS;IACzC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IAElB,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;IACjD,IAAA,gBAAK,EAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;IAC9B,IAAI,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAC7B,KAAK,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;IAC7C,CAAC;IACD,IAAA,gBAAK,EAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;IAExB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAA;IAC/B,IAAA,gBAAK,EAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC,CAAA;AACpD,CAAC;AAGD,0EAA0E;AAC1E,EAAE;AACF,4EAA4E;AAC5E,qEAAqE;AACrE,wEAAwE;AACxE,MAAM,QAAQ,GAAG,IAAA,cAAG,EAAC,SAAS,QAAQ,CAAC,KAAU;IAC/C,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;IAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;IACpB,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAA;IAEvC,MAAM,MAAM,GAAG,IAAA,qBAAY,EAAC,IAAI,CAAC,CAAA;IAEjC,2EAA2E;IAC3E,oEAAoE;IACpE,oEAAoE;IACpE,2EAA2E;IAC3E,sEAAsE;IACtE,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAA;IAEnC,IAAI,IAAI,IAAI,IAAI,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CACb,qEAAqE;YACrE,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;IAC1D,CAAC;IAED,MAAM,SAAS,GAAG,IAAA,qBAAW,EAAC,IAAI,EAAE,YAAY,IAAI,SAAS,IAAI,EAAE,CAAC,CAAA;IAEpE,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;IAEhD,GAAG,CAAC,IAAI,CAAC;QACP,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI;KACzD,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;QAuCA,QAAQ;AApCV,mDAAmD;AACnD,EAAE;AACF,4EAA4E;AAC5E,wEAAwE;AACxE,sEAAsE;AACtE,WAAW;AACX,MAAM,IAAI,GAAG,IAAA,cAAG,EAAC,SAAS,IAAI,CAAC,KAAU;IACvC,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;IACtB,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAA;IAEvC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IAEzB,MAAM,KAAK,GAAG,KAAK,EAAE,IAAI,EAAE,CAAC,WAAG,CAAC,EAAE,IAAI,IAAI,EAAE,CAAA;IAE5C,IAAA,eAAI,EAAC,KAAK,EAAE,CAAC,IAAS,EAAE,EAAE;QACxB,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,OAAM;QACR,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAA;QAE9B,IAAI,IAAI,IAAI,IAAI,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;YAChC,OAAM;QACR,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAA;QAEnC,IAAA,gBAAK,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAEjB,IAAA,iBAAM,EAAC,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IAC5C,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;QAIA,IAAI"}

package/dist/cmp/ExternalDocs.d.ts

@@ -1,2 +0,0 @@
-declare const ExternalDocs: import("jostraca").Component;
-export { ExternalDocs };

package/dist/cmp/ExternalDocs.js

@@ -1,43 +0,0 @@
-"use strict";
-// The Root for a DOCS item that generates outside the SDK repo
-// (`main: kit: docs: <n>: output: path`).
-//
-// Out of tree is the NORMAL case for a docs item, not the exception it is for
-// a target: a documentation site usually has its own repo, and in-tree it
-// would collide with the SDK repo's own README and CI workflows.
-//
-// The two facts that make this a separate `generate()` pass rather than a
-// folder are the ones `ExternalTarget` documents at length: jostraca's
-// `FileHandler.validName` refuses a `..` segment in a folder name (the guard
-// that keeps generation inside the tree it was pointed at, not an oversight
-// to route around), and the output root is `jopts.folder` PER CALL — so
-// writing somewhere else means another call.
-//
-// No Folder wraps the item: the destination IS the site, so its files go at
-// the root of the output path.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExternalDocs = void 0;
-const jostraca_1 = require("jostraca");
-const Docs_1 = require("./Docs");
-const ExternalDocs = (0, jostraca_1.cmp)(function ExternalDocs(props) {
-    const { model, item, cmpfolder, sdkrelpath } = props;
-    const ctx$ = props.ctx$;
-    // Components live in the PROJECT, not in the repo being written to. This
-    // pass has retargeted jostraca's output folder, which is what requirePath
-    // otherwise resolves against — see utility.resolvePath. Losing this line
-    // makes the pass look for components under the DESTINATION.
-    ctx$.cmpfolder = cmpfolder;
-    // The path from the destination back to the SDK project, for a site that
-    // sits beside the SDK in a known layout and needs to name it.
-    ctx$.sdkrelpath = sdkrelpath;
-    // The same preamble the in-tree pass performs — one definition, both
-    // callers, because a project whose ONLY docs item is out of tree must
-    // generate exactly as one with both.
-    (0, Docs_1.prepareModel)(model, ctx$);
-    (0, jostraca_1.Project)({}, () => {
-        (0, jostraca_1.names)(item, item.name ?? item.key$);
-        (0, Docs_1.DocsItem)({ item });
-    });
-});
-exports.ExternalDocs = ExternalDocs;
-//# sourceMappingURL=ExternalDocs.js.map

package/dist/cmp/ExternalDocs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ExternalDocs.js","sourceRoot":"","sources":["../../src/cmp/ExternalDocs.ts"],"names":[],"mappings":";AAAA,+DAA+D;AAC/D,0CAA0C;AAC1C,EAAE;AACF,8EAA8E;AAC9E,0EAA0E;AAC1E,iEAAiE;AACjE,EAAE;AACF,0EAA0E;AAC1E,uEAAuE;AACvE,6EAA6E;AAC7E,4EAA4E;AAC5E,wEAAwE;AACxE,6CAA6C;AAC7C,EAAE;AACF,4EAA4E;AAC5E,+BAA+B;;;AAE/B,uCAA8C;AAI9C,iCAA+C;AAG/C,MAAM,YAAY,GAAG,IAAA,cAAG,EAAC,SAAS,YAAY,CAAC,KAAU;IACvD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,KAAK,CAAA;IACpD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;IAEvB,yEAAyE;IACzE,0EAA0E;IAC1E,yEAAyE;IACzE,4DAA4D;IAC5D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAE1B,yEAAyE;IACzE,8DAA8D;IAC9D,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAE5B,qEAAqE;IACrE,sEAAsE;IACtE,qCAAqC;IACrC,IAAA,mBAAY,EAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IAEzB,IAAA,kBAAO,EAAC,EAAE,EAAE,GAAG,EAAE;QACf,IAAA,gBAAK,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAA;IACpB,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;QAIA,YAAY"}

package/src/cmp/Docs.ts

@@ -1,125 +0,0 @@
-// GENERATING A DOCS ITEM. See docs/design/sdkgen-packages.md §20.3.
-//
-// A docs item is dispatched by the same convention a target is —
-// `cmp/docs/<n>/Main_<n>` — so an item's package supplies the emitter and
-// sdkgen supplies only the call.
-//
-// WHY THIS IS NOT RENDERED BY THE CONSUMER'S Root.ts
-//
-// A project's `Root.ts` is written once, by create-sdkgen, and is never
-// touched again (doctor has an `unwired` category precisely because of it).
-// So a kind introduced later can reach generation in one of two ways: every
-// existing project edits its Root, or sdkgen runs the kind's own pass. The
-// second is what happens here — `docs add` in a project scaffolded years ago
-// generates with no scaffold change at all, which is the whole point of
-// putting the destinations in packages.
-//
-// The cost is honest and small: a second `generate()` call over the same
-// root, so the changes report arrives in two parts.
-
-import { cmp, each, names, Folder } from 'jostraca'
-
-import { requirePath } from '../utility'
-
-import { ensureStdrep } from '../helpers/stdrep'
-
-import { KIT } from '../types'
-
-
-// The model preamble every pass performs before rendering: the case-variant
-// name constants (`Name`, `NAME`, …) and the ProjectName replacement map that
-// template substitution reads.
-//
-// Done HERE rather than relied upon, because a docs pass does NOT go through
-// the consumer's Root — nothing else has set `ctx$.model`, and when there are
-// out-of-tree items the Root was handed a FILTERED COPY, so the preamble it
-// performed did not touch this object at all.
-function prepareModel(model: any, ctx$: any) {
-  ctx$.model = model
-
-  model.const = model.const || { name: model.name }
-  names(model.const, model.name)
-  if (null == model.const.year) {
-    model.const.year = new Date().getFullYear()
-  }
-  names(model, model.name)
-
-  ctx$.stdrep = ctx$.stdrep || {}
-  names(ctx$.stdrep, model.Name, 'Project' + 'Name')
-}
-
-
-// One item: its emitter, called with the item and the shared replace map.
-//
-// No Folder here — WHERE it lands is the caller's business, because that is
-// exactly what differs between the two passes: in-tree the item owns
-// `<sdk-repo>/<name>/`, out-of-tree the destination IS the item's root.
-const DocsItem = cmp(function DocsItem(props: any) {
-  const { item, ctx$ } = props
-  const log = ctx$.log
-  const model = props.model ?? ctx$.model
-
-  const stdrep = ensureStdrep(ctx$)
-
-  // The MODEL KEY is the fallback, and it is not paranoia: `name` comes from
-  // the base schema's `name: key()`, so an item whose project has not
-  // included that schema — or whose own definition omits it — reached
-  // `require('cmp/docs/undefined/Main_undefined')`, a message naming nothing
-  // the author wrote. Seen in the first real install of a docs package.
-  const name = item.name ?? item.key$
-
-  if (null == name || '' === name) {
-    throw new Error(
-      'Docs item has no name and no model key, so its component cannot be ' +
-      'located: ' + JSON.stringify(Object.keys(item ?? {})))
-  }
-
-  const Main_docs = requirePath(ctx$, `cmp/docs/${name}/Main_${name}`)
-
-  Main_docs['Main']({ model, docs: item, stdrep })
-
-  log.info({
-    point: 'generate-docs', docs: name, note: 'docs:' + name
-  })
-})
-
-
-// Every IN-TREE docs item, each in its own folder.
-//
-// Items with `output: path` are excluded: they get their own pass rooted at
-// that path, and rendering them here as well would ALSO write them into
-// `<sdk-repo>/<name>/` — the same reason `withoutExternal` exists for
-// targets.
-const Docs = cmp(function Docs(props: any) {
-  const { ctx$ } = props
-  const model = props.model ?? ctx$.model
-
-  prepareModel(model, ctx$)
-
-  const items = model?.main?.[KIT]?.docs ?? {}
-
-  each(items, (item: any) => {
-    if (false === item.active) {
-      return
-    }
-
-    const path = item.output?.path
-
-    if (null != path && '' !== path) {
-      return
-    }
-
-    const name = item.name ?? item.key$
-
-    names(item, name)
-
-    Folder({ name }, () => DocsItem({ item }))
-  })
-})
-
-
-export {
-  Docs,
-  DocsItem,
-  prepareModel,
-}

package/src/cmp/ExternalDocs.ts

@@ -1,54 +0,0 @@
-// The Root for a DOCS item that generates outside the SDK repo
-// (`main: kit: docs: <n>: output: path`).
-//
-// Out of tree is the NORMAL case for a docs item, not the exception it is for
-// a target: a documentation site usually has its own repo, and in-tree it
-// would collide with the SDK repo's own README and CI workflows.
-//
-// The two facts that make this a separate `generate()` pass rather than a
-// folder are the ones `ExternalTarget` documents at length: jostraca's
-// `FileHandler.validName` refuses a `..` segment in a folder name (the guard
-// that keeps generation inside the tree it was pointed at, not an oversight
-// to route around), and the output root is `jopts.folder` PER CALL — so
-// writing somewhere else means another call.
-//
-// No Folder wraps the item: the destination IS the site, so its files go at
-// the root of the output path.
-
-import { cmp, names, Project } from 'jostraca'
-
-import { KIT } from '../types'
-
-import { DocsItem, prepareModel } from './Docs'
-
-
-const ExternalDocs = cmp(function ExternalDocs(props: any) {
-  const { model, item, cmpfolder, sdkrelpath } = props
-  const ctx$ = props.ctx$
-
-  // Components live in the PROJECT, not in the repo being written to. This
-  // pass has retargeted jostraca's output folder, which is what requirePath
-  // otherwise resolves against — see utility.resolvePath. Losing this line
-  // makes the pass look for components under the DESTINATION.
-  ctx$.cmpfolder = cmpfolder
-
-  // The path from the destination back to the SDK project, for a site that
-  // sits beside the SDK in a known layout and needs to name it.
-  ctx$.sdkrelpath = sdkrelpath
-
-  // The same preamble the in-tree pass performs — one definition, both
-  // callers, because a project whose ONLY docs item is out of tree must
-  // generate exactly as one with both.
-  prepareModel(model, ctx$)
-
-  Project({}, () => {
-    names(item, item.name ?? item.key$)
-
-    DocsItem({ item })
-  })
-})
-
-
-export {
-  ExternalDocs
-}