@voxgig/sdkgen 4.21.0 → 4.23.0

package/project/.sdk/src/cmp/go/ReadmeRef_go.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, canonToType, File, isAuthActive, entityIdField, entityOps, opRequestShape } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, File, isAuthActive, entityIdField, entityOps, opRequestShape , targetFeatures } from '@voxgig/sdkgen'
 import { ReadmeRefFeatures } from '@voxgig/sdkgen'
 
 import {
@@ -44,7 +44,7 @@ const ReadmeRef = cmp(function ReadmeRef(props: any) {
   const { model } = props.ctx$
 
   const entity = getModelPath(model, `main.${KIT}.entity`)
-  const feature = getModelPath(model, `main.${KIT}.feature`)
+  const feature = targetFeatures(model, target)
 
   const publishedEntities = each(entity).filter((e: any) => e.active !== false)
 
@@ -113,7 +113,6 @@ client := sdk.TestSDK(testopts, sdkopts)
 `)
 
 
-    // Entity factory methods
     publishedEntities.map((ent: any) => {
       Content(`#### \`${ent.Name}(data map[string]any) ${model.const.Name}Entity\`
 
@@ -159,17 +158,14 @@ same parameters as \`Direct()\`.
 `)
 
 
-    // Entity reference sections
     publishedEntities.map((ent: any) => {
       // ACTIVE ops only — an inactive op generates no method, so an example
       // calling it would not compile.
       const opnames = entityOps(ent)
-      const fields = ent.fields || []
+      const fields = Object.values(ent.fields || {})
       // Model-driven id key: null when this entity has no id-like field, in
       // which case load/remove pass a nil match and update omits the id.
       const idF = entityIdField(ent)
-      // camelCase Go identifier (a `status_embed_config` entity must not bind
-      // a snake_case Go variable).
       const eVar = goVarName(ent.name)
 
       Content(`
@@ -193,7 +189,6 @@ fmt.Println(${eVar}.GetName()) // "${ent.name}"
 `)
 
 
-      // Field schema
       if (fields.length > 0) {
         Content(`### Fields
 
@@ -201,16 +196,15 @@ fmt.Println(${eVar}.GetName()) // "${ent.name}"
 | --- | --- | --- | --- |
 `)
         each(fields, (field: any) => {
-          const req = field.req ? 'Yes' : 'No'
-          const desc = field.short || ''
-          Content(`| \`${field.name}\` | \`${canonToType(field.type, target.name)}\` | ${req} | ${desc} |
+          const req = field.r ? 'Yes' : 'No'
+          const desc = field.sh || ''
+          Content(`| \`${field.n}\` | \`${canonToType(field.t, target.name)}\` | ${req} | ${desc} |
 `)
         })
 
         Content(`
 `)
 
-        // Field operations breakdown
         const hasFieldOps = fields.some((f: any) => f.op && Object.keys(f.op).length > 0)
         if (hasFieldOps) {
           // Only emit columns for operations this entity actually exposes —
@@ -231,7 +225,7 @@ fmt.Println(${eVar}.GetName()) // "${ent.name}"
               if (fop.active === false) return '-'
               return 'Yes'
             })
-            Content(`| \`${field.name}\` | ${cols.join(' | ')} |
+            Content(`| \`${field.n}\` | ${cols.join(' | ')} |
 `)
           })
 
@@ -241,7 +235,6 @@ fmt.Println(${eVar}.GetName()) // "${ent.name}"
       }
 
 
-      // Operation details
       if (opnames.length > 0) {
         Content(`### Operations
 
@@ -346,7 +339,6 @@ fmt.Println(result)
       }
 
 
-      // Common methods
       Content(`### Common Methods
 
 #### \`Data(args ...any) any\`
@@ -372,7 +364,6 @@ Return the entity name.
     })
 
 
-    // Features section
     const activeFeatures = each(feature).filter((f: any) => f.active)
     if (activeFeatures.length > 0) {
       Content(`
@@ -408,9 +399,6 @@ client := sdk.New${model.const.Name}SDK(map[string]any{
 \`\`\`
 
 `)
-      // The shared feature reference: options, defaults, usage and the
-      // considerations. Model facts, identical in every target, so they are
-      // written once in cmp/ReadmeRefFeatures.ts rather than here.
       ReadmeRefFeatures({ target })
     }
 

package/project/.sdk/src/cmp/go/ReadmeTopQuick_go.ts

@@ -14,7 +14,6 @@ const ReadmeTopQuick = cmp(function ReadmeTopQuick(props: any) {
   const { target, ctx$: { model } } = props
 
   const entity = getModelPath(model, `main.${KIT}.entity`)
-  // Go module path == repo path on GitHub (org from model.origin).
   const gomodule = goModule(model, target.name)
 
   const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
@@ -46,10 +45,7 @@ client := ${ctor}
 
   if (exampleEntity) {
     const eName = nom(exampleEntity, 'Name')
-    // camelCase Go identifier (never snake_case, never a Go keyword).
     const eVar = goVarName(exampleEntity.name)
-    // ACTIVE ops only — an inactive op generates no method, so an example
-    // calling it would not compile.
     const opnames = entityOps(exampleEntity)
 
     let hasCall = false
@@ -65,9 +61,6 @@ fmt.Println(${eVar}s)
       hasCall = true
     }
 
-    // Find a nested entity for a more interesting example: 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 &&
@@ -106,9 +99,7 @@ fmt.Println(${neVar})
       hasCall = true
     }
 
-    // Fallback: APIs with only `load` (no list, no nested) — still show one call.
     if (!hasCall && opnames.includes('load')) {
-      // Every REQUIRED load-match key (id first) — nil when there are none.
       const idF = entityIdField(exampleEntity)
       const loadItems = opRequestShape(exampleEntity, 'load').items
         .filter((it: any) => !it.optional || it.name === idF)

package/project/.sdk/src/cmp/go/Schema_go.ts

@@ -17,27 +17,6 @@ import {
 } from './utility_go'
 
 
-// THE GENERATED SCHEMA MODULE: the model's schemas, as data the SDK can run.
-//
-// The go peer of src/cmp/ts/Schema_ts.ts. Same two exports, same source:
-// OPTSPEC from `main.kit.optspec` plus each feature's own `config.options`,
-// ENTITYSPEC from the entity field sentinels — both built by the shared
-// helpers, so what go validates against and what ts validates against cannot
-// drift.
-//
-// EMBEDDED AS JSON, PARSED AT LOAD, where ts emits an object literal. JSON is
-// a subset of TypeScript's own literal syntax and is not a subset of go's, so
-// the literal ts writes directly is a `map[string]any{...}` tree here — which
-// this could render (utility_go has the formatter config.go's literal branch
-// uses), but the JSON string is the smaller, simpler artefact and every
-// target this is being ported to already carries one for its config.
-//
-// The round-trip is exact because the spec holds only strings and booleans:
-// pinned by "strings and booleans only, so the JSON round-trip is lossless"
-// in ts/test/optspec.test.ts. That is not incidental. json.Unmarshal decodes
-// EVERY JSON number as float64, and struct reads a spec by example, so one
-// number in here would mean something different in go than in ts — the same
-// disagreement configNormalise exists to repair in config.go.
 const Schema = cmp(async function Schema(props: any) {
   const ctx$ = props.ctx$
   const target = props.target
@@ -57,7 +36,7 @@ import (
 // ${model.const.Name} ${target.Name} SDK: generated schemas. Do not edit.
 //
 // Generated from the model: \`main.kit.optspec\` and each feature's
-// \`config.options\` for OPTSPEC; entity \`fields[].type\` for ENTITYSPEC.
+// \`config.options\` for OPTSPEC; entity \`fields{}.type\` for ENTITYSPEC.
 
 const optspecJSON = ${formatGoString(JSON.stringify(optspec))}
 

package/project/.sdk/src/cmp/go/TestDirect_go.ts

@@ -35,10 +35,10 @@ function normalizePathParams(
       // original name was renamed to another param's current name (e.g. badge
       // load: param 'group_id' has orig 'id', and another param has name 'id').
       const param = params.find((p: any) =>
-          p.name === snaked || p.name === depluralized) ||
+          p.n === snaked || p.n === depluralized) ||
         params.find((p: any) =>
-          p.orig === snaked || p.orig === depluralized)
-      if (param) return '{' + param.name + '}'
+          p.or === snaked || p.or === depluralized)
+      if (param) return '{' + param.n + '}'
 
       if (rename) {
         for (const [origCamel, renamedTo] of Object.entries(rename)) {
@@ -46,10 +46,10 @@ function normalizePathParams(
             const origSnaked = snakify(origCamel)
             const origDepluralized = depluralize(origSnaked)
             const renamedParam = params.find(
-              (p: any) => p.orig === origSnaked || p.name === origSnaked ||
-                p.orig === origDepluralized || p.name === origDepluralized
+              (p: any) => p.or === origSnaked || p.n === origSnaked ||
+                p.or === origDepluralized || p.n === origDepluralized
             )
-            if (renamedParam) return '{' + renamedParam.name + '}'
+            if (renamedParam) return '{' + renamedParam.n + '}'
           }
         }
       }
@@ -107,11 +107,10 @@ const TestDirect = cmp(function TestDirect(props: any) {
   const loadOp = entity.op?.load
   const listOp = entity.op?.list
 
-  // Get load point info
   const loadPoint = loadOp?.points?.[0]
   const loadIsGraphql = 'graphql' === (loadPoint as any)?.kind
-  const loadPath = loadPoint ? normalizePathParams(pointParts(loadPoint), loadPoint?.args?.params || [], loadPoint?.rename?.param) : ''
-  const allLoadParams = loadPoint?.args?.params || []
+  const loadPath = loadPoint ? normalizePathParams(pointParts(loadPoint), loadPoint?.g?.params || [], loadPoint?.r?.param) : ''
+  const allLoadParams = loadPoint?.g?.params || []
   // Some upstream OpenAPI specs declare a parameter as `in: path` even when
   // that path has no `{name}` placeholder for it. Only path params that
   // actually appear in the URL template should drive direct-test path-param
@@ -123,7 +122,7 @@ const TestDirect = cmp(function TestDirect(props: any) {
       _pathPlaceholders.add(part.slice(1, -1))
     }
   }
-  const _renameMap = (loadPoint?.rename?.param || {}) as Record<string, string>
+  const _renameMap = (loadPoint?.r?.param || {}) as Record<string, string>
   const _renamedPlaceholders = new Set<string>()
   for (const ph of _pathPlaceholders) {
     _renamedPlaceholders.add(ph)
@@ -132,28 +131,25 @@ const TestDirect = cmp(function TestDirect(props: any) {
     }
   }
   const loadParams = allLoadParams.filter((p: any) =>
-    _renamedPlaceholders.has(p.name) || _renamedPlaceholders.has(p.orig))
+    _renamedPlaceholders.has(p.n) || _renamedPlaceholders.has(p.or))
 
-  // Get list point info
   const listPoint = listOp?.points?.[0]
   const listIsGraphql = 'graphql' === (listPoint as any)?.kind
-  const listPath = listPoint ? normalizePathParams(pointParts(listPoint), listPoint?.args?.params || [], listPoint?.rename?.param) : ''
-  const listParams = listPoint?.args?.params || []
+  const listPath = listPoint ? normalizePathParams(pointParts(listPoint), listPoint?.g?.params || [], listPoint?.r?.param) : ''
+  const listParams = listPoint?.g?.params || []
 
-  // Required query params with spec-provided examples — needed in live mode
-  // to satisfy API contracts (e.g. /v2018/history requires city/start/end).
-  const loadQuery = loadPoint?.args?.query || []
+  const loadQuery = loadPoint?.g?.query || []
   const loadLiveQueryEntries = loadQuery
-    .filter((q: any) => q.reqd && undefined !== q.example && null !== q.example)
+    .filter((q: any) => q.r && undefined !== q.ex && null !== q.ex)
   const loadLiveQueryLines = loadLiveQueryEntries
-    .map((q: any) => `\t\t\tquery["${q.name}"] = ${JSON.stringify(q.example)}`)
+    .map((q: any) => `\t\t\tquery["${q.n}"] = ${JSON.stringify(q.ex)}`)
     .join('\n')
 
-  const listQuery = listPoint?.args?.query || []
+  const listQuery = listPoint?.g?.query || []
   const listLiveQueryEntries = listQuery
-    .filter((q: any) => q.reqd && undefined !== q.example && null !== q.example)
+    .filter((q: any) => q.r && undefined !== q.ex && null !== q.ex)
   const listLiveQueryLines = listLiveQueryEntries
-    .map((q: any) => `\t\t\tquery["${q.name}"] = ${JSON.stringify(q.example)}`)
+    .map((q: any) => `\t\t\tquery["${q.n}"] = ${JSON.stringify(q.ex)}`)
     .join('\n')
 
   // Path params with spec-provided examples — when ALL load params have
@@ -163,12 +159,11 @@ const TestDirect = cmp(function TestDirect(props: any) {
   // semantic mismatch.
   const loadAllHaveExamples =
     loadParams.length > 0 &&
-    loadParams.every((p: any) => undefined !== p.example && null !== p.example)
+    loadParams.every((p: any) => undefined !== p.ex && null !== p.ex)
   const loadExampleLines = loadAllHaveExamples
-    ? loadParams.map((p: any) => `\t\t\tparams["${p.name}"] = ${JSON.stringify(p.example)}`).join('\n')
+    ? loadParams.map((p: any) => `\t\t\tparams["${p.n}"] = ${JSON.stringify(p.ex)}`).join('\n')
     : ''
 
-  // Build the ENTID env var name for this entity
   const entidEnvVar = `${PROJECTNAME}_TEST_${envToken(entity.name)}_ENTID`
 
   File({ name: entity.name + '_direct_test.' + target.ext }, () => {
@@ -188,7 +183,6 @@ import (
 func Test${entity.Name}Direct(t *testing.T) {
 `)
 
-    // Generate list test first (load needs list results in live mode)
     if (hasList && listPoint && listIsGraphql) {
       generateDirectGraphqlGo('list', entity, listPoint, liveFail)
     }
@@ -196,15 +190,14 @@ func Test${entity.Name}Direct(t *testing.T) {
     if (hasList && listPoint && !listIsGraphql) {
       const listParamStr = listParams.length > 0
         ? listParams.map((p: any, i: number) =>
-          `"${p.name}": "direct0${i + 1}"`).join(', ')
+          `"${p.n}": "direct0${i + 1}"`).join(', ')
         : ''
 
-      // Build live params for list
       const listLiveParams = listParams.map((p: any) => {
-        const key = p.name === 'id'
+        const key = p.n === 'id'
           ? entity.name + '01'
-          : p.name.replace(/_id$/, '') + '01'
-        return { name: p.name, key }
+          : p.n.replace(/_id$/, '') + '01'
+        return { name: p.n, key }
       })
 
       // Track idmap keys this test consumes in live mode. If any are
@@ -252,9 +245,6 @@ ${listSkipBlock}		client := setup.client
         Content(`		params := map[string]any{}
 `)
         listLiveParams.forEach((lp: any, i: number) => {
-          // Each path param gets its own placeholder ("direct01", "direct02", ...)
-          // in non-live mode so URL-shape assertions can verify the params
-          // landed in distinct positions in the URL.
           const placeholder = 'direct0' + (i + 1)
           Content(`		if setup.live {
 			params["${lp.name}"] = setup.idmap["${lp.key}"]
@@ -354,29 +344,21 @@ ${listSkipBlock}		client := setup.client
     if (hasLoad && loadPoint && !loadIsGraphql) {
       const loadParamStr = loadParams.length > 0
         ? loadParams.map((p: any, i: number) =>
-          `"${p.name}": "direct0${i + 1}"`).join(', ')
+          `"${p.n}": "direct0${i + 1}"`).join(', ')
         : ''
 
-      // Identify ancestor params (not 'id') for live mode
-      const ancestorParams = loadParams.filter((p: any) => p.name !== 'id')
+      const ancestorParams = loadParams.filter((p: any) => p.n !== 'id')
 
-      // Determine which idmap keys this load test will consume in live mode.
-      // - allHaveExamples: spec provides example values for every load
-      //   path-param, so live mode uses them — no idmap needed.
-      // - hasList: we list-bootstrap, so we need the keys for the list call's
-      //   path params (ancestors of the list path).
-      // - synthetic-only: we'd use idmap for load path-params; without an
-      //   override they're undefined and the live request 4xx's.
       let loadLiveIdKeys: string[] = []
       if (loadParams.length > 0 && !loadAllHaveExamples) {
         if (hasList) {
           loadLiveIdKeys = listParams.map((p: any) => {
-            return p.name === 'id'
+            return p.n === 'id'
               ? entity.name + '01'
-              : p.name.replace(/_id$/, '') + '01'
+              : p.n.replace(/_id$/, '') + '01'
           })
         } else {
-          loadLiveIdKeys = loadParams.map((p: any) => p.name + '01')
+          loadLiveIdKeys = loadParams.map((p: any) => p.n + '01')
         }
       }
       const loadSkipBlock = loadLiveIdKeys.length > 0
@@ -419,23 +401,20 @@ ${loadSkipBlock}		client := setup.client
         Content(`		if setup.live {
 `)
 
-        // Required-query setup (e.g. /v2018/history needs city/start/end).
         if (loadLiveQueryLines) {
           Content(loadLiveQueryLines + '\n')
         }
 
         if (loadAllHaveExamples) {
-          // Use spec-provided path-param examples — no list bootstrap needed.
           Content(loadExampleLines + '\n')
         } else if (hasList && loadParams.length > 0) {
-          // List-bootstrap: first call list, take id from response.
           Content(`			listParams := map[string]any{}
 `)
           for (const p of listParams) {
-            const key = p.name === 'id'
+            const key = p.n === 'id'
               ? entity.name + '01'
-              : p.name.replace(/_id$/, '') + '01'
-            Content(`			listParams["${p.name}"] = setup.idmap["${key}"]
+              : p.n.replace(/_id$/, '') + '01'
+            Content(`			listParams["${p.n}"] = setup.idmap["${key}"]
 `)
           }
 
@@ -459,10 +438,9 @@ ${loadSkipBlock}		client := setup.client
 			firstEnt := core.ToMapAny(listData[0])
 			params["id"] = firstEnt["id"]
 `)
-          // Set ancestor params from idmap
           for (const p of ancestorParams) {
-            const key = p.name.replace(/_id$/, '') + '01'
-            Content(`			params["${p.name}"] = setup.idmap["${key}"]
+            const key = p.n.replace(/_id$/, '') + '01'
+            Content(`			params["${p.n}"] = setup.idmap["${key}"]
 `)
           }
         }
@@ -471,7 +449,7 @@ ${loadSkipBlock}		client := setup.client
           Content(`		} else {
 `)
           for (let i = 0; i < loadParams.length; i++) {
-            Content(`			params["${loadParams[i].name}"] = "direct0${i + 1}"
+            Content(`			params["${loadParams[i].n}"] = "direct0${i + 1}"
 `)
           }
         }
@@ -632,7 +610,6 @@ func ${entity.name}DirectSetup(mockres any) *${entity.name}DirectSetupResult {
 }
 `)
 
-    // Suppress unused import warnings
     Content(`
 var _ = os.Getenv
 var _ = json.Unmarshal
@@ -642,7 +619,7 @@ var _ = json.Unmarshal
 
 
 // GraphQL-backed op needs POST+body, not a REST-shaped GET+params Direct()
-// call — reuse apidef's own point.graphql.doc via the SDK's Graphql() hatch.
+// call — reuse apidef's own point.gq.doc via the SDK's Graphql() hatch.
 // Mirrors TestDirect_ts.ts's generateDirectGraphql.
 function generateDirectGraphqlGo(
   opname: 'load' | 'list',
@@ -650,8 +627,8 @@ function generateDirectGraphqlGo(
   point: any,
   liveFail: string,
 ) {
-  const doc: string = point.graphql.doc
-  const vars: any[] = point.graphql.vars || []
+  const doc: string = point.gq.doc
+  const vars: any[] = point.gq.vars || []
 
   const mockVarLines = vars.map((v: any, i: number) =>
     `\t\tvariables["${v.name}"] = "direct0${i + 1}"`).join('\n')