@voxgig/sdkgen 0.43.0 → 0.45.0

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

@@ -7,7 +7,12 @@ import {
 
 import {
   KIT,
+  Model,
+  ModelEntity,
+  ModelEntityFlow,
+  ModelEntityFlowStep,
   getModelPath,
+  nom,
 } from '@voxgig/apidef'
 
 
@@ -18,6 +23,7 @@ import {
   each,
   buildIdNames,
   getMatchEntries,
+  isAuthActive,
 } from '@voxgig/sdkgen'
 
 
@@ -27,33 +33,42 @@ function goVar(name: string): string {
 }
 
 
-type OpGen = (ctx: GenCtx, step: any, index: any) => void
-
+// Go's GenCtx mirrors the shared shape (see TestEntity_ts.ts) plus a
+// `gomodule` slot used to build qualified package paths in emitted code.
 type GenCtx = {
-  model: any
-  entity: any
+  model: Model
+  entity: ModelEntity
   gomodule: string
-  flow: any
+  flow: ModelEntityFlow
   PROJUPPER: string
 }
 
+type OpGen = (ctx: GenCtx, step: ModelEntityFlowStep, index: number) => void
+
 
 const TestEntity = cmp(function TestEntity(props: any) {
   const ctx$ = props.ctx$
-  const model = ctx$.model
+  const model: Model = ctx$.model
 
   const target = props.target
-  const entity = props.entity
-  const gomodule = props.gomodule
-
-  const basicflow = getModelPath(model, `main.${KIT}.flow.Basic${entity.Name}Flow`)
-  const dobasic = basicflow && true === basicflow.active
+  const entity: ModelEntity = props.entity
+  const gomodule: string = props.gomodule
 
-  if (!dobasic) {
+  const basicflow: ModelEntityFlow | undefined =
+    getModelPath(model, `main.${KIT}.flow.Basic${nom(entity, 'Name')}Flow`)
+  if (null == basicflow || true !== basicflow.active) {
     return
   }
 
-  const PROJUPPER = model.const.Name.toUpperCase().replace(/[^A-Z_]/g, '_')
+  const PROJUPPER = nom(model.const, 'Name').toUpperCase().replace(/[^A-Z_]/g, '_')
+
+  const authActive = isAuthActive(model)
+  const apikeyEnvEntry = authActive
+    ? `\n\t\t"${PROJUPPER}_APIKEY":         "NONE",`
+    : ''
+  const apikeyLiveField = authActive
+    ? `\n\t\t\t\t"apikey": env["${PROJUPPER}_APIKEY"],`
+    : ''
 
   const idnames = buildIdNames(entity, basicflow)
   const idnamesStr = idnames.map(n => `"${n}"`).join(', ')
@@ -72,7 +87,7 @@ const TestEntity = cmp(function TestEntity(props: any) {
   // when no step needs it, otherwise Go's strict unused-import check fails.
   const needsFmt = allSteps.some((s: any) =>
     s.op === 'update' &&
-    s.input?.textfield &&
+    s.input.textfield &&
     Array.isArray(s.spec) &&
     s.spec.some((sp: any) => sp.apply === 'TextFieldMark'))
 
@@ -181,8 +196,7 @@ ${allSteps.length > 0 ? '\t\tclient := setup.client\n\n' : ''}`)
 	env := envOverride(map[string]any{
 		"${PROJUPPER}_TEST_${entity.name.toUpperCase().replace(/[^A-Z_]/g, '_')}_ENTID": idmap,
 		"${PROJUPPER}_TEST_LIVE":      "FALSE",
-		"${PROJUPPER}_TEST_EXPLAIN":   "FALSE",
-		"${PROJUPPER}_APIKEY":         "NONE",
+		"${PROJUPPER}_TEST_EXPLAIN":   "FALSE",${apikeyEnvEntry}
 	})
 
 	idmapResolved := core.ToMapAny(env["${PROJUPPER}_TEST_${entity.name.toUpperCase().replace(/[^A-Z_]/g, '_')}_ENTID"])
@@ -203,8 +217,7 @@ ${allSteps.length > 0 ? '\t\tclient := setup.client\n\n' : ''}`)
     Content(`
 	if env["${PROJUPPER}_TEST_LIVE"] == "TRUE" {
 		mergedOpts := vs.Merge([]any{
-			map[string]any{
-				"apikey": env["${PROJUPPER}_APIKEY"],
+			map[string]any{${apikeyLiveField}
 			},
 			extra,
 		})
@@ -227,9 +240,9 @@ ${allSteps.length > 0 ? '\t\tclient := setup.client\n\n' : ''}`)
 
 const generateCreate: OpGen = (ctx, step, index) => {
   const { entity, flow } = ctx
-  const ref = step.input?.ref ?? entity.name + '_ref01'
-  const entvar = goVar(step.input?.entvar ?? ref + '_ent')
-  const datavar = goVar(step.input?.datavar ?? (ref + '_data' + (step.input?.suffix ?? '')))
+  const ref = step.input.ref ?? entity.name + '_ref01'
+  const entvar = goVar(step.input.entvar ?? ref + '_ent')
+  const datavar = goVar(step.input.datavar ?? (ref + '_data' + (step.input.suffix ?? '')))
 
   const priorSteps = Object.values(flow.step).slice(0, Number(index)) as any[]
   const needsEnt = !priorSteps.some((s: any) =>
@@ -237,8 +250,8 @@ const generateCreate: OpGen = (ctx, step, index) => {
 
   const hasDatvar = priorSteps.some((s: any) => {
     if ('create' === s.op) {
-      const priorRef = s.input?.ref ?? entity.name + '_ref01'
-      const priorDatvar = goVar(s.input?.datavar ?? (priorRef + '_data' + (s.input?.suffix ?? '')))
+      const priorRef = s.input.ref ?? entity.name + '_ref01'
+      const priorDatvar = goVar(s.input.datavar ?? (priorRef + '_data' + (s.input.suffix ?? '')))
       return priorDatvar === datavar
     }
     return false
@@ -278,19 +291,22 @@ const generateCreate: OpGen = (ctx, step, index) => {
 		if ${datavar} == nil {
 			t.Fatal("expected create result to be a map")
 		}
-		if ${datavar}["id"] == nil {
+`)
+  if (null != ctx.entity.id) {
+    Content(`		if ${datavar}["id"] == nil {
 			t.Fatal("expected created entity to have an id")
 		}
 `)
+  }
 }
 
 
 const generateList: OpGen = (ctx, step, index) => {
   const { entity, flow } = ctx
-  const ref = step.input?.ref ?? entity.name + '_ref01'
-  const entvar = goVar(step.input?.entvar ?? ref + '_ent')
-  const matchvar = goVar(step.input?.matchvar ?? (ref + '_match' + (step.input?.suffix ?? '')))
-  const listvar = goVar(step.input?.listvar ?? (ref + '_list' + (step.input?.suffix ?? '')))
+  const ref = step.input.ref ?? entity.name + '_ref01'
+  const entvar = goVar(step.input.entvar ?? ref + '_ent')
+  const matchvar = goVar(step.input.matchvar ?? (ref + '_match' + (step.input.suffix ?? '')))
+  const listvar = goVar(step.input.listvar ?? (ref + '_list' + (step.input.suffix ?? '')))
 
   const priorSteps = Object.values(flow.step).slice(0, Number(index)) as any[]
   const needsEnt = !priorSteps.some((s: any) =>
@@ -326,7 +342,7 @@ const generateList: OpGen = (ctx, step, index) => {
     if ('ItemExists' !== v.apply && 'ItemNotExists' !== v.apply) return false
     const validRef = v.def?.ref
     return validRef && allSteps.some((s: any) => 'create' === s.op &&
-      ((s.input?.ref ?? entity.name + '_ref01') === validRef))
+      ((s.input.ref ?? entity.name + '_ref01') === validRef))
   })
   const listvarBind = listvarUsed ? listvar : '_'
 
@@ -349,7 +365,7 @@ const generateList: OpGen = (ctx, step, index) => {
     for (const validator of step.valid) {
       const validRef = validator.def?.ref
       const hasRefData = validRef && allSteps.some((s: any) => 'create' === s.op &&
-        ((s.input?.ref ?? entity.name + '_ref01') === validRef))
+        ((s.input.ref ?? entity.name + '_ref01') === validRef))
 
       if ('ItemExists' === validator.apply && hasRefData) {
         const refDataVar = goVar(validRef + '_data')
@@ -375,17 +391,19 @@ const generateList: OpGen = (ctx, step, index) => {
 
 const generateUpdate: OpGen = (ctx, step, index) => {
   const { entity, flow } = ctx
-  const ref = step.input?.ref ?? entity.name + '_ref01'
-  const entvar = goVar(step.input?.entvar ?? ref + '_ent')
-  const datavar = goVar(step.input?.datavar ?? (ref + '_data' + (step.input?.suffix ?? '')))
-  const resdatavar = goVar(step.input?.resdatavar ?? (ref + '_resdata' + (step.input?.suffix ?? '')))
-  const markdefvar = goVar(step.input?.markdefvar ?? (ref + '_markdef' + (step.input?.suffix ?? '')))
-  const srcdatavar = goVar(step.input?.srcdatavar ?? (ref + '_data' + (step.input?.suffix ?? '')))
+  const ref = step.input.ref ?? entity.name + '_ref01'
+  const entvar = goVar(step.input.entvar ?? ref + '_ent')
+  const datavar = goVar(step.input.datavar ?? (ref + '_data' + (step.input.suffix ?? '')))
+  const resdatavar = goVar(step.input.resdatavar ?? (ref + '_resdata' + (step.input.suffix ?? '')))
+  const markdefvar = goVar(step.input.markdefvar ?? (ref + '_markdef' + (step.input.suffix ?? '')))
+  const srcdatavar = goVar(step.input.srcdatavar ?? (ref + '_data' + (step.input.suffix ?? '')))
 
   const priorSteps = Object.values(flow.step).slice(0, Number(index)) as any[]
   const needsEnt = !priorSteps.some((s: any) =>
     ['create', 'list', 'load', 'update', 'remove'].includes(s.op))
 
+  const hasEntIdU = null != entity.id
+
   Content(`		// UPDATE
 `)
   if (needsEnt) {
@@ -393,8 +411,11 @@ const generateUpdate: OpGen = (ctx, step, index) => {
 `)
   }
   Content(`		${datavar}Up := map[string]any{
-			"id": ${srcdatavar}["id"],
 `)
+  if (hasEntIdU) {
+    Content(`			"id": ${srcdatavar}["id"],
+`)
+  }
 
   // Add data entries from step.data
   if (step.data) {
@@ -411,7 +432,7 @@ const generateUpdate: OpGen = (ctx, step, index) => {
   // Handle TextFieldMark spec
   if (step.spec) {
     for (const spec of step.spec) {
-      if ('TextFieldMark' === spec.apply && null != step.input?.textfield) {
+      if ('TextFieldMark' === spec.apply && null != step.input.textfield) {
         const fieldname = step.input.textfield
         const fieldvalue = spec.def?.mark ?? `Mark01-${ref}`
         Content(`
@@ -432,15 +453,18 @@ const generateUpdate: OpGen = (ctx, step, index) => {
 		if ${resdatavar} == nil {
 			t.Fatal("expected update result to be a map")
 		}
-		if ${resdatavar}["id"] != ${datavar}Up["id"] {
+`)
+  if (hasEntIdU) {
+    Content(`		if ${resdatavar}["id"] != ${datavar}Up["id"] {
 			t.Fatal("expected update result id to match")
 		}
 `)
+  }
 
   // Assert TextFieldMark
   if (step.spec) {
     for (const spec of step.spec) {
-      if ('TextFieldMark' === spec.apply && null != step.input?.textfield) {
+      if ('TextFieldMark' === spec.apply && null != step.input.textfield) {
         Content(`		if ${resdatavar}[${markdefvar}Name] != ${markdefvar}Value {
 			t.Fatalf("expected %s to be updated, got %v", ${markdefvar}Name, ${resdatavar}[${markdefvar}Name])
 		}
@@ -453,11 +477,11 @@ const generateUpdate: OpGen = (ctx, step, index) => {
 
 const generateLoad: OpGen = (ctx, step, index) => {
   const { entity, flow } = ctx
-  const ref = step.input?.ref ?? entity.name + '_ref01'
-  const entvar = goVar(step.input?.entvar ?? ref + '_ent')
-  const matchvar = goVar(step.input?.matchvar ?? (ref + '_match' + (step.input?.suffix ?? '')))
-  const datavar = goVar(step.input?.datavar ?? (ref + '_data' + (step.input?.suffix ?? '')))
-  const srcdatavar = goVar(step.input?.srcdatavar ?? (ref + '_data' + (step.input?.suffix ?? '')))
+  const ref = step.input.ref ?? entity.name + '_ref01'
+  const entvar = goVar(step.input.entvar ?? ref + '_ent')
+  const matchvar = goVar(step.input.matchvar ?? (ref + '_match' + (step.input.suffix ?? '')))
+  const datavar = goVar(step.input.datavar ?? (ref + '_data' + (step.input.suffix ?? '')))
+  const srcdatavar = goVar(step.input.srcdatavar ?? (ref + '_data' + (step.input.suffix ?? '')))
 
   const priorSteps = Object.values(flow.step).slice(0, Number(index)) as any[]
   const hasEntVar = priorSteps.some((s: any) =>
@@ -469,20 +493,22 @@ const generateLoad: OpGen = (ctx, step, index) => {
   const hasSrcData = (!flowHasCreate && srcdatavar === goVar(preambleRef + '_data')) ||
     priorSteps.some((s: any) => {
       if ('create' === s.op) {
-        const priorRef = s.input?.ref ?? entity.name + '_ref01'
-        const priorDatvar = goVar(s.input?.datavar ?? (priorRef + '_data' + (s.input?.suffix ?? '')))
+        const priorRef = s.input.ref ?? entity.name + '_ref01'
+        const priorDatvar = goVar(s.input.datavar ?? (priorRef + '_data' + (s.input.suffix ?? '')))
         return priorDatvar === srcdatavar
       }
       return false
     })
 
+  const hasEntId = null != entity.id
+
   Content(`		// LOAD
 `)
   if (!hasEntVar) {
     Content(`		${entvar} := client.${entity.Name}(nil)
 `)
   }
-  if (!hasSrcData) {
+  if (!hasSrcData && hasEntId) {
     Content(`		${srcdatavar}Raw := vs.Items(core.ToMapAny(vs.GetPath("existing.${entity.name}", setup.data)))
 		var ${srcdatavar} map[string]any
 		if len(${srcdatavar}Raw) > 0 {
@@ -490,7 +516,8 @@ const generateLoad: OpGen = (ctx, step, index) => {
 		}
 `)
   }
-  Content(`		${matchvar} := map[string]any{
+  if (hasEntId) {
+    Content(`		${matchvar} := map[string]any{
 			"id": ${srcdatavar}["id"],
 		}
 		${datavar}Loaded, err := ${entvar}.Load(${matchvar}, nil)
@@ -505,15 +532,27 @@ const generateLoad: OpGen = (ctx, step, index) => {
 			t.Fatal("expected load result id to match")
 		}
 `)
+  }
+  else {
+    Content(`		${matchvar} := map[string]any{}
+		${datavar}Loaded, err := ${entvar}.Load(${matchvar}, nil)
+		if err != nil {
+			t.Fatalf("load failed: %v", err)
+		}
+		if ${datavar}Loaded == nil {
+			t.Fatal("expected load result to be non-nil")
+		}
+`)
+  }
 }
 
 
 const generateRemove: OpGen = (ctx, step, index) => {
   const { entity, flow } = ctx
-  const ref = step.input?.ref ?? entity.name + '_ref01'
-  const entvar = goVar(step.input?.entvar ?? ref + '_ent')
-  const matchvar = goVar(step.input?.matchvar ?? (ref + '_match' + (step.input?.suffix ?? '')))
-  const srcdatavar = goVar(step.input?.srcdatavar ?? (ref + '_data'))
+  const ref = step.input.ref ?? entity.name + '_ref01'
+  const entvar = goVar(step.input.entvar ?? ref + '_ent')
+  const matchvar = goVar(step.input.matchvar ?? (ref + '_match' + (step.input.suffix ?? '')))
+  const srcdatavar = goVar(step.input.srcdatavar ?? (ref + '_data'))
 
   const priorSteps = Object.values(flow.step).slice(0, Number(index)) as any[]
   const needsEnt = !priorSteps.some((s: any) =>
@@ -523,13 +562,16 @@ const generateRemove: OpGen = (ctx, step, index) => {
   // otherwise reuse the `err` from a prior op step.
   const errOp = needsEnt ? ':=' : '='
 
+  const hasEntIdR = null != entity.id
+
   Content(`		// REMOVE
 `)
   if (needsEnt) {
     Content(`		${entvar} := client.${entity.Name}(nil)
 `)
   }
-  Content(`		${matchvar} := map[string]any{
+  if (hasEntIdR) {
+    Content(`		${matchvar} := map[string]any{
 			"id": ${srcdatavar}["id"],
 		}
 		_, err ${errOp} ${entvar}.Remove(${matchvar}, nil)
@@ -537,6 +579,15 @@ const generateRemove: OpGen = (ctx, step, index) => {
 			t.Fatalf("remove failed: %v", err)
 		}
 `)
+  }
+  else {
+    Content(`		${matchvar} := map[string]any{}
+		_, err ${errOp} ${entvar}.Remove(${matchvar}, nil)
+		if err != nil {
+			t.Fatalf("remove failed: %v", err)
+		}
+`)
+  }
 }
 
 

package/project/.sdk/src/cmp/js/Config_js.ts

@@ -10,6 +10,7 @@ import {
   cmp,
   each,
   indent,
+  isAuthActive,
 } from '@voxgig/sdkgen'
 
 
@@ -40,6 +41,21 @@ const Config = cmp(async function Config(props: any) {
 
   const headers = getModelPath(model, `main.${KIT}.config.headers`) || {}
 
+  const authActive = isAuthActive(model)
+  let authPrefix = 'Bearer'
+  try {
+    const v = getModelPath(model, `main.${KIT}.config.auth.prefix`,
+      { only_active: false, required: false })
+    if (null != v) authPrefix = v
+  } catch (_e) { /* ignore */ }
+  const authBlock = authActive
+    ? `auth: {
+      prefix: '${authPrefix}',
+    },
+
+    `
+    : ''
+
   File({ name: 'Config.' + target.ext }, () => {
 
     Fragment({
@@ -47,6 +63,8 @@ const Config = cmp(async function Config(props: any) {
 
       replace: {
 
+        "'AUTHBLOCK'": authBlock,
+
         "'HEADERS'": indent(JSON.stringify(headers, null, 2), 4).trim(),
 
         '// #ImportFeatures': () => each(feature, (f: any) => {

package/project/.sdk/src/cmp/js/Gitignore_js.ts

@@ -0,0 +1,35 @@
+
+import {
+  Content,
+  File,
+  cmp,
+} from '@voxgig/sdkgen'
+
+
+const Gitignore = cmp(async function Gitignore(_props: any) {
+  File({ name: '.gitignore' }, () => {
+    Content(`# Dependencies
+node_modules/
+
+# Build output
+dist/
+
+# Coverage
+coverage/
+
+# Logs
+*.log
+npm-debug.log*
+
+# IDE / OS
+.idea/
+.vscode/
+.DS_Store
+`)
+  })
+})
+
+
+export {
+  Gitignore
+}

package/project/.sdk/src/cmp/js/Main_js.ts

@@ -20,6 +20,7 @@ import {
 
 import { Package } from './Package_js'
 import { Config } from './Config_js'
+import { Gitignore } from './Gitignore_js'
 import { MainEntity } from './MainEntity_js'
 import { SdkError } from './SdkError_js'
 import { EntityBase } from './EntityBase_js'
@@ -36,6 +37,8 @@ const Main = cmp(async function Main(props: any) {
 
   Package({ target })
 
+  Gitignore({})
+
   Copy({
     from: 'tm/' + target.name,
     replace: {

package/project/.sdk/src/cmp/js/ReadmeEntity_js.ts

@@ -0,0 +1,138 @@
+
+import { cmp, each, Content } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+
+// 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.
+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.' },
+  create: { method: 'create(data)',  desc: 'Create a new entity with the given data.' },
+  update: { method: 'update(data)',  desc: 'Update an existing entity.' },
+  remove: { method: 'remove(match)', desc: 'Remove the matching entity.' },
+}
+
+
+const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
+  const { target } = props
+  const { model } = props.ctx$
+
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+
+  const publishedEntities = each(entity)
+    .filter((entity: any) => entity.active !== false)
+
+  if (0 === publishedEntities.length) {
+    return
+  }
+
+  Content(`
+
+## Entities
+
+`)
+
+  publishedEntities.map((entity: any) => {
+    const opnames = Object.keys(entity.op || {})
+    const fields = entity.fields || []
+
+    Content(`
+### ${entity.Name}
+
+`)
+
+    if (entity.short) {
+      Content(`${entity.short}
+
+`)
+    }
+
+    Content(`Create an instance: \`const ${entity.name} = client.${entity.Name}()\`
+
+`)
+
+    if (opnames.length > 0) {
+      Content(`#### Operations
+
+| Method | Description |
+| --- | --- |
+`)
+      opnames.map((opname: string) => {
+        const info = OP_DESC[opname]
+        if (info) {
+          Content(`| \`${info.method}\` | ${info.desc} |
+`)
+        }
+      })
+
+      Content(`
+`)
+    }
+
+    if (fields.length > 0) {
+      Content(`#### Fields
+
+| Field | Type | Description |
+| --- | --- | --- |
+`)
+
+      each(fields, (field: any) => {
+        const desc = field.short || ''
+        Content(`| \`${field.name}\` | \`${field.type || 'any'}\` | ${desc} |
+`)
+      })
+
+      Content(`
+`)
+    }
+
+    if (opnames.includes('load')) {
+      Content(`#### Example: Load
+
+\`\`\`ts
+const ${entity.name} = await client.${entity.Name}().load({ id: '${entity.name}_id' })
+\`\`\`
+
+`)
+    }
+
+    if (opnames.includes('list')) {
+      Content(`#### Example: List
+
+\`\`\`ts
+const ${entity.name}s = await client.${entity.Name}().list()
+\`\`\`
+
+`)
+    }
+
+    if (opnames.includes('create')) {
+      Content(`#### Example: Create
+
+\`\`\`ts
+const ${entity.name} = await client.${entity.Name}().create({
+`)
+      each(fields, (field: any) => {
+        if ('id' !== field.name && field.req) {
+          Content(`  ${field.name}: /* ${field.type || 'value'} */,
+`)
+        }
+      })
+      Content(`})
+\`\`\`
+
+`)
+    }
+  })
+})
+
+
+export {
+  ReadmeEntity
+}

package/project/.sdk/src/cmp/js/ReadmeHowto_js.ts

@@ -1,5 +1,5 @@
 
-import { cmp, Content } from '@voxgig/sdkgen'
+import { cmp, Content, isAuthActive } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -10,6 +10,13 @@ import {
 const ReadmeHowto = cmp(function ReadmeHowto(props: any) {
   const { target, ctx$: { model } } = props
 
+  const authActive = isAuthActive(model)
+  const apikeyTesterCtor = authActive
+    ? `new ${model.const.Name}SDK({ apikey: '...' })`
+    : `new ${model.const.Name}SDK()`
+  const apikeyExtendField = authActive ? `\n  apikey: '...',` : ''
+  const apikeyEnvLine = authActive ? `\n${model.NAME}_APIKEY=<your-key>` : ''
+
   Content(`### Make a direct HTTP request
 
 For endpoints not covered by entity methods:
@@ -57,7 +64,7 @@ const result = await client.Planet().load({ id: 'test01' })
 You can also use the instance method:
 
 \`\`\`js
-const client = new ${model.const.Name}SDK({ apikey: '...' })
+const client = ${apikeyTesterCtor}
 const testClient = client.tester()
 \`\`\`
 
@@ -92,8 +99,7 @@ const logger = {
   },
 }
 
-const client = new ${model.const.Name}SDK({
-  apikey: '...',
+const client = new ${model.const.Name}SDK({${apikeyExtendField}
   extend: [logger],
 })
 \`\`\`
@@ -103,8 +109,7 @@ const client = new ${model.const.Name}SDK({
 Create a \`.env.local\` file at the project root:
 
 \`\`\`
-${model.NAME}_TEST_LIVE=TRUE
-${model.NAME}_APIKEY=<your-key>
+${model.NAME}_TEST_LIVE=TRUE${apikeyEnvLine}
 \`\`\`
 
 Then run:

package/project/.sdk/src/cmp/js/ReadmeIntro_js.ts

@@ -0,0 +1,18 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+
+const ReadmeIntro = cmp(function ReadmeIntro(props: any) {
+  const { target, ctx$: { model } } = props
+
+  Content(`# ${model.Name} ${target.title} SDK
+
+The ${target.title} SDK for the ${model.Name} API. Provides an entity-oriented interface with full async/await support.
+
+`)
+})
+
+
+export {
+  ReadmeIntro
+}

package/project/.sdk/src/cmp/js/ReadmeModel_js.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content } from '@voxgig/sdkgen'
+import { cmp, each, Content, isAuthActive } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -13,6 +13,10 @@ const ReadmeModel = cmp(function ReadmeModel(props: any) {
   const entity = getModelPath(model, `main.${KIT}.entity`)
   const entityList = each(entity).filter((e: any) => e.active !== false)
 
+  const apikeyOptionRow = isAuthActive(model)
+    ? '| `apikey` | `string` | API key for authentication. |\n'
+    : ''
+
   Content(`### ${model.const.Name}SDK
 
 #### Constructor
@@ -23,8 +27,7 @@ new ${model.const.Name}SDK(options?)
 
 | Option | Type | Description |
 | --- | --- | --- |
-| \`apikey\` | \`string\` | API key for authentication. |
-| \`base\` | \`string\` | Base URL of the API server. |
+${apikeyOptionRow}| \`base\` | \`string\` | Base URL of the API server. |
 | \`prefix\` | \`string\` | URL path prefix prepended to all requests. |
 | \`suffix\` | \`string\` | URL path suffix appended to all requests. |
 | \`feature\` | \`object\` | Feature activation flags (e.g. \`{ test: { active: true } }\`). |