@voxgig/sdkgen 1.3.14 → 1.3.17

package/project/.sdk/src/cmp/scala/EntityTypes_scala.ts

@@ -0,0 +1,202 @@
+
+
+// Typed-model generator (Scala 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.scala,
+// holding an `object <Name>Types` with a nested `final case class` per active
+// entity plus a request/match case class per active op.
+//
+// WHY A CONTAINER OBJECT: keeps the whole reference model in one file whatever
+// the entity count and matches the java target's single-container layout
+// (<Name>Types.java). Scala permits multiple top-level types per file, but a
+// container object mirrors the JVM sibling and keeps the generated core/ dir
+// tidy.
+//
+// TYPE CHOICE: reference `case class` types with BOXED (nullable) component
+// types, NOT the wired runtime type. The generated ops take/return the loose
+// object model (java.util.Map[String, Object] / Object), so these case classes
+// 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 java target's reference records and the JS target's JSDoc
+// typedefs (annotation only, no runtime effect). Emitting unused case classes
+// is harmless — they compile and have no runtime effect.
+//
+// OPTIONAL FIELDS: every component is a boxed reference type, hence inherently
+// nullable, so a `req:false` field/param needs no distinct rendering in Scala.
+//
+// Sentinels map to Scala types via the SHARED canonToType 'scala' 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 { scalaPackage } from './utility_scala'
+
+
+const LANG = 'scala'
+
+
+// Scala reserved words that cannot be a case-class parameter name.
+const SCALA_KEYWORDS = new Set<string>([
+  'abstract', 'case', 'catch', 'class', 'def', 'do', 'else', 'enum', 'export',
+  'extends', 'false', 'final', 'finally', 'for', 'forSome', 'given', 'if',
+  'implicit', 'import', 'lazy', 'match', 'new', 'null', 'object', 'override',
+  'package', 'private', 'protected', 'return', 'sealed', 'super', 'then',
+  'this', 'throw', 'trait', 'true', 'try', 'type', 'val', 'var', 'while',
+  'with', 'yield',
+])
+
+
+// A field/param name that has a safe Scala identifier rendering. Names that are
+// not valid identifiers (hyphens, leading digits) have no clean parameter form
+// and are skipped — they remain reachable via the runtime map.
+function scalaIdent(name: string): boolean {
+  return /^[A-Za-z_][A-Za-z0-9_]*$/.test(name) && !SCALA_KEYWORDS.has(name)
+}
+
+
+// Emit a nested `final case 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 case class is a valid,
+// zero-parameter shape.
+function emitCaseClass(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 (!scalaIdent(it.name)) {
+      if (log && log.warn) {
+        log.warn({
+          point: 'entity-types-skip-field', typeName, field: it.name,
+          note: `scala: field "${it.name}" of ${typeName} has no legal ` +
+            `Scala 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(`  final case class ${typeName}()
+
+`)
+    return
+  }
+
+  const params = usable
+    .map((it: any) => `${it.name}: ${canonToType(it.type, LANG)}`)
+    .join(', ')
+  Content(`  final case class ${typeName}(${params})
+
+`)
+}
+
+
+const EntityTypes = cmp(function EntityTypes(props: any) {
+  const { model, log } = props.ctx$
+  const target = props.target || {}
+  const ext = target.ext || 'scala'
+
+  const scalapackage = props.scalapackage || scalaPackage(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/java/csharp 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 ${scalapackage}.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 case classes are documentation/DX reference shapes ONLY. The SDK ops
+// take and return the loose object model (java.util.Map[String, Object] /
+// Object) 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 boxed (nullable) type, so an optional (req:false) key needs
+// no distinct rendering.
+
+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.
+      emitCaseClass(Name, fields.map((f: any) => ({
+        name: f.name, type: f.type,
+      })), log)
+
+      // Per active op: a request/match case class. 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)
+
+        emitCaseClass(typeName, items, log)
+      })
+    })
+
+    Content(`}
+`)
+  })
+})
+
+
+export {
+  EntityTypes,
+}

package/project/.sdk/src/cmp/scala/Main_scala.ts

@@ -23,6 +23,7 @@ import { Config } from './Config_scala'
 import { Gitignore } from './Gitignore_scala'
 import { MainEntity } from './MainEntity_scala'
 import { EntityBase } from './EntityBase_scala'
+import { EntityTypes } from './EntityTypes_scala'
 import { scalaPackage } from './utility_scala'
 
 
@@ -83,6 +84,11 @@ const Main = cmp(async function Main(props: any) {
     })
 
     Config({ target })
+
+    // Generate the typed reference-model file (<Name>Types.scala) beside the
+    // other generated core files. Documentation/DX shapes only — not wired
+    // into the loose-object-model op signatures.
+    EntityTypes({ target, scalapackage })
   })
 
 })

package/project/.sdk/src/cmp/scala/ReadmeEntity_scala.ts

@@ -0,0 +1,175 @@
+
+import { cmp, each, Content, canonToType, canonKey, entityIdField, opRequestShape } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+import { scalaVarName } from './utility_scala'
+
+
+// Type names come from the shared canonToType 'scala' column (single source of truth).
+
+// A type-correct Scala literal for a field's canonical type.
+function scalaLit(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 'java.util.List.of()'
+  if ('OBJECT' === k) return 'java.util.Map.of()'
+  return `"${placeholder}"`
+}
+
+
+// Operation method spelling for Scala: 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 Scala keyword gets a
+    // trailing underscore (scalaVarName) so the snippet compiles.
+    const eVar = scalaVarName(entity.name)
+    const accessor = scalaVarName(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
+        ? `java.util.Map.of(${loadItems.map((it: any) =>
+          `"${it.name}", ${scalaLit(it.type,
+            it.name === idF ? entity.name + '_id' : it.name)}`).join(', ')})`
+        : 'null'
+      Content(`#### Example: Load
+
+\`\`\`scala
+val ${eVar} = client.${accessor}(null).load(${loadArg}, null)
+\`\`\`
+
+`)
+    }
+
+    if (opnames.includes('list')) {
+      Content(`#### Example: List
+
+\`\`\`scala
+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
+
+\`\`\`scala
+val ${eVar} = client.${accessor}(null).create(java.util.Map.of(
+`)
+      createItems.map((it: any, i: number) => {
+        const comma = i < createItems.length - 1 ? ',' : ''
+        Content(`    "${it.name}", ${scalaLit(it.type, 'example_' + it.name)}${comma}  // ${canonToType(it.type, target.name)}
+`)
+      })
+      Content(`), null)
+\`\`\`
+
+`)
+    }
+  })
+})
+
+
+export {
+  ReadmeEntity
+}

package/project/.sdk/src/cmp/scala/ReadmeExamplesTest_scala.ts

@@ -0,0 +1,163 @@
+
+import { cmp, File, Content } from '@voxgig/sdkgen'
+
+
+// Emits sdktest/ReadmeExamplesTest.scala — a PRESENCE + STRUCTURE gate over
+// every scala fenced block in the repository ROOT README.md, the per-language
+// scala/README.md, AND the per-language scala/REFERENCE.md. It is a
+// default-package scala-cli object exposing run(rep) and is driven by the
+// generated SdkEntityTestMain aggregator (mirrors the generated per-entity
+// test objects).
+//
+// SCOPE NOTE (deliberate, documented): the Python/TS/Go equivalents EXECUTE and
+// type-check every documented block. That is infeasible here — the generated
+// Scala SDK compiles with scala-cli only (no in-process Scala compiler wired
+// into the test runtime), 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 scala block (nothing was
+//      dropped);
+//   2. every scala 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 Scala 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
+
+  File({ name: 'ReadmeExamplesTest.' + target.ext }, () => {
+    Content(`// ${Name} SDK — documentation scala-examples PRESENCE + STRUCTURE gate.
+//
+// GUARANTEE (see ReadmeExamplesTest_scala.ts for why this is a structure gate
+// and not an execute gate): every scala example in the docs is accounted for.
+// A dependency-free scala-cli test object (default package, driven by
+// SdkEntityTestMain) over every scala fenced code block in three documents:
+//   - the repository ROOT README.md (one directory above the scala module),
+//   - the per-language scala/README.md,
+//   - the per-language scala/REFERENCE.md.
+//
+// Checks, PER DOCUMENT:
+//   1. PRESENCE: the doc exists and holds at least one scala block.
+//   2. STRUCTURE: every scala 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 java.nio.file.{Files, Path, Paths}
+
+object ReadmeExamplesTest {
+
+  // The three documents to scan, resolved relative to the scala module
+  // directory (the working directory when scala-cli runs the tests). Each row
+  // is {label, relative path}.
+  private def docs(): Array[Array[String]] = Array(
+    Array("root README", ".." + java.io.File.separator + "README.md"),
+    Array("scala README.md", "README.md"),
+    Array("scala REFERENCE.md", "REFERENCE.md")
+  )
+
+  // Extract every scala 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
+  // "scala" are returned.
+  private def scalaBlocks(text: String): java.util.List[String] = {
+    val fence = 96.toChar.toString.repeat(3)
+    val parts = text.split(java.util.regex.Pattern.quote(fence), -1)
+    val blocks = new java.util.ArrayList[String]()
+    var i = 1
+    while (i < parts.length) {
+      val seg = parts(i)
+      val nl = seg.indexOf('\\n')
+      val info = (if (nl < 0) seg else seg.substring(0, nl)).trim()
+      if (info == "scala") {
+        blocks.add(if (nl < 0) "" else seg.substring(nl + 1))
+      }
+      i += 2
+    }
+    blocks
+  }
+
+  private def readDoc(path: Path): String =
+    new String(Files.readAllBytes(path), "UTF-8")
+
+  // 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 def balanced(block: String): Boolean = {
+    val stack = new java.util.ArrayDeque[Character]()
+    var i = 0
+    while (i < block.length) {
+      val ch = block.charAt(i)
+      ch match {
+        case '(' => stack.push(')')
+        case '[' => stack.push(']')
+        case '{' => stack.push('}')
+        case ')' | ']' | '}' =>
+          if (stack.isEmpty || stack.pop().charValue() != ch) return false
+        case _ =>
+      }
+      i += 1
+    }
+    stack.isEmpty
+  }
+
+  def run(rep: SdkTestReport): Unit = {
+    val ds = docs()
+
+    // PRESENCE: each doc exists and holds at least one scala block.
+    var di = 0
+    while (di < ds.length) {
+      val label = ds(di)(0)
+      val rel = ds(di)(1)
+      rep.scope("readme-examples.presence." + label) {
+        val path = Paths.get(rel)
+        rep.check("readme-examples.presence." + label + ".exists",
+          Files.exists(path), label + " not found: " + path)
+        if (Files.exists(path)) {
+          val blocks = scalaBlocks(readDoc(path))
+          rep.check("readme-examples.presence." + label, blocks.size() > 0,
+            "expected at least one scala block in " + label)
+        }
+      }
+      di += 1
+    }
+
+    // STRUCTURE: every scala block's delimiters balance.
+    rep.scope("readme-examples.structure") {
+      val failures = new java.util.ArrayList[String]()
+      var dj = 0
+      while (dj < ds.length) {
+        val label = ds(dj)(0)
+        val path = Paths.get(ds(dj)(1))
+        if (Files.exists(path)) {
+          val blocks = scalaBlocks(readDoc(path))
+          var balancedCount = 0
+          var bi = 0
+          while (bi < blocks.size()) {
+            if (balanced(blocks.get(bi))) balancedCount += 1
+            else failures.add(label + " scala block #" + bi + " has unbalanced delimiters")
+            bi += 1
+          }
+          println("[readme-examples] " + label + " scala blocks: total=" +
+            blocks.size() + " balanced=" + balancedCount)
+        }
+        dj += 1
+      }
+      rep.check("readme-examples.structure", failures.isEmpty(),
+        String.join("; ", failures))
+    }
+  }
+}
+`)
+  })
+})
+
+
+export {
+  ReadmeExamplesTest
+}

package/project/.sdk/src/cmp/scala/ReadmeExplanation_scala.ts

@@ -0,0 +1,49 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+import { scalaPackage } from './utility_scala'
+
+
+const ReadmeExplanation = cmp(function ReadmeExplanation(props: any) {
+  const { target, ctx$: { model } } = props
+
+  const pkg = scalaPackage(model)
+
+  Content(`### Data as maps
+
+The Scala SDK uses a loose object model — \`java.util.Map[String, Object]\`
+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
+\`java.util.Map[String, Object]\`. A \`${model.const.Name}Types.scala\` module of
+reference \`case class\` types is also generated for editor documentation.
+
+### Project structure
+
+\`\`\`
+scala/
+├── project.scala               -- scala-cli project config (Scala 3, no deps)
+├── 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
+└── sdktest/                     -- Generated per-entity tests (scala-cli mains)
+\`\`\`
+
+The main client class (\`${model.const.Name}SDK\`, package \`${pkg}.core\`)
+exposes the entity accessors. Reference entity or utility types directly only
+when needed. The SDK is a dependency-free scala-cli project: JSON parsing is
+the vendored \`utility/Json.java\`, HTTP transport is the JDK
+\`java.net.http.HttpClient\`, and the struct library is inlined under
+\`utility/struct\`.
+
+`)
+
+})
+
+
+export {
+  ReadmeExplanation
+}