@voxgig/create-sdkgen 0.1.1 → 0.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voxgig/create-sdkgen",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "main": "dist/create-sdkgen.js",
   "type": "commonjs",
   "types": "dist/create-sdkgen.d.ts",
@@ -37,7 +37,7 @@
     "src",
     "dist",
     "bin",
-    "tm",
+    "project",
     "LICENSE"
   ],
   "devDependencies": {

package/project/standard/.env.local

@@ -0,0 +1 @@
+PROJECTNAME_APIKEY=<apikey>

package/project/standard/.sdk/build/apidef.js

@@ -0,0 +1,8 @@
+
+const { ApiDef } = require('@voxgig/apidef')
+
+const opts = {
+  folder: __dirname + '/../model',
+}
+
+module.exports = ApiDef.makeBuild(opts)

package/project/standard/.sdk/build/docgen.js

@@ -0,0 +1,15 @@
+
+const { DocGen } = require('@voxgig/docgen')
+
+const config = {
+  root: __dirname+'/../dist/DocStaticRoot.js',
+  folder: __dirname+'/../../doc',
+  meta: {
+    name: '$$name$$'
+  },
+  model: {
+    folder: __dirname+'/../model',
+  },
+}
+
+module.exports = DocGen.makeBuild(config)

package/project/standard/.sdk/build/sdkgen.js

@@ -0,0 +1,16 @@
+
+const { SdkGen } = require('@voxgig/sdkgen')
+
+const config = {
+  root: __dirname+'/../dist/Root.js',
+  folder: __dirname+'/../..',
+  meta: {
+    name: '$$name$$'
+  },
+  model: {
+    folder: __dirname+'/../model',
+  },
+  existing: { txt: { merge: true } },
+}
+
+module.exports = SdkGen.makeBuild(config)

package/project/standard/.sdk/def/README.md

@@ -0,0 +1,4 @@
+# API Definition
+ 
+API definition (OpenAPI etc) files live here.
+

package/project/standard/.sdk/model/.model-config/model-config.jsonic

@@ -0,0 +1,17 @@
+
+
+@'@voxgig/model/model/.model-config/model-config.jsonic'
+
+sys: model: builders: {
+  apidef: load: 'build/apidef.js'
+  sdkgen: load: 'build/sdkgen.js'
+  // docgen: load: 'build/docgen.js'
+}
+
+sys: model: watch: {
+  'src': {}   # To catch fragment updates.
+  'dist': {}
+  'tm': {}
+  'def': {}
+  # 'doc/static/src': {}
+}

package/project/standard/.sdk/model/.model-config/model-config.jsonic~

@@ -0,0 +1,16 @@
+
+
+@'@voxgig/model/model/.model-config/model-config.jsonic'
+
+sys: model: builders: {
+  apidef: load: 'build/apidef.js'
+  sdkgen: load: 'build/sdkgen.js'
+  // docgen: load: 'build/docgen.js'
+}
+
+sys: model: watch: {
+  'dist': {}
+  'tm': {}
+  'def': {}
+  # 'doc/static/src': {}
+}

package/project/standard/.sdk/model/README.md

@@ -0,0 +1,2 @@
+# SDK Model Definition
+

package/project/standard/.sdk/model/api/api-def.jsonic

@@ -0,0 +1,5 @@
+# API Definition
+
+main: def: {}
+
+

package/project/standard/.sdk/model/api/api-entity-index.jsonic

@@ -0,0 +1,2 @@
+# Entity Models
+

package/project/standard/.sdk/model/config.jsonic

@@ -0,0 +1,13 @@
+# SDK Configuration
+
+main: sdk: config: {
+
+  # Authorization header token value prefix
+  auth: prefix: 'Bearer'
+
+
+  headers: {
+    'content-type': 'application/json'
+  }
+
+}

package/project/standard/.sdk/model/feature/README.md

@@ -0,0 +1,2 @@
+# Feature Model Defintions
+

package/project/standard/.sdk/model/feature/feature-index.jsonic

@@ -0,0 +1,3 @@
+# Features
+
+

package/project/standard/.sdk/model/flow/flow-index.jsonic

@@ -0,0 +1,2 @@
+# Operational Flows
+

package/project/standard/.sdk/model/guide.jsonic

@@ -0,0 +1,5 @@
+# Guide
+
+main: api: guide: {}
+
+

package/project/standard/.sdk/model/sdk.fragment.jsonic

@@ -0,0 +1,38 @@
+
+# Generation guide.
+@"guide.jsonic"
+
+
+# Model definitions.
+@"@voxgig/apidef/model/apidef.jsonic"
+@"@voxgig/sdkgen/model/sdkgen.jsonic"
+
+
+# SDK Details.
+name: 'NAME'
+def: 'DEF'
+
+
+# API Definition
+@"api/api-def.jsonic"
+
+
+# API Entities
+@"api/api-entity-index.jsonic"
+
+
+# SDK Configuration.
+@"config.jsonic"
+
+
+# SDK Features.
+@"feature/feature-index.jsonic"
+ 
+
+# SDK Targets.
+@"target/target-index.jsonic"
+
+
+# Operation workflows.
+@"flow/flow-index.jsonic"
+

package/project/standard/.sdk/model/target/README.md

@@ -0,0 +1,2 @@
+# Language Model Defintions
+

package/project/standard/.sdk/model/target/target-index.jsonic

@@ -0,0 +1,2 @@
+# SDK Targets.
+

package/project/standard/.sdk/model/target/target-index.jsonic~

@@ -0,0 +1,4 @@
+# SDK Targets.
+
+@"ts.jsonic"
+

package/project/standard/.sdk/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "build-$$const.name$$-sdk",
+  "version": "0.0.1",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "model": "voxgig-model model/sdk.jsonic",
+    "model-watch": "voxgig-model -w model/sdk.jsonic",
+    "test-model": "voxgig-model test/test.jsonic",
+    "test-model-watch": "voxgig-model -w test/test.jsonic",
+    "watch": "tsc --build src -w",
+    "build": "tsc --build src",
+    "test": "echo no-test",
+    "clean": "rm -rf node_modules yarn.lock package-lock.json",
+    "reset": "npm run clean && npm i && npm run build && npm test",
+    "add-target": "voxgig-sdkgen target add $npm_config_target",
+    "add-feature": "voxgig-sdkgen feature add $npm_config_feature"
+  },
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": ">=24",
+    "typescript": ">=5",
+    "patch-package": ">=8"
+  },
+  "dependencies": {
+    "@voxgig/apidef": ">=2",
+    "@voxgig/model": ">=7",
+    "@voxgig/sdkgen": ">=0",
+    "@voxgig/util": ">=0",
+    "@voxgig/struct": ">=0",
+    "jostraca": ">=0"
+  }
+}

package/project/standard/.sdk/src/DocStaticRoot.ts

@@ -0,0 +1,45 @@
+
+// import {
+//   names,
+//   cmp,
+//   each,
+
+//   Project,
+//   Folder,
+
+//   Index,
+// } from '@voxgig/docgen'
+
+import {
+  cmp,
+} from '@voxgig/sdkgen'
+
+
+const Root = cmp(function Root(props: any) {
+
+  /*
+  const { model, ctx$ } = props
+
+
+  model.const = { name: model.name }
+
+  names(model.const, model.name)
+
+  model.const.year = new Date().getFullYear()
+
+
+  ctx$.model = model
+
+  Project({}, () => {
+
+    Index({})
+
+    })
+    */
+})
+
+
+export {
+  Root
+}
+

package/project/standard/.sdk/src/Root.ts

@@ -0,0 +1,228 @@
+
+import {
+  names,
+  cmp,
+  each,
+  getx,
+
+  Project,
+  Folder,
+
+  Main,
+  Entity,
+  Feature,
+  Readme,
+
+} from '@voxgig/sdkgen'
+
+
+import { transform, select, ismap } from '@voxgig/struct'
+
+import { PointUtil, Content } from 'jostraca'
+
+const {
+  buildPoints,
+  SerialPoint,
+} = PointUtil
+
+
+
+const Root = cmp(function Root(props: any) {
+  const { model, ctx$ } = props
+
+  ctx$.util = ctx$.util || {}
+  ctx$.util.makeFlow = makeFlow
+
+  // TODO: move to @voxgig/util as duplicated
+  model.const = { name: model.name }
+  names(model.const, model.name)
+  model.const.year = new Date().getFullYear()
+
+  ctx$.model = model
+
+  const target = model.main.sdk.target || {}
+  const feature = model.main.sdk.feature || {}
+  const entity = model.main.api.entity || {}
+
+  ctx$.log.debug({
+    point: 'cmp-root', target, entity, feature, note: [
+      '\ntarget: \n' + Object.keys(target).map(s => '  ' + s).join('\n'),
+      '\nentity:\n' + Object.keys(entity).map(s => '  ' + s).join('\n'),
+      '\nfeature:\n' + Object.keys(feature).map(s => '  ' + s).join('\n'),
+    ].join('\n')
+  })
+
+  names(model, model.name)
+  // console.log('MODEL name', model.name, model.Name)
+
+  // Standard Replacements
+  ctx$.stdrep = {}
+  names(ctx$.stdrep, model.Name, 'ProjectName')
+  // console.log('STDREP', stdrep)
+
+  Project({}, () => {
+
+    each(target, (target: any) => {
+      names(target, target.name)
+
+      Folder({ name: target.name }, () => {
+
+        each(entity, (entity: any) => {
+          names(entity, entity.name)
+          Entity({ target, entity })
+        })
+
+        // each(feature).filter((feature: any) => feature.active).map((feature: any) => {
+        each(feature).filter((feature: any) => feature.active).map((feature: any) => {
+          names(feature, feature.name)
+          Feature({ target, feature })
+        })
+
+        Main({ target })
+
+        Readme({ target })
+
+      })
+    })
+
+  })
+})
+
+
+function makeFlow(def: any, data: any, stepMakers: Record<string, any>) {
+
+  const steps: any = {}
+  each(stepMakers, (n: any) => {
+    // TODO: support after?
+    if ('function' === typeof n.val$) {
+      steps[n.key$] = (id: any, pdef: any) => makeFlowStep(id(), pdef, n.val$)
+    }
+    else if ('string' === typeof n.val$) {
+      steps[n.key$] = (id: any, pdef: any) => makeFlowStep(id(), pdef, (sd: any, pctx: any) => {
+        Content({
+          indent: pctx.data.indent,
+          extra: {
+            __stepdef: sd
+          },
+        }, n.val$)
+      })
+    }
+    else if (Array.isArray(n)) {
+      steps[(n as any).key$] =
+        (id: any, pdef: any) => makeFlowStep(id(), pdef, (sd: any, pctx: any) => {
+          const extra = {
+            __stepdef: sd
+          }
+          for (let tmdef of n) {
+            let tmtxt
+            if ('string' === typeof tmdef) {
+              tmtxt = tmdef
+            }
+            else if (Array.isArray(tmdef)) {
+              let pass = true
+              let cond = tmdef[0]
+              tmtxt = tmdef[1]
+
+              if ('string' === typeof cond) {
+                pass = (null != getx(extra, tmdef[0]) || null != getx(pctx.data.model, tmdef[0]))
+              }
+              else if (ismap(cond)) {
+                let children = [{ ...pctx.data.model, ...extra }]
+                let found = select(
+                  children,
+                  cond
+                )
+                pass = 0 < found.length
+              }
+
+              if (!pass) {
+                tmtxt = tmdef[2]
+              }
+            }
+            else if ('function' === typeof tmdef) {
+              tmdef(sd, pctx)
+            }
+
+            if (null != tmtxt) {
+              Content({
+                indent: pctx.data.indent,
+                extra,
+              }, tmtxt)
+            }
+          }
+        })
+    }
+  })
+
+  each(def.step, (step: any) => {
+    names(step, step.entity, 'entity')
+  })
+
+  // console.log('STEPS', stepMakers, steps, def)
+
+  const spec = transform(def, {
+    p: ['`$EACH`', 'step', {
+      k: 'FlowStep',
+      a: '`.`',
+      p: [
+        { k: 'GetEntity', a: '`...`' },
+        { k: 'EntityMatch', a: '`...`' },
+        { k: 'EntityData', a: '`...`' },
+        { k: 'EntityAction', a: '`...`' },
+        { k: 'ExplainAction', a: '`...`' },
+        { k: 'ValidateAction', a: '`...`' },
+      ]
+    }]
+  })
+
+  const rootPoint = buildPoints(spec, steps) as any
+
+  data = data || {}
+  data.step = {}
+
+  rootPoint.direct(data)
+}
+
+
+function makeFlowStep(
+  id: string,
+  pdef: any,
+  before: any,
+  after?: any,
+  _parent?: any
+): any {
+
+  class FlowStep extends SerialPoint {
+    pdef: any
+
+    constructor(id: string, pdef: any) {
+      super(id)
+      this.pdef = pdef
+    }
+
+    async run(pctx: any): Promise<void> {
+      const stepdef = pdef.a
+      if (stepdef.ref) {
+        const refstep = pctx.data.step[stepdef.ref]
+        stepdef.kind = refstep.kind
+        stepdef.entity = refstep.entity
+        stepdef._ref = stepdef.ref
+        delete stepdef.ref
+      }
+
+      before.call(this, stepdef, pctx)
+      super.run(pctx)
+      after && after.call(this, stepdef, pctx)
+    }
+  }
+
+  return new FlowStep(id, pdef)
+}
+
+
+
+
+export {
+  Root
+}
+

package/project/standard/.sdk/src/cmp/README.md

@@ -0,0 +1,2 @@
+# Target builder components
+

package/project/standard/.sdk/src/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "module": "nodenext",
+    "noEmitOnError": true,
+    "outDir":"../dist",
+    "rootDir":".",
+    "resolveJsonModule": true,
+    "sourceMap": true,
+    "strict": true,
+    "target": "es2021",
+    "declaration": true,
+    "declarationDir": "../dist"
+  },
+  "exclude": ["**/fragment/*.fragment.ts"]
+}

package/project/standard/.sdk/test/.model-config/model-config.json

@@ -0,0 +1,7 @@
+{
+  "sys": {
+    "model": {
+      "builders": {}
+    }
+  }
+}

package/project/standard/.sdk/test/.model-config/model-config.jsonic

@@ -0,0 +1,4 @@
+
+@"@voxgig/model/model/.model-config/model-config.jsonic"
+
+sys: model: builders: {}

package/project/standard/.sdk/test/primary/auth.jsonic

@@ -0,0 +1,20 @@
+
+DEF: {
+  client: a: test: options: { apikey: 'APIKEY01' }
+  client: b: test: options: {}
+}
+
+
+basic: set: [
+
+  { ctx: spec:headers:{}
+    client: a
+    match: out:headers:authorization:'Bearer APIKEY01'
+  }
+
+  # { ctx: spec:headers:{}
+  #   client: b
+  #   match: out:headers:authorization:'__UNDEF__' }
+
+]
+

package/project/standard/.sdk/test/primary/body.jsonic

@@ -0,0 +1,27 @@
+
+basic: set: [
+  {
+    ctx: {
+      op:kind:req, op:reqform:'`data.foo`', op:check:nobody:true
+      op:data:foo:{x:1}
+    }
+    out: {x:1}
+  }
+
+  {
+    ctx: {
+      op:kind:req, op:reqform:'`data.bar`', op:check:nobody:false
+      op:data:foo:{x:2}
+    }
+  }
+
+  {
+    ctx: {
+      op:kind:req, op:reqform:'`data.bar`', op:check:nobody:true
+      op:data:foo:{x:3}
+    }
+    err: 'empty'
+  }
+
+]
+

package/project/standard/.sdk/test/primary/contextify.jsonic

@@ -0,0 +1,5 @@
+
+basic: set: [
+  { in:{op:{kind:req}}, match:out:{op:{kind:req}} }
+]
+

package/project/standard/.sdk/test/primary/done.jsonic

@@ -0,0 +1,7 @@
+
+basic: set: [
+  { ctx:{result:{ok:true,resdata:{x:1}}}, out:{x:1} }
+
+  { ctx:{result:{ok:false}}, err:'unknown operation: unknown error' }
+]
+

package/project/standard/.sdk/test/primary/error.jsonic

@@ -0,0 +1,19 @@
+
+basic: set: [
+  { args:[], err:'SDK: unknown operation: unknown error' }
+  { args:[{}], err:'SDK: unknown operation: unknown error' }
+  { args:[{},{}], err:'SDK: unknown operation: unknown error' }
+
+  { args:[{op:{}}], err:'SDK: unknown operation: unknown error' }
+  { args:[{op:name:foo}], err:'SDK: foo: unknown error' }
+  { args:[{op:name:foo,result:{}}], err:'SDK: foo: unknown error' }
+
+  { args:[{op:name:foo,result:{err:message:bar}}], err:'SDK: foo: bar' }
+  { args:[{op:name:foo}, {message:zed}], err:'SDK: foo: zed' }
+
+  { args:[{op:name:o0}, {message:e0}], err:'SDK: o0: e0'
+    match: err:message:'SDK: o0: e0'
+  }
+
+]
+

package/project/standard/.sdk/test/primary/findparam.jsonic

@@ -0,0 +1,22 @@
+
+
+DEF: {
+  ctx0: {op:{}}
+  ctx1: .ctx0 & {op:kind:res}
+  ctx2: .ctx1 & {op:match:{}}
+  ctx3: .ctx2 & {op:match:a:'A'}
+  ctx4: .ctx3 & {op:alias:{}}
+  ctx5: .ctx4 & {op:alias:b:'a',spec:{}}
+}
+
+basic: set: [
+  { mark:10, args: [ .....DEF.ctx0, a ] }
+  { mark:20, args: [ .....DEF.ctx1, a ] }
+  { mark:30, args: [ .....DEF.ctx2, a ] }
+  { mark:40, args: [ .....DEF.ctx3, a ], out: 'A'}
+  { mark:50, args: [ .....DEF.ctx3, b ] }
+  { mark:60, args: [ .....DEF.ctx4, b ] }
+  { mark:70, args: [ .....DEF.ctx5, a ], out: 'A' }
+  { mark:80, args: [ .....DEF.ctx5, b ], out: 'A', match: ctx:spec:alias:a:'b' }
+]
+