@voxgig/sdkgen 1.3.14 → 1.3.18

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

@@ -0,0 +1,387 @@
+
+import { cmp, each, Content, canonToType, canonKey, File, isAuthActive, entityIdField, opRequestShape } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+import { kotlinVarName } from './utility_kotlin'
+
+
+// Type names come from the shared canonToType 'kotlin' column (single source of truth).
+
+// A type-correct Kotlin literal for a field's canonical type.
+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 OP_SIGNATURES: Record<string, { sig: string, returns: string, desc: string }> = {
+  load: {
+    sig: 'load(reqmatch, ctrl) -> Any?',
+    returns: 'the entity data',
+    desc: 'Load a single entity matching the given criteria. Returns the entity data and raises on error.',
+  },
+  list: {
+    sig: 'list(reqmatch, ctrl) -> Any?',
+    returns: 'an aggregate list of entities',
+    desc: 'List entities matching the given criteria. The match is optional — call `list(null, null)` to list all records. Returns an aggregate list and raises on error.',
+  },
+  create: {
+    sig: 'create(reqdata, ctrl) -> Any?',
+    returns: 'the created entity data',
+    desc: 'Create a new entity with the given data. Returns the created entity data and raises on error.',
+  },
+  update: {
+    sig: 'update(reqdata, ctrl) -> Any?',
+    returns: 'the updated entity data',
+    desc: 'Update an existing entity. The data must include the entity `id`. Returns the updated entity data and raises on error.',
+  },
+  remove: {
+    sig: 'remove(reqmatch, ctrl) -> Any?',
+    returns: 'the removed entity data',
+    desc: 'Remove the entity matching the given criteria. Raises on error.',
+  },
+}
+
+
+const ReadmeRef = cmp(function ReadmeRef(props: any) {
+  const { target } = props
+  const { model } = props.ctx$
+
+  const SDK = model.const.Name + 'SDK'
+
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+  const feature = getModelPath(model, `main.${KIT}.feature`)
+
+  const publishedEntities = each(entity).filter((e: any) => e.active !== false)
+
+
+  File({ name: 'REFERENCE.md' }, () => {
+
+    Content(`# ${model.Name} ${target.title} SDK Reference
+
+Complete API reference for the ${model.Name} ${target.title} SDK.
+
+
+## ${SDK}
+
+### Constructor
+
+`)
+
+    Content(`\`\`\`kotlin
+val client = ${SDK}(options)
+\`\`\`
+
+Create a new SDK client instance. \`options\` is a \`MutableMap<String, Any?>\`.
+
+**Parameters:**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| \`options\` | \`Map\` | SDK configuration options. |
+${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"]\` | \`Map\` | Custom headers for all requests. |
+| \`options["feature"]\` | \`Map\` | Feature configuration. |
+| \`options["system"]\` | \`Map\` | System overrides (e.g. custom fetch). |
+
+`)
+
+
+    Content(`
+### Static Methods
+
+`)
+
+    Content(`#### \`${SDK}.testSDK(testopts, sdkopts)\`
+
+Create a test client with mock features active. Both arguments may be \`null\`.
+
+\`\`\`kotlin
+val client = ${SDK}.testSDK(null, null)
+\`\`\`
+
+`)
+
+
+    Content(`
+### Instance Methods
+
+`)
+
+
+    // Entity factory methods
+    publishedEntities.map((ent: any) => {
+      Content(`#### \`${kotlinVarName(ent.name)}(entopts)\`
+
+Create a new \`${ent.Name}\` entity instance (returns \`SdkEntity\`). Pass
+\`null\` for no initial options.
+
+`)
+    })
+
+
+    Content(`#### \`optionsMap() -> MutableMap\`
+
+Return a deep copy of the current SDK options.
+
+#### \`getUtility() -> Utility\`
+
+Return a copy of the SDK utility object.
+
+#### \`direct(fetchargs) -> MutableMap\`
+
+Make a direct HTTP request to any API endpoint. Returns a result
+\`MutableMap<String, Any?>\` with \`ok\`, \`status\`, \`headers\`, and \`data\`
+(or \`err\` on failure). This escape hatch never raises — branch on
+\`result["ok"]\`.
+
+**Parameters:**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| \`fetchargs["path"]\` | \`String\` | URL path with optional \`{param}\` placeholders. |
+| \`fetchargs["method"]\` | \`String\` | HTTP method (default: \`"GET"\`). |
+| \`fetchargs["params"]\` | \`Map\` | Path parameter values. |
+| \`fetchargs["query"]\` | \`Map\` | Query string parameters. |
+| \`fetchargs["headers"]\` | \`Map\` | Request headers (merged with defaults). |
+| \`fetchargs["body"]\` | \`Any?\` | Request body (maps are JSON-serialized). |
+
+**Returns:** \`MutableMap<String, Any?>\`
+
+#### \`prepare(fetchargs) -> MutableMap\`
+
+Prepare a fetch definition without sending. Returns the \`fetchdef\` and raises on error.
+
+`)
+
+
+    // Entity reference sections
+    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.
+      const idF = entityIdField(ent)
+      // Sanitise the local variable name — kotlinVarName guards Kotlin keywords.
+      const eVar = kotlinVarName(ent.name)
+      const accessor = kotlinVarName(ent.name)
+
+      Content(`
+---
+
+## ${ent.Name}
+
+`)
+
+      if (ent.short) {
+        Content(`${ent.short}
+
+`)
+      }
+
+      Content(`\`\`\`kotlin
+val ${eVar} = client.${accessor}(null)
+\`\`\`
+
+`)
+
+
+      // Field schema
+      if (fields.length > 0) {
+        Content(`### Fields
+
+| Field | Type | Required | Description |
+| --- | --- | --- | --- |
+`)
+        each(fields, (field: any) => {
+          const req = field.req ? 'Yes' : 'No'
+          const desc = field.short || ''
+          Content(`| \`${field.name}\` | \`${canonToType(field.type, target.name)}\` | ${req} | ${desc} |
+`)
+        })
+
+        Content(`
+`)
+
+        // Field operations breakdown
+        const hasFieldOps = fields.some((f: any) => f.op && Object.keys(f.op).length > 0)
+        if (hasFieldOps) {
+          const opcols = ['load', 'list', 'create', 'update', 'remove']
+            .filter((op: string) => opnames.includes(op) && ent.op[op]?.active !== false)
+          Content(`### Field Usage by Operation
+
+| Field | ${opcols.join(' | ')} |
+| --- | ${opcols.map(() => '---').join(' | ')} |
+`)
+          each(fields, (field: any) => {
+            const fops = field.op || {}
+            const cols = opcols.map((op: string) => {
+              const fop = fops[op]
+              if (null == fop) return '-'
+              if (fop.active === false) return '-'
+              return 'Yes'
+            })
+            Content(`| \`${field.name}\` | ${cols.join(' | ')} |
+`)
+          })
+
+          Content(`
+`)
+        }
+      }
+
+
+      // Operation details
+      if (opnames.length > 0) {
+        Content(`### Operations
+
+`)
+
+        opnames.map((opname: string) => {
+          const info = OP_SIGNATURES[opname]
+          if (!info) return
+
+          Content(`#### \`${info.sig}\`
+
+${info.desc}
+
+`)
+
+          if ('load' === opname || 'remove' === opname) {
+            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
+              ? `mutableMapOf<String, Any?>(${matchItems.map((it: any) =>
+                `"${it.name}" to ${kotlinLit(it.type,
+                  it.name === idF ? ent.name + '_id' : it.name)}`).join(', ')})`
+              : 'null'
+            Content(`\`\`\`kotlin
+val result = client.${accessor}(null).${opname}(${arg}, null)
+\`\`\`
+
+`)
+          }
+          else if ('list' === opname) {
+            Content(`\`\`\`kotlin
+val results = client.${accessor}(null).list(null, null)
+println(results)
+\`\`\`
+
+`)
+          }
+          else if ('create' === opname) {
+            const createItems = opRequestShape(ent, 'create').items
+              .filter((it: any) => !it.optional)
+            Content(`\`\`\`kotlin
+val result = client.${accessor}(null).create(mutableMapOf<String, Any?>(
+`)
+            createItems.map((it: any, i: number) => {
+              const comma = i < createItems.length - 1 ? ',' : ''
+              Content(`    "${it.name}" to ${kotlinLit(it.type, 'example_' + it.name)}${comma}  // ${canonToType(it.type, target.name)}
+`)
+            })
+            Content(`), null)
+\`\`\`
+
+`)
+          }
+          else if ('update' === opname) {
+            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, i: number) => {
+              const comma = i < updateItems.length - 1 ? ',' : ''
+              return `    "${it.name}" to ${kotlinLit(it.type,
+                it.name === idF ? ent.name + '_id' : it.name)}${comma}\n`
+            }).join('')
+            Content(`\`\`\`kotlin
+val result = client.${accessor}(null).update(mutableMapOf<String, Any?>(
+${updateLines}), null)
+\`\`\`
+
+`)
+          }
+        })
+      }
+
+
+      // Common methods
+      Content(`### Common Methods
+
+#### \`data(vararg newdata) -> Any?\`
+
+Get or set the entity data.
+
+#### \`match(vararg newmatch) -> Any?\`
+
+Get or set the entity match criteria.
+
+#### \`make() -> Entity\`
+
+Create a new \`${ent.Name}\` entity instance with the same options.
+
+#### \`name -> String\`
+
+The entity name (read-only property).
+
+`)
+    })
+
+
+    // Features section
+    const activeFeatures = each(feature).filter((f: any) => f.active)
+    if (activeFeatures.length > 0) {
+      Content(`
+---
+
+## Features
+
+| Feature | Version | Description |
+| --- | --- | --- |
+`)
+
+      activeFeatures.map((f: any) => {
+        Content(`| \`${f.name}\` | ${f.version || '0.0.1'} | ${f.title || ''} |
+`)
+      })
+
+      Content(`
+
+Features are activated via the \`feature\` option:
+
+`)
+
+      Content(`\`\`\`kotlin
+val feature = mutableMapOf<String, Any?>(
+`)
+      activeFeatures.map((f: any) => {
+        Content(`    "${f.name}" to mapOf("active" to true),
+`)
+      })
+      Content(`)
+val client = ${SDK}(mutableMapOf<String, Any?>("feature" to feature))
+\`\`\`
+
+`)
+    }
+
+  })
+})
+
+
+export {
+  ReadmeRef
+}

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

@@ -0,0 +1,23 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+
+const ReadmeTopHowto = cmp(function ReadmeTopHowto(props: any) {
+  const { target } = props
+
+  Content(`**Kotlin:**
+\`\`\`kotlin
+val result = client.direct(mutableMapOf<String, Any?>(
+    "path" to "/api/resource/{id}",
+    "method" to "GET",
+    "params" to mapOf("id" to "example")))
+\`\`\`
+
+`)
+
+})
+
+
+export {
+  ReadmeTopHowto
+}

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/TestDirect_kotlin.ts

@@ -72,7 +72,7 @@ const TestDirect = cmp(function TestDirect(props: any) {
 
   const authActive = isAuthActive(model)
 
-  const opnames = Object.keys(entity.op)
+  const opnames = Object.keys(entity.op || {})
   const hasLoad = opnames.includes('load')
   const hasList = opnames.includes('list')
 
@@ -80,8 +80,8 @@ const TestDirect = cmp(function TestDirect(props: any) {
     return
   }
 
-  const loadOp = entity.op.load
-  const listOp = entity.op.list
+  const loadOp = entity.op?.load
+  const listOp = entity.op?.list
 
   const loadPoint = loadOp?.points?.[0]
   const loadPath = loadPoint ? normalizePathParams(loadPoint.parts || [], loadPoint?.args?.params || [], loadPoint?.rename?.param) : ''

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 })
   })
 })