@voxgig/create-sdkgen 0.0.3 → 0.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voxgig/create-sdkgen",
-  "version": "0.0.3",
+  "version": "0.0.6",
   "main": "dist/create-sdkgen.js",
   "type": "commonjs",
   "types": "dist/create-sdkgen.d.ts",
@@ -17,13 +17,15 @@
     "url": "git://github.com/voxgig/create-sdkgen.git"
   },
   "bin": {
-    "create-sdkgen": "bin/run-create-sdkgen.js"
+    "create-sdkgen": "bin/voxgig-create-sdkgen.js"
   },
   "scripts": {
     "test": "node --enable-source-maps --test dist-test",
     "test-some": "node --enable-source-maps --test-name-pattern=\"$npm_config_pattern\" --test dist-test",
     "watch": "tsc --build src test -w",
     "build": "tsc --build src test",
+    "test-model": "voxgig-model project/.sdk/test/test.jsonic",
+    "test-model-watch": "voxgig-model -w project/.sdk/test/test.jsonic",
     "clean": "rm -rf node_modules yarn.lock package-lock.json",
     "reset": "npm run clean && npm i && npm run build && npm test",
     "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;",
@@ -40,15 +42,16 @@
   ],
   "devDependencies": {
     "@hapi/code": "^9.0.3",
-    "@types/node": "22.5.5",
-    "esbuild": "^0.23.1",
-    "memfs": "^4.12.0",
-    "typescript": "^5.6.2"
+    "@types/node": "22.15.12",
+    "esbuild": "^0.25.4",
+    "memfs": "^4.17.1",
+    "typescript": "^5.8.3"
   },
   "dependencies": {
-    "aontu": "^0.22.0",
-    "chokidar": "^4.0.0",
-    "gubu": "^8.3.0",
-    "jostraca": "^0.6.0"
+    "@voxgig/util": "^0.0.10",
+    "aontu": "^0.28.0",
+    "chokidar": "^4.0.3",
+    "gubu": "^9.0.0",
+    "jostraca": "^0.16.2"
   }
 }

package/src/create-sdkgen.ts

@@ -1,120 +1,102 @@
 /* Copyright (c) 2024 Richard Rodger, MIT License */
 
 import * as Fs from 'node:fs'
+import Path from 'node:path'
 
-import { FSWatcher } from 'chokidar'
+import { prettyPino, Pino } from '@voxgig/util'
 
 import * as JostracaModule from 'jostraca'
 
 
 
 type FullCreateSdkGenOptions = {
-  folder: string
-  fs: any
-  model: any
-  meta: any
-  rootpath: string
+  fs?: any
+  debug?: boolean | string
+  pino?: ReturnType<typeof Pino>
+
 }
 
 type CreateSdkGenOptions = Partial<FullCreateSdkGenOptions>
 
 
-const { Jostraca } = JostracaModule
+type GenerateSpec = {
+  name: string // Name of SDK project.
+  def: string // Path to OpenAPI definition file, copied into SDK project.
+  root: string // Path to Root template component.
+}
 
 
-function CreateSdkGen(opts: CreateSdkGenOptions) {
-  const fs = opts.fs || Fs
-  const folder = opts.folder || '.'
-  const jostraca = Jostraca()
-  const rootpath = opts.rootpath as string
+const { each, names, Jostraca } = JostracaModule
 
-  async function generate(spec: any) {
-    // console.log('CreateSdkGen.generate', spec)
 
-    const { model } = spec
+function CreateSdkGen(opts: FullCreateSdkGenOptions) {
+  const fs = opts.fs || Fs
+  const pino = prettyPino('create', opts)
+  const log = pino.child({ cmp: 'create' })
 
-    const ctx$ = { fs, folder, meta: { spec } }
+  const jostraca = Jostraca()
 
-    clear()
-    const { Root } = require(rootpath)
+  async function generate(spec: GenerateSpec) {
+    const start = Date.now()
 
-    try {
-      await jostraca.generate(ctx$, () => Root({ model }))
-    }
-    catch (err: any) {
-      console.log('CREATE SDKGEN ERROR: ', err)
-      throw err
-    }
-  }
+    log.info({ point: 'generate-start', start })
+    log.debug({ point: 'generate-spec', spec, note: JSON.stringify(spec, null, 2) })
 
+    const rootModule: any = require(spec.root)
+    const Root = rootModule.Root
 
-  async function watch(spec: any) {
-    const fsw = new FSWatcher()
-    let last_change_time = 0
+    const name = spec.name
+    spec.def = (null == spec.def || '' === spec.def) ? name + '-openapi3.yml' : spec.def
 
-    await generate(spec)
+    const folder = Path.join(process.cwd(), name + (name.endsWith('-sdk') ? '' : '-sdk'))
 
-    fsw.on('change', (args: any[]) => {
-      // console.log('CHANGE', args)
+    const opts = {
+      fs: () => fs,
+      folder,
+      log: log.child({ cmp: 'jostraca' }),
+      meta: { spec },
+      existing: {
+        // write: false,
+        // present: true,
+        merge: true
+      }
+    }
 
-      const dorun = 1111 < Date.now() - last_change_time
+    const model = {
+      name,
+      year: new Date().getFullYear(),
+    }
 
-      if (dorun) {
-        last_change_time = Date.now()
-        generate(spec)
-      }
-    })
+    names(model, model.name)
 
-    spec.watch
-      .map((wf: string) => (__dirname + '/' + wf))
-      // .map((wf: string) => (console.log(wf), wf))
-      .map((wf: string) => fsw.add(wf))
+    log.debug({ point: 'generate-model', model, note: JSON.stringify(model, null, 2) })
 
-    // generate()
-  }
+    const info = await jostraca.generate(opts, () => Root({ model, spec }))
 
+    logfiles(info, log)
 
-  function clear() {
-    if (rootpath) {
-      clearRequire(rootpath)
-    }
+    log.info({ point: 'generate-end' })
   }
 
-
   return {
     generate,
-    watch,
   }
 
 }
 
 
-// Adapted from https://github.com/sindresorhus/import-fresh - Thanks!
-function clearRequire(path: string) {
-  let filePath = require.resolve(path)
-
-  if (require.cache[filePath]) {
-    const children = require.cache[filePath].children.map(child => child.id)
-
-    // Delete module from cache
-    delete require.cache[filePath]
-
-    for (const id of children) {
-      clearRequire(id)
-    }
-  }
-
+function logfiles(info: any, log: ReturnType<typeof Pino>) {
+  const cwd = process.cwd()
 
-  if (require.cache[filePath] && require.cache[filePath].parent) {
-    let i = require.cache[filePath].parent.children.length
-
-    while (i--) {
-      if (require.cache[filePath].parent.children[i].id === filePath) {
-        require.cache[filePath].parent.children.splice(i, 1)
+    ;['preserve', 'present', 'merge'].map(action => {
+      let entries = info.file[action]
+      if (0 < entries.length) {
+        log.info({
+          point: 'file-' + action, entries,
+          note: '\n' + entries.map((n: any) => n.path.replace(cwd, '.')).join('\n')
+        })
       }
-    }
-  }
-
+    })
 }
 
 

package/src/standard/ModelSdk.ts

@@ -1,87 +1,25 @@
 
 import {
-  names,
   cmp,
-  each,
-
-  Project,
-  Folder,
-  Copy,
   File,
-  Content,
+  Fragment,
 
 } from 'jostraca'
 
 
 
 const ModelSdk = cmp(function ModelSdk(props: any) {
-  const { ctx$, ctx$: { model } } = props
-
-
-  // console.log('ModelSdk 2', model)
-
-  // TODO: use apidef
-  // const def = ctx$.fs.readFileSync(model.def.filepath)
+  const { spec } = props
 
 
   File({ name: 'sdk.jsonic' }, () => {
-    Content(`
-name: '${model.name}'
-
-@"api.jsonic"
-@"def.jsonic"
-
-main: sdk: build: &: { name: .$KEY }
-
-main: sdk: build: js: @"js.jsonic"
-
-main: sdk: build: rb: @"rb.jsonic"
-
-main: sdk: build: py: @"py.jsonic"
-
-main: sdk: build: php: @"php.jsonic"
-
-main: sdk: build: go: @"go.jsonic"
-
-
-
-main: sdk: test: quick: entity: name: q
-
-
-main: sdk: entity: $.main.api.entity
-
-
-main: sdk: entity: &: {
-  name: .$KEY
-  publish: *true | boolean
-}
-
-
-
-main: sdk: options: &: {
-   name: .$KEY
-   publish: *true | boolean
-}
-
-
-main: sdk: options: {
-
-  endpoint: {
-    kind: *String | string
-    short: "${model.Name} API URL"
-  }
-
-  apikey: {
-    kind: *String | string
-    short: "${model.Name} API Key"
-  }
-  
-  fetch: {
-    kind: *Any | string
-    publish: false
-  }
-}
-`)
+    Fragment({
+      from: __dirname + '/../../project/.sdk/model/sdk.fragment.jsonic',
+      replace: {
+        NAME: spec.name,
+        DEF: spec.def,
+      }
+    })
   })
 
 })

package/src/standard/Root.ts

@@ -1,12 +1,11 @@
 
 
 import Path from 'node:path'
-
+import * as Fs from 'node:fs'
 
 import {
   names,
   cmp,
-  each,
 
   Project,
   Folder,
@@ -20,85 +19,44 @@ import {
 import { ModelSdk } from './ModelSdk'
 
 
+// TODO: rename to RootSdk
 const Root = cmp(function Root(props: any) {
-  const { model, ctx$ } = props
-
-  const { folder, meta } = ctx$
-  const { spec } = meta
-
-  console.log('Root 5')
-
-  // console.log('SPEC', spec)
-
-  names(model, model.name)
+  const { ctx$, ctx$: { folder }, spec, model } = props
 
-  // console.log('MODEL')
-  // console.dir(model, { depth: null })
+  // 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
 
-  /*
-  let createInfo = { exclude: [], last: Number.MAX_SAFE_INTEGER }
-
-
-  try {
-    createInfo = JSON.parse(ctx$.fs.readFileSync(
-      Path.join(folder, '.voxgig', 'create-sdkgen.json'), 'utf8'))
-  }
-  catch (err: any) {
-    console.log(err)
-    // TODO: file not foound ignored, handle others!
-  }
-
-  ctx$.info = createInfo
-
-  console.log('INFO', ctx$.info)
-  */
-
   Project({ folder }, () => {
+    Copy({
+      from: __dirname + '/../../project',
+    })
 
-    // TODO: perhaps remove the need for this, create top level folder in Project
-    // would keep paths indo of project folder name
-    // Folder({ name: Path.basename(folder) }, () => {
-
-    // File({ name: 'foo.txt' }, () => {
-    //   Content('FOO')
-    // })
-
-    // console.log('FOLDER', folder)
-    Copy({ from: __dirname + '/../../tm/standard' })
+    const origdef = spec.def
+    const projdef = Path.basename(origdef)
+    spec.def = projdef
 
-    const def = model.def.filepath
-    if (null != def && '' !== def) {
+    Folder({ name: '.sdk' }, () => {
       Folder({ name: 'def' }, () => {
-        Copy({ from: def, name: Path.basename(def) })
+        if (Fs.existsSync(origdef)) {
+          Copy({ from: origdef, to: projdef })
+        }
+        else {
+          File({ name: projdef }, () => {
+            Content('# OpenAPI Definition')
+          })
+        }
       })
-    }
 
-    Folder({ name: '.voxgig' }, () => { })
-
-    Folder({ name: 'model' }, () => {
-      ModelSdk({})
+      Folder({ name: 'model' }, () => {
+        ModelSdk({ spec })
+      })
     })
-  })
 
-  /*
-  // TODO: need mechanism to ensure this is last
-  setTimeout(() => {
-    try {
-      const info = {
-        last: Date.now(),
-        exclude: ctx$.info.exclude,
-      }
-      ctx$.fs.writeFileSync(Path.join(folder, '.voxgig', 'create-sdkgen.json'),
-        JSON.stringify(info, null, 2))
-    }
-    catch (err: any) {
-      console.log(err)
-      // TODO: file not foound ignored, handle others!
-    }
-    }, 777)
-    */
+  })
 })