@voxgig/sdkgen 2.0.2 → 3.1.0

package/project/.sdk/src/cmp/swift/ReadmeHowto_swift.ts

@@ -51,7 +51,8 @@ const ReadmeHowto = cmp(function ReadmeHowto(props: any) {
   // The op-driven test-mode line, shown only when the SDK has an entity op.
   // A direct()-only SDK (no ops anywhere) shows a direct() call instead.
   const testModeExample = primaryOp
-    ? `// Entity ops return the bare record and throw on error.
+    ? `// Entity ops return the ENTITY and throws on error;
+// call data() for the record.
 let ${eVar} = try client.${eName}().${primaryOp}(${testArg}, nil)
 // ${eVar} holds the mock response record
 print(${eVar})`

package/project/.sdk/src/cmp/swift/ReadmeInstall_swift.ts

@@ -1,5 +1,5 @@
 
-import { cmp, Content, isPublished, repoInfo } from '@voxgig/sdkgen'
+import { cmp, Content, isPublished, repoInfo, packageVersion } from '@voxgig/sdkgen'
 
 
 const ReadmeInstall = cmp(function ReadmeInstall(props: any) {
@@ -11,7 +11,7 @@ const ReadmeInstall = cmp(function ReadmeInstall(props: any) {
 
 \`\`\`swift
 dependencies: [
-    .package(url: "<repo-url>", from: "0.0.1"),
+    .package(url: "<repo-url>", from: "${packageVersion(model, target.name)}"),
 ],
 \`\`\`
 
@@ -39,7 +39,7 @@ your \`Package.swift\`:
 \`\`\`swift
 dependencies: [
     // From the git release tag:
-    .package(url: "<repo-url>", exact: "0.0.1"),
+    .package(url: "<repo-url>", exact: "${packageVersion(model, target.name)}"),
 ],
 \`\`\`
 

package/project/.sdk/src/cmp/swift/ReadmeModel_swift.ts

@@ -92,7 +92,7 @@ ${opRows}
 
 ### Result shape
 
-Entity operations return the bare result data (a \`Value\` map for
+Entity operations return the ENTITY (call data() for the record) (a \`Value\` map for
 single-entity ops, a \`Value\` list for \`list\`) and throw on error. Wrap
 calls in \`do\`/\`catch\` to handle failures.
 

package/project/.sdk/src/cmp/swift/ReadmeQuick_swift.ts

@@ -125,7 +125,7 @@ catch {
       Content(`### 3. Load ${neArticle} ${neName.toLowerCase()}
 
 ${neName} is nested under ${parentName}, so provide the \`${parentParam}\`.
-\`load()\` returns the bare record (a \`Value\`) and throws on error.
+\`load()\` returns the ENTITY — call data() for the record — and throws on error.
 
 \`\`\`swift
 do {
@@ -153,7 +153,7 @@ catch {
 
       Content(`### 3. Load ${article} ${eName.toLowerCase()}
 
-\`load()\` returns the bare record (a \`Value\`) and throws on error.
+\`load()\` returns the ENTITY — call data() for the record — and throws on error.
 
 \`\`\`swift
 do {
@@ -193,7 +193,7 @@ catch {
 \`\`\`swift
 `)
       if (opnames.includes('create')) {
-        Content(`// Create — returns the bare created record (a Value)
+        Content(`// Create — returns the ENTITY (call data() for the record)
 let created = try client.${accessor}().create(VMap([${examplePairs('create').join(', ')}]), nil)
 
 `)

package/project/.sdk/src/cmp/swift/fragment/EntityBase.fragment.swift

@@ -84,6 +84,20 @@ open class ProjectNameEntityBase: Entity {
     throw unsupportedOp("remove", name)
   }
 
+  // Every operation resolves to the entity; `remove` additionally marks
+  // it. The instance KEEPS the data it held — a caller can still read
+  // what was deleted — but it is no longer a live record. See AGENTS.md.
+  private var deletedFlag: Bool = false
+
+  public func markDeleted() {
+    self.deletedFlag = true
+  }
+
+  public func deleted() -> Bool {
+    return self.deletedFlag
+  }
+
+
   func runOp(_ ctx: Context, _ postDone: () -> Void) throws -> Value {
     // #PrePoint-Hook
 
@@ -134,7 +148,26 @@ open class ProjectNameEntityBase: Entity {
 
     postDone()
 
-    return try utility.done(ctx)
+    let out = try utility.done(ctx)
+
+    // An operation resolves to the ENTITY, not the raw data. Entities are
+    // stateful: postDone has just absorbed resdata/resmatch into this
+    // instance, and the caller reaches the record through data(). Two
+    // structural exceptions: `list` resolves to the ARRAY of entity
+    // instances makeResult built, and a failed op with throwing disabled
+    // hands back the error payload unchanged. `remove` additionally marks
+    // the entity deleted; it KEEPS its data, so a caller can still read
+    // what was removed. See AGENTS.md "Entity operations return ENTITIES".
+    let opname = ctx.op?.name
+
+    if let result = ctx.result, result.ok, "list" != opname {
+      if "remove" == opname {
+        self.markDeleted()
+      }
+      return .native(NativeRef(self))
+    }
+
+    return out
   }
 
   // Streaming operations. Runs `action` through the full pipeline and returns

package/project/.sdk/src/cmp/ts/EntityOperation_ts.ts

@@ -1,7 +1,8 @@
 
 import {
   cmp, camelify,
-  Content, Fragment
+  Content, Fragment,
+  entityClassName, entityCollection,
 } from '@voxgig/sdkgen'
 
 
@@ -32,6 +33,13 @@ const EntityOperation = cmp(function Operation(props: any) {
       SdkName: model.const.Name,
       EntityName: entity.Name,
       entityname: entity.name,
+
+      // The CLASS token. Operations resolve to the entity instance, so their
+      // declared return type must name the class — `Promise<PlanetEntity>`,
+      // not `Promise<Planet>` (the data interface). A signature that says
+      // the data type while the call resolves to an entity is a lie the
+      // compiler cannot catch; see AGENTS.md.
+      EntyClass: entityClassName(entity, entityCollection(model)),
       "['POINTS']": formatJson(entop.points, { margin: 6 }).trim(),
       '#Feature-Hook': ({ name, indent }: any) =>
         Content({ indent }, `

package/project/.sdk/src/cmp/ts/EntityTypes_ts.ts

@@ -21,7 +21,7 @@ import {
   File, Content,
 } from '@voxgig/sdkgen'
 
-import { canonToType, opTypeName, opRequestShape, warnEntityTypeCollisions , deriveEntityNames } from '@voxgig/sdkgen'
+import { canonToType, opTypeName, opRequestShape, warnEntityTypeCollisions , deriveEntityNames, opActions } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -108,6 +108,23 @@ const EntityTypes = cmp(function EntityTypes(props: any) {
           Content(`  ${propKey(it.name)}${opt}: ${canonToType(it.type, LANG)}
 `)
         })
+
+        // Custom actions are selected with `$action` in the call's argument
+        // (see the Actions section of REFERENCE.md). Without it in the type,
+        // the ONLY documented way to reach those endpoints does not compile,
+        // and a TypeScript caller has to cast — which is how two of one API's
+        // six endpoints came to be unreachable from the typed interface.
+        const actions = opActions(ops[opname])
+        if (0 < actions.length) {
+          Content(`
+  // Selects a custom action instead of the plain ${opname}:
+  //   ${actions.map((a: any) => `'` + a.action + `'`).join(' | ')}
+  // The remaining keys are that action's own payload.
+  $action?: string
+  [action: string]: any
+`)
+        }
+
         Content(`}
 
 `)

package/project/.sdk/src/cmp/ts/Gitignore_ts.ts

@@ -12,8 +12,11 @@ const Gitignore = cmp(async function Gitignore(_props: any) {
 node_modules/
 
 # Build output
-dist/
-dist-test/
+#
+# dist/ and dist-test/ are COMMITTED, not ignored: the compiled SDK and the
+# compiled test suite are part of the published repo, so a consumer can read
+# and run them straight from a clone without a build step. Only the
+# incremental-build bookkeeping is ignored.
 *.tsbuildinfo
 
 # Coverage

package/project/.sdk/src/cmp/ts/Main_ts.ts

@@ -4,7 +4,7 @@ import * as Path from 'node:path'
 import {
   cmp, each, names, cmap,
   List, File, Content, Copy, Folder, Fragment, Line, FeatureHook,
-  entityClassName, entityCollection,
+  entityClassName, entityCollection, srcFeatureExcludes,
 } from '@voxgig/sdkgen'
 
 
@@ -43,6 +43,9 @@ const Main = cmp(async function Main(props: any) {
 
   Copy({
     from: 'tm/' + target.name,
+    // Root copies src/feature/<name>/ per ACTIVE feature; keep this blanket
+    // copy from restoring one that was switched off after `target add`.
+    exclude: srcFeatureExcludes(model),
     replace: {
       ...props.ctx$.stdrep,
     }

package/project/.sdk/src/cmp/ts/Package_ts.ts

@@ -11,6 +11,7 @@ import {
   repoInfo,
   PUBLISHER,
   PUBLISHER_URL,
+  packageVersion,
 } from '@voxgig/sdkgen'
 
 
@@ -54,7 +55,7 @@ const Package = cmp(async function Package(props: any) {
 
   const pkg = {
     name: packageName(model, 'npm'),
-    version: `0.0.1`,
+    version: packageVersion(model, target.name),
     description: pkgDescription(model, target.name),
     keywords: keywords(model),
     homepage: `${repoUrl}#readme`,
@@ -63,6 +64,14 @@ const Package = cmp(async function Package(props: any) {
     main: `dist/${SdkName}SDK.js`,
     type: 'commonjs',
     types: `dist/${SdkName}SDK.d.ts`,
+
+    // What actually ships. Without `files`, `npm publish` packs everything
+    // not gitignored — the test suite, dist-test/, the Makefile, the agent
+    // guides — into the published tarball. `src` IS included: the emitted
+    // .js.map files point back at it, so shipping it is what makes stack
+    // traces in a consumer resolve to SDK source. README/LICENSE/package.json
+    // are always included by npm and need no entry.
+    files: ['dist', 'src'],
     scripts: {
       // `test` and `test-coverage` run the COMPILED suite in dist-test/, which
       // a fresh clone does not have — the glob then matches nothing and the

package/project/.sdk/src/cmp/ts/ReadmeEntity_ts.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, canonToType, entityIdField, opRequestShape, safeVarName, exampleVarName, jsKey } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, entityIdField, opRequestShape, safeVarName, exampleVarName, jsKey, matchArg, idLiteral } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -12,6 +12,17 @@ import { exampleValue } from './utility_ts'
 // Operation method spelling differs between Go and other languages — Go
 // uses PascalCase methods with explicit ctrl arg, others use lowercase
 // methods with optional ctrl. The op descriptions are language-agnostic.
+// A `list()` on a NESTED entity needs its parent path params. The
+// quickstart used to emit `client.Moon().list()` for an entity at
+// `/planet/{planet_id}/moon`, which 404s against a live server from a
+// half-built URL — indistinguishable from "no such record". The model
+// already marks those params `reqd: true`; matchArg renders exactly them.
+function listMatchArg(ent: any): string {
+  const idF = entityIdField(ent)
+  return matchArg('ts', ent, 'list', idF, idLiteral(ent, 'list', idF))
+}
+
+
 const OP_DESC: Record<string, { method: string, desc: string }> = {
   load:   { method: 'load(match)',   desc: 'Load a single entity by match criteria.' },
   list:   { method: 'list(match)',   desc: 'List entities matching the criteria.' },
@@ -124,7 +135,7 @@ const ${eVar} = await client.${entity.Name}().load(${loadArg})
       Content(`#### Example: List
 
 \`\`\`ts
-const ${eVar}s = await client.${entity.Name}().list()
+const ${eVar}s = await client.${entity.Name}().list(${listMatchArg(entity)})
 \`\`\`
 
 `)

package/project/.sdk/src/cmp/ts/ReadmeHowto_ts.ts

@@ -67,7 +67,8 @@ const ReadmeHowto = cmp(function ReadmeHowto(props: any) {
   // A direct()-only SDK (no ops anywhere) shows a direct() test call instead.
   const testModeExample = primaryOp
     ? `const ${eVar} = await client.${eName}().${primaryOp}(${testCallArg})
-// ${eVar} is a bare entity populated with mock response data
+// ${eVar} is the entity, populated with mock response data
+// — call ${eVar}.data() for the record itself
 console.log(${eVar})`
     : `const result = await client.direct({ path: '/api/resource', method: 'GET' })
 console.log(result)`

package/project/.sdk/src/cmp/ts/ReadmeQuick_ts.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, isAuthActive, packageName, envName, opRequestShape, entityIdField, entityDataIdField, entityOps, safeVarName, exampleVarName, jsKey } from '@voxgig/sdkgen'
+import { cmp, each, Content, isAuthActive, packageName, envName, opRequestShape, entityIdField, entityDataIdField, entityOps, safeVarName, exampleVarName, jsKey, matchArg, idLiteral } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -10,6 +10,17 @@ import {
 import { exampleValue } from './utility_ts'
 
 
+// A `list()` on a NESTED entity needs its parent path params. The
+// quickstart used to emit `client.Moon().list()` for an entity at
+// `/planet/{planet_id}/moon`, which 404s against a live server from a
+// half-built URL — indistinguishable from "no such record". The model
+// already marks those params `reqd: true`; matchArg renders exactly them.
+function listMatchArg(ent: any): string {
+  const idF = entityIdField(ent)
+  return matchArg('ts', ent, 'list', idF, idLiteral(ent, 'list', idF))
+}
+
+
 const ReadmeQuick = cmp(function ReadmeQuick(props: any) {
   const { target, ctx$: { model } } = props
 
@@ -63,10 +74,12 @@ const client = ${ctor}
     if (opnames.includes('list')) {
       Content(`### 2. List ${eName.toLowerCase()} records
 
-\`list()\` resolves to an array of ${eName} objects — iterate it directly:
+\`list()\` resolves to an array of ${eName} ENTITIES — every operation
+resolves to entities, not raw records. Iterate them directly, and call
+\`.data()\` on one for the record it holds:
 
 \`\`\`ts
-const ${eVar}s = await client.${eName}().list()
+const ${eVar}s = await client.${eName}().list(${listMatchArg(exampleEntity)})
 
 for (const ${eVar} of ${eVar}s) {
   console.log(${eVar})
@@ -195,8 +208,10 @@ try {
         const matchType = matchItem ? matchItem.type : null
         return null == matchType || null == dataIdType || matchType === dataIdType
       }
+      // `create` resolves to the ENTITY, so the id is reached through
+      // `.data()` — `created.id` is a TS2339 on the entity class.
       const idValueFor = (opname: string): string => usesCreatedId(opname)
-        ? `created.${dataIdF}!`
+        ? `created.data().${dataIdF}!`
         : exampleValue(exampleEntity, exampleEntity.op[opname], idF as string, 'example_id')
 
       Content(`### 4. Create, update, and remove
@@ -206,7 +221,7 @@ try {
       if (opnames.includes('create')) {
         const createLines = exampleFields('create')
         const createBody = createLines.length ? '\n' + createLines.join('\n') + '\n' : ''
-        Content(`// Create — returns the created ${eName}
+        Content(`// Create — returns the created ${eName} ENTITY (.data() for the record)
 const created = await client.${eName}().create({${createBody}})
 
 `)
@@ -216,7 +231,7 @@ const created = await client.${eName}().create({${createBody}})
         // type carries one, else a literal), plus a couple of patch fields.
         const updateLines = (idF ? [`  ${idF}: ${idValueFor('update')},`] : []).concat(exampleFields('update'))
         const updateBody = updateLines.length ? '\n' + updateLines.join('\n') + '\n' : ''
-        Content(`// Update${usesCreatedId('update') ? ' — the id comes straight off the returned entity' : ''}
+        Content(`// Update${usesCreatedId('update') ? ' — the id comes off the returned entity\'s data()' : ''}
 const updated = await client.${eName}().update({${updateBody}})
 
 `)

package/project/.sdk/src/cmp/ts/ReadmeRef_ts.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, canonToType, File, isAuthActive, entityIdField, opRequestShape, safeVarName, exampleVarName, jsKey } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, File, isAuthActive, entityIdField, entityActions, opRequestShape, safeVarName, exampleVarName, jsKey, matchArg, idLiteral } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -9,6 +9,17 @@ import {
 import { exampleValue } from './utility_ts'
 
 
+// A `list()` on a NESTED entity needs its parent path params. The
+// quickstart used to emit `client.Moon().list()` for an entity at
+// `/planet/{planet_id}/moon`, which 404s against a live server from a
+// half-built URL — indistinguishable from "no such record". The model
+// already marks those params `reqd: true`; matchArg renders exactly them.
+function listMatchArg(ent: any): string {
+  const idF = entityIdField(ent)
+  return matchArg('ts', ent, 'list', idF, idLiteral(ent, 'list', idF))
+}
+
+
 const OP_SIGNATURES: Record<string, { sig: string, returns: string, desc: string }> = {
   load: {
     sig: 'load(match: object, ctrl?: object)',
@@ -254,6 +265,45 @@ const ${eVar} = client.${ent.Name}()
       }
 
 
+      // Custom actions.
+      //
+      // A POST route like `/api/planet/{id}/terraform` is folded into the
+      // `create` op as an alternative point, selected at call time by
+      // `$action`. The mechanism was implemented and documented NOWHERE — so
+      // for an API with two such routes, two of its six endpoints were
+      // unreachable by anyone reading the docs. A user who wanted `terraform`
+      // had to fall back to `direct()` and rebuild the URL by hand, which is
+      // exactly what the entity model exists to spare them.
+      const actions = entityActions(ent)
+      if (0 < actions.length) {
+        Content(`### Actions
+
+This entity exposes custom API actions in addition to the standard
+operations. Select one with \`$action\` in the call's argument; the
+remaining keys are sent as that action's payload.
+
+| Action | Route | Call |
+| --- | --- | --- |
+`)
+        actions.forEach((a: any) => {
+          Content(`| \`${a.action}\` | \`${a.path}\` | \`client.${ent.Name}().${a.op}({ $action: '${a.action}', ... })\` |
+`)
+        })
+
+        Content(`
+An action returns that action's OWN response, which is not necessarily a
+${ent.Name} record — check the API definition for its shape.
+
+\`\`\`ts
+const result = await client.${ent.Name}().${actions[0].op}({
+  $action: '${actions[0].action}',
+  /* ...the action's own arguments */
+})
+\`\`\`
+
+`)
+      }
+
       // Operation details
       if (opnames.length > 0) {
         Content(`### Operations
@@ -292,7 +342,7 @@ const result = await client.${ent.Name}().${opname}(${arg})
           }
           else if ('list' === opname) {
             Content(`\`\`\`ts
-const results = await client.${ent.Name}().${opname}()
+const results = await client.${ent.Name}().${opname}(${listMatchArg(ent)})
 \`\`\`
 
 `)

package/project/.sdk/src/cmp/ts/ReadmeTopQuick_ts.ts

@@ -1,5 +1,5 @@
 
-import { cmp, Content, isAuthActive, packageName, envName, entityIdField, entityOps, opRequestShape, safeVarName, exampleVarName, jsKey } from '@voxgig/sdkgen'
+import { cmp, Content, isAuthActive, packageName, envName, entityIdField, entityOps, opRequestShape, safeVarName, exampleVarName, jsKey, matchArg, idLiteral } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -10,6 +10,17 @@ import {
 import { exampleValue } from './utility_ts'
 
 
+// A `list()` on a NESTED entity needs its parent path params. The
+// quickstart used to emit `client.Moon().list()` for an entity at
+// `/planet/{planet_id}/moon`, which 404s against a live server from a
+// half-built URL — indistinguishable from "no such record". The model
+// already marks those params `reqd: true`; matchArg renders exactly them.
+function listMatchArg(ent: any): string {
+  const idF = entityIdField(ent)
+  return matchArg('ts', ent, 'list', idF, idLiteral(ent, 'list', idF))
+}
+
+
 const ReadmeTopQuick = cmp(function ReadmeTopQuick(props: any) {
   const { target, ctx$: { model } } = props
 
@@ -36,8 +47,8 @@ const client = ${ctor}
     let hasCall = false
 
     if (opnames.includes('list')) {
-      Content(`// List all ${eName.toLowerCase()}s (returns ${eName}[])
-const ${eVar}s = await client.${eName}().list()
+      Content(`// List all ${eName.toLowerCase()}s (returns ${eName}Entity[] — .data() for the record)
+const ${eVar}s = await client.${eName}().list(${listMatchArg(exampleEntity)})
 for (const ${eVar} of ${eVar}s) {
   console.log(${eVar})
 }

package/project/.sdk/src/cmp/ts/ReadmeTopTest_ts.ts

@@ -18,8 +18,39 @@ const ReadmeTopTest = cmp(function ReadmeTopTest(props: any) {
   // `load` on an op-less entity like Cloudsmith's `Abort`.
   const { entity: exampleEntity, primaryOp } = pickExampleEntity(entity)
 
+  // The mock SEEDS NOTHING on its own.
+  //
+  // `SDK.test()` with no argument used to be shown alongside "populated with
+  // mock data" — and returned an empty array. The seed shape
+  // (`{ entity: { <name>: { <id>: {...} } } }`) was documented nowhere; the
+  // only way to find it was to read TestFeature.ts. Offline test mode is a
+  // headline feature of these SDKs, so its one worked example has to run.
+  const seedEntity = exampleEntity ? nom(exampleEntity, 'name') : ''
+  const seedFields = exampleEntity ?
+    opRequestShape(exampleEntity, 'create').items
+      .filter((it: any) => !it.optional)
+      .slice(0, 3) : []
+
+  const seedId = 'test01'
+  const seedBody = [
+    `${jsKey('id')}: '${seedId}'`,
+    ...seedFields
+      .filter((it: any) => 'id' !== it.name)
+      .map((it: any) => `${jsKey(it.name)}: ${exampleValue(
+        exampleEntity, exampleEntity.op && exampleEntity.op.create, it.name,
+        'example_' + it.name)}`),
+  ].join(', ')
+
   Content(`\`\`\`ts
-const client = ${model.const.Name}SDK.test()
+// The offline mock starts EMPTY — seed it with the records the test needs.
+// Shape: { entity: { <entity-name>: { <id>: <record> } } }
+const client = ${model.const.Name}SDK.test({
+  entity: {
+    ${seedEntity}: {
+      ${seedId}: { ${seedBody} },
+    },
+  },
+})
 `)
 
   if (exampleEntity && primaryOp) {
@@ -51,7 +82,8 @@ const client = ${model.const.Name}SDK.test()
         `${jsKey(it.name)}: ${exampleValue(exampleEntity, primaryOpDef, it.name, 'example_' + it.name)}`).join(', ')} }`
     }
     Content(`const ${eVar} = await client.${eName}().${primaryOp}(${arg})
-// ${eVar} is ${'list' === primaryOp ? `an array of bare ${eName} records` : `a bare ${eName}`} populated with mock data
+// ${eVar} is ${'list' === primaryOp ? `an array of ${eName} entities` : `the ${eName} entity`}, populated with mock data
+// — call ${eVar}${'list' === primaryOp ? '[0]' : ''}.data() for the record itself
 console.log(${eVar})
 `)
   }