@voxgig/sdkgen 4.21.0 → 4.23.0

package/project/.sdk/src/cmp/csharp/PrepareAuth_csharp.ts

@@ -16,30 +16,6 @@ import {
 } from '@voxgig/apidef'
 
 
-// WHERE THE CREDENTIAL GOES IS A FACT ABOUT THE API, so it is generated
-// rather than templated.
-//
-// This was a static file at `tm/csharp/utility/PrepareAuth.cs` that
-// hardcoded `authorization` and a header. apidef has always resolved the
-// scheme's `in` and `name` into `main.kit.info.security` - joplin's says
-// `in: "query", name: "token"` - and generation dropped both. The result
-// was an SDK that sent a header the API does not read and never sent the
-// query parameter it does, so it could not authenticate at all. Four
-// repos in the cedar fleet shipped that way: joplin (`token`), pipedrive
-// (`api_token`), trello (`key`), lm-umbrella (`apiKey`).
-//
-// A template cannot fix this, because the three placements need three
-// different bodies and a template has to pick one. A component emits the
-// branch this API actually uses and nothing else - no dead query code in
-// a bearer-token SDK, and no runtime `if` on a value that is fixed at
-// generation time.
-//
-// This is the csharp port of PrepareAuth_ts, and it keeps the C# file's
-// own idioms (lazy prefix read, `TryGetValue` for a suppressed auth
-// block, `Remove` rather than a struct delprop): the credential MOVES,
-// nothing else changes. For the default header placement the rendered
-// file is BYTE-IDENTICAL to the template it replaces, so every
-// header-based csharp SDK regenerates with no diff at all.
 const PrepareAuth = cmp(async function PrepareAuth(props: any) {
   const { target } = props
   const { model } = props.ctx$
@@ -49,19 +25,6 @@ const PrepareAuth = cmp(async function PrepareAuth(props: any) {
   const name = resolveAuthName(model)
   const basic = isHttpBasicAuth(model)
 
-  // `utility`, opened HERE, and the call site in Main_csharp is at the
-  // ROOT - deliberately outside `Folder({ name: 'core' })`.
-  //
-  // csharp's layout is not ts's. Main_csharp copies `tm/csharp` at the
-  // root, so the template this replaces landed at `<out>/utility/
-  // PrepareAuth.cs`, beside MakeSpec.cs and Register.cs - which is the
-  // one path that compiles, since Register.cs wires `u.PrepareAuth =
-  // PrepareAuthUtil` from the same `partial class SdkUtility`. The
-  // generated files (Config, SdkError, EntityBase, EntityTypes) sit one
-  // level down in `core/` because Main opens that Folder around them; a
-  // call from inside it would write `core/utility/PrepareAuth.cs`, which
-  // nothing compiles into the utility partial and which would leave the
-  // stale copy at `utility/` being used instead.
   Folder({ name: 'utility' }, () => {
     File({ name: 'PrepareAuth.' + target.ext }, () => {
       Content(render({
@@ -76,30 +39,6 @@ const PrepareAuth = cmp(async function PrepareAuth(props: any) {
 })
 
 
-// DELIBERATELY NARROWER THAN isAuthActive, and measured rather than assumed.
-//
-// isAuthActive answers TWO different questions with one boolean:
-//
-//   1. `main.kit.config.auth.active: false` - this SDK is deliberately
-//      built WITHOUT auth. A per-SDK decision.
-//   2. `main.kit.info.auth: false`          - the SPEC declares no security
-//      scheme. A fact about the API.
-//
-// Only (1) may silence prepareAuth. (2) says nothing about whether the
-// CALLER holds a credential, and csharp has always let one through: the
-// optspec in tm/csharp/utility/MakeOptions.cs supplies an `auth` default
-// map whether or not the generated config carries one, so `options.auth` is
-// non-null at runtime and the old template placed `options.apikey` in the
-// authorization header regardless of what the spec declared. The generated
-// secrets feature and the auth-null probe both depend on exactly that.
-//
-// Gating the no-op on isAuthActive instead turns two csharp tests red -
-// `csharp: auth null beats an explicit apikey` ("baseline broken: an
-// ordinary apikey was not sent") and `csharp: the secrets feature runs with
-// the feature active` - because the generate harness model IS case (2)
-// (`main: kit: info: { ..., auth: false }`). Losing the ability to
-// authenticate is the defect this whole change exists to fix, so it is not
-// worth re-introducing at the other end.
 function authSwitchedOff(model: any): boolean {
   const auth = getModelPath(model, `main.${KIT}.config.auth`,
     { only_active: false, required: false })
@@ -112,9 +51,6 @@ function render(spec: {
 }): string {
   const Name = spec.Name
 
-  // AUTH SWITCHED OFF FOR THIS SDK (`config.auth.active: false`). The
-  // project has said it wants no credential placed, so prepareAuth places
-  // none - rather than one that deletes a header nobody set.
   if (!spec.active) {
     return `// ${Name} SDK utility: prepareAuth - this SDK is built with auth
 // switched off, so there is no credential to place.
@@ -142,22 +78,10 @@ public static partial class SdkUtility
     return renderCookie(Name, csstr(spec.name))
   }
 
-  // HEADER NAMES ARE LOWERCASED, and the rest of the generated C# is why.
-  // `spec.Headers` is a plain Dictionary<string, object?> - case-SENSITIVE -
-  // and every other writer of an auth header in this target spells it
-  // lowercase: SecretsFeature re-writes `headers["authorization"]` on a
-  // refresh, MakeSpec sets `headers["content-type"]`, and the generated
-  // tests assert `Headers["authorization"]`. An `Authorization` key here
-  // would sit BESIDE those rather than replace them and go out as a second
-  // header. Header names are case-insensitive on the wire (RFC 7230) and
-  // lowercase on HTTP/2, so nothing is lost. Query parameter and cookie
-  // names, which ARE case-sensitive, are emitted verbatim above.
   return renderHeader(Name, csstr(String(spec.name).toLowerCase()), spec.basic)
 }
 
 
-// HEADER. Byte-identical to the template it replaces whenever the resolved
-// name is the default (`authorization`) and the scheme is not HTTP Basic.
 function renderHeader(Name: string, cred: string, basic: boolean): string {
   // HTTP Basic is header-only by definition: the scheme is
   // `Authorization: Basic base64(user:pass)`. It cannot be expressed as a
@@ -320,9 +244,6 @@ public static partial class SdkUtility
 }
 
 
-// COOKIE. A cookie IS a header, so the credential rides in the shared
-// `cookie` header - APPENDED to whatever options.headers (or an earlier
-// feature) already put there, never assigned over it.
 function renderCookie(Name: string, cred: string): string {
   return `// ${Name} SDK utility: prepareAuth - carry the API credential in the
 // ${cred} cookie, from the client options.
@@ -380,8 +301,6 @@ public static partial class SdkUtility
 }
 
 
-// A C# double-quoted string literal body. These names come from the API's
-// own securityScheme, so they are not guaranteed to be bare identifiers.
 function csstr(s: string): string {
   return String(s).replace(/\\/g, '\\\\').replace(/"/g, '\\"')
 }

package/project/.sdk/src/cmp/csharp/ReadmeEntity_csharp.ts

@@ -55,8 +55,7 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
 
   publishedEntities.map((entity: any) => {
     const opnames = Object.keys(entity.op || {})
-    const fields = entity.fields || []
-    // Model-driven id key: null when this entity has no id-like field.
+    const fields = Object.values(entity.fields || {})
     const idF = entityIdField(entity)
     // Sanitise the local variable name — a camelCased C# keyword gets a
     // trailing underscore (csVarName) so the snippet compiles.
@@ -103,8 +102,8 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
 `)
 
       each(fields, (field: any) => {
-        const desc = field.short || ''
-        Content(`| \`${field.name}\` | \`${canonToType(field.type, target.name)}\` | ${desc} |
+        const desc = field.sh || ''
+        Content(`| \`${field.n}\` | \`${canonToType(field.t, target.name)}\` | ${desc} |
 `)
       })
 

package/project/.sdk/src/cmp/csharp/ReadmeExamplesTest_csharp.ts

@@ -2,29 +2,6 @@
 import { cmp, File, Content } from '@voxgig/sdkgen'
 
 
-// Emits test/ReadmeExamplesTest.cs — an xUnit PRESENCE + STRUCTURE gate over
-// every ```csharp fenced block in the repository ROOT README.md, the
-// per-language csharp/README.md, AND the per-language csharp/REFERENCE.md.
-//
-// SCOPE NOTE (deliberate, documented): the Python/TS/Go equivalents EXECUTE and
-// type-check every documented block. That is infeasible here — the generated
-// C# SDK targets the .NET BCL only (no Roslyn scripting dependency), so a test
-// project cannot compile-and-run arbitrary doc snippets at test time without a
-// dependency the target explicitly forbids. This gate therefore guarantees the
-// weaker-but-real invariant that keeps the docs honest as the generator
-// evolves:
-//   1. every doc exists and contains at least one ```csharp block (nothing was
-//      dropped);
-//   2. every ```csharp block is structurally well-formed — its braces,
-//      parentheses and brackets balance (catches a truncated or malformed
-//      generated snippet), and it references the SDK/client surface so it is a
-//      real example, not an empty fence.
-// A per-doc summary line makes the coverage visible in the test output.
-//
-// The emitted C# is written WITHOUT literal backticks (the fence marker is
-// built at runtime as new string((char)96, 3)) so this TS template literal
-// stays clean — the only interpolations are the SDK class name and the
-// generated entity map.
 const ReadmeExamplesTest = cmp(function ReadmeExamplesTest(props: any) {
   const { target, ctx$: { model } } = props
 

package/project/.sdk/src/cmp/csharp/ReadmeModel_csharp.ts

@@ -114,13 +114,13 @@ On error, \`ok\` is \`false\` and \`err\` contains the error value.
 
 `)
   each(entityList, (ent: any) => {
-    const fields = ent.fields || []
+    const fields = Object.values(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 || '' : ''
+    const path = points.length > 0 ? (points[0] as any).o || '' : ''
 
     Content(`#### ${ent.Name}
 
@@ -128,7 +128,7 @@ On error, \`ok\` is \`false\` and \`err\` contains the error value.
 | --- | --- |
 `)
     each(fields, (field: any) => {
-      Content(`| \`${field.name}\` | ${field.short || ''} |
+      Content(`| \`${field.n}\` | ${field.sh || ''} |
 `)
     })
 

package/project/.sdk/src/cmp/csharp/ReadmeRef_csharp.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, canonToType, canonKey, canonScalarKey, File, isAuthActive, entityIdField, opRequestShape } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, canonKey, canonScalarKey, File, isAuthActive, entityIdField, opRequestShape , targetFeatures } from '@voxgig/sdkgen'
 import { ReadmeRefFeatures } from '@voxgig/sdkgen'
 
 import {
@@ -58,7 +58,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)
 
@@ -171,7 +171,7 @@ Prepare a fetch definition without sending. Returns the \`fetchdef\` and raises
     // Entity reference sections
     publishedEntities.map((ent: any) => {
       const opnames = Object.keys(ent.op || {})
-      const fields = ent.fields || []
+      const fields = Object.values(ent.fields || {})
       // Model-driven id key: null when this entity has no id-like field.
       const idF = entityIdField(ent)
       // Sanitise the local variable name — csVarName guards C# keywords.
@@ -205,9 +205,9 @@ var ${eVar} = client.${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} |
 `)
         })
 
@@ -232,7 +232,7 @@ var ${eVar} = client.${ent.Name}();
               if (fop.active === false) return '-'
               return 'Yes'
             })
-            Content(`| \`${field.name}\` | ${cols.join(' | ')} |
+            Content(`| \`${field.n}\` | ${cols.join(' | ')} |
 `)
           })
 
@@ -380,9 +380,6 @@ var client = new ${model.const.Name}SDK(new Dictionary<string, object?>
 \`\`\`
 
 `)
-      // 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/csharp/ReadmeTopQuick_csharp.ts

@@ -49,8 +49,6 @@ var client = ${ctor};
     // C# keyword gets a trailing underscore (csVarName) so the snippet compiles.
     const eVar = csVarName(exampleEntity.name)
     const opnames = Object.keys(exampleEntity.op || {})
-    // Model-driven id key: null when the entity has no id-like field, in which
-    // case the load example takes an empty match.
     const idF = entityIdField(exampleEntity)
 
     if (opnames.includes('list')) {

package/project/.sdk/src/cmp/csharp/Schema_csharp.ts

@@ -17,24 +17,6 @@ import {
 } from './utility_csharp'
 
 
-// THE GENERATED SCHEMA MODULE: the model's schemas, as data the SDK can run.
-//
-// The csharp peer of src/cmp/ts/Schema_ts.ts. Same two members, 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 csharp validates against and what ts validates against
-// cannot drift.
-//
-// A COLLECTION LITERAL, not embedded JSON, where go and the JVM targets
-// parse a string. SdkConfig switches to a JSON constant above a size
-// threshold because a large composite literal is slow for the compiler to
-// bind and the JIT to run; the spec has no such spread. It is bounded by the
-// option list and the feature set — a few hundred entries whatever the API
-// looks like — and in C# the literal is also the SAFER rep: a `false` here
-// stays `false` rather than arriving as a JsonElement to be mapped back, and
-// the number ladder SdkConfig's ConfigValue exists to reproduce is a question
-// the spec never asks (it holds only strings and booleans, pinned by "strings
-// and booleans only" in ts/test/optspec.test.ts).
 const Schema = cmp(async function Schema(props: any) {
   const ctx$ = props.ctx$
   const target = props.target
@@ -52,7 +34,7 @@ const Schema = cmp(async function Schema(props: any) {
 // do not edit by hand.
 //
 // Built 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.
 
 namespace ${model.const.Name}Sdk;
 

package/project/.sdk/src/cmp/csharp/TestDirect_csharp.ts

@@ -32,10 +32,10 @@ function normalizePathParams(
       const snaked = snakify(rawName)
       const depluralized = depluralize(snaked)
       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)) {
@@ -43,10 +43,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 + '}'
           }
         }
       }
@@ -103,8 +103,8 @@ const TestDirect = cmp(function TestDirect(props: any) {
 
   // Get load point info
   const loadPoint = loadOp?.points?.[0]
-  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 || []
   // Only path params that actually appear in the URL template drive direct
   // path-param setup and URL-substitution asserts.
   const _pathPlaceholders = new Set<string>()
@@ -113,7 +113,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)
@@ -122,29 +122,29 @@ 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 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.
-  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) => `            query["${q.name}"] = ${formatCsValue(q.example)};`)
+    .map((q: any) => `            query["${q.n}"] = ${formatCsValue(q.ex)};`)
     .join('\n')
 
   // Path params with spec-provided examples - when ALL load params have
   // spec examples, prefer them over list-bootstrap in live mode.
   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) =>
-      `            pathParams["${p.name}"] = ${formatCsValue(p.example)};`).join('\n')
+      `            pathParams["${p.n}"] = ${formatCsValue(p.ex)};`).join('\n')
     : ''
 
   const entidEnvVar = `${PROJECTNAME}_TEST_${ENTUPPER}_ENTID`
@@ -168,10 +168,10 @@ public class ${entity.Name}DirectTest
     if (hasList && listPoint) {
       // 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 }
       })
 
       const listLiveIdKeys = listParams.length > 0
@@ -297,18 +297,18 @@ ${listSkipBlock}        var client = setup.Client;
     // Generate load test - in live mode, first list to get a real entity ID
     if (hasLoad && loadPoint) {
       // 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')
 
       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
@@ -362,10 +362,10 @@ ${loadSkipBlock}        var client = setup.Client;
           Content(`            var listParams = new Dictionary<string, object?>();
 `)
           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}"];
 `)
           }
 
@@ -390,8 +390,8 @@ ${loadSkipBlock}        var client = setup.Client;
             pathParams["id"] = firstEnt?["id"];
 `)
           for (const p of ancestorParams) {
-            const key = p.name.replace(/_id$/, '') + '01'
-            Content(`            pathParams["${p.name}"] = setup.Idmap["${key}"];
+            const key = p.n.replace(/_id$/, '') + '01'
+            Content(`            pathParams["${p.n}"] = setup.Idmap["${key}"];
 `)
           }
         }
@@ -402,7 +402,7 @@ ${loadSkipBlock}        var client = setup.Client;
         {
 `)
           for (let i = 0; i < loadParams.length; i++) {
-            Content(`            pathParams["${loadParams[i].name}"] = "direct0${i + 1}";
+            Content(`            pathParams["${loadParams[i].n}"] = "direct0${i + 1}";
 `)
           }
         }