@voxgig/sdkgen 1.3.14 → 1.3.18

package/project/.sdk/src/cmp/java/ReadmeRef_java.ts

@@ -0,0 +1,388 @@
+
+import { cmp, each, Content, canonToType, canonKey, File, isAuthActive, entityIdField, opRequestShape } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+import { javaVarName } from './utility_java'
+
+
+// Type names come from the shared canonToType 'java' column (single source of truth).
+
+// A type-correct Java literal for a field's canonical type.
+function javaLit(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 'List.of()'
+  if ('OBJECT' === k) return 'Map.of()'
+  return `"${placeholder}"`
+}
+
+
+const OP_SIGNATURES: Record<string, { sig: string, returns: string, desc: string }> = {
+  load: {
+    sig: 'load(reqmatch, ctrl) -> Object',
+    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) -> Object',
+    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) -> Object',
+    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) -> Object',
+    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) -> Object',
+    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(`\`\`\`java
+${SDK} client = new ${SDK}(options);
+\`\`\`
+
+Create a new SDK client instance. \`options\` is a \`Map<String, Object>\`.
+
+**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\`.
+
+\`\`\`java
+${SDK} client = ${SDK}.testSDK(null, null);
+\`\`\`
+
+`)
+
+
+    Content(`
+### Instance Methods
+
+`)
+
+
+    // Entity factory methods
+    publishedEntities.map((ent: any) => {
+      Content(`#### \`${javaVarName(ent.name)}(entopts)\`
+
+Create a new \`${ent.Name}\` entity instance (returns \`SdkEntity\`). Pass
+\`null\` for no initial options.
+
+`)
+    })
+
+
+    Content(`#### \`optionsMap() -> Map\`
+
+Return a deep copy of the current SDK options.
+
+#### \`getUtility() -> Utility\`
+
+Return a copy of the SDK utility object.
+
+#### \`direct(fetchargs) -> Map\`
+
+Make a direct HTTP request to any API endpoint. Returns a result
+\`Map<String, Object>\` with \`ok\`, \`status\`, \`headers\`, and \`data\` (or
+\`err\` on failure). This escape hatch never raises — branch on
+\`result.get("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"]\` | \`Object\` | Request body (maps are JSON-serialized). |
+
+**Returns:** \`Map<String, Object>\`
+
+#### \`prepare(fetchargs) -> Map\`
+
+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 — javaVarName guards Java keywords.
+      const eVar = javaVarName(ent.name)
+      const accessor = javaVarName(ent.name)
+
+      Content(`
+---
+
+## ${ent.Name}
+
+`)
+
+      if (ent.short) {
+        Content(`${ent.short}
+
+`)
+      }
+
+      Content(`\`\`\`java
+SdkEntity ${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
+              ? `Map.of(${matchItems.map((it: any) =>
+                `"${it.name}", ${javaLit(it.type,
+                  it.name === idF ? ent.name + '_id' : it.name)}`).join(', ')})`
+              : 'null'
+            Content(`\`\`\`java
+Object result = client.${accessor}(null).${opname}(${arg}, null);
+\`\`\`
+
+`)
+          }
+          else if ('list' === opname) {
+            Content(`\`\`\`java
+Object results = client.${accessor}(null).list(null, null);
+System.out.println(results);
+\`\`\`
+
+`)
+          }
+          else if ('create' === opname) {
+            const createItems = opRequestShape(ent, 'create').items
+              .filter((it: any) => !it.optional)
+            Content(`\`\`\`java
+Object result = client.${accessor}(null).create(Map.of(
+`)
+            createItems.map((it: any, i: number) => {
+              const comma = i < createItems.length - 1 ? ',' : ''
+              Content(`    "${it.name}", ${javaLit(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}", ${javaLit(it.type,
+                it.name === idF ? ent.name + '_id' : it.name)}${comma}\n`
+            }).join('')
+            Content(`\`\`\`java
+Object result = client.${accessor}(null).update(Map.of(
+${updateLines}), null);
+\`\`\`
+
+`)
+          }
+        })
+      }
+
+
+      // Common methods
+      Content(`### Common Methods
+
+#### \`data(newdata...) -> Object\`
+
+Get or set the entity data.
+
+#### \`match(newmatch...) -> Object\`
+
+Get or set the entity match criteria.
+
+#### \`make() -> Entity\`
+
+Create a new \`${ent.Name}\` entity instance with the same options.
+
+#### \`getName() -> String\`
+
+Return the entity name.
+
+`)
+    })
+
+
+    // 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(`\`\`\`java
+Map<String, Object> feature = new java.util.LinkedHashMap<>();
+`)
+      activeFeatures.map((f: any) => {
+        Content(`feature.put("${f.name}", Map.of("active", true));
+`)
+      })
+      Content(`Map<String, Object> options = new java.util.LinkedHashMap<>();
+options.put("feature", feature);
+${SDK} client = new ${SDK}(options);
+\`\`\`
+
+`)
+    }
+
+  })
+})
+
+
+export {
+  ReadmeRef
+}

package/project/.sdk/src/cmp/java/ReadmeTopHowto_java.ts

@@ -0,0 +1,23 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+
+const ReadmeTopHowto = cmp(function ReadmeTopHowto(props: any) {
+  const { target } = props
+
+  Content(`**Java:**
+\`\`\`java
+Map<String, Object> result = client.direct(Map.of(
+    "path", "/api/resource/{id}",
+    "method", "GET",
+    "params", Map.of("id", "example")));
+\`\`\`
+
+`)
+
+})
+
+
+export {
+  ReadmeTopHowto
+}

package/project/.sdk/src/cmp/java/ReadmeTopQuick_java.ts

@@ -0,0 +1,103 @@
+
+import { cmp, Content, isAuthActive, envName, canonKey, entityIdField, opRequestShape } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+  nom,
+} from '@voxgig/apidef'
+
+import { javaVarName, javaPackage } from './utility_java'
+
+
+// A type-correct Java 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 Map<String, Object>.
+function javaLit(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 'List.of()'
+  if ('OBJECT' === k) return 'Map.of()'
+  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(`\`\`\`java
+import ${javaPackage(model)}.core.${SDK};
+
+`)
+
+  if (authActive) {
+    Content(`Map<String, Object> options = new java.util.LinkedHashMap<>();
+options.put("apikey", System.getenv("${envName(model)}_APIKEY"));
+${SDK} client = new ${SDK}(options);
+
+`)
+  }
+  else {
+    Content(`${SDK} client = new ${SDK}();
+
+`)
+  }
+
+  if (exampleEntity) {
+    // Sanitise the local variable name — an entity whose camelCased name is a
+    // Java keyword gets a trailing underscore (javaVarName) so the snippet compiles.
+    const eVar = javaVarName(exampleEntity.name)
+    const accessor = javaVarName(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 Object, an aggregate list; raises on error)
+Object ${eVar}List = client.${accessor}(null).list(null, null);
+System.out.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
+        ? `Map.of(${loadItems.map((it: any) =>
+          `"${it.name}", ${javaLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)}`).join(', ')})`
+        : 'null'
+      Content(`
+// Load a specific ${eNameLower} (returns the record, raises on error)
+Object ${eVar} = client.${accessor}(null).load(${loadArg}, null);
+System.out.println(${eVar});
+`)
+    }
+  }
+
+  Content(`\`\`\`
+`)
+
+})
+
+
+export {
+  ReadmeTopQuick
+}

package/project/.sdk/src/cmp/java/ReadmeTopTest_java.ts

@@ -0,0 +1,77 @@
+
+import { cmp, Content, canonKey, entityIdField, pickExampleEntity, opRequestShape } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+import { javaVarName } from './utility_java'
+
+
+// A type-correct Java literal for a field's canonical type.
+function javaLit(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 'List.of()'
+  if ('OBJECT' === k) return 'Map.of()'
+  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(`\`\`\`java
+${SDK} 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
+        ? `Map.of(${items.map((it: any) =>
+          `"${it.name}", ${it.name === idF ? '"test01"' : javaLit(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 = `Map.of(${chosen.map((it: any) =>
+        `"${it.name}", ${javaLit(it.type)}`).join(', ')})`
+    }
+    const eVar = javaVarName(exampleEntity.name) + ('list' === primaryOp ? 'List' : '')
+    const accessor = javaVarName(exampleEntity.name)
+    Content(`Object ${eVar} = client.${accessor}(null).${primaryOp}(${arg}, null);
+System.out.println(${eVar});
+`)
+  }
+
+  Content(`\`\`\`
+`)
+
+})
+
+
+export {
+  ReadmeTopTest
+}

package/project/.sdk/src/cmp/java/TestDirect_java.ts

@@ -75,7 +75,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')
 
@@ -83,8 +83,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
 
   // Get load point info
   const loadPoint = loadOp?.points?.[0]

package/project/.sdk/src/cmp/java/Test_java.ts

@@ -13,6 +13,7 @@ import { cmp, each, Folder } from '@voxgig/sdkgen'
 
 import { TestEntity } from './TestEntity_java'
 import { TestDirect } from './TestDirect_java'
+import { ReadmeExamplesTest } from './ReadmeExamplesTest_java'
 import { javaPackage } from './utility_java'
 
 
@@ -33,6 +34,9 @@ const Test = cmp(function Test(props: any) {
       TestEntity({ target, entity, javapackage })
       TestDirect({ target, entity, javapackage })
     })
+
+    // Validate the documented java examples in the root + per-language docs.
+    ReadmeExamplesTest({ target, javapackage })
   })
 })
 

package/project/.sdk/src/cmp/js/EntityTypes_js.ts

@@ -14,16 +14,19 @@
 //
 // The typedefs are emitted at file (script) scope so they are GLOBAL across
 // the SDK's JS program — the op fragments reference them by bare name
-// (@param {AdviceLoadMatch} / @returns {Promise<Advice>}). Keeps the SAME
-// type-name scheme as the TS reference (<Name>, <Name>LoadMatch,
-// <Name>ListMatch, <Name>CreateData, <Name>UpdateData, <Name>RemoveMatch).
+// (@param {AdviceLoadMatch} / @returns {Promise<Advice>}). The program itself
+// is established by the tm/js/jsconfig.json template shipped at the SDK root
+// (one project spanning src/ + test/), so resolution does not depend on
+// editor workspace inference. Keeps the SAME type-name scheme as the TS
+// reference (<Name>, <Name>LoadMatch, <Name>ListMatch, <Name>CreateData,
+// <Name>UpdateData, <Name>RemoveMatch).
 
 import {
   cmp, each, names,
   File, Content,
 } from '@voxgig/sdkgen'
 
-import { canonToType, opTypeName, opRequestShape } from '@voxgig/sdkgen'
+import { canonToType, opTypeName, opRequestShape, warnEntityTypeCollisions , deriveEntityNames } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -42,14 +45,27 @@ function propKey(name: string): string {
 
 
 const EntityTypes = cmp(function EntityTypes(props: any) {
-  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 = deriveEntityNames(entity)
   // 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.const.Name + 'Types.' + LANG }, () => {