@voxgig/sdkgen 1.2.1 → 1.3.2

package/project/.sdk/src/cmp/lua/ReadmeQuick_lua.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, isAuthActive } from '@voxgig/sdkgen'
+import { cmp, each, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityDataIdField, entityOps } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -14,57 +14,181 @@ const ReadmeQuick = cmp(function ReadmeQuick(props: any) {
   const entity = getModelPath(model, `main.${KIT}.entity`)
 
   const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
+
+  // Find a nested entity if available: one with a parent chain
+  // (relations.ancestors), an active load op, and a required non-id load
+  // param to demonstrate (the parent key, e.g. page_id).
   const nestedEntity = Object.values(entity).find((e: any) =>
-    e.active !== false && e.ancestors && e.ancestors.length > 0
+    e.active !== false &&
+    e.relations && e.relations.ancestors && 0 < e.relations.ancestors.length &&
+    entityOps(e).includes('load') &&
+    opRequestShape(e, 'load').items.some((it: any) =>
+      !it.optional && it.name !== entityIdField(e))
   ) as any
 
-  const apikeyArg = isAuthActive(model)
-    ? `\n  apikey = os.getenv("${model.NAME}_APIKEY"),\n`
-    : ''
+  const ctor = isAuthActive(model)
+    ? `sdk.new({\n  apikey = os.getenv("${envName(model)}_APIKEY"),\n})`
+    : `sdk.new()`
 
   Content(`### 1. Create a client
 
 \`\`\`lua
 local sdk = require("${model.name}_sdk")
 
-local client = sdk.new({${apikeyArg}})
+local client = ${ctor}
 \`\`\`
 
 `)
 
   if (exampleEntity) {
     const eName = nom(exampleEntity, 'Name')
-    const opnames = Object.keys(exampleEntity.op || {})
+    const article = /^[aeiou]/i.test(eName) ? "an" : "a"
+    const opnames = entityOps(exampleEntity)
+    // Model-driven id key: `idF` is the MATCH key (null when none). `dataIdF`
+    // is the id on the RETURNED record's data type — an entity can key its match
+    // on an id it does not carry as data, so a record id read (`item["id"]`,
+    // `created["id"]`) must be guarded on this, not the match key.
+    const idF = entityIdField(exampleEntity)
+    const dataIdF = entityDataIdField(exampleEntity)
+
+    // A type-correct, executable Lua literal for a param: numeric/boolean/
+    // table params render a typed literal; strings render the quoted
+    // placeholder (the doc test EXECUTES these blocks, so a comment
+    // placeholder would not parse). Non-identifier keys use bracket syntax.
+    const luaLit = (type: any, placeholder: string = 'example'): string => {
+      const k = canonKey(type)
+      if ('INTEGER' === k || 'NUMBER' === k) return '1'
+      if ('BOOLEAN' === k) return 'true'
+      if ('ARRAY' === k || 'OBJECT' === k) return '{}'
+      return `"${placeholder}"`
+    }
+    const luaKey = (name: string): string =>
+      /^[A-Za-z_]\w*$/.test(name) ? name : `["${name}"]`
+
+    // MODEL-DRIVEN display field: the list example must reference a field
+    // the entity actually has, not a hardcoded "name". Pick the entity's
+    // first non-id string field (falling back to the first non-id field of
+    // any type). The id key stays `id` — the SDK renames every id param to
+    // `id`, matching the load example and the seeded test fixture.
+    const idNames = new Set<string>(['id',
+      (exampleEntity.id && exampleEntity.id.field) || 'id'])
+    const fields: any[] = Array.isArray(exampleEntity.fields) ? exampleEntity.fields : []
+    const isStringField = (f: any) =>
+      f && typeof f.type === 'string' && /STRING/i.test(f.type)
+    const displayFieldObj =
+      fields.find((f: any) => f && !idNames.has(f.name) && isStringField(f)) ||
+      fields.find((f: any) => f && !idNames.has(f.name))
+    const displayField = displayFieldObj ? displayFieldObj.name : null
+    const idCol = dataIdF ? `item["${dataIdF}"]` : null
+    const dispCol = displayField ? `item["${displayField}"]` : null
+    const printCols = [idCol, dispCol].filter(Boolean).join(', ')
+    const printLine = printCols ? `  print(${printCols})` : `  print(item)`
 
     if (opnames.includes('list')) {
-      Content(`### 2. List ${eName.toLowerCase()}s
+      Content(`### 2. List ${eName.toLowerCase()} records
+
+Entity operations return \`(value, err)\`. For \`list\`, \`value\` is the
+array of records itself — iterate it directly (there is no wrapper).
 
 \`\`\`lua
-local result, err = client:${eName}(nil):list(nil, nil)
+local ${eName.toLowerCase()}s, err = client:${eName}():list()
 if err then error(err) end
 
-if type(result) == "table" then
-  for _, item in ipairs(result) do
-    local d = item:data_get()
-    print(d["id"], d["name"])
-  end
+for _, item in ipairs(${eName.toLowerCase()}s) do
+${printLine}
 end
 \`\`\`
 
 `)
     }
 
-    if (opnames.includes('load')) {
-      Content(`### 3. Load a ${eName.toLowerCase()}
+    if (nestedEntity) {
+      const neName = nom(nestedEntity, 'Name')
+      const neArticle = /^[aeiou]/i.test(neName) ? "an" : "a"
+      const neVar = neName.toLowerCase()
+
+      // Model-driven match: every REQUIRED load-match key — the same shape
+      // the runtime resolves path params from, so the example always works.
+      // Parent keys (e.g. page_id) first, the entity's own id last.
+      const neIdF = entityIdField(nestedEntity)
+      const neRequired = opRequestShape(nestedEntity, 'load').items
+        .filter((it: any) => !it.optional)
+        .sort((a: any, b: any) =>
+          (a.name === neIdF ? 1 : 0) - (b.name === neIdF ? 1 : 0))
+      const parentItem = neRequired.find((it: any) => it.name !== neIdF) as any
+      const parentParam = parentItem && parentItem.name
+      const parentName = parentParam ? parentParam.replace(/_id$/, '') : 'its parent'
+      const neMatch = neRequired.map((it: any) =>
+        `${luaKey(it.name)} = ${luaLit(it.type,
+          it.name === neIdF ? 'example_id' : 'example_' + it.name)}`)
+
+      Content(`### 3. Load ${neArticle} ${neName.toLowerCase()}
+
+${neName} is nested under ${parentName}, so provide the \`${parentParam}\`.
 
 \`\`\`lua
-local result, err = client:${eName}(nil):load({ id = "example_id" }, nil)
+local ${neVar}, err = client:${neName}():load({ ${neMatch.join(', ')} })
 if err then error(err) end
-print(result)
+print(${neVar})
 \`\`\`
 
 `)
     }
+    else 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 loadRequired = 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 < loadRequired.length
+        ? `{ ${loadRequired.map((it: any) =>
+          `${luaKey(it.name)} = ${luaLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)}`).join(', ')} }`
+        : ''
+
+      Content(`### 3. Load ${article} ${eName.toLowerCase()}
+
+\`\`\`lua
+local ${eName.toLowerCase()}, err = client:${eName}():load(${loadArg})
+if err then error(err) end
+print(${eName.toLowerCase()})
+\`\`\`
+
+`)
+    }
+
+    // Model-driven example fields: derive the create/update body from the op
+    // shape (opRequestShape) so the docs reference REAL writable fields, not a
+    // hardcoded "name" the entity may not have. Literals are Lua-typed by the
+    // field's canonical type; non-identifier keys use bracket syntax. ids are
+    // rendered separately as the match key for update/remove; a REQUIRED
+    // create id stays (the call is invalid without it).
+    const examplePairs = (opname: string): string[] => {
+      const items = opRequestShape(exampleEntity, opname).items
+        .filter((it: any) => !idNames.has(it.name) ||
+          ('create' === opname && !it.optional))
+      const required = items.filter((it: any) => !it.optional)
+      const optional = items.filter((it: any) => it.optional)
+      // create needs ALL required fields; update is a patch, so the required
+      // members plus a sample optional field or two suffice.
+      const chosen = 'create' === opname
+        ? (required.length ? required : items.slice(0, 2))
+        : required.concat(optional).slice(0, Math.max(2, required.length))
+      return chosen.map((it: any) =>
+        `${luaKey(it.name)} = ${luaLit(it.type, 'example_' + it.name)}`)
+    }
+
+    // The id VALUE for an update/remove match: off the returned `created` record
+    // only when its data type carries the id AND a create ran, else a literal.
+    const idParamType = (opname: string): any => {
+      const it = opRequestShape(exampleEntity, opname).items.find((x: any) => x.name === idF)
+      return it && it.type
+    }
+    const idValueFor = (opname: string): string => (null != dataIdF && opnames.includes('create'))
+      ? `created["${dataIdF}"]`
+      : luaLit(idParamType(opname), 'example_id')
 
     if (opnames.includes('create') || opnames.includes('update') || opnames.includes('remove')) {
       Content(`### 4. Create, update, and remove
@@ -73,19 +197,30 @@ print(result)
 `)
       if (opnames.includes('create')) {
         Content(`-- Create
-local created, _ = client:${eName}(nil):create({ name = "Example" }, nil)
+local created, err = client:${eName}():create({ ${examplePairs('create').join(', ')} })
+if err then error(err) end
 
 `)
       }
       if (opnames.includes('update')) {
+        const updatePairs = (idF ? [`${idF} = ${idValueFor('update')}`] : []).concat(examplePairs('update'))
         Content(`-- Update
-client:${eName}(nil):update({ id = created["id"], name = "Example-Renamed" }, nil)
+client:${eName}():update({ ${updatePairs.join(', ')} })
 
 `)
       }
       if (opnames.includes('remove')) {
+        // Every REQUIRED remove-match key: the id (off the created record
+        // when possible) plus parent keys like page_id.
+        const removePairs = opRequestShape(exampleEntity, 'remove').items
+          .filter((it: any) => !it.optional || it.name === idF)
+          .sort((a: any, b: any) =>
+            (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+          .map((it: any) => it.name === idF
+            ? `${luaKey(it.name)} = ${idValueFor('remove')}`
+            : `${luaKey(it.name)} = ${luaLit(it.type, 'example_' + it.name)}`)
         Content(`-- Remove
-client:${eName}(nil):remove({ id = created["id"] }, nil)
+client:${eName}():remove(${removePairs.length ? `{ ${removePairs.join(', ')} }` : ''})
 `)
       }
       Content(`\`\`\`

package/project/.sdk/src/cmp/lua/ReadmeRef_lua.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, File, isAuthActive } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, canonKey, File, isAuthActive, entityIdField, opRequestShape } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -7,6 +7,24 @@ import {
 } from '@voxgig/apidef'
 
 
+// A type-correct, executable Lua literal for a param: numeric/boolean/table
+// params render a typed literal; strings render the quoted placeholder (the
+// doc test EXECUTES runnable blocks, so a comment placeholder would not
+// parse).
+function luaLit(type: any, placeholder: string = 'example'): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k || 'NUMBER' === k) return '1'
+  if ('BOOLEAN' === k) return 'true'
+  if ('ARRAY' === k || 'OBJECT' === k) return '{}'
+  return `"${placeholder}"`
+}
+
+// Non-identifier table keys use bracket syntax.
+function luaKey(name: string): string {
+  return /^[A-Za-z_]\w*$/.test(name) ? name : `["${name}"]`
+}
+
+
 const OP_SIGNATURES: Record<string, { sig: string, returns: string, desc: string }> = {
   load: {
     sig: 'load(reqmatch, ctrl) -> any, err',
@@ -71,8 +89,7 @@ Create a new SDK client instance.
 | Name | Type | Description |
 | --- | --- | --- |
 | \`options\` | \`table\` | SDK configuration options. |
-| \`options.apikey\` | \`string\` | API key for authentication. |
-| \`options.base\` | \`string\` | Base URL for API requests. |
+${isAuthActive(model) ? '| \`options.apikey\` | \`string\` | API key for authentication. |\n' : ''}| \`options.base\` | \`string\` | Base URL for API requests. |
 | \`options.prefix\` | \`string\` | URL prefix appended after base. |
 | \`options.suffix\` | \`string\` | URL suffix appended after path. |
 | \`options.headers\` | \`table\` | Custom headers for all requests. |
@@ -87,12 +104,12 @@ Create a new SDK client instance.
 
 `)
 
-    Content(`#### \`sdk.test(testopts, sdkopts)\`
+    Content(`#### \`sdk.test(testopts?, sdkopts?)\`
 
-Create a test client with mock features active. Both arguments may be \`nil\`.
+Create a test client with mock features active. Both arguments are optional.
 
 \`\`\`lua
-local client = sdk.test(nil, nil)
+local client = sdk.test()
 \`\`\`
 
 `)
@@ -154,6 +171,9 @@ same parameters as \`direct()\`.
     publishedEntities.map((ent: any) => {
       const opnames = Object.keys(ent.op || {})
       const fields = ent.fields || []
+      // Model-driven id key: null when this entity has no id-like field, in
+      // which case load/remove match on no argument and update omits the id.
+      const idF = entityIdField(ent)
 
       Content(`
 ---
@@ -185,7 +205,7 @@ local ${ent.name} = client:${ent.Name}(nil)
         each(fields, (field: any) => {
           const req = field.req ? 'Yes' : 'No'
           const desc = field.short || ''
-          Content(`| \`${field.name}\` | \`${field.type || 'any'}\` | ${req} | ${desc} |
+          Content(`| \`${field.name}\` | \`${canonToType(field.type, target.name)}\` | ${req} | ${desc} |
 `)
         })
 
@@ -195,15 +215,18 @@ local ${ent.name} = client:${ent.Name}(nil)
         // Field operations breakdown
         const hasFieldOps = fields.some((f: any) => f.op && Object.keys(f.op).length > 0)
         if (hasFieldOps) {
+          // Only emit columns for operations this entity actually exposes —
+          // never advertise a create/update/remove column the entity lacks.
+          const opcols = ['load', 'list', 'create', 'update', 'remove']
+            .filter((op: string) => opnames.includes(op) && ent.op[op]?.active !== false)
           Content(`### Field Usage by Operation
 
-| Field | load | list | create | update | remove |
-| --- | --- | --- | --- | --- | --- |
+| Field | ${opcols.join(' | ')} |
+| --- | ${opcols.map(() => '---').join(' | ')} |
 `)
           each(fields, (field: any) => {
             const fops = field.op || {}
-            const cols = ['load', 'list', 'create', 'update', 'remove'].map((op: string) => {
-              if (!opnames.includes(op)) return '-'
+            const cols = opcols.map((op: string) => {
               const fop = fops[op]
               if (null == fop) return '-'
               if (fop.active === false) return '-'
@@ -237,40 +260,65 @@ ${info.desc}
 
           // Show example
           if ('load' === opname || 'remove' === opname) {
+            // The id key plus every REQUIRED match key (parent path params
+            // like page_id) — the same shape the runtime resolves path
+            // params from, so the example always works.
+            const matchItems = opRequestShape(ent, opname).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 arg = 0 < matchItems.length
+              ? `{ ${matchItems.map((it: any) =>
+                `${luaKey(it.name)} = ${luaLit(it.type,
+                  it.name === idF ? ent.name + '_id' : it.name)}`).join(', ')} }`
+              : ''
             Content(`\`\`\`lua
-local result, err = client:${ent.Name}(nil):${opname}({ id = "${ent.name}_id" }, nil)
+local result, err = client:${ent.Name}():${opname}(${arg})
 \`\`\`
 
 `)
           }
           else if ('list' === opname) {
             Content(`\`\`\`lua
-local results, err = client:${ent.Name}(nil):list(nil, nil)
+local results, err = client:${ent.Name}():list()
 \`\`\`
 
 `)
           }
           else if ('create' === opname) {
+            // Members come from the SAME shape the runtime validates
+            // (opRequestShape): every required member must appear — including
+            // a required id and parent keys like page_id (the --[[ type ]]
+            // placeholders mark the block as an illustration for the doc
+            // gate).
+            const createItems = opRequestShape(ent, 'create').items
+              .filter((it: any) => !it.optional)
             Content(`\`\`\`lua
-local result, err = client:${ent.Name}(nil):create({
+local result, err = client:${ent.Name}():create({
 `)
-            each(fields, (field: any) => {
-              if ('id' !== field.name && field.req) {
-                Content(`  ${field.name} = --[[ ${field.type || 'value'} ]],
+            createItems.map((it: any) => {
+              Content(`  ${luaKey(it.name)} = --[[ ${canonToType(it.type, target.name)} ]],
 `)
-              }
             })
-            Content(`}, nil)
+            Content(`})
 \`\`\`
 
 `)
           }
           else if ('update' === opname) {
+            // The id key plus every REQUIRED data member — the same shape the
+            // runtime validates — then the patch-fields note.
+            const updateItems = opRequestShape(ent, 'update').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 updateLines = updateItems.map((it: any) =>
+              `  ${luaKey(it.name)} = ${luaLit(it.type,
+                it.name === idF ? ent.name + '_id' : it.name)},\n`).join('')
             Content(`\`\`\`lua
-local result, err = client:${ent.Name}(nil):update({
-  id = "${ent.name}_id",
-  -- Fields to update
-}, nil)
+local result, err = client:${ent.Name}():update({
+${updateLines}  -- Fields to update
+})
 \`\`\`
 
 `)

package/project/.sdk/src/cmp/lua/ReadmeTopQuick_lua.ts

@@ -1,5 +1,5 @@
 
-import { cmp, Content, isAuthActive } from '@voxgig/sdkgen'
+import { cmp, Content, isAuthActive, envName, canonKey, entityIdField, opRequestShape } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -8,6 +8,23 @@ import {
 } from '@voxgig/apidef'
 
 
+// A type-correct, executable Lua literal for a param: numeric/boolean/table
+// params render a typed literal; strings render the quoted placeholder (the
+// doc test EXECUTES this block, so a comment placeholder would break it).
+function luaLit(type: any, placeholder: string = 'example'): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k || 'NUMBER' === k) return '1'
+  if ('BOOLEAN' === k) return 'true'
+  if ('ARRAY' === k || 'OBJECT' === k) return '{}'
+  return `"${placeholder}"`
+}
+
+// Non-identifier table keys use bracket syntax.
+function luaKey(name: string): string {
+  return /^[A-Za-z_]\w*$/.test(name) ? name : `["${name}"]`
+}
+
+
 const ReadmeTopQuick = cmp(function ReadmeTopQuick(props: any) {
   const { target, ctx$: { model } } = props
 
@@ -15,34 +32,54 @@ const ReadmeTopQuick = cmp(function ReadmeTopQuick(props: any) {
 
   const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
 
-  const apikeyArg = isAuthActive(model)
-    ? `\n  apikey = os.getenv("${model.NAME}_APIKEY"),\n`
-    : ''
+  const authActive = isAuthActive(model)
+  const ctor = authActive
+    ? `sdk.new({\n  apikey = os.getenv("${envName(model)}_APIKEY"),\n})`
+    : `sdk.new()`
 
   Content(`\`\`\`lua
 local sdk = require("${model.name}_sdk")
 
-local client = sdk.new({${apikeyArg}})
+local client = ${ctor}
 
 `)
 
   if (exampleEntity) {
     const eName = nom(exampleEntity, 'Name')
     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 no match argument.
+    const idF = entityIdField(exampleEntity)
+
+    let hasCall = false
 
     if (opnames.includes('list')) {
       Content(`-- List all ${eName.toLowerCase()}s
-local ${eName.toLowerCase()}s, err = client:${eName}(nil):list(nil, nil)
+local ${eName.toLowerCase()}s, err = client:${eName}():list()
+print(${eName.toLowerCase()}s)
 `)
+      hasCall = true
     }
 
     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
+        ? `{ ${loadItems.map((it: any) =>
+          `${luaKey(it.name)} = ${luaLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)}`).join(', ')} }`
+        : ''
       Content(`
 -- Load a specific ${eName.toLowerCase()}
-local ${eName.toLowerCase()}, err = client:${eName}(nil):load(
-  { id = "example_id" }, nil
-)
+local ${eName.toLowerCase()}, err = client:${eName}():load(${loadArg})
+print(${eName.toLowerCase()})
 `)
+      hasCall = true
     }
   }
 

package/project/.sdk/src/cmp/lua/ReadmeTopTest_lua.ts

@@ -1,5 +1,5 @@
 
-import { cmp, Content } from '@voxgig/sdkgen'
+import { cmp, Content, canonKey, entityIdField, entityPrimaryOp, opRequestShape } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -8,6 +8,20 @@ import {
 } from '@voxgig/apidef'
 
 
+// A type-correct Lua literal for a field's canonical type.
+function luaLit(type: any): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k || 'NUMBER' === k) return '1'
+  if ('BOOLEAN' === k) return 'true'
+  if ('ARRAY' === k || 'OBJECT' === k) return '{}'
+  return '"example"'
+}
+
+function luaKey(name: string): string {
+  return /^[A-Za-z_]\w*$/.test(name) ? name : `["${name}"]`
+}
+
+
 const ReadmeTopTest = cmp(function ReadmeTopTest(props: any) {
   const { target, ctx$: { model } } = props
 
@@ -16,14 +30,38 @@ const ReadmeTopTest = cmp(function ReadmeTopTest(props: any) {
   const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
 
   Content(`\`\`\`lua
-local client = sdk.test(nil, nil)
+local client = sdk.test()
 `)
 
   if (exampleEntity) {
     const eName = nom(exampleEntity, 'Name')
-    Content(`local result, err = client:${eName}(nil):load(
-  { id = "test01" }, nil
-)
+    // Drive the test-mode example off the entity's PRIMARY op (never a hardcoded
+    // `load` a create-only entity lacks).
+    const idF = entityIdField(exampleEntity)
+    const primaryOp = entityPrimaryOp(exampleEntity) || 'load'
+    const isMatchOp = 'load' === primaryOp || 'remove' === primaryOp
+    let arg = ''
+    if (isMatchOp) {
+      // Every REQUIRED match key (id first, then parent path params like
+      // page_id) — the same shape the runtime resolves path params from.
+      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
+        ? `{ ${items.map((it: any) =>
+          `${luaKey(it.name)} = ${it.name === idF ? '"test01"' : luaLit(it.type)}`).join(', ')} }`
+        : ''
+    } 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 = `{ ${chosen.map((it: any) => `${luaKey(it.name)} = ${luaLit(it.type)}`).join(', ')} }`
+    }
+    // A list result is an array — name the variable accordingly.
+    const rVar = 'list' === primaryOp ? 'results' : 'result'
+    Content(`local ${rVar}, err = client:${eName}():${primaryOp}(${arg})
 `)
   }
 

package/project/.sdk/src/cmp/lua/Test_lua.ts

@@ -13,6 +13,7 @@ import { cmp, each, Folder, File, Content } from '@voxgig/sdkgen'
 
 import { TestEntity } from './TestEntity_lua'
 import { TestDirect } from './TestDirect_lua'
+import { ReadmeExamplesTest } from './ReadmeExamplesTest_lua'
 
 
 const Test = cmp(function Test(props: any) {
@@ -40,6 +41,9 @@ end)
       TestEntity({ target, entity })
       TestDirect({ target, entity })
     })
+
+    // README ```lua example snippets: syntax-check + offline run.
+    ReadmeExamplesTest({ target })
   })
 })
 

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

@@ -5,6 +5,10 @@ local entityCreateOp = {}
 
 -- EJECT-START
 
+---@param reqdata EntityNameCreateData
+---@param ctrl? table
+---@return EntityName
+---@return string? err
 function EntityNameEntity:create(reqdata, ctrl)
   local utility = self._utility
   local ctx = utility.make_context({

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

@@ -2,6 +2,10 @@ local entityListOp = {}
 
 -- EJECT-START
 
+---@param reqmatch EntityNameListMatch
+---@param ctrl? table
+---@return EntityName[]
+---@return string? err
 function EntityNameEntity:list(reqmatch, ctrl)
   local utility = self._utility
   local ctx = utility.make_context({

package/project/.sdk/src/cmp/lua/fragment/EntityLoadOp.fragment.lua

@@ -5,6 +5,10 @@ local entityLoadOp = {}
 
 -- EJECT-START
 
+---@param reqmatch EntityNameLoadMatch
+---@param ctrl? table
+---@return EntityName
+---@return string? err
 function EntityNameEntity:load(reqmatch, ctrl)
   local utility = self._utility
   local ctx = utility.make_context({

package/project/.sdk/src/cmp/lua/fragment/EntityRemoveOp.fragment.lua

@@ -5,6 +5,10 @@ local entityRemoveOp = {}
 
 -- EJECT-START
 
+---@param reqmatch EntityNameRemoveMatch
+---@param ctrl? table
+---@return EntityName
+---@return string? err
 function EntityNameEntity:remove(reqmatch, ctrl)
   local utility = self._utility
   local ctx = utility.make_context({

package/project/.sdk/src/cmp/lua/fragment/EntityUpdateOp.fragment.lua

@@ -5,6 +5,10 @@ local entityUpdateOp = {}
 
 -- EJECT-START
 
+---@param reqdata EntityNameUpdateData
+---@param ctrl? table
+---@return EntityName
+---@return string? err
 function EntityNameEntity:update(reqdata, ctrl)
   local utility = self._utility
   local ctx = utility.make_context({