@voxgig/sdkgen 0.32.2 → 0.33.0

package/src/cmp/ReadmeRef.ts

@@ -0,0 +1,369 @@
+
+import { cmp, each, Content, File } from 'jostraca'
+
+import {
+  KIT,
+  getModelPath
+} from '../types'
+
+
+const OP_SIGNATURES: Record<string, { sig: string, returns: string, desc: string }> = {
+  load: {
+    sig: 'load(match: object, ctrl?: object)',
+    returns: 'Promise<object>',
+    desc: 'Load a single entity matching the given criteria.',
+  },
+  list: {
+    sig: 'list(match: object, ctrl?: object)',
+    returns: 'Promise<object[]>',
+    desc: 'List entities matching the given criteria. Returns an array.',
+  },
+  create: {
+    sig: 'create(data: object, ctrl?: object)',
+    returns: 'Promise<object>',
+    desc: 'Create a new entity with the given data.',
+  },
+  update: {
+    sig: 'update(data: object, ctrl?: object)',
+    returns: 'Promise<object>',
+    desc: 'Update an existing entity. The data must include the entity `id`.',
+  },
+  remove: {
+    sig: 'remove(match: object, ctrl?: object)',
+    returns: 'Promise<void>',
+    desc: 'Remove the entity matching the given criteria.',
+  },
+}
+
+
+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.publish)
+
+  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
+
+\`\`\`ts
+new ${model.Name}SDK(options?: object)
+\`\`\`
+
+Create a new SDK client instance.
+
+**Parameters:**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| \`options\` | \`object\` | SDK configuration options. |
+| \`options.apikey\` | \`string\` | API key for authentication. |
+| \`options.base\` | \`string\` | Base URL for API requests. |
+| \`options.prefix\` | \`string\` | URL prefix appended after base. |
+| \`options.suffix\` | \`string\` | URL suffix appended after path. |
+| \`options.headers\` | \`object\` | Custom headers for all requests. |
+| \`options.feature\` | \`object\` | Feature configuration. |
+| \`options.system\` | \`object\` | System overrides (e.g. custom fetch). |
+
+
+### Static Methods
+
+#### \`${model.Name}SDK.test(testopts?, sdkopts?)\`
+
+Create a test client with mock features active.
+
+\`\`\`ts
+const client = ${model.Name}SDK.test()
+\`\`\`
+
+**Parameters:**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| \`testopts\` | \`object\` | Test feature options. |
+| \`sdkopts\` | \`object\` | Additional SDK options merged with test defaults. |
+
+**Returns:** \`${model.Name}SDK\` instance in test mode.
+
+
+### Instance Methods
+
+`)
+
+
+    // Entity factory methods
+    publishedEntities.map((ent: any) => {
+      Content(`#### \`${ent.Name}(data?: object)\`
+
+Create a new \`${ent.Name}\` entity instance.
+
+**Parameters:**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| \`data\` | \`object\` | Initial entity data. |
+
+**Returns:** \`${ent.Name}Entity\` instance.
+
+`)
+    })
+
+
+    Content(`#### \`options()\`
+
+Return a deep copy of the current SDK options.
+
+**Returns:** \`object\`
+
+#### \`utility()\`
+
+Return a copy of the SDK utility object.
+
+**Returns:** \`object\`
+
+#### \`direct(fetchargs?: object)\`
+
+Make a direct HTTP request to any API endpoint.
+
+**Parameters:**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| \`fetchargs.path\` | \`string\` | URL path with optional \`{param}\` placeholders. |
+| \`fetchargs.method\` | \`string\` | HTTP method (default: \`GET\`). |
+| \`fetchargs.params\` | \`object\` | Path parameter values for \`{param}\` substitution. |
+| \`fetchargs.query\` | \`object\` | Query string parameters. |
+| \`fetchargs.headers\` | \`object\` | Request headers (merged with defaults). |
+| \`fetchargs.body\` | \`any\` | Request body (objects are JSON-serialized). |
+| \`fetchargs.ctrl\` | \`object\` | Control options (e.g. \`{ explain: true }\`). |
+
+**Returns:** \`Promise<{ ok, status, headers, data } | Error>\`
+
+#### \`prepare(fetchargs?: object)\`
+
+Prepare a fetch definition without sending the request. Accepts the
+same parameters as \`direct()\`.
+
+**Returns:** \`Promise<{ url, method, headers, body } | Error>\`
+
+#### \`tester(testopts?, sdkopts?)\`
+
+Alias for \`${model.Name}SDK.test()\`.
+
+**Returns:** \`${model.Name}SDK\` instance in test mode.
+
+`)
+
+
+    // Entity reference sections
+    publishedEntities.map((ent: any) => {
+      const opnames = Object.keys(ent.op || {})
+      const fields = ent.field || []
+
+      Content(`
+---
+
+## ${ent.Name}Entity
+
+`)
+
+      if (ent.short) {
+        Content(`${ent.short}
+
+`)
+      }
+
+      Content(`\`\`\`ts
+const ${ent.name} = client.${ent.Name}()
+\`\`\`
+
+`)
+
+
+      // 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}\` | \`${field.type || 'any'}\` | ${req} | ${desc} |
+`)
+        })
+
+        Content(`
+`)
+
+        // Field operations breakdown
+        const hasFieldOps = fields.some((f: any) => f.op && Object.keys(f.op).length > 0)
+        if (hasFieldOps) {
+          Content(`### Field Usage by Operation
+
+| Field | load | list | create | update | remove |
+| --- | --- | --- | --- | --- | --- |
+`)
+          each(fields, (field: any) => {
+            const fops = field.op || {}
+            const cols = ['load', 'list', 'create', 'update', 'remove'].map((op: string) => {
+              if (!opnames.includes(op)) return '-'
+              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}
+
+`)
+
+          // Show example
+          if ('load' === opname || 'remove' === opname) {
+            Content(`\`\`\`ts
+const result = await client.${ent.Name}().${opname}({ id: '${ent.name}_id' })
+\`\`\`
+
+`)
+          }
+          else if ('list' === opname) {
+            Content(`\`\`\`ts
+const results = await client.${ent.Name}().${opname}()
+\`\`\`
+
+`)
+          }
+          else if ('create' === opname) {
+            Content(`\`\`\`ts
+const result = await client.${ent.Name}().create({
+`)
+            each(fields, (field: any) => {
+              if ('id' !== field.name && field.req) {
+                Content(`  ${field.name}: /* ${field.type || 'value'} */,
+`)
+              }
+            })
+            Content(`})
+\`\`\`
+
+`)
+          }
+          else if ('update' === opname) {
+            Content(`\`\`\`ts
+const result = await client.${ent.Name}().update({
+  id: '${ent.name}_id',
+  // Fields to update
+})
+\`\`\`
+
+`)
+          }
+        })
+      }
+
+
+      // Common methods
+      Content(`### Common Methods
+
+#### \`data(data?: object)\`
+
+Get or set the entity data. When called with data, sets the entity's
+internal data and returns the current data. When called without
+arguments, returns a copy of the current data.
+
+#### \`match(match?: object)\`
+
+Get or set the entity match criteria. Works the same as \`data()\`.
+
+#### \`make()\`
+
+Create a new \`${ent.Name}Entity\` instance with the same client and
+options.
+
+#### \`client()\`
+
+Return the parent \`${model.Name}SDK\` instance.
+
+#### \`entopts()\`
+
+Return a copy of the entity options.
+
+`)
+    })
+
+
+    // 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:
+
+\`\`\`ts
+const client = new ${model.Name}SDK({
+  feature: {
+`)
+      activeFeatures.map((f: any) => {
+        Content(`    ${f.name}: { active: true },
+`)
+      })
+      Content(`  }
+})
+\`\`\`
+
+`)
+    }
+
+  })
+})
+
+
+export {
+  ReadmeRef
+}

package/src/sdkgen.ts

@@ -29,6 +29,7 @@ import { Test } from './cmp/Test'
 import { ReadmeInstall } from './cmp/ReadmeInstall'
 import { ReadmeOptions } from './cmp/ReadmeOptions'
 import { ReadmeEntity } from './cmp/ReadmeEntity'
+import { ReadmeRef } from './cmp/ReadmeRef'
 import { FeatureHook } from './cmp/FeatureHook'
 
 
@@ -358,6 +359,7 @@ export {
   ReadmeInstall,
   ReadmeOptions,
   ReadmeEntity,
+  ReadmeRef,
   FeatureHook,
 
   Jostraca,