@voxgig/apidef 1.8.0 → 2.0.0

package/dist/utility.d.ts

@@ -0,0 +1,4 @@
+import type { FsUtil, Log } from './types';
+declare function loadFile(path: string, what: string, fs: FsUtil, log: Log): string;
+declare function formatJsonSrc(jsonsrc: string): string;
+export { loadFile, formatJsonSrc };

package/dist/utility.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadFile = loadFile;
+exports.formatJsonSrc = formatJsonSrc;
+const node_path_1 = __importDefault(require("node:path"));
+function loadFile(path, what, fs, log) {
+    try {
+        const source = fs.readFileSync(path, 'utf8');
+        return source;
+    }
+    catch (err) {
+        log.error({ load: 'fail', what, path, err });
+        throw err;
+    }
+}
+function formatJsonSrc(jsonsrc) {
+    return jsonsrc
+        .replace(/"([a-zA-Z_][a-zA-Z_0-9]*)": /g, '$1: ')
+        .replace(/},/g, '}\n');
+}
+function writeChanged(point, path, content, fs, log, flags) {
+    let exists = false;
+    let changed = false;
+    flags = flags || {};
+    flags.update = null == flags.update ? true : !!flags.update;
+    let action = '';
+    try {
+        let existingContent = '';
+        path = node_path_1.default.normalize(path);
+        exists = fs.existsSync(path);
+        if (exists) {
+            action = 'read';
+            existingContent = fs.readFileSync(path, 'utf8');
+        }
+        changed = existingContent !== content;
+        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
+        });
+        if (!exists || (changed && flags.update)) {
+            fs.writeFileSync(path, content);
+        }
+    }
+    catch (err) {
+        log.error({
+            fail: action, point, file: path, exists, changed,
+            contentLength: content.length, err
+        });
+        err.__logged__ = true;
+        throw err;
+    }
+}
+//# sourceMappingURL=utility.js.map

package/dist/utility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility.js","sourceRoot":"","sources":["../src/utility.ts"],"names":[],"mappings":";;;;;AA+EE,4BAAQ;AACR,sCAAa;AA/Ef,0DAA4B;AAS5B,SAAS,QAAQ,CAAC,IAAY,EAAE,IAAY,EAAE,EAAU,EAAE,GAAQ;IAChE,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAC5C,OAAO,MAAM,CAAA;IACf,CAAC;IACD,OAAO,GAAQ,EAAE,CAAC;QAChB,GAAG,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAA;QAC5C,MAAM,GAAG,CAAA;IACX,CAAC;AACH,CAAC;AAGD,SAAS,aAAa,CAAC,OAAe;IACpC,OAAO,OAAO;SACX,OAAO,CAAC,+BAA+B,EAAE,MAAM,CAAC;SAChD,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;AAC1B,CAAC;AAGD,SAAS,YAAY,CACnB,KAAa,EAAE,IAAY,EAAE,OAAe,EAC5C,EAAU,EAAE,GAAQ,EACpB,KAA4B;IAE5B,IAAI,MAAM,GAAG,KAAK,CAAA;IAClB,IAAI,OAAO,GAAG,KAAK,CAAA;IAEnB,KAAK,GAAG,KAAK,IAAI,EAAE,CAAA;IACnB,KAAK,CAAC,MAAM,GAAG,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAA;IAE3D,IAAI,MAAM,GAAG,EAAE,CAAA;IACf,IAAI,CAAC;QACH,IAAI,eAAe,GAAW,EAAE,CAAA;QAChC,IAAI,GAAG,mBAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAE3B,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QAE5B,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,GAAG,MAAM,CAAA;YACf,eAAe,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QACjD,CAAC;QAED,OAAO,GAAG,eAAe,KAAK,OAAO,CAAA;QAErC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAA;QAExC,GAAG,CAAC,IAAI,CAAC;YACP,KAAK,EAAE,QAAQ,GAAG,KAAK;YACvB,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,UAAU,GAAG,IAAI;YACjD,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO;YAC9C,aAAa,EAAE,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI;SAC1C,CAAC,CAAA;QAEF,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACzC,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACjC,CAAC;IACH,CAAC;IACD,OAAO,GAAQ,EAAE,CAAC;QAChB,GAAG,CAAC,KAAK,CAAC;YACR,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO;YAChD,aAAa,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG;SACnC,CAAC,CAAA;QACF,GAAG,CAAC,UAAU,GAAG,IAAI,CAAA;QACrB,MAAM,GAAG,CAAA;IACX,CAAC;AACH,CAAC"}

package/model/apidef.jsonic

@@ -1,33 +1,36 @@
 
-main: api: guide: control: transform: &: {
-  order: string
-}
-
-main: api: guide: control: transform: openapi: {
-  order: *`
+main: api: guide: control: {
+
+  transform: openapi: {
+    order: *`
+      top,
+      entity,
+      operation,
+      field,
+      ` | string,
+
+    element: {
+      top: {}
+      entity: {}
+      operation: {}
+      field: {}
+    }
+  }
 
-  top,
-  entity,
-  operation,
-  field,
-  manual,
-  
-  ` | string
-}
+  builder: standard: {
+    order: *`
+      entity,
+      flow,
+      ` | string,
 
+    element: {
+      entity: {}
+      flow: {}
+    }
+  }
 
-main: api: guide: transform: &: {
-  name: .$KEY
-  load: string
 }
 
-main: api: guide: transform: {
-  top: {}
-  entity: {}
-  operation: {}
-  field: {}
-  manual: {}
-}
 
 
 main: api: guide: entity: &: {
@@ -46,3 +49,4 @@ main: api: guide: entity: &: {
 
 
 
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voxgig/apidef",
-  "version": "1.8.0",
+  "version": "2.0.0",
   "main": "dist/apidef.js",
   "type": "commonjs",
   "types": "dist/apidef.d.ts",
@@ -19,13 +19,13 @@
     "voxgig-apidef": "bin/voxgig-apidef"
   },
   "scripts": {
-    "test": "node --enable-source-maps --test dist-test",
-    "test22": "node --enable-source-maps --test \"dist-test/*.test.js\"",
-    "test-some": "node --enable-source-maps --test-name-pattern=\"$npm_config_pattern\" --test dist-test",
+    "test": "node --enable-source-maps --test \"dist-test/**/*.test.js\"",
+    "test-some": "node --enable-source-maps --test-name-pattern=\"$npm_config_pattern\" --test \"dist-test/**/*.test.js\"",
     "watch": "tsc --build src test -w",
     "build": "tsc --build src test",
     "clean": "rm -rf dist dist-test node_modules yarn.lock package-lock.json",
     "reset": "npm run clean && npm i && npm run build && npm test",
+    "postinstall": "patch-package",
     "repo-tag": "REPO_VERSION=`node -e \"console.log(require('./package').version)\"` && echo TAG: v$REPO_VERSION && git commit -a -m v$REPO_VERSION && git push && git tag v$REPO_VERSION && git push --tags;",
     "repo-publish": "npm run clean && npm i && npm run repo-publish-quick",
     "repo-publish-quick": "npm run build && npm run test && npm run repo-tag && npm publish --registry https://registry.npmjs.org --access=public"
@@ -41,20 +41,22 @@
   "devDependencies": {
     "@hapi/code": "^9.0.3",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "22.15.17",
+    "@types/node": "24.0.7",
     "aontu": "^0.28.0",
-    "esbuild": "^0.25.4",
+    "esbuild": "^0.25.5",
     "json-schema-to-ts": "^3.1.1",
-    "memfs": "^4.17.1",
+    "memfs": "^4.17.2",
+    "patch-package": "^8.0.0",
     "typescript": "^5.8.3"
   },
   "dependencies": {
     "@redocly/openapi-core": "^1.34.3",
+    "@voxgig/struct": "^0.0.3",
     "@voxgig/util": "^0.0.10",
     "chokidar": "^4.0.3",
     "gubu": "^9.0.0",
-    "jostraca": "^0.18.0",
-    "pino": "^9.6.0",
+    "jostraca": "^0.20.0",
+    "pino": "^9.7.0",
     "pino-pretty": "^13.0.0",
     "sonic-boom": "^4.2.0"
   }

package/src/apidef.ts

@@ -1,13 +1,35 @@
-/* Copyright (c) 2024 Voxgig, MIT License */
+/* Copyright (c) 2024-2025 Voxgig, MIT License */
 
 import * as Fs from 'node:fs'
 import Path from 'node:path'
 import { inspect } from 'node:util'
 
-import { bundleFromString, createConfig } from '@redocly/openapi-core'
-import { Gubu, Open, Any } from 'gubu'
-import { each } from 'jostraca'
-import { prettyPino, Pino } from '@voxgig/util'
+import { Jostraca, Project, names } from 'jostraca'
+
+import { prettyPino } from '@voxgig/util'
+
+
+import type {
+  ApiDefOptions,
+  Model,
+  Build,
+  ApiModel,
+} from './types'
+
+import {
+  OpenModelShape,
+  OpenBuildShape,
+} from './types'
+
+
+import {
+  resolveGuide,
+} from './guide'
+
+
+import {
+  parse
+} from './parse'
 
 
 import {
@@ -17,76 +39,55 @@ import {
 } from './transform'
 
 
-type ApiDefOptions = {
-  def?: string
-  fs?: any
-  pino?: ReturnType<typeof Pino>
-  debug?: boolean | string
-  folder?: string
-  meta?: Record<string, any>
-  outprefix?: string
-}
-
 
-type ApiModel = {
-  main: {
-    api: {
-      entity: Record<string, any>
-    }
-    def: Record<string, any>
-  }
-}
+import {
+  resolveElements
+} from './resolver'
 
+import {
+  loadFile,
+} from './utility'
 
-const ModelShape = Gubu({
-  def: String,
-  main: {
-    sdk: {},
-    def: {},
-    api: {},
-  }
-})
-const OpenModelShape = Gubu(Open(ModelShape))
-
-type Model = ReturnType<typeof ModelShape>
-
-
-const BuildShape = Gubu({
-  spec: {
-    base: '',
-    path: '',
-    debug: '',
-    use: {},
-    res: [],
-    require: '',
-    log: {},
-    fs: Any(),
-    watch: {
-      mod: true,
-      add: true,
-      rem: true,
-    }
-  }
-})
-const OpenBuildShape = Gubu(Open(BuildShape))
 
-type Build = ReturnType<typeof BuildShape>
+import { topTransform } from './transform/top'
+import { entityTransform } from './transform/entity'
+import { operationTransform } from './transform/operation'
+import { fieldTransform } from './transform/field'
 
+import { makeEntityBuilder } from './builder/entity'
+import { makeFlowBuilder } from './builder/flow'
 
 
 function ApiDef(opts: ApiDefOptions) {
+
+  // TODO: gubu opts!
   const fs = opts.fs || Fs
   const pino = prettyPino('apidef', opts)
-
   const log = pino.child({ cmp: 'apidef' })
 
+  opts.strategy = opts.strategy || 'heuristic01'
+
 
   async function generate(spec: any) {
     const start = Date.now()
 
+    // console.log('APIDEF GENERATE')
+    // console.dir(spec, { depth: null })
+
     const model: Model = OpenModelShape(spec.model)
     const build: Build = OpenBuildShape(spec.build)
 
+    names(model, model.name)
+
+    const apimodel: ApiModel = {
+      main: {
+        api: {
+          entity: {}
+        },
+        def: {},
+      },
+    }
+
     const buildspec = build.spec
 
     let defpath = model.def
@@ -101,214 +102,96 @@ function ApiDef(opts: ApiDefOptions) {
 
     // TODO: Validate spec
     const ctx = {
+      fs,
       log,
       spec,
       opts,
       util: { fixName },
       defpath: Path.dirname(defpath),
       model,
-    }
-
-    const transformSpec = await resolveTransforms(ctx)
-
-    log.debug({
-      point: 'transform', spec: transformSpec,
-      note: log.levelVal <= 20 ? inspect(transformSpec) : ''
-    })
-
-
-    let source
-    try {
-      source = fs.readFileSync(defpath, 'utf8')
-    }
-    catch (err: any) {
-      log.error({ read: 'fail', what: 'def', file: defpath, err })
-      throw err
-    }
-
-
-    const config = await createConfig({})
-    let bundle
-
-    try {
-      bundle = await bundleFromString({
-        source,
-        config,
-        dereference: true,
-      })
-    }
-    catch (err: any) {
-      log.error({ parse: 'fail', what: 'openapi', file: defpath, err })
-      throw err
-    }
-
-
-    const apimodel: ApiModel = {
-      main: {
-        api: {
-          entity: {}
-        },
-        def: {},
-      },
-    }
-
-    const def = bundle.bundle.parsed
-    const processResult = await processTransforms(ctx, transformSpec, apimodel, def)
-
-    if (!processResult.ok) {
-      log.error({
-        fail: 'process', point: 'transform-result',
-        result: processResult, note: processResult.msg,
-        err: processResult.results[0]?.err
-      })
-
-      return { ok: false, name: 'apidef', processResult }
-    }
-
-
-    const modelPath = Path.normalize(spec.config.model)
-
-    buildModel_api(apimodel, modelPath)
-    buildModel_def(apimodel, modelPath)
-    buildModel_entity(apimodel, modelPath)
-
-    log.info({ point: 'generate-end', note: 'success', break: true })
-
-    return {
-      ok: true,
-      name: 'apidef',
       apimodel,
+      def: undefined
     }
-  }
-
-
-  function buildModel_api(apimodel: ApiModel, modelPath: string) {
-    const modelapi = { main: { api: apimodel.main.api } }
-    let modelSrc = JSON.stringify(modelapi, null, 2)
-
-    modelSrc =
-      '# GENERATED FILE - DO NOT EDIT\n\n' +
-      modelSrc.substring(1, modelSrc.length - 1).replace(/\n  /g, '\n')
-
-    writeChanged('api-model', modelPath, modelSrc)
-    return modelPath
-  }
-
-
-  function buildModel_def(apimodel: ApiModel, modelPath: string) {
-    const modelBasePath = Path.dirname(modelPath)
-    const defFilePath = Path.join(modelBasePath,
-      (null == opts.outprefix ? '' : opts.outprefix) + 'def-generated.jsonic')
-
-    const modelDef = { main: { def: apimodel.main.def } }
-    let modelDefSrc = JSON.stringify(modelDef, null, 2)
-
-    modelDefSrc =
-      '# GENERATED FILE - DO NOT EDIT\n\n' +
-      modelDefSrc.substring(1, modelDefSrc.length - 1).replace(/\n  /g, '\n')
-
-    writeChanged('def-model', defFilePath, modelDefSrc)
-  }
 
+    const defsrc = loadFile(defpath, 'def', fs, log)
 
-  function buildModel_entity(apimodel: ApiModel, modelPath: string) {
-    const modelBasePath = Path.dirname(modelPath)
+    const def = await parse('OpenAPI', defsrc, { file: defpath })
+    ctx.def = def
 
-    const entityIncludes: string[] = []
+    const guideBuilder = await resolveGuide(ctx)
 
-    each(apimodel.main.api.entity, ((entity: any) => {
-      entityIncludes.push(entity.name)
 
-      // HEURISTIC: id may be name_id or nameId
-      const fieldAliases =
-        each(entity.op, (op: any) =>
-          each(op.param))
-          .flat()
-          .reduce((a: any, p: any) =>
-
-          (entity.field[p.keys] ? null :
-            (p.key$.toLowerCase().includes(entity.name) ?
-              (a[p.key$] = 'id', a.id = p.key$) :
-              null)
-
-            , a), {})
+    // const transformSpec = await resolveTransforms(ctx)
+    const transforms = await resolveElements(ctx, 'transform', 'openapi', {
+      top: topTransform,
+      entity: entityTransform,
+      operation: operationTransform,
+      field: fieldTransform,
+    })
 
-      const fieldAliasesSrc =
-        JSON.stringify(fieldAliases, null, 2)
-          .replace(/\n/g, '\n  ')
+    // log.debug({
+    //   point: 'transform', spec: transformSpec,
+    //   note: log.levelVal <= 20 ? inspect(transformSpec) : ''
+    // })
 
-      const entityFileSrc = `
-# Entity ${entity.name}
+    // const processResult = await processTransforms(ctx, transforms, apimodel, def)
 
-main: sdk: entity: ${entity.name}: {
-  alias: field: ${fieldAliasesSrc}
-}
+    // if (!processResult.ok) {
+    //   log.error({
+    //     fail: 'process', point: 'transform-result',
+    //     result: processResult, note: processResult.msg,
+    //     err: processResult.results[0]?.err
+    //   })
 
-`
-      const entityFilePath = Path.join(modelBasePath, 'entity',
-        (null == opts.outprefix ? '' : opts.outprefix) + entity.name + '.jsonic')
+    //   return { ok: false, name: 'apidef', processResult }
+    // }
 
-      fs.mkdirSync(Path.dirname(entityFilePath), { recursive: true })
 
-      // TODO: diff merge
-      writeChanged('entity-model', entityFilePath, entityFileSrc, { update: false })
-    }))
+    const builders = await resolveElements(ctx, 'builder', 'standard', {
+      entity: makeEntityBuilder,
+      flow: makeFlowBuilder,
+    })
 
 
-    modifyModel(
-      fs,
-      Path.join(
-        modelBasePath,
-        (null == opts.outprefix ? '' : opts.outprefix) + 'sdk.jsonic'),
-      entityIncludes
-    )
-  }
 
+    // const entityBuilder = resolveEntity(apimodel, spec, opts)
 
-  function writeChanged(
-    point: string, path: string, content: string,
-    flags?: { update?: boolean }
-  ) {
-    let exists = false
-    let changed = false
+    // const entityBuilder = await resolveEntity(ctx)
+    // const flowBuilder = await resolveFlows(ctx)
 
-    flags = flags || {}
-    flags.update = null == flags.update ? true : !!flags.update
+    const jostraca = Jostraca({
+      now: spec.now,
+      fs: () => fs,
+      log,
+    })
 
-    let action = ''
-    try {
-      let existingContent: string = ''
-      path = Path.normalize(path)
+    const jmodel = {}
 
-      exists = fs.existsSync(path)
+    const root = () => Project({ folder: '.' }, async () => {
+      guideBuilder()
+      // entityBuilder()
+      // flowBuilder()
 
-      if (exists) {
-        action = 'read'
-        existingContent = fs.readFileSync(path, 'utf8')
+      for (let builder of builders) {
+        builder()
       }
+    })
 
-      changed = existingContent !== content
+    const jres = await jostraca.generate({
+      // folder: Path.dirname(opts.folder as string),
+      folder: opts.folder,
+      model: jmodel,
+      existing: { txt: { merge: true } }
+    }, root)
 
-      action = flags.update ? 'write' : 'skip'
+    // console.log('JRES', jres)
 
-      log.info({
-        point: 'write-' + point,
-        note: (changed ? '' : 'not-') + 'changed ' + path,
-        write: 'file', skip: !changed, exists, changed,
-        contentLength: content.length, file: path
-      })
+    log.info({ point: 'generate-end', note: 'success', break: true })
 
-      if (!exists || (changed && flags.update)) {
-        fs.writeFileSync(path, content)
-      }
-    }
-    catch (err: any) {
-      log.error({
-        fail: action, point, file: path, exists, changed,
-        contentLength: content.length, err
-      })
-      err.__logged__ = true
-      throw err
+    return {
+      ok: true,
+      name: 'apidef',
+      apimodel,
     }
   }
 
@@ -318,17 +201,14 @@ main: sdk: entity: ${entity.name}: {
 }
 
 
-
 ApiDef.makeBuild = async function(opts: ApiDefOptions) {
   let apidef: any = undefined
 
-  const outprefix = null == opts.outprefix ? '' : opts.outprefix
+  // const outprefix = null == opts.outprefix ? '' : opts.outprefix
 
   const config = {
     def: opts.def || 'no-def',
     kind: 'openapi3',
-    model: opts.folder ?
-      (opts.folder + '/' + outprefix + 'api-generated.jsonic') : 'no-model',
     meta: opts.meta || {},
   }
 
@@ -351,41 +231,15 @@ ApiDef.makeBuild = async function(opts: ApiDefOptions) {
 
 
 
-async function modifyModel(fs: any, path: string, entityIncludes: string[]) {
-  // TODO: This is a kludge.
-  // Aontu should provide option for as-is AST so that can be used
-  // to find injection point more reliably
-
-
-  let src = fs.existsSync(path) ? fs.readFileSync(path, 'utf8') :
-    'main: sdk: entity: {}\n'
-
-  let newsrc = '' + src
-
-  // Inject target file references into model
-  entityIncludes.sort().map((entname: string) => {
-    const lineRE =
-      new RegExp(`@"entity/${entname}.jsonic"`)
-
-    if (!src.match(lineRE)) {
-      newsrc = newsrc.replace(/(main:\s+sdk:\s+entity:\s+\{\s*\}\n)/, '$1' +
-        `@"entity/${entname}.jsonic"\n`)
-    }
-  })
-
-  if (newsrc.length !== src.length) {
-    fs.writeFileSync(path, newsrc)
-  }
-}
 
 
 
 export type {
   ApiDefOptions,
-  // ApiDefSpec,
 }
 
 
 export {
   ApiDef,
+  parse,
 }