@voxgig/sdkgen 1.3.14 → 1.3.17

package/project/.sdk/src/cmp/clojure/ReadmeInstall_clojure.ts

@@ -0,0 +1,51 @@
+
+import { cmp, Content, isPublished, repoInfo } from '@voxgig/sdkgen'
+
+
+const ReadmeInstall = cmp(function ReadmeInstall(props: any) {
+  const { target, ctx$ } = props
+  const { model } = ctx$
+  const { origin, repo, repoUrl, releasesUrl } = repoInfo(model)
+
+  if (isPublished(model, target.name)) {
+    // Live on Clojars: add the published coordinate to deps.edn.
+    Content(`Add the dependency to your \`deps.edn\`:
+
+\`\`\`clojure
+;; deps.edn
+{:deps {org.clojars.${origin}/${repo} {:mvn/version "X.Y.Z"}}}
+\`\`\`
+
+`)
+    return
+  }
+
+  // Publish pending: not yet on Clojars. Depend on the library directly from
+  // the GitHub release tag, or from a local checkout via :local/root.
+  Content(`This package is not yet published to Clojars. Depend on it directly from the
+GitHub release tag (\`${target.name}/vX.Y.Z\`, see [Releases](${releasesUrl})),
+using a \`tools.deps\` git dependency:
+
+\`\`\`clojure
+;; deps.edn
+{:deps {${model.const.Name.toLowerCase()}/sdk
+        {:git/url "${repoUrl}"
+         :git/tag "${target.name}/vX.Y.Z"
+         :git/sha "..."
+         :deps/root "${target.name}"}}}
+\`\`\`
+
+Or from a local source checkout:
+
+\`\`\`clojure
+;; deps.edn
+{:deps {${model.const.Name.toLowerCase()}/sdk {:local/root "../${target.name}"}}}
+\`\`\`
+
+`)
+})
+
+
+export {
+  ReadmeInstall
+}

package/project/.sdk/src/cmp/clojure/ReadmeIntro_clojure.ts

@@ -0,0 +1,66 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+
+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 Clojure conventions (plain functions, immutable data, and
+the vendored \`voxgig.struct\` value model).
+
+`)
+
+  // 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 \`(api/${exampleEntity.name} client nil)\` — 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/clojure/ReadmeModel_clojure.ts

@@ -0,0 +1,156 @@
+
+import { cmp, each, Content, isAuthActive } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+
+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 — never document an
+  // operation no entity has.
+  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` | `(ent reqmatch ctrl) -> map` | Load a single entity by match criteria. Raises on error. |',
+    list: '| `list` | `(ent reqmatch ctrl) -> vector` | List entities matching the criteria. Raises on error. |',
+    create: '| `create` | `(ent reqdata ctrl) -> map` | Create a new entity. Raises on error. |',
+    update: '| `update` | `(ent reqdata ctrl) -> map` | Update an existing entity. Raises on error. |',
+    remove: '| `remove` | `(ent reqmatch ctrl) -> map` | Remove an entity. Raises on error. |',
+  }
+  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(`### make-sdk
+
+\`\`\`clojure
+(require '[sdk.api :as api]
+         '[voxgig.struct :as vs])
+
+(def client (api/make-sdk options))
+\`\`\`
+
+Creates a new SDK client. \`options\` is a \`voxgig.struct\` map (or \`nil\`).
+
+| Option | 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. |
+| \`extend\` | \`vector\` | Additional feature atoms to load. |
+| \`system\` | \`map\` | System overrides (e.g. custom \`fetch\` fn). |
+
+### test-sdk
+
+\`\`\`clojure
+(def client (api/test-sdk testopts sdkopts))
+\`\`\`
+
+Creates a test-mode client with mock transport. Both arguments may be \`nil\`.
+
+### Client functions
+
+| Function | Signature | Description |
+| --- | --- | --- |
+| \`options-map\` | \`(client) -> map\` | Deep copy of current SDK options. |
+| \`get-utility\` | \`(client) -> utility\` | Copy of the SDK utility object. |
+| \`prepare\` | \`(client fetchargs) -> map\` | Build an HTTP request definition without sending. Raises on error. |
+| \`direct\` | \`(client fetchargs) -> map\` | 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(`| \`${ent.name}\` | \`(client data) -> ${ent.Name} entity\` | Create ${article} ${ent.Name} entity instance. |
+`)
+  })
+
+  Content(`
+### Entity interface
+
+All entities share the same interface. Operations are functions in the
+entity namespace (\`sdk.entity.<name>\`); state accessors are stored on the
+entity map and are called via keyword lookup.
+
+| Member | Signature | Description |
+| --- | --- | --- |
+${opRows}
+| \`:data-get\` | \`() -> map\` | Get entity data. |
+| \`:data-set\` | \`(data)\` | Set entity data. |
+| \`:match-get\` | \`() -> map\` | Get entity match criteria. |
+| \`:match-set\` | \`(match)\` | Set entity match criteria. |
+| \`:make\` | \`() -> entity\` | Create a new instance with the same options. |
+| \`:get-name\` | \`() -> string\` | Return the entity name. |
+
+State accessors are called by looking up the fn and applying it, e.g.
+\`((:data-get ent))\` or \`((:data-set ent) (vs/jm "k" "v"))\`.
+
+### Result shape
+
+Entity operations return the bare result data (a \`map\` for single-entity
+ops, a \`vector\` for \`list\`) and raise (via \`ex-info\`) on error. Wrap
+calls in \`try\`/\`catch\` to handle failures.
+
+The \`direct\` escape hatch never raises — it returns a result \`map\` you
+branch on via \`(vs/getprop result "ok")\`:
+
+| Key | Type | Description |
+| --- | --- | --- |
+| \`ok\` | \`boolean\` | \`true\` if the HTTP status is 2xx. |
+| \`status\` | \`long\` | HTTP status code. |
+| \`headers\` | \`map\` | Response headers. |
+| \`data\` | \`any\` | Parsed JSON response body. |
+
+On error, \`ok\` is \`false\` and \`err\` contains the error value.
+
+`)
+
+  // 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/clojure/ReadmeOptions_clojure.ts

@@ -0,0 +1,61 @@
+
+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 options as a \`voxgig.struct\` map when creating a client:
+
+`)
+
+  Content(`\`\`\`clojure
+(def client
+  (api/make-sdk
+    (vs/jm
+`)
+
+  publishedOptions.map((option: any) => {
+    if ('apikey' === option.name) {
+      Content(`      "${option.name}" (System/getenv "${envName(model)}_APIKEY")
+`)
+    }
+    else {
+      Content(`      ;; "${option.name}" ${option.kind === 'string' ? '"..."' : '...'}
+`)
+    }
+  })
+
+  Content(`      )))
+\`\`\`
+
+`)
+
+  Content(`| Option | Type | Description |
+| --- | --- | --- |
+`)
+
+  publishedOptions.map((option: any) => {
+    Content(`| \`${option.name}\` | \`${option.kind}\` | ${option.short} |
+`)
+  })
+
+  Content(`
+`)
+})
+
+
+export {
+  ReadmeOptions
+}

package/project/.sdk/src/cmp/clojure/ReadmeQuick_clojure.ts

@@ -0,0 +1,210 @@
+
+import { cmp, each, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityDataIdField, entityOps } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+
+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, an active load
+  // op, and a required non-id load param to demonstrate (the parent key).
+  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
+    ? `(api/make-sdk (vs/jm "apikey" (System/getenv "${envName(model)}_APIKEY")))`
+    : `(api/make-sdk nil)`
+
+  // A type-correct Clojure literal for a param.
+  const cljLit = (type: any, placeholder: string = 'example'): string => {
+    const k = canonKey(type)
+    if ('INTEGER' === k || 'NUMBER' === k) return '1'
+    if ('BOOLEAN' === k) return 'true'
+    if ('ARRAY' === k) return '(vs/jt)'
+    if ('OBJECT' === k) return '(vs/jm)'
+    return `"${placeholder}"`
+  }
+
+  // Requires for block 1: the api ns, struct, plus every entity namespace the
+  // quickstart references.
+  const requireLines = ["(require '[sdk.api :as api]"]
+  if (exampleEntity) {
+    requireLines.push(`         '[sdk.entity.${exampleEntity.name} :as e-${exampleEntity.name}]`)
+  }
+  if (nestedEntity && (!exampleEntity || nestedEntity.name !== exampleEntity.name)) {
+    requireLines.push(`         '[sdk.entity.${nestedEntity.name} :as e-${nestedEntity.name}]`)
+  }
+  requireLines.push(`         '[voxgig.struct :as vs])`)
+
+  Content(`### 1. Create a client
+
+\`\`\`clojure
+${requireLines.join('\n')}
+
+(def client ${ctor})
+\`\`\`
+
+`)
+
+  if (exampleEntity) {
+    const eLow = exampleEntity.name
+    const article = /^[aeiou]/i.test(eLow) ? 'an' : 'a'
+    const opnames = entityOps(exampleEntity)
+    // `idF` is the entity's id-like MATCH field; `dataIdF` is the id on the
+    // RETURNED record's data type.
+    const idF = entityIdField(exampleEntity)
+    const dataIdF = entityDataIdField(exampleEntity)
+
+    if (opnames.includes('list')) {
+      Content(`### 2. List ${eLow} records
+
+\`list\` returns a vector of records (each a map) and raises on error —
+iterate it directly.
+
+\`\`\`clojure
+(try
+  (doseq [${eLow} (e-${eLow}/list (api/${eLow} client nil) nil nil)]
+    (println ${eLow}))
+  (catch Exception err
+    (println "list failed:" (.getMessage err))))
+\`\`\`
+
+`)
+    }
+
+    if (nestedEntity) {
+      const neLow = nestedEntity.name
+      const neArticle = /^[aeiou]/i.test(neLow) ? 'an' : 'a'
+
+      // Model-driven match: every REQUIRED load-match key. Parent keys first,
+      // the entity's own id last.
+      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}" ${cljLit(it.type,
+          it.name === neIdF ? 'example_id' : 'example_' + it.name)}`)
+
+      Content(`### 3. Load ${neArticle} ${neLow}
+
+${nestedEntity.Name} is nested under ${parentName}, so provide the
+\`${parentParam}\`. \`load\` returns the bare record (a map) and raises on error.
+
+\`\`\`clojure
+(try
+  (let [${neLow} (e-${neLow}/load (api/${neLow} client nil) (vs/jm ${neMatch.join(' ')}) nil)]
+    (println ${neLow}))
+  (catch Exception err
+    (println "load failed:" (.getMessage err))))
+\`\`\`
+
+`)
+    }
+    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
+        ? `(vs/jm ${loadRequired.map((it: any) =>
+          `"${it.name}" ${cljLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)}`).join(' ')})`
+        : 'nil'
+
+      Content(`### 3. Load ${article} ${eLow}
+
+\`load\` returns the bare record (a map) and raises on error.
+
+\`\`\`clojure
+(try
+  (let [${eLow} (e-${eLow}/load (api/${eLow} client nil) ${loadArg} nil)]
+    (println ${eLow}))
+  (catch Exception err
+    (println "load failed:" (.getMessage err))))
+\`\`\`
+
+`)
+    }
+
+    // Model-driven example fields from the op shape (opRequestShape).
+    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}" ${cljLit(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
+    }
+    const idValueFor = (opname: string): string => (null != dataIdF && opnames.includes('create'))
+      ? `(vs/getprop created "${dataIdF}")`
+      : cljLit(idParamType(opname), 'example_id')
+
+    if (opnames.includes('create') || opnames.includes('update') || opnames.includes('remove')) {
+      Content(`### 4. Create, update, and remove
+
+\`\`\`clojure
+`)
+      if (opnames.includes('create')) {
+        Content(`;; Create — returns the bare created record (a map)
+(def created (e-${eLow}/create (api/${eLow} client nil) (vs/jm ${examplePairs('create').join(' ')}) nil))
+
+`)
+      }
+      if (opnames.includes('update')) {
+        const updatePairs = (idF ? [`"${idF}" ${idValueFor('update')}`] : []).concat(examplePairs('update'))
+        const fromCreated = null != dataIdF && opnames.includes('create')
+        Content(`;; Update${fromCreated ? " — the created record's id is a plain map key" : ''}
+(e-${eLow}/update (api/${eLow} client nil) (vs/jm ${updatePairs.join(' ')}) nil)
+
+`)
+      }
+      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}" ${cljLit(it.type, 'example_' + it.name)}`)
+        Content(`;; Remove
+(e-${eLow}/remove (api/${eLow} client nil) ${removePairs.length ? `(vs/jm ${removePairs.join(' ')})` : 'nil'} nil)
+`)
+      }
+      Content(`\`\`\`
+
+`)
+    }
+  }
+})
+
+
+export {
+  ReadmeQuick
+}