@voxgig/sdkgen 1.3.14 → 1.3.17

package/project/.sdk/src/cmp/kotlin/ReadmeTopQuick_kotlin.ts

@@ -0,0 +1,104 @@
+
+import { cmp, Content, isAuthActive, envName, canonKey, entityIdField, opRequestShape } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+  nom,
+} from '@voxgig/apidef'
+
+import { kotlinVarName, kotlinPackage } from './utility_kotlin'
+
+
+// A type-correct Kotlin 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 all values live in MutableMap<String, Any?>.
+function kotlinLit(type: any, placeholder: string = 'example'): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k) return '1L'
+  if ('NUMBER' === k) return '1.0'
+  if ('BOOLEAN' === k) return 'true'
+  if ('ARRAY' === k) return 'listOf<Any?>()'
+  if ('OBJECT' === k) return 'mapOf<String, Any?>()'
+  return `"${placeholder}"`
+}
+
+
+const ReadmeTopQuick = cmp(function ReadmeTopQuick(props: any) {
+  const { target, ctx$: { model } } = props
+
+  const SDK = 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(`\`\`\`kotlin
+import ${kotlinPackage(model)}.core.${SDK}
+
+`)
+
+  if (authActive) {
+    Content(`val client = ${SDK}(mutableMapOf<String, Any?>(
+    "apikey" to System.getenv("${envName(model)}_APIKEY"),
+))
+
+`)
+  }
+  else {
+    Content(`val client = ${SDK}()
+
+`)
+  }
+
+  if (exampleEntity) {
+    // Sanitise the local variable name — an entity whose camelCased name is a
+    // Kotlin keyword gets a trailing underscore (kotlinVarName) so the snippet
+    // compiles.
+    const eVar = kotlinVarName(exampleEntity.name)
+    const accessor = kotlinVarName(exampleEntity.name)
+    const eNameLower = nom(exampleEntity, 'Name').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 Any?, an aggregate list; raises on error)
+val ${eVar}List = client.${accessor}(null).list(null, null)
+println(${eVar}List)
+`)
+    }
+
+    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
+        ? `mutableMapOf<String, Any?>(${loadItems.map((it: any) =>
+          `"${it.name}" to ${kotlinLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)}`).join(', ')})`
+        : 'null'
+      Content(`
+// Load a specific ${eNameLower} (returns the record, raises on error)
+val ${eVar} = client.${accessor}(null).load(${loadArg}, null)
+println(${eVar})
+`)
+    }
+  }
+
+  Content(`\`\`\`
+`)
+
+})
+
+
+export {
+  ReadmeTopQuick
+}

package/project/.sdk/src/cmp/kotlin/ReadmeTopTest_kotlin.ts

@@ -0,0 +1,77 @@
+
+import { cmp, Content, canonKey, entityIdField, pickExampleEntity, opRequestShape } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+import { kotlinVarName } from './utility_kotlin'
+
+
+// A type-correct Kotlin literal for a field's canonical type.
+function kotlinLit(type: any): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k) return '1L'
+  if ('NUMBER' === k) return '1.0'
+  if ('BOOLEAN' === k) return 'true'
+  if ('ARRAY' === k) return 'listOf<Any?>()'
+  if ('OBJECT' === k) return 'mapOf<String, Any?>()'
+  return '"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(`\`\`\`kotlin
+val client = ${SDK}.testSDK(null, null)
+`)
+
+  if (exampleEntity && primaryOp) {
+    const idF = entityIdField(exampleEntity)
+    const isMatchOp = 'load' === primaryOp || 'remove' === primaryOp
+    let arg = 'null'
+    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
+        ? `mutableMapOf<String, Any?>(${items.map((it: any) =>
+          `"${it.name}" to ${it.name === idF ? '"test01"' : kotlinLit(it.type)}`).join(', ')})`
+        : 'null'
+    } 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 = `mutableMapOf<String, Any?>(${chosen.map((it: any) =>
+        `"${it.name}" to ${kotlinLit(it.type)}`).join(', ')})`
+    }
+    const eVar = kotlinVarName(exampleEntity.name) + ('list' === primaryOp ? 'List' : '')
+    const accessor = kotlinVarName(exampleEntity.name)
+    Content(`val ${eVar} = client.${accessor}(null).${primaryOp}(${arg}, null)
+println(${eVar})
+`)
+  }
+
+  Content(`\`\`\`
+`)
+
+})
+
+
+export {
+  ReadmeTopTest
+}

package/project/.sdk/src/cmp/kotlin/Test_kotlin.ts

@@ -13,6 +13,7 @@ import { cmp, each, Folder } from '@voxgig/sdkgen'
 
 import { TestEntity } from './TestEntity_kotlin'
 import { TestDirect } from './TestDirect_kotlin'
+import { ReadmeExamplesTest } from './ReadmeExamplesTest_kotlin'
 import { kotlinPackage } from './utility_kotlin'
 
 
@@ -33,6 +34,9 @@ const Test = cmp(function Test(props: any) {
       TestEntity({ target, entity, kotlinpackage })
       TestDirect({ target, entity, kotlinpackage })
     })
+
+    // Validate the documented kotlin examples in the root + per-language docs.
+    ReadmeExamplesTest({ target, kotlinpackage })
   })
 })
 

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

@@ -54,7 +54,7 @@ const Config = cmp(async function Config(props: any) {
 
   File({ name: 'config.' + target.ext }, () => {
 
-    Content(`-- ProjectName SDK configuration
+    Content(`-- ${model.const.Name} SDK configuration
 
 local function make_config()
   return {

package/project/.sdk/src/cmp/lua/EntityTypes_lua.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,
@@ -41,15 +41,29 @@ function propKey(name: string): string {
 
 const EntityTypes = cmp(function EntityTypes(props: any) {
   const { target } = props
-  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.name + '_types.' + (target.ext || LANG) }, () => {
 
     Content(`-- Typed models for the ${model.const.Name} SDK (LuaLS annotations).

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

@@ -55,7 +55,19 @@ const Main = cmp(async function Main(props: any) {
         replace: {
           ...props.ctx$.stdrep,
 
-          '#BuildFeatures': ({ indent }: any) => {
+          // Load the LuaLS typed-model annotations module so it is part of
+          // the loaded program (module body is empty — no runtime effect) and
+          // does not depend on workspace-wide language-server scanning.
+          // NOTE: plain marker keys must EMBED the lua comment prefix
+          // (`-- #X`) — jostraca's bare `#X` form only matches `//`-style
+          // comment lines (cf. the `'-- #LoadOp'` keys in Entity_lua.ts).
+          '-- #TypesRequire': ({ indent }: any) => Content({ indent },
+            `-- Typed-model annotations (LuaLS ---@class); empty at runtime.\n` +
+            `require("${model.name}_types")`),
+
+          // Same embedded `-- ` prefix requirement as above (the bare
+          // '#BuildFeatures' key never matched the lua comment line).
+          '-- #BuildFeatures': ({ indent }: any) => {
             each(feature, (feat: any) => {
               const fname = feat.name.charAt(0).toUpperCase() + feat.name.slice(1)
               Content({ indent }, `  -- feature: ${feat.name}
@@ -90,7 +102,7 @@ self._utility.feature_hook(self._rootctx, "${name}")
 
   // Generate feature factory module
   File({ name: 'features.' + target.ext }, () => {
-    Content(`-- ProjectName SDK feature factory
+    Content(`-- ${model.const.Name} SDK feature factory
 
 local BaseFeature = require("feature.base_feature")
 `)

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

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, canonToType, canonKey, entityIdField, opRequestShape, safeVarName } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, canonKey, entityIdField, opRequestShape, safeVarName, exampleVarName } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -63,7 +63,7 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
     const idF = entityIdField(entity)
     // Sanitise the local variable name — an entity whose lowercased name is a
     // Lua keyword (e.g. `end`) would otherwise emit uncompilable code.
-    const eVar = safeVarName(entity.name, 'lua')
+    const eVar = exampleVarName(entity.name, 'lua')
 
     Content(`
 ### ${entity.Name}

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

@@ -36,7 +36,12 @@ const ReadmeHowto = cmp(function ReadmeHowto(props: any) {
   const isMatchOp = 'load' === primaryOp || 'remove' === primaryOp
   let testCallArg = ''
   if (exampleEntity && isMatchOp) {
-    testCallArg = idF ? `{ ${idF} = "test01" }` : ''
+    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))
+    testCallArg = 0 < items.length
+      ? `{ ${items.map((it: any) => `${luaKey(it.name)} = ${it.name === idF ? '"test01"' : luaLit(it.type)}`).join(', ')} }`
+      : ''
   } else if (exampleEntity && ('create' === primaryOp || 'update' === primaryOp)) {
     const items = opRequestShape(exampleEntity, primaryOp).items
       .filter((it: any) => it.name !== idF && it.name !== 'id')

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

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityDataIdField, entityOps, safeVarName } from '@voxgig/sdkgen'
+import { cmp, each, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityDataIdField, entityOps, safeVarName, exampleVarName } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -45,7 +45,7 @@ local client = ${ctor}
     const article = /^[aeiou]/i.test(eName) ? "an" : "a"
     // Sanitise the local variable name — an entity whose lowercased name is a
     // Lua keyword (e.g. `end`) would otherwise emit uncompilable code.
-    const eVar = safeVarName(eName.toLowerCase(), 'lua')
+    const eVar = exampleVarName(eName.toLowerCase(), 'lua')
     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
@@ -108,7 +108,7 @@ end
     if (nestedEntity) {
       const neName = nom(nestedEntity, 'Name')
       const neArticle = /^[aeiou]/i.test(neName) ? "an" : "a"
-      const neVar = safeVarName(neName.toLowerCase(), 'lua')
+      const neVar = exampleVarName(neName.toLowerCase(), 'lua')
 
       // Model-driven match: every REQUIRED load-match key — the same shape
       // the runtime resolves path params from, so the example always works.

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

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, canonToType, canonKey, File, isAuthActive, entityIdField, opRequestShape, safeVarName } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, canonKey, File, isAuthActive, entityIdField, opRequestShape, safeVarName, exampleVarName } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -176,7 +176,7 @@ same parameters as \`direct()\`.
       const idF = entityIdField(ent)
       // Sanitise the local variable name — an entity whose lowercased name is
       // a Lua keyword (e.g. `end`) would otherwise emit uncompilable code.
-      const eVar = safeVarName(ent.name, 'lua')
+      const eVar = exampleVarName(ent.name, 'lua')
 
       Content(`
 ---

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

@@ -1,5 +1,5 @@
 
-import { cmp, Content, isAuthActive, envName, canonKey, entityIdField, opRequestShape, safeVarName } from '@voxgig/sdkgen'
+import { cmp, Content, isAuthActive, envName, canonKey, entityIdField, opRequestShape, safeVarName, exampleVarName } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -48,7 +48,7 @@ local client = ${ctor}
     const eName = nom(exampleEntity, 'Name')
     // Sanitise the local variable name — an entity whose lowercased name is a
     // Lua keyword (e.g. `end`) would otherwise emit uncompilable code.
-    const eVar = safeVarName(eName.toLowerCase(), 'lua')
+    const eVar = exampleVarName(eName.toLowerCase(), 'lua')
     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.

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

@@ -24,6 +24,7 @@ import {
   buildIdNames,
   getMatchEntries,
   isAuthActive,
+  entityDataIdField,
 } from '@voxgig/sdkgen'
 
 
@@ -342,6 +343,7 @@ const generateCreate: OpGen = (ctx, step, index) => {
 
 const generateList: OpGen = (ctx, step, index) => {
   const { entity, flow } = ctx
+  const hasDataId = null != entityDataIdField(entity)
   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 ?? ''))
@@ -387,7 +389,7 @@ const generateList: OpGen = (ctx, step, index) => {
       const hasRefData = validRef && allSteps.some((s: any) => 'create' === s.op &&
         ((s.input.ref ?? entity.name + '_ref01') === validRef))
 
-      if ('ItemExists' === validator.apply && hasRefData) {
+      if ('ItemExists' === validator.apply && hasRefData && hasDataId) {
         const refDataVar = validRef + '_data'
         Content(`
     local found_item = vs.select(
@@ -395,7 +397,7 @@ const generateList: OpGen = (ctx, step, index) => {
       { id = ${refDataVar}["id"] })
     assert.is_false(vs.isempty(found_item))
 `)
-      } else if ('ItemNotExists' === validator.apply && hasRefData) {
+      } else if ('ItemNotExists' === validator.apply && hasRefData && hasDataId) {
         const refDataVar = validRef + '_data'
         Content(`
     local not_found_item = vs.select(
@@ -548,6 +550,9 @@ const generateLoad: OpGen = (ctx, step, index) => {
 
 const generateRemove: OpGen = (ctx, step, index) => {
   const { entity, flow } = ctx
+  if (null == entityDataIdField(entity)) {
+    return
+  }
   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 ?? ''))

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

@@ -24,7 +24,7 @@ const Test = cmp(function Test(props: any) {
 
     // Generate exists test
     File({ name: 'exists_test.' + target.ext }, () => {
-      Content(`-- ProjectName SDK exists test
+      Content(`-- ${model.const.Name} SDK exists test
 
 local sdk = require("${model.name}_sdk")
 

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

@@ -8,6 +8,8 @@ local helpers = require("core.helpers")
 -- Load utility registration (populates Utility._registrar)
 require("utility.register")
 
+-- #TypesRequire
+
 -- Load features
 local BaseFeature = require("feature.base_feature")
 local features_factory = require("features")

package/project/.sdk/src/cmp/ocaml/ReadmeEntity_ocaml.ts

@@ -0,0 +1,180 @@
+
+import { cmp, each, Content, canonKey, entityIdField, opRequestShape } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+import { ocamlVarName } from './utility_ocaml'
+
+
+// A type-correct OCaml `value` literal for a field's canonical type. Strings
+// render the quoted placeholder.
+function ocamlLit(type: any, placeholder: string = 'example'): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k || 'NUMBER' === k) return '(Num 1.)'
+  if ('BOOLEAN' === k) return '(Bool true)'
+  if ('ARRAY' === k) return '(empty_list ())'
+  if ('OBJECT' === k) return '(empty_map ())'
+  return `(Str "${placeholder}")`
+}
+
+
+// The logical OCaml type of a field's canonical type. The SDK carries every
+// field inside the dynamic `value` variant, so this documents the underlying
+// shape a caller reads out of the value.
+function ocamlType(type: any): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k) return 'int'
+  if ('NUMBER' === k) return 'float'
+  if ('BOOLEAN' === k) return 'bool'
+  if ('STRING' === k) return 'string'
+  if ('ARRAY' === k) return 'value list'
+  if ('OBJECT' === k) return 'value map'
+  return 'value'
+}
+
+
+// The op accessor spelling on the entity_obj record, plus a language-agnostic
+// description.
+const OP_DESC: Record<string, { method: string, desc: string }> = {
+  load:   { method: 'e_load reqmatch ctrl',   desc: 'Load a single entity by match criteria.' },
+  list:   { method: 'e_list reqmatch ctrl',   desc: 'List entities, optionally matching the given criteria.' },
+  create: { method: 'e_create reqdata ctrl',  desc: 'Create a new entity with the given data.' },
+  update: { method: 'e_update reqdata ctrl',  desc: 'Update an existing entity.' },
+  remove: { method: 'e_remove reqmatch ctrl', desc: 'Remove the matching entity.' },
+}
+
+
+const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
+  const { target } = props
+  const { model } = props.ctx$
+
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+
+  const publishedEntities = each(entity)
+    .filter((entity: any) => entity.active !== false)
+
+  if (0 === publishedEntities.length) {
+    return
+  }
+
+  Content(`
+
+## Entities
+
+`)
+
+  publishedEntities.map((entity: any) => {
+    const opnames = Object.keys(entity.op || {})
+    const fields = entity.fields || []
+    // Model-driven id key: null when this entity has no id-like field.
+    const idF = entityIdField(entity)
+    const fn = ocamlVarName(entity.name)
+
+    Content(`
+### ${entity.Name}
+
+`)
+
+    if (entity.short) {
+      Content(`${entity.short}
+
+`)
+    }
+
+    Content(`Create an instance: \`let ${fn} = Sdk_client.${fn} client Noval\`
+
+`)
+
+    if (opnames.length > 0) {
+      Content(`#### Operations
+
+| Method | Description |
+| --- | --- |
+`)
+      opnames.map((opname: string) => {
+        const info = OP_DESC[opname]
+        if (info) {
+          Content(`| \`${info.method}\` | ${info.desc} |
+`)
+        }
+      })
+
+      Content(`
+`)
+    }
+
+    if (fields.length > 0) {
+      Content(`#### Fields
+
+| Field | Type | Description |
+| --- | --- | --- |
+`)
+
+      each(fields, (field: any) => {
+        const desc = field.short || ''
+        Content(`| \`${field.name}\` | \`${ocamlType(field.type)}\` | ${desc} |
+`)
+      })
+
+      Content(`
+`)
+    }
+
+    if (opnames.includes('load')) {
+      // The id key plus every REQUIRED match key (parent path params like
+      // page_id) — the same shape the runtime resolves path params from.
+      const loadItems = opRequestShape(entity, '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
+        ? `jo [${loadItems.map((it: any) =>
+          `("${it.name}", ${ocamlLit(it.type,
+            it.name === idF ? entity.name + '_id' : it.name)})`).join('; ')}]`
+        : 'Noval'
+      Content(`#### Example: Load
+
+\`\`\`ocaml
+let ${fn} = (Sdk_client.${fn} client Noval).e_load (${loadArg}) Noval
+\`\`\`
+
+`)
+    }
+
+    if (opnames.includes('list')) {
+      Content(`#### Example: List
+
+\`\`\`ocaml
+let ${fn}s = (Sdk_client.${fn} client Noval).e_list (empty_map ()) Noval
+\`\`\`
+
+`)
+    }
+
+    if (opnames.includes('create')) {
+      const createItems = opRequestShape(entity, 'create').items
+        .filter((it: any) => !it.optional)
+      Content(`#### Example: Create
+
+\`\`\`ocaml
+let ${fn} = (Sdk_client.${fn} client Noval).e_create (jo [
+`)
+      createItems.map((it: any) => {
+        Content(`    ("${it.name}", ${ocamlLit(it.type, 'example_' + it.name)});  (* ${ocamlType(it.type)} *)
+`)
+      })
+      Content(`]) Noval
+\`\`\`
+
+`)
+    }
+  })
+})
+
+
+export {
+  ReadmeEntity
+}