@voxgig/sdkgen 0.35.2 → 0.37.0

package/project/.sdk/src/cmp/js/TestEntity_js.ts

@@ -37,7 +37,7 @@ import {
 } from './utility_js'
 
 
-type OpGen = (model: any, entity: any, flow: any, step: any, index: any) => void
+type OpGen = (model: any, entity: any, flow: any, step: any, index: { key$: number, val$: any }) => void
 
 
 const TestEntity = cmp(function TestEntity(props: any) {
@@ -78,9 +78,9 @@ const TestEntity = cmp(function TestEntity(props: any) {
         const indent = 2
 
         const idlist = flatten([
-          '${entity.name}01',
-          '${entity.name}02',
-          '${entity.name}03',
+          entity.name + '01',
+          entity.name + '02',
+          entity.name + '03',
           flatten(items(entity.relations.ancestors, (ap: any) =>
             items(ap[1], (a: any) =>
               items(['01', '02', '03'], (n: any) =>
@@ -156,6 +156,10 @@ function basicSetup(extra) {
 
 
         Slot({ name: 'basic' }, () => {
+          const flowHasCreate = Object.values(basicflow.step).some(
+            (s: any) => s.op === 'create'
+          )
+
           Content(`
     const setup = basicSetup()
     const client = setup.client
@@ -166,6 +170,15 @@ function basicSetup(extra) {
 
 `)
 
+          // When the flow has no create step, bootstrap the entity data variable
+          // from existing test data so that subsequent update/load/remove steps
+          // can reference it.
+          if (!flowHasCreate) {
+            const ref01 = entity.name + '_ref01'
+            Content(`    let ${ref01}_data = Object.values(setup.data.existing.${entity.name})[0]
+`)
+          }
+
           each(basicflow.step, (step: any, index: any) => {
             const opgen: OpGen = GENERATE_OP[step.op]
             opgen(model, entity, basicflow, step, index)
@@ -183,17 +196,39 @@ const generateCreate: OpGen = (
   entity: ModelEntity,
   flow: ModelEntityFlow,
   step: ModelEntityFlowStep,
-  index: number
+  index: any
 ) => {
   const ref = step.input.ref ?? entity.name + '_ref01'
   const entvar = step.input.entvar ?? ref + '_ent'
   const datavar = step.input.datavar ?? (ref + '_data' + (step.input.suffix ?? ''))
 
+  const priorSteps = Object.values(flow.step).slice(0, Number(index))
+  const needsEnt = !priorSteps.some((s: any) =>
+    ['create', 'list', 'load', 'update', 'remove'].includes(s.op))
+
+  const hasDatvar = priorSteps.some((s: any) => {
+    if ('create' === s.op) {
+      const priorRef = s.input?.ref ?? entity.name + '_ref01'
+      const priorDatvar = s.input?.datavar ?? (priorRef + '_data' + (s.input?.suffix ?? ''))
+      return priorDatvar === datavar
+    }
+    return false
+  })
+
   Content(`
     // CREATE
-    const ${entvar} = client.${nom(entity, 'Name')}()
-    let ${datavar} = setup.data.new.${entity.name}['${ref}']
 `)
+  if (needsEnt) {
+    Content(`    const ${entvar} = client.${nom(entity, 'Name')}()
+`)
+  }
+  if (hasDatvar) {
+    Content(`    ${datavar} = setup.data.new.${entity.name}['${ref}']
+`)
+  } else {
+    Content(`    let ${datavar} = setup.data.new.${entity.name}['${ref}']
+`)
+  }
 
   each(step.match, (mi: any) => {
     Content(`    ${datavar}['${mi.key$}'] = setup.idmap['${mi.val$}']
@@ -212,16 +247,25 @@ const generateList: OpGen = (
   entity: ModelEntity,
   flow: ModelEntityFlow,
   step: ModelEntityFlowStep,
-  index: number
+  index: any
 ) => {
   const ref = step.input.ref ?? entity.name + '_ref01'
   const entvar = step.input.entvar ?? ref + '_ent'
   const matchvar = step.input.matchvar ?? (ref + '_match' + (step.input.suffix ?? ''))
   const listvar = step.input.listvar ?? (ref + '_list' + (step.input.suffix ?? ''))
 
+  const priorSteps = Object.values(flow.step).slice(0, Number(index))
+  const needsEnt = !priorSteps.some((s: any) =>
+    ['create', 'list', 'load', 'update', 'remove'].includes(s.op))
+
   Content(`
     // LIST
-    const ${matchvar} = {}
+`)
+  if (needsEnt) {
+    Content(`    const ${entvar} = client.${nom(entity, 'Name')}()
+`)
+  }
+  Content(`    const ${matchvar} = {}
 `)
 
   each(step.match, (mi: any) => {
@@ -232,16 +276,21 @@ const generateList: OpGen = (
   Content(`
     const ${listvar} = await ${entvar}.list(${matchvar})
 `)
+  const allSteps = Object.values(flow.step)
   for (let vI = 0; vI < step.valid.length; vI++) {
     const validator = step.valid[vI]
-    if ('ItemExists' === validator.apply) {
+    const validRef = validator.def?.ref
+    const hasRefData = validRef && allSteps.some((s: any) => 'create' === s.op &&
+      ((s.input?.ref ?? entity.name + '_ref01') === validRef))
+
+    if ('ItemExists' === validator.apply && hasRefData) {
       Content(`
-    assert(!isempty(select(${listvar}, { id: ${validator.def.ref}_data.id })))
+    assert(!isempty(select(${listvar}, { id: ${validRef}_data.id })))
 `)
     }
-    else if ('ItemNotExists' === validator.apply) {
+    else if ('ItemNotExists' === validator.apply && hasRefData) {
       Content(`
-    assert(isempty(select(${listvar}, { id: ${validator.def.ref}_data.id })))
+    assert(isempty(select(${listvar}, { id: ${validRef}_data.id })))
 `)
     }
   }
@@ -253,7 +302,7 @@ const generateUpdate: OpGen = (
   entity: ModelEntity,
   flow: ModelEntityFlow,
   step: ModelEntityFlowStep,
-  index: number
+  index: any
 ) => {
   const ref = step.input.ref ?? entity.name + '_ref01'
   const entvar = step.input.entvar ?? ref + '_ent'
@@ -262,9 +311,18 @@ const generateUpdate: OpGen = (
   const markdefvar = step.input.markdefvar ?? (ref + '_markdef' + (step.input.suffix ?? ''))
   const srcdatavar = step.input.srcdatavar ?? (ref + '_data' + (step.input.suffix ?? ''))
 
+  const priorSteps = Object.values(flow.step).slice(0, Number(index))
+  const needsEnt = !priorSteps.some((s: any) =>
+    ['create', 'list', 'load', 'update', 'remove'].includes(s.op))
+
   Content(`
     // UPDATE
-    const ${datavar} = {}
+`)
+  if (needsEnt) {
+    Content(`    const ${entvar} = client.${nom(entity, 'Name')}()
+`)
+  }
+  Content(`    const ${datavar} = {}
     ${datavar}.id = ${srcdatavar}.id
 `)
 
@@ -295,7 +353,7 @@ const generateUpdate: OpGen = (
 
   for (let sI = 0; sI < step.spec.length; sI++) {
     const spec = step.spec[sI]
-    if ('TextFieldMark' === spec.apply) {
+    if ('TextFieldMark' === spec.apply && null != step.input.textfield) {
       Content(`
     assert(${resdatavar}[${markdefvar}.name] === ${markdefvar}.value)
 `)
@@ -310,7 +368,7 @@ const generateLoad: OpGen = (
   entity: ModelEntity,
   flow: ModelEntityFlow,
   step: ModelEntityFlowStep,
-  index: number
+  index: any
 ) => {
   const ref = step.input.ref ?? entity.name + '_ref01'
   const entvar = step.input.entvar ?? ref + '_ent'
@@ -318,9 +376,36 @@ const generateLoad: OpGen = (
   const datavar = step.input.datavar ?? (ref + '_data' + (step.input.suffix ?? ''))
   const srcdatavar = step.input.srcdatavar ?? (ref + '_data' + (step.input.suffix ?? ''))
 
+  const priorSteps = Object.values(flow.step).slice(0, Number(index))
+  const hasEntVar = priorSteps.some((s: any) =>
+    ['create', 'list', 'load', 'update', 'remove'].includes(s.op))
+
+  // Check if srcdatavar was declared by a prior create step or by the
+  // preamble bootstrap (which runs when the flow has no create step)
+  const flowHasCreate = Object.values(flow.step).some((s: any) => s.op === 'create')
+  const preambleRef = entity.name + '_ref01'
+  const hasSrcData = (!flowHasCreate && srcdatavar === preambleRef + '_data') ||
+    priorSteps.some((s: any) => {
+      if ('create' === s.op) {
+        const priorRef = s.input?.ref ?? entity.name + '_ref01'
+        const priorDatvar = s.input?.datavar ?? (priorRef + '_data' + (s.input?.suffix ?? ''))
+        return priorDatvar === srcdatavar
+      }
+      return false
+    })
+
   Content(`
     // LOAD
-    const ${matchvar} = {}
+`)
+  if (!hasEntVar) {
+    Content(`    const ${entvar} = client.${nom(entity, 'Name')}()
+`)
+  }
+  if (!hasSrcData) {
+    Content(`    const ${srcdatavar} = Object.values(setup.data.existing.${entity.name})[0]
+`)
+  }
+  Content(`    const ${matchvar} = {}
     ${matchvar}.id = ${srcdatavar}.id
     const ${datavar} = await ${entvar}.load(${matchvar})
     assert(${datavar}.id === ${srcdatavar}.id)
@@ -333,16 +418,25 @@ const generateRemove: OpGen = (
   entity: ModelEntity,
   flow: ModelEntityFlow,
   step: ModelEntityFlowStep,
-  index: number
+  index: any
 ) => {
   const ref = step.input.ref ?? entity.name + '_ref01'
   const entvar = step.input.entvar ?? ref + '_ent'
   const matchvar = step.input.matchvar ?? (ref + '_match' + (step.input.suffix ?? ''))
   const srcdatavar = step.input.srcdatavar ?? (ref + '_data')
 
+  const priorSteps = Object.values(flow.step).slice(0, Number(index))
+  const needsEnt = !priorSteps.some((s: any) =>
+    ['create', 'list', 'load', 'update', 'remove'].includes(s.op))
+
   Content(`
     // REMOVE
-    const ${matchvar} = {}
+`)
+  if (needsEnt) {
+    Content(`    const ${entvar} = client.${nom(entity, 'Name')}()
+`)
+  }
+  Content(`    const ${matchvar} = {}
     ${matchvar}.id = ${srcdatavar}.id
     await ${entvar}.remove(${matchvar})
   `)

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

@@ -1,106 +1,22 @@
 
 const { inspect } = require('node:util')
 
-const {
-  SdkNameSDK,
-  SdkNameEntity,
-} = require('../SdkNameSDK')
-
-const {
-  Utility
-} = require('../utility/Utility')
+const { ProjectNameEntityBase } = require('../ProjectNameEntityBase')
 
 
 // TODO: needs Entity superclass
-class EntityNameEntity {
-  name = 'entityname'
-
-  #client
-  #utility
-  #entopts
-  #data
-  #match
-
-  _entctx
+class EntityNameEntity extends ProjectNameEntityBase {
 
   constructor(client, entopts) {
-    // super()
-    entopts = entopts || {}
-    entopts.active = false !== entopts.active
-
-    this.#client = client
-    this.#entopts = entopts
-    this.#utility = client.utility()
-    this.#data = {}
-    this.#match = {}
-
-    const makeContext = this.#utility.makeContext
-
-    this._entctx = makeContext({
-      entity: this,
-      entopts,
-    }, client._rootctx)
-
-    const featureHook = this.#utility.featureHook
-    featureHook(this._entctx, 'PostConstructEntity')
+    super(client, entopts)
+    this.name = 'entityname'
+    this.name_ = 'entityname'
+    this.Name = 'EntityName'
   }
 
-  entopts() {
-    return { ...this.#entopts }
-  }
-
-  client() {
-    return this.#client
-  }
 
   make() {
-    return new EntityNameEntity(this.#client, this.entopts())
-  }
-
-
-  data(data) {
-    const struct = this.#utility.struct
-    const featureHook = this.#utility.featureHook
-
-    if (null != data) {
-      this.#data = struct.clone(data)
-      featureHook(this._entctx, 'SetData')
-    }
-
-    featureHook(this._entctx, 'GetData')
-    let out = struct.clone(this.#data)
-
-    return out
-  }
-
-
-  match(match) {
-    const struct = this.#utility.struct
-    const featureHook = this.#utility.featureHook
-
-    if (null != match) {
-      this.#match = struct.clone(match)
-      featureHook(this._entctx, 'SetMatch')
-    }
-
-    featureHook(this._entctx, 'GetMatch')
-    let out = struct.clone(this.#match)
-
-    return out
-  }
-
-
-  toJSON() {
-    const struct = this.#utility.struct
-    return struct.merge([{}, struct.getdef(this.#data, {}), { $entity: 'EntityName' }])
-  }
-
-  toString() {
-    return 'EntityName ' + this.#utility.struct.jsonify(this.#data)
-  }
-
-  [inspect.custom]() {
-    return this.toString()
+    return new EntityNameEntity(this._client, this.entopts())
   }
 
 
@@ -114,54 +30,6 @@ class EntityNameEntity {
 
   // #RemoveOp
 
-
-  #unexpected(ctx, err) {
-    const clean = this.#utility.clean
-    const struct = this.#utility.struct
-
-    const delprop = struct.delprop
-    const clone = struct.clone
-    const merge = struct.merge
-
-    const ctrl = ctx.ctrl
-
-    ctrl.err = err
-
-    if (ctrl.explain) {
-      ctx.ctrl.explain = clean(ctx, ctx.ctrl.explain)
-      delprop(ctx.ctrl.explain.result, 'err')
-
-      if (null != ctx.result && null != ctx.result.err) {
-        ctrl.explain.err = clean(ctx, merge([
-          clone({ err: ctx.result.err }).err,
-          {
-            message: ctx.result.err.message,
-            stack: ctx.result.err.stack,
-          }]))
-      }
-
-      const cleanerr = clean(ctx, merge([
-        clone({ err }).err,
-        {
-          message: err.message,
-          stack: err.stack,
-        }]))
-
-      if (null == ctrl.explain.err) {
-        ctrl.explain.err = cleanerr
-      }
-      else if (ctrl.explain.err.message != cleanerr.message) {
-        ctrl.explain.unexpected = cleanerr
-      }
-    }
-
-    if (false === ctrl.throw) {
-      return undefined
-    }
-
-    return err
-  }
-
 }
 
 

package/project/.sdk/src/cmp/js/fragment/EntityBase.fragment.js

@@ -0,0 +1,149 @@
+
+const { inspect } = require('node:util')
+
+
+// TODO: needs Entity superclass
+class ProjectNameEntityBase {
+  name = ''
+  name_ = ''
+  Name = ''
+
+  _client
+  _utility
+  _entopts
+  _data
+  _match
+  _entctx
+
+
+  constructor(client, entopts) {
+    entopts = entopts || {}
+    entopts.active = false !== entopts.active
+
+    this._client = client
+    this._entopts = entopts
+    this._utility = client.utility()
+    this._data = {}
+    this._match = {}
+
+    const makeContext = this._utility.makeContext
+
+    this._entctx = makeContext({
+      entity: this,
+      entopts,
+    }, client._rootctx)
+
+    const featureHook = this._utility.featureHook
+    featureHook(this._entctx, 'PostConstructEntity')
+  }
+
+  entopts() {
+    return this._utility.struct.merge([{}, this._entopts])
+  }
+
+  client() {
+    return this._client
+  }
+
+
+  data(data) {
+    const struct = this._utility.struct
+    const featureHook = this._utility.featureHook
+
+    if (null != data) {
+      this._data = struct.clone(data)
+      featureHook(this._entctx, 'SetData')
+    }
+
+    featureHook(this._entctx, 'GetData')
+    let out = struct.clone(this._data)
+
+    return out
+  }
+
+
+  match(match) {
+    const struct = this._utility.struct
+    const featureHook = this._utility.featureHook
+
+    if (null != match) {
+      this._match = struct.clone(match)
+      featureHook(this._entctx, 'SetMatch')
+    }
+
+    featureHook(this._entctx, 'GetMatch')
+    let out = struct.clone(this._match)
+
+    return out
+  }
+
+
+  toJSON() {
+    const struct = this._utility.struct
+    return struct.merge([{}, struct.getdef(this._data, {}), { entity$: this.Name }])
+  }
+
+
+  toString() {
+    return this.Name + ' ' + this._utility.struct.jsonify(this._data)
+  }
+
+
+  [inspect.custom]() {
+    return this.toString()
+  }
+
+
+  _unexpected(ctx, err) {
+    const clean = this._utility.clean
+    const struct = this._utility.struct
+
+    const delprop = struct.delprop
+    const clone = struct.clone
+    const merge = struct.merge
+
+    const ctrl = ctx.ctrl
+
+    ctrl.err = err
+
+    if (ctrl.explain) {
+      ctx.ctrl.explain = clean(ctx, ctx.ctrl.explain)
+      delprop(ctx.ctrl.explain.result, 'err')
+
+      if (null != ctx.result && null != ctx.result.err) {
+        ctrl.explain.err = clean(ctx, merge([
+          clone({ err: ctx.result.err }).err,
+          {
+            message: ctx.result.err.message,
+            stack: ctx.result.err.stack,
+          }]))
+      }
+
+      const cleanerr = clean(ctx, merge([
+        clone({ err }).err,
+        {
+          message: err.message,
+          stack: err.stack,
+        }]))
+
+      if (null == ctrl.explain.err) {
+        ctrl.explain.err = cleanerr
+      }
+      else if (ctrl.explain.err.message != cleanerr.message) {
+        ctrl.explain.unexpected = cleanerr
+      }
+    }
+
+    if (false === ctrl.throw) {
+      return undefined
+    }
+
+    return err
+  }
+
+}
+
+
+module.exports = {
+  ProjectNameEntityBase
+}

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

@@ -1,16 +1,12 @@
 
 class EntityOperation {
 
-  #match
-  #data
-  #utility
-
 
   // EJECT-START
 
   async create(reqdata, ctrl) {
 
-    const utility = this.#utility
+    const utility = this._utility
     const {
       makeContext,
       done,
@@ -28,8 +24,8 @@ class EntityOperation {
     let ctx = makeContext({
       opname: 'create',
       ctrl,
-      match: this.#match,
-      data: this.#data,
+      match: this._match,
+      data: this._data,
       reqdata
     }, this._entctx)
 
@@ -78,7 +74,7 @@ class EntityOperation {
 
       if (null != ctx.result) {
         if (null != ctx.result.resdata) {
-          this.#data = ctx.result.resdata
+          this._data = ctx.result.resdata
         }
       }
 
@@ -87,7 +83,7 @@ class EntityOperation {
     catch (err) {
       // #PreUnexpected-Hook
 
-      err = this.#unexpected(ctx, err)
+      err = this._unexpected(ctx, err)
 
       if (err) {
         throw err
@@ -101,5 +97,5 @@ class EntityOperation {
   // EJECT-END
 
 
-  #unexpected(ctx, err) { return err }
+  _unexpected(ctx, err) { return err }
 }

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

@@ -1,16 +1,12 @@
 
 class EntityOperation {
 
-  #match
-  #data
-  #utility
-
 
   // EJECT-START
 
   async list(reqmatch, ctrl) {
 
-    const utility = this.#utility
+    const utility = this._utility
 
     const {
       makeContext,
@@ -29,8 +25,8 @@ class EntityOperation {
     let ctx = makeContext({
       opname: 'list',
       ctrl,
-      match: this.#match,
-      data: this.#data,
+      match: this._match,
+      data: this._data,
       reqmatch
     }, this._entctx)
 
@@ -79,7 +75,7 @@ class EntityOperation {
 
       if (null != ctx.result) {
         if (null != ctx.result.resmatch) {
-          this.#match = ctx.result.resmatch
+          this._match = ctx.result.resmatch
         }
       }
 
@@ -88,7 +84,7 @@ class EntityOperation {
     catch (err) {
       // #PreUnexpected-Hook
 
-      err = this.#unexpected(ctx, err)
+      err = this._unexpected(ctx, err)
 
       if (err) {
         throw err
@@ -102,7 +98,7 @@ class EntityOperation {
   // EJECT-END
 
 
-  #unexpected(_ctx, err) { return err }
+  _unexpected(_ctx, err) { return err }
 
 }