@voxgig/sdkgen 0.44.0 → 0.45.0

package/project/.sdk/src/cmp/rb/ReadmeRef_rb.ts

@@ -0,0 +1,361 @@
+
+import { cmp, each, Content, File, isAuthActive } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+
+const OP_SIGNATURES: Record<string, { sig: string, returns: string, desc: string }> = {
+  load: {
+    sig: 'load(reqmatch, ctrl = nil) -> result, err',
+    returns: 'result, err',
+    desc: 'Load a single entity matching the given criteria.',
+  },
+  list: {
+    sig: 'list(reqmatch, ctrl = nil) -> result, err',
+    returns: 'result, err',
+    desc: 'List entities matching the given criteria. Returns an array.',
+  },
+  create: {
+    sig: 'create(reqdata, ctrl = nil) -> result, err',
+    returns: 'result, err',
+    desc: 'Create a new entity with the given data.',
+  },
+  update: {
+    sig: 'update(reqdata, ctrl = nil) -> result, err',
+    returns: 'result, err',
+    desc: 'Update an existing entity. The data must include the entity `id`.',
+  },
+  remove: {
+    sig: 'remove(reqmatch, ctrl = nil) -> result, err',
+    returns: 'result, err',
+    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.active !== false)
+
+
+  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(`\`\`\`ruby
+require_relative '${model.name}_sdk'
+
+client = ${model.const.Name}SDK.new(options)
+\`\`\`
+
+Create a new SDK client instance.
+
+**Parameters:**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| \`options\` | \`Hash\` | 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"]\` | \`Hash\` | Custom headers for all requests. |
+| \`options["feature"]\` | \`Hash\` | Feature configuration. |
+| \`options["system"]\` | \`Hash\` | System overrides (e.g. custom fetch). |
+
+`)
+
+
+    Content(`
+### Static Methods
+
+`)
+
+    Content(`#### \`${model.const.Name}SDK.test(testopts = nil, sdkopts = nil)\`
+
+Create a test client with mock features active. Both arguments may be \`nil\`.
+
+\`\`\`ruby
+client = ${model.const.Name}SDK.test
+\`\`\`
+
+`)
+
+
+    Content(`
+### Instance Methods
+
+`)
+
+
+    // Entity factory methods
+    publishedEntities.map((ent: any) => {
+      Content(`#### \`${ent.Name}(data = nil)\`
+
+Create a new \`${ent.Name}\` entity instance. Pass \`nil\` for no initial data.
+
+`)
+    })
+
+
+    Content(`#### \`options_map -> Hash\`
+
+Return a deep copy of the current SDK options.
+
+#### \`get_utility -> Utility\`
+
+Return a copy of the SDK utility object.
+
+#### \`direct(fetchargs = {}) -> Hash, err\`
+
+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"]\` | \`Hash\` | Path parameter values for \`{param}\` substitution. |
+| \`fetchargs["query"]\` | \`Hash\` | Query string parameters. |
+| \`fetchargs["headers"]\` | \`Hash\` | Request headers (merged with defaults). |
+| \`fetchargs["body"]\` | \`any\` | Request body (hashes are JSON-serialized). |
+| \`fetchargs["ctrl"]\` | \`Hash\` | Control options (e.g. \`{ "explain" => true }\`). |
+
+**Returns:** \`Hash, err\`
+
+#### \`prepare(fetchargs = {}) -> Hash, err\`
+
+Prepare a fetch definition without sending the request. Accepts the
+same parameters as \`direct()\`.
+
+**Returns:** \`Hash, err\`
+
+`)
+
+
+    // Entity reference sections
+    publishedEntities.map((ent: any) => {
+      const opnames = Object.keys(ent.op || {})
+      const fields = ent.fields || []
+
+      Content(`
+---
+
+## ${ent.Name}Entity
+
+`)
+
+      if (ent.short) {
+        Content(`${ent.short}
+
+`)
+      }
+
+      Content(`\`\`\`ruby
+${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(`\`\`\`ruby
+result, err = client.${ent.Name}.${opname}({ "id" => "${ent.name}_id" })
+\`\`\`
+
+`)
+          }
+          else if ('list' === opname) {
+            Content(`\`\`\`ruby
+results, err = client.${ent.Name}.list(nil)
+\`\`\`
+
+`)
+          }
+          else if ('create' === opname) {
+            Content(`\`\`\`ruby
+result, err = 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(`\`\`\`ruby
+result, err = client.${ent.Name}.update({
+  "id" => "${ent.name}_id",
+  # Fields to update
+})
+\`\`\`
+
+`)
+          }
+        })
+      }
+
+
+      // Common methods
+      Content(`### Common Methods
+
+#### \`data_get -> Hash\`
+
+Get the entity data. Returns a copy of the current data.
+
+#### \`data_set(data)\`
+
+Set the entity data.
+
+#### \`match_get -> Hash\`
+
+Get the entity match criteria.
+
+#### \`match_set(match)\`
+
+Set the entity match criteria.
+
+#### \`make -> Entity\`
+
+Create a new \`${ent.Name}Entity\` instance with the same client and
+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(`\`\`\`ruby
+client = ${model.const.Name}SDK.new({
+  "feature" => {
+`)
+      activeFeatures.map((f: any) => {
+        Content(`    "${f.name}" => { "active" => true },
+`)
+      })
+      Content(`  },
+})
+\`\`\`
+
+`)
+    }
+
+  })
+})
+
+
+
+
+export {
+  ReadmeRef
+}

package/project/.sdk/src/cmp/rb/ReadmeTopQuick_rb.ts

@@ -1,5 +1,5 @@
 
-import { cmp, Content } from '@voxgig/sdkgen'
+import { cmp, Content, isAuthActive } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -15,12 +15,14 @@ const ReadmeTopQuick = cmp(function ReadmeTopQuick(props: any) {
 
   const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
 
+  const apikeyArg = isAuthActive(model)
+    ? `\n  "apikey" => ENV["${model.NAME}_APIKEY"],\n`
+    : ''
+
   Content(`\`\`\`ruby
 require_relative "${model.const.Name}_sdk"
 
-client = ${model.const.Name}SDK.new({
-  "apikey" => ENV["${model.NAME}_APIKEY"],
-})
+client = ${model.const.Name}SDK.new({${apikeyArg}})
 
 `)
 

package/project/.sdk/src/cmp/rb/TestDirect_rb.ts

@@ -1,5 +1,8 @@
 
 import {
+  Model,
+  ModelEntity,
+  nom,
   depluralize,
 } from '@voxgig/apidef'
 
@@ -8,6 +11,7 @@ import {
   File,
   cmp,
   snakify,
+  isAuthActive,
 } from '@voxgig/sdkgen'
 
 
@@ -51,12 +55,20 @@ function normalizePathParams(
 
 const TestDirect = cmp(function TestDirect(props: any) {
   const ctx$ = props.ctx$
-  const model = ctx$.model
+  const model: Model = ctx$.model
 
   const target = props.target
-  const entity = props.entity
+  const entity: ModelEntity = props.entity
 
-  const PROJECTNAME = model.Name.toUpperCase().replace(/[^A-Z_]/g, '_')
+  const PROJECTNAME = nom(model, 'Name').toUpperCase().replace(/[^A-Z_]/g, '_')
+
+  const authActive = isAuthActive(model)
+  const apikeyEnvEntry = authActive
+    ? `\n    "${PROJECTNAME}_APIKEY" => "NONE",`
+    : ''
+  const apikeyLiveField = authActive
+    ? `\n      "apikey" => env["${PROJECTNAME}_APIKEY"],`
+    : ''
 
   const opnames = Object.keys(entity.op)
   const hasLoad = opnames.includes('load')
@@ -77,7 +89,7 @@ const TestDirect = cmp(function TestDirect(props: any) {
   const listPath = listPoint ? normalizePathParams(listPoint.parts || [], listPoint?.args?.params || [], listPoint?.rename?.param) : ''
   const listParams = listPoint?.args?.params || []
 
-  const entidEnvVar = `${PROJECTNAME}_TEST_${entity.Name.toUpperCase().replace(/[^A-Z_]/g, '_')}_ENTID`
+  const entidEnvVar = `${PROJECTNAME}_TEST_${nom(entity, 'NAME').replace(/[^A-Z_]/g, '_')}_ENTID`
 
   File({ name: entity.name + '_direct_test.' + target.ext }, () => {
 
@@ -204,15 +216,13 @@ def ${entity.name}_direct_setup(mockres)
 
   env = Runner.env_override({
     "${entidEnvVar}" => {},
-    "${PROJECTNAME}_TEST_LIVE" => "FALSE",
-    "${PROJECTNAME}_APIKEY" => "NONE",
+    "${PROJECTNAME}_TEST_LIVE" => "FALSE",${apikeyEnvEntry}
   })
 
   live = env["${PROJECTNAME}_TEST_LIVE"] == "TRUE"
 
   if live
-    merged_opts = {
-      "apikey" => env["${PROJECTNAME}_APIKEY"],
+    merged_opts = {${apikeyLiveField}
     }
     client = ${model.const.Name}SDK.new(merged_opts)
     return {