@toa.io/extensions.exposition 1.0.0-alpha.30 → 1.0.0-alpha.301

package/transpiled/directives/io/Input.js

@@ -1,57 +1,38 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Input = void 0;
-const HTTP_1 = require("../../HTTP");
-const schemas = __importStar(require("./schemas"));
-class Input {
-    permissions;
+import { BadRequest } from '../../HTTP/index.js';
+import * as schemas from './schemas.js';
+export class Input {
+    /** what a client may send, which is therefore what the input schema states */
+    allowed;
     constructor(permissions) {
-        this.permissions = permissions;
+        this.allowed = new Set(permissions);
     }
     static validate(permissions) {
-        schemas.input.validate(permissions, 'Incorrect \'io:input\' format');
+        schemas.input.validate(permissions, "Incorrect 'io:input' format");
     }
-    attach(context) {
-        context.pipelines.body.push((body) => this.check(body));
+    precall(context) {
+        // Restrictions are on what the client sent, so the check goes to the front of the
+        // pipeline whatever order the families ran in: `auth:delegate` embeds the identity
+        // and `map:*` assigns mapped properties, and those additions are the server's own,
+        // not input to be restricted.
+        context.pipelines.body.unshift((body) => this.check(body));
     }
     check(body) {
+        if (body === undefined)
+            return body;
         try {
             schemas.message.validate(body);
         }
         catch {
-            throw new HTTP_1.BadRequest('Invalid request body.');
+            throw new BadRequest('Invalid request body');
         }
         const property = this.violation(body);
         if (property !== undefined)
-            throw new HTTP_1.BadRequest(`Unexpected input: ${property}.`);
+            throw new BadRequest(`Unexpected input: ${property}`);
         return body;
     }
     violation(value) {
         if (!Array.isArray(value))
-            return Object.keys(value).find((key) => !this.permissions.includes(key));
+            return Object.keys(value).find((key) => !this.allowed.has(key));
         for (const item of value) {
             const property = this.violation(item);
             if (property !== undefined)
@@ -59,5 +40,4 @@ class Input {
         }
     }
 }
-exports.Input = Input;
 //# sourceMappingURL=Input.js.map

package/transpiled/directives/io/Input.js.map

@@ -1 +1 @@
-{"version":3,"file":"Input.js","sourceRoot":"","sources":["../../../source/directives/io/Input.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAuC;AACvC,mDAAoC;AAKpC,MAAa,KAAK;IACC,WAAW,CAAa;IAEzC,YAAoB,WAAwB;QAC1C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAE,WAAoB;QAC1C,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,EAAE,+BAA+B,CAAC,CAAA;IACtE,CAAC;IAEM,MAAM,CAAE,OAAgB;QAC7B,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;IACzD,CAAC;IAEO,KAAK,CAAE,IAAa;QAC1B,IAAI,CAAC;YACH,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAChC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,iBAAU,CAAC,uBAAuB,CAAC,CAAA;QAC/C,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAErC,IAAI,QAAQ,KAAK,SAAS;YACxB,MAAM,IAAI,iBAAU,CAAC,qBAAqB,QAAQ,GAAG,CAAC,CAAA;QAExD,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,SAAS,CAAE,KAA0B;QAC3C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YACvB,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;QAE1E,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;YAErC,IAAI,QAAQ,KAAK,SAAS;gBACxB,OAAO,QAAQ,CAAA;QACnB,CAAC;IACH,CAAC;CACF;AAzCD,sBAyCC"}
+{"version":3,"file":"Input.js","sourceRoot":"","sources":["../../../source/directives/io/Input.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAChD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAKvC,MAAM,OAAO,KAAK;IAChB,8EAA8E;IAC9D,OAAO,CAAa;IAEpC,YAAmB,WAAwB;QACzC,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAA;IACrC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,WAAoB;QACzC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAc,WAAW,EAAE,6BAA6B,CAAC,CAAA;IACjF,CAAC;IAEM,OAAO,CAAC,OAAgB;QAC7B,kFAAkF;QAClF,mFAAmF;QACnF,mFAAmF;QACnF,8BAA8B;QAC9B,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;IAC5D,CAAC;IAEO,KAAK,CAAC,IAAa;QACzB,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,IAAI,CAAA;QAEnC,IAAI,CAAC;YACH,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAsB,IAAI,CAAC,CAAA;QACrD,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,UAAU,CAAC,sBAAsB,CAAC,CAAA;QAC9C,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAErC,IAAI,QAAQ,KAAK,SAAS;YAAE,MAAM,IAAI,UAAU,CAAC,qBAAqB,QAAQ,EAAE,CAAC,CAAA;QAEjF,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,SAAS,CAAC,KAA0B;QAC1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YACvB,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;QAEjE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;YAErC,IAAI,QAAQ,KAAK,SAAS;gBAAE,OAAO,QAAQ,CAAA;QAC7C,CAAC;IACH,CAAC;CACF"}

package/transpiled/directives/io/Message.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=Message.js.map

package/transpiled/directives/io/Output.d.ts

@@ -1,13 +1,17 @@
-import type { Directive } from './Directive';
-import type { Input as Context } from '../../io';
+import type { Directive } from './Directive.ts';
+import type { Input as Context } from '../../io.ts';
 export declare class Output implements Directive {
-    private readonly disabled;
+    /** whether the reply passes whole, which is when the schema is the operation's own */
+    readonly disabled: boolean;
+    /** what a reply may carry, which is therefore what the output schema states */
+    readonly allowed: Set<string>;
     private readonly omitted;
     private readonly permissions;
     constructor(permissions: Permissions);
     static validate(permissions: unknown): asserts permissions is Permissions;
-    attach(context: Context): void;
+    precall(context: Context): void;
     private restriction;
+    /** Runs per entity of a collection, hence the set and the absence of intermediates. */
     private fit;
 }
 export type Permissions = string[] | boolean;

package/transpiled/directives/io/Output.js

@@ -1,33 +1,11 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Output = void 0;
-const node_stream_1 = require("node:stream");
-const schemas = __importStar(require("./schemas"));
-class Output {
+import { Stream } from 'node:stream';
+import { console } from 'openspan';
+import * as schemas from './schemas.js';
+export class Output {
+    /** whether the reply passes whole, which is when the schema is the operation's own */
     disabled = false;
+    /** what a reply may carry, which is therefore what the output schema states */
+    allowed;
     omitted = true;
     permissions = [];
     constructor(permissions) {
@@ -38,39 +16,45 @@ class Output {
                 this.omitted = false;
         else
             this.permissions = permissions;
+        this.allowed = new Set(this.permissions);
     }
     static validate(permissions) {
-        schemas.output.validate(permissions, 'Incorrect \'io:output\' format');
+        schemas.output.validate(permissions, "Incorrect 'io:output' format");
     }
-    attach(context) {
+    precall(context) {
         context.pipelines.response.push(this.restriction(context));
     }
     restriction(context) {
         return (message) => {
-            const error = message.status !== undefined && message.status >= 300;
-            const stream = message.body instanceof node_stream_1.Stream;
+            // what the gateway built is its own — a code and a message — and a restriction has
+            // nothing to say about it; everything else is a reply the operation returned, and is
+            // restricted whatever status it carries
+            const error = message.authentic === true;
+            const stream = message.body instanceof Stream;
             const none = message.body === undefined || message.body === null;
             if (this.disabled || error || stream || none)
                 return;
             if (typeof message.body !== 'object' || this.permissions.length === 0) {
                 if (this.omitted)
-                    console.warn('Permissions for \'io:output\' are not specified properly ' +
-                        `(${context.request.url}). Response omitted.`);
+                    console.warn("Permissions for 'io:output' are not specified properly, response omitted", { path: context.url.pathname });
                 delete message.body;
                 return;
             }
-            schemas.message.validate(message.body, '\'io:output\' expects response to be an object or array of objects');
+            schemas.message.validate(message.body, "'io:output' expects response to be an object or array of objects");
             if (Array.isArray(message.body))
                 message.body = message.body.map((entity) => this.fit(entity));
             else
                 message.body = this.fit(message.body);
         };
     }
+    /** Runs per entity of a collection, hence the set and the absence of intermediates. */
     fit(message) {
-        const entries = Object.entries(message)
-            .filter(([key]) => this.permissions.includes(key));
-        return Object.fromEntries(entries);
+        const output = {};
+        // the keys of the entity, so that the response keeps the order it was built in
+        for (const key of Object.keys(message))
+            if (this.allowed.has(key))
+                output[key] = message[key];
+        return output;
     }
 }
-exports.Output = Output;
 //# sourceMappingURL=Output.js.map

package/transpiled/directives/io/Output.js.map

@@ -1 +1 @@
-{"version":3,"file":"Output.js","sourceRoot":"","sources":["../../../source/directives/io/Output.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAAoC;AACpC,mDAAoC;AAMpC,MAAa,MAAM;IACA,QAAQ,GAAY,KAAK,CAAA;IACzB,OAAO,GAAY,IAAI,CAAA;IACvB,WAAW,GAAa,EAAE,CAAA;IAE3C,YAAoB,WAAwB;QAC1C,IAAI,OAAO,WAAW,KAAK,SAAS;YAClC,IAAI,WAAW;gBACb,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;;gBAEpB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;;YAGtB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAClC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAE,WAAoB;QAC1C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,gCAAgC,CAAC,CAAA;IACxE,CAAC;IAEM,MAAM,CAAE,OAAgB;QAC7B,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;IAC5D,CAAC;IAEO,WAAW,CAAE,OAAgB;QACnC,OAAO,CAAC,OAAwB,EAAQ,EAAE;YACxC,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,CAAA;YACnE,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,YAAY,oBAAM,CAAA;YAC7C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,CAAA;YAEhE,IAAI,IAAI,CAAC,QAAQ,IAAI,KAAK,IAAI,MAAM,IAAI,IAAI;gBAC1C,OAAM;YAER,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtE,IAAI,IAAI,CAAC,OAAO;oBACd,OAAO,CAAC,IAAI,CAAC,2DAA2D;wBACtE,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,sBAAsB,CAAC,CAAA;gBAElD,OAAO,OAAO,CAAC,IAAI,CAAA;gBAEnB,OAAM;YACR,CAAC;YAED,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EACnC,oEAAoE,CAAC,CAAA;YAEvE,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;gBAC7B,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;;gBAE7D,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACzC,CAAC,CAAA;IACH,CAAC;IAEO,GAAG,CAAE,OAAgB;QAC3B,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;aACpC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;QAEpD,OAAO,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;IACpC,CAAC;CACF;AA3DD,wBA2DC"}
+{"version":3,"file":"Output.js","sourceRoot":"","sources":["../../../source/directives/io/Output.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAClC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAMvC,MAAM,OAAO,MAAM;IACjB,sFAAsF;IACtE,QAAQ,GAAY,KAAK,CAAA;IAEzC,+EAA+E;IAC/D,OAAO,CAAa;IACnB,OAAO,GAAY,IAAI,CAAA;IACvB,WAAW,GAAa,EAAE,CAAA;IAE3C,YAAmB,WAAwB;QACzC,IAAI,OAAO,WAAW,KAAK,SAAS;YAClC,IAAI,WAAW;gBAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;;gBAChC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;;YACtB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAEnC,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAC1C,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,WAAoB;QACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,8BAA8B,CAAC,CAAA;IACtE,CAAC;IAEM,OAAO,CAAC,OAAgB;QAC7B,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;IAC5D,CAAC;IAEO,WAAW,CAAC,OAAgB;QAClC,OAAO,CAAC,OAAwB,EAAQ,EAAE;YACxC,mFAAmF;YACnF,qFAAqF;YACrF,wCAAwC;YACxC,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,KAAK,IAAI,CAAA;YACxC,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,YAAY,MAAM,CAAA;YAC7C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,CAAA;YAEhE,IAAI,IAAI,CAAC,QAAQ,IAAI,KAAK,IAAI,MAAM,IAAI,IAAI;gBAAE,OAAM;YAEpD,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtE,IAAI,IAAI,CAAC,OAAO;oBACd,OAAO,CAAC,IAAI,CACV,0EAA0E,EAC1E,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAC/B,CAAA;gBAEH,OAAO,OAAO,CAAC,IAAI,CAAA;gBAEnB,OAAM;YACR,CAAC;YAED,OAAO,CAAC,OAAO,CAAC,QAAQ,CACtB,OAAO,CAAC,IAAI,EACZ,kEAAkE,CACnE,CAAA;YAED,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;gBAC7B,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,MAAiB,CAAC,CAAC,CAAA;;gBACrE,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAC5C,CAAC,CAAA;IACH,CAAC;IAED,uFAAuF;IAC/E,GAAG,CAAC,OAAgB;QAC1B,MAAM,MAAM,GAAY,EAAE,CAAA;QAE1B,+EAA+E;QAC/E,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YACpC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;QAEvD,OAAO,MAAM,CAAA;IACf,CAAC;CACF"}

package/transpiled/directives/io/Status.d.ts

@@ -0,0 +1,19 @@
+import type { Directive } from './Directive.ts';
+import type * as http from '../../HTTP/index.ts';
+/**
+ * The status of the reply, taken from a property of what the operation returned and removed
+ * from it — an outcome the operation knows and the transport does not, like a protocol that
+ * states its error as a body rather than as a status of its own.
+ *
+ * Settled rather than transformed, so the status is set before anything reads it. A reply of
+ * 300 or above is left as the operation built it, which `io:output` does not restrict: a
+ * failure and a success are different shapes, and one list of permitted properties does not
+ * describe both.
+ */
+export declare class Status implements Directive {
+    private readonly property;
+    constructor(property: unknown);
+    static validate(value: unknown): asserts value is string;
+    precall(): void;
+    settle(_: unknown, response: http.OutgoingMessage): void;
+}

package/transpiled/directives/io/Status.js

@@ -0,0 +1,35 @@
+/**
+ * The status of the reply, taken from a property of what the operation returned and removed
+ * from it — an outcome the operation knows and the transport does not, like a protocol that
+ * states its error as a body rather than as a status of its own.
+ *
+ * Settled rather than transformed, so the status is set before anything reads it. A reply of
+ * 300 or above is left as the operation built it, which `io:output` does not restrict: a
+ * failure and a success are different shapes, and one list of permitted properties does not
+ * describe both.
+ */
+export class Status {
+    property;
+    constructor(property) {
+        this.property = property;
+    }
+    static validate(value) {
+        if (typeof value !== 'string')
+            throw new Error('`io:status` must be a string');
+    }
+    precall() {
+        // nothing to do until the operation has answered
+    }
+    settle(_, response) {
+        const body = response.body;
+        if (body === null || typeof body !== 'object' || !(this.property in body))
+            return;
+        const value = body[this.property];
+        if (typeof value !== 'number')
+            throw new Error(`\`io:status\` expects '${this.property}' to be a number`);
+        response.status = value;
+        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+        delete body[this.property];
+    }
+}
+//# sourceMappingURL=Status.js.map

package/transpiled/directives/io/Status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Status.js","sourceRoot":"","sources":["../../../source/directives/io/Status.ts"],"names":[],"mappings":"AAGA;;;;;;;;;GASG;AACH,MAAM,OAAO,MAAM;IACA,QAAQ,CAAQ;IAEjC,YAAmB,QAAiB;QAClC,IAAI,CAAC,QAAQ,GAAG,QAAkB,CAAA;IACpC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAc;QACnC,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;IAChF,CAAC;IAEM,OAAO;QACZ,iDAAiD;IACnD,CAAC;IAEM,MAAM,CAAC,CAAU,EAAE,QAA8B;QACtD,MAAM,IAAI,GAAY,QAAQ,CAAC,IAAI,CAAA;QAEnC,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC;YAAE,OAAM;QAEjF,MAAM,KAAK,GAAa,IAAgC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAEvE,IAAI,OAAO,KAAK,KAAK,QAAQ;YAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,IAAI,CAAC,QAAQ,kBAAkB,CAAC,CAAA;QAE5E,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAA;QAEvB,gEAAgE;QAChE,OAAQ,IAAgC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACzD,CAAC;CACF"}

package/transpiled/directives/io/Throttle.d.ts

@@ -0,0 +1,11 @@
+import { type Declaration, type Sync } from './lib/throttle/index.ts';
+import type * as http from '../../HTTP/index.ts';
+import type { Parameter } from '../../RTD/index.ts';
+import type { Directive } from './Directive.ts';
+export declare class Throttle implements Directive {
+    private readonly quotas;
+    constructor(declaration: Declaration, sync: Sync, route: string);
+    static validate(declaration: unknown): asserts declaration is Declaration;
+    precall(context: http.Context, parameters: Parameter[]): void;
+    settle(context: http.Context, output: http.OutgoingMessage): void;
+}

package/transpiled/directives/io/Throttle.js

@@ -0,0 +1,22 @@
+import { TooManyRequests } from '../../HTTP/index.js';
+import * as schemas from './schemas.js';
+import { parse, Quotas } from './lib/throttle/index.js';
+export class Throttle {
+    quotas;
+    constructor(declaration, sync, route) {
+        this.quotas = Quotas.create(parse(declaration), route);
+        sync.register(this.quotas);
+    }
+    static validate(declaration) {
+        schemas.throttle.validate(declaration, "Incorrect 'io:throttle' format");
+    }
+    precall(context, parameters) {
+        const retry = this.quotas.check(context, parameters);
+        if (retry > 0)
+            throw new TooManyRequests(retry);
+    }
+    settle(context, output) {
+        this.quotas.use(context, output);
+    }
+}
+//# sourceMappingURL=Throttle.js.map

package/transpiled/directives/io/Throttle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Throttle.js","sourceRoot":"","sources":["../../../source/directives/io/Throttle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,EAA+B,MAAM,yBAAyB,CAAA;AAKpF,MAAM,OAAO,QAAQ;IACF,MAAM,CAAQ;IAE/B,YAAmB,WAAwB,EAAE,IAAU,EAAE,KAAa;QACpE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC,CAAA;QAEtD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC5B,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,WAAoB;QACzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,gCAAgC,CAAC,CAAA;IAC1E,CAAC;IAEM,OAAO,CAAC,OAAqB,EAAE,UAAuB;QAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;QAEpD,IAAI,KAAK,GAAG,CAAC;YAAE,MAAM,IAAI,eAAe,CAAC,KAAK,CAAC,CAAA;IACjD,CAAC;IAEM,MAAM,CAAC,OAAqB,EAAE,MAA4B;QAC/D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IAClC,CAAC;CACF"}

package/transpiled/directives/io/index.d.ts

@@ -1,2 +1,2 @@
-import { IO } from './IO';
+import { IO } from './IO.ts';
 export declare const io: IO;

package/transpiled/directives/io/index.js

@@ -1,6 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.io = void 0;
-const IO_1 = require("./IO");
-exports.io = new IO_1.IO();
+import { IO } from './IO.js';
+export const io = new IO();
 //# sourceMappingURL=index.js.map

package/transpiled/directives/io/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../source/directives/io/index.ts"],"names":[],"mappings":";;;AAAA,6BAAyB;AAEZ,QAAA,EAAE,GAAG,IAAI,OAAE,EAAE,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../source/directives/io/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAA;AAE5B,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,CAAA"}

package/transpiled/directives/io/lib/throttle/Configuration.d.ts

@@ -0,0 +1,26 @@
+export interface Configuration {
+    key: KeyComponent[];
+    condition?: KeyCondition[];
+    requests: number;
+    interval: number;
+}
+interface Rule<T, K = unknown> {
+    method: T;
+    options?: K;
+}
+export type KeyComponentMethod = 'ip' | 'path' | 'route' | 'identity' | 'segment';
+export type KeyConditionMethod = 'status';
+export type KeyComponent = Rule<KeyComponentMethod>;
+export type KeyCondition = Rule<KeyConditionMethod>;
+/** A bare component, or the one that takes an argument. */
+type KeyEntry = KeyComponentMethod | {
+    segment: string;
+};
+type KeyDeclaration = KeyEntry | KeyEntry[];
+type ConditionDeclaration = Record<KeyConditionMethod, unknown> | Array<Record<KeyConditionMethod, unknown>>;
+export interface Declaration extends Omit<Configuration, 'key' | 'condition'> {
+    key: KeyDeclaration;
+    condition?: ConditionDeclaration;
+}
+export declare function parse(declaration: Declaration): Configuration;
+export {};

package/transpiled/directives/io/lib/throttle/Configuration.js

@@ -0,0 +1,31 @@
+export function parse(declaration) {
+    const { key, condition, requests, interval } = declaration;
+    return {
+        key: mapKey(key),
+        condition: mapCondition(condition),
+        requests,
+        interval: interval * 1000
+    };
+}
+function mapKey(declaration) {
+    const entries = Array.isArray(declaration) ? declaration : [declaration];
+    // a bare `path`, or `segment: id` for the ones that take an argument
+    return entries.flatMap((entry) => typeof entry === 'string'
+        ? [{ method: entry }]
+        : Object.entries(entry).map(([method, options]) => ({
+            method: method,
+            options
+        })));
+}
+function mapCondition(declaration) {
+    if (declaration === undefined)
+        return;
+    // reduce to a single object, then map entries to rules
+    const conditions = Array.isArray(declaration) ? declaration : [declaration];
+    const single = conditions.reduce((acc, condition) => ({ ...acc, ...condition }), {});
+    return Object.entries(single).map(([method, options]) => ({
+        method,
+        options
+    }));
+}
+//# sourceMappingURL=Configuration.js.map

package/transpiled/directives/io/lib/throttle/Configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Configuration.js","sourceRoot":"","sources":["../../../../../source/directives/io/lib/throttle/Configuration.ts"],"names":[],"mappings":"AA+BA,MAAM,UAAU,KAAK,CAAC,WAAwB;IAC5C,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAA;IAE1D,OAAO;QACL,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC;QAChB,SAAS,EAAE,YAAY,CAAC,SAAS,CAAC;QAClC,QAAQ;QACR,QAAQ,EAAE,QAAQ,GAAG,IAAI;KAC1B,CAAA;AACH,CAAC;AAED,SAAS,MAAM,CAAC,WAA2B;IACzC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAA;IAExE,qEAAqE;IACrE,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAkB,EAAE,CAC/C,OAAO,KAAK,KAAK,QAAQ;QACvB,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;QACrB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YAChD,MAAM,EAAE,MAA4B;YACpC,OAAO;SACR,CAAC,CAAC,CACR,CAAA;AACH,CAAC;AAED,SAAS,YAAY,CAAC,WAAkC;IACtD,IAAI,WAAW,KAAK,SAAS;QAAE,OAAM;IAErC,uDAAuD;IACvD,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAA;IAC3E,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;IAEpF,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QACxD,MAAM;QACN,OAAO;KACR,CAAC,CAAmB,CAAA;AACvB,CAAC"}

package/transpiled/directives/io/lib/throttle/Keys.d.ts

@@ -0,0 +1,14 @@
+import { type Component } from './components/index.ts';
+import { type Condition } from './conditions/index.ts';
+import type { KeyComponent, KeyCondition } from './Configuration.ts';
+import type { Parameter } from '../../../../RTD/index.ts';
+import type { Input as Context, Output } from '../../../../io.ts';
+export declare class Keys {
+    private readonly components;
+    private readonly conditions?;
+    constructor(components: Component[], conditions?: Condition[]);
+    static create(componentRules: KeyComponent[], conditionRules?: KeyCondition[], route?: string): Keys;
+    /** The key of the request, or nothing when a component cannot key it. */
+    get(context: Context, parameters?: Parameter[]): string | undefined;
+    matches(input: Context, output: Output): boolean;
+}

package/transpiled/directives/io/lib/throttle/Keys.js

@@ -0,0 +1,32 @@
+import { createHash } from 'node:crypto';
+import { Components } from './components/index.js';
+import { Conditions } from './conditions/index.js';
+const NONE = [];
+export class Keys {
+    components;
+    conditions;
+    constructor(components, conditions) {
+        this.components = components;
+        this.conditions = conditions;
+    }
+    static create(componentRules, conditionRules, route = '') {
+        const components = componentRules.map((rule) => new Components[rule.method](rule.options, route));
+        const conditions = conditionRules?.map((rule) => new Conditions[rule.method](rule.options));
+        return new this(components, conditions);
+    }
+    /** The key of the request, or nothing when a component cannot key it. */
+    get(context, parameters = NONE) {
+        const hash = createHash('sha256');
+        for (const component of this.components) {
+            const part = component.get(context, parameters);
+            if (part === undefined)
+                return;
+            hash.update(part);
+        }
+        return hash.digest('hex');
+    }
+    matches(input, output) {
+        return this.conditions?.some((condition) => !condition.match(input, output)) !== true;
+    }
+}
+//# sourceMappingURL=Keys.js.map

package/transpiled/directives/io/lib/throttle/Keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Keys.js","sourceRoot":"","sources":["../../../../../source/directives/io/lib/throttle/Keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,UAAU,EAAkB,MAAM,uBAAuB,CAAA;AAClE,OAAO,EAAE,UAAU,EAAkB,MAAM,uBAAuB,CAAA;AAKlE,MAAM,IAAI,GAAgB,EAAE,CAAA;AAE5B,MAAM,OAAO,IAAI;IACE,UAAU,CAAa;IACvB,UAAU,CAAc;IAEzC,YAAmB,UAAuB,EAAE,UAAwB;QAClE,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAEM,MAAM,CAAC,MAAM,CAClB,cAA8B,EAC9B,cAA+B,EAC/B,KAAK,GAAW,EAAE;QAElB,MAAM,UAAU,GAAG,cAAc,CAAC,GAAG,CACnC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAC3D,CAAA;QAED,MAAM,UAAU,GAAG,cAAc,EAAE,GAAG,CACpC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CACpD,CAAA;QAED,OAAO,IAAI,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;IACzC,CAAC;IAED,yEAAyE;IAClE,GAAG,CAAC,OAAgB,EAAE,UAAU,GAAgB,IAAI;QACzD,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAA;QAEjC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;YAE/C,IAAI,IAAI,KAAK,SAAS;gBAAE,OAAM;YAE9B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACnB,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAC3B,CAAC;IAEM,OAAO,CAAC,KAAc,EAAE,MAAc;QAC3C,OAAO,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,KAAK,IAAI,CAAA;IACvF,CAAC;CACF"}

package/transpiled/directives/io/lib/throttle/Quotas.d.ts

@@ -0,0 +1,70 @@
+import { Keys } from './Keys.ts';
+import type { Batch } from './Sync.ts';
+import type { Configuration } from './Configuration.ts';
+import type { Parameter } from '../../../../RTD/index.ts';
+import type { Input as Context, Output } from '../../../../io.ts';
+/**
+ * A quota per key, metered by GCRA, decided in this process and shared with the others.
+ *
+ * The state of a key is one theoretical arrival time: the moment the key would be back
+ * at zero if nothing more arrived. An admitted request pushes it `emission` further out,
+ * time drags it back, and a request is admitted while it stays within `capacity` of now.
+ * So `requests` is what a key may spend at once, and `requests / interval` what it earns
+ * back — no window to burst across the edge of, and no lockout to time out of.
+ *
+ * Deciding needs nothing but the local map, which is what keeps the request path free of
+ * I/O. What the other gateways have spent arrives on {@link Sync}'s tick, as a debt in
+ * milliseconds — a duration, so it carries across processes without their clocks having
+ * to agree, and additive, which is what lets each process report only its own increments.
+ */
+export declare class Quotas {
+    /** How often the debt is worth reconciling with the other gateways, in milliseconds. */
+    readonly period: number;
+    /** Milliseconds of debt an admitted request adds, `interval / requests`. */
+    private readonly emission;
+    /** Debt a key may carry before it is refused, `interval` — a burst of `requests`. */
+    private readonly capacity;
+    private readonly keys;
+    private readonly prefix;
+    private readonly conditional;
+    private readonly entries;
+    /**
+     * The key computed at precall, for settle to charge against.
+     *
+     * `segment` reads the route parameters, which settle is not given, and `identity`
+     * can be refreshed between the two — so recomputing there would key a request
+     * differently than it was checked, and throttling would quietly stop working.
+     */
+    private readonly keyed;
+    constructor(options: Options);
+    static create(configuration: Configuration, route?: string): Quotas;
+    /**
+     * Seconds to wait before the request would be admitted, or zero when it is.
+     *
+     * Charges here when nothing conditions the count, so that the request is metered by
+     * the same call that admits it; otherwise only the response can tell whether it counts,
+     * and {@link use} charges once it can.
+     */
+    check(context: Context, parameters: Parameter[]): number;
+    /** Charges what the condition accepts, once the response can be matched against it. */
+    use(input: Context, output: Output): void;
+    /**
+     * Adds what is worth reporting to the batch, and drops what has gone quiet.
+     *
+     * The debt is not cleared here but in {@link settled}, so a tick that fails to reach
+     * Redis leaves it to be reported by the next one instead of losing it.
+     */
+    flush(now: number, batch: Batch[]): void;
+    /** Takes the group's debt back, and clears what this process contributed to it. */
+    settled(reported: Batch, debt: number, now: number): void;
+    name(key: string): string;
+    private charge;
+}
+export interface Options {
+    keys: Keys;
+    requests: number;
+    interval: number;
+    conditional: boolean;
+    /** what the keys are reported under, in place of the budget they carry */
+    name?: string;
+}