@voxgig/sdkgen 0.21.0 → 0.23.0

package/src/cmp/Main.ts

@@ -1,28 +1,27 @@
 
-import { cmp, names, Copy, Folder } from 'jostraca'
+import { cmp, names, Copy } from 'jostraca'
 
 import { requirePath } from '../utility'
 
 
 const Main = cmp(function Main(props: any) {
   const { target, ctx$ } = props
-  const { model } = ctx$
-
-  names(model, model.name)
-  // console.log('MODEL name', model.name, model.Name)
+  const { model, stdrep, log } = ctx$
 
   Copy({
+    // This folder is relative to the .sdk folder in the project, as that is where
+    // the sdk is generated from.
     from: 'tm/' + target.name,
     replace: {
-      Name: model.Name,
+      ...stdrep,
     }
   })
 
-  // const Main_sdk = require(resolvePath(ctx$, `cmp/${target.name}/Main_${target.name}`))
   const Main_sdk = requirePath(ctx$, `cmp/${target.name}/Main_${target.name}`)
 
-  Main_sdk['Main']({ model, target })
+  Main_sdk['Main']({ model, target, stdrep })
 
+  log.info({ point: 'generate-main', target, note: 'target:' + target.name })
 })
 
 

package/src/cmp/ReadmeIntro.ts

@@ -1,5 +1,5 @@
 
-import { cmp, select, Content } from 'jostraca'
+import { cmp, Content } from 'jostraca'
 
 
 const ReadmeIntro = cmp(function ReadmeIntro(props: any) {

package/src/sdkgen.ts

@@ -1,6 +1,7 @@
 /* Copyright (c) 2024 Richard Rodger, MIT License */
 
-import * as Fs from 'node:fs'
+import Fs from 'node:fs'
+import Path from 'node:path'
 
 import { prettyPino, Pino } from '@voxgig/util'
 
@@ -8,6 +9,16 @@ import { Jsonic } from 'jsonic'
 import * as JostracaModule from 'jostraca'
 import { Aontu, Context } from 'aontu'
 
+import {
+  showChanges,
+  getdlog,
+} from '@voxgig/util'
+
+import type {
+  ActionContext,
+  ActionResult,
+} from './types'
+
 import { SdkGenError, requirePath } from './utility'
 
 import { Main } from './cmp/Main'
@@ -19,8 +30,17 @@ import { ReadmeOptions } from './cmp/ReadmeOptions'
 import { ReadmeEntity } from './cmp/ReadmeEntity'
 import { FeatureHook } from './cmp/FeatureHook'
 
-import { action_target } from './action/target'
-import { action_feature } from './action/feature'
+
+import {
+  action_target,
+  target_add,
+} from './action/target'
+
+import {
+  action_feature,
+  feature_add,
+} from './action/feature'
+
 
 
 // TODO: use shape
@@ -37,7 +57,7 @@ type SdkGenOptions = {
     name: string
   }
   debug?: boolean | string
-  pino?: ReturnType<typeof Pino>
+  pino?: any, // ReturnType<typeof Pino>
   now?: () => number
 
   // TODO: match Jostraca
@@ -45,6 +65,8 @@ type SdkGenOptions = {
     txt?: any
     bin?: any
   }
+
+  dryrun?: boolean
 }
 
 
@@ -57,12 +79,27 @@ const ACTION_MAP: any = {
 }
 
 
+const dlog = getdlog('sdkgen', __filename)
+
+
 function SdkGen(opts: SdkGenOptions) {
   const fs = opts.fs || Fs
   const folder = opts.folder || '../'
   const now = opts.now || (() => Date.now())
 
-  const jostraca = Jostraca({ now })
+  const jopts = {
+    now,
+    control: {
+      dryrun: opts.dryrun
+    },
+    existing: {
+      txt: {
+        merge: true
+      }
+    }
+  }
+
+  const jostraca = Jostraca(jopts)
 
   const pino = prettyPino('sdkgen', opts)
   const log = pino.child({ cmp: 'sdkgen' })
@@ -72,7 +109,7 @@ function SdkGen(opts: SdkGenOptions) {
     const start = Date.now()
     const { model, config } = spec
 
-    log.info({ point: 'generate-start', start })
+    log.info({ point: 'generate-start', start, note: opts.dryrun ? '** DRY RUN **' : '' })
     log.debug({ point: 'generate-spec', spec })
 
     let Root = spec.root
@@ -89,10 +126,19 @@ function SdkGen(opts: SdkGenOptions) {
       log: log.child({ cmp: 'jostraca' }),
       meta: { spec },
       debug: opts.debug,
-      existing: opts.existing
+      existing: opts.existing,
     }
 
-    await jostraca.generate(jopts, () => Root({ model }))
+    const jres = await jostraca.generate(jopts, () => Root({ model }))
+
+    showChanges(jopts.log, 'generate-result', jres, Path.dirname(process.cwd()))
+
+    const dlogs = dlog.log()
+    if (0 < dlogs.length) {
+      for (let dlogentry of dlogs) {
+        log.debug({ point: 'generate-warning', dlogentry, note: String(dlogentry) })
+      }
+    }
 
     log.info({ point: 'generate-end' })
 
@@ -110,17 +156,28 @@ function SdkGen(opts: SdkGenOptions) {
       throw new SdkGenError('Unknown action: ' + actname)
     }
 
+    const ctx = resolveActionContext()
+
+    await action(pargs, ctx)
+  }
+
+
+  function resolveActionContext(): ActionContext {
+
+    // TODO: use AsyncLocalStorage to avoid reloading model
     const { model, tree } = resolveModel()
 
-    const ctx = {
+    const ctx: ActionContext = {
       fs: () => fs,
       log,
       folder: '.', // The `generate` folder,
       model,
       tree,
+      jostraca,
+      opts,
     }
 
-    await action(pargs, ctx)
+    return ctx
   }
 
 
@@ -179,10 +236,28 @@ function SdkGen(opts: SdkGenOptions) {
   }
 
 
+  const target = {
+    add: async (targets: string[]): Promise<ActionResult> => {
+      const ctx = resolveActionContext()
+      return target_add(targets, ctx)
+    }
+  }
+
+  const feature = {
+    add: async (features: string[]): Promise<ActionResult> => {
+      const ctx = resolveActionContext()
+      return feature_add(features, ctx)
+    }
+  }
+
+
+
   return {
-    pino,
+    pino: pino as any,
     generate,
     action,
+    target,
+    feature,
   }
 
 }
@@ -267,7 +342,6 @@ export const each: (subject?: any, apply?: any) => any = JostracaModule.each
 export const snakify: (input: any[] | string) => string = JostracaModule.snakify
 export const camelify: (input: any[] | string) => string = JostracaModule.camelify
 export const kebabify: (input: any[] | string) => string = JostracaModule.kebabify
-export const select: (key: any, map: Record<string, Function>) => any = JostracaModule.select
 export const cmap: (o: any, p: any) => any = JostracaModule.cmap
 export const vmap: (o: any, p: any) => any = JostracaModule.vmap
 export const get: (root: any, path: string | string[]) => any = JostracaModule.get

package/src/types.ts

@@ -0,0 +1,33 @@
+
+import Fs from 'node:fs'
+
+import type {
+  JostracaResult
+} from 'jostraca'
+
+
+type FsUtil = typeof Fs
+
+
+type ActionContext = {
+  fs: () => FsUtil,
+  log: any,
+  folder: string,
+  model: any,
+  tree: any,
+  opts: any,
+  jostraca: any
+}
+
+
+type ActionResult = {
+  jres: JostracaResult
+}
+
+
+
+export type {
+  ActionContext,
+  ActionResult,
+}
+

package/src/utility.ts

@@ -1,15 +1,17 @@
 
 import Path from 'node:path'
 
-// TODO: move to @voxgig/util as duplicated with @voxgig/sdkgen
+import { JostracaResult } from 'jostraca'
 
-const resolvePath = (ctx$: any, path: string): any => {
+
+
+function resolvePath(ctx$: any, path: string): any {
   const fullpath = Path.join(ctx$.folder, '.sdk', 'dist', path)
   return fullpath
 }
 
 
-const requirePath = (ctx$: any, path: string, flags?: { ignore?: boolean }): any => {
+function requirePath(ctx$: any, path: string, flags?: { ignore?: boolean }): any {
   const fullpath = resolvePath(ctx$, path)
   const ignore = null == flags?.ignore ? false : flags.ignore
 

package/project/.sdk/model/feature/limit.jsonic

@@ -1,12 +0,0 @@
-
-title: Limiter
-active: true
-
-
-hook: {
-  PreFetch: {
-    active: true
-    await: true
-  }
-}
-

package/project/.sdk/model/feature/page.jsonic

@@ -1,9 +0,0 @@
-
-title: Paging
-active: true
-
-
-hook: {
-  PreFetch: active: true
-}
-

package/project/.sdk/model/feature/telemetry.jsonic

@@ -1,10 +0,0 @@
-
-title: Telemetry
-active: true
-
-hook: {
-  PostConstruct: active: true
-  PreFetch: active: true
-  PostFetch: active: true
-}
-

package/project/.sdk/src/cmp/ts/Main_ts.ts~

@@ -1,88 +0,0 @@
-
-import * as Path from 'node:path'
-
-import {
-  cmp, each, names, cmap,
-  List, File, Content, Copy, Folder, Fragment, Line, FeatureHook,
-} from '@voxgig/sdkgen'
-
-
-//import { Package } from './Package_js'
-import { Config } from './Config_ts'
-//import { MainEntity } from './MainEntity_js'
-//import { Test } from './Test_js'
-
-
-const Main = cmp(async function Main(props: any) {
-  const { target } = props
-  const { model } = props.ctx$
-
-  const { entity } = model.main.api
-  const { feature } = model.main.sdk
-
-  // Package({ target })
-
-  // Test({ target })
-
-  Folder({ name: 'src' }, () => {
-
-    // File({ name: model.const.Name + 'SDK.' + target.name }, () => {
-
-    //   Line(`// ${model.const.Name} ${target.Name} SDK\n`)
-
-    //   List({ item: feature }, ({ item }: any) =>
-    //     Line(`const { ${item.Name + 'Feature'} } = ` +
-    //       `require('./feature/${item.name}/${item.Name}Feature')`))
-
-    //   List({ item: entity }, ({ item }: any) =>
-    //     Line(`const { ${item.Name}Entity } = require('./entity/${item.Name}Entity')`))
-
-    //   Fragment({
-    //     from: Path.normalize(__dirname + '/../../../src/cmp/js/fragment/Main.fragment.js'),
-    //     replace: {
-    //       Name: model.const.Name,
-
-
-    //       '#FeatureOptions': ({ indent }: any) =>
-    //         Line({ indent }, `const fopts = this.#options.feature || {}`),
-
-    //       '#BuildFeature': ({ indent }: any) => {
-    //         List({ item: feature, line: false }, ({ item }: any) =>
-    //           Line({ indent }, `${item.name}: ` +
-    //             `new ${item.Name}Feature(this, fopts.${item.name}, ` +
-    //             `${JSON.stringify(item.config || {})}), `))
-    //       },
-
-    //       '#Feature-Hook': ({ name, indent }: any) =>
-    //         FeatureHook({ name }, (f: any) =>
-    //           Line({ indent },
-    //             `${f.await ? 'await ' : ''}this.#features.${f.name}.${name}({ client: this })`)),
-
-    //       '#TestOptions': ({ indent }: any) => {
-    //         const topts = {
-    //           feature: cmap(feature, {
-    //             active: false
-    //           }),
-    //         }
-    //         Content({ indent },
-    //           JSON.stringify(topts, null, 2)
-    //             .replace(/^{\n  /, '').replace(/\n}$/, ',\n').replace(/\n  /g, '\n'))
-    //       }
-    //     }
-    //   }, () => {
-    //     each(entity, (entity: any) => {
-    //       // console.log('ENTITY', entity.name)
-    //       MainEntity({ target, entity, entitySDK: model.main.sdk.entity[entity.name] })
-    //     })
-    //   })
-    // })
-
-    Config({ target })
-
-  })
-})
-
-
-export {
-  Main
-}

package/project/.sdk/src/cmp/ts/Package_ts.ts~

@@ -1,58 +0,0 @@
-
-import {
-  cmp, omap, each, cmap,
-  File, Content,
-} from '@voxgig/sdkgen'
-
-
-
-const Package = cmp(async function Package(props: any) {
-  const { target, ctx$: { model } } = props
-  const { main: { sdk: { feature } } } = model
-
-  const only = (kind: string, deps: any) =>
-    omap(deps, ([k, v]: any) => [v.active && kind === v.kind ? k : undefined, v.version])
-
-  // merge target and feature deps, by kind
-  const deps =
-    each(feature, (feature: any) =>
-      omap(feature.deps[target.name], ([k, v]: any) =>
-        [v.active ? k : undefined, v]))
-      // TODO: sort by version; rules for version choice?
-      .reduce((a: any, deps: any) => (each(deps, (dep: any) =>
-        a[dep.kind][dep.key$] = dep.version), a),
-        {
-          prod: only('prod', target.deps),
-          peer: only('peer', target.deps),
-          dev: only('dev', target.deps),
-        })
-
-  // TODO: complete SDK meta data in model and use here
-  const pkg = {
-    name: `${model.const.name}-sdk`,
-    version: `0.0.1`,
-    description: 'DESCRIPTION',
-    main: `src/${model.const.Name}SDK.js`,
-    scripts: {
-      'test': 'node --test test/*.test.js',
-      'test-utility': 'node --test test/utility/*.test.js',
-      'test-accept': 'node --test test/accept/*.test.js',
-      'test-all': 'npm run test && npm run test-utility'
-    },
-    author: `${model.const.Name}`,
-    license: 'MIT',
-    dependencies: deps.prod,
-    peerDependencies: deps.peer,
-    devDependencies: deps.dev,
-  }
-
-
-  File({ name: 'package.json' }, () => {
-    Content(JSON.stringify(pkg, null, 2))
-  })
-})
-
-
-export {
-  Package
-}

package/project/.sdk/src/cmp/ts/Quick_ts.ts.off

@@ -1,82 +0,0 @@
-
-import { names, getx, each, cmp, File, Content } from '@voxgig/sdkgen'
-
-
-const Quick = cmp(function Quick(props: any) {
-  const { target } = props
-  const { model, meta: { spec } } = props.ctx$
-
-  // get quick entity from target config
-
-  let ent: any
-  let entmap = getx(spec.config.guideModel, 'guide entity?test:quick:active=true')
-
-  if (entmap) {
-    ent = Object.values(entmap)[0]
-    ent.name = Object.keys(entmap)[0]
-  }
-
-  ent = ent || { name: 'Entity' }
-  names(ent, ent.name)// , ent.key$ || 'name')
-
-  // TODO: selected features should be active by default!
-
-  const featureOptions = each(model.main.sdk.feature)
-    .filter((f: any) => f.active)
-    .reduce((a: any, f: any) => a + `\n    ${f.name}: { active: true },`, '')
-
-  // console.log('QUICK', ent, featureOptions)
-
-
-  File({ name: 'quick.' + target.name }, () => {
-
-    Content(`
-// ENT 3
-require('dotenv').config({ path: ['../../.env.local']})
-
-const { ${model.const.Name}SDK } = require('../')
-
-run()
-
-async function run() {
-  const client = new ${model.const.Name}SDK({
-    endpoint: process.env.${model.NAME}_ENDPOINT,
-    apikey: process.env.${model.NAME}_APIKEY,
-    ${featureOptions}
-  })
-
-`)
-
-    if (ent.test?.quick.create) {
-      Content(`    
-  out = await client.${ent.Name}().create(${JSON.stringify(ent.test?.quick.create)})
-  console.log('${ent.Name}.load', out) 
-`)
-    }
-
-    if (ent.test?.quick.load) {
-      Content(`    
-  out = await client.${ent.Name}().load(${JSON.stringify(ent.test?.quick.load)})
-  console.log('${ent.Name}.load', out) 
-`)
-    }
-
-    if (ent.test?.quick.list) {
-      Content(`    
-  out = await client.${ent.Name}().list(${JSON.stringify(ent.test?.quick.list)})
-  console.log('${ent.Name}.list', out)
-`)
-    }
-
-    Content(`
-}
-`)
-
-  })
-})
-
-
-export {
-  Quick
-}
-

package/project/.sdk/src/cmp/ts/TestAcceptEntity_ts.ts.off

@@ -1,13 +0,0 @@
-
-import { cmp, camelify, Content } from '@voxgig/sdkgen'
-
-
-const TestAcceptEntity = cmp(function TestEntity(props: any) {
-  const { entity } = props
-
-})
-
-
-export {
-  TestAcceptEntity
-}

package/project/.sdk/src/cmp/ts/TestAccept_ts.ts.off

@@ -1,18 +0,0 @@
-
-import { cmp, each, File, Content } from '@voxgig/sdkgen'
-
-
-import { TestAcceptEntity } from './TestAcceptEntity_js'
-
-
-const TestAccept = cmp(function TestMain(props: any) {
-  const { target } = props
-  const { model } = props.ctx$
-
-})
-
-
-export {
-  TestAccept
-}
-

package/project/.sdk/src/cmp/ts/Test_ts.ts.off

@@ -1,24 +0,0 @@
-
-import { cmp, File, Content, Folder } from '@voxgig/sdkgen'
-
-import { Quick } from './Quick_js'
-import { TestMain } from './TestMain_js'
-import { TestAccept } from './TestAccept_js'
-
-
-const Test = cmp(function Test(props: any) {
-  const { target } = props
-
-  Folder({ name: 'test' }, () => {
-    Quick({ target })
-    TestMain({ target })
-    Folder({ name: 'accept' }, () => {
-      TestAccept({ target })
-    })
-  })
-})
-
-
-export {
-  Test
-}

package/project/.sdk/src/cmp/ts/fragment/Entity.fragment.js

@@ -1,79 +0,0 @@
-
-class NameEntity {  
-  #client
-  #options
-  #features
-  #utility
-  #data
-  #match
-  
-  constructor(client, options) {
-    options = options || {}
-    options.active = false !== options.active
-
-    this.#client = client
-    this.#options = options
-    this.#features = client.features()
-    this.#utility = client.utility()
-    this.#data = {}
-    this.#match = {}
-
-    // #PostConstructEntity-Hook
-  }
-
-  options() {
-    return { ...this.#options }
-  }
-
-  client() {
-    return this.#client
-  }
-
-  make() {
-    return new NameEntity(this.#client, this.options())
-  }
-
-  
-  data(data) {
-    // NOTE: data can be mutated.
-    if(null != data) {
-
-      // #SetData-Hook
-      
-      this.#data = { ...data }
-    }
-
-    let out = { ...this.#data }
-
-    // #GetData-Hook
-
-    return out
-  }
-
-  
-  match() {
-    // NOTE: match cannot be mutated.
-    let out = { ...this.#match }
-
-    // #GetMatch-Hook
-
-    return out
-  }
-
-
-  // #LoadOp
-
-  // #ListOp
-
-  // #CreateOp
-
-  // #UpdateOp
-
-  // #RemoveOp
-
-}
-
-
-module.exports = {
-  NameEntity
-}