@voxgig/sdkgen 0.22.0 → 0.23.0

package/src/cmp/Main.ts

@@ -6,9 +6,11 @@ import { requirePath } from '../utility'
 
 const Main = cmp(function Main(props: any) {
   const { target, ctx$ } = props
-  const { model, stdrep } = ctx$
+  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: {
       ...stdrep,
@@ -19,6 +21,7 @@ const Main = cmp(function Main(props: any) {
 
   Main_sdk['Main']({ model, target, stdrep })
 
+  log.info({ point: 'generate-main', target, note: 'target:' + target.name })
 })
 
 

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,
   }
 
 }

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/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
-}

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

@@ -1,61 +0,0 @@
-class EntityOperation { // REMOVED
-
-async create(data) {
-  let entity = this
-  let client = this.#client
-  const utility = this.#utility
-  const { operator, spec, request, response, result, error, struct, done } = utility
-  
-  let op = {
-    entity: 'Name',
-    name: 'create',
-    path: 'PATH',
-    params: ['PARAM-LIST'],
-    alias: {'ALIAS':'MAP'},
-    match: this.#match,
-    data: null == data ? this.#data : data,
-    state: {},
-    reqform: 'REQFORM',
-    resform: 'RESFORM',
-  }
-  
-  let ctx = { client, op, utility, entity }
-
-  
-  // #PreOperation-Hook    
-
-  await operator(ctx)
-
-  
-  // #PreSpec-Hook
-
-  this.#data = ctx.op.data
-  
-  await spec(ctx)
-
-  
-  // #PreRequest-Hook
-
-  await request(ctx)
-
-  
-  // #PreResponse-Hook
-
-  await response(ctx)
-
-  
-  // #PreResult-Hook
-
-  await result(ctx)
-
-
-  // #PostOperation-Hook
-
-  if(null != ctx.result.resdata) {
-    this.#data = ctx.result.resdata
-  }
-
-  return done(ctx)
-}
-
-} // REMOVED

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

@@ -1,57 +0,0 @@
-class EntityOperation { // REMOVED
-
-async list(match) {
-  let entity = this
-  let client = this.#client
-  const utility = this.#utility
-    const { operator, spec, request, response, result, error, struct, done } = utility
-  
-  let op = {
-    entity: 'Name',
-    name: 'list',
-    path: 'PATH',
-    params: ['PARAM-LIST'],
-    alias: {'ALIAS':'MAP'},
-    match,
-    data: this.#data,
-    state: {},
-    reqform: 'REQFORM',
-    resform: 'RESFORM',
-  }
-
-  let ctx = { client, entity, op, utility}
-
-  
-  // #PreOperation-Hook    
-
-  await operator(ctx)
-
-  
-  // #PreSpec-Hook
-
-  this.#match = ctx.op.match
-  
-  await spec(ctx)
-
-  
-  // #PreRequest-Hook
-
-  await request(ctx)
-
-  
-  // #PreResponse-Hook
-
-  await response(ctx)
-
-  
-  // #PreResult-Hook
-
-  await result(ctx)
-
-
-  // #PostOperation-Hook
-
-  return done(ctx)
-}
-
-} // REMOVED

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

@@ -1,61 +0,0 @@
-class EntityOperation { // REMOVED
-
-async load(match) {
-  const entity = this
-  const client = this.#client
-  const utility = this.#utility
-  const { operator, spec, request, response, result, error, struct, done } = utility
-  
-  const op = {
-    entity: 'Name',
-    name: 'load',
-    path: 'PATH',
-    params: ['PARAM-LIST'],
-    alias: {'ALIAS':'MAP'},
-    match,
-    data: this.#data,
-    state: {},
-    reqform: 'REQFORM',
-    resform: 'RESFORM',
-  }
-
-  let ctx = { client, entity, op, utility}
-
-  
-  // #PreOperation-Hook    
-
-  await operator(ctx)
-
-  
-  // #PreSpec-Hook
-
-  this.#match = op.match
-  
-  await spec(ctx)
-
-  
-  // #PreRequest-Hook
-
-  await request(ctx)
-
-  
-  // #PreResponse-Hook
-
-  await response(ctx)
-
-  
-  // #PreResult-Hook
-  
-  await result(ctx)
-
-  
-  // #PostOperation-Hook
-
-  if(null != ctx.result.resdata) {
-    this.#data = ctx.result.resdata
-  }
-
-  return done(ctx)
-}
-
-} // REMOVED

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

@@ -1,61 +0,0 @@
-class EntityOperation { // REMOVED
-
-async remove(match) {
-  let entity = this
-  let client = this.#client
-  const utility = this.#utility
-  const { operator, spec, request, response, result, error, struct, done } = utility
-  
-  let op = {
-    entity: 'Name',
-    name: 'remove',
-    path: 'PATH',
-    params: ['PARAM-LIST'],
-    alias: {'ALIAS':'MAP'},
-    match,
-    data: this.#data,
-    state: {},
-    reqform: 'REQFORM',
-    resform: 'RESFORM',
-  }
-
-  let ctx = {client, entity, op, utility}
-
-
-  // #PreOperation-Hook    
-
-  await operator(ctx)
-
-  
-  // #PreSpec-Hook
-
-  this.#data = op.data
-  
-  await spec(ctx)
-
-  
-  // #PreRequest-Hook
-
-  await request(ctx)
-
-  
-  // #PreResponse-Hook
-
-  await response(ctx)
-
-  
-  // #PreResult-Hook
-
-  await result(ctx)
-
-
-  // #PostOperation-Hook
-
-  if(null != ctx.result.resdata) {
-    this.#data = ctx.result.resdata
-  }
-
-  return done(ctx)
-}
-  
-} // REMOVED

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

@@ -1,61 +0,0 @@
-class EntityOperation { // REMOVED
-
-async update(data) {
-  let entity = this
-  let client = this.#client
-  const utility = this.#utility
-  const { operator, spec, request, response, result, error, struct, done } = utility
-  
-  let op = {
-    entity: 'Name',
-    name: 'update',
-    path: 'PATH',
-    params: ['PARAM-LIST'],
-    alias: {'ALIAS':'MAP'},
-    match: this.#match,
-    data: null == data ? this.#data : data,
-    state: {},
-    reqform: 'REQFORM',
-    resform: 'RESFORM',
-  }
-  
-  let ctx = {client, entity, op, utility}
-
-
-  // #PreOperation-Hook    
-
-  await operator(ctx)
-
-  
-  // #PreSpec-Hook
-
-  this.#data = op.data
-  
-  await spec(ctx)
-
-  
-  // #PreRequest-Hook
-
-  await request(ctx)
-
-  
-  // #PreResponse-Hook
-
-  await response(ctx)
-
-  
-  // #PreResult-Hook
-
-  await result(ctx)
-
-
-  // #PostOperation-Hook
-
-  if(null != ctx.result.resdata) {
-    this.#data = ctx.result.resdata
-  }
-
-  return done(ctx)
-}
-
-} // REMOVED