@voxgig/sdkgen 1.2.1 → 1.3.2

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

@@ -1,21 +1,64 @@
 
-import { cmp, Content, isAuthActive } from '@voxgig/sdkgen'
+import { cmp, Content, isAuthActive, envName, entityIdField, entityDataIdField, entityPrimaryOp, opRequestShape, safeVarName } from '@voxgig/sdkgen'
 
 import {
   KIT,
   getModelPath,
+  nom,
 } from '@voxgig/apidef'
 
+import { exampleValue } from './utility_ts'
+
 
 const ReadmeHowto = cmp(function ReadmeHowto(props: any) {
   const { target, ctx$: { model } } = props
 
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+  const exampleEntity = Object.values(entity || {}).find((e: any) => e && e.active !== false) as any
+  const eName = exampleEntity ? nom(exampleEntity, 'Name') : 'Entity'
+  // Variable-safe lowercase name (a `Delete` entity must not bind `delete`).
+  const eVar = safeVarName(eName.toLowerCase(), 'ts')
+
+  // Drive the test-mode / stateful examples off the entity's PRIMARY op — an op
+  // it actually exposes — never a hardcoded `load` a create-only entity lacks.
+  const primaryOp = exampleEntity ? (entityPrimaryOp(exampleEntity) || 'load') : 'load'
+  const primaryOpDef = exampleEntity && exampleEntity.op && exampleEntity.op[primaryOp]
+  const isMatchOp = 'load' === primaryOp || 'remove' === primaryOp
+  // Model-driven id key: `idF` is the entity's id-like MATCH field name, or null
+  // when it has none. `dataIdF` is the id on the RETURNED record's data type —
+  // reading `.id` off a record whose data type has none is a TS2339.
+  const idF = exampleEntity ? entityIdField(exampleEntity) : null
+  const dataIdF = exampleEntity ? entityDataIdField(exampleEntity) : null
+
+  // A type-correct, language-idiomatic argument for the primary op call.
+  const primaryArg = (idPlaceholder: string): string => {
+    if (!exampleEntity) return ''
+    if ('list' === primaryOp) return ''
+    if (isMatchOp) {
+      return idF ? `{ ${idF}: ${exampleValue(exampleEntity, primaryOpDef, idF, idPlaceholder)} }` : ''
+    }
+    // create / update: a body of the required writable fields.
+    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)
+    const pairs = chosen.map((it: any) =>
+      `${it.name}: ${exampleValue(exampleEntity, primaryOpDef, it.name, 'example_' + it.name)}`)
+    return `{ ${pairs.join(', ')} }`
+  }
+  const testCallArg = primaryArg('test01')
+  const stateCallArg = primaryArg('example')
+  // Only read `.id` off the returned record when its data type carries one.
+  const stateDataLine = dataIdF
+    ? `console.log(data.${dataIdF})`
+    : `console.log(data)`
+
   const authActive = isAuthActive(model)
   const apikeyTesterCtor = authActive
     ? `new ${model.const.Name}SDK({ apikey: '...' })`
     : `new ${model.const.Name}SDK()`
   const apikeyExtendField = authActive ? `\n  apikey: '...',` : ''
-  const apikeyEnvLine = authActive ? `\n${model.NAME}_APIKEY=<your-key>` : ''
+  const apikeyEnvLine = authActive ? `\n${envName(model)}_APIKEY=<your-key>` : ''
 
   Content(`### Make a direct HTTP request
 
@@ -28,6 +71,9 @@ const result = await client.direct({
   params: { id: 'example' },
 })
 
+if (result instanceof Error) {
+  throw result
+}
 if (result.ok) {
   console.log(result.status)  // 200
   console.log(result.data)    // response body
@@ -56,9 +102,9 @@ Create a mock client for unit testing \u2014 no server required:
 \`\`\`ts
 const client = ${model.const.Name}SDK.test()
 
-const result = await client.Planet().load({ id: 'test01' })
-// result.ok === true
-// result.data contains mock response data
+const ${eVar} = await client.${eName}().${primaryOp}(${testCallArg})
+// ${eVar} is a bare entity populated with mock response data
+console.log(${eVar})
 \`\`\`
 
 You can also use the instance method:
@@ -73,14 +119,14 @@ const testClient = client.tester()
 Entity instances remember their last match and data:
 
 \`\`\`ts
-const entity = client.Planet()
+const entity = client.${eName}()
 
-// First call sets internal match
-await entity.load({ id: 'example' })
+// First call runs the operation and stores its result
+await entity.${primaryOp}(${stateCallArg})
 
-// Subsequent calls reuse the stored match
+// Subsequent calls reuse the stored state
 const data = entity.data()
-console.log(data.id) // 'example'
+${stateDataLine}
 \`\`\`
 
 ### Add custom middleware
@@ -109,7 +155,7 @@ const client = new ${model.const.Name}SDK({${apikeyExtendField}
 Create a \`.env.local\` file at the project root:
 
 \`\`\`
-${model.NAME}_TEST_LIVE=TRUE${apikeyEnvLine}
+${envName(model)}_TEST_LIVE=TRUE${apikeyEnvLine}
 \`\`\`
 
 Then run:

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

@@ -1,16 +1,29 @@
 
-import { cmp, Content } from '@voxgig/sdkgen'
+import { cmp, Content, installCommand, isPublished, repoInfo } from '@voxgig/sdkgen'
 
 
 const ReadmeInstall = cmp(function ReadmeInstall(props: any) {
-  const { target } = props
+  const { target, ctx$ } = props
+  const { model } = ctx$
 
-  Content('```bash')
-  Content(`
-npm install ${target.module.name}
+  if (isPublished(model, target.name)) {
+    Content('```bash')
+    Content(`
+${installCommand(model, target.name)}
 `)
-  Content('```')
+    Content('```')
+    return
+  }
 
+  // Publish pending: the package is not yet on npm, so install from the
+  // git release tag instead of a `npm install` that would 404.
+  const { releasesUrl } = repoInfo(model)
+  Content(`This package is not yet published to npm. Install it from the GitHub
+release tag (\`${target.name}/vX.Y.Z\`):
+
+- Releases: [${releasesUrl}](${releasesUrl})
+
+`)
 })
 
 

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

@@ -1,13 +1,51 @@
 
 import { cmp, Content } from '@voxgig/sdkgen'
 
+import {
+  KIT,
+  getModelPath,
+  nom,
+} from '@voxgig/apidef'
+
 
 const ReadmeIntro = cmp(function ReadmeIntro(props: any) {
   const { target, ctx$: { model } } = props
+  const info = (model.main && model.main.kit && model.main.kit.info) || {}
+  const tagline = info.tagline || ''
+
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+  const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
+  const eName = exampleEntity ? nom(exampleEntity, 'Name') : 'Entity'
+
+  // Model-driven op list — only the operations the active entities actually
+  // expose (a read-only entity has just list+load); never claim
+  // create/update/remove exist when no entity has them.
+  const CANON_OPS = ['list', 'load', 'create', 'update', 'remove']
+  const opSet = new Set<string>()
+  Object.values(entity || {}).forEach((e: any) => {
+    if (!e || e.active === false) return
+    Object.keys(e.op || {}).forEach((o: string) => {
+      if (e.op[o] && e.op[o].active !== false) opSet.add(o)
+    })
+  })
+  const opNames = CANON_OPS.filter((o) => opSet.has(o))
+    .concat([...opSet].filter((o) => !CANON_OPS.includes(o)))
+  const opList = (opNames.length ? opNames : ['list', 'load'])
+    .map((o) => '`' + o + '`').join(', ')
 
   Content(`# ${model.Name} ${target.title} SDK
 
-The ${target.title} SDK for the ${model.Name} API. Provides a type-safe, entity-oriented interface with full async/await support.
+${tagline}
+
+The ${target.title} SDK for the ${model.Name} API — a type-safe, entity-oriented client with full async/await support.
+
+The API is exposed as capitalised, semantic **Entities** — e.g.
+\`client.${eName}()\` — each with a small set of operations (${opList})
+instead of raw URL paths and query parameters. This keeps the surface
+predictable and low-friction for both humans and AI agents.
+
+> Other languages, the CLI, and MCP server live alongside this one — see
+> the [top-level README](../README.md).
 
 `)
 })

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

@@ -13,6 +13,43 @@ const ReadmeModel = cmp(function ReadmeModel(props: any) {
   const entity = getModelPath(model, `main.${KIT}.entity`)
   const entityList = each(entity).filter((e: any) => e.active !== false)
 
+  // Model-driven op rows for the shared entity interface: emit a
+  // load/list/create/update/remove row only for operations at least one active
+  // entity actually exposes (a read-only entity has just list+load) — never
+  // document an operation no entity has.
+  const opUnion = new Set<string>()
+  entityList.forEach((e: any) => Object.keys(e.op || {})
+    .forEach((o: string) => { if (e.op[o] && e.op[o].active !== false) opUnion.add(o) }))
+  const opRowDefs: Record<string, string> = {
+    load: '| `load` | `load(reqmatch?, ctrl?): Promise<Entity>` | Load a single entity by match criteria. |',
+    list: '| `list` | `list(reqmatch?, ctrl?): Promise<Entity[]>` | List entities matching the criteria. |',
+    create: '| `create` | `create(reqdata?, ctrl?): Promise<Entity>` | Create a new entity. |',
+    update: '| `update` | `update(reqdata?, ctrl?): Promise<Entity>` | Update an existing entity. |',
+    remove: '| `remove` | `remove(reqmatch?, ctrl?): Promise<void>` | Remove an entity. |',
+  }
+  const opRows = ['load', 'list', 'create', 'update', 'remove']
+    .filter((o) => opUnion.has(o)).map((o) => opRowDefs[o]).join('\n')
+
+  // Model-driven return-value bullets: describe only the operations that
+  // actually exist (single-object ops among load/create/update, plus
+  // list/remove) — never document return semantics for a missing op.
+  const singleOps = ['load', 'create', 'update'].filter((o) => opUnion.has(o))
+    .map((o) => '`' + o + '`')
+  const retBullets: string[] = []
+  if (singleOps.length) {
+    const joined = singleOps.length > 1
+      ? singleOps.slice(0, -1).join(', ') + ' and ' + singleOps[singleOps.length - 1]
+      : singleOps[0]
+    retBullets.push(`- ${joined} ${singleOps.length > 1 ? 'resolve' : 'resolves'} to a single entity object.`)
+  }
+  if (opUnion.has('list')) {
+    retBullets.push('- `list` resolves to an **array** of entity objects (iterate it directly;\n  there is no `.data` and no `.ok`).')
+  }
+  if (opUnion.has('remove')) {
+    retBullets.push('- `remove` resolves to `void`.')
+  }
+  const returnBullets = retBullets.join('\n')
+
   const authActive = isAuthActive(model)
   const apikeyOptionType = authActive ? `\n  apikey?: string` : ''
   const apikeyOptionRow = authActive
@@ -52,7 +89,8 @@ ${apikeyOptionRow}| \`base\` | \`string\` | Base URL of the API server. |
 `)
 
   each(entityList, (ent: any) => {
-    Content(`| \`${ent.Name}(data?)\` | \`${ent.Name}Entity\` | Create a ${ent.Name} entity instance. |
+    const article = /^[aeiou]/i.test(ent.Name) ? 'an' : 'a'
+    Content(`| \`${ent.Name}(data?)\` | \`${ent.Name}Entity\` | Create ${article} ${ent.Name} entity instance. |
 `)
   })
 
@@ -72,29 +110,23 @@ All entities share the same interface.
 
 | Method | Signature | Description |
 | --- | --- | --- |
-| \`load\` | \`load(reqmatch?, ctrl?): Promise<Result>\` | Load a single entity by match criteria. |
-| \`list\` | \`list(reqmatch?, ctrl?): Promise<Result>\` | List entities matching the criteria. |
-| \`create\` | \`create(reqdata?, ctrl?): Promise<Result>\` | Create a new entity. |
-| \`update\` | \`update(reqdata?, ctrl?): Promise<Result>\` | Update an existing entity. |
-| \`remove\` | \`remove(reqmatch?, ctrl?): Promise<Result>\` | Remove an entity. |
-| \`data\` | \`data(data?): any\` | Get or set entity data. |
-| \`match\` | \`match(match?): any\` | Get or set entity match criteria. |
+${opRows}
+| \`data\` | \`data(data?: Partial<Entity>): Entity\` | Get or set entity data. |
+| \`match\` | \`match(match?: Partial<Entity>): Partial<Entity>\` | Get or set entity match criteria. |
 | \`make\` | \`make(): Entity\` | Create a new instance with the same options. |
 | \`client\` | \`client(): ${model.const.Name}SDK\` | Return the parent SDK client. |
 | \`entopts\` | \`entopts(): object\` | Return a copy of the entity options. |
 
-#### Result shape
+#### Return values
 
-All entity operations return a Result object:
+Entity operations resolve to the entity data directly — there is no
+result envelope:
 
-\`\`\`ts
-{
-  ok: boolean      // true if the HTTP status is 2xx
-  status: number   // HTTP status code
-  headers: object  // response headers
-  data: any        // parsed JSON response body
-}
-\`\`\`
+${returnBullets}
+
+On a failed request these methods **throw**, so wrap calls in
+\`try\`/\`catch\` to handle errors. Only \`direct()\` returns the result
+envelope described below.
 
 ### DirectResult shape
 

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

@@ -1,12 +1,13 @@
 
-import { cmp, each, Content } from '@voxgig/sdkgen'
+import { cmp, each, Content, envName, isAuthActive } from '@voxgig/sdkgen'
 
 
 const ReadmeOptions = cmp(function ReadmeOptions(props: any) {
   const { target } = props
   const { model } = props.ctx$
 
-  const publishedOptions = each(target.options).filter((option: any) => option.publish)
+  const publishedOptions = each(target.options).filter((option: any) =>
+    option.publish && ('apikey' !== option.name || isAuthActive(model)))
   if (0 === publishedOptions.length) {
     return
   }
@@ -25,7 +26,7 @@ const client = new ${model.Name}SDK({
 
   publishedOptions.map((option: any) => {
     if ('apikey' === option.name) {
-      Content(`  ${option.name}: process.env.${model.NAME}_APIKEY,
+      Content(`  ${option.name}: process.env.${envName(model)}_APIKEY,
 `)
     }
     else {

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

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, isAuthActive } from '@voxgig/sdkgen'
+import { cmp, each, Content, isAuthActive, packageName, envName, opRequestShape, entityIdField, entityDataIdField, entityOps, safeVarName } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -7,6 +7,8 @@ import {
   nom,
 } from '@voxgig/apidef'
 
+import { exampleValue } from './utility_ts'
+
 
 const ReadmeQuick = cmp(function ReadmeQuick(props: any) {
   const { target, ctx$: { model } } = props
@@ -16,21 +18,27 @@ const ReadmeQuick = cmp(function ReadmeQuick(props: any) {
   // Find the first published entity for examples
   const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
 
-  // Find a nested entity if available
+  // 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: process.env.${model.NAME}_APIKEY,\n`
-    : ''
+  const ctor = isAuthActive(model)
+    ? `new ${model.const.Name}SDK({\n  apikey: process.env.${envName(model)}_APIKEY,\n})`
+    : `new ${model.const.Name}SDK()`
 
   Content(`### 1. Create a client
 
 \`\`\`ts
-import { ${model.const.Name}SDK } from '${target.module.name}'
+import { ${model.const.Name}SDK } from '${packageName(model, target.name)}'
 
-const client = new ${model.const.Name}SDK({${apikeyArg}})
+const client = ${ctor}
 \`\`\`
 
 `)
@@ -38,18 +46,30 @@ const client = new ${model.const.Name}SDK({${apikeyArg}})
 
   if (exampleEntity) {
     const eName = nom(exampleEntity, 'Name')
-    const opnames = Object.keys(exampleEntity.op || {})
+    // 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 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
+    // null when it has none (then load/remove match on no argument).
+    const idF = entityIdField(exampleEntity)
+    // The id field on the RETURNED record's data type, or null. DISTINCT from
+    // idF (the match key): an entity can key its load-match on an id it does not
+    // carry as a data field, so `.id` off a returned record must be guarded on
+    // this — reading `created.id` when the data type has no id is a TS2339.
+    const dataIdF = entityDataIdField(exampleEntity)
 
     if (opnames.includes('list')) {
-      Content(`### 2. List ${eName.toLowerCase()}s
+      Content(`### 2. List ${eName.toLowerCase()} records
+
+\`list()\` resolves to an array of ${eName} objects — iterate it directly:
 
 \`\`\`ts
-const result = await client.${eName}().list()
+const ${eVar}s = await client.${eName}().list()
 
-if (result.ok) {
-  for (const item of result.data) {
-    console.log(item.id, item.name)
-  }
+for (const ${eVar} of ${eVar}s) {
+  console.log(${eVar})
 }
 \`\`\`
 
@@ -58,70 +78,143 @@ if (result.ok) {
 
     if (nestedEntity) {
       const neName = nom(nestedEntity, 'Name')
-      const parentFields = (nestedEntity.fields || [])
-        .filter((f: any) => f.name !== 'id' && f.name.endsWith('_id'))
-      const parentParam = parentFields.length > 0 ? parentFields[0].name : 'parent_id'
-
-      Content(`### 3. Load a ${neName.toLowerCase()}
-
-${neName} is nested under ${eName}, so provide the \`${parentParam}\`:
+      const neVar = safeVarName(neName.toLowerCase(), 'ts')
+      const neArticle = /^[aeiou]/i.test(neName) ? 'an' : 'a'
+      const loadOp = nestedEntity.op && nestedEntity.op.load
+
+      // Model-driven match: every REQUIRED load-match key — the same shape
+      // that generates <Name>LoadMatch, so the example always type-checks.
+      // 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 neMatchLines = neRequired.map((it: any) =>
+        `    ${it.name}: ${exampleValue(nestedEntity, loadOp, it.name,
+          it.name === neIdF ? 'example_id' : 'example_' + it.name)},`)
+
+      Content(`### 3. Load ${neArticle} ${neName.toLowerCase()}
+
+${neName} is nested under ${parentName}, so provide the \`${parentParam}\`.
+\`load()\` returns the entity directly and throws on failure:
 
 \`\`\`ts
-const ${neName.toLowerCase()} = client.${neName}()
-const result = await ${neName.toLowerCase()}.load({
-  ${parentParam}: 'example',
-  id: 'example_id',
-})
-
-if (result.ok) {
-  console.log(result.data)
+try {
+  const ${neVar} = await client.${neName}().load({
+${neMatchLines.join('\n')}
+  })
+  console.log(${neVar})
+} catch (err) {
+  console.error('load failed:', err)
 }
 \`\`\`
 
 `)
     }
     else if (opnames.includes('load')) {
-      Content(`### 3. Load a ${eName.toLowerCase()}
+      // Every REQUIRED load-match key (id first) — the same shape that
+      // generates <Name>LoadMatch, so the example always type-checks.
+      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) =>
+          `${it.name}: ${exampleValue(exampleEntity, exampleEntity.op && exampleEntity.op.load, it.name,
+            it.name === idF ? 'example_id' : 'example_' + it.name)}`).join(', ')} }`
+        : ''
+
+      Content(`### 3. Load ${article} ${eName.toLowerCase()}
+
+\`load()\` returns the entity directly and throws on failure:
 
 \`\`\`ts
-const result = await client.${eName}().load({ id: 'example_id' })
-
-if (result.ok) {
-  console.log(result.data)
+try {
+  const ${eVar} = await client.${eName}().load(${loadArg})
+  console.log(${eVar})
+} catch (err) {
+  console.error('load failed:', err)
 }
 \`\`\`
 
 `)
     }
 
-    // CRUD operations
+    // CRUD operations. The create/update example payloads are derived from the
+    // SAME op shapes that generate the <Name>CreateData / <Name>UpdateData types
+    // (opRequestShape), so the snippet always type-checks. Prefer writable
+    // non-id fields and render a type-correct literal per field via
+    // exampleValue — never a hardcoded field the entity may not have.
     if (opnames.includes('create') || opnames.includes('update') || opnames.includes('remove')) {
+      // Writable non-id example fields for an op body. For create the REQUIRED
+      // fields must all appear or the literal is not assignable to the typed
+      // <Name>CreateData (a TS2345); update is a patch, so a couple of fields
+      // suffice.
+      const exampleFields = (opname: string): string[] => {
+        // ids are rendered separately as the match key for update/remove; a
+        // REQUIRED id stays (dropping it makes the literal unassignable).
+        const items = opRequestShape(exampleEntity, opname).items
+          .filter((it: any) => (it.name !== idF && it.name !== 'id') ||
+            ('create' === opname && !it.optional))
+        const required = items.filter((it: any) => !it.optional)
+        const optional = items.filter((it: any) => it.optional)
+        // Required members must all appear or the literal is not assignable
+        // to the typed <Name>{Create,Update}Data; pad update (a patch) with a
+        // sample optional field or two.
+        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) =>
+          `  ${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
+        ? `created.${dataIdF}!`
+        : exampleValue(exampleEntity, exampleEntity.op[opname], idF as string, 'example_id')
+
       Content(`### 4. Create, update, and remove
 
 \`\`\`ts
 `)
       if (opnames.includes('create')) {
-        Content(`// Create
-const created = await client.${eName}().create({
-  name: 'Example',
-})
+        const createLines = exampleFields('create')
+        const createBody = createLines.length ? '\n' + createLines.join('\n') + '\n' : ''
+        Content(`// Create — returns the created ${eName}
+const created = await client.${eName}().create({${createBody}})
 
 `)
       }
       if (opnames.includes('update')) {
-        Content(`// Update
-const updated = await client.${eName}().update({
-  id: created.data.id,
-  name: 'Example-Renamed',
-})
+        // Match on the id (from the returned `created` record when the data
+        // 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' : ''}
+const updated = await client.${eName}().update({${updateBody}})
 
 `)
       }
       if (opnames.includes('remove')) {
+        // Every REQUIRED remove-match key: the id (off the created record
+        // when possible) plus parent keys like page_id.
+        const removeLines = 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
+            ? `  ${it.name}: ${idValueFor('remove')},`
+            : `  ${it.name}: ${exampleValue(exampleEntity, exampleEntity.op.remove, it.name, 'example_' + it.name)},`)
         Content(`// Remove
-const removed = await client.${eName}().remove({
-  id: created.data.id,
-})
+await client.${eName}().remove(${removeLines.length ? `{\n${removeLines.join('\n')}\n}` : ''})
 `)
       }
       Content(`\`\`\`