@voxgig/sdkgen 1.3.14 → 1.3.17

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

@@ -0,0 +1,201 @@
+
+// Typed-model generator (Kotlin target). Port of EntityTypes_java.ts /
+// EntityTypes_py.ts.
+//
+// Reads main.<KIT>.entity.<e>.fields[] and per-op params
+// (op.<name>.points[].args.params[]) and emits ONE file, core/<Name>Types.kt,
+// holding a container `object <Name>Types` with a nested `data class` per
+// active entity plus a request/match type per active op.
+//
+// WHY A CONTAINER OBJECT: parity with the java/csharp emitters — every
+// generated reference type lives inside a single `object <Name>Types`, so the
+// whole reference model is in one file (<Name>Types.kt) whatever the entity
+// count. Kotlin has no one-public-type-per-file rule, but the single-file
+// convention is kept for cross-language consistency.
+//
+// TYPE CHOICE: reference types with BOXED (nullable) component types, NOT the
+// wired runtime type. The generated ops take/return the loose object model
+// (MutableMap<String, Any?> / Any?), so these types are NOT wired into the op
+// signatures — they are documentation/DX reference shapes a caller may use to
+// describe a payload before converting it to a map. This mirrors the JS
+// target's JSDoc typedefs (annotation only, no runtime effect). Emitting unused
+// types is harmless — they compile and have no runtime effect.
+//
+// OPTIONAL FIELDS: every component is a nullable reference type, so a
+// `req:false` field/param needs no distinct rendering in Kotlin.
+//
+// EMPTY SHAPES: Kotlin forbids a `data class` with zero components, so an
+// empty shape is emitted as a plain marker `class <Name>` instead.
+//
+// Sentinels map to Kotlin types via the SHARED canonToType 'kotlin' column
+// (the single source of truth per language — do not keep a local table here).
+//
+// Keep the SAME type-name scheme as every other language: <Name>,
+// <Name>LoadMatch, <Name>ListMatch, <Name>CreateData, <Name>UpdateData,
+// <Name>RemoveMatch (via the shared opTypeName helper).
+
+import {
+  cmp, each, names,
+  File, Content,
+} from '@voxgig/sdkgen'
+
+import { canonToType, opTypeName, opRequestShape, warnEntityTypeCollisions } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+import { kotlinPackage } from './utility_kotlin'
+
+
+// Kotlin hard keywords that cannot be a (non-escaped) property name.
+const KOTLIN_KEYWORDS = new Set<string>([
+  'as', 'break', 'class', 'continue', 'do', 'else', 'false', 'for', 'fun',
+  'if', 'in', 'interface', 'is', 'null', 'object', 'package', 'return',
+  'super', 'this', 'throw', 'true', 'try', 'typealias', 'typeof', 'val',
+  'var', 'when', 'while',
+])
+
+
+// A field/param name that has a safe Kotlin identifier rendering. Names that
+// are not valid identifiers (hyphens, leading digits) have no clean component
+// form and are skipped — they remain reachable via the runtime map.
+function kotlinIdent(name: string): boolean {
+  return /^[A-Za-z_][A-Za-z0-9_]*$/.test(name) && !KOTLIN_KEYWORDS.has(name)
+}
+
+
+const LANG = 'kotlin'
+
+
+// Emit a nested `data class <typeName>(...)` from {name, type} items. An item
+// whose name is not a legal identifier is skipped (WITH a warning — the key
+// stays reachable via the runtime map, but its absence from the typed model
+// should be visible, not silent); a duplicate component name (after the
+// identifier filter) is dropped. An empty shape becomes a plain marker
+// `class <typeName>` (Kotlin forbids a zero-component data class).
+function emitRecord(typeName: string, items: any[], log?: any): void {
+  const seen = new Set<string>()
+  const usable = items.filter((it: any) => {
+    if (!it || null == it.name) {
+      return false
+    }
+    if (!kotlinIdent(it.name)) {
+      if (log && log.warn) {
+        log.warn({
+          point: 'entity-types-skip-field', typeName, field: it.name,
+          note: `kotlin: field "${it.name}" of ${typeName} has no legal ` +
+            `Kotlin identifier form; omitted from the typed model (still ` +
+            `reachable via the runtime map)`,
+        })
+      }
+      return false
+    }
+    if (seen.has(it.name)) {
+      return false
+    }
+    seen.add(it.name)
+    return true
+  })
+
+  if (0 === usable.length) {
+    Content(`  class ${typeName}
+
+`)
+    return
+  }
+
+  const params = usable
+    .map((it: any) => `val ${it.name}: ${canonToType(it.type, LANG)}`)
+    .join(', ')
+  Content(`  data class ${typeName}(${params})
+
+`)
+}
+
+
+const EntityTypes = cmp(function EntityTypes(props: any) {
+  const { model, log } = props.ctx$
+  const target = props.target || {}
+  const ext = target.ext || 'kt'
+
+  const kotlinpackage = props.kotlinpackage || kotlinPackage(model)
+
+  // 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/py/csharp/java emitter's fix.
+  entityList.forEach((e: any) => { if (null == e.Name) names(e, e.name) })
+
+  // Surface duplicate generated type names (two entities with the same
+  // PascalCase Name) — they would redeclare a type in statically-typed
+  // targets. Detection only; renaming is a model-level decision.
+  warnEntityTypeCollisions(entity, log, LANG)
+
+  File({ name: model.const.Name + 'Types.' + ext }, () => {
+
+    Content(`package ${kotlinpackage}.core
+
+// Typed reference models for the ${model.const.Name} SDK.
+//
+// GENERATED from the API model: main.${KIT}.entity.<e>.fields[] and per-op
+// params (op.<name>.points[].args.params[]). Field/param types come from the
+// canonical type sentinels (source of truth: @voxgig/apidef VALID_CANON). Do
+// not edit by hand.
+//
+// These types are documentation/DX reference shapes ONLY. The SDK ops take and
+// return the loose object model (MutableMap<String, Any?> / Any?) at runtime,
+// so these types are not wired into the op signatures — use them to describe a
+// payload before converting it to a map. Every component is a nullable type, so
+// an optional (req:false) key needs no distinct rendering.
+
+@Suppress("unused")
+object ${model.const.Name}Types {
+
+`)
+
+    entityList.forEach((ent: any) => {
+      const Name = ent.Name
+      const fields = (ent.fields ? each(ent.fields) : [])
+        .filter((f: any) => f.active !== false)
+
+      // Entity data model: one component per field.
+      emitRecord(Name, fields.map((f: any) => ({
+        name: f.name, type: f.type,
+      })), log)
+
+      // Per active op: a request/match type. Members come from the shared
+      // partiality policy (opRequestShape).
+      const ops = ent.op || {}
+      ;['load', 'list', 'create', 'update', 'remove'].forEach((opname: string) => {
+        if (null == ops[opname]) {
+          return
+        }
+
+        const typeName = opTypeName(Name, opname)
+        const { items } = opRequestShape(ent, opname)
+
+        emitRecord(typeName, items, log)
+      })
+    })
+
+    Content(`}
+`)
+  })
+})
+
+
+export {
+  EntityTypes,
+}

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

@@ -23,6 +23,7 @@ import { Config } from './Config_kotlin'
 import { Gitignore } from './Gitignore_kotlin'
 import { MainEntity } from './MainEntity_kotlin'
 import { EntityBase } from './EntityBase_kotlin'
+import { EntityTypes } from './EntityTypes_kotlin'
 import { SdkError } from './SdkError_kotlin'
 import { kotlinPackage } from './utility_kotlin'
 
@@ -84,6 +85,11 @@ const Main = cmp(async function Main(props: any) {
     })
 
     Config({ target })
+
+    // Generate the typed reference-model file (<Name>Types.kt) beside the
+    // other generated core files. Documentation/DX shapes only — not wired
+    // into the loose-object-model op signatures.
+    EntityTypes({ target, kotlinpackage })
   })
 
 })

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

@@ -0,0 +1,175 @@
+
+import { cmp, each, Content, canonToType, canonKey, 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}"`
+}
+
+
+// Operation method spelling for Kotlin: camelCase methods over the loose
+// object model. The op descriptions are language-agnostic.
+const OP_DESC: Record<string, { method: string, desc: string }> = {
+  load:   { method: 'load(match, null)',   desc: 'Load a single entity by match criteria.' },
+  list:   { method: 'list(null, null)',    desc: 'List entities, optionally matching the given criteria.' },
+  create: { method: 'create(data, null)',  desc: 'Create a new entity with the given data.' },
+  update: { method: 'update(data, null)',  desc: 'Update an existing entity.' },
+  remove: { method: 'remove(match, null)', 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)
+    // Sanitise the local variable name — a camelCased Kotlin keyword gets a
+    // trailing underscore (kotlinVarName) so the snippet compiles.
+    const eVar = kotlinVarName(entity.name)
+    const accessor = kotlinVarName(entity.name)
+
+    Content(`
+### ${entity.Name}
+
+`)
+
+    if (entity.short) {
+      Content(`${entity.short}
+
+`)
+    }
+
+    Content(`Create an instance: \`val ${eVar} = client.${accessor}(null)\`
+
+`)
+
+    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}\` | \`${canonToType(field.type, target.name)}\` | ${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, so
+      // the example always works.
+      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
+        ? `mutableMapOf<String, Any?>(${loadItems.map((it: any) =>
+          `"${it.name}" to ${kotlinLit(it.type,
+            it.name === idF ? entity.name + '_id' : it.name)}`).join(', ')})`
+        : 'null'
+      Content(`#### Example: Load
+
+\`\`\`kotlin
+val ${eVar} = client.${accessor}(null).load(${loadArg}, null)
+\`\`\`
+
+`)
+    }
+
+    if (opnames.includes('list')) {
+      Content(`#### Example: List
+
+\`\`\`kotlin
+val ${eVar}List = client.${accessor}(null).list(null, null)
+\`\`\`
+
+`)
+    }
+
+    if (opnames.includes('create')) {
+      // 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 — with a real literal.
+      const createItems = opRequestShape(entity, 'create').items
+        .filter((it: any) => !it.optional)
+      Content(`#### Example: Create
+
+\`\`\`kotlin
+val ${eVar} = 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)
+\`\`\`
+
+`)
+    }
+  })
+})
+
+
+export {
+  ReadmeEntity
+}

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

@@ -0,0 +1,173 @@
+
+import { cmp, File, Content } from '@voxgig/sdkgen'
+
+import { kotlinPackage } from './utility_kotlin'
+
+
+// Emits test/ReadmeExamplesTest.kt — a JUnit PRESENCE + STRUCTURE gate over
+// every ```kotlin fenced block in the repository ROOT README.md, the
+// per-language kotlin/README.md, AND the per-language kotlin/REFERENCE.md.
+//
+// SCOPE NOTE (deliberate, documented): the Python/TS/Go equivalents EXECUTE and
+// type-check every documented block. That is infeasible here — the generated
+// Kotlin SDK compiles with Gradle/kotlinc only (no in-process Kotlin compiler
+// dependency wired into the test classpath), so a test cannot compile-and-run
+// arbitrary doc snippets at test time. This gate therefore guarantees the
+// weaker-but-real invariant that keeps the docs honest as the generator evolves:
+//   1. every doc exists and contains at least one ```kotlin block (nothing was
+//      dropped);
+//   2. every ```kotlin block is structurally well-formed — its braces,
+//      parentheses and brackets balance (catches a truncated or malformed
+//      generated snippet).
+// A per-doc summary line makes the coverage visible in the test output.
+//
+// The emitted Kotlin is written WITHOUT literal backticks (the fence marker is
+// built at runtime as 96.toChar().toString().repeat(3)) so this TS template
+// literal stays clean.
+const ReadmeExamplesTest = cmp(function ReadmeExamplesTest(props: any) {
+  const { target, ctx$: { model } } = props
+
+  const Name = model.const.Name
+  const kotlinpackage = props.kotlinpackage || kotlinPackage(model)
+
+  File({ name: 'ReadmeExamplesTest.' + target.ext }, () => {
+    Content(`package ${kotlinpackage}.sdktest
+
+// ${Name} SDK — documentation kotlin-examples PRESENCE + STRUCTURE gate.
+//
+// GUARANTEE (see ReadmeExamplesTest_kotlin.ts for why this is a structure gate
+// and not an execute gate): every kotlin example in the docs is accounted for.
+// This JUnit class is a completeness gate over every ${'```'}kotlin fenced code
+// block in three documents:
+//   - the repository ROOT README.md (one directory above this module),
+//   - the per-language kotlin/README.md,
+//   - the per-language kotlin/REFERENCE.md.
+//
+// Checks, PER DOCUMENT:
+//   1. PRESENCE: the doc exists and holds at least one kotlin block.
+//   2. STRUCTURE: every kotlin block's braces / parens / brackets balance, so a
+//      truncated or malformed generated snippet fails loudly.
+//
+// GENERATED by @voxgig/sdkgen — do not edit by hand.
+
+import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.Test
+
+import java.io.File
+import java.nio.file.Files
+import java.nio.file.Path
+import java.nio.file.Paths
+
+class ReadmeExamplesTest {
+
+  // The three documents to scan, resolved relative to the Gradle module
+  // directory (the working directory when the test task runs). Each row is
+  // {label, relative path}.
+  private fun docs(): Array<Array<String>> {
+    return arrayOf(
+      arrayOf("root README", ".." + File.separator + "README.md"),
+      arrayOf("kotlin README.md", "README.md"),
+      arrayOf("kotlin REFERENCE.md", "REFERENCE.md"),
+    )
+  }
+
+  // Extract every kotlin fenced block. Split on the triple-backtick fence:
+  // odd-indexed segments are the inside of a fenced block (info string on the
+  // first line, then the code). Only blocks whose info string is exactly
+  // "kotlin" are returned.
+  private fun kotlinBlocks(text: String): List<String> {
+    val fence = 96.toChar().toString().repeat(3)
+    val parts = text.split(fence)
+    val blocks = mutableListOf<String>()
+    var i = 1
+    while (i < parts.size) {
+      val seg = parts[i]
+      val nl = seg.indexOf('\\n')
+      val info = (if (nl < 0) seg else seg.substring(0, nl)).trim()
+      if (info == "kotlin") {
+        blocks.add(if (nl < 0) "" else seg.substring(nl + 1))
+      }
+      i += 2
+    }
+    return blocks
+  }
+
+  private fun readDoc(path: Path, label: String): String {
+    assertTrue(Files.exists(path), label + " not found: " + path)
+    return Files.readString(path)
+  }
+
+  // True when every open/close delimiter balances (ignores the subtlety of
+  // delimiters inside string literals — a generated snippet never nests an
+  // unbalanced delimiter in a string, and this catches truncation).
+  private fun balanced(block: String): Boolean {
+    val stack = ArrayDeque<Char>()
+    val pairs = mapOf('(' to ')', '[' to ']', '{' to '}')
+    for (ch in block) {
+      if (pairs.containsKey(ch)) {
+        stack.addLast(pairs[ch]!!)
+      }
+      else if (ch == ')' || ch == ']' || ch == '}') {
+        if (stack.isEmpty() || stack.removeLast() != ch) {
+          return false
+        }
+      }
+    }
+    return stack.isEmpty()
+  }
+
+  @Test
+  fun rootReadmeHasKotlinBlocks() {
+    val doc = docs()[0]
+    val blocks = kotlinBlocks(readDoc(Paths.get(doc[1]), doc[0]))
+    assertTrue(blocks.size > 0, "expected at least one kotlin block in " + doc[0])
+  }
+
+  @Test
+  fun localReadmeHasKotlinBlocks() {
+    val doc = docs()[1]
+    val blocks = kotlinBlocks(readDoc(Paths.get(doc[1]), doc[0]))
+    assertTrue(blocks.size > 0, "expected at least one kotlin block in " + doc[0])
+  }
+
+  @Test
+  fun referenceHasKotlinBlocks() {
+    val doc = docs()[2]
+    val blocks = kotlinBlocks(readDoc(Paths.get(doc[1]), doc[0]))
+    assertTrue(blocks.size > 0, "expected at least one kotlin block in " + doc[0])
+  }
+
+  @Test
+  fun allKotlinBlocksAreStructurallyBalanced() {
+    val failures = mutableListOf<String>()
+    for (doc in docs()) {
+      val path = Paths.get(doc[1])
+      if (!Files.exists(path)) {
+        continue
+      }
+      val blocks = kotlinBlocks(readDoc(path, doc[0]))
+      var balancedCount = 0
+      for (i in blocks.indices) {
+        if (balanced(blocks[i])) {
+          balancedCount++
+        }
+        else {
+          failures.add(doc[0] + " kotlin block #" + i +
+              " has unbalanced delimiters:\\n\\n" + blocks[i])
+        }
+      }
+      println(
+          "[readme-examples] " + doc[0] + " kotlin blocks: total=" +
+          blocks.size + " balanced=" + balancedCount)
+    }
+    assertTrue(failures.isEmpty(), failures.joinToString("\\n\\n"))
+  }
+}
+`)
+  })
+})
+
+
+export {
+  ReadmeExamplesTest
+}

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

@@ -0,0 +1,47 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+import { kotlinPackage } from './utility_kotlin'
+
+
+const ReadmeExplanation = cmp(function ReadmeExplanation(props: any) {
+  const { target, ctx$: { model } } = props
+
+  const pkg = kotlinPackage(model)
+
+  Content(`### Data as maps
+
+The Kotlin SDK uses a loose object model — \`MutableMap<String, Any?>\`
+throughout — rather than a bespoke typed class per endpoint. This mirrors the
+dynamic nature of the API and keeps the SDK flexible: no regeneration is
+needed when the API schema changes.
+
+Use \`Helpers.toMapAny(value)\` to safely coerce a value to a
+\`MutableMap<String, Any?>\`. A \`${model.const.Name}Types.kt\` module of
+reference \`data class\` types is also generated for editor documentation.
+
+### Project structure
+
+\`\`\`
+kotlin/
+├── build.gradle.kts            -- Gradle build (compiles core/, utility/, feature/, entity/)
+├── settings.gradle.kts         -- Gradle project settings
+├── core/                       -- Main SDK client, config, entity base, error type
+├── entity/                     -- Entity implementations
+├── feature/                    -- Built-in features (Base, Test, Log, ...)
+├── utility/                    -- Utility functions and the vendored struct library
+└── test/                       -- JUnit test suites
+\`\`\`
+
+The main client class (\`${model.const.Name}SDK\`, package \`${pkg}.core\`)
+exposes the entity accessors. Reference entity or utility types directly only
+when needed.
+
+`)
+
+})
+
+
+export {
+  ReadmeExplanation
+}