@stacks/api-toolkit 1.12.0 → 1.12.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/api-toolkit",
-  "version": "1.12.0",
+  "version": "1.12.1",
   "description": "API development toolkit",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",

package/dist/fastify/cache.d.ts

@@ -1,31 +0,0 @@
-import { FastifyReply } from 'fastify';
-/**
- * A `Cache-Control` header used for re-validation based caching.
- * * `public` == allow proxies/CDNs to cache as opposed to only local browsers.
- * * `no-cache` == clients can cache a resource but should revalidate each time before using it.
- * * `must-revalidate` == somewhat redundant directive to assert that cache must be revalidated, required by some CDNs
- */
-export declare const CACHE_CONTROL_MUST_REVALIDATE = "public, no-cache, must-revalidate";
-export declare function setResponseNonCacheable(reply: FastifyReply): Promise<void>;
-/**
- * Parses the etag values from a raw `If-None-Match` request header value.
- * The wrapping double quotes (if any) and validation prefix (if any) are stripped.
- * The parsing is permissive to account for commonly non-spec-compliant clients, proxies, CDNs, etc.
- * E.g. the value:
- * ```js
- * `"a", W/"b", c,d,   "e", "f"`
- * ```
- * Would be parsed and returned as:
- * ```js
- * ['a', 'b', 'c', 'd', 'e', 'f']
- * ```
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match#syntax
- * ```
- * If-None-Match: "etag_value"
- * If-None-Match: "etag_value", "etag_value", ...
- * If-None-Match: *
- * ```
- * @param ifNoneMatchHeaderValue - raw header value
- * @returns an array of etag values
- */
-export declare function parseIfNoneMatchHeader(ifNoneMatchHeaderValue: string | undefined): string[] | undefined;

package/dist/fastify/cache.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CACHE_CONTROL_MUST_REVALIDATE = void 0;
-exports.setResponseNonCacheable = setResponseNonCacheable;
-exports.parseIfNoneMatchHeader = parseIfNoneMatchHeader;
-const logger_1 = require("../logger");
-/**
- * A `Cache-Control` header used for re-validation based caching.
- * * `public` == allow proxies/CDNs to cache as opposed to only local browsers.
- * * `no-cache` == clients can cache a resource but should revalidate each time before using it.
- * * `must-revalidate` == somewhat redundant directive to assert that cache must be revalidated, required by some CDNs
- */
-exports.CACHE_CONTROL_MUST_REVALIDATE = 'public, no-cache, must-revalidate';
-async function setResponseNonCacheable(reply) {
-    await reply.removeHeader('Cache-Control');
-    await reply.removeHeader('ETag');
-}
-/**
- * Parses the etag values from a raw `If-None-Match` request header value.
- * The wrapping double quotes (if any) and validation prefix (if any) are stripped.
- * The parsing is permissive to account for commonly non-spec-compliant clients, proxies, CDNs, etc.
- * E.g. the value:
- * ```js
- * `"a", W/"b", c,d,   "e", "f"`
- * ```
- * Would be parsed and returned as:
- * ```js
- * ['a', 'b', 'c', 'd', 'e', 'f']
- * ```
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match#syntax
- * ```
- * If-None-Match: "etag_value"
- * If-None-Match: "etag_value", "etag_value", ...
- * If-None-Match: *
- * ```
- * @param ifNoneMatchHeaderValue - raw header value
- * @returns an array of etag values
- */
-function parseIfNoneMatchHeader(ifNoneMatchHeaderValue) {
-    if (!ifNoneMatchHeaderValue) {
-        return undefined;
-    }
-    // Strip wrapping double quotes like `"hello"` and the ETag validation-prefix like `W/"hello"`.
-    // The API returns compliant, strong-validation ETags (double quoted ASCII), but can't control what
-    // clients, proxies, CDNs, etc may provide.
-    const normalized = /^(?:"|W\/")?(.*?)"?$/gi.exec(ifNoneMatchHeaderValue.trim())?.[1];
-    if (!normalized) {
-        // This should never happen unless handling a buggy request with something like `If-None-Match: ""`,
-        // or if there's a flaw in the above code. Log warning for now.
-        logger_1.logger.warn(`Normalized If-None-Match header is falsy: ${ifNoneMatchHeaderValue}`);
-        return undefined;
-    }
-    else if (normalized.includes(',')) {
-        // Multiple etag values provided, likely irrelevant extra values added by a proxy/CDN.
-        // Split on comma, also stripping quotes, weak-validation prefixes, and extra whitespace.
-        return normalized.split(/(?:W\/"|")?(?:\s*),(?:\s*)(?:W\/"|")?/gi);
-    }
-    else {
-        // Single value provided (the typical case)
-        return [normalized];
-    }
-}
-//# sourceMappingURL=cache.js.map

package/dist/fastify/cache.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../src/fastify/cache.ts"],"names":[],"mappings":";;;AAWA,0DAGC;AAuBD,wDAuBC;AA3DD,sCAAmC;AAEnC;;;;;GAKG;AACU,QAAA,6BAA6B,GAAG,mCAAmC,CAAC;AAE1E,KAAK,UAAU,uBAAuB,CAAC,KAAmB;IAC/D,MAAM,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IAC1C,MAAM,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,sBAAsB,CACpC,sBAA0C;IAE1C,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,+FAA+F;IAC/F,mGAAmG;IACnG,2CAA2C;IAC3C,MAAM,UAAU,GAAG,wBAAwB,CAAC,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACrF,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,oGAAoG;QACpG,+DAA+D;QAC/D,eAAM,CAAC,IAAI,CAAC,6CAA6C,sBAAsB,EAAE,CAAC,CAAC;QACnF,OAAO,SAAS,CAAC;IACnB,CAAC;SAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACpC,sFAAsF;QACtF,yFAAyF;QACzF,OAAO,UAAU,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;IACrE,CAAC;SAAM,CAAC;QACN,2CAA2C;QAC3C,OAAO,CAAC,UAAU,CAAC,CAAC;IACtB,CAAC;AACH,CAAC"}

package/dist/fastify/fastify.d.ts

@@ -1,16 +0,0 @@
-import { FastifyInstance } from 'fastify';
-import { IFastifyMetrics } from 'fastify-metrics';
-/**
- * Creates a Fastify server that handles Prometheus metrics and CORS headers automatically.
- * @returns Fastify instance
- */
-export declare function buildFastifyApiServer(): Promise<FastifyInstance>;
-/**
- * Creates a Fastify server that serves a `/metrics` endpoint with metrics taken from
- * `FastifyMetrics`.
- * @param args - Fastify instance metrics decorator
- * @returns Fastify instance
- */
-export declare function buildPrometheusServer(args: {
-    metrics: IFastifyMetrics;
-}): Promise<FastifyInstance>;

package/dist/fastify/fastify.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildFastifyApiServer = buildFastifyApiServer;
-exports.buildPrometheusServer = buildPrometheusServer;
-const cors_1 = require("@fastify/cors");
-const fastify_1 = require("fastify");
-const fastify_metrics_1 = require("fastify-metrics");
-const logger_1 = require("../logger");
-const values_1 = require("../helpers/values");
-/**
- * Creates a Fastify server that handles Prometheus metrics and CORS headers automatically.
- * @returns Fastify instance
- */
-async function buildFastifyApiServer() {
-    const fastify = (0, fastify_1.default)({
-        trustProxy: true,
-        logger: logger_1.PINO_LOGGER_CONFIG,
-    }).withTypeProvider();
-    if (values_1.isProdEnv) {
-        await fastify.register(fastify_metrics_1.default, { endpoint: null });
-    }
-    await fastify.register(cors_1.default);
-    return fastify;
-}
-/**
- * Creates a Fastify server that serves a `/metrics` endpoint with metrics taken from
- * `FastifyMetrics`.
- * @param args - Fastify instance metrics decorator
- * @returns Fastify instance
- */
-async function buildPrometheusServer(args) {
-    const promServer = (0, fastify_1.default)({
-        trustProxy: true,
-        logger: logger_1.PINO_LOGGER_CONFIG,
-    });
-    promServer.route({
-        url: '/metrics',
-        method: 'GET',
-        logLevel: 'info',
-        handler: async (_, reply) => {
-            await reply.type('text/plain').send(await args.metrics.client.register.metrics());
-        },
-    });
-    return promServer;
-}
-//# sourceMappingURL=fastify.js.map

package/dist/fastify/fastify.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fastify.js","sourceRoot":"","sources":["../../src/fastify/fastify.ts"],"names":[],"mappings":";;AAWA,sDAUC;AAQD,sDAgBC;AA7CD,wCAAwC;AACxC,qCAAmD;AACnD,qDAAkE;AAClE,sCAA+C;AAE/C,8CAA8C;AAE9C;;;GAGG;AACI,KAAK,UAAU,qBAAqB;IACzC,MAAM,OAAO,GAAG,IAAA,iBAAO,EAAC;QACtB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,2BAAkB;KAC3B,CAAC,CAAC,gBAAgB,EAAuB,CAAC;IAC3C,IAAI,kBAAS,EAAE,CAAC;QACd,MAAM,OAAO,CAAC,QAAQ,CAAC,yBAAc,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,CAAC;IACD,MAAM,OAAO,CAAC,QAAQ,CAAC,cAAW,CAAC,CAAC;IACpC,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,qBAAqB,CAAC,IAE3C;IACC,MAAM,UAAU,GAAG,IAAA,iBAAO,EAAC;QACzB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,2BAAkB;KAC3B,CAAC,CAAC;IACH,UAAU,CAAC,KAAK,CAAC;QACf,GAAG,EAAE,UAAU;QACf,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,MAAM;QAChB,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE;YAC1B,MAAM,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;QACpF,CAAC;KACF,CAAC,CAAC;IACH,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/fastify/index.d.ts

@@ -1,4 +0,0 @@
-export * from './cache';
-export * from './fastify';
-export * from './openapi';
-export * from './schemas';

package/dist/fastify/index.js

@@ -1,21 +0,0 @@
-"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./cache"), exports);
-__exportStar(require("./fastify"), exports);
-__exportStar(require("./openapi"), exports);
-__exportStar(require("./schemas"), exports);
-//# sourceMappingURL=index.js.map

package/dist/fastify/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/fastify/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,4CAA0B;AAC1B,4CAA0B;AAC1B,4CAA0B"}

package/dist/fastify/openapi.d.ts

@@ -1,13 +0,0 @@
-import { FastifyPluginAsync, FastifyPluginCallback } from 'fastify';
-import { SwaggerOptions } from '@fastify/swagger';
-export interface OpenApiGeneratorOptions {
-    apiDefinition: FastifyPluginAsync | FastifyPluginCallback;
-    swaggerOptions?: SwaggerOptions;
-    prefix?: string;
-    outputDirectory?: string;
-}
-/**
- * Generates OpenAPI JSON and YAML spec documents based on a given Fastify API plugin with optional
- * Swagger definitions.
- */
-export declare function generateOpenApiSpec(options: OpenApiGeneratorOptions): Promise<void>;

package/dist/fastify/openapi.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateOpenApiSpec = generateOpenApiSpec;
-const fastify_1 = require("fastify");
-const swagger_1 = require("@fastify/swagger");
-const fs_1 = require("fs");
-/**
- * Generates OpenAPI JSON and YAML spec documents based on a given Fastify API plugin with optional
- * Swagger definitions.
- */
-async function generateOpenApiSpec(options) {
-    const fastify = (0, fastify_1.default)().withTypeProvider();
-    await fastify.register(swagger_1.default, options.swaggerOptions);
-    await fastify.register(options.apiDefinition, { prefix: options.prefix });
-    await fastify.ready();
-    const directory = options.outputDirectory ?? './tmp';
-    if (!(0, fs_1.existsSync)(directory))
-        (0, fs_1.mkdirSync)(directory);
-    (0, fs_1.writeFileSync)(`${directory}/openapi.yaml`, fastify.swagger({ yaml: true }));
-    (0, fs_1.writeFileSync)(`${directory}/openapi.json`, JSON.stringify(fastify.swagger(), null, 2));
-    await fastify.close();
-}
-//# sourceMappingURL=openapi.js.map

package/dist/fastify/openapi.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"openapi.js","sourceRoot":"","sources":["../../src/fastify/openapi.ts"],"names":[],"mappings":";;AAiBA,kDAYC;AA7BD,qCAA6E;AAG7E,8CAA8C;AAC9C,2BAA0D;AAS1D;;;GAGG;AACI,KAAK,UAAU,mBAAmB,CAAC,OAAgC;IACxE,MAAM,OAAO,GAAG,IAAA,iBAAO,GAAE,CAAC,gBAAgB,EAAuB,CAAC;IAClE,MAAM,OAAO,CAAC,QAAQ,CAAC,iBAAc,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/D,MAAM,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1E,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;IAEtB,MAAM,SAAS,GAAG,OAAO,CAAC,eAAe,IAAI,OAAO,CAAC;IACrD,IAAI,CAAC,IAAA,eAAU,EAAC,SAAS,CAAC;QAAE,IAAA,cAAS,EAAC,SAAS,CAAC,CAAC;IACjD,IAAA,kBAAa,EAAC,GAAG,SAAS,eAAe,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC5E,IAAA,kBAAa,EAAC,GAAG,SAAS,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAEvF,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;AACxB,CAAC"}

package/dist/fastify/schemas.d.ts

@@ -1,9 +0,0 @@
-import { TSchema } from '@sinclair/typebox';
-export declare const Nullable: <T extends TSchema>(type: T) => import("@sinclair/typebox").TUnion<[T, import("@sinclair/typebox").TNull]>;
-export declare const Optional: <T extends TSchema>(type: T) => import("@sinclair/typebox").TOptional<T>;
-export declare const PaginatedResponse: <T extends TSchema>(type: T, title: string) => import("@sinclair/typebox").TObject<{
-    limit: import("@sinclair/typebox").TInteger;
-    offset: import("@sinclair/typebox").TInteger;
-    total: import("@sinclair/typebox").TInteger;
-    results: import("@sinclair/typebox").TArray<T>;
-}>;

package/dist/fastify/schemas.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaginatedResponse = exports.Optional = exports.Nullable = void 0;
-const typebox_1 = require("@sinclair/typebox");
-const Nullable = (type) => typebox_1.Type.Union([type, typebox_1.Type.Null()]);
-exports.Nullable = Nullable;
-const Optional = (type) => typebox_1.Type.Optional(type);
-exports.Optional = Optional;
-const PaginatedResponse = (type, title) => typebox_1.Type.Object({
-    limit: typebox_1.Type.Integer({ examples: [20] }),
-    offset: typebox_1.Type.Integer({ examples: [0] }),
-    total: typebox_1.Type.Integer({ examples: [1] }),
-    results: typebox_1.Type.Array(type),
-}, { title });
-exports.PaginatedResponse = PaginatedResponse;
-//# sourceMappingURL=schemas.js.map

package/dist/fastify/schemas.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../src/fastify/schemas.ts"],"names":[],"mappings":";;;AAAA,+CAAkD;AAE3C,MAAM,QAAQ,GAAG,CAAoB,IAAO,EAAE,EAAE,CAAC,cAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,cAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAA3E,QAAA,QAAQ,YAAmE;AACjF,MAAM,QAAQ,GAAG,CAAoB,IAAO,EAAE,EAAE,CAAC,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAA/D,QAAA,QAAQ,YAAuD;AAErE,MAAM,iBAAiB,GAAG,CAAoB,IAAO,EAAE,KAAa,EAAE,EAAE,CAC7E,cAAI,CAAC,MAAM,CACT;IACE,KAAK,EAAE,cAAI,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IACvC,MAAM,EAAE,cAAI,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACvC,KAAK,EAAE,cAAI,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACtC,OAAO,EAAE,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC;CAC1B,EACD,EAAE,KAAK,EAAE,CACV,CAAC;AATS,QAAA,iBAAiB,qBAS1B"}

package/dist/helpers/events.d.ts

@@ -1,52 +0,0 @@
-import { EventEmitter } from 'node:events';
-/**
- * Creates a Promise that resolves when the specified `eventName` is emitted by the `EventEmitter`
- * and the provided predicate returns `true` for the emitted arguments.
- *
- * Similar to [`events.once`](https://nodejs.org/api/events.html#eventsonceemitter-name-options),
- * but includes support for a predicate function to filter events. Only events for which
- * the predicate returns `true` will cause the Promise to resolve.
- *
- * The resolved value is an array of the arguments emitted with the event.
- *
- * Supports typed `EventEmitter`s and optional cancellation via `AbortSignal`.
- *
- * @example
- * ```ts
- * import { EventEmitter } from 'node:events';
- *
- * const emitter = new EventEmitter<{
- *   myEvent: [id: number, msg: string];
- * }>();
- *
- * setTimeout(() => {
- *   for (let i = 0; i <= 5; i++) {
- *     emitter.emit('myEvent', i, `Message ${i}`);
- *   }
- * }, 100);
- *
- * const [id, msg] = await onceWhen(emitter, 'myEvent', (id, msg) => id === 3);
- *
- * // outputs: "Received event with id: 3, message: Message 3"
- * console.log(`Received event with id: ${id}, message: ${msg}`);
- * ```
- *
- * @example
- * ```ts
- * import { EventEmitter } from 'node:events';
- *
- * const emitter = new EventEmitter<{ myEvent: [id: number, msg: string] }>();
- *
- * const signal = AbortSignal.timeout(10);
- *
- * setTimeout(() => emitter.emit('myEvent', 1, 'Hello'), 1000);
- *
- * const whenPromise = onceWhen(emitter, 'myEvent', id => id === 1, { signal });
- *
- * // This rejects because the signal is aborted before the event is emitted
- * await expect(whenPromise).rejects.toThrow(signal.reason);
- * ```
- */
-export declare function onceWhen<EventMap extends Record<string, any[]> = Record<string, any[]>, K extends Extract<keyof EventMap, string> = Extract<keyof EventMap, string>>(emitter: EventEmitter<EventMap>, eventName: K, predicate: (...args: EventMap[K]) => boolean, options?: {
-    signal?: AbortSignal;
-}): Promise<EventMap[K]>;

package/dist/helpers/events.js

@@ -1,93 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.onceWhen = onceWhen;
-const node_events_1 = require("node:events");
-// This is a workaround for Node.js versions that do not support Symbol.dispose
-const DisposeSymbol = Symbol.dispose ?? Symbol.for('nodejs.dispose');
-/**
- * Creates a Promise that resolves when the specified `eventName` is emitted by the `EventEmitter`
- * and the provided predicate returns `true` for the emitted arguments.
- *
- * Similar to [`events.once`](https://nodejs.org/api/events.html#eventsonceemitter-name-options),
- * but includes support for a predicate function to filter events. Only events for which
- * the predicate returns `true` will cause the Promise to resolve.
- *
- * The resolved value is an array of the arguments emitted with the event.
- *
- * Supports typed `EventEmitter`s and optional cancellation via `AbortSignal`.
- *
- * @example
- * ```ts
- * import { EventEmitter } from 'node:events';
- *
- * const emitter = new EventEmitter<{
- *   myEvent: [id: number, msg: string];
- * }>();
- *
- * setTimeout(() => {
- *   for (let i = 0; i <= 5; i++) {
- *     emitter.emit('myEvent', i, `Message ${i}`);
- *   }
- * }, 100);
- *
- * const [id, msg] = await onceWhen(emitter, 'myEvent', (id, msg) => id === 3);
- *
- * // outputs: "Received event with id: 3, message: Message 3"
- * console.log(`Received event with id: ${id}, message: ${msg}`);
- * ```
- *
- * @example
- * ```ts
- * import { EventEmitter } from 'node:events';
- *
- * const emitter = new EventEmitter<{ myEvent: [id: number, msg: string] }>();
- *
- * const signal = AbortSignal.timeout(10);
- *
- * setTimeout(() => emitter.emit('myEvent', 1, 'Hello'), 1000);
- *
- * const whenPromise = onceWhen(emitter, 'myEvent', id => id === 1, { signal });
- *
- * // This rejects because the signal is aborted before the event is emitted
- * await expect(whenPromise).rejects.toThrow(signal.reason);
- * ```
- */
-function onceWhen(emitter, eventName, predicate, options) {
-    return new Promise((resolve, reject) => {
-        // Immediate abort check
-        if (options?.signal?.aborted) {
-            reject(options.signal.reason ?? new Error('Aborted'));
-            return;
-        }
-        // Cleanup helper: remove both the event listener and the abort listener
-        const cleanup = () => {
-            // eslint-disable-next-line @typescript-eslint/no-use-before-define
-            emitter.off(eventName, listener);
-            // eslint-disable-next-line @typescript-eslint/no-use-before-define
-            disposable?.[DisposeSymbol]();
-        };
-        // Abort handler
-        const onAbort = () => {
-            cleanup();
-            reject(options?.signal?.reason ?? new Error('Aborted'));
-        };
-        // Our event listener that checks the predicate
-        const listener = (...args) => {
-            try {
-                if (predicate(...args)) {
-                    cleanup();
-                    resolve(args);
-                }
-            }
-            catch (err) {
-                cleanup();
-                reject(err);
-                return;
-            }
-        };
-        // Install the AbortSignal listener via Node’s helper
-        const disposable = options?.signal ? (0, node_events_1.addAbortListener)(options.signal, onAbort) : undefined;
-        emitter.on(eventName, listener);
-    });
-}
-//# sourceMappingURL=events.js.map

package/dist/helpers/events.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/helpers/events.ts"],"names":[],"mappings":";;AAqDA,4BAiDC;AAtGD,6CAA6D;AAE7D,+EAA+E;AAC/E,MAAM,aAAa,GAA0B,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,SAAgB,QAAQ,CAItB,OAA+B,EAC/B,SAAY,EACZ,SAA4C,EAC5C,OAAkC;IAElC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,wBAAwB;QACxB,IAAI,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;YAC7B,MAAM,CAAE,OAAO,CAAC,MAAM,CAAC,MAAgB,IAAI,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;YACjE,OAAO;QACT,CAAC;QAED,wEAAwE;QACxE,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,mEAAmE;YAClE,OAAwB,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YACnD,mEAAmE;YACnE,UAAU,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;QAChC,CAAC,CAAC;QAEF,gBAAgB;QAChB,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,OAAO,EAAE,CAAC;YACV,MAAM,CAAE,OAAO,EAAE,MAAM,EAAE,MAAgB,IAAI,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;QACrE,CAAC,CAAC;QAEF,+CAA+C;QAC/C,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAiB,EAAE,EAAE;YACxC,IAAI,CAAC;gBACH,IAAI,SAAS,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;oBACvB,OAAO,EAAE,CAAC;oBACV,OAAO,CAAC,IAAI,CAAC,CAAC;gBAChB,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,EAAE,CAAC;gBACV,MAAM,CAAC,GAAY,CAAC,CAAC;gBACrB,OAAO;YACT,CAAC;QACH,CAAC,CAAC;QAEF,qDAAqD;QACrD,MAAM,UAAU,GAAG,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,IAAA,8BAAgB,EAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1F,OAAwB,CAAC,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/helpers/index.d.ts

@@ -1,7 +0,0 @@
-export * from './iterators';
-export * from './time';
-export * from './values';
-export * from './is-debugging';
-export * from './events';
-export { WorkerThreadManager } from './worker-thread-manager';
-export type { WorkerPoolModuleInterface } from './worker-thread-manager';

package/dist/helpers/index.js

@@ -1,25 +0,0 @@
-"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkerThreadManager = void 0;
-__exportStar(require("./iterators"), exports);
-__exportStar(require("./time"), exports);
-__exportStar(require("./values"), exports);
-__exportStar(require("./is-debugging"), exports);
-__exportStar(require("./events"), exports);
-var worker_thread_manager_1 = require("./worker-thread-manager");
-Object.defineProperty(exports, "WorkerThreadManager", { enumerable: true, get: function () { return worker_thread_manager_1.WorkerThreadManager; } });
-//# sourceMappingURL=index.js.map

package/dist/helpers/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,yCAAuB;AACvB,2CAAyB;AACzB,iDAA+B;AAC/B,2CAAyB;AACzB,iEAA8D;AAArD,4HAAA,mBAAmB,OAAA"}

package/dist/helpers/is-debugging.d.ts

@@ -1 +0,0 @@
-export declare function isDebugging(): boolean;

package/dist/helpers/is-debugging.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDebugging = isDebugging;
-/*
- * Reliable way to check if we are debugging. Supports ts-node and other tools unlike some other
- * approaches that check argv or env vars. It also lazy-loads the `node:inspector` module to avoid
- * unnecessary overhead in production environments where this function might not be called.
- */
-function isDebugging() {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const inspector = require('node:inspector');
-    const url = inspector.url();
-    return url !== undefined;
-}
-//# sourceMappingURL=is-debugging.js.map

package/dist/helpers/is-debugging.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"is-debugging.js","sourceRoot":"","sources":["../../src/helpers/is-debugging.ts"],"names":[],"mappings":";;AAKA,kCAMC;AAXD;;;;GAIG;AACH,SAAgB,WAAW;IAEzB,8DAA8D;IAC9D,MAAM,SAAS,GAAG,OAAO,CAAC,gBAAgB,CAAsB,CAAC;IACjE,MAAM,GAAG,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC;IAC5B,OAAO,GAAG,KAAK,SAAS,CAAC;AAC3B,CAAC"}

package/dist/helpers/iterators.d.ts

@@ -1,27 +0,0 @@
-/**
- * Iterate over an array, yielding multiple items at a time. If the size of the given array
- * is not divisible by the given batch size, then the length of the last items returned will
- * be smaller than the given batch size, i.e.:
- * ```typescript
- * items.length % batchSize
- * ```
- * @param items - The array to iterate over.
- * @param batchSize - Maximum number of items to return at a time.
- * @param printBenchmark - If we should print benchmark of items per second
- */
-export declare function batchIterate<T>(items: T[], batchSize: number, printBenchmark?: boolean): Generator<T[]>;
-/**
- * Iterate over an `AsyncIterable`, yielding multiple items at a time. If the size of the given
- * array is not divisible by the given batch size, then the length of the last items returned will
- * be smaller than the given batch size.
- *
- * @param items - AsyncIterable
- * @param batchSize - Batch size
- * @param printBenchmark - If we should print benchmark of items per second
- */
-export declare function asyncBatchIterate<T>(items: AsyncIterable<T>, batchSize: number, printBenchmark?: boolean): AsyncGenerator<T[], void, unknown>;
-/**
- * Convert an `AsyncIterable` to a generator
- * @param iter - AsyncIterable
- */
-export declare function asyncIterableToGenerator<T>(iter: AsyncIterable<T>): AsyncGenerator<Awaited<T>, void, unknown>;

package/dist/helpers/iterators.js

@@ -1,74 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.batchIterate = batchIterate;
-exports.asyncBatchIterate = asyncBatchIterate;
-exports.asyncIterableToGenerator = asyncIterableToGenerator;
-const logger_1 = require("../logger");
-const values_1 = require("./values");
-/**
- * Iterate over an array, yielding multiple items at a time. If the size of the given array
- * is not divisible by the given batch size, then the length of the last items returned will
- * be smaller than the given batch size, i.e.:
- * ```typescript
- * items.length % batchSize
- * ```
- * @param items - The array to iterate over.
- * @param batchSize - Maximum number of items to return at a time.
- * @param printBenchmark - If we should print benchmark of items per second
- */
-function* batchIterate(items, batchSize, printBenchmark = values_1.isDevEnv) {
-    if (items.length === 0)
-        return;
-    const startTime = Date.now();
-    for (let i = 0; i < items.length;) {
-        const itemsRemaining = items.length - i;
-        const sliceSize = Math.min(batchSize, itemsRemaining);
-        yield items.slice(i, i + sliceSize);
-        i += sliceSize;
-    }
-    if (printBenchmark) {
-        const itemsPerSecond = Math.round((items.length / (Date.now() - startTime)) * 1000);
-        const caller = new Error().stack?.split('at ')[3].trim();
-        logger_1.logger.debug(`Iterated ${itemsPerSecond} items/second at ${caller}`);
-    }
-}
-/**
- * Iterate over an `AsyncIterable`, yielding multiple items at a time. If the size of the given
- * array is not divisible by the given batch size, then the length of the last items returned will
- * be smaller than the given batch size.
- *
- * @param items - AsyncIterable
- * @param batchSize - Batch size
- * @param printBenchmark - If we should print benchmark of items per second
- */
-async function* asyncBatchIterate(items, batchSize, printBenchmark = values_1.isDevEnv) {
-    const startTime = Date.now();
-    let itemCount = 0;
-    let itemBatch = [];
-    for await (const item of items) {
-        itemBatch.push(item);
-        itemCount++;
-        if (itemBatch.length >= batchSize) {
-            yield itemBatch;
-            itemBatch = [];
-            if (printBenchmark) {
-                const itemsPerSecond = Math.round((itemCount / (Date.now() - startTime)) * 1000);
-                const caller = new Error().stack?.split('at ')[3].trim();
-                logger_1.logger.debug(`Iterated ${itemsPerSecond} items/second at ${caller}`);
-            }
-        }
-    }
-    if (itemBatch.length > 0) {
-        yield itemBatch;
-    }
-}
-/**
- * Convert an `AsyncIterable` to a generator
- * @param iter - AsyncIterable
- */
-async function* asyncIterableToGenerator(iter) {
-    for await (const entry of iter) {
-        yield entry;
-    }
-}
-//# sourceMappingURL=iterators.js.map

package/dist/helpers/iterators.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"iterators.js","sourceRoot":"","sources":["../../src/helpers/iterators.ts"],"names":[],"mappings":";;AAcA,oCAkBC;AAWD,8CAwBC;AAMD,4DAIC;AA7ED,sCAAmC;AACnC,qCAAoC;AAEpC;;;;;;;;;;GAUG;AACH,QAAe,CAAC,CAAC,YAAY,CAC3B,KAAU,EACV,SAAiB,EACjB,cAAc,GAAG,iBAAQ;IAEzB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IAC/B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,GAAI,CAAC;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QACxC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QACtD,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC;QACpC,CAAC,IAAI,SAAS,CAAC;IACjB,CAAC;IACD,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QACpF,MAAM,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACzD,eAAM,CAAC,KAAK,CAAC,YAAY,cAAc,oBAAoB,MAAM,EAAE,CAAC,CAAC;IACvE,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,SAAS,CAAC,CAAC,iBAAiB,CACtC,KAAuB,EACvB,SAAiB,EACjB,cAAc,GAAG,iBAAQ;IAEzB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,IAAI,SAAS,GAAQ,EAAE,CAAC;IACxB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC/B,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrB,SAAS,EAAE,CAAC;QACZ,IAAI,SAAS,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;YAClC,MAAM,SAAS,CAAC;YAChB,SAAS,GAAG,EAAE,CAAC;YACf,IAAI,cAAc,EAAE,CAAC;gBACnB,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;gBACjF,MAAM,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBACzD,eAAM,CAAC,KAAK,CAAC,YAAY,cAAc,oBAAoB,MAAM,EAAE,CAAC,CAAC;YACvE,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,MAAM,SAAS,CAAC;IAClB,CAAC;AACH,CAAC;AAED;;;GAGG;AACI,KAAK,SAAS,CAAC,CAAC,wBAAwB,CAAI,IAAsB;IACvE,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;QAC/B,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/helpers/serialize-error.d.ts

@@ -1,20 +0,0 @@
-/**
- * Custom errors can only be deserialized correctly if they are registered here.
- */
-export declare function addKnownErrorConstructor(constructor: new (message?: string, ..._arguments: unknown[]) => Error): void;
-type SerializedError = {
-    constructorName: string;
-    name: string;
-    message: string;
-    stack: string;
-    [key: string]: any;
-};
-export type ErrorLike = {
-    name: string;
-    message: string;
-    stack: string;
-};
-export declare function isErrorLike(value: unknown): value is ErrorLike;
-export declare function serializeError(subject: Error): SerializedError;
-export declare function deserializeError(subject: ErrorLike): Error;
-export {};