@voxgig/sdkgen 4.21.0 → 4.22.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voxgig/sdkgen",
-  "version": "4.21.0",
+  "version": "4.22.0",
   "main": "dist/sdkgen.js",
   "type": "commonjs",
   "engines": {
@@ -43,7 +43,7 @@
     "voxgig-sdkgen": "bin/voxgig-sdkgen"
   },
   "scripts": {
-    "test": "node --enable-source-maps --test dist-test/**/*.test.js",
+    "test": "node ../tools/comment-gate.cjs && node --enable-source-maps --test dist-test/**/*.test.js",
     "test-some": "node --enable-source-maps --test-name-pattern=\"$npm_config_pattern\" --test dist-test/**/*.test.js",
     "golden": "npm run build && SDKGEN_GOLDEN_UPDATE=1 node --test dist-test/characterize.test.js",
     "watch": "tsc --build src test -w",
@@ -89,10 +89,10 @@
   "peerDependencies": {
     "@tabnas/jsonic": ">=0.6.0",
     "@tabnas/parser": ">=0.8.0",
-    "@voxgig/apidef": ">=8.2.2",
+    "@voxgig/apidef": ">=8.12.0",
     "@voxgig/struct": ">=0.2",
     "@voxgig/util": ">=0.5",
-    "aontu": ">=0.52",
+    "aontu": ">=0.68",
     "jostraca": ">=0.38.1",
     "shape": ">=11.4.1"
   }

package/project/.sdk/model/feature/audit.aon

@@ -24,13 +24,6 @@ main: kit: feature: audit: {
 }
 
 
-# TYPES for the options this feature reads but does not default.
-#
-# `config.options` is the defaults map — what happens when you say nothing —
-# so it can only describe an option that HAS a default. A callback has none,
-# and an option the caller either supplies or does not has none either. Left
-# undeclared these were invisible twice over: the generated option spec could
-# not type them, and the README's option table could not list them.
 main: kit: feature: audit: config: optspec: {
   # injected clock, so a test can pin the timestamps
   now: '`$FUNCTION`'

package/project/.sdk/model/feature/cache.aon

@@ -25,13 +25,6 @@ main: kit: feature: cache: {
 }
 
 
-# TYPES for the options this feature reads but does not default.
-#
-# `config.options` is the defaults map — what happens when you say nothing —
-# so it can only describe an option that HAS a default. A callback has none,
-# and an option the caller either supplies or does not has none either. Left
-# undeclared these were invisible twice over: the generated option spec could
-# not type them, and the README's option table could not list them.
 main: kit: feature: cache: config: optspec: {
   # injected clock, for TTL expiry without waiting
   now: '`$FUNCTION`'

package/project/.sdk/model/feature/clienttrack.aon

@@ -22,13 +22,6 @@ main: kit: feature: clienttrack: {
 }
 
 
-# TYPES for the options this feature reads but does not default.
-#
-# `config.options` is the defaults map — what happens when you say nothing —
-# so it can only describe an option that HAS a default. A callback has none,
-# and an option the caller either supplies or does not has none either. Left
-# undeclared these were invisible twice over: the generated option spec could
-# not type them, and the README's option table could not list them.
 main: kit: feature: clienttrack: config: optspec: {
   # overrides the SDK name sent in the client header
   clientName: '`$STRING`'

package/project/.sdk/model/feature/cost.aon

@@ -16,18 +16,14 @@ main: kit: feature: cost: {
     options: {
       active: false
       currency: 'USD'
-      # flat cost per attempt, when no rate or reported figure applies
       unit: 0
-      # cost per attempt keyed '<entity>.<op>', '<op>', or '*'
       rates: {}
       # response header carrying a reported usage figure (per attempt)
       header: ''
       # response body path carrying a reported usage figure (per operation),
       # e.g. 'usage.total_tokens'
       path: ''
-      # price per reported unit; multiplies a header or body figure
       perUnit: 0
-      # spend ceiling, in `currency`. 0 = no budget
       budget: 0
       # once the budget is spent: 'warn' records it, 'deny' refuses the call
       onBudget: 'warn'
@@ -43,16 +39,7 @@ main: kit: feature: cost: {
 }
 
 
-# TYPES for the options this feature reads but does not default.
-#
-# `config.options` is the defaults map — what happens when you say nothing —
-# so it can only describe an option that HAS a default. A callback has none,
-# and an option the caller either supplies or does not has none either. Left
-# undeclared these were invisible twice over: the generated option spec could
-# not type them, and the README's option table could not list them.
 main: kit: feature: cost: config: optspec: {
-  # who the spend is attributed to
   actor: '`$STRING`'
-  # receives every priced attempt
   sink: '`$FUNCTION`'
 }

package/project/.sdk/model/feature/debug.aon

@@ -27,13 +27,6 @@ main: kit: feature: debug: {
 }
 
 
-# TYPES for the options this feature reads but does not default.
-#
-# `config.options` is the defaults map — what happens when you say nothing —
-# so it can only describe an option that HAS a default. A callback has none,
-# and an option the caller either supplies or does not has none either. Left
-# undeclared these were invisible twice over: the generated option spec could
-# not type them, and the README's option table could not list them.
 main: kit: feature: debug: config: optspec: {
   # injected clock, so a trace has stable durations
   now: '`$FUNCTION`'

package/project/.sdk/model/feature/idempotency.aon

@@ -23,13 +23,6 @@ main: kit: feature: idempotency: {
 }
 
 
-# TYPES for the options this feature reads but does not default.
-#
-# `config.options` is the defaults map — what happens when you say nothing —
-# so it can only describe an option that HAS a default. A callback has none,
-# and an option the caller either supplies or does not has none either. Left
-# undeclared these were invisible twice over: the generated option spec could
-# not type them, and the README's option table could not list them.
 main: kit: feature: idempotency: config: optspec: {
   # supplies the idempotency key
   keygen: '`$FUNCTION`'

package/project/.sdk/model/feature/log.aon

@@ -38,13 +38,6 @@ main: kit: feature: log: {
 }
 
 
-# TYPES for the options this feature reads but does not default.
-#
-# `config.options` is the defaults map — what happens when you say nothing —
-# so it can only describe an option that HAS a default. A callback has none,
-# and an option the caller either supplies or does not has none either. Left
-# undeclared these were invisible twice over: the generated option spec could
-# not type them, and the README's option table could not list them.
 main: kit: feature: log: config: optspec: {
   # pino level: 'info' unless set
   level: '`$STRING`'

package/project/.sdk/model/feature/metrics.aon

@@ -22,13 +22,6 @@ main: kit: feature: metrics: {
 }
 
 
-# TYPES for the options this feature reads but does not default.
-#
-# `config.options` is the defaults map — what happens when you say nothing —
-# so it can only describe an option that HAS a default. A callback has none,
-# and an option the caller either supplies or does not has none either. Left
-# undeclared these were invisible twice over: the generated option spec could
-# not type them, and the README's option table could not list them.
 main: kit: feature: metrics: config: optspec: {
   # injected clock, for deterministic durations
   now: '`$FUNCTION`'

package/project/.sdk/model/feature/netsim.aon

@@ -9,26 +9,17 @@ main: kit: feature: netsim: {
   transport: 'wrap'
 
   config: {
-    # Test-support feature: enable per test via
-    # options.feature.netsim.active = true (kept off in normal use).
     options: {
       active: false
-      # fixed ms, or { min, max } for a uniform sample
       latency: 0
-      # first N calls fail with `failStatus`
       failTimes: 0
       failStatus: 503
-      # every Nth call fails (0 = never)
       failEvery: 0
-      # first N calls throw a connection error
       errorTimes: 0
-      # first N calls return HTTP 429 with Retry-After
       rateLimitTimes: 0
       retryAfter: 0
-      # random failure probability 0..1 (uses `seed`)
       failRate: 0
       seed: 1
-      # hard outage: every call fails at the transport level
       offline: false
     }
 
@@ -47,6 +38,5 @@ main: kit: feature: netsim: {
     }
   }
 
-  # Netsim wraps the transport in init(); it dispatches no pipeline hooks.
   hook: {}
 }

package/project/.sdk/model/feature/paging.aon

@@ -32,13 +32,6 @@ main: kit: feature: paging: {
 }
 
 
-# TYPES for the options this feature reads but does not default.
-#
-# `config.options` is the defaults map — what happens when you say nothing —
-# so it can only describe an option that HAS a default. A callback has none,
-# and an option the caller either supplies or does not has none either. Left
-# undeclared these were invisible twice over: the generated option spec could
-# not type them, and the README's option table could not list them.
 main: kit: feature: paging: config: optspec: {
   # page size to request
   limit: '`$NUMBER`'

package/project/.sdk/model/feature/proxy.aon

@@ -25,13 +25,6 @@ main: kit: feature: proxy: {
 }
 
 
-# TYPES for the options this feature reads but does not default.
-#
-# `config.options` is the defaults map — what happens when you say nothing —
-# so it can only describe an option that HAS a default. A callback has none,
-# and an option the caller either supplies or does not has none either. Left
-# undeclared these were invisible twice over: the generated option spec could
-# not type them, and the README's option table could not list them.
 main: kit: feature: proxy: config: optspec: {
   # builds the transport agent for a proxy URL
   agent: '`$FUNCTION`'

package/project/.sdk/model/feature/ratelimit.aon

@@ -23,13 +23,6 @@ main: kit: feature: ratelimit: {
 }
 
 
-# TYPES for the options this feature reads but does not default.
-#
-# `config.options` is the defaults map — what happens when you say nothing —
-# so it can only describe an option that HAS a default. A callback has none,
-# and an option the caller either supplies or does not has none either. Left
-# undeclared these were invisible twice over: the generated option spec could
-# not type them, and the README's option table could not list them.
 main: kit: feature: ratelimit: config: optspec: {
   # injected clock
   now: '`$FUNCTION`'

package/project/.sdk/model/feature/retry.aon

@@ -25,13 +25,6 @@ main: kit: feature: retry: {
 }
 
 
-# TYPES for the options this feature reads but does not default.
-#
-# `config.options` is the defaults map — what happens when you say nothing —
-# so it can only describe an option that HAS a default. A callback has none,
-# and an option the caller either supplies or does not has none either. Left
-# undeclared these were invisible twice over: the generated option spec could
-# not type them, and the README's option table could not list them.
 main: kit: feature: retry: config: optspec: {
   # randomise the backoff delay
   jitter: '`$BOOLEAN`'