@voxgig/sdkgen 1.3.14 → 1.3.18

package/project/.sdk/src/cmp/rust/ReadmeQuick_rust.ts

@@ -0,0 +1,212 @@
+
+import { cmp, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityDataIdField, entityOps } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+  nom,
+} from '@voxgig/apidef'
+
+import { crateIdent, rustVarName } from './utility_rust'
+
+
+const ReadmeQuick = cmp(function ReadmeQuick(props: any) {
+  const { target, ctx$: { model } } = props
+
+  const rustcrate = crateIdent(model)
+  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
+    ? `${model.const.Name}SDK::new(jo(vec![\n    ("apikey", Value::str(std::env::var("${envName(model)}_APIKEY").unwrap_or_default())),\n]))`
+    : `${model.const.Name}SDK::new(Value::Noval)`
+
+  // A type-correct rust expression constructing a voxgig struct Value.
+  const rustLit = (type: any, placeholder: string = 'example'): string => {
+    const k = canonKey(type)
+    if ('INTEGER' === k || 'NUMBER' === k) return 'Value::Num(1.0)'
+    if ('BOOLEAN' === k) return 'Value::Bool(true)'
+    if ('ARRAY' === k) return 'Value::empty_list()'
+    if ('OBJECT' === k) return 'Value::empty_map()'
+    return `Value::str("${placeholder}")`
+  }
+
+  Content(`### 1. Create a client
+
+\`\`\`rust
+use ${rustcrate}::{getp, jo, ${model.const.Name}SDK, Value};
+
+let client = ${ctor};
+\`\`\`
+
+`)
+
+  if (exampleEntity) {
+    const eName = nom(exampleEntity, 'Name')
+    const article = /^[aeiou]/i.test(eName) ? 'an' : 'a'
+    const eVar = rustVarName(exampleEntity.name)
+    const method = rustVarName(exampleEntity.name)
+    const opnames = entityOps(exampleEntity)
+    // Model-driven id key: `idF` is the entity's id-like MATCH field name, or
+    // null. `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 ${eName.toLowerCase()} records
+
+\`list()\` returns a \`Value::List\` of records and returns \`Err\` on
+failure — match on the \`Result\`.
+
+\`\`\`rust
+match client.${method}(Value::Noval).list(Value::Noval, Value::Noval) {
+    Ok(${eVar}s) => {
+        if let Value::List(items) = &${eVar}s {
+            for ${eVar} in items.borrow().iter() {
+                println!("{:?}", ${eVar});
+            }
+        }
+    }
+    Err(err) => eprintln!("list failed: {}", err),
+}
+\`\`\`
+
+`)
+    }
+
+    if (nestedEntity) {
+      const neName = nom(nestedEntity, 'Name')
+      const neArticle = /^[aeiou]/i.test(neName) ? 'an' : 'a'
+      const neVar = rustVarName(nestedEntity.name)
+      const neMethod = rustVarName(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}", ${rustLit(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()\` returns the bare record and returns \`Err\` on failure.
+
+\`\`\`rust
+match client.${neMethod}(Value::Noval).load(jo(vec![${neMatch.join(', ')}]), Value::Noval) {
+    Ok(${neVar}) => println!("{:?}", ${neVar}),
+    Err(err) => eprintln!("load failed: {}", 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(vec![${loadRequired.map((it: any) =>
+          `("${it.name}", ${rustLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)})`).join(', ')}])`
+        : 'Value::Noval'
+
+      Content(`### 3. Load ${article} ${eName.toLowerCase()}
+
+\`load()\` returns the bare record and returns \`Err\` on failure.
+
+\`\`\`rust
+match client.${method}(Value::Noval).load(${loadArg}, Value::Noval) {
+    Ok(${eVar}) => println!("{:?}", ${eVar}),
+    Err(err) => eprintln!("load failed: {}", 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}", ${rustLit(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: read it off the returned
+    // `created` record with getp when its data type carries the id AND a
+    // create ran; otherwise a type-correct literal.
+    const idValueFor = (opname: string): string => (null != dataIdF && opnames.includes('create'))
+      ? `getp(&created, "${dataIdF}")`
+      : rustLit(idParamType(opname), 'example_id')
+
+    if (opnames.includes('create') || opnames.includes('update') || opnames.includes('remove')) {
+      Content(`### 4. Create, update, and remove
+
+\`\`\`rust
+`)
+      if (opnames.includes('create')) {
+        Content(`// Create — returns the bare created record
+let created = client.${method}(Value::Noval).create(jo(vec![${examplePairs('create').join(', ')}]), Value::Noval).unwrap();
+
+`)
+      }
+      if (opnames.includes('update')) {
+        const updatePairs = (idF ? [`("${idF}", ${idValueFor('update')})`] : []).concat(examplePairs('update'))
+        Content(`// Update
+client.${method}(Value::Noval).update(jo(vec![${updatePairs.join(', ')}]), Value::Noval).unwrap();
+
+`)
+      }
+      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}", ${rustLit(it.type, 'example_' + it.name)})`)
+        Content(`// Remove
+client.${method}(Value::Noval).remove(${removePairs.length ? `jo(vec![${removePairs.join(', ')}])` : 'Value::Noval'}, Value::Noval).unwrap();
+`)
+      }
+      Content(`\`\`\`
+
+`)
+    }
+  }
+})
+
+
+export {
+  ReadmeQuick
+}

package/project/.sdk/src/cmp/rust/ReadmeRef_rust.ts

@@ -0,0 +1,384 @@
+
+import { cmp, each, Content, canonToType, canonKey, File, isAuthActive, entityIdField, opRequestShape } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+import { crateIdent, rustVarName } from './utility_rust'
+
+
+// Type names come from the shared canonToType 'rust' column (single source of truth).
+
+// A type-correct rust expression constructing a voxgig struct Value.
+function rustLit(type: any, placeholder: string = 'example'): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k || 'NUMBER' === k) return 'Value::Num(1.0)'
+  if ('BOOLEAN' === k) return 'Value::Bool(true)'
+  if ('ARRAY' === k) return 'Value::empty_list()'
+  if ('OBJECT' === k) return 'Value::empty_map()'
+  return `Value::str("${placeholder}")`
+}
+
+
+const ReadmeRef = cmp(function ReadmeRef(props: any) {
+  const { target } = props
+  const { model } = props.ctx$
+
+  const rustcrate = crateIdent(model)
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+  const feature = getModelPath(model, `main.${KIT}.feature`)
+
+  const publishedEntities = each(entity).filter((e: any) => e.active !== false)
+
+  const errType = `${model.const.Name}Error`
+  const OP_SIGNATURES: Record<string, { sig: string, desc: string }> = {
+    load: {
+      sig: `load(reqmatch: Value, ctrl: Value) -> Result<Value, ${errType}>`,
+      desc: 'Load a single entity matching the given criteria. Returns the entity data on `Ok` and `Err` on failure.',
+    },
+    list: {
+      sig: `list(reqmatch: Value, ctrl: Value) -> Result<Value, ${errType}>`,
+      desc: 'List entities matching the given criteria. The match is optional — pass `Value::Noval` to list all records. `Ok` is a `Value::List`.',
+    },
+    create: {
+      sig: `create(reqdata: Value, ctrl: Value) -> Result<Value, ${errType}>`,
+      desc: 'Create a new entity with the given data. Returns the created entity data on `Ok` and `Err` on failure.',
+    },
+    update: {
+      sig: `update(reqdata: Value, ctrl: Value) -> Result<Value, ${errType}>`,
+      desc: 'Update an existing entity. The data must include the entity id. Returns the updated entity data on `Ok`.',
+    },
+    remove: {
+      sig: `remove(reqmatch: Value, ctrl: Value) -> Result<Value, ${errType}>`,
+      desc: 'Remove the entity matching the given criteria. `Err` on failure.',
+    },
+  }
+
+
+  File({ name: 'REFERENCE.md' }, () => {
+
+    Content(`# ${model.Name} ${target.title} SDK Reference
+
+Complete API reference for the ${model.Name} ${target.title} SDK.
+
+
+## ${model.Name}SDK
+
+### Constructor
+
+`)
+
+    Content(`\`\`\`rust
+use ${rustcrate}::{${model.const.Name}SDK, Value};
+
+let client = ${model.const.Name}SDK::new(options);
+\`\`\`
+
+Create a new SDK client instance. \`options\` is a \`Value\` map
+(\`Value::Noval\` for none).
+
+**Parameters:**
+
+| Key | Value type | Description |
+| --- | --- | --- |
+${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. |
+
+`)
+
+
+    Content(`
+### Static Functions
+
+`)
+
+    Content(`#### \`test_sdk(testopts: Value, sdkopts: Value) -> Rc<${model.const.Name}SDK>\`
+
+Create a test client with mock features active. Both arguments may be
+\`Value::Noval\`.
+
+\`\`\`rust
+use ${rustcrate}::{test_sdk, Value};
+
+let client = test_sdk(Value::Noval, Value::Noval);
+\`\`\`
+
+`)
+
+
+    Content(`
+### Instance Methods
+
+`)
+
+
+    // Entity factory methods
+    publishedEntities.map((ent: any) => {
+      Content(`#### \`${rustVarName(ent.name)}(entopts: Value) -> Rc<${ent.Name}Entity>\`
+
+Create a new \`${ent.Name}Entity\` instance. Pass \`Value::Noval\` for no
+initial options.
+
+`)
+    })
+
+
+    Content(`#### \`options_map() -> Value\`
+
+Return a deep copy of the current SDK options.
+
+#### \`get_utility() -> Rc<Utility>\`
+
+Return a copy of the SDK utility object.
+
+#### \`direct(fetchargs: Value) -> Result<Value, ${errType}>\`
+
+Make a direct HTTP request to any API endpoint. \`Ok\` is a result \`Value::Map\`
+with \`ok\`, \`status\`, \`headers\`, and \`data\` (or \`err\` on failure). This
+escape hatch resolves to \`Ok\` even on a non-2xx response — branch on
+\`getp(&result, "ok")\`.
+
+**Parameters (\`fetchargs\` map keys):**
+
+| Key | Value 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\` | \`any\` | Request body (maps are JSON-serialized). |
+
+#### \`prepare(fetchargs: Value) -> Result<Value, ${errType}>\`
+
+Prepare a fetch definition without sending. Returns the fetchdef on \`Ok\`.
+
+`)
+
+
+    // Entity reference sections
+    publishedEntities.map((ent: any) => {
+      const opnames = Object.keys(ent.op || {})
+      const fields = ent.fields || []
+      const idF = entityIdField(ent)
+      const eVar = rustVarName(ent.name)
+      const method = rustVarName(ent.name)
+
+      Content(`
+---
+
+## ${ent.Name}Entity
+
+`)
+
+      if (ent.short) {
+        Content(`${ent.short}
+
+`)
+      }
+
+      Content(`\`\`\`rust
+let ${eVar} = client.${method}(Value::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}\` | \`${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
+              ? `jo(vec![${matchItems.map((it: any) =>
+                `("${it.name}", ${rustLit(it.type,
+                  it.name === idF ? ent.name + '_id' : it.name)})`).join(', ')}])`
+              : 'Value::Noval'
+            Content(`\`\`\`rust
+let result = client.${method}(Value::Noval).${opname}(${arg}, Value::Noval).unwrap();
+\`\`\`
+
+`)
+          }
+          else if ('list' === opname) {
+            Content(`\`\`\`rust
+let results = client.${method}(Value::Noval).list(Value::Noval, Value::Noval).unwrap();
+if let Value::List(items) = &results {
+    for ${eVar} in items.borrow().iter() {
+        println!("{:?}", ${eVar});
+    }
+}
+\`\`\`
+
+`)
+          }
+          else if ('create' === opname) {
+            const createItems = opRequestShape(ent, 'create').items
+              .filter((it: any) => !it.optional)
+            Content(`\`\`\`rust
+let result = client.${method}(Value::Noval).create(jo(vec![
+`)
+            createItems.map((it: any) => {
+              Content(`    ("${it.name}", ${rustLit(it.type, 'example_' + it.name)}),  // ${canonToType(it.type, target.name)}
+`)
+            })
+            Content(`]), Value::Noval).unwrap();
+\`\`\`
+
+`)
+          }
+          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}", ${rustLit(it.type,
+                it.name === idF ? ent.name + '_id' : it.name)}),\n`).join('')
+            Content(`\`\`\`rust
+let result = client.${method}(Value::Noval).update(jo(vec![
+${updateLines}    // Fields to update
+]), Value::Noval).unwrap();
+\`\`\`
+
+`)
+          }
+        })
+      }
+
+
+      // Common methods
+      Content(`### Common Methods
+
+#### \`data(args: Option<&Value>) -> Value\`
+
+Get the entity data. Pass \`Some(&map)\` to set it.
+
+#### \`matchv(args: Option<&Value>) -> Value\`
+
+Get the entity match criteria. Pass \`Some(&map)\` to set it.
+
+#### \`make() -> Rc<dyn Entity>\`
+
+Create a new \`${ent.Name}Entity\` instance with the same options.
+
+#### \`get_name() -> 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(`\`\`\`rust
+let client = ${model.const.Name}SDK::new(jo(vec![
+    ("feature", jo(vec![
+`)
+      activeFeatures.map((f: any) => {
+        Content(`        ("${f.name}", jo(vec![("active", Value::Bool(true))])),
+`)
+      })
+      Content(`    ])),
+]));
+\`\`\`
+
+`)
+    }
+
+  })
+})
+
+
+export {
+  ReadmeRef
+}

package/project/.sdk/src/cmp/rust/ReadmeTopHowto_rust.ts

@@ -0,0 +1,24 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+
+const ReadmeTopHowto = cmp(function ReadmeTopHowto(props: any) {
+  const { target } = props
+
+  Content(`**Rust:**
+\`\`\`rust
+let result = client.direct(jo(vec![
+    ("path", Value::str("/api/resource/{id}")),
+    ("method", Value::str("GET")),
+    ("params", jo(vec![("id", Value::str("example"))])),
+]));
+\`\`\`
+
+`)
+
+})
+
+
+export {
+  ReadmeTopHowto
+}