@tstdl/base 0.90.82 → 0.90.83

package/context/context.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Creates a new context provider
+ * @param name name of of the context used for function names
+ */
+export declare function createContextProvider<Context, const Name extends string>(name: Name): { [P in `getCurrent${Name}Context`]: {
+    (required: true, debugFn: Function): Context;
+    (required?: false | undefined, debugFn?: Function): Context | null;
+    (required: boolean, debugFn: Function): Context | null;
+}; } & { [P_1 in `setCurrent${Name}Context`]: (context: Context | null) => Context | null; } & { [P_2 in `runIn${Name}Context`]: <ReturnT>(context: Context, fn: () => ReturnT) => ReturnT; } & { [P_3 in `isIn${Name}Context`]: {
+    (required: true, debugFn: Function): Context;
+    (required?: false | undefined, debugFn?: Function): Context | null;
+    (required: boolean, debugFn: Function): Context | null;
+}; } & { [P_4 in `assertIn${Name}Context`]: {
+    (required: true, debugFn: Function): Context;
+    (required?: false | undefined, debugFn?: Function): Context | null;
+    (required: boolean, debugFn: Function): Context | null;
+}; } extends infer T extends import("../types.js").Record<PropertyKey, any> ? { [K in keyof T]: ({ [P in `getCurrent${Name}Context`]: {
+    (required: true, debugFn: Function): Context;
+    (required?: false | undefined, debugFn?: Function): Context | null;
+    (required: boolean, debugFn: Function): Context | null;
+}; } & { [P_1 in `setCurrent${Name}Context`]: (context: Context | null) => Context | null; } & { [P_2 in `runIn${Name}Context`]: <ReturnT>(context: Context, fn: () => ReturnT) => ReturnT; } & { [P_3 in `isIn${Name}Context`]: {
+    (required: true, debugFn: Function): Context;
+    (required?: false | undefined, debugFn?: Function): Context | null;
+    (required: boolean, debugFn: Function): Context | null;
+}; } & { [P_4 in `assertIn${Name}Context`]: {
+    (required: true, debugFn: Function): Context;
+    (required?: false | undefined, debugFn?: Function): Context | null;
+    (required: boolean, debugFn: Function): Context | null;
+}; })[K]; } : never;

package/context/context.js

@@ -0,0 +1,63 @@
+import { isNotNull } from '../utils/type-guards.js';
+/**
+ * Creates a new context provider
+ * @param name name of of the context used for function names
+ */
+export function createContextProvider(name) {
+    let currentContext = null;
+    function getCurrentContext(required = false, debugFn) {
+        if (required) {
+            assertInContext(debugFn);
+        }
+        return currentContext;
+    }
+    /**
+     * Manually set the context. Usually runInContext is preferred, as no manual cleanup is required.
+     * @param context context to set
+     * @returns previous context, if any
+     */
+    function setCurrentContext(context) {
+        const previous = currentContext;
+        currentContext = context;
+        return previous;
+    }
+    /**
+     * Runs the given function with the given {@link Context} as context.
+     *
+     * @param context the context to provide while `fn` is executing
+     * @param fn the function to run with the provided context
+     * @returns the return value of the function, if any
+     */
+    function runInContext(context, fn) {
+        const previousContext = setCurrentContext(context);
+        try {
+            return fn();
+        }
+        finally {
+            setCurrentContext(previousContext);
+        }
+    }
+    /**
+     * Whether the current stack is in a context
+     */
+    function isInContext() {
+        return isNotNull(currentContext);
+    }
+    /**
+     * Asserts that the current stack is within an context
+     *
+     * @param debugFn a reference to the function making the assertion (used for the error message).
+     */
+    function assertInContext(debugFn) {
+        if (!isInContext()) {
+            throw new Error(`${debugFn.name}() can only be used within an ${name}Context via \`runIn${name}Context\`.`);
+        }
+    }
+    return {
+        [`getCurrent${name}Context`]: getCurrentContext,
+        [`setCurrent${name}Context`]: setCurrentContext,
+        [`runIn${name}Context`]: runInContext,
+        [`isIn${name}Context`]: getCurrentContext,
+        [`assertIn${name}Context`]: getCurrentContext
+    };
+}

package/context/index.d.ts

@@ -0,0 +1 @@
+export * from './context.js';

package/context/index.js

@@ -0,0 +1 @@
+export * from './context.js';

package/examples/api/streaming.js

@@ -6,6 +6,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 /* eslint-disable max-classes-per-file */
 import '../../polyfills.js';
+import { Agent } from 'undici';
 import { compileClient } from '../../api/client/client.js';
 import { defineApi } from '../../api/index.js';
 import { apiController, configureApiServer } from '../../api/server/index.js';
@@ -17,13 +18,14 @@ import { HttpServerResponse } from '../../http/server/index.js';
 import { configureNodeHttpServer } from '../../http/server/node/index.js';
 import { inject } from '../../injector/inject.js';
 import { WebServerModule } from '../../module/modules/web-server.module.js';
+import { configureDefaultSignalsImplementation } from '../../signals/implementation/configure.js';
 import { ServerSentEvents, ServerSentEventsSource } from '../../sse/index.js';
 import { decodeTextStream, encodeUtf8Stream } from '../../utils/encoding.js';
 import { getReadableStreamFromIterable, getReadableStreamIterable } from '../../utils/stream/index.js';
 import { cancelableTimeout, timeout } from '../../utils/timing.js';
 import { isDefined } from '../../utils/type-guards.js';
-import { Agent } from 'undici';
 configureTstdl();
+configureDefaultSignalsImplementation();
 const logger = getGlobalInjector().resolve(CORE_LOGGER);
 const streamingApiDefinition = defineApi({
     resource: 'streams', // /api/:version/users
@@ -82,22 +84,21 @@ async function clientTest() {
     }
     await Application.shutdown();
 }
-function main() {
+function bootstrap() {
     configureNodeHttpServer();
     configureApiServer({ controllers: [StreamingApi] });
     configureUndiciHttpClientAdapter({ dispatcher: new Agent({ keepAliveMaxTimeout: 1 }) });
     configureHttpClient({ baseUrl: 'http://localhost:8000' });
-    Application.run(WebServerModule, clientTest);
 }
-main();
+Application.run({ bootstrap }, WebServerModule, clientTest);
 function eventsSource() {
     const events = new ServerSentEventsSource();
     void (async () => {
         for (let i = 1; i <= 10; i++) {
-            if (events.closed || isDefined(events.error)) {
+            if (events.closed() || isDefined(events.error())) {
                 return;
             }
-            await events.sendJson({ name: 'time', id: i.toString(), data: { dateTime: `${new Date().toLocaleString()}`, uptime: performance.now() }, retry: 1000 });
+            await events.sendJson({ name: 'time', id: i.toString(), data: { dateTime: new Date().toLocaleString(), uptime: performance.now() }, retry: 1000 });
             await timeout(1000);
         }
         await events.close();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tstdl/base",
-  "version": "0.90.82",
+  "version": "0.90.83",
   "author": "Patrick Hein",
   "publishConfig": {
     "access": "public"
@@ -111,7 +111,7 @@
     "luxon": "^3.4",
     "reflect-metadata": "^0.2",
     "rxjs": "^7.8",
-    "type-fest": "4.18"
+    "type-fest": "4.20"
   },
   "devDependencies": {
     "@mxssfd/typedoc-theme": "1.1",
@@ -123,6 +123,7 @@
     "@types/mjml": "4.7",
     "@types/node": "20",
     "@types/nodemailer": "6.4",
+    "@typescript-eslint/eslint-plugin": "7.12",
     "concurrently": "8.2",
     "eslint": "8.57",
     "eslint-import-resolver-typescript": "3.6",
@@ -130,8 +131,7 @@
     "tsc-alias": "1.8",
     "typedoc": "0.25",
     "typedoc-plugin-missing-exports": "2.2",
-    "typescript": "5.4",
-    "typescript-eslint": "7.11"
+    "typescript": "5.4"
   },
   "peerDependencies": {
     "@elastic/elasticsearch": "^8.13",

package/sse/server-sent-events-source.d.ts

@@ -1,12 +1,9 @@
 import type { ServerSentJsonEvent, ServerSentTextEvent } from './model.js';
 export declare class ServerSentEventsSource {
-    private readonly writable;
-    private readonly writer;
-    private _closed;
-    private _error;
+    #private;
     readonly readable: ReadableStream<string>;
-    get closed(): boolean;
-    get error(): Error | undefined;
+    readonly closed: import("../signals/api.js").Signal<boolean>;
+    readonly error: import("../signals/api.js").Signal<Error | undefined>;
     constructor();
     close(): Promise<void>;
     sendComment(comment: string): Promise<void>;

package/sse/server-sent-events-source.js

@@ -1,33 +1,28 @@
+import { signal } from '../signals/api.js';
 import { isDefined } from '../utils/type-guards.js';
 export class ServerSentEventsSource {
-    writable;
-    writer;
-    _closed;
-    _error;
+    #writable;
+    #writer;
+    #closed = signal(false);
+    #error = signal(undefined);
     readable;
-    get closed() {
-        return this._closed;
-    }
-    get error() {
-        return this._error;
-    }
+    closed = this.#closed.asReadonly();
+    error = this.#error.asReadonly();
     constructor() {
         const { writable, readable } = new TransformStream();
-        this.writable = writable;
+        this.#writable = writable;
         this.readable = readable;
-        this._closed = false;
-        this._error = undefined;
-        this.writer = this.writable.getWriter();
-        this.writer.closed
-            .then(() => (this._closed = true))
-            .catch((error) => (this._error = error));
+        this.#writer = this.#writable.getWriter();
+        this.#writer.closed
+            .then(() => (this.#closed.set(true)))
+            .catch((error) => this.#error.set(error));
     }
     async close() {
-        await this.writer.close();
+        await this.#writer.close();
     }
     async sendComment(comment) {
         const text = formatText(comment, '');
-        await this.writer.write(text);
+        await this.#writer.write(text);
     }
     async sendText({ name, data, id, retry }) {
         let message = '';
@@ -44,7 +39,7 @@ export class ServerSentEventsSource {
             message += formatText(retry.toString(), 'retry');
         }
         message += '\n';
-        await this.writer.write(message);
+        await this.#writer.write(message);
     }
     async sendJson({ name, data, id, retry }) {
         return this.sendText({