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

package/transpiled/directives/help/Family.d.ts

@@ -0,0 +1,27 @@
+import { Help } from './Help.ts';
+import { Parameters } from './Parameters.ts';
+import type { Introspection } from '../../Introspection.ts';
+export type { Described } from './described.ts';
+import type { Context } from '../../HTTP/index.ts';
+import type { DirectiveFamily } from '../../RTD/index.ts';
+/** The name the family is declared under, and what a consumer of one asks a method for. */
+export declare const FAMILY = "help";
+export type Directive = Help | Parameters;
+export declare class Family implements DirectiveFamily<Directive> {
+    readonly name = "help";
+    readonly mandatory = false;
+    /**
+     * What a node says of itself is not said of what is under it: inherited, `help:node`
+     * would describe every resource below as the one it was written for. The rest go with
+     * it — a sentence about one method is not true of the next, and a route variable a
+     * template does not have is not one at all.
+     */
+    readonly inherited = false;
+    /** What the nearest declaration says of the method, or nothing where none does. */
+    static method(directives: Directive[] | undefined): Help | null;
+    /** And the same of the resource the method is on. */
+    static node(directives: Directive[] | undefined): Help | null;
+    create(name: string, value: unknown, _: unknown, route: string): Directive;
+    /** What the route states this method and its parameters are. */
+    explain(directives: Directive[], _: Context, introspection: Introspection): Introspection | null;
+}

package/transpiled/directives/help/Family.js

@@ -0,0 +1,83 @@
+import { Help } from './Help.js';
+import { Parameters } from './Parameters.js';
+/** The name the family is declared under, and what a consumer of one asks a method for. */
+export const FAMILY = 'help';
+export class Family {
+    name = FAMILY;
+    mandatory = false;
+    /**
+     * What a node says of itself is not said of what is under it: inherited, `help:node`
+     * would describe every resource below as the one it was written for. The rest go with
+     * it — a sentence about one method is not true of the next, and a route variable a
+     * template does not have is not one at all.
+     */
+    inherited = false;
+    /** What the nearest declaration says of the method, or nothing where none does. */
+    static method(directives) {
+        return stated(directives, 'method');
+    }
+    /** And the same of the resource the method is on. */
+    static node(directives) {
+        return stated(directives, 'node');
+    }
+    // eslint-disable-next-line max-params
+    create(name, value, _, route) {
+        if (name === 'node' || name === 'method')
+            return new Help(name, value);
+        if (!(name === 'route' || name === 'query'))
+            throw new Error(`Unknown directive: help:${name}`);
+        return new Parameters(name, value, route);
+    }
+    /** What the route states this method and its parameters are. */
+    explain(directives, _, introspection) {
+        const help = Family.method(directives);
+        // what is hidden is hidden from every answer at once, this being the one place they
+        // all read; the method itself is reached as it always was
+        if (help?.hidden === true)
+            return null;
+        const described = {
+            ...introspection,
+            ...(help?.title === undefined ? {} : { title: help.title }),
+            ...(help?.description === undefined ? {} : { description: help.description })
+        };
+        // a schema says `title` and `description` of what it describes, which is where these go
+        for (const subject of PARAMETERS) {
+            const declaration = declared(directives, subject);
+            if (declaration === null)
+                continue;
+            const parameters = declaration.parameters;
+            for (const [name, stated] of Object.entries(parameters)) {
+                const schema = described[subject]?.[name];
+                /*
+                 * A route variable is one because the template names it, whether or not the
+                 * operation declares it as input — and only then is it answered. `:id` on an
+                 * observation is the ordinary case: it is taken by the query, so nothing describes
+                 * it and the caller is not told it is a path parameter at all.
+                 *
+                 * Anything else is described only where it is already answered: a querystring
+                 * parameter is one only where the mapping takes it, and a segment `map:segments`
+                 * renames is answered under the property it fills.
+                 */
+                if (schema === undefined && !declaration.variables.includes(name))
+                    continue;
+                // written where the shape states it, whatever the schema already said
+                const merged = { ...schema };
+                delete merged.title;
+                delete merged.description;
+                described[subject] ??= {};
+                described[subject][name] = Object.assign(merged, stated);
+            }
+        }
+        return described;
+    }
+}
+const PARAMETERS = ['route', 'query'];
+function stated(directives, subject) {
+    const help = directives?.find((directive) => directive instanceof Help && directive.subject === subject);
+    return help ?? null;
+}
+function declared(directives, subject) {
+    const found = directives?.find((directive) => directive instanceof Parameters && directive.subject === subject);
+    return found ?? null;
+}
+//# sourceMappingURL=Family.js.map

package/transpiled/directives/help/Family.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Family.js","sourceRoot":"","sources":["../../../source/directives/help/Family.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAM5C,2FAA2F;AAC3F,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAA;AAI5B,MAAM,OAAO,MAAM;IACD,IAAI,GAAG,MAAM,CAAA;IACb,SAAS,GAAG,KAAK,CAAA;IAEjC;;;;;OAKG;IACa,SAAS,GAAG,KAAK,CAAA;IAEjC,mFAAmF;IAC5E,MAAM,CAAC,MAAM,CAAC,UAAmC;QACtD,OAAO,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;IACrC,CAAC;IAED,qDAAqD;IAC9C,MAAM,CAAC,IAAI,CAAC,UAAmC;QACpD,OAAO,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;IACnC,CAAC;IAED,sCAAsC;IAC/B,MAAM,CAAC,IAAY,EAAE,KAAc,EAAE,CAAU,EAAE,KAAa;QACnE,IAAI,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,QAAQ;YAAE,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;QAEtE,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,OAAO,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,EAAE,CAAC,CAAA;QAEpD,OAAO,IAAI,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;IAC3C,CAAC;IAED,gEAAgE;IACzD,OAAO,CACZ,UAAuB,EACvB,CAAU,EACV,aAA4B;QAE5B,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QAEtC,oFAAoF;QACpF,0DAA0D;QAC1D,IAAI,IAAI,EAAE,MAAM,KAAK,IAAI;YAAE,OAAO,IAAI,CAAA;QAEtC,MAAM,SAAS,GAAkB;YAC/B,GAAG,aAAa;YAChB,GAAG,CAAC,IAAI,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;YAC3D,GAAG,CAAC,IAAI,EAAE,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;SAC9E,CAAA;QAED,wFAAwF;QACxF,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE,CAAC;YACjC,MAAM,WAAW,GAAG,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;YAEjD,IAAI,WAAW,KAAK,IAAI;gBAAE,SAAQ;YAElC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAA;YAEzC,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;gBACxD,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;gBAEzC;;;;;;;;;mBASG;gBACH,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC;oBAAE,SAAQ;gBAE3E,sEAAsE;gBACtE,MAAM,MAAM,GAAG,EAAE,GAAG,MAAM,EAA6B,CAAA;gBAEvD,OAAO,MAAM,CAAC,KAAK,CAAA;gBACnB,OAAO,MAAM,CAAC,WAAW,CAAA;gBAEzB,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;gBACzB,SAAS,CAAC,OAAO,CAAE,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAsB,CAAA;YAChF,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;CACF;AAED,MAAM,UAAU,GAAG,CAAC,OAAO,EAAE,OAAO,CAAU,CAAA;AAE9C,SAAS,MAAM,CAAC,UAAmC,EAAE,OAAe;IAClE,MAAM,IAAI,GAAG,UAAU,EAAE,IAAI,CAC3B,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,YAAY,IAAI,IAAI,SAAS,CAAC,OAAO,KAAK,OAAO,CAC1E,CAAA;IAED,OAAQ,IAAyB,IAAI,IAAI,CAAA;AAC3C,CAAC;AAED,SAAS,QAAQ,CACf,UAAmC,EACnC,OAAe;IAEf,MAAM,KAAK,GAAG,UAAU,EAAE,IAAI,CAC5B,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,YAAY,UAAU,IAAI,SAAS,CAAC,OAAO,KAAK,OAAO,CAChF,CAAA;IAED,OAAQ,KAAgC,IAAI,IAAI,CAAA;AAClD,CAAC"}

package/transpiled/directives/help/Help.d.ts

@@ -0,0 +1,22 @@
+/**
+ * What a resource or a method is, in the words an application chooses for it — read by
+ * everything that describes one: `OPTIONS`, discovery, and the tools MCP publishes.
+ *
+ * The operation states what it is too, and that is not this. An operation is written
+ * without knowledge of any route, and a method is an operation and a route together — the
+ * same operation mounted twice is two methods, and one sentence is not true of both.
+ */
+export declare class Help {
+    /** `node` says what the resource is; `method` what one of its methods is. */
+    readonly subject: Subject;
+    readonly title: string | undefined;
+    readonly description: string | undefined;
+    /**
+     * Whether the method is described at all. `help:method: null` takes it out of every
+     * answer — `OPTIONS`, discovery and the tools MCP publishes — and leaves it as callable
+     * as it was: a route something else reaches for, and nobody is meant to go looking for.
+     */
+    readonly hidden: boolean;
+    constructor(subject: Subject, value: unknown);
+}
+export type Subject = 'node' | 'method';

package/transpiled/directives/help/Help.js

@@ -0,0 +1,36 @@
+import { described } from './described.js';
+/**
+ * What a resource or a method is, in the words an application chooses for it — read by
+ * everything that describes one: `OPTIONS`, discovery, and the tools MCP publishes.
+ *
+ * The operation states what it is too, and that is not this. An operation is written
+ * without knowledge of any route, and a method is an operation and a route together — the
+ * same operation mounted twice is two methods, and one sentence is not true of both.
+ */
+export class Help {
+    /** `node` says what the resource is; `method` what one of its methods is. */
+    subject;
+    title;
+    description;
+    /**
+     * Whether the method is described at all. `help:method: null` takes it out of every
+     * answer — `OPTIONS`, discovery and the tools MCP publishes — and leaves it as callable
+     * as it was: a route something else reaches for, and nobody is meant to go looking for.
+     */
+    hidden;
+    constructor(subject, value) {
+        if (!(value !== null || subject === 'method'))
+            throw new Error(`Directive help:${subject}: only a method is hidden`);
+        if (value === null) {
+            this.subject = subject;
+            this.hidden = true;
+            return;
+        }
+        const stated = described(`help:${subject}`, value);
+        this.subject = subject;
+        this.hidden = false;
+        this.title = stated.title;
+        this.description = stated.description;
+    }
+}
+//# sourceMappingURL=Help.js.map

package/transpiled/directives/help/Help.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Help.js","sourceRoot":"","sources":["../../../source/directives/help/Help.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAA;AAE1D;;;;;;;GAOG;AACH,MAAM,OAAO,IAAI;IACf,6EAA6E;IAC7D,OAAO,CAAS;IAChB,KAAK,CAAoB;IACzB,WAAW,CAAoB;IAE/C;;;;OAIG;IACa,MAAM,CAAS;IAE/B,YAAmB,OAAgB,EAAE,KAAc;QACjD,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,QAAQ,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,kBAAkB,OAAO,2BAA2B,CAAC,CAAA;QAEvE,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;YACtB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;YAElB,OAAM;QACR,CAAC;QAED,MAAM,MAAM,GAAc,SAAS,CAAC,QAAQ,OAAO,EAAE,EAAE,KAAK,CAAC,CAAA;QAE7D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;QACzB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAA;IACvC,CAAC;CACF"}

package/transpiled/directives/help/Parameters.d.ts

@@ -0,0 +1,18 @@
+import { type Described } from './described.ts';
+/**
+ * What the parameters of a method are, by name: a route variable, or one of the
+ * querystring. Written where the method is, because what a variable means is what the
+ * route it is in makes of it.
+ *
+ * A name is not checked against the template, because the template is not what says them
+ * all: `map:segments` answers a variable under the property it fills instead, and that
+ * name is nowhere here. What matches nothing is not answered.
+ */
+export declare class Parameters {
+    readonly subject: Subject;
+    readonly parameters: Record<string, Described>;
+    /** What the route template names, which is a parameter whether an operation takes it or not. */
+    readonly variables: string[];
+    constructor(subject: Subject, value: unknown, route: string);
+}
+export type Subject = 'route' | 'query';

package/transpiled/directives/help/Parameters.js

@@ -0,0 +1,34 @@
+import { segment } from '../../RTD/segment.js';
+import { described } from './described.js';
+/**
+ * What the parameters of a method are, by name: a route variable, or one of the
+ * querystring. Written where the method is, because what a variable means is what the
+ * route it is in makes of it.
+ *
+ * A name is not checked against the template, because the template is not what says them
+ * all: `map:segments` answers a variable under the property it fills instead, and that
+ * name is nowhere here. What matches nothing is not answered.
+ */
+export class Parameters {
+    subject;
+    parameters;
+    /** What the route template names, which is a parameter whether an operation takes it or not. */
+    variables;
+    constructor(subject, value, route) {
+        if (!(typeof value === 'object' && value !== null && !Array.isArray(value)))
+            throw new Error(`Directive help:${subject}: the value names each parameter it describes`);
+        const parameters = {};
+        for (const [name, stated] of Object.entries(value))
+            parameters[name] = described(`help:${subject}.${name}`, stated);
+        this.subject = subject;
+        this.parameters = parameters;
+        this.variables = subject === 'route' ? names(route) : [];
+    }
+}
+/** The variables the template names, which are what a route parameter may be called. */
+function names(route) {
+    return segment(route)
+        .map((part) => part.fragment !== null ? null : part.wildcard === true ? '**' : part.placeholder)
+        .filter((name) => name !== null);
+}
+//# sourceMappingURL=Parameters.js.map

package/transpiled/directives/help/Parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Parameters.js","sourceRoot":"","sources":["../../../source/directives/help/Parameters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAC9C,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAA;AAE1D;;;;;;;;GAQG;AACH,MAAM,OAAO,UAAU;IACL,OAAO,CAAS;IAChB,UAAU,CAA2B;IAErD,gGAAgG;IAChF,SAAS,CAAU;IAEnC,YAAmB,OAAgB,EAAE,KAAc,EAAE,KAAa;QAChE,IAAI,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACzE,MAAM,IAAI,KAAK,CACb,kBAAkB,OAAO,+CAA+C,CACzE,CAAA;QAEH,MAAM,UAAU,GAA8B,EAAE,CAAA;QAEhD,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;YAChD,UAAU,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,QAAQ,OAAO,IAAI,IAAI,EAAE,EAAE,MAAM,CAAC,CAAA;QAEjE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,SAAS,GAAG,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAC1D,CAAC;CACF;AAED,wFAAwF;AACxF,SAAS,KAAK,CAAC,KAAa;IAC1B,OAAO,OAAO,CAAC,KAAK,CAAC;SAClB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACZ,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CACjF;SACA,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;AACpD,CAAC"}

package/transpiled/directives/help/described.d.ts

@@ -0,0 +1,16 @@
+/** What a resource, a method or a parameter says of itself, in the order it is written. */
+export interface Described {
+    title?: string;
+    description?: string;
+    /** what its methods are guarded by; see `guarded` */
+    authenticated?: boolean;
+    private?: boolean;
+    protected?: boolean;
+    system?: boolean;
+}
+/**
+ * A bare value is the title: it is the short thing, and the one a client has somewhere to
+ * put — a name is an address and reads as one. A sentence is written as a mapping, beside
+ * the title it explains, and either may stand alone.
+ */
+export declare function described(subject: string, value: unknown): Described;

package/transpiled/directives/help/described.js

@@ -0,0 +1,27 @@
+/**
+ * A bare value is the title: it is the short thing, and the one a client has somewhere to
+ * put — a name is an address and reads as one. A sentence is written as a mapping, beside
+ * the title it explains, and either may stand alone.
+ */
+export function described(subject, value) {
+    const stated = typeof value === 'string' ? { title: value } : value;
+    if (!(typeof stated === 'object' && stated !== null && !Array.isArray(stated)))
+        throw new Error(`Directive ${subject}: the value is a title, or a \`title\` and a \`description\``);
+    const { title, description, ...rest } = stated;
+    if (Object.keys(rest).length !== 0)
+        throw new Error(`Directive ${subject}: unknown ${Object.keys(rest)
+            .map((key) => `'${key}'`)
+            .join(', ')}`);
+    if (!(title === undefined || (typeof title === 'string' && title.trim().length > 0)))
+        throw new Error(`Directive ${subject}: a title cannot be empty`);
+    if (!(description === undefined ||
+        (typeof description === 'string' && description.trim().length > 0)))
+        throw new Error(`Directive ${subject}: a description cannot be empty`);
+    if (!(title !== undefined || description !== undefined))
+        throw new Error(`Directive ${subject}: says nothing`);
+    return {
+        ...(title === undefined ? {} : { title: title }),
+        ...(description === undefined ? {} : { description: description })
+    };
+}
+//# sourceMappingURL=described.js.map

package/transpiled/directives/help/described.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"described.js","sourceRoot":"","sources":["../../../source/directives/help/described.ts"],"names":[],"mappings":"AAYA;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,OAAe,EAAE,KAAc;IACvD,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;IAEnE,IAAI,CAAC,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5E,MAAM,IAAI,KAAK,CACb,aAAa,OAAO,8DAA8D,CACnF,CAAA;IAEH,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAiC,CAAA;IAEzE,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;QAChC,MAAM,IAAI,KAAK,CACb,aAAa,OAAO,aAAa,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;aAC/C,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,GAAG,CAAC;aACxB,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAA;IAEH,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAClF,MAAM,IAAI,KAAK,CAAC,aAAa,OAAO,2BAA2B,CAAC,CAAA;IAElE,IACE,CAAC,CACC,WAAW,KAAK,SAAS;QACzB,CAAC,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CACnE;QAED,MAAM,IAAI,KAAK,CAAC,aAAa,OAAO,iCAAiC,CAAC,CAAA;IAExE,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,WAAW,KAAK,SAAS,CAAC;QACrD,MAAM,IAAI,KAAK,CAAC,aAAa,OAAO,gBAAgB,CAAC,CAAA;IAEvD,OAAO;QACL,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAe,EAAE,CAAC;QAC1D,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,WAAqB,EAAE,CAAC;KAC7E,CAAA;AACH,CAAC"}

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

@@ -0,0 +1,22 @@
+import { Family } from './Family.ts';
+import type { Described } from './described.ts';
+import type { Directives } from '../../RTD/index.ts';
+import type { Introspection } from '../../Introspection.ts';
+export declare const help: Family;
+/**
+ * What the resource a method is on says of itself, or nothing where it says nothing. Read
+ * from the method because that is what carries a route's directives; every method of one
+ * node carries the same declaration.
+ */
+export declare function resource(directives: Directives): Described | null;
+/**
+ * What a resource is, taken from what its methods are: the flags are a method's, and a
+ * resource carries whichever of them any of its methods does — which is what a reader picks
+ * one icon by.
+ */
+export declare function guarded(methods: Record<string, Introspection>): Described;
+export { FAMILY, Family } from './Family.ts';
+export { Help } from './Help.ts';
+export { Parameters } from './Parameters.ts';
+export type { Directive } from './Family.ts';
+export type { Described } from './described.ts';

package/transpiled/directives/help/index.js

@@ -0,0 +1,34 @@
+import { Family, FAMILY } from './Family.js';
+export const help = new Family();
+/**
+ * What the resource a method is on says of itself, or nothing where it says nothing. Read
+ * from the method because that is what carries a route's directives; every method of one
+ * node carries the same declaration.
+ */
+export function resource(directives) {
+    const stated = Family.node(directives.declared(FAMILY));
+    if (stated === null)
+        return null;
+    return {
+        ...(stated.title === undefined ? {} : { title: stated.title }),
+        ...(stated.description === undefined ? {} : { description: stated.description })
+    };
+}
+/**
+ * What a resource is, taken from what its methods are: the flags are a method's, and a
+ * resource carries whichever of them any of its methods does — which is what a reader picks
+ * one icon by.
+ */
+export function guarded(methods) {
+    const described = {};
+    for (const introspection of Object.values(methods))
+        for (const flag of FLAGS)
+            if (introspection[flag] === true)
+                described[flag] = true;
+    return described;
+}
+const FLAGS = ['authenticated', 'private', 'protected', 'system'];
+export { FAMILY, Family } from './Family.js';
+export { Help } from './Help.js';
+export { Parameters } from './Parameters.js';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../source/directives/help/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAM5C,MAAM,CAAC,MAAM,IAAI,GAAG,IAAI,MAAM,EAAE,CAAA;AAEhC;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,UAAsB;IAC7C,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAY,MAAM,CAAC,CAAC,CAAA;IAElE,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IAEhC,OAAO;QACL,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;QAC9D,GAAG,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC;KACjF,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CAAC,OAAsC;IAC5D,MAAM,SAAS,GAAc,EAAE,CAAA;IAE/B,KAAK,MAAM,aAAa,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;QAChD,KAAK,MAAM,IAAI,IAAI,KAAK;YAAE,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,IAAI;gBAAE,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAEpF,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,eAAe,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAA;AAE1E,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA"}

package/transpiled/directives/index.d.ts

@@ -1,4 +1,9 @@
-import type { DirectiveFamily } from '../RTD';
-import type { Interceptor } from '../Interception';
+import type { DirectiveFamily } from '../RTD/index.ts';
+import type { Interceptor } from '../Interception.ts';
 export declare const families: DirectiveFamily[];
+/**
+ * `cors` first, so a preflight is answered before anything reads the request; `censor` next,
+ * so a refusal carries the CORS headers a page needs to read it; the page is last, and claims
+ * its own prefix.
+ */
 export declare const interceptors: Interceptor[];

package/transpiled/directives/index.js

@@ -1,14 +1,33 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.interceptors = exports.families = void 0;
-const auth_1 = require("./auth");
-const cache_1 = require("./cache");
-const cors_1 = require("./cors");
-const dev_1 = require("./dev");
-const octets_1 = require("./octets");
-const io_1 = require("./io");
-const vary_1 = require("./vary");
-const require_1 = require("./require");
-exports.families = [auth_1.authorization, io_1.io, cache_1.cache, vary_1.vary, require_1.req, octets_1.octets, dev_1.dev];
-exports.interceptors = [cors_1.cors];
+import { authorization } from './auth/index.js';
+import { cache } from './cache/index.js';
+import { cors } from './cors/index.js';
+import { censor } from './censor/index.js';
+import { dev } from './dev/index.js';
+import { octets } from './octets/index.js';
+import { io } from './io/index.js';
+import { map } from './map/index.js';
+import { mcp } from './mcp/index.js';
+import { req } from './require/index.js';
+import { flow } from './flow/index.js';
+import { help } from './help/index.js';
+import { discovery } from './oauth/index.js';
+import { Site } from '../Discovery/index.js';
+export const families = [
+    authorization,
+    io,
+    cache,
+    map,
+    mcp,
+    help,
+    req,
+    flow,
+    octets,
+    dev
+];
+/**
+ * `cors` first, so a preflight is answered before anything reads the request; `censor` next,
+ * so a refusal carries the CORS headers a page needs to read it; the page is last, and claims
+ * its own prefix.
+ */
+export const interceptors = [cors, censor, discovery, new Site()];
 //# sourceMappingURL=index.js.map

package/transpiled/directives/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/directives/index.ts"],"names":[],"mappings":";;;AAAA,iCAAsC;AACtC,mCAA+B;AAC/B,iCAA6B;AAC7B,+BAA2B;AAC3B,qCAAiC;AACjC,6BAAyB;AACzB,iCAA6B;AAC7B,uCAA+B;AAIlB,QAAA,QAAQ,GAAsB,CAAC,oBAAa,EAAE,OAAE,EAAE,aAAK,EAAE,WAAI,EAAE,aAAG,EAAE,eAAM,EAAE,SAAG,CAAC,CAAA;AAChF,QAAA,YAAY,GAAkB,CAAC,WAAI,CAAC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/directives/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC1C,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC1C,OAAO,EAAE,EAAE,EAAE,MAAM,eAAe,CAAA;AAClC,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,OAAO,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAA;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAI5C,MAAM,CAAC,MAAM,QAAQ,GAAsB;IACzC,aAAa;IACb,EAAE;IACF,KAAK;IACL,GAAG;IACH,GAAG;IACH,IAAI;IACJ,GAAG;IACH,IAAI;IACJ,MAAM;IACN,GAAG;CACJ,CAAA;AACD;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,CAAA"}

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

@@ -1,8 +1,13 @@
-import type { Input } from '../../io';
+import type { Sync } from './lib/throttle/index.ts';
+import type { Parameter } from '../../RTD/index.ts';
+import type { Input as Context } from '../../io.ts';
+import type * as http from '../../HTTP/index.ts';
 export interface Directive {
-    attach: (context: Input) => void;
+    precall: (context: Context, parameters: Parameter[]) => void;
+    /** Synchronous by contract: settling holds the response, and none of it needs I/O. */
+    settle?: (context: Context, response: http.OutgoingMessage) => void;
 }
 export interface Constructor {
     validate: (value: unknown) => void;
-    new (value: any): Directive;
+    new (value: any, sync: Sync, route: string): Directive;
 }

package/transpiled/directives/io/Directive.js

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

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

@@ -1,9 +1,28 @@
-import type { Directive } from './Directive';
-import type { Input as Context } from '../../io';
-import type { DirectiveFamily } from '../../RTD';
+import type * as http from '../../HTTP/index.ts';
+import type { Parameter, DirectiveFamily } from '../../RTD/index.ts';
+import type { Remotes } from '../../Remotes.ts';
+import type { Directive } from './Directive.ts';
+import type { Introspection } from '../../Introspection.ts';
+import type { extensions } from '@toa.io/core/types';
 export declare class IO implements DirectiveFamily<Directive> {
     readonly name = "io";
     readonly mandatory = true;
-    create(name: string, value: unknown): Directive;
-    preflight(directives: Directive[], context: Context): null;
+    private host;
+    /** Throttling reconciles through the atom of the gateways, one for every directive. */
+    private sync;
+    mount(host: extensions.Host): void;
+    create(name: string, value: unknown, remotes: Remotes, route: string): Directive;
+    precall(directives: Directive[], context: http.Context, parameters: Parameter[]): null;
+    /**
+     * What a whitelist admits is what the schema states. Without an `io:output` the reply is
+     * dropped before it is sent, so there is no output to describe at all.
+     */
+    explain(directives: Directive[], _: http.Context, introspection: Introspection): Introspection;
+    settle(directives: Directive[], context: http.Context, output: http.OutgoingMessage): void;
+    /**
+     * The ticker belongs to the family rather than to any route's directives, and the
+     * factory disposes every route it made — so this runs once per route at shutdown,
+     * and disposing an already stopped ticker is what makes that harmless.
+     */
+    dispose(): void;
 }

package/transpiled/directives/io/IO.js

@@ -1,33 +1,76 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IO = void 0;
-const Output_1 = require("./Output");
-const Input_1 = require("./Input");
-class IO {
+import { restrict } from '../../Introspection.js';
+import { Output } from './Output.js';
+import { Input } from './Input.js';
+import { Throttle } from './Throttle.js';
+import { Status } from './Status.js';
+import { Sync } from './lib/throttle/index.js';
+import { ATOM_GROUP } from '@toa.io/definitions/extensions.exposition';
+export class IO {
     name = 'io';
     mandatory = true;
-    create(name, value) {
+    host;
+    /** Throttling reconciles through the atom of the gateways, one for every directive. */
+    sync = null;
+    mount(host) {
+        this.host = host;
+    }
+    // eslint-disable-next-line max-params
+    create(name, value, remotes, route) {
         if (!(name in constructors))
-            throw new Error(`Directive 'io:${name}' is not implemented.`);
+            throw new Error(`Directive 'io:${name}' is not implemented`);
         const Directive = constructors[name];
         Directive.validate(value);
-        return new Directive(value);
+        if (name === 'throttle')
+            this.sync ??= new Sync(this.host.atom(ATOM_GROUP));
+        return new Directive(value, this.sync, route);
     }
-    preflight(directives, context) {
+    precall(directives, context, parameters) {
         let restricted = false;
         for (const directive of directives) {
-            restricted ||= directive instanceof Output_1.Output;
-            directive.attach(context);
+            restricted ||= directive instanceof Output;
+            directive.precall(context, parameters);
         }
         if (!restricted)
-            DENIAL.attach(context);
+            DENIAL.precall(context, parameters);
         return null;
     }
+    /**
+     * What a whitelist admits is what the schema states. Without an `io:output` the reply is
+     * dropped before it is sent, so there is no output to describe at all.
+     */
+    explain(directives, _, introspection) {
+        let restricted = false;
+        for (const directive of directives) {
+            if (directive instanceof Input)
+                introspection.input = restrict(introspection.input, directive.allowed);
+            if (!(directive instanceof Output))
+                continue;
+            restricted = true;
+            if (!directive.disabled)
+                introspection.output = restrict(introspection.output, directive.allowed);
+        }
+        if (!restricted)
+            delete introspection.output;
+        return introspection;
+    }
+    settle(directives, context, output) {
+        for (const directive of directives)
+            directive.settle?.(context, output);
+    }
+    /**
+     * The ticker belongs to the family rather than to any route's directives, and the
+     * factory disposes every route it made — so this runs once per route at shutdown,
+     * and disposing an already stopped ticker is what makes that harmless.
+     */
+    dispose() {
+        this.sync?.dispose();
+    }
 }
-exports.IO = IO;
 const constructors = {
-    output: Output_1.Output,
-    input: Input_1.Input
+    input: Input,
+    output: Output,
+    status: Status,
+    throttle: Throttle
 };
-const DENIAL = new Output_1.Output([]);
+const DENIAL = new Output([]);
 //# sourceMappingURL=IO.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"IO.js","sourceRoot":"","sources":["../../../source/directives/io/IO.ts"],"names":[],"mappings":";;;AAAA,qCAAiC;AACjC,mCAA+B;AAK/B,MAAa,EAAE;IACG,IAAI,GAAG,IAAI,CAAA;IACX,SAAS,GAAG,IAAI,CAAA;IAEzB,MAAM,CAAE,IAAY,EAAE,KAAc;QACzC,IAAI,CAAC,CAAC,IAAI,IAAI,YAAY,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,uBAAuB,CAAC,CAAA;QAE/D,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;QAEpC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QAEzB,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAA;IAC7B,CAAC;IAEM,SAAS,CAAE,UAAuB,EAAE,OAAgB;QACzD,IAAI,UAAU,GAAG,KAAK,CAAA;QAEtB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,UAAU,KAAK,SAAS,YAAY,eAAM,CAAA;YAE1C,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QAC3B,CAAC;QAED,IAAI,CAAC,UAAU;YACb,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QAExB,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AA7BD,gBA6BC;AAED,MAAM,YAAY,GAAgC;IAChD,MAAM,EAAE,eAAM;IACd,KAAK,EAAE,aAAK;CACb,CAAA;AAED,MAAM,MAAM,GAAW,IAAI,eAAM,CAAC,EAAE,CAAC,CAAA"}
+{"version":3,"file":"IO.js","sourceRoot":"","sources":["../../../source/directives/io/IO.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAA;AAM9C,OAAO,EAAE,UAAU,EAAE,MAAM,2CAA2C,CAAA;AAGtE,MAAM,OAAO,EAAE;IACG,IAAI,GAAG,IAAI,CAAA;IACX,SAAS,GAAG,IAAI,CAAA;IAExB,IAAI,CAAkB;IAE9B,uFAAuF;IAC/E,IAAI,GAAgB,IAAI,CAAA;IAEzB,KAAK,CAAC,IAAqB;QAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED,sCAAsC;IAC/B,MAAM,CACX,IAAY,EACZ,KAAc,EACd,OAAgB,EAChB,KAAa;QAEb,IAAI,CAAC,CAAC,IAAI,IAAI,YAAY,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,sBAAsB,CAAC,CAAA;QAE9D,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;QAEpC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QAEzB,IAAI,IAAI,KAAK,UAAU;YAAE,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAA;QAE3E,OAAO,IAAI,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,IAAK,EAAE,KAAK,CAAC,CAAA;IAChD,CAAC;IAEM,OAAO,CACZ,UAAuB,EACvB,OAAqB,EACrB,UAAuB;QAEvB,IAAI,UAAU,GAAG,KAAK,CAAA;QAEtB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,UAAU,KAAK,SAAS,YAAY,MAAM,CAAA;YAE1C,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;QACxC,CAAC;QAED,IAAI,CAAC,UAAU;YAAE,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;QAEpD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACI,OAAO,CACZ,UAAuB,EACvB,CAAe,EACf,aAA4B;QAE5B,IAAI,UAAU,GAAG,KAAK,CAAA;QAEtB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,IAAI,SAAS,YAAY,KAAK;gBAC5B,aAAa,CAAC,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;YAExE,IAAI,CAAC,CAAC,SAAS,YAAY,MAAM,CAAC;gBAAE,SAAQ;YAE5C,UAAU,GAAG,IAAI,CAAA;YAEjB,IAAI,CAAC,SAAS,CAAC,QAAQ;gBACrB,aAAa,CAAC,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QAC5E,CAAC;QAED,IAAI,CAAC,UAAU;YAAE,OAAO,aAAa,CAAC,MAAM,CAAA;QAE5C,OAAO,aAAa,CAAA;IACtB,CAAC;IAEM,MAAM,CACX,UAAuB,EACvB,OAAqB,EACrB,MAA4B;QAE5B,KAAK,MAAM,SAAS,IAAI,UAAU;YAAE,SAAS,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IACzE,CAAC;IAED;;;;OAIG;IACI,OAAO;QACZ,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,CAAA;IACtB,CAAC;CACF;AAED,MAAM,YAAY,GAAgC;IAChD,KAAK,EAAE,KAAK;IACZ,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,QAAQ;CACnB,CAAA;AAED,MAAM,MAAM,GAAc,IAAI,MAAM,CAAC,EAAE,CAAC,CAAA"}

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

@@ -1,10 +1,11 @@
-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 Input implements Directive {
-    private readonly permissions;
+    /** what a client may send, which is therefore what the input schema states */
+    readonly allowed: Set<string>;
     constructor(permissions: Permissions);
     static validate(permissions: unknown): asserts permissions is Permissions;
-    attach(context: Context): void;
+    precall(context: Context): void;
     private check;
     private violation;
 }