@voxgig/sdkgen-infrapack 0.0.13 → 0.0.14

package/.sdk/src/cmp/seneca-provider/Main_seneca-provider.ts

@@ -6,6 +6,7 @@ import {
   opRequestShape, opParams, ownPoint, entityPath,
   collectDeps, repoInfo, packageName, packageVersion, apiName, envName,
   authorInfo, contributorList, isAuthActive, isHttpBasicAuth, jsKey, jsProp,
+  resolveAuthIn, resolveAuthName, resolveAuthPrefix,
   SdkGenError,
   PUBLISHER, PUBLISHER_URL,
   pointSegments,
@@ -155,16 +156,27 @@ function idSpec(ent: any): { parts: string[], sep: string, from?: Record<string,
     return null
   }
 
-  return { parts: [rk], sep: idSep(ent) }
+  const from = ent?.id?.from
+  const path = null != from && 'object' === typeof from ? from[rk] : null
+  return {
+    parts: [rk],
+    sep: idSep(ent),
+    ...(null != path && '' !== String(path) ? { from: { [rk]: String(path) } } : {}),
+  }
 }
 
 
+// The model's identifier when the load match carries it, else the terminal
+// path parameter, else a lone required query parameter: the rule the SDK's
+// offline transport keys its store by.
 function recordKey(ent: any): string {
   const idf = entityIdField(ent)
   if (null != idf && '' !== idf) {
     return String(idf)
   }
 
+  let fallback = ''
+
   for (const opname of ['load', 'remove', 'update']) {
     const op = (ent.op || {})[opname]
     if (null == op || 0 === (op.points || []).length) {
@@ -174,11 +186,11 @@ function recordKey(ent: any): string {
     const canonical = op.points.filter((pt: any) =>
       null == (pt && pt.q && pt.q['$action']))
     const point = ownPoint(0 < canonical.length ? canonical : op.points)
-    const vars = pointSegments(point)
-      .filter((seg: any) => null != seg.var)
+    const segs = pointSegments(point)
+    const last = segs[segs.length - 1]
 
-    if (0 < vars.length) {
-      return String(vars[vars.length - 1].var)
+    if (null != last && null != last.var) {
+      return String(last.var)
     }
 
     const query = (point && point.g && point.g.query) || []
@@ -186,9 +198,43 @@ function recordKey(ent: any): string {
     if (1 === reqdQuery.length) {
       return String(reqdQuery[0].n)
     }
+
+    // A literal-terminal route names a facet of a record: a last resort.
+    if ('' === fallback) {
+      const vars = segs.filter((seg: any) => null != seg.var)
+      if (0 < vars.length) {
+        fallback = String(vars[vars.length - 1].var)
+      }
+    }
+  }
+
+  return '' !== fallback ? fallback : 'id'
+}
+
+
+// Does a create have to SEND the record key, or does the API assign it?
+function rkOnCreate(ent: any): boolean {
+  const rk = recordKey(ent)
+
+  if ('id' === rk || 0 < idParts(ent).length || null == (ent.op || {}).create) {
+    return false
   }
 
-  return 'id'
+  return opRequestShape(ent, 'create').items
+    .some((it: any) => it.name === rk && !it.optional)
+}
+
+
+// Is `<provider>_id` free for this entity, or a name it already uses itself?
+function parkFree(ent: any, parked: string): boolean {
+  const taken = new Set<string>([
+    recordKey(ent),
+    ...idParts(ent),
+    ...parentKeys(ent),
+    ...Object.values(ent.fields || {}).map((f: any) => String(f.n)),
+  ])
+
+  return !taken.has(parked)
 }
 
 
@@ -335,6 +381,8 @@ const Main = cmp(function Main(props: any) {
         ops: entityOps(ent),
         idf: entityIdField(ent),
         rk: recordKey(ent),
+        rkoncreate: rkOnCreate(ent),
+        parkfree: parkFree(ent, lower + '_id'),
         // The composite key, when this API addresses a record by several
         // path params at once. The doc and test emitters in Extras need the
         // same answer the handler emitters use: a test that addresses a
@@ -494,6 +542,11 @@ const Main = cmp(function Main(props: any) {
     // plumbing one anyway produces a credential path that cannot work.
     authActive: isAuthActive(model),
     authBasic: isAuthActive(model) && isHttpBasicAuth(model),
+    // Where the credential goes, resolved as the SDK's auth stage does.
+    authIn: resolveAuthIn(model),
+    authName: 'header' === resolveAuthIn(model) ?
+      resolveAuthName(model).toLowerCase() : resolveAuthName(model),
+    authPrefix: resolveAuthPrefix(model),
   }
 
   // `.gitignore` is EMITTED rather than copied — npm strips that filename
@@ -662,6 +715,8 @@ const PackageJson = cmp(function PackageJson(props: any) {
 const ProviderSource = cmp(function ProviderSource(props: any) {
   const { provider } = props
 
+  const translated = provider.entities.filter((e: any) => null != idSpec(e.ent))
+
   Folder({ name: 'src' }, () => {
     File({ name: `${provider.fileBase}.ts` }, () => {
       Content(`/* Generated by @voxgig/sdkgen. Do not edit. */
@@ -760,8 +815,8 @@ function ${provider.pluginName}(this: any, options: ${provider.pluginName}Option
 
 
   // The SDK argument for an ACTION on a read cmd: everything the caller sent
-  // minus Seneca's own directives, with the record key carried across, plus
-  // the \`$action\` selector the SDK dispatches on.
+  // minus Seneca's own directives, with the id translated into the API's own
+  // keys, plus the \`$action\` selector the SDK dispatches on.
   //
   // WIDER than the canonical argument on purpose. An action route has its own
   // parameters — GitHub's merge takes commit_title and merge_method, which the
@@ -769,14 +824,21 @@ function ${provider.pluginName}(this: any, options: ${provider.pluginName}Option
   // required keys would strip the action's whole payload. The SDK still
   // validates: an action whose own point cannot be built is refused with
   // \`point_action_invalid\` rather than sent somewhere else.
-  function actionq(q: any, rk: string, action: string) {
+  function actionq(q: any, ${0 === translated.length ? '' : 'name: string, '}action: string) {
     const out = cleanq(q)
+${0 === translated.length ? '' : `
+    // An action addresses the SAME record the canonical route does, so the id
+    // is translated the same way a write translates it: split into the path
+    // parameters the API names, under the names it names them by. Sending the
+    // joined id as one terminal parameter asks for \`owner0/repo0\` as a repo.
+    const own = Object.prototype.hasOwnProperty
+    const spec = own.call(ID_SPEC, name) ? ID_SPEC[name] : null
 
-    if ('id' !== rk && null != out.id) {
-      out[rk] = out.id
+    if (null != spec && null != out.id) {
+      Object.assign(out, splitid(name, out.id, 'action'))
       delete out.id
     }
-
+`}
     out.$action = action
     return out
   }
@@ -818,6 +880,15 @@ function ${provider.pluginName}(this: any, options: ${provider.pluginName}Option
         '${provider.pkgName}: ${e.name} ' + cmd + ': ${k} is required'
       )
     }
+
+    // A path parameter is one value. A loaded record can carry an object
+    // under the same name, and that must not be sent as a URL segment.
+    if ('object' === typeof value) {
+      throw new Error(
+        '${provider.pkgName}: ${e.name} ' + cmd + ': ${k} must be a single ' +
+        'value to build the request path, not an object'
+      )
+    }
     return value
   }
 
@@ -827,16 +898,15 @@ function ${provider.pluginName}(this: any, options: ${provider.pluginName}Option
         })
       }
 
-      const translated = provider.entities.filter((e: any) => null != idSpec(e.ent))
-
       if (0 < translated.length) {
         const rows = translated.map((e: any) => {
           const spec: any = idSpec(e.ent)
           const from = null == spec.from ? '' :
             `, from: { ${Object.keys(spec.from).sort()
               .map((k: string) => `${jsKey(k)}: '${spec.from[k]}'`).join(', ')} }`
+          const park = false === e.parkfree ? ', park: false' : ''
           return `    ${jsKey(e.name)}: { parts: [${
-            spec.parts.map((p: string) => `'${p}'`).join(', ')}], sep: '${spec.sep}'${from} },`
+            spec.parts.map((p: string) => `'${p}'`).join(', ')}], sep: '${spec.sep}'${from}${park} },`
         }).join('\n')
 
         Content(`  // HOW EACH ENTITY'S id MAPS TO THE API'S OWN KEYS, from the model.
@@ -853,7 +923,9 @@ function ${provider.pluginName}(this: any, options: ${provider.pluginName}Option
   //          field's name: github returns a repo's owner as an OBJECT
   //          (\`owner.login\`) and its name as \`name\`, never \`repo\`.
   //          A part missing here cannot be read back off a response.
-  const ID_SPEC: Record<string, { parts: string[], sep: string, from?: Record<string, string> }> = {
+  // \`park\`   false where \`${provider.lower}_id\` is a name this entity
+  //          already uses, so the API's own id is left where it is.
+  const ID_SPEC: Record<string, { parts: string[], sep: string, from?: Record<string, string>, park?: boolean }> = {
 ${rows}
   }
 
@@ -904,7 +976,7 @@ ${rows}
   // THE ADDRESSING KEY WINS over an \`id\` the response already carries. A
   // response often has both — github's pull has a global database \`id\` and
   // a repo-scoped \`number\` — and the unrelated one is no use for addressing
-  // anything. It is kept as \`${provider.lower}_id\` rather than dropped.
+  // anything. It is kept as \`${provider.lower}_id\`, unless \`park\` forbids.
   function joinid(name: string, data: any, vals?: any) {
     const spec = ID_SPEC[name]
     if (null == data) {
@@ -930,7 +1002,7 @@ ${rows}
     }
 
     if (null != id) {
-      if (null != data.id && String(data.id) !== id &&
+      if (false !== spec.park && null != data.id && String(data.id) !== id &&
         null == ${jsProp('data', provider.lower + '_id')}) {
         ${jsProp('data', provider.lower + '_id')} = data.id
       }
@@ -1053,19 +1125,18 @@ ${rows}
       each(provider.entities, (e: any) => {
         const eparts = idParts(e.ent)
         const espec = idSpec(e.ent)
-        const guard = (cmd: string, src: string) => {
-          const keys = 'save' === cmd ?
-            [...new Set([...(e.opParents.create || []), ...(e.opParents.update || [])])].sort() :
-            (e.opParents[cmd] || [])
+        // Guards of ONE op: save's create and update branches guard their own.
+        const guard = (opname: string, src: string, label = opname, ind = '      ') => {
+          const keys = e.opParents[opname] || []
 
           return keys
             .filter((k: string) => !eparts.includes(k))
             .map((k: string) =>
-              `      ${guardName(e, k)}(${jsProp(src, k)}, '${cmd}')\n`)
+              `${ind}${guardName(e, k)}(${jsProp(src, k)}, '${label}')\n`)
             .join('')
         }
 
-        const refuse = (cmd: string) => {
+        const refuse = (cmd: string, ind = '      ') => {
           if (true !== (e.idmisaddressed || {})[cmd]) {
             return ''
           }
@@ -1073,13 +1144,17 @@ ${rows}
             recordKey(e.ent)
           const addresses = addressKeys(e.ent, cmd)
 
-          return `      misaddressed('${e.name}', '${cmd}', '${key}', ` +
+          return `${ind}misaddressed('${e.name}', '${cmd}', '${key}', ` +
             `[${addresses.map((k: string) => `'${k}'`).join(', ')}])
 `
         }
 
         const rk = recordKey(e.ent)
 
+        // Named only where there is a spec to translate the id through.
+        const aq = `actionq(msg.q, ${0 === translated.length ? '' :
+          `'${e.name}', `}action$)`
+
         const sdkArg = (opname: string) => {
           const keys = addressKeys(e.ent, opname)
           if (0 === keys.length) {
@@ -1094,23 +1169,24 @@ ${rows}
             `${jsKey(k)}: ${jsProp('q', k === rk ? 'id' : k)}`).join(', ')} }`
         }
 
-        // The line that splits the Seneca id into the API's parameters,
-        // emitted only where there is one record to address. `list` has none.
-        // The entity-options argument that carries the path parameters for a
-        // write. Empty for an ordinary entity, which needs no such channel.
-        const entArg = 0 === eparts.length ? '' :
-          `null == key ? undefined : { match: key }`
+        // Seneca's `id` and the API's key differ: composite, or not called id.
+        const keyed = null != espec
+
+        // The entity-options argument carrying a write's addressing values.
+        const entArg = !keyed ? '' : `null == key ? undefined : { match: key }`
 
         const splitLine = (cmd: string) => 0 === eparts.length ? '' :
-          `      const key = splitid('${e.name}', ${'save' === cmd ? 'data.id' : 'q.id'}, '${cmd}')\n`
+          `      const key = splitid('${e.name}', q.id, '${cmd}')\n`
 
-        // The data hop, plus the id alias when the API keys the record by
-        // something other than `id`. A composite entity passes the addressing
-        // values through, because the response may not repeat them.
+        // The data hop, plus the id from the values this request addressed the
+        // record with, which the response need not repeat.
         const out = (expr: string, vals?: string) =>
-          null == espec ? `plain(${expr})` :
+          !keyed ? `plain(${expr})` :
             `joinid('${e.name}', plain(${expr})${null == vals ? '' : ', ' + vals})`
 
+        const loadVals = 0 < eparts.length ? 'key' :
+          !keyed ? undefined : `{ ${jsKey(rk)}: q.id }`
+
         const actionBranch = (cmd: string, call: string) => `      const action$ = actionOf(msg)
       if (null != action$) {
         const op$ = actionop(action$, '${e.name}', '${cmd}')
@@ -1124,7 +1200,7 @@ ${call}      }
     async function list_${e.name}(this: any, entize: any, msg: any) {
       const q = cleanq(msg.q)
 ${actionBranch('list',
-            `        const found = await this.shared.sdk.${e.acc}()[op$](actionq(msg.q, '${rk}', action$))
+            `        const found = await this.shared.sdk.${e.acc}()[op$](${aq})
         return found.map((data: any) => entize(${out('data')}))
 `)}${guard('list', 'q')}      const list = await this.shared.sdk.${e.acc}().list(q)
       return list.map((data: any) => entize(${out('data')}))
@@ -1139,10 +1215,10 @@ ${actionBranch('list',
     async function load_${e.name}(this: any, entize: any, msg: any) {
       const q = cleanq(msg.q)
 ${actionBranch('load',
-            `        const hit = await ornull(() => this.shared.sdk.${e.acc}()[op$](actionq(msg.q, '${rk}', action$)))
+            `        const hit = await ornull(() => this.shared.sdk.${e.acc}()[op$](${aq}))
         return null == hit ? null : entize(${out('hit')})
 `)}${guard('load', 'q')}${splitLine('load')}      const res = await ornull(() => this.shared.sdk.${e.acc}().load(${sdkArg('load')}))
-      return null == res ? null : entize(${out('res', 0 < eparts.length ? 'key' : undefined)})
+      return null == res ? null : entize(${out('res', loadVals)})
     }
 
 `)
@@ -1152,22 +1228,19 @@ ${actionBranch('load',
           const hasCreate = e.ops.includes('create')
           const hasUpdate = e.ops.includes('update')
 
-          const refuseUpdate = true === (e.idmisaddressed || {}).update ?
-            refuse('update') : ''
+          const refuseUpdate = true === (e.idmisaddressed || {}).update
 
-          const body = hasCreate && hasUpdate
-            ? (('' === refuseUpdate) ? `      const res = null == data.id
-        ? await sdk.${e.acc}(${entArg}).create(data)
-        : await sdk.${e.acc}(${entArg}).update(data)` : `      if (null != data.id) {
-  ${refuseUpdate.replace(/\n$/, '')}
-      }
+          const isUpdate = keyed ? 'null != key' : 'null != data.id'
 
-      const res = await sdk.${e.acc}(${entArg}).create(data)`)
-            : hasCreate
-              ? `      const res = await sdk.${e.acc}(${entArg}).create(data)`
-              : `${refuseUpdate}      const res = await sdk.${e.acc}(${entArg}).update(data)`
+          // Deleting a name the entity owns strips a value the caller supplied.
+          const dropPark = false === e.parkfree ? '' : `
+      // \`${provider.lower}_id\` is this provider's own bookkeeping — the
+      // API's unrelated \`id\`, parked by joinid(). It is not a field of the
+      // API's write schema, so it must not travel in the request body.
+      delete ${jsProp('data', provider.lower + '_id')}
+`
 
-          const compositeSave = 0 < eparts.length ? `
+          const keyBlock = 0 < eparts.length ? `
       // Seneca carries this ${e.name}'s key as one \`id\`; the API addresses
       // the record by ${eparts.map((p: string) => '`' + p + '`').join(' and ')}.
       //
@@ -1186,13 +1259,7 @@ ${actionBranch('load',
       if (null != data.id) {
         key = splitid('${e.name}', data.id, 'save')
       }
-
-      // \`${provider.lower}_id\` is this provider's own bookkeeping — the
-      // API's unrelated \`id\`, parked by joinid() so it is not lost. It is
-      // not a field of the API's write schema, so it must not travel in the
-      // request body.
-      delete ${jsProp('data', provider.lower + '_id')}
-
+${dropPark}
       // AND NEITHER DOES THE JOINED \`id\`. It is Seneca's key for this
       // record, not the API's: a composite ${e.name} is addressed by
       // \`${eparts.join('\` and \`')}\`, which travel as path parameters in
@@ -1201,39 +1268,61 @@ ${actionBranch('load',
       // which matches a request against a stored record, then looked for a
       // record whose own \`id\` was that joined string and found none.
       delete data.id
-` : ''
-
-          const alias = 0 < eparts.length ? '' : 'id' === rk ? '' :
-            `
+` : !keyed ? '' : `
       // This API keys a ${e.name} by \`${rk}\`; Seneca carries it as \`id\`.
-      if (null == ${jsProp('data', rk)} && null != data.id) {
-        ${jsProp('data', rk)} = data.id
+      // The key goes on the body under the API's own name, where the route
+      // reads it, and into the match, which the SDK consults first.
+      let key = null
+      if (null != data.id) {
+        key = { ${jsKey(rk)}: data.id }
+        if (null == ${jsProp('data', rk)}) {
+          ${jsProp('data', rk)} = data.id
+        }
       }
-
-      // \`${provider.lower}_id\` is this provider's own bookkeeping — the
-      // API's unrelated \`id\`, parked by joinid() so it is not lost. It
-      // is not a field of the API's write schema, so it must not travel in
-      // the request body: a strict API rejects an unknown property, and a
-      // lax one may persist it.
-      delete ${jsProp('data', provider.lower + '_id')}
+${dropPark}
+      // NOR DOES SENECA'S \`id\`. It holds the \`${rk}\` this API addresses
+      // the record by, under a name this API's ${e.name} does not have: sent
+      // on the body it is at best an unknown property, and to a store that
+      // matches a write against the record it names the wrong one.
+      delete data.id
 `
 
+          const saveVals = keyed ? 'key' : undefined
+
+          const call = (opname: string) =>
+            `await sdk.${e.acc}(${entArg}).${opname}(data)`
+
+          const body = hasCreate && hasUpdate
+            ? (!refuseUpdate ? `      let res
+      if (${isUpdate}) {
+${guard('update', 'data', 'save', '        ')}        res = ${call('update')}
+      }
+      else {
+${guard('create', 'data', 'save', '        ')}        res = ${call('create')}
+      }` : `      if (${isUpdate}) {
+${refuse('update', '        ')}      }
+
+${guard('create', 'data', 'save')}      const res = ${call('create')}`)
+            : hasCreate
+              ? `${guard('create', 'data', 'save')}      const res = ${call('create')}`
+              : `${refuse('update')}${guard('update', 'data', 'save')}      const res = ${call('update')}`
+
           Content(`
   ${jsProp('entity', e.name)}.cmd.save.action =
     async function save_${e.name}(this: any, entize: any, msg: any) {
       const data = msg.ent.data$(false)
-${alias}      const sdk = this.shared.sdk
+${keyBlock}      const sdk = this.shared.sdk
 
 ${actionBranch('save',
             `        // The action's OWN payload is the entity's own fields — data$(false)
         // has already dropped every trailing-\`$\` key, \`action$\` included,
         // so \`$action\` is the only thing added here.
         data.$action = action$
-        const done = await sdk.${e.acc}()[op$](data)
-        return entize(${out('done')})
-`)}${guard('save', 'data')}${compositeSave}${body}
+        const done = await sdk.${e.acc}(${entArg})[op$](data)
+        return entize(${out('done', saveVals)})
+`)}${body}
 
-      return entize(${out('res', 0 < eparts.length ? 'key' : undefined)})
+      return entize(${out('res', saveVals)})
     }
 
 `)
@@ -1245,7 +1334,7 @@ ${actionBranch('save',
     async function remove_${e.name}(this: any, entize: any, msg: any) {
       const q = cleanq(msg.q)
 ${actionBranch('remove',
-            `        const gone = await ornull(() => this.shared.sdk.${e.acc}()[op$](actionq(msg.q, '${rk}', action$)))
+            `        const gone = await ornull(() => this.shared.sdk.${e.acc}()[op$](${aq}))
         return null == gone ? null : entize(${out('gone')})
 `)}${'' !== refuse('remove') ? refuse('remove') :
             `${guard('remove', 'q')}${splitLine('remove')}      await ornull(() => this.shared.sdk.${e.acc}().remove(${sdkArg('remove')}))
@@ -1405,6 +1494,7 @@ if ('undefined' !== typeof module) {
 export {
   Main,
   recordKey,
+  rkOnCreate,
   cmdActions,
   entityActionList,
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voxgig/sdkgen-infrapack",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "Infrastructure-provider targets for the Voxgig SDK Generator: Seneca provider.",
   "type": "commonjs",
   "license": "MIT",

package/sdkgen-package.json

@@ -3,7 +3,7 @@
     "package": 1
   },
   "name": "@voxgig/sdkgen-infrapack",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "engines": {
     "sdkgen": ">=4.23.0"
   },