@voxgig/sdkgen 1.3.13 → 1.3.17

package/project/.sdk/src/cmp/perl/ReadmeModel_perl.ts

@@ -0,0 +1,150 @@
+
+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: 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` | `($reqmatch, $ctrl) -> hashref` | Load a single entity by match criteria. Dies on error. |',
+    list: '| `list` | `($reqmatch, $ctrl) -> arrayref` | List entities matching the criteria. Dies on error. |',
+    create: '| `create` | `($reqdata, $ctrl) -> hashref` | Create a new entity. Dies on error. |',
+    update: '| `update` | `($reqdata, $ctrl) -> hashref` | Update an existing entity. Dies on error. |',
+    remove: '| `remove` | `($reqmatch, $ctrl) -> hashref` | Remove an entity. Dies 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(`### ${model.const.Name}SDK
+
+\`\`\`perl
+use lib 'lib';
+use ${model.const.Name}SDK;
+
+my $client = ${model.const.Name}SDK->new($options);
+\`\`\`
+
+Creates a new SDK client.
+
+| 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\` | \`hashref\` | Feature activation flags. |
+| \`extend\` | \`arrayref\` | Additional feature instances to load. |
+| \`system\` | \`hashref\` | System overrides (e.g. custom \`fetch\` coderef). |
+
+### test
+
+\`\`\`perl
+my $client = ${model.const.Name}SDK->test($testopts, $sdkopts);
+\`\`\`
+
+Creates a test-mode client with mock transport. Both arguments may be \`undef\`.
+
+### ${model.const.Name}SDK methods
+
+| Method | Signature | Description |
+| --- | --- | --- |
+| \`options_map\` | \`() -> hashref\` | Deep copy of current SDK options. |
+| \`get_utility\` | \`() -> utility\` | Copy of the SDK utility object. |
+| \`prepare\` | \`($fetchargs) -> hashref\` | Build an HTTP request definition without sending. Dies on error. |
+| \`direct\` | \`($fetchargs) -> hashref\` | Build and send an HTTP request. Returns a result hashref (branch on \`ok\`). |
+`)
+
+  each(entityList, (ent: any) => {
+    const article = /^[aeiou]/i.test(ent.Name) ? 'an' : 'a'
+    Content(`| \`${ent.Name}\` | \`($data) -> ${ent.Name} entity\` | Create ${article} ${ent.Name} entity instance. |
+`)
+  })
+
+  Content(`
+### Entity interface
+
+All entities share the same interface.
+
+| Method | Signature | Description |
+| --- | --- | --- |
+${opRows}
+| \`data_get\` | \`() -> hashref\` | Get entity data. |
+| \`data_set\` | \`($data)\` | Set entity data. |
+| \`match_get\` | \`() -> hashref\` | 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. |
+
+### Result shape
+
+Entity operations return the bare result data (a \`hashref\` for single-entity
+ops, an \`arrayref\` for \`list\`) and die on error. Wrap calls in
+\`eval { ... }\` and inspect \`$@\` to handle failures.
+
+The \`direct()\` escape hatch never dies — it returns a result \`hashref\`
+you branch on via \`$result->{ok}\`:
+
+| Key | Type | Description |
+| --- | --- | --- |
+| \`ok\` | \`boolean\` | True if the HTTP status is 2xx. |
+| \`status\` | \`integer\` | HTTP status code. |
+| \`headers\` | \`hashref\` | 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/perl/ReadmeOptions_perl.ts

@@ -0,0 +1,59 @@
+
+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 when creating a client instance:
+
+`)
+
+  Content(`\`\`\`perl
+my $client = ${model.const.Name}SDK->new({
+`)
+
+  publishedOptions.map((option: any) => {
+    if ('apikey' === option.name) {
+      Content(`    '${option.name}' => $ENV{'${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/perl/ReadmeQuick_perl.ts

@@ -0,0 +1,216 @@
+
+import { cmp, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityDataIdField, entityOps } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+  nom,
+} 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
+  // (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({\n    'apikey' => $ENV{'${envName(model)}_APIKEY'},\n})`
+    : `${model.const.Name}SDK->new`
+
+  Content(`### 1. Create a client
+
+\`\`\`perl
+use lib 'lib';
+use ${model.const.Name}SDK;
+
+my $client = ${ctor};
+\`\`\`
+
+`)
+
+  if (exampleEntity) {
+    const eName = nom(exampleEntity, 'Name')
+    const article = /^[aeiou]/i.test(eName) ? 'an' : 'a'
+    const eVar = eName.toLowerCase()
+    const opnames = entityOps(exampleEntity)
+    // `idF` is the id-like MATCH field name (or null). `dataIdF` is the id on
+    // the RETURNED record's data type — an entity can key its match on an id it
+    // does not carry as data.
+    const idF = entityIdField(exampleEntity)
+    const dataIdF = entityDataIdField(exampleEntity)
+
+    // A type-correct, executable Perl literal for a param.
+    const perlLit = (type: any, placeholder: string = 'example'): string => {
+      const k = canonKey(type)
+      if ('INTEGER' === k || 'NUMBER' === k) return '1'
+      if ('BOOLEAN' === k) return '1'
+      if ('ARRAY' === k) return '[]'
+      if ('OBJECT' === k) return '{}'
+      return `'${placeholder}'`
+    }
+
+    if (opnames.includes('list')) {
+      Content(`### 2. List ${eName.toLowerCase()} records
+
+\`list()\` returns an \`arrayref\` of records (each a \`hashref\`) and dies on
+error — iterate it directly.
+
+\`\`\`perl
+my $${eVar}s = eval { $client->${eName}->list };
+if (my $err = $@) {
+    print "list failed: $err\\n";
+}
+else {
+    for my $${eVar} (@$${eVar}s) {
+        print "$${eVar}->{id}\\n";
+    }
+}
+\`\`\`
+
+`)
+    }
+
+    if (nestedEntity) {
+      const neName = nom(nestedEntity, 'Name')
+      const neArticle = /^[aeiou]/i.test(neName) ? 'an' : 'a'
+      const neVar = neName.toLowerCase()
+
+      // Model-driven match: every REQUIRED load-match key. Parent keys (e.g.
+      // page_id) 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}' => ${perlLit(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 (a \`hashref\`) and dies on error.
+
+\`\`\`perl
+my $${neVar} = eval { $client->${neName}->load({ ${neMatch.join(', ')} }) };
+if (my $err = $@) {
+    print "load failed: $err\\n";
+}
+else {
+    print "$${neVar}->{id}\\n";
+}
+\`\`\`
+
+`)
+    }
+    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
+        ? `{ ${loadRequired.map((it: any) =>
+          `'${it.name}' => ${perlLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)}`).join(', ')} }`
+        : ''
+
+      Content(`### 3. Load ${article} ${eName.toLowerCase()}
+
+\`load()\` returns the bare record (a \`hashref\`) and dies on error.
+
+\`\`\`perl
+my $${eVar} = eval { $client->${eName}->load(${loadArg}) };
+if (my $err = $@) {
+    print "load failed: $err\\n";
+}
+else {
+    print "$${eVar}->{id}\\n";
+}
+\`\`\`
+
+`)
+    }
+
+    // Model-driven example fields: derive the create/update body from the op
+    // shape so the docs reference REAL writable fields. ids are rendered
+    // separately as the match key for update/remove; a REQUIRED create id
+    // stays (the call is invalid without it).
+    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}' => ${perlLit(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'))
+      ? `$created->{${dataIdF}}`
+      : perlLit(idParamType(opname), 'example_id')
+
+    if (opnames.includes('create') || opnames.includes('update') || opnames.includes('remove')) {
+      Content(`### 4. Create, update, and remove
+
+\`\`\`perl
+`)
+      if (opnames.includes('create')) {
+        Content(`# Create — returns the bare created record (a hashref)
+my $created = $client->${eName}->create({ ${examplePairs('create').join(', ')} });
+
+`)
+      }
+      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 hash key" : ''}
+$client->${eName}->update({ ${updatePairs.join(', ')} });
+
+`)
+      }
+      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}' => ${perlLit(it.type, 'example_' + it.name)}`)
+        Content(`# Remove
+$client->${eName}->remove(${removePairs.length ? `{ ${removePairs.join(', ')} }` : ''});
+`)
+      }
+      Content(`\`\`\`
+
+`)
+    }
+  }
+})
+
+
+export {
+  ReadmeQuick
+}