@voxgig/sdkgen 1.3.14 → 1.3.17

package/project/.sdk/src/cmp/zig/ReadmeIntro_zig.ts

@@ -0,0 +1,66 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+import { zigVarName } from './utility_zig'
+
+
+const ReadmeIntro = cmp(function ReadmeIntro(props: any) {
+  const { target, ctx$: { model } } = props
+  const info = (model.main && model.main.kit && model.main.kit.info) || {}
+  const tagline = info.tagline || ''
+
+  Content(`# ${model.Name} ${target.title} SDK
+
+${tagline}
+
+The ${target.title} SDK for the ${model.Name} API — an entity-oriented client following idiomatic Zig conventions.
+
+`)
+
+  // Emphasise the entity-oriented design: the SDK surfaces the API as
+  // capitalised, semantic Entities with a small, uniform verb set rather
+  // than raw URL paths and query strings. The example entity name is
+  // derived from the model, never hardcoded.
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+  const exampleEntity = Object.values(entity || {})
+    .find((e: any) => e.active !== false) as any
+  const example = exampleEntity
+    ? `for example \`client.${zigVarName(exampleEntity.name)}(h.vnull())\` — each`
+    : 'each'
+
+  // Model-driven op list — only the operations the active entities actually
+  // expose (a read-only entity has just list+load); never claim
+  // create/update/remove exist when no entity has them.
+  const CANON_OPS = ['list', 'load', 'create', 'update', 'remove']
+  const opSet = new Set<string>()
+  Object.values(entity || {}).forEach((e: any) => {
+    if (!e || e.active === false) return
+    Object.keys(e.op || {}).forEach((o: string) => {
+      if (e.op[o] && e.op[o].active !== false) opSet.add(o)
+    })
+  })
+  const opNames = CANON_OPS.filter((o) => opSet.has(o))
+    .concat([...opSet].filter((o) => !CANON_OPS.includes(o)))
+  const opList = (opNames.length ? opNames : ['list', 'load'])
+    .map((o) => '`' + o + '`').join(', ')
+
+  Content(`The SDK exposes the API as capitalised, semantic **Entities** — ${example}
+carrying a small, uniform set of operations (${opList}) instead of raw URL
+paths and query strings. You work with named resources and verbs, which
+keeps the cognitive load low.
+
+> Other languages, the CLI, and MCP server live alongside this one — see
+> the [top-level README](../README.md).
+
+`)
+})
+
+
+export {
+  ReadmeIntro
+}

package/project/.sdk/src/cmp/zig/ReadmeModel_zig.ts

@@ -0,0 +1,152 @@
+
+import { cmp, each, Content, isAuthActive } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+import { zigVarName } from './utility_zig'
+
+
+const ReadmeModel = cmp(function ReadmeModel(props: any) {
+  const { target, ctx$: { model } } = props
+
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+  const entityList = each(entity).filter((e: any) => e.active !== false)
+
+  // Model-driven op rows for the shared entity interface: emit a row only for
+  // operations at least one active entity actually exposes.
+  const opUnion = new Set<string>()
+  entityList.forEach((e: any) => Object.keys(e.op || {})
+    .forEach((o: string) => { if (e.op[o] && e.op[o].active !== false) opUnion.add(o) }))
+  const opRowDefs: Record<string, string> = {
+    load: '| `load` | `(reqmatch: Value, ctrl: Value) OpResult` | Load a single entity by match criteria. |',
+    list: '| `list` | `(reqmatch: Value, ctrl: Value) OpResult` | List entities matching the criteria (`.ok` is a `Value` array). |',
+    create: '| `create` | `(reqdata: Value, ctrl: Value) OpResult` | Create a new entity. |',
+    update: '| `update` | `(reqdata: Value, ctrl: Value) OpResult` | Update an existing entity. |',
+    remove: '| `remove` | `(reqmatch: Value, ctrl: Value) OpResult` | Remove an entity. |',
+  }
+  const opRows = ['load', 'list', 'create', 'update', 'remove']
+    .filter((o) => opUnion.has(o)).map((o) => opRowDefs[o]).join('\n')
+
+  const apikeyOptionRow = isAuthActive(model)
+    ? '| `apikey` | `string` | API key for authentication. |\n'
+    : ''
+
+  Content(`### ${model.const.Name}SDK
+
+\`\`\`zig
+const sdk = @import("sdk");
+const h = sdk.h;
+
+const client = sdk.${model.const.Name}SDK.new(options);
+\`\`\`
+
+Creates a new SDK client. \`options\` is a \`Value\` map (\`h.vnull()\` for
+none) carrying any of the following keys:
+
+| Option | Value type | Description |
+| --- | --- | --- |
+${apikeyOptionRow}| \`base\` | \`string\` | Base URL of the API server. |
+| \`prefix\` | \`string\` | URL path prefix prepended to all requests. |
+| \`suffix\` | \`string\` | URL path suffix appended to all requests. |
+| \`feature\` | \`map\` | Feature activation flags. |
+| \`system\` | \`map\` | System overrides (e.g. a custom fetcher). |
+
+### test_sdk
+
+\`\`\`zig
+const client = sdk.test_sdk(testopts, sdkopts);
+\`\`\`
+
+Creates a test-mode client with mock transport. Both arguments may be
+\`h.vnull()\`.
+
+### ${model.const.Name}SDK methods
+
+| Method | Signature | Description |
+| --- | --- | --- |
+| \`options_map\` | \`() Value\` | Deep copy of the current SDK options. |
+| \`get_utility\` | \`() *Utility\` | Copy of the SDK utility object. |
+| \`prepare\` | \`(fetchargs: Value) E!Value\` | Build an HTTP request definition without sending. |
+| \`direct\` | \`(fetchargs: Value) Value\` | Build and send an HTTP request. Returns a result map (branch on \`ok\`). |
+`)
+
+  each(entityList, (ent: any) => {
+    const article = /^[aeiou]/i.test(ent.Name) ? 'an' : 'a'
+    Content(`| \`${zigVarName(ent.name)}\` | \`(entopts: Value) *${ent.Name}Entity\` | Create ${article} ${ent.Name} entity instance. |
+`)
+  })
+
+  Content(`
+### Entity interface
+
+All entities share the same interface.
+
+| Method | Signature | Description |
+| --- | --- | --- |
+${opRows}
+| \`stream\` | \`(action: []const u8, args: Value, callopts: Value) []Value\` | Run an op through the pipeline and materialise its result items. |
+| \`data\` | \`(args: ?Value) Value\` | Get entity data (pass a map to set). |
+| \`matchv\` | \`(args: ?Value) Value\` | Get entity match criteria (pass a map to set). |
+| \`get_name\` | \`() []const u8\` | Return the entity name. |
+
+### Result shape
+
+Entity operations return an \`OpResult\` union — \`switch\` on it: \`.ok\`
+carries the bare result data (a \`Value\` object for single-entity ops, a
+\`Value\` array for \`list\`), \`.err\` carries the branded error pointer.
+
+The \`direct()\` escape hatch returns a result \`Value\` map directly (no
+error union) — even on a non-2xx response — that you branch on via
+\`h.get_bool(result, "ok")\`:
+
+| Key | Type | Description |
+| --- | --- | --- |
+| \`ok\` | \`bool\` | \`true\` if the HTTP status is 2xx. |
+| \`status\` | \`number\` | HTTP status code. |
+| \`headers\` | \`map\` | Response headers. |
+| \`data\` | \`any\` | Parsed JSON response body. |
+
+On error, \`ok\` is \`false\` and \`err\` carries the error message.
+
+`)
+
+  // Entities summary
+  Content(`### Entities
+
+`)
+  each(entityList, (ent: any) => {
+    const fields = ent.fields || []
+    const opnames = Object.keys(ent.op || {})
+    const ops = ent.op || {}
+    const points = each(ops).map((op: any) =>
+      op.points ? each(op.points) : []
+    ).flat()
+    const path = points.length > 0 ? (points[0] as any).orig || '' : ''
+
+    Content(`#### ${ent.Name}
+
+| Field | Description |
+| --- | --- |
+`)
+    each(fields, (field: any) => {
+      Content(`| \`${field.name}\` | ${field.short || ''} |
+`)
+    })
+
+    Content(`
+Operations: ${opnames.map((n: string) => n.charAt(0).toUpperCase() + n.slice(1)).join(', ')}.
+
+API path: \`${path}\`
+
+`)
+  })
+
+})
+
+
+export {
+  ReadmeModel
+}

package/project/.sdk/src/cmp/zig/ReadmeOptions_zig.ts

@@ -0,0 +1,60 @@
+
+import { cmp, each, Content, envName, isAuthActive } from '@voxgig/sdkgen'
+
+
+const ReadmeOptions = cmp(function ReadmeOptions(props: any) {
+  const { target } = props
+  const { model } = props.ctx$
+
+  const publishedOptions = each(target.options).filter((option: any) =>
+    option.publish && ('apikey' !== option.name || isAuthActive(model)))
+  if (0 === publishedOptions.length) {
+    return
+  }
+
+  Content(`
+
+## Options
+
+Pass an options map when creating a client instance:
+
+`)
+
+  Content(`\`\`\`zig
+const client = sdk.${model.Name}SDK.new(h.jo(&.{
+`)
+
+  publishedOptions.map((option: any) => {
+    if ('apikey' === option.name) {
+      Content(`    .{ "${option.name}", h.vstr(std.posix.getenv("${envName(model)}_APIKEY") orelse "") },
+`)
+    }
+    else {
+      const val = option.kind === 'string' ? 'h.vstr("...")' : 'h.vnull()'
+      Content(`    // .{ "${option.name}", ${val} },
+`)
+    }
+  })
+
+  Content(`}));
+\`\`\`
+
+`)
+
+  Content(`| Option | Type | Description |
+| --- | --- | --- |
+`)
+
+  publishedOptions.map((option: any) => {
+    Content(`| \`${option.name}\` | \`${option.kind}\` | ${option.short} |
+`)
+  })
+
+  Content(`
+`)
+})
+
+
+export {
+  ReadmeOptions
+}

package/project/.sdk/src/cmp/zig/ReadmeQuick_zig.ts

@@ -0,0 +1,211 @@
+
+import { cmp, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityOps } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+  nom,
+} from '@voxgig/apidef'
+
+import { zigVarName } from './utility_zig'
+
+
+const ReadmeQuick = cmp(function ReadmeQuick(props: any) {
+  const { target, ctx$: { model } } = props
+
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+
+  const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
+
+  // Find a nested entity if available: one with a parent chain
+  // (relations.ancestors), an active load op, and a required non-id load
+  // param to demonstrate (the parent key, e.g. page_id).
+  const nestedEntity = Object.values(entity).find((e: any) =>
+    e.active !== false &&
+    e.relations && e.relations.ancestors && 0 < e.relations.ancestors.length &&
+    entityOps(e).includes('load') &&
+    opRequestShape(e, 'load').items.some((it: any) =>
+      !it.optional && it.name !== entityIdField(e))
+  ) as any
+
+  const authActive = isAuthActive(model)
+  const ctor = authActive
+    ? `sdk.${model.const.Name}SDK.new(h.jo(&.{\n    .{ "apikey", h.vstr(std.posix.getenv("${envName(model)}_APIKEY") orelse "") },\n}))`
+    : `sdk.${model.const.Name}SDK.new(h.vnull())`
+
+  // A type-correct zig expression constructing a voxgig struct Value.
+  const zigLit = (type: any, placeholder: string = 'example'): string => {
+    const k = canonKey(type)
+    if ('INTEGER' === k || 'NUMBER' === k) return 'h.vnum(1)'
+    if ('BOOLEAN' === k) return 'h.vbool(true)'
+    if ('ARRAY' === k) return 'h.olist()'
+    if ('OBJECT' === k) return 'h.omap()'
+    return `h.vstr("${placeholder}")`
+  }
+
+  Content(`### 1. Create a client
+
+\`\`\`zig
+const std = @import("std");
+const sdk = @import("sdk");
+const h = sdk.h;
+
+const client = ${ctor};
+\`\`\`
+
+`)
+
+  if (exampleEntity) {
+    const eName = nom(exampleEntity, 'Name')
+    const article = /^[aeiou]/i.test(eName) ? 'an' : 'a'
+    const eVar = zigVarName(exampleEntity.name)
+    const method = zigVarName(exampleEntity.name)
+    const opnames = entityOps(exampleEntity)
+    const idF = entityIdField(exampleEntity)
+
+    if (opnames.includes('list')) {
+      Content(`### 2. List ${eName.toLowerCase()} records
+
+\`list()\` returns an \`OpResult\` whose \`.ok\` is a \`Value\` array —
+\`switch\` on it.
+
+\`\`\`zig
+switch (client.${method}(h.vnull()).list(h.vnull(), h.vnull())) {
+    .ok => |${eVar}s| std.debug.print("{s}\\n", .{h.stringify(${eVar}s)}),
+    .err => |e| std.debug.print("list failed: {s}\\n", .{e.msg}),
+}
+\`\`\`
+
+`)
+    }
+
+    if (nestedEntity) {
+      const neName = nom(nestedEntity, 'Name')
+      const neArticle = /^[aeiou]/i.test(neName) ? 'an' : 'a'
+      const neVar = zigVarName(nestedEntity.name)
+      const neMethod = zigVarName(nestedEntity.name)
+
+      const neIdF = entityIdField(nestedEntity)
+      const neRequired = opRequestShape(nestedEntity, 'load').items
+        .filter((it: any) => !it.optional)
+        .sort((a: any, b: any) =>
+          (a.name === neIdF ? 1 : 0) - (b.name === neIdF ? 1 : 0))
+      const parentItem = neRequired.find((it: any) => it.name !== neIdF) as any
+      const parentParam = parentItem && parentItem.name
+      const parentName = parentParam ? parentParam.replace(/_id$/, '') : 'its parent'
+      const neMatch = neRequired.map((it: any) =>
+        `.{ "${it.name}", ${zigLit(it.type,
+          it.name === neIdF ? 'example_id' : 'example_' + it.name)} }`)
+
+      Content(`### 3. Load ${neArticle} ${neName.toLowerCase()}
+
+${neName} is nested under ${parentName}, so provide the \`${parentParam}\`.
+\`load()\`'s \`.ok\` carries the bare record.
+
+\`\`\`zig
+switch (client.${neMethod}(h.vnull()).load(h.jo(&.{${neMatch.join(', ')}}), h.vnull())) {
+    .ok => |${neVar}| std.debug.print("{s}\\n", .{h.stringify(${neVar})}),
+    .err => |e| std.debug.print("load failed: {s}\\n", .{e.msg}),
+}
+\`\`\`
+
+`)
+    }
+    else if (opnames.includes('load')) {
+      const loadRequired = 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 < loadRequired.length
+        ? `h.jo(&.{${loadRequired.map((it: any) =>
+          `.{ "${it.name}", ${zigLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)} }`).join(', ')}})`
+        : 'h.vnull()'
+
+      Content(`### 3. Load ${article} ${eName.toLowerCase()}
+
+\`load()\`'s \`.ok\` carries the bare record.
+
+\`\`\`zig
+switch (client.${method}(h.vnull()).load(${loadArg}, h.vnull())) {
+    .ok => |${eVar}| std.debug.print("{s}\\n", .{h.stringify(${eVar})}),
+    .err => |e| std.debug.print("load failed: {s}\\n", .{e.msg}),
+}
+\`\`\`
+
+`)
+    }
+
+    // Model-driven example fields: derive the create/update body from the op
+    // shape so the docs reference REAL writable fields.
+    const examplePairs = (opname: string): string[] => {
+      const items = opRequestShape(exampleEntity, opname).items
+        .filter((it: any) => (it.name !== idF && it.name !== 'id') ||
+          ('create' === opname && !it.optional))
+      const required = items.filter((it: any) => !it.optional)
+      const optional = items.filter((it: any) => it.optional)
+      const chosen = 'create' === opname
+        ? (required.length ? required : items.slice(0, 2))
+        : required.concat(optional).slice(0, Math.max(2, required.length))
+      return chosen.map((it: any) => `.{ "${it.name}", ${zigLit(it.type, 'example_' + it.name)} }`)
+    }
+
+    const idParamType = (opname: string): any => {
+      const it = opRequestShape(exampleEntity, opname).items.find((x: any) => x.name === idF)
+      return it && it.type
+    }
+    // The id VALUE for an update/remove match: a type-correct literal (zig
+    // ops return an OpResult, so threading the created record's id through a
+    // switch scope would obscure the example).
+    const idValueFor = (opname: string): string => zigLit(idParamType(opname), 'example_id')
+
+    if (opnames.includes('create') || opnames.includes('update') || opnames.includes('remove')) {
+      Content(`### 4. Create, update, and remove
+
+\`\`\`zig
+`)
+      if (opnames.includes('create')) {
+        Content(`// Create — .ok carries the created record
+switch (client.${method}(h.vnull()).create(h.jo(&.{${examplePairs('create').join(', ')}}), h.vnull())) {
+    .ok => |created| std.debug.print("{s}\\n", .{h.stringify(created)}),
+    .err => |e| std.debug.print("create failed: {s}\\n", .{e.msg}),
+}
+
+`)
+      }
+      if (opnames.includes('update')) {
+        const updatePairs = (idF ? [`.{ "${idF}", ${idValueFor('update')} }`] : []).concat(examplePairs('update'))
+        Content(`// Update
+switch (client.${method}(h.vnull()).update(h.jo(&.{${updatePairs.join(', ')}}), h.vnull())) {
+    .ok => |updated| std.debug.print("{s}\\n", .{h.stringify(updated)}),
+    .err => |e| std.debug.print("update failed: {s}\\n", .{e.msg}),
+}
+
+`)
+      }
+      if (opnames.includes('remove')) {
+        const removePairs = opRequestShape(exampleEntity, 'remove').items
+          .filter((it: any) => !it.optional || it.name === idF)
+          .sort((a: any, b: any) =>
+            (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+          .map((it: any) => it.name === idF
+            ? `.{ "${it.name}", ${idValueFor('remove')} }`
+            : `.{ "${it.name}", ${zigLit(it.type, 'example_' + it.name)} }`)
+        Content(`// Remove
+switch (client.${method}(h.vnull()).remove(${removePairs.length ? `h.jo(&.{${removePairs.join(', ')}})` : 'h.vnull()'}, h.vnull())) {
+    .ok => |_| std.debug.print("removed\\n", .{}),
+    .err => |e| std.debug.print("remove failed: {s}\\n", .{e.msg}),
+}
+`)
+      }
+      Content(`\`\`\`
+
+`)
+    }
+  }
+})
+
+
+export {
+  ReadmeQuick
+}