@voxgig/apidef 2.3.0 → 2.4.0

package/src/utility.ts

@@ -1,6 +1,8 @@
 
 import Path from 'node:path'
 
+import { slice, merge, inject, clone, isnode, walk, transform, select } from '@voxgig/struct'
+
 
 import type {
   FsUtil,
@@ -27,6 +29,9 @@ function getdlog(
   return dlog
 }
 
+// Log non-fatal wierdness.
+const dlog = getdlog('apidef', __filename)
+
 
 function loadFile(path: string, what: string, fs: FsUtil, log: Log) {
   try {
@@ -123,7 +128,7 @@ function depluralize(word: string): string {
   if (word.endsWith('nses')) {
     return word.slice(0, -1)
   }
-  
+
   // -ses, -xes, -zes, -shes, -ches -> remove -es (boxes -> box)
   if (word.endsWith('ses') || word.endsWith('xes') || word.endsWith('zes') ||
     word.endsWith('shes') || word.endsWith('ches')) {
@@ -140,55 +145,197 @@ function depluralize(word: string): string {
 }
 
 
-/*
-function writeChanged(
-  point: string, path: string, content: string,
-  fs: FsUtil, log: Log,
-  flags?: { update?: boolean }
-) {
-  let exists = false
-  let changed = false
+function find(obj: any, qkey: string): any[] {
+  let vals: any[] = []
+  walk(obj, (key: any, val: any, _p: any, t: string[]) => {
+    if (qkey === key) {
+      vals.push({ key, val, path: t })
+    }
+    return val
+  })
+  return vals
+}
 
-  flags = flags || {}
-  flags.update = null == flags.update ? true : !!flags.update
 
-  let action = ''
-  try {
-    let existingContent: string = ''
-    path = Path.normalize(path)
+function capture(data: any, shape: any): Record<string, any> {
+  let meta = { capture: {} }
+  let errs: any[] = []
+
+  transform(data, shape, {
+    extra: {
+      $CAPTURE,
+      $APPEND,
+      $ANY,
+      $SELECT,
+      $LOWER,
+    },
+    errs,
+    meta
+  })
+
+  if (0 < errs.length) {
+    console.log('ERRS', errs)
+    dlog(errs)
+  }
+  return meta.capture
+}
 
-    exists = fs.existsSync(path)
 
-    if (exists) {
-      action = 'read'
-      existingContent = fs.readFileSync(path, 'utf8')
+function $CAPTURE(inj: any) {
+  // Set prop foo with value at x: { x: { '`$CAPTURE`': 'foo' } }
+  if ('key:pre' === inj.mode) {
+    const { val, prior } = inj
+    const { dparent, key } = prior
+    const dval = dparent?.[key]
+    if (undefined !== dval) {
+      inj.meta.capture[val] = dval
     }
+  }
 
-    changed = existingContent !== content
+  // Use key x as prop name: { x: '`$CAPTURE`': }
+  else if ('val' === inj.mode) {
+    const { key, dparent } = inj
+    const dval = dparent?.[key]
+    if (undefined !== dval) {
+      inj.meta.capture[key] = dval
+    }
+  }
+}
 
-    action = flags.update ? 'write' : 'skip'
 
-    log.info({
-      point: 'write-' + point,
-      note: (changed ? '' : 'not-') + 'changed ' + path,
-      write: 'file', skip: !changed, exists, changed,
-      contentLength: content.length, file: path
+function $APPEND(inj: any, val: any, ref: any, store: any) {
+  // Set prop foo with value at x: { x: { '`$CAPTURE`': 'foo' } }
+  if ('key:pre' === inj.mode) {
+    const { val, prior } = inj
+    const { dparent, key } = prior
+    const dval = dparent?.[key]
+    if (undefined !== dval) {
+      inj.meta.capture[val] = (inj.meta.capture[val] || [])
+      inj.meta.capture[val].push(dval)
+    }
+  }
+
+
+  else if ('val' === inj.mode) {
+    inj.keyI = inj.keys.length
+
+    const [_, prop, xform] = inj.parent
+    const { key, dparent } = inj.prior
+    const dval = dparent?.[key]
+
+    const vstore = { ...store }
+    vstore.$TOP = { [key]: dval }
+
+    // const ptval = transform({ [key]: dval }, { [key]: xform }, {
+    const ptval = inject({ [key]: xform }, vstore, {
+      meta: { ...inj.meta },
+      errs: inj.errs,
     })
 
-    if (!exists || (changed && flags.update)) {
-      fs.writeFileSync(path, content)
+    const tval = ptval[key]
+
+    if (undefined !== tval) {
+      inj.meta.capture[prop] = (inj.meta.capture[prop] || [])
+      inj.meta.capture[prop].push(tval)
     }
   }
-  catch (err: any) {
-    log.error({
-      fail: action, point, file: path, exists, changed,
-      contentLength: content.length, err
+}
+
+
+
+function $ANY(inj: any, _val: any, _ref: any, store: any) {
+  if ('key:pre' === inj.mode) {
+    const { prior } = inj
+    const child = inj.parent[inj.key]
+    const { dparent, key } = prior
+    const dval = dparent?.[key]
+    if (isnode(dval)) {
+      for (let n of Object.entries(dval)) {
+        let vstore = { ...store }
+        vstore.$TOP = { [n[0]]: n[1] }
+        inject(clone({ [n[0]]: child }), vstore, {
+          meta: inj.meta,
+          errs: inj.errs,
+        })
+      }
+    }
+  }
+}
+
+
+function $SELECT(inj: any, _val: any, _ref: any, store: any) {
+  if ('val' === inj.mode) {
+    inj.keyI = inj.keys.length
+
+    let [_, selector, descendor] = inj.parent
+
+    const dparents =
+      Object.entries(inj.dparent || {})
+        .filter(n => isnode(n[1]))
+        .reduce((a, n) => (a[n[0]] = n[1], a), ({} as any))
+
+    // console.log('SELECT-FROM', dparents)
+
+    if (selector instanceof RegExp) {
+      selector = {
+        '$KEY': { '`$LIKE`': selector.toString() }
+      }
+    }
+
+    // TODO: select should be safe for scalars
+    const children = select(dparents, selector)
+
+    if (0 < children.length) {
+      for (let child of children) {
+        let vstore = { ...store }
+        vstore.$TOP = { [child.$KEY]: child }
+
+        inject(clone({ [child.$KEY]: descendor }), vstore, {
+          meta: merge([
+            inj.meta,
+
+            // TODO: need this hack as struct does not provide a way to get grandparent keys
+            // also, these capture actions are not preserving the path!
+            { select: { key: { [slice(inj.path, 1, -1).join('+')]: child.$KEY } } }
+          ]),
+          errs: inj.errs,
+        })
+      }
+    }
+  }
+}
+
+
+function $LOWER(inj: any, val: any, ref: any, store: any) {
+  if ('key:pre' === inj.mode) {
+    const dval = inj.parent[inj.key]
+
+    // TODO: handle paths more generally! use inj.prior?
+    // TODO: mkae this into a utility method on inj?
+    const dkey = inj.prior.key
+    const gkey = inj.prior.prior.key
+
+    const vstore = { ...store }
+    vstore.$TOP = { [gkey]: { [dkey]: inj.dparent?.[dkey] } }
+
+    const vspec = { [gkey]: { [dkey]: dval } }
+
+    const ptval = inject(vspec, vstore, {
+      meta: { ...inj.meta },
+      errs: inj.errs,
     })
-    err.__logged__ = true
-    throw err
+
+    let tval = ptval[gkey][dkey]
+
+    if ('string' === typeof tval) {
+      tval = tval.toLowerCase()
+    }
+
+    inj.setval(tval, 2)
   }
 }
-*/
+
+
 
 
 export {
@@ -196,6 +343,6 @@ export {
   loadFile,
   formatJsonSrc,
   depluralize,
-
-  // writeChanged,
+  find,
+  capture,
 }

package/dist/guide.d.ts

@@ -1,2 +0,0 @@
-declare function resolveGuide(ctx: any): Promise<() => void>;
-export { resolveGuide };

package/dist/guide.js

@@ -1,95 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveGuide = resolveGuide;
-const node_path_1 = __importDefault(require("node:path"));
-const jostraca_1 = require("jostraca");
-const struct_1 = require("@voxgig/struct");
-const heuristic01_1 = require("./guide/heuristic01");
-const utility_1 = require("./utility");
-// Log non-fatal wierdness.
-const dlog = (0, utility_1.getdlog)('apidef', __filename);
-async function resolveGuide(ctx) {
-    let baseguide = {};
-    let override = ctx.model.main.api.guide;
-    if ('heuristic01' === ctx.opts.strategy) {
-        baseguide = await (0, heuristic01_1.heuristic01)(ctx);
-    }
-    else {
-        throw new Error('Unknown guide strategy: ' + ctx.opts.strategy);
-    }
-    // Override generated base guide with custom hints 
-    let guide = (0, struct_1.merge)([{}, baseguide, override]);
-    // TODO: this is a hack!!!
-    // Instead, update @voxgig/model, so that builders can request a reload of the entire
-    // model. This allows builders to modify the model for later buidlers
-    // during a single generation pass.
-    guide = cleanGuide(guide);
-    // TODO: FIX: sdk.jsonic should have final version of guide
-    if (ctx.model.main?.api) {
-        ctx.model.main.api.guide = guide;
-    }
-    else {
-        dlog('missing', 'ctx.model.main.api');
-    }
-    const guideFile = node_path_1.default.join(ctx.opts.folder, (null == ctx.opts.outprefix ? '' : ctx.opts.outprefix) + 'base-guide.jsonic');
-    const guideBlocks = [
-        '# Guide',
-        '',
-        'main: api: guide: { ',
-    ];
-    guideBlocks.push(...(0, jostraca_1.each)(baseguide.entity, (entity, entityname) => {
-        guideBlocks.push(`
-entity: ${entityname}: {` +
-            (0 < entity.why_name.length ? ' # name:' + entity.why_name.join(';') : ''));
-        (0, jostraca_1.each)(entity.path, (path, pathname) => {
-            guideBlocks.push(`  path: '${pathname}': op: {` +
-                (0 < path.why_ent.length ? ' # ent:' + path.why_ent.join(';') : ''));
-            (0, jostraca_1.each)(path.op, (op, opname) => {
-                guideBlocks.push(`    '${opname}': method: ${op.method}` +
-                    (0 < op.why_op.length ? ' # ' + op.why_op : ''));
-                if (op.transform?.reqform) {
-                    guideBlocks.push(`    '${opname}': transform: reqform: ${JSON.stringify(op.transform.reqform)}`);
-                }
-            });
-            guideBlocks.push(`  }`);
-        });
-        guideBlocks.push(`}`);
-    }));
-    guideBlocks.push('}');
-    const guideSrc = guideBlocks.join('\n');
-    return () => {
-        // Save base guide for reference
-        (0, jostraca_1.File)({ name: '../def/' + node_path_1.default.basename(guideFile) }, () => (0, jostraca_1.Content)(guideSrc));
-    };
-}
-function cleanGuide(guide) {
-    const clean = {
-        control: guide.control,
-        entity: {}
-    };
-    const exclude_entity = guide.exclude?.entity?.split(',') || [];
-    const include_entity = guide.include?.entity?.split(',') || [];
-    (0, jostraca_1.each)(guide.entity, (entity, name) => {
-        if (exclude_entity.includes(name)) {
-            return;
-        }
-        if (exclude_entity.includes('*')) {
-            if (!include_entity.includes(name)) {
-                return;
-            }
-        }
-        let ent = clean.entity[name] = clean.entity[name] = {
-            name,
-            why_name: entity.why_name || [],
-            path: {}
-        };
-        (0, jostraca_1.each)(entity.path, (path, pathname) => {
-            ent.path[pathname] = path;
-        });
-    });
-    return clean;
-}
-//# sourceMappingURL=guide.js.map

package/dist/guide.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"guide.js","sourceRoot":"","sources":["../src/guide.ts"],"names":[],"mappings":";;;;;AAmIE,oCAAY;AAlId,0DAA4B;AAE5B,uCAA8C;AAE9C,2CAAsC;AAGtC,qDAAiD;AAEjD,uCAEkB;AAGlB,2BAA2B;AAC3B,MAAM,IAAI,GAAG,IAAA,iBAAO,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;AAE1C,KAAK,UAAU,YAAY,CAAC,GAAQ;IAClC,IAAI,SAAS,GAAwB,EAAE,CAAA;IACvC,IAAI,QAAQ,GAAwB,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAA;IAE5D,IAAI,aAAa,KAAK,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACxC,SAAS,GAAG,MAAM,IAAA,yBAAW,EAAC,GAAG,CAAC,CAAA;IACpC,CAAC;SACI,CAAC;QACJ,MAAM,IAAI,KAAK,CAAC,0BAA0B,GAAG,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACjE,CAAC;IAED,mDAAmD;IACnD,IAAI,KAAK,GAAG,IAAA,cAAK,EAAC,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAA;IAE5C,0BAA0B;IAC1B,qFAAqF;IACrF,qEAAqE;IACrE,mCAAmC;IAGnC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAA;IAGzB,2DAA2D;IAC3D,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC;QACxB,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,KAAK,CAAA;IAClC,CAAC;SACI,CAAC;QACJ,IAAI,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAA;IACvC,CAAC;IAED,MAAM,SAAS,GACb,mBAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EACvB,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,mBAAmB,CAAC,CAAA;IAEjF,MAAM,WAAW,GAAG;QAClB,SAAS;QACT,EAAE;QACF,sBAAsB;KAEvB,CAAA;IAGD,WAAW,CAAC,IAAI,CAAC,GAAG,IAAA,eAAI,EAAC,SAAS,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE;QAChE,WAAW,CAAC,IAAI,CAAC;UACX,UAAU,KAAK;YACnB,CAAC,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAE7E,IAAA,eAAI,EAAC,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;YACnC,WAAW,CAAC,IAAI,CAAC,YAAY,QAAQ,UAAU;gBAC7C,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YAEtE,IAAA,eAAI,EAAC,IAAI,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE;gBAC3B,WAAW,CAAC,IAAI,CAAC,QAAQ,MAAM,cAAc,EAAE,CAAC,MAAM,EAAE;oBACtD,CAAC,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;gBAClD,IAAI,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,CAAC;oBAC1B,WAAW,CAAC,IAAI,CACd,QAAQ,MAAM,0BAA0B,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBACnF,CAAC;YACH,CAAC,CAAC,CAAA;YAEF,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACzB,CAAC,CAAC,CAAA;QAEF,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACvB,CAAC,CAAC,CAAC,CAAA;IAEH,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAErB,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAEvC,OAAO,GAAG,EAAE;QACV,gCAAgC;QAChC,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,SAAS,GAAG,mBAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,IAAA,kBAAO,EAAC,QAAQ,CAAC,CAAC,CAAA;IAC/E,CAAC,CAAA;AACH,CAAC;AAGD,SAAS,UAAU,CAAC,KAA0B;IAC5C,MAAM,KAAK,GAAwB;QACjC,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,MAAM,EAAE,EAAE;KACX,CAAA;IAED,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAA;IAC9D,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAA;IAE9D,IAAA,eAAI,EAAC,KAAK,CAAC,MAAM,EAAE,CAAC,MAAW,EAAE,IAAY,EAAE,EAAE;QAC/C,IAAI,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAM;QACR,CAAC;QACD,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnC,OAAM;YACR,CAAC;QACH,CAAC;QAED,IAAI,GAAG,GAAQ,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG;YACvD,IAAI;YACJ,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,EAAE;YAC/B,IAAI,EAAE,EAAE;SACT,CAAA;QAED,IAAA,eAAI,EAAC,MAAM,CAAC,IAAI,EAAE,CAAC,IAAS,EAAE,QAAgB,EAAE,EAAE;YAChD,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAA;QAC3B,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,OAAO,KAAK,CAAA;AACd,CAAC"}