@voxgig/apidef 3.1.1 → 3.3.1

package/src/guide/heuristic01.ts

@@ -53,6 +53,8 @@ import type {
 } from '../utility'
 
 
+const KONSOLE_LOG = console['log']
+
 
 // Log non - fatal wierdness.
 const dlog = getdlog('apidef', __filename)
@@ -63,7 +65,6 @@ const IS_ENTCMP_METHOD_RATE = 0.21
 const IS_ENTCMP_PATH_RATE = 0.41
 
 
-
 const METHOD_IDOP: Record<string, string> = {
   GET: 'load',
   POST: 'create',
@@ -88,6 +89,7 @@ const METHOD_CONSIDER_ORDER: Record<string, number> = {
 
 async function heuristic01(ctx: ApiDefContext): Promise<Guide> {
 
+  // TODO: Ordu needs better debug output to track task exec
   const analysis = new Ordu({ select: { sort: true } }).add([
     Prepare,
     {
@@ -120,22 +122,13 @@ async function heuristic01(ctx: ApiDefContext): Promise<Guide> {
 
   const guide = result.data.guide
 
-  // console.log('WORK', result.data.work)
-
-  // console.log('GUIDE')
-  // console.dir(guide, { depth: null })
-
-
-  // TODO: move to Ordu
-  // warnOnError('reviewEntityDescs', ctx.warn, () => reviewEntityDescs(ctx, result))
-
   return guide
 
 }
 
 
 function ShowNode(spec: TaskSpec) {
-  console.log('NODE', spec.node.key, spec.node.val)
+  KONSOLE_LOG('NODE', spec.node.key, spec.node.val)
 }
 
 
@@ -242,7 +235,6 @@ function selectCmpXrefs(_source: any, spec: TaskSpec) {
   const out = find(spec.ctx.def, 'x-ref')
     .filter(xref => xref.val.match(/\/(components\/schemas|definitions)\//))
 
-  // console.log('selectCmpXrefs', out)
   return out
 }
 
@@ -271,9 +263,10 @@ function selectAllMethods(_source: any, spec: TaskSpec): MethodDesc[] {
   const ctx = spec.ctx
   // const paths = ctx.def.paths
 
+  /*
   let caught = capture(ctx.def, {
     paths:
-      ['`$SELECT`', /.*/,
+      ['`$SELECT`', /.* /,
         ['`$SELECT`', /^get|post|put|patch|delete$/i,
           ['`$APPEND`', 'methods', {
             path: '`select$=key.paths`',
@@ -286,11 +279,35 @@ function selectAllMethods(_source: any, spec: TaskSpec): MethodDesc[] {
           }]
         ]
       ]
-  })
+      })
 
-  // TODO: capture should return these empty objects
-  caught = caught ?? {}
-  caught.methods = caught.methods ?? []
+        // TODO: capture should return these empty objects
+        caught = caught ?? {}
+        caught.methods = caught.methods ?? []
+
+  */
+
+  let caught: any = { methods: [] }
+
+  Object.entries(ctx.def.paths).map((n: any) => {
+    const path = n[0]
+    const pdef = n[1]
+
+    Object.entries(pdef).map((m: any) => {
+      const method = m[0].toUpperCase()
+      const mdef = m[1]
+
+      caught.methods.push({
+        path,
+        method,
+        summary: mdef.summary,
+        tags: mdef.tags,
+        parameters: mdef.parameters,
+        responses: mdef.responses,
+        requestBody: mdef.requestBody,
+      })
+    })
+  })
 
   caught.methods.sort((a: any, b: any) => {
     if (a.path < b.path) {
@@ -310,8 +327,6 @@ function selectAllMethods(_source: any, spec: TaskSpec): MethodDesc[] {
     }
   })
 
-  // console.log(caught.methods.map((n: any) => n.path + ' ' + n.method))
-
   return caught.methods || []
 }
 
@@ -402,7 +417,7 @@ function ResolveEntityComponent(spec: TaskSpec) {
       const pcount = metrics.count.path
       const method_rate = (0 < mcount ? (cmprefs / mcount) : -1)
       const path_rate = (0 < pcount ? (cmprefs / pcount) : -1)
-      // console.log('RCN', xref.cmp, cmprefs, mcount, method_rate, IS_ENTCMP_METHOD_RATE, method_rate < IS_ENTCMP_METHOD_RATE)
+
       const infrequent =
         method_rate < IS_ENTCMP_METHOD_RATE
         || path_rate < IS_ENTCMP_PATH_RATE
@@ -1036,8 +1051,6 @@ function ResolveTransform(spec: TaskSpec) {
   const resprops = getResponseSchema(resokdef)?.properties
   debugpath(pathStr, methodName, 'TRANSFORM-RES', keysof(resprops))
 
-  // console.log('APIDEF-resprops', resprops)
-
   if (resprops) {
     if (resprops[entdesc.origname]) {
       transform.res = '`body.' + entdesc.origname + '`'
@@ -1067,8 +1080,6 @@ function ResolveTransform(spec: TaskSpec) {
 
 function BuildEntity(spec: TaskSpec) {
   const entdesc = spec.node.val
-  // console.log('BUILD-ENTITY')
-  // console.dir(entdesc, { depth: null })
 
   const guide: Guide = spec.data.guide
   guide.metrics.count.entity++
@@ -1078,7 +1089,6 @@ function BuildEntity(spec: TaskSpec) {
   const path: Record<string, GuidePath> = {}
 
   const rename_param = (pathdesc: any) => {
-    // console.log('RENAME-PATHDESC', pathdesc)
     const out: Record<string, GuideRenameParam> = {}
     each(pathdesc.rename.param, (item: any) => {
       out[item.key$] = {
@@ -1371,8 +1381,6 @@ function entityCmpMatch(
     pathish: true,
   }
 
-  // console.log('ECM-A', out, ment)
-
   const cmpInfrequent = (
     ment.method_rate < IS_ENTCMP_METHOD_RATE
     || ment.path_rate < IS_ENTCMP_PATH_RATE
@@ -1431,8 +1439,6 @@ function entityCmpMatch(
     mdesc.method, entname + '->', out, why, ment,
     IS_ENTCMP_METHOD_RATE, IS_ENTCMP_PATH_RATE)
 
-  // console.log('ECM-Z', out, why, ment)
-
   return out
 }
 
@@ -1647,7 +1653,6 @@ function findcmps(
 
 
         found.map((xref: { val: string }) => {
-          // console.log('FINDCMPS', pathStr, (md as any).key$, up, xref.val)
           let m = xref.val.match(/\/(components\/schemas|definitions)\/(.+)$/)
           if (m) {
             cmplist.push(m[2])
@@ -1656,7 +1661,7 @@ function findcmps(
         })
       })
     })
-  // console.log('FOUNDCMPS', cmps)
+
   return (opts?.uniq ? Array.from(cmpset) : cmplist).map(n =>
     ({ cmp: canonize(n), origcmp: n }))
 }
@@ -1714,119 +1719,9 @@ function hasMethod(def: any, pathStr: string, methodName: string) {
       || null != pathDef[methodName.toUpperCase()]
     )
   )
-  console.log('hasMethod', pathStr, methodName, found)
-  return found
-}
-
-
-
-/*
-// Some decisions require the full list of potential entities.
-function reviewEntityDescs(ctx: ApiDefContext, result: any) {
-  const guide: Guide = result.data.guide
-  const metrics = guide.metrics
-  const entityDescs = result.data.work.entmap
-
-  if (0 < metrics.count.cmp) {
-    items(entityDescs).map(([entname, entdesc]: [string, EntityDesc]) => {
-
-      // Entities with a single path and single op and no cmp are suspicious
 
-      const pathmap = entdesc.path
-      const pathcount = size(pathmap)
-      const hascmp = null != entdesc.cmp?.namedesc
-
-      if (
-        1 === pathcount
-        && !hascmp
-      ) {
-        let pathdesc: EntityPathDesc = each(pathmap)[0]
-        const pathStr = (pathdesc as any).key$
-
-        if (1 === size(pathdesc.op)) {
-          let op = pathdesc.op
-
-          // console.log('REVIEW', entdesc.name, pathcount, hascmp, op)
-
-          if (op.create) {
-
-            // Entities without "good" components
-            if (
-              entname.includes('_')
-              && pathdesc.pm.expr.endsWith('p/t/')
-            ) {
-              const lastpart = canonize(getelem(pathdesc.pm, -1))
-              const tgtent = entityDescs[lastpart]
-
-              // console.log('REVIEW', entname, entdesc.cmp, size(pathmap), lastpart, realent)
-
-              if (
-                null != tgtent
-                && tgtent.name !== entname
-                && (
-                  null == tgtent.cmp
-                  || lastpart == tgtent.cmp
-                )
-              ) {
-
-                // Actually a known component
-                // console.dir(entdesc, { depth: null })
-
-
-                const realent = guide.entity[entname]
-                const realpathmap = realent.path
-                let realpath = realpathmap[pathStr]
-
-                if (null == realpath) {
-                  realpath = realpathmap[pathStr] = pathdesc
-                }
-                else if (null == realpath.op?.create) {
-                  realpath.op = (realpath.op ?? {})
-                  realpath.op.create = pathdesc.op.create
-                }
-
-                realpath.op.create.why_op =
-                  'was/create/A:' + entname + ':' + realpath.op.create.why_op
-
-                delete entityDescs[entname]
-
-                // console.log('REPLACE', entname, realent.name, realpath)
-              }
-
-            }
-          }
-
-          else if (op.remove) {
-            const otherents: EntityDesc[] = each(entityDescs)
-              .filter((ed: EntityDesc) => ed !== entdesc && each(ed.path)
-                .filter(epd => epd.key$ === pathStr).length)
-
-            const otherent = 1 === otherents.length ? otherents[0] : null
-
-            // console.log('OTHERENT', pathStr, otherents.length, otherent)
-
-            if (null != otherent && null != otherent.cmp) {
-              const otherpath = otherent.path[pathStr]
-
-              if (null == otherpath.op.remove) {
-                otherpath.op.remove = op.remove
-                otherpath.op.remove.why_op =
-                  'was/delete/A:' + entname + ':' + op.remove.why_op
-                delete entityDescs[entname]
-              }
-            }
-          }
-
-          debugpath(pathdesc.pm.path, null,
-            'REVIEW-ENTITY', formatJSONIC(entdesc, { hsepd: 0, $: true, color: true }))
-
-
-        }
-      }
-    })
-  }
+  return found
 }
-*/
 
 
 export {

package/src/model.ts

@@ -10,6 +10,14 @@ type OpName = 'load' | 'list' | 'create' | 'update' | 'remove' | 'patch' | 'head
 
 
 type Model = {
+  name: string
+  origin?: string
+
+  const: {
+    // TODO: remove
+    Name: string
+  }
+
   main: {
     kit: {
       entity: Record<string, ModelEntity>

package/src/transform/top.ts

@@ -1,5 +1,5 @@
 
-import { joinurl } from '@voxgig/struct'
+import { join } from '@voxgig/struct'
 
 import { KIT } from '../types'
 
@@ -47,7 +47,7 @@ const topTransform = async function(
   // Swagger 2.0
   if (def.host) {
     kit.info.servers.push({
-      url: (def.schemes?.[0] ?? 'https') + '://' + joinurl([def.host, def.basePath])
+      url: (def.schemes?.[0] ?? 'https') + '://' + join([def.host, def.basePath], '/', true)
     })
   }
 

package/src/utility.ts

@@ -6,7 +6,12 @@ import { snakify, camelify, kebabify, each } from 'jostraca'
 import { decircular } from '@voxgig/util'
 
 import {
-  slice, merge, inject, clone, isnode, walk, transform, select
+  slice, merge, inject, clone, isnode, walk, transform, select,
+  Injection,
+  M_VAL,
+  M_KEYPRE,
+  M_KEYPOST,
+
 } from '@voxgig/struct'
 
 
@@ -17,6 +22,8 @@ import type {
 } from './types'
 
 
+const KONSOLE_LOG = console['log']
+
 
 function makeWarner(spec: { point: string, log: Log }): Warner {
   const { point, log } = spec
@@ -222,26 +229,28 @@ function capture(data: any, shape: any): Record<string, any> {
   })
 
   if (0 < errs.length) {
-    console.log('ERRS', errs)
+    KONSOLE_LOG('ERRS', errs)
     dlog(errs)
   }
   return meta.capture
 }
 
 
-function $CAPTURE(inj: any) {
+function $CAPTURE(inj: Injection) {
   // Set prop foo with value at x: { x: { '`$CAPTURE`': 'foo' } }
-  if ('key:pre' === inj.mode) {
+  if (M_KEYPRE === inj.mode) {
     const { val, prior } = inj
-    const { dparent, key } = prior
-    const dval = dparent?.[key]
-    if (undefined !== dval) {
-      inj.meta.capture[val] = dval
+    if (null != prior) {
+      const { dparent, key } = prior
+      const dval = dparent?.[key]
+      if (undefined !== dval) {
+        inj.meta.capture[val] = dval
+      }
     }
   }
 
   // Use key x as prop name: { x: '`$CAPTURE`': }
-  else if ('val' === inj.mode) {
+  else if (M_VAL === inj.mode) {
     const { key, dparent } = inj
     const dval = dparent?.[key]
     if (undefined !== dval) {
@@ -251,22 +260,28 @@ function $CAPTURE(inj: any) {
 }
 
 
-function $APPEND(inj: any, val: any, ref: any, store: any) {
+function $APPEND(inj: Injection, val: any, ref: any, store: any) {
   // Set prop foo with value at x: { x: { '`$CAPTURE`': 'foo' } }
-  if ('key:pre' === inj.mode) {
+  if (M_KEYPRE === 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)
+    if (null != prior) {
+      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) {
+  else if (M_VAL === inj.mode) {
     inj.keyI = inj.keys.length
 
+    if (null == inj.prior) {
+      return
+    }
+
     const [_, prop, xform] = inj.parent
     const { key, dparent } = inj.prior
     const dval = dparent?.[key]
@@ -291,28 +306,30 @@ function $APPEND(inj: any, val: any, ref: any, store: any) {
 
 
 
-function $ANY(inj: any, _val: any, _ref: any, store: any) {
-  if ('key:pre' === inj.mode) {
+function $ANY(inj: Injection, _val: any, _ref: any, store: any) {
+  if (M_KEYPRE === 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,
-        })
+    if (null != prior) {
+      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) {
+function $SELECT(inj: Injection, _val: any, _ref: any, store: any) {
+  if (M_VAL === inj.mode) {
     inj.keyI = inj.keys.length
 
     let [_, selector, descendor] = inj.parent
@@ -352,8 +369,12 @@ function $SELECT(inj: any, _val: any, _ref: any, store: any) {
 }
 
 
-function $RECASE(inj: any, val: any, ref: any, store: any) {
-  if ('key:pre' === inj.mode) {
+function $RECASE(inj: Injection, val: any, ref: any, store: any) {
+  if (
+    M_KEYPRE === inj.mode
+    && null != inj.prior
+    && null != inj.prior.prior
+  ) {
     const dval = inj.parent[inj.key]
 
     // TODO: handle paths more generally! use inj.prior?
@@ -727,19 +748,22 @@ function warnOnError(where: string, warn: Warner, fn: Function, result?: any) {
 
 function debugpath(pathStr: string, methodName: string | null | undefined, ...args: any[]): void {
   const apipath = process.env.APIDEF_DEBUG_PATH
-  if (!apipath) return
 
-  const [targetPath, targetMethod] = apipath.split(':')
+  if (null == apipath || '' === apipath) return
 
-  // Check if path matches
-  if (pathStr !== targetPath) return
+  if ('ALL' !== apipath) {
+    const [targetPath, targetMethod] = apipath.split(':')
 
-  // If a method is specified in apipath and we have a method name, check if it matches
-  if (targetMethod && methodName) {
-    if (methodName.toLowerCase() !== targetMethod.toLowerCase()) return
+    // Check if path matches
+    if (pathStr !== targetPath) return
+
+    // If a method is specified in apipath and we have a method name, check if it matches
+    if (targetMethod && methodName) {
+      if (methodName.toLowerCase() !== targetMethod.toLowerCase()) return
+    }
   }
 
-  console.log(methodName || '', ...args)
+  KONSOLE_LOG(methodName || '', ...args)
 }
 
 
@@ -807,12 +831,14 @@ function relativizePath(path: string): string {
 }
 
 
+// NOTE: removes inactive items by default
 function getModelPath(
   model: any,
   path: string,
-  flags?: { required?: boolean }
+  flags?: { required?: boolean, only_active?: boolean }
 ): any {
   const required = flags?.required ?? true
+  const only_active = flags?.only_active ?? true
 
   if (path === '') {
     if (required) {
@@ -876,6 +902,26 @@ function getModelPath(
     current = current[part]
   }
 
+  if (current && only_active) {
+    if (false === current.active) {
+      current = undefined
+    }
+    if ('object' === typeof current) {
+      const out: any = Array.isArray(current) ? [] : {}
+      Object.entries(current).map((n: any) => {
+        if (null != n[1] && false !== n[1].active) {
+          if (Array.isArray(out)) {
+            out.push(n[1])
+          }
+          else {
+            out[n[0]] = n[1]
+          }
+        }
+      })
+      current = out
+    }
+  }
+
   return current
 }