@toa.io/extensions.exposition 1.0.0-alpha.152 → 1.0.0-alpha.154

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

@@ -0,0 +1,26 @@
+import { Keys } from './Keys';
+import { Interval } from './Interval';
+import type { Configuration } from './Configuration';
+import type { Input as Context, Output } from '../../../../io';
+export declare class Quotas {
+    private readonly requests;
+    private readonly cooldown;
+    private readonly interval;
+    private readonly keys;
+    private readonly quotas;
+    private readonly blocked;
+    constructor(options: Options);
+    static create(configuration: Configuration): Quotas;
+    ok(context: Context): boolean;
+    use(input: Context, output: Output): void;
+    dispose(): void;
+    private readonly reset;
+    private block;
+}
+interface Options {
+    keys: Keys;
+    requests: number;
+    cooldown: number;
+    interval: Interval;
+}
+export {};

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

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Quotas = void 0;
+const openspan_1 = require("openspan");
+const Keys_1 = require("./Keys");
+const Quota_1 = require("./Quota");
+const Interval_1 = require("./Interval");
+class Quotas {
+    requests;
+    cooldown;
+    interval;
+    keys;
+    quotas = {};
+    blocked = {};
+    constructor(options) {
+        this.requests = options.requests;
+        this.cooldown = options.cooldown;
+        this.interval = options.interval;
+        this.keys = options.keys;
+        this.interval.on('tick', this.reset);
+    }
+    static create(configuration) {
+        const requests = configuration.requests;
+        const cooldown = configuration.cooldown;
+        const keys = Keys_1.Keys.create(configuration.key, configuration.condition);
+        const interval = new Interval_1.Interval(configuration.interval);
+        return new this({ requests, cooldown, keys, interval });
+    }
+    ok(context) {
+        const key = this.keys.get(context);
+        return this.blocked[key] !== true;
+    }
+    use(input, output) {
+        const key = this.keys.match(input, output);
+        if (key === null)
+            return;
+        this.quotas[key] ??= new Quota_1.Quota(this.requests);
+        const ok = this.quotas[key].use();
+        if (!ok)
+            this.block(key);
+    }
+    dispose() {
+        this.interval.dispose();
+    }
+    reset = () => {
+        for (const key in this.quotas) {
+            const quota = this.quotas[key];
+            if (quota.idle)
+                delete this.quotas[key];
+            else
+                quota.reset();
+        }
+    };
+    block(key) {
+        this.blocked[key] = true;
+        setTimeout(() => delete this.blocked[key], this.cooldown);
+        openspan_1.console.info('Quota exceeded, key blocked', { key, cooldown: this.cooldown });
+    }
+}
+exports.Quotas = Quotas;
+//# sourceMappingURL=Quotas.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Quotas.js","sourceRoot":"","sources":["../../../../../source/directives/io/lib/throttle/Quotas.ts"],"names":[],"mappings":";;;AAAA,uCAAkC;AAClC,iCAA6B;AAC7B,mCAA+B;AAC/B,yCAAqC;AAIrC,MAAa,MAAM;IACA,QAAQ,CAAQ;IAChB,QAAQ,CAAQ;IAChB,QAAQ,CAAU;IAClB,IAAI,CAAM;IACV,MAAM,GAAsC,EAAE,CAAA;IAC9C,OAAO,GAAwC,EAAE,CAAA;IAElE,YAAoB,OAAgB;QAClC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QAChC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QAChC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QAChC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;QAExB,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACtC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAE,aAA4B;QAChD,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAA;QACvC,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAA;QACvC,MAAM,IAAI,GAAG,WAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,SAAS,CAAC,CAAA;QACpE,MAAM,QAAQ,GAAG,IAAI,mBAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;QAErD,OAAO,IAAI,IAAI,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAA;IACzD,CAAC;IAEM,EAAE,CAAE,OAAgB;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QAElC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,CAAA;IACnC,CAAC;IAEM,GAAG,CAAE,KAAc,EAAE,MAAc;QACxC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAE1C,IAAI,GAAG,KAAK,IAAI;YACd,OAAM;QAER,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,IAAI,aAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAE7C,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAE,CAAC,GAAG,EAAE,CAAA;QAElC,IAAI,CAAC,EAAE;YACL,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACnB,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;IACzB,CAAC;IAEgB,KAAK,GAAG,GAAS,EAAE;QAClC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAE,CAAA;YAE/B,IAAI,KAAK,CAAC,IAAI;gBACZ,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;;gBAEvB,KAAK,CAAC,KAAK,EAAE,CAAA;QACjB,CAAC;IACH,CAAC,CAAA;IAEO,KAAK,CAAE,GAAW;QACxB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;QAExB,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;QAEzD,kBAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC/E,CAAC;CACF;AApED,wBAoEC"}

package/transpiled/directives/io/lib/throttle/components/Component.d.ts

@@ -0,0 +1,4 @@
+import type { Input as Context } from '../../../../../io';
+export interface Component {
+    get: (context: Context) => string;
+}

package/transpiled/directives/io/lib/throttle/components/Component.js

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

package/transpiled/directives/io/lib/throttle/components/Component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Component.js","sourceRoot":"","sources":["../../../../../../source/directives/io/lib/throttle/components/Component.ts"],"names":[],"mappings":""}

package/transpiled/directives/io/lib/throttle/components/IP.d.ts

@@ -0,0 +1,6 @@
+import type { Context } from '../../../../../HTTP';
+import type { Component } from './Component';
+export declare class IP implements Component {
+    get(context: Context): string;
+    private xff;
+}

package/transpiled/directives/io/lib/throttle/components/IP.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IP = void 0;
+class IP {
+    get(context) {
+        return this.xff(context) ?? context.request.socket.remoteAddress ?? '';
+    }
+    xff(context) {
+        const xff = context.request.headers['x-forwarded-for'];
+        if (xff === undefined || typeof xff === 'string')
+            return xff;
+        let ip;
+        for (const value of xff) {
+            ip = value.trim();
+            if (!local(ip))
+                return ip;
+        }
+        return ip; // last otherwise
+    }
+}
+exports.IP = IP;
+function local(ip) {
+    return (ip === 'unknown' ||
+        ip === '' ||
+        ip === '127.0.0.1' ||
+        ip === '::1' ||
+        ip.startsWith('10.') ||
+        ip.startsWith('192.168.') ||
+        ip.match(/^172\.(1[6-9]|2[0-9]|3[0-1])\./) !== null ||
+        ip.startsWith('fd') ||
+        ip.startsWith('fe80:'));
+}
+//# sourceMappingURL=IP.js.map

package/transpiled/directives/io/lib/throttle/components/IP.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IP.js","sourceRoot":"","sources":["../../../../../../source/directives/io/lib/throttle/components/IP.ts"],"names":[],"mappings":";;;AAGA,MAAa,EAAE;IACN,GAAG,CAAE,OAAgB;QAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,IAAI,EAAE,CAAA;IACxE,CAAC;IAEO,GAAG,CAAE,OAAgB;QAC3B,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;QAEtD,IAAI,GAAG,KAAK,SAAS,IAAI,OAAO,GAAG,KAAK,QAAQ;YAC9C,OAAO,GAAG,CAAA;QAEZ,IAAI,EAAE,CAAA;QAEN,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE,CAAC;YACxB,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;YAEjB,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACZ,OAAO,EAAE,CAAA;QACb,CAAC;QAED,OAAO,EAAE,CAAA,CAAC,iBAAiB;IAC7B,CAAC;CACF;AAtBD,gBAsBC;AAED,SAAS,KAAK,CAAE,EAAU;IACxB,OAAO,CACL,EAAE,KAAK,SAAS;QAChB,EAAE,KAAK,EAAE;QACT,EAAE,KAAK,WAAW;QAClB,EAAE,KAAK,KAAK;QACZ,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC;QACpB,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;QACzB,EAAE,CAAC,KAAK,CAAC,gCAAgC,CAAC,KAAK,IAAI;QACnD,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC;QACnB,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CACvB,CAAA;AACH,CAAC"}

package/transpiled/directives/io/lib/throttle/components/Path.d.ts

@@ -0,0 +1,5 @@
+import type { Context } from '../../../../../HTTP';
+import type { Component } from './Component';
+export declare class Path implements Component {
+    get(context: Context): string;
+}

package/transpiled/directives/io/lib/throttle/components/Path.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Path = void 0;
+class Path {
+    get(context) {
+        return context.url.pathname;
+    }
+}
+exports.Path = Path;
+//# sourceMappingURL=Path.js.map

package/transpiled/directives/io/lib/throttle/components/Path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Path.js","sourceRoot":"","sources":["../../../../../../source/directives/io/lib/throttle/components/Path.ts"],"names":[],"mappings":";;;AAGA,MAAa,IAAI;IACR,GAAG,CAAE,OAAgB;QAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAA;IAC7B,CAAC;CACF;AAJD,oBAIC"}

package/transpiled/directives/io/lib/throttle/components/index.d.ts

@@ -0,0 +1,5 @@
+import type { KeyComponentMethod } from '../Configuration';
+import type { Component } from './Component';
+type Constructor<T> = new (options: unknown) => T;
+export declare const Components: Record<KeyComponentMethod, Constructor<Component>>;
+export type { Component };

package/transpiled/directives/io/lib/throttle/components/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Components = void 0;
+const Path_1 = require("./Path");
+const IP_1 = require("./IP");
+exports.Components = {
+    ip: IP_1.IP,
+    path: Path_1.Path
+};
+//# sourceMappingURL=index.js.map

package/transpiled/directives/io/lib/throttle/components/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../source/directives/io/lib/throttle/components/index.ts"],"names":[],"mappings":";;;AAAA,iCAA6B;AAC7B,6BAAyB;AAMZ,QAAA,UAAU,GAAuD;IAC5E,EAAE,EAAE,OAAE;IACN,IAAI,EAAE,WAAI;CACX,CAAA"}

package/transpiled/directives/io/lib/throttle/conditions/Condition.d.ts

@@ -0,0 +1,4 @@
+import type { Input, Output } from '../../../../../io';
+export interface Condition {
+    match: (input: Input, output: Output) => boolean;
+}

package/transpiled/directives/io/lib/throttle/conditions/Condition.js

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

package/transpiled/directives/io/lib/throttle/conditions/Condition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Condition.js","sourceRoot":"","sources":["../../../../../../source/directives/io/lib/throttle/conditions/Condition.ts"],"names":[],"mappings":""}

package/transpiled/directives/io/lib/throttle/conditions/Status.d.ts

@@ -0,0 +1,7 @@
+import type { Input, Output } from '../../../../../io';
+import type { Condition } from './Condition';
+export declare class Status implements Condition {
+    private readonly status;
+    constructor(status: unknown);
+    match(input: Input, output: Output): boolean;
+}

package/transpiled/directives/io/lib/throttle/conditions/Status.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Status = void 0;
+const node_assert_1 = __importDefault(require("node:assert"));
+class Status {
+    status;
+    constructor(status) {
+        node_assert_1.default.ok(typeof status === 'number', 'Status must be a number');
+        this.status = status;
+    }
+    match(input, output) {
+        return output?.status === this.status;
+    }
+}
+exports.Status = Status;
+//# sourceMappingURL=Status.js.map

package/transpiled/directives/io/lib/throttle/conditions/Status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Status.js","sourceRoot":"","sources":["../../../../../../source/directives/io/lib/throttle/conditions/Status.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAgC;AAIhC,MAAa,MAAM;IACA,MAAM,CAAQ;IAE/B,YAAoB,MAAe;QACjC,qBAAM,CAAC,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,EAAE,yBAAyB,CAAC,CAAA;QAEhE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEM,KAAK,CAAE,KAAY,EAAE,MAAc;QACxC,OAAO,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC,MAAM,CAAA;IACvC,CAAC;CACF;AAZD,wBAYC"}

package/transpiled/directives/io/lib/throttle/conditions/index.d.ts

@@ -0,0 +1,5 @@
+import type { KeyConditionMethod } from '../Configuration';
+import type { Condition } from './Condition';
+type Constructor<T> = new (options: unknown) => T;
+export declare const Conditions: Record<KeyConditionMethod, Constructor<Condition>>;
+export type { Condition };

package/transpiled/directives/io/lib/throttle/conditions/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Conditions = void 0;
+const Status_1 = require("./Status");
+exports.Conditions = {
+    status: Status_1.Status
+};
+//# sourceMappingURL=index.js.map

package/transpiled/directives/io/lib/throttle/conditions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../source/directives/io/lib/throttle/conditions/index.ts"],"names":[],"mappings":";;;AAAA,qCAAiC;AAMpB,QAAA,UAAU,GAAuD;IAC5E,MAAM,EAAE,eAAM;CACf,CAAA"}

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

@@ -0,0 +1,2 @@
+export { Quotas } from './Quotas';
+export { parse, type Configuration, type Declaration } from './Configuration';

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parse = exports.Quotas = void 0;
+var Quotas_1 = require("./Quotas");
+Object.defineProperty(exports, "Quotas", { enumerable: true, get: function () { return Quotas_1.Quotas; } });
+var Configuration_1 = require("./Configuration");
+Object.defineProperty(exports, "parse", { enumerable: true, get: function () { return Configuration_1.parse; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../source/directives/io/lib/throttle/index.ts"],"names":[],"mappings":";;;AAAA,mCAAiC;AAAxB,gGAAA,MAAM,OAAA;AACf,iDAA6E;AAApE,sGAAA,KAAK,OAAA"}

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

@@ -1,7 +1,9 @@
 import { type Schema } from '@toa.io/schemas';
 import type { Permissions as InputPermissions } from './Input';
 import type { Permissions as OutputPermissions } from './Output';
+import type { Declaration as ThrottleDeclaration } from './lib/throttle';
 import type { Message } from './Message';
 export declare const message: Schema<Message | Message[]>;
 export declare const input: Schema<InputPermissions>;
 export declare const output: Schema<OutputPermissions>;
+export declare const throttle: Schema<ThrottleDeclaration>;

package/transpiled/directives/io/schemas.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.output = exports.input = exports.message = void 0;
+exports.throttle = exports.output = exports.input = exports.message = void 0;
 const node_path_1 = require("node:path");
 const schemas_1 = __importDefault(require("@toa.io/schemas"));
 const path = (0, node_path_1.resolve)(__dirname, '../../../schemas/io');
@@ -11,4 +11,5 @@ const namespace = schemas_1.default.namespace(path);
 exports.message = namespace.schema('message');
 exports.input = namespace.schema('input');
 exports.output = namespace.schema('output');
+exports.throttle = namespace.schema('throttle');
 //# sourceMappingURL=schemas.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../source/directives/io/schemas.ts"],"names":[],"mappings":";;;;;;AAAA,yCAAmC;AACnC,8DAAsD;AAKtD,MAAM,IAAI,GAAG,IAAA,mBAAO,EAAC,SAAS,EAAE,qBAAqB,CAAC,CAAA;AACtD,MAAM,SAAS,GAAG,iBAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;AAE5B,QAAA,OAAO,GAAgC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;AAClE,QAAA,KAAK,GAA6B,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AAC3D,QAAA,MAAM,GAA8B,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA"}
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../source/directives/io/schemas.ts"],"names":[],"mappings":";;;;;;AAAA,yCAAmC;AACnC,8DAAsD;AAOtD,MAAM,IAAI,GAAG,IAAA,mBAAO,EAAC,SAAS,EAAE,qBAAqB,CAAC,CAAA;AACtD,MAAM,SAAS,GAAG,iBAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;AAE5B,QAAA,OAAO,GAAgC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;AAClE,QAAA,KAAK,GAA6B,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AAC3D,QAAA,MAAM,GAA8B,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;AAC9D,QAAA,QAAQ,GAAgC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA"}