@voxgig/sdkgen 1.3.14 → 1.3.18

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

@@ -0,0 +1,175 @@
+
+import { cmp, each, Content, canonToType, canonKey, 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, JSON-serialisable 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}"`
+}
+
+
+// Operation method spelling for Java: 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 Java keyword gets a
+    // trailing underscore (javaVarName) so the snippet compiles.
+    const eVar = javaVarName(entity.name)
+    const accessor = javaVarName(entity.name)
+
+    Content(`
+### ${entity.Name}
+
+`)
+
+    if (entity.short) {
+      Content(`${entity.short}
+
+`)
+    }
+
+    Content(`Create an instance: \`SdkEntity ${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
+        ? `Map.of(${loadItems.map((it: any) =>
+          `"${it.name}", ${javaLit(it.type,
+            it.name === idF ? entity.name + '_id' : it.name)}`).join(', ')})`
+        : 'null'
+      Content(`#### Example: Load
+
+\`\`\`java
+Object ${eVar} = client.${accessor}(null).load(${loadArg}, null);
+\`\`\`
+
+`)
+    }
+
+    if (opnames.includes('list')) {
+      Content(`#### Example: List
+
+\`\`\`java
+Object ${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
+
+\`\`\`java
+Object ${eVar} = 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);
+\`\`\`
+
+`)
+    }
+  })
+})
+
+
+export {
+  ReadmeEntity
+}

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

@@ -0,0 +1,208 @@
+
+import { cmp, File, Content } from '@voxgig/sdkgen'
+
+import { javaPackage } from './utility_java'
+
+
+// Emits test/ReadmeExamplesTest.java — a JUnit PRESENCE + STRUCTURE gate over
+// every ```java fenced block in the repository ROOT README.md, the
+// per-language java/README.md, AND the per-language java/REFERENCE.md.
+//
+// SCOPE NOTE (deliberate, documented): the Python/TS/Go equivalents EXECUTE and
+// type-check every documented block. That is infeasible here — the generated
+// Java SDK compiles with plain `javac`/Maven only (no in-process Java 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 ```java block (nothing was
+//      dropped);
+//   2. every ```java 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 Java is written WITHOUT literal backticks (the fence marker is
+// built at runtime as String.valueOf((char) 96).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 javapackage = props.javapackage || javaPackage(model)
+
+  File({ name: 'ReadmeExamplesTest.' + target.ext }, () => {
+    Content(`package ${javapackage}.sdktest;
+
+// ${Name} SDK — documentation java-examples PRESENCE + STRUCTURE gate.
+//
+// GUARANTEE (see ReadmeExamplesTest_java.ts for why this is a structure gate
+// and not an execute gate): every java example in the docs is accounted for.
+// This JUnit class is a completeness gate over every ${'```'}java fenced code
+// block in three documents:
+//   - the repository ROOT README.md (one directory above this module),
+//   - the per-language java/README.md,
+//   - the per-language java/REFERENCE.md.
+//
+// Checks, PER DOCUMENT:
+//   1. PRESENCE: the doc exists and holds at least one java block.
+//   2. STRUCTURE: every java 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 static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.ArrayDeque;
+import java.util.ArrayList;
+import java.util.Deque;
+import java.util.List;
+import java.util.Map;
+
+import org.junit.jupiter.api.Test;
+
+public class ReadmeExamplesTest {
+
+  // The three documents to scan, resolved relative to the Maven module
+  // directory (the working directory when surefire runs the tests). Each row
+  // is {label, relative path}.
+  private static String[][] docs() {
+    return new String[][] {
+      { "root README", ".." + java.io.File.separator + "README.md" },
+      { "java README.md", "README.md" },
+      { "java REFERENCE.md", "REFERENCE.md" },
+    };
+  }
+
+  // Extract every java 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
+  // "java" are returned.
+  private static List<String> javaBlocks(String text) {
+    String fence = String.valueOf((char) 96).repeat(3);
+    String[] parts = text.split(java.util.regex.Pattern.quote(fence), -1);
+    List<String> blocks = new ArrayList<>();
+    for (int i = 1; i < parts.length; i += 2) {
+      String seg = parts[i];
+      int nl = seg.indexOf('\\n');
+      String info = (nl < 0 ? seg : seg.substring(0, nl)).trim();
+      if (info.equals("java")) {
+        blocks.add(nl < 0 ? "" : seg.substring(nl + 1));
+      }
+    }
+    return blocks;
+  }
+
+  // A well-formed doc has an even number of triple-backtick fence markers:
+  // every opening fence has a matching close. An odd count means a fence was
+  // opened but never closed — a truncated or malformed generated doc. The
+  // split-based javaBlocks() would silently treat the unterminated tail as a
+  // complete block, so this must be checked explicitly.
+  private static boolean fencesClosed(String text) {
+    String fence = String.valueOf((char) 96).repeat(3);
+    int count = 0;
+    int from = 0;
+    int idx;
+    while ((idx = text.indexOf(fence, from)) >= 0) {
+      count++;
+      from = idx + fence.length();
+    }
+    return count % 2 == 0;
+  }
+
+  private static String readDoc(Path path, String label) {
+    assertTrue(Files.exists(path), label + " not found: " + path);
+    try {
+      return Files.readString(path);
+    }
+    catch (IOException e) {
+      throw new RuntimeException("failed to read " + label + ": " + path, e);
+    }
+  }
+
+  // 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 static boolean balanced(String block) {
+    Deque<Character> stack = new ArrayDeque<>();
+    Map<Character, Character> pairs =
+        Map.of('(', ')', '[', ']', '{', '}');
+    for (int i = 0; i < block.length(); i++) {
+      char ch = block.charAt(i);
+      if (pairs.containsKey(ch)) {
+        stack.push(pairs.get(ch));
+      }
+      else if (ch == ')' || ch == ']' || ch == '}') {
+        if (stack.isEmpty() || stack.pop() != ch) {
+          return false;
+        }
+      }
+    }
+    return stack.isEmpty();
+  }
+
+  @Test
+  public void rootReadmeHasJavaBlocks() {
+    String[] doc = docs()[0];
+    List<String> blocks = javaBlocks(readDoc(Path.of(doc[1]), doc[0]));
+    assertTrue(blocks.size() > 0,
+        "expected at least one java block in " + doc[0]);
+  }
+
+  @Test
+  public void localReadmeHasJavaBlocks() {
+    String[] doc = docs()[1];
+    List<String> blocks = javaBlocks(readDoc(Path.of(doc[1]), doc[0]));
+    assertTrue(blocks.size() > 0,
+        "expected at least one java block in " + doc[0]);
+  }
+
+  @Test
+  public void referenceHasJavaBlocks() {
+    String[] doc = docs()[2];
+    List<String> blocks = javaBlocks(readDoc(Path.of(doc[1]), doc[0]));
+    assertTrue(blocks.size() > 0,
+        "expected at least one java block in " + doc[0]);
+  }
+
+  @Test
+  public void allJavaBlocksAreStructurallyBalanced() {
+    List<String> failures = new ArrayList<>();
+    for (String[] doc : docs()) {
+      Path path = Path.of(doc[1]);
+      if (!Files.exists(path)) {
+        continue;
+      }
+      String src = readDoc(path, doc[0]);
+      if (!fencesClosed(src)) {
+        failures.add(doc[0] +
+            " has an unclosed code fence (opened but never closed)");
+      }
+      List<String> blocks = javaBlocks(src);
+      int balancedCount = 0;
+      for (int i = 0; i < blocks.size(); i++) {
+        if (balanced(blocks.get(i))) {
+          balancedCount++;
+        }
+        else {
+          failures.add(doc[0] + " java block #" + i +
+              " has unbalanced delimiters:\\n\\n" + blocks.get(i));
+        }
+      }
+      System.out.println(
+          "[readme-examples] " + doc[0] + " java blocks: total=" +
+          blocks.size() + " balanced=" + balancedCount);
+    }
+    assertTrue(failures.isEmpty(), String.join("\\n\\n", failures));
+  }
+}
+`)
+  })
+})
+
+
+export {
+  ReadmeExamplesTest
+}

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

@@ -0,0 +1,46 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+import { javaPackage } from './utility_java'
+
+
+const ReadmeExplanation = cmp(function ReadmeExplanation(props: any) {
+  const { target, ctx$: { model } } = props
+
+  const pkg = javaPackage(model)
+
+  Content(`### Data as maps
+
+The Java SDK uses a loose object model — \`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
+\`Map<String, Object>\`. A \`${model.const.Name}Types.java\` module of reference
+\`record\` types is also generated for editor documentation.
+
+### Project structure
+
+\`\`\`
+java/
+├── pom.xml                     -- Maven project (compiles core/, utility/, feature/, entity/)
+├── 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
+}

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

@@ -0,0 +1,156 @@
+
+import { cmp, Content, isAuthActive, envName, 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 ReadmeHowto = cmp(function ReadmeHowto(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). primaryOp is null only
+  // when NO entity exposes any op (a direct()-only SDK).
+  const { entity: exampleEntity, primaryOp } = pickExampleEntity(entity)
+  const eVar = exampleEntity ? javaVarName(exampleEntity.name) : 'entity'
+  const accessor = exampleEntity ? javaVarName(exampleEntity.name) : 'entity'
+  // Model-driven id key: null when the entity has no id-like field, so a
+  // match op takes an empty match.
+  const idF = exampleEntity ? entityIdField(exampleEntity) : null
+  const isMatchOp = 'load' === primaryOp || 'remove' === primaryOp
+  let testArg = 'null'
+  if (exampleEntity && isMatchOp) {
+    testArg = idF ? `Map.of("${idF}", "test01")` : 'null'
+  } else if (exampleEntity && ('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)
+    testArg = `Map.of(${chosen.map((it: any) =>
+      `"${it.name}", ${javaLit(it.type)}`).join(', ')})`
+  }
+
+  // The op-driven test-mode line, shown only when the SDK has an entity op.
+  // A direct()-only SDK (no ops anywhere) shows a direct() call instead.
+  const testModeExample = primaryOp
+    ? `// Entity ops return the bare record and raise on error.
+Object ${eVar} = client.${accessor}(null).${primaryOp}(${testArg}, null);
+// ${eVar} holds the mock response record
+System.out.println(${eVar});`
+    : `Map<String, Object> result = client.direct(Map.of(
+    "path", "/api/resource",
+    "method", "GET"));
+System.out.println(result);`
+
+  const apikeyEnvLine = isAuthActive(model)
+    ? `\n${envName(model)}_APIKEY=<your-key>`
+    : ''
+
+  Content(`### Make a direct HTTP request
+
+For endpoints not covered by entity methods:
+
+\`\`\`java
+Map<String, Object> result = client.direct(Map.of(
+    "path", "/api/resource/{id}",
+    "method", "GET",
+    "params", Map.of("id", "example")));
+
+if (Boolean.TRUE.equals(result.get("ok"))) {
+    System.out.println(result.get("status"));  // 200
+    System.out.println(result.get("data"));    // response body
+}
+else {
+    // A non-2xx response carries status + data (the error body); a
+    // transport-level failure carries err instead. Only one is present, so
+    // read both — an absent key simply reads as null.
+    System.out.println(result.get("status") + " " + result.get("err"));
+}
+\`\`\`
+
+### Prepare a request without sending it
+
+\`\`\`java
+// prepare() returns the fetch definition and raises on error.
+Map<String, Object> fetchdef = client.prepare(Map.of(
+    "path", "/api/resource/{id}",
+    "method", "DELETE",
+    "params", Map.of("id", "example")));
+
+System.out.println(fetchdef.get("url"));
+System.out.println(fetchdef.get("method"));
+System.out.println(fetchdef.get("headers"));
+\`\`\`
+
+### Use test mode
+
+Create a mock client for unit testing — no server required:
+
+\`\`\`java
+${SDK} client = ${SDK}.testSDK(null, null);
+
+${testModeExample}
+\`\`\`
+
+### Use a custom fetch function
+
+Replace the HTTP transport with your own \`BiFunction\`:
+
+\`\`\`java
+java.util.function.BiFunction<String, Map<String, Object>, Object> mockFetch =
+    (url, init) -> {
+        Map<String, Object> res = new java.util.LinkedHashMap<>();
+        res.put("status", 200);
+        res.put("statusText", "OK");
+        res.put("headers", new java.util.LinkedHashMap<String, Object>());
+        res.put("json", (java.util.function.Supplier<Object>) () ->
+            Map.of("id", "mock01"));
+        return res;
+    };
+
+Map<String, Object> options = new java.util.LinkedHashMap<>();
+options.put("base", "http://localhost:8080");
+options.put("system", Map.of("fetch", mockFetch));
+${SDK} client = new ${SDK}(options);
+\`\`\`
+
+### Run live tests
+
+Create a \`.env.local\` file at the project root:
+
+\`\`\`
+${envName(model)}_TEST_LIVE=TRUE${apikeyEnvLine}
+\`\`\`
+
+Then run:
+
+\`\`\`bash
+cd java && mvn test
+\`\`\`
+
+`)
+
+})
+
+
+export {
+  ReadmeHowto
+}

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

@@ -0,0 +1,52 @@
+
+import { cmp, Content, isPublished, repoInfo } from '@voxgig/sdkgen'
+
+import { mavenGroupId } from './utility_java'
+
+
+const ReadmeInstall = cmp(function ReadmeInstall(props: any) {
+  const { target, ctx$ } = props
+  const { model } = ctx$
+
+  const groupId = mavenGroupId(model)
+  const artifactId = `${model.name}-sdk`
+
+  if (isPublished(model, target.name)) {
+    Content(`Add the dependency to your \`pom.xml\`:
+
+\`\`\`xml
+<dependency>
+  <groupId>${groupId}</groupId>
+  <artifactId>${artifactId}</artifactId>
+  <version>0.0.1</version>
+</dependency>
+\`\`\`
+
+Or build and install from a source checkout:
+
+\`\`\`bash
+cd java && mvn install
+\`\`\`
+
+`)
+    return
+  }
+
+  // Publish pending: not yet on Maven Central. Install from the git release
+  // tag or from a local source checkout built with Maven.
+  const { releasesUrl } = repoInfo(model)
+  Content(`This package is not yet published to Maven Central. Install it from the GitHub
+release tag (\`${target.name}/vX.Y.Z\`, see [Releases](${releasesUrl})) or
+from a source checkout — build the library with Maven:
+
+\`\`\`bash
+cd java && mvn install
+\`\`\`
+
+`)
+})
+
+
+export {
+  ReadmeInstall
+}