@voxgig/sdkgen 1.3.14 → 1.3.17

package/project/.sdk/src/cmp/swift/ReadmeTopQuick_swift.ts

@@ -0,0 +1,105 @@
+
+import { cmp, Content, isAuthActive, envName, canonKey, entityIdField, opRequestShape } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+  nom,
+} from '@voxgig/apidef'
+
+import { swiftVarName } from './utility_swift'
+
+
+// A type-correct Swift `Value` literal for a param: numeric/boolean/array/
+// object params render a typed literal; strings render the quoted placeholder.
+// The SDK's loose object model means every value is a `Value` inside a `VMap`.
+function swiftLit(type: any, placeholder: string = 'example'): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k) return '.int(1)'
+  if ('NUMBER' === k) return '.double(1.0)'
+  if ('BOOLEAN' === k) return '.bool(true)'
+  if ('ARRAY' === k) return '.list([])'
+  if ('OBJECT' === k) return '.map(VMap())'
+  return `.string("${placeholder}")`
+}
+
+
+const ReadmeTopQuick = cmp(function ReadmeTopQuick(props: any) {
+  const { target, ctx$: { model } } = props
+
+  const SDK = model.const.Name + 'SDK'
+  const MODULE = model.const.Name + 'Sdk'
+
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+
+  const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
+
+  const authActive = isAuthActive(model)
+
+  Content(`\`\`\`swift
+import ${MODULE}
+
+`)
+
+  if (authActive) {
+    Content(`let options = VMap()
+options.entries["apikey"] = .string(
+    ProcessInfo.processInfo.environment["${envName(model)}_APIKEY"] ?? "")
+let client = ${SDK}(options)
+
+`)
+  }
+  else {
+    Content(`let client = ${SDK}()
+
+`)
+  }
+
+  if (exampleEntity) {
+    const eName = nom(exampleEntity, 'Name')
+    const eVar = swiftVarName(exampleEntity.name)
+    const eNameLower = eName.toLowerCase()
+    const opnames = Object.keys(exampleEntity.op || {})
+    // Model-driven id key: null when the entity has no id-like field, in which
+    // case the load example takes an empty match.
+    const idF = entityIdField(exampleEntity)
+
+    if (opnames.includes('list')) {
+      Content(`// List all ${eNameLower}s (returns a Value list, throws on error)
+let ${eVar}List = try client.${eName}().list(nil, nil)
+for ${eVar} in ${eVar}List.asList?.items ?? [] {
+    print(${eVar})
+}
+`)
+    }
+
+    if (opnames.includes('load')) {
+      // Every REQUIRED load-match key (id first, then parent path params like
+      // page_id) — the same shape the runtime resolves path params from, so
+      // the example always works.
+      const loadItems = opRequestShape(exampleEntity, 'load').items
+        .filter((it: any) => !it.optional || it.name === idF)
+        .sort((a: any, b: any) =>
+          (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+      const loadArg = 0 < loadItems.length
+        ? `VMap([${loadItems.map((it: any) =>
+          `("${it.name}", ${swiftLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)})`).join(', ')}])`
+        : 'nil'
+      Content(`
+// Load a specific ${eNameLower} (returns the record, throws on error)
+let ${eVar} = try client.${eName}().load(${loadArg}, nil)
+print(${eVar})
+`)
+    }
+  }
+
+  Content(`\`\`\`
+`)
+
+})
+
+
+export {
+  ReadmeTopQuick
+}

package/project/.sdk/src/cmp/swift/ReadmeTopTest_swift.ts

@@ -0,0 +1,77 @@
+
+import { cmp, Content, canonKey, entityIdField, pickExampleEntity, opRequestShape } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+import { swiftVarName } from './utility_swift'
+
+
+// A type-correct Swift `Value` literal for a field's canonical type.
+function swiftLit(type: any): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k) return '.int(1)'
+  if ('NUMBER' === k) return '.double(1.0)'
+  if ('BOOLEAN' === k) return '.bool(true)'
+  if ('ARRAY' === k) return '.list([])'
+  if ('OBJECT' === k) return '.map(VMap())'
+  return '.string("example")'
+}
+
+
+const ReadmeTopTest = cmp(function ReadmeTopTest(props: any) {
+  const { target, ctx$: { model } } = props
+
+  const SDK = model.const.Name + 'SDK'
+
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+
+  // Pick an entity with a real op (prefer a read op) — never fabricate a
+  // `load` on an op-less entity.
+  const { entity: exampleEntity, primaryOp } = pickExampleEntity(entity)
+
+  Content(`\`\`\`swift
+let client = ${SDK}.testSDK(nil, nil)
+`)
+
+  if (exampleEntity && primaryOp) {
+    const eName = exampleEntity.Name
+    const idF = entityIdField(exampleEntity)
+    const isMatchOp = 'load' === primaryOp || 'remove' === primaryOp
+    let arg = 'nil'
+    if (isMatchOp) {
+      // Every REQUIRED match key (id first) — the same shape that generates
+      // the op's request type, so the block stays honest.
+      const items = opRequestShape(exampleEntity, primaryOp).items
+        .filter((it: any) => !it.optional || it.name === idF)
+        .sort((a: any, b: any) =>
+          (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+      arg = 0 < items.length
+        ? `VMap([${items.map((it: any) =>
+          `("${it.name}", ${it.name === idF ? '.string("test01")' : swiftLit(it.type)})`).join(', ')}])`
+        : 'nil'
+    } else if ('create' === primaryOp || 'update' === primaryOp) {
+      const items = opRequestShape(exampleEntity, primaryOp).items
+        .filter((it: any) => it.name !== idF && it.name !== 'id')
+      const required = items.filter((it: any) => !it.optional)
+      const chosen = required.length ? required : items.slice(0, 3)
+      arg = `VMap([${chosen.map((it: any) =>
+        `("${it.name}", ${swiftLit(it.type)})`).join(', ')}])`
+    }
+    const eVar = swiftVarName(exampleEntity.name) + ('list' === primaryOp ? 'List' : '')
+    Content(`let ${eVar} = try client.${eName}().${primaryOp}(${arg}, nil)
+print(${eVar})
+`)
+  }
+
+  Content(`\`\`\`
+`)
+
+})
+
+
+export {
+  ReadmeTopTest
+}

package/project/.sdk/src/cmp/swift/Test_swift.ts

@@ -13,6 +13,7 @@ import { cmp, each, Folder } from '@voxgig/sdkgen'
 
 import { TestEntity } from './TestEntity_swift'
 import { TestDirect } from './TestDirect_swift'
+import { ReadmeExamplesTest } from './ReadmeExamplesTest_swift'
 
 
 const Test = cmp(function Test(props: any) {
@@ -29,6 +30,9 @@ const Test = cmp(function Test(props: any) {
         TestEntity({ target, entity })
         TestDirect({ target, entity })
       })
+
+      // Validate the documented swift examples in the READMEs are well-formed.
+      ReadmeExamplesTest({ target })
     })
   })
 })

package/project/.sdk/src/cmp/ts/EntityTypes_ts.ts

@@ -21,7 +21,7 @@ import {
   File, Content,
 } from '@voxgig/sdkgen'
 
-import { canonToType, opTypeName, opRequestShape } from '@voxgig/sdkgen'
+import { canonToType, opTypeName, opRequestShape, warnEntityTypeCollisions } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -39,15 +39,29 @@ function propKey(name: string): string {
 
 
 const EntityTypes = cmp(function EntityTypes(props: any) {
-  const { model } = props.ctx$
-
-  const entity = getModelPath(model, `main.${KIT}.entity`)
-  const entityList = each(entity).filter((e: any) => e.active !== false)
+  const { model, log } = props.ctx$
+
+  // only_active:false — getModelPath DROPS active:false entries by default,
+  // but the consumer scaffold (create-sdkgen Root.ts) iterates the RAW entity
+  // collection, so inactive entities still get generated entity code that
+  // references these typed names. The typed model must cover them too.
+  const entity = getModelPath(model, `main.${KIT}.entity`, { only_active: false, required: false })
+  // Emit for EVERY entity that gets generated entity code: the consumer
+  // scaffold (create-sdkgen Root.ts) iterates entities WITHOUT an active
+  // filter, so inactive entities still get class files referencing these
+  // typed names. Filter on `name` (always present), NOT `active` — parity
+  // with the go emitter's fix.
+  const entityList = each(entity).filter((e: any) => e && null != e.name)
   // Derive the PascalCase Name up-front — it is set LAZILY by names(), so an
   // entity not yet named (e.g. a fieldless placeholder) would otherwise read
   // `Name = undefined` below. Parity with the go emitter's fix.
   entityList.forEach((e: any) => { if (null == e.Name) names(e, e.name) })
 
+  // Surface duplicate generated type names (two entities with the same
+  // PascalCase Name) — they would redeclare a type in statically-typed
+  // targets. Detection only; renaming is a model-level decision.
+  warnEntityTypeCollisions(entity, log, LANG)
+
   File({ name: model.const.Name + 'Types.' + LANG }, () => {
 
     Content(`// Typed models for the ${model.const.Name} SDK.

package/project/.sdk/src/cmp/ts/MainEntity_ts.ts

@@ -18,9 +18,11 @@ const MainEntity = cmp(async function MainEntity(props: any) {
 
   Content(`
   // Entity access: \`client.${entity.Name}().list()\` / \`client.${entity.Name}().load({ id })\`.
-  ${entity.Name}(data?: any) {
+  // The argument is the entity OPTIONS object (passed to the entity
+  // constructor as entopts), not initial entity data.
+  ${entity.Name}(entopts?: Record<string, any>) {
     const self = this
-    return new ${cls}(self,data)
+    return new ${cls}(self, entopts)
   }
 
 `)

package/project/.sdk/src/cmp/ts/ReadmeEntity_ts.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, canonToType, entityIdField, opRequestShape, safeVarName } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, entityIdField, opRequestShape, safeVarName, exampleVarName, jsKey } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -46,7 +46,7 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
     // Model-driven id key: null when this entity has no id-like field.
     const idF = entityIdField(entity)
     // Variable-safe lowercase name (a `Delete` entity must not bind `delete`).
-    const eVar = safeVarName(entity.name, target.name)
+    const eVar = exampleVarName(entity.name, target.name)
 
     Content(`
 ### ${entity.Name}
@@ -108,7 +108,7 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
           (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
       const loadArg = 0 < loadItems.length
         ? `{ ${loadItems.map((it: any) =>
-          `${it.name}: ${exampleValue(entity, entity.op && entity.op.load, it.name,
+          `${jsKey(it.name)}: ${exampleValue(entity, entity.op && entity.op.load, it.name,
             it.name === idF ? entity.name + '_id' : it.name)}`).join(', ')} }`
         : ''
       Content(`#### Example: Load
@@ -143,7 +143,7 @@ const ${eVar}s = await client.${entity.Name}().list()
 const ${eVar} = await client.${entity.Name}().create({
 `)
       createItems.map((it: any) => {
-        Content(`  ${it.name}: ${exampleValue(entity, entity.op && entity.op.create, it.name, 'example_' + it.name)},
+        Content(`  ${jsKey(it.name)}: ${exampleValue(entity, entity.op && entity.op.create, it.name, 'example_' + it.name)},
 `)
       })
       Content(`})

package/project/.sdk/src/cmp/ts/ReadmeHowto_ts.ts

@@ -1,5 +1,5 @@
 
-import { cmp, Content, isAuthActive, envName, entityIdField, entityDataIdField, pickExampleEntity, opRequestShape, safeVarName } from '@voxgig/sdkgen'
+import { cmp, Content, isAuthActive, envName, entityIdField, entityDataIdField, pickExampleEntity, opRequestShape, safeVarName, exampleVarName, jsKey } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -20,7 +20,7 @@ const ReadmeHowto = cmp(function ReadmeHowto(props: any) {
   const { entity: exampleEntity, primaryOp } = pickExampleEntity(entity)
   const eName = exampleEntity ? nom(exampleEntity, 'Name') : 'Entity'
   // Variable-safe lowercase name (a `Delete` entity must not bind `delete`).
-  const eVar = safeVarName(eName.toLowerCase(), 'ts')
+  const eVar = exampleVarName(eName.toLowerCase(), 'ts')
 
   const primaryOpDef = exampleEntity && primaryOp && exampleEntity.op && exampleEntity.op[primaryOp]
   const isMatchOp = 'load' === primaryOp || 'remove' === primaryOp
@@ -35,7 +35,17 @@ const ReadmeHowto = cmp(function ReadmeHowto(props: any) {
     if (!exampleEntity || !primaryOp) return ''
     if ('list' === primaryOp) return ''
     if (isMatchOp) {
-      return idF ? `{ ${idF}: ${exampleValue(exampleEntity, primaryOpDef, idF, idPlaceholder)} }` : ''
+      // Every REQUIRED match key (id first), not just idF — a composite-match
+      // entity (e.g. Umbrella's FlatPermission, database_id + id) needs them all
+      // to satisfy the typed <Name>LoadMatch. Mirrors ReadmeTopTest.
+      const items = opRequestShape(exampleEntity, primaryOp).items
+        .filter((it: any) => !it.optional || it.name === idF)
+        .sort((a: any, b: any) => (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+      if (0 === items.length) return ''
+      const pairs = items.map((it: any) =>
+        `${jsKey(it.name)}: ${exampleValue(exampleEntity, primaryOpDef, it.name,
+          it.name === idF ? idPlaceholder : 'example_' + it.name)}`)
+      return `{ ${pairs.join(', ')} }`
     }
     // create / update: a body of the required writable fields.
     const items = opRequestShape(exampleEntity, primaryOp).items
@@ -43,7 +53,7 @@ const ReadmeHowto = cmp(function ReadmeHowto(props: any) {
     const required = items.filter((it: any) => !it.optional)
     const chosen = required.length ? required : items.slice(0, 3)
     const pairs = chosen.map((it: any) =>
-      `${it.name}: ${exampleValue(exampleEntity, primaryOpDef, it.name, 'example_' + it.name)}`)
+      `${jsKey(it.name)}: ${exampleValue(exampleEntity, primaryOpDef, it.name, 'example_' + it.name)}`)
     return `{ ${pairs.join(', ')} }`
   }
   const testCallArg = primaryArg('test01')

package/project/.sdk/src/cmp/ts/ReadmeQuick_ts.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, isAuthActive, packageName, envName, opRequestShape, entityIdField, entityDataIdField, entityOps, safeVarName } from '@voxgig/sdkgen'
+import { cmp, each, Content, isAuthActive, packageName, envName, opRequestShape, entityIdField, entityDataIdField, entityOps, safeVarName, exampleVarName, jsKey } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -48,7 +48,7 @@ const client = ${ctor}
     const eName = nom(exampleEntity, 'Name')
     // Variable-safe lowercase name — a `Delete`/`Class` entity must not bind a
     // reserved word (`const delete = ...` is a TS1109 syntax error).
-    const eVar = safeVarName(eName.toLowerCase(), 'ts')
+    const eVar = exampleVarName(eName.toLowerCase(), 'ts')
     const article = /^[aeiou]/i.test(eName) ? 'an' : 'a'
     const opnames = entityOps(exampleEntity)
     // Model-driven id key: `idF` is the entity's id-like MATCH field name, or
@@ -78,7 +78,7 @@ for (const ${eVar} of ${eVar}s) {
 
     if (nestedEntity) {
       const neName = nom(nestedEntity, 'Name')
-      const neVar = safeVarName(neName.toLowerCase(), 'ts')
+      const neVar = exampleVarName(neName.toLowerCase(), 'ts')
       const neArticle = /^[aeiou]/i.test(neName) ? 'an' : 'a'
       const loadOp = nestedEntity.op && nestedEntity.op.load
 
@@ -94,7 +94,7 @@ for (const ${eVar} of ${eVar}s) {
       const parentParam = parentItem && parentItem.name
       const parentName = parentParam ? parentParam.replace(/_id$/, '') : 'its parent'
       const neMatchLines = neRequired.map((it: any) =>
-        `    ${it.name}: ${exampleValue(nestedEntity, loadOp, it.name,
+        `    ${jsKey(it.name)}: ${exampleValue(nestedEntity, loadOp, it.name,
           it.name === neIdF ? 'example_id' : 'example_' + it.name)},`)
 
       Content(`### 3. Load ${neArticle} ${neName.toLowerCase()}
@@ -124,7 +124,7 @@ ${neMatchLines.join('\n')}
           (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
       const loadArg = 0 < loadRequired.length
         ? `{ ${loadRequired.map((it: any) =>
-          `${it.name}: ${exampleValue(exampleEntity, exampleEntity.op && exampleEntity.op.load, it.name,
+          `${jsKey(it.name)}: ${exampleValue(exampleEntity, exampleEntity.op && exampleEntity.op.load, it.name,
             it.name === idF ? 'example_id' : 'example_' + it.name)}`).join(', ')} }`
         : ''
 
@@ -169,15 +169,33 @@ try {
           ? (required.length ? required : items.slice(0, 2))
           : required.concat(optional).slice(0, Math.max(2, required.length))
         return chosen.map((it: any) =>
-          `  ${it.name}: ${exampleValue(exampleEntity, exampleEntity.op[opname], it.name, 'example_' + it.name)},`)
+          `  ${jsKey(it.name)}: ${exampleValue(exampleEntity, exampleEntity.op[opname], it.name, 'example_' + it.name)},`)
       }
 
       // The id VALUE for an update/remove match. When the entity's DATA type
       // carries the id (dataIdF) AND a `created` record exists, take it off the
       // returned record; otherwise use a type-correct literal — reading
       // `created.id` off an id-less data type is a TS2339.
-      const canUseCreatedId = null != dataIdF && opnames.includes('create')
-      const idValueFor = (opname: string): string => canUseCreatedId
+      // Type of the data field we would read off `created` (e.g. number for an
+      // integer id). null when unknown.
+      const dataFields: any[] = exampleEntity.fields ? each(exampleEntity.fields) : []
+      const dataIdType = dataIdF
+        ? (dataFields.find((f: any) => f && f.name === dataIdF) || {}).type
+        : null
+      // `created.<dataIdF>` is only usable as an op's id-match value when its
+      // type matches that op's id PARAM type. An id that is integer in the data
+      // type but string in the match path (a spec quirk seen on management
+      // APIs) would be a TS2322 otherwise — fall back to a type-correct literal.
+      const usesCreatedId = (opname: string): boolean => {
+        if (null == dataIdF || !opnames.includes('create')) {
+          return false
+        }
+        const matchItem = opRequestShape(exampleEntity, opname).items
+          .find((it: any) => it.name === idF)
+        const matchType = matchItem ? matchItem.type : null
+        return null == matchType || null == dataIdType || matchType === dataIdType
+      }
+      const idValueFor = (opname: string): string => usesCreatedId(opname)
         ? `created.${dataIdF}!`
         : exampleValue(exampleEntity, exampleEntity.op[opname], idF as string, 'example_id')
 
@@ -198,7 +216,7 @@ const created = await client.${eName}().create({${createBody}})
         // type carries one, else a literal), plus a couple of patch fields.
         const updateLines = (idF ? [`  ${idF}: ${idValueFor('update')},`] : []).concat(exampleFields('update'))
         const updateBody = updateLines.length ? '\n' + updateLines.join('\n') + '\n' : ''
-        Content(`// Update${canUseCreatedId ? ' — the id comes straight off the returned entity' : ''}
+        Content(`// Update${usesCreatedId('update') ? ' — the id comes straight off the returned entity' : ''}
 const updated = await client.${eName}().update({${updateBody}})
 
 `)
@@ -211,8 +229,8 @@ const updated = await client.${eName}().update({${updateBody}})
           .sort((a: any, b: any) =>
             (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
           .map((it: any) => it.name === idF
-            ? `  ${it.name}: ${idValueFor('remove')},`
-            : `  ${it.name}: ${exampleValue(exampleEntity, exampleEntity.op.remove, it.name, 'example_' + it.name)},`)
+            ? `  ${jsKey(it.name)}: ${idValueFor('remove')},`
+            : `  ${jsKey(it.name)}: ${exampleValue(exampleEntity, exampleEntity.op.remove, it.name, 'example_' + it.name)},`)
         Content(`// Remove
 await client.${eName}().remove(${removeLines.length ? `{\n${removeLines.join('\n')}\n}` : ''})
 `)

package/project/.sdk/src/cmp/ts/ReadmeRef_ts.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, canonToType, File, isAuthActive, entityIdField, opRequestShape, safeVarName } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, File, isAuthActive, entityIdField, opRequestShape, safeVarName, exampleVarName, jsKey } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -185,7 +185,7 @@ Alias for \`${model.Name}SDK.test()\`.
       // which case load/remove match on no argument and update omits the id.
       const idF = entityIdField(ent)
       // Variable-safe lowercase name (a `Delete` entity must not bind `delete`).
-      const eVar = safeVarName(ent.name, target.name)
+      const eVar = exampleVarName(ent.name, target.name)
 
       Content(`
 ---
@@ -281,7 +281,7 @@ ${info.desc}
                 (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
             const arg = 0 < matchItems.length
               ? `{ ${matchItems.map((it: any) =>
-                `${it.name}: ${exampleValue(ent, ent.op && ent.op[opname], it.name,
+                `${jsKey(it.name)}: ${exampleValue(ent, ent.op && ent.op[opname], it.name,
                   it.name === idF ? ent.name + '_id' : it.name)}`).join(', ')} }`
               : ''
             Content(`\`\`\`ts
@@ -308,7 +308,7 @@ const results = await client.${ent.Name}().${opname}()
 const result = await client.${ent.Name}().create({
 `)
             createItems.map((it: any) => {
-              Content(`  ${it.name}: ${exampleValue(ent, ent.op && ent.op.create, it.name, 'example_' + it.name)},
+              Content(`  ${jsKey(it.name)}: ${exampleValue(ent, ent.op && ent.op.create, it.name, 'example_' + it.name)},
 `)
             })
             Content(`})
@@ -324,7 +324,7 @@ const result = await client.${ent.Name}().create({
               .sort((a: any, b: any) =>
                 (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
             const updateLines = updateItems.map((it: any) =>
-              `  ${it.name}: ${exampleValue(ent, ent.op && ent.op.update, it.name,
+              `  ${jsKey(it.name)}: ${exampleValue(ent, ent.op && ent.op.update, it.name,
                 it.name === idF ? ent.name + '_id' : it.name)},\n`).join('')
             Content(`\`\`\`ts
 const result = await client.${ent.Name}().update({

package/project/.sdk/src/cmp/ts/ReadmeTopQuick_ts.ts

@@ -1,5 +1,5 @@
 
-import { cmp, Content, isAuthActive, packageName, envName, entityIdField, entityOps, opRequestShape, safeVarName } from '@voxgig/sdkgen'
+import { cmp, Content, isAuthActive, packageName, envName, entityIdField, entityOps, opRequestShape, safeVarName, exampleVarName, jsKey } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -30,7 +30,7 @@ const client = ${ctor}
 
   if (exampleEntity) {
     const eName = nom(exampleEntity, 'Name')
-    const eVar = safeVarName(eName.toLowerCase(), 'ts')
+    const eVar = exampleVarName(eName.toLowerCase(), 'ts')
     const opnames = entityOps(exampleEntity)
 
     let hasCall = false
@@ -58,7 +58,7 @@ for (const ${eVar} of ${eVar}s) {
 
     if (nestedEntity) {
       const neName = nom(nestedEntity, 'Name')
-      const neVar = safeVarName(neName.toLowerCase(), 'ts')
+      const neVar = exampleVarName(neName.toLowerCase(), 'ts')
       const loadOp = nestedEntity.op && nestedEntity.op.load
 
       // Every REQUIRED load-match key (parent keys first, own id last) — the
@@ -70,7 +70,7 @@ for (const ${eVar} of ${eVar}s) {
         .sort((a: any, b: any) =>
           (a.name === neIdF ? 1 : 0) - (b.name === neIdF ? 1 : 0))
         .map((it: any) =>
-          `  ${it.name}: ${exampleValue(nestedEntity, loadOp, it.name,
+          `  ${jsKey(it.name)}: ${exampleValue(nestedEntity, loadOp, it.name,
             it.name === neIdF ? 'example_id' : 'example_' + it.name)},`)
 
       Content(`

package/project/.sdk/src/cmp/ts/ReadmeTopTest_ts.ts

@@ -1,5 +1,5 @@
 
-import { cmp, Content, entityIdField, pickExampleEntity, opRequestShape, safeVarName } from '@voxgig/sdkgen'
+import { cmp, Content, entityIdField, pickExampleEntity, opRequestShape, safeVarName, exampleVarName, jsKey } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -25,7 +25,7 @@ const client = ${model.const.Name}SDK.test()
   if (exampleEntity && primaryOp) {
     const eName = nom(exampleEntity, 'Name')
     // A list() result is an array — name the variable accordingly.
-    const eVar = safeVarName(eName.toLowerCase(), 'ts') +
+    const eVar = exampleVarName(eName.toLowerCase(), 'ts') +
       ('list' === primaryOp ? 's' : '')
     const primaryOpDef = exampleEntity.op && exampleEntity.op[primaryOp]
     const idF = entityIdField(exampleEntity)
@@ -39,7 +39,7 @@ const client = ${model.const.Name}SDK.test()
           (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
       arg = 0 < items.length
         ? `{ ${items.map((it: any) =>
-          `${it.name}: ${exampleValue(exampleEntity, primaryOpDef, it.name,
+          `${jsKey(it.name)}: ${exampleValue(exampleEntity, primaryOpDef, it.name,
             it.name === idF ? 'test01' : 'example_' + it.name)}`).join(', ')} }`
         : ''
     } else if ('create' === primaryOp || 'update' === primaryOp) {
@@ -48,7 +48,7 @@ const client = ${model.const.Name}SDK.test()
       const required = items.filter((it: any) => !it.optional)
       const chosen = required.length ? required : items.slice(0, 3)
       arg = `{ ${chosen.map((it: any) =>
-        `${it.name}: ${exampleValue(exampleEntity, primaryOpDef, it.name, 'example_' + it.name)}`).join(', ')} }`
+        `${jsKey(it.name)}: ${exampleValue(exampleEntity, primaryOpDef, it.name, 'example_' + it.name)}`).join(', ')} }`
     }
     Content(`const ${eVar} = await client.${eName}().${primaryOp}(${arg})
 // ${eVar} is ${'list' === primaryOp ? `an array of bare ${eName} records` : `a bare ${eName}`} populated with mock data

package/project/.sdk/src/cmp/ts/TestDirect_ts.ts

@@ -17,6 +17,8 @@ import {
   cmp,
   snakify,
   isAuthActive,
+  jsProp,
+  jsOptProp,
 } from '@voxgig/sdkgen'
 
 
@@ -192,7 +194,7 @@ function generateDirectLoad(model: Model, entity: ModelEntity) {
     .filter((q: any) => q.reqd && undefined !== q.example && null !== q.example)
   const hasLiveQuery = liveQueryEntries.length > 0
   const liveQueryLines = liveQueryEntries
-    .map((q: any) => `      query.${q.name} = ${JSON.stringify(q.example)}`)
+    .map((q: any) => `      ${jsProp('query', q.name)} = ${JSON.stringify(q.example)}`)
     .join('\n')
 
   // Get list info for live mode bootstrapping
@@ -245,12 +247,12 @@ function generateDirectLoad(model: Model, entity: ModelEntity) {
   let liveParamsBlock = ''
   if (allLoadParamsHaveExamples) {
     const exampleLines = loadParams.map(
-      (p: any) => `      params.${p.name} = ${JSON.stringify(p.example)}`
+      (p: any) => `      ${jsProp('params', p.name)} = ${JSON.stringify(p.example)}`
     ).join('\n')
     liveParamsBlock = `    if (setup.live) {
 ${liveQueryPrefix}${exampleLines}
     } else {
-${loadParams.map((p: any, i: number) => `      params.${p.name} = 'direct0${i + 1}'`).join('\n')}
+${loadParams.map((p: any, i: number) => `      ${jsProp('params', p.name)} = 'direct0${i + 1}'`).join('\n')}
     }`
   }
   else if (hasList) {
@@ -262,7 +264,7 @@ ${loadParams.map((p: any, i: number) => `      params.${p.name} = 'direct0${i +
     const listParamLines = liveListParams.map((lp: any) =>
       `        ${lp.name}: setup.idmap['${lp.key}'],`).join('\n')
     const ancestorParamLines = liveAncestorParams.map((lp: any) =>
-      `      params.${lp.name} = setup.idmap['${lp.key}']`).join('\n')
+      `      ${jsProp('params', lp.name)} = setup.idmap['${lp.key}']`).join('\n')
     // Try every load-path param name as the candidate field on listData[0].
     // Some APIs name the path param differently from the response field
     // (e.g. path uses {id} while response has mal_id), so we attempt the
@@ -286,14 +288,14 @@ ${listParamLines}
       if (null == listArr || listArr.length === 0) {
         return // skip: no entities to load in live mode
       }
-      const candidateId = listArr[0]?.${idParamName} ?? listArr[0]?.id
+      const candidateId = ${jsOptProp('listArr[0]', idParamName)} ?? listArr[0]?.id
       if (null == candidateId) {
         return // skip: list response shape does not expose load identifier
       }
-      params.${idParamName} = candidateId
+      ${jsProp('params', idParamName)} = candidateId
 ${ancestorParamLines}
     } else {
-${loadParams.map((p: any, i: number) => `      params.${p.name} = 'direct0${i + 1}'`).join('\n')}
+${loadParams.map((p: any, i: number) => `      ${jsProp('params', p.name)} = 'direct0${i + 1}'`).join('\n')}
     }`
   } else if (hasLiveQuery || loadParams.length > 0) {
     // Synthetic-only fallback: if there are load params with no examples
@@ -306,7 +308,7 @@ ${loadParams.map((p: any, i: number) => `      params.${p.name} = 'direct0${i +
     liveParamsBlock = `    if (setup.live) {
 ${liveQueryPrefix.replace(/\n$/, '')}
     } else {
-${loadParams.map((p: any, i: number) => `      params.${p.name} = 'direct0${i + 1}'`).join('\n')}
+${loadParams.map((p: any, i: number) => `      ${jsProp('params', p.name)} = 'direct0${i + 1}'`).join('\n')}
     }`
   } else {
     liveParamsBlock = ''
@@ -369,7 +371,7 @@ function generateDirectList(model: Model, entity: ModelEntity) {
   const listQuery = listPoint.args?.query || []
   const liveQueryLines = listQuery
     .filter((q: any) => q.reqd && undefined !== q.example && null !== q.example)
-    .map((q: any) => `      query.${q.name} = ${JSON.stringify(q.example)}`)
+    .map((q: any) => `      ${jsProp('query', q.name)} = ${JSON.stringify(q.example)}`)
     .join('\n')
 
   // Build live params
@@ -388,10 +390,10 @@ function generateDirectList(model: Model, entity: ModelEntity) {
     const liveLines = [
       liveQueryLines,
       liveParams.map((lp: any) =>
-        `      params.${lp.name} = setup.idmap['${lp.key}']`).join('\n'),
+        `      ${jsProp('params', lp.name)} = setup.idmap['${lp.key}']`).join('\n'),
     ].filter(Boolean).join('\n')
     const mockLines = listParams.map((p: any, i: number) =>
-      `      params.${p.name} = 'direct0${i + 1}'`).join('\n')
+      `      ${jsProp('params', p.name)} = 'direct0${i + 1}'`).join('\n')
 
     paramsBlock = `    const params: any = {}
     const query: any = {}