@voxgig/sdkgen 1.3.14 → 1.3.17

package/project/.sdk/src/cmp/ocaml/ReadmeQuick_ocaml.ts

@@ -0,0 +1,205 @@
+
+import { cmp, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityDataIdField, entityOps } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+  nom,
+} from '@voxgig/apidef'
+
+import { ocamlVarName } from './utility_ocaml'
+
+
+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
+    ? `Sdk_client.make (jo [("apikey", Str (Sys.getenv "${envName(model)}_APIKEY"))])`
+    : `Sdk_client.make0 ()`
+
+  Content(`### 1. Create a client
+
+\`\`\`ocaml
+open Voxgig_struct
+open Sdk_helpers
+
+let client = ${ctor}
+\`\`\`
+
+`)
+
+  if (exampleEntity) {
+    const eName = nom(exampleEntity, 'Name')
+    const article = /^[aeiou]/i.test(eName) ? 'an' : 'a'
+    const fn = ocamlVarName(exampleEntity.name)
+    const opnames = entityOps(exampleEntity)
+    // Model-driven id key: `idF` is the entity's id-like MATCH field, or null.
+    // `dataIdF` is the id on the RETURNED record's data type.
+    const idF = entityIdField(exampleEntity)
+    const dataIdF = entityDataIdField(exampleEntity)
+
+    // A type-correct OCaml `value` literal for a param.
+    const ocamlLit = (type: any, placeholder: string = 'example'): string => {
+      const k = canonKey(type)
+      if ('INTEGER' === k || 'NUMBER' === k) return '(Num 1.)'
+      if ('BOOLEAN' === k) return '(Bool true)'
+      if ('ARRAY' === k) return '(empty_list ())'
+      if ('OBJECT' === k) return '(empty_map ())'
+      return `(Str "${placeholder}")`
+    }
+
+    if (opnames.includes('list')) {
+      Content(`### 2. List ${fn} records
+
+\`e_list\` returns a \`List\` value of records (each a \`Map\`) and raises on
+error — iterate it directly.
+
+\`\`\`ocaml
+(try
+   let ${fn}s = (Sdk_client.${fn} client Noval).e_list (empty_map ()) Noval in
+   (match ${fn}s with
+    | List items -> List.iter (fun r -> print_endline (stringify r)) !items
+    | _ -> ())
+ with Sdk_error.E err -> Printf.eprintf "list failed: %s\\n" (Sdk_error.message err))
+\`\`\`
+
+`)
+    }
+
+    if (nestedEntity) {
+      const neName = nom(nestedEntity, 'Name')
+      const neArticle = /^[aeiou]/i.test(neName) ? 'an' : 'a'
+      const neFn = ocamlVarName(nestedEntity.name)
+
+      // 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}", ${ocamlLit(it.type,
+          it.name === neIdF ? 'example_id' : 'example_' + it.name)})`)
+
+      Content(`### 3. Load ${neArticle} ${neFn}
+
+${neName} is nested under ${parentName}, so provide the \`${parentParam}\`.
+\`e_load\` returns the bare record (a \`Map\`) and raises on error.
+
+\`\`\`ocaml
+(try
+   let ${neFn} = (Sdk_client.${neFn} client Noval).e_load (jo [${neMatch.join('; ')}]) Noval in
+   print_endline (stringify ${neFn})
+ with Sdk_error.E err -> Printf.eprintf "load failed: %s\\n" (Sdk_error.message 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
+        ? `jo [${loadRequired.map((it: any) =>
+          `("${it.name}", ${ocamlLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)})`).join('; ')}]`
+        : 'Noval'
+
+      Content(`### 3. Load ${article} ${fn}
+
+\`e_load\` returns the bare record (a \`Map\`) and raises on error.
+
+\`\`\`ocaml
+(try
+   let ${fn} = (Sdk_client.${fn} client Noval).e_load (${loadArg}) Noval in
+   print_endline (stringify ${fn})
+ with Sdk_error.E err -> Printf.eprintf "load failed: %s\\n" (Sdk_error.message err))
+\`\`\`
+
+`)
+    }
+
+    // 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}", ${ocamlLit(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'))
+      ? `(getp created "${dataIdF}")`
+      : ocamlLit(idParamType(opname), 'example_id')
+
+    if (opnames.includes('create') || opnames.includes('update') || opnames.includes('remove')) {
+      Content(`### 4. Create, update, and remove
+
+\`\`\`ocaml
+`)
+      if (opnames.includes('create')) {
+        Content(`(* Create — returns the bare created record (a Map) *)
+let created = (Sdk_client.${fn} client Noval).e_create (jo [${examplePairs('create').join('; ')}]) Noval in
+ignore created;
+
+`)
+      }
+      if (opnames.includes('update')) {
+        const updatePairs = (idF ? [`("${idF}", ${idValueFor('update')})`] : []).concat(examplePairs('update'))
+        Content(`(* Update *)
+ignore ((Sdk_client.${fn} client Noval).e_update (jo [${updatePairs.join('; ')}]) Noval);
+
+`)
+      }
+      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}", ${ocamlLit(it.type, 'example_' + it.name)})`)
+        Content(`(* Remove *)
+ignore ((Sdk_client.${fn} client Noval).e_remove (${removePairs.length ? `jo [${removePairs.join('; ')}]` : 'Noval'}) Noval)
+`)
+      }
+      Content(`\`\`\`
+
+`)
+    }
+  }
+})
+
+
+export {
+  ReadmeQuick
+}

package/project/.sdk/src/cmp/ocaml/ReadmeRef_ocaml.ts

@@ -0,0 +1,402 @@
+
+import { cmp, each, Content, canonKey, File, isAuthActive, entityIdField, opRequestShape } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+import { ocamlVarName } from './utility_ocaml'
+
+
+// A type-correct OCaml `value` literal. Strings render the quoted placeholder.
+function ocamlLit(type: any, placeholder: string = 'example'): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k || 'NUMBER' === k) return '(Num 1.)'
+  if ('BOOLEAN' === k) return '(Bool true)'
+  if ('ARRAY' === k) return '(empty_list ())'
+  if ('OBJECT' === k) return '(empty_map ())'
+  return `(Str "${placeholder}")`
+}
+
+
+// The logical OCaml type of a field's canonical type (every field is carried
+// inside the dynamic `value` variant).
+function ocamlType(type: any): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k) return 'int'
+  if ('NUMBER' === k) return 'float'
+  if ('BOOLEAN' === k) return 'bool'
+  if ('STRING' === k) return 'string'
+  if ('ARRAY' === k) return 'value list'
+  if ('OBJECT' === k) return 'value map'
+  return 'value'
+}
+
+
+const OP_SIGNATURES: Record<string, { sig: string, returns: string, desc: string }> = {
+  load: {
+    sig: 'e_load reqmatch ctrl : value',
+    returns: 'the entity data',
+    desc: 'Load a single entity matching the given criteria. Returns the entity data and raises on error.',
+  },
+  list: {
+    sig: 'e_list reqmatch ctrl : value',
+    returns: 'a List of entities',
+    desc: 'List entities matching the given criteria. The match is optional — pass `(empty_map ())` to list all records. Returns a List and raises on error.',
+  },
+  create: {
+    sig: 'e_create reqdata ctrl : value',
+    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: 'e_update reqdata ctrl : value',
+    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: 'e_remove reqmatch ctrl : value',
+    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 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_client
+
+### Constructor
+
+`)
+
+    Content(`\`\`\`ocaml
+open Voxgig_struct
+open Sdk_helpers
+
+let client = Sdk_client.make options
+\`\`\`
+
+Create a new SDK client instance from a \`value\` options map. Use
+\`Sdk_client.make0 ()\` for defaults.
+
+**Parameters:**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| \`options\` | \`value\` | SDK configuration options (a Map). |
+${isAuthActive(model) ? '| `apikey` | `string` | API key for authentication. |\n' : ''}| \`base\` | \`string\` | Base URL for API requests. |
+| \`prefix\` | \`string\` | URL prefix appended after base. |
+| \`suffix\` | \`string\` | URL suffix appended after path. |
+| \`headers\` | \`map\` | Custom headers for all requests. |
+| \`feature\` | \`map\` | Feature configuration. |
+| \`system\` | \`map\` | System overrides (e.g. custom fetch). |
+
+`)
+
+
+    Content(`
+### Static constructors
+
+`)
+
+    Content(`#### \`Sdk_client.test testopts sdkopts\`
+
+Create a test client with mock features active. Both arguments may be \`Noval\`
+(\`Sdk_client.test ()\` uses defaults, \`Sdk_client.test_with\` takes explicit
+options).
+
+\`\`\`ocaml
+let client = Sdk_client.test ()
+\`\`\`
+
+`)
+
+
+    Content(`
+### Instance functions
+
+`)
+
+
+    // Entity accessor functions
+    publishedEntities.map((ent: any) => {
+      const fn = ocamlVarName(ent.name)
+      Content(`#### \`Sdk_client.${fn} client entopts : entity_obj\`
+
+Create a \`${ent.Name}\` entity accessor. Pass \`Noval\` for no initial options.
+
+`)
+    })
+
+
+    Content(`#### \`Sdk_client.direct client fetchargs : value\`
+
+Make a direct HTTP request to any API endpoint. Returns a result \`value\` map
+with \`ok\`, \`status\`, \`headers\`, and \`data\` (or \`err\` on failure). This
+escape hatch never raises — branch on \`getp result "ok"\`.
+
+**Parameters:**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| \`path\` | \`string\` | URL path with optional \`{param}\` placeholders. |
+| \`method\` | \`string\` | HTTP method (default: \`"GET"\`). |
+| \`params\` | \`map\` | Path parameter values. |
+| \`query\` | \`map\` | Query string parameters. |
+| \`headers\` | \`map\` | Request headers (merged with defaults). |
+| \`body\` | \`value\` | Request body (Maps are JSON-serialized). |
+
+**Returns:** a result \`value\` map.
+
+#### \`Sdk_client.prepare client fetchargs : value\`
+
+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 || []
+      const idF = entityIdField(ent)
+      const fn = ocamlVarName(ent.name)
+
+      Content(`
+---
+
+## ${ent.Name}
+
+`)
+
+      if (ent.short) {
+        Content(`${ent.short}
+
+`)
+      }
+
+      Content(`\`\`\`ocaml
+let ${fn} = Sdk_client.${fn} client Noval
+\`\`\`
+
+`)
+
+
+      // 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}\` | \`${ocamlType(field.type)}\` | ${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
+              ? `jo [${matchItems.map((it: any) =>
+                `("${it.name}", ${ocamlLit(it.type,
+                  it.name === idF ? ent.name + '_id' : it.name)})`).join('; ')}]`
+              : 'Noval'
+            Content(`\`\`\`ocaml
+let result = (Sdk_client.${fn} client Noval).${'load' === opname ? 'e_load' : 'e_remove'} (${arg}) Noval
+\`\`\`
+
+`)
+          }
+          else if ('list' === opname) {
+            Content(`\`\`\`ocaml
+let results = (Sdk_client.${fn} client Noval).e_list (empty_map ()) Noval in
+(match results with
+ | List items -> List.iter (fun r -> print_endline (stringify r)) !items
+ | _ -> ())
+\`\`\`
+
+`)
+          }
+          else if ('create' === opname) {
+            const createItems = opRequestShape(ent, 'create').items
+              .filter((it: any) => !it.optional)
+            Content(`\`\`\`ocaml
+let result = (Sdk_client.${fn} client Noval).e_create (jo [
+`)
+            createItems.map((it: any) => {
+              Content(`    ("${it.name}", ${ocamlLit(it.type, 'example_' + it.name)});  (* ${ocamlType(it.type)} *)
+`)
+            })
+            Content(`]) Noval
+\`\`\`
+
+`)
+          }
+          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) =>
+              `    ("${it.name}", ${ocamlLit(it.type,
+                it.name === idF ? ent.name + '_id' : it.name)});\n`).join('')
+            Content(`\`\`\`ocaml
+let result = (Sdk_client.${fn} client Noval).e_update (jo [
+${updateLines}    (* Fields to update *)
+]) Noval
+\`\`\`
+
+`)
+          }
+        })
+      }
+
+
+      // Common fields
+      Content(`### Common Fields
+
+#### \`e_data_get : unit -> value\`
+
+Get the entity data.
+
+#### \`e_data_set : value -> unit\`
+
+Set the entity data.
+
+#### \`e_match_get : unit -> value\`
+
+Get the entity match criteria.
+
+#### \`e_match_set : value -> unit\`
+
+Set the entity match criteria.
+
+#### \`e_make : unit -> entity_obj\`
+
+Create a new \`${ent.Name}\` entity accessor with the same options.
+
+#### \`e_name : string\`
+
+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(`\`\`\`ocaml
+let client = Sdk_client.make (jo [
+    ("feature", jo [
+`)
+      activeFeatures.map((f: any) => {
+        Content(`        ("${f.name}", jo [("active", Bool true)]);
+`)
+      })
+      Content(`    ]);
+])
+\`\`\`
+
+`)
+    }
+
+  })
+})
+
+
+
+
+export {
+  ReadmeRef
+}

package/project/.sdk/src/cmp/ocaml/ReadmeTopHowto_ocaml.ts

@@ -0,0 +1,25 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+
+const ReadmeTopHowto = cmp(function ReadmeTopHowto(props: any) {
+  const { target } = props
+
+  Content(`**OCaml:**
+\`\`\`ocaml
+let result = Sdk_client.direct client (jo [
+    ("path", Str "/api/resource/{id}");
+    ("method", Str "GET");
+    ("params", jo [("id", Str "example")]);
+]) in
+ignore result
+\`\`\`
+
+`)
+
+})
+
+
+export {
+  ReadmeTopHowto
+}