remult 3.0.5-next.0 → 3.0.5

package/async-hooks.d.ts

@@ -0,0 +1 @@
+export { initAsyncHooks } from './server/initAsyncHooks.js';

package/async-hooks.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initAsyncHooks = void 0;
+var initAsyncHooks_js_1 = require("./server/initAsyncHooks.js");
+Object.defineProperty(exports, "initAsyncHooks", { enumerable: true, get: function () { return initAsyncHooks_js_1.initAsyncHooks; } });

package/esm/async-hooks.js

@@ -0,0 +1 @@
+export { initAsyncHooks } from './server/initAsyncHooks.js';

package/esm/server/initAsyncHooks.js

@@ -2,6 +2,31 @@ import { AsyncLocalStorage } from 'async_hooks';
 import { RemultAsyncLocalStorage, } from '../src/context.js';
 import { remultStatic } from '../src/remult-static.js';
 let init = false;
+/**
+ * Initializes async context tracking for the server.
+ *
+ * This should be called before handling any incoming requests or calling `withRemult()`.
+ * @example
+ * import { remult, repo, withRemult } from 'remult';
+ * import { initAsyncHooks } from 'remult/async-hooks';
+ *
+ * import { Task } from './entities/Task.js';
+ *
+ * initAsyncHooks();
+ *
+ * // Thx to the `initAsyncHooks` above,
+ * // we have isolated async contexts with multiple `withRemult()`,
+ * // without needing to initialize a `remultApi` all the time!
+ * withRemult(async () => {
+ *     remult.user = { id: '42' };
+ *     repo(Task).find()
+ * });
+ *
+ * withRemult(async () => {
+ *     remult.user = { id: '21' };
+ *     repo(Task).find()
+ * });
+ */
 export function initAsyncHooks() {
     if (init)
         return;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "3.0.5-next.0",
+    "version": "3.0.5",
     "description": "A CRUD framework for full-stack TypeScript",
     "homepage": "https://remult.dev",
     "repository": {
@@ -41,6 +41,11 @@
             "import": "./esm/remult-next.js",
             "types": "./remult-next.d.ts"
         },
+        "./async-hooks": {
+            "require": "./async-hooks.js",
+            "import": "./esm/async-hooks.js",
+            "types": "./async-hooks.d.ts"
+        },
         "./server": {
             "require": "./server/index.js",
             "import": "./esm/server/index.js",

package/server/initAsyncHooks.d.ts

@@ -1,4 +1,29 @@
 import { type RemultAsyncLocalStorageCore } from '../src/context.js';
+/**
+ * Initializes async context tracking for the server.
+ *
+ * This should be called before handling any incoming requests or calling `withRemult()`.
+ * @example
+ * import { remult, repo, withRemult } from 'remult';
+ * import { initAsyncHooks } from 'remult/async-hooks';
+ *
+ * import { Task } from './entities/Task.js';
+ *
+ * initAsyncHooks();
+ *
+ * // Thx to the `initAsyncHooks` above,
+ * // we have isolated async contexts with multiple `withRemult()`,
+ * // without needing to initialize a `remultApi` all the time!
+ * withRemult(async () => {
+ *     remult.user = { id: '42' };
+ *     repo(Task).find()
+ * });
+ *
+ * withRemult(async () => {
+ *     remult.user = { id: '21' };
+ *     repo(Task).find()
+ * });
+ */
 export declare function initAsyncHooks(): void;
 export declare class AsyncLocalStorageBridgeToRemultAsyncLocalStorageCoreImpl<T> implements RemultAsyncLocalStorageCore<T> {
     private asyncLocalStorage;

package/server/initAsyncHooks.js

@@ -7,6 +7,31 @@ var async_hooks_1 = require("async_hooks");
 var context_js_1 = require("../src/context.js");
 var remult_static_js_1 = require("../src/remult-static.js");
 var init = false;
+/**
+ * Initializes async context tracking for the server.
+ *
+ * This should be called before handling any incoming requests or calling `withRemult()`.
+ * @example
+ * import { remult, repo, withRemult } from 'remult';
+ * import { initAsyncHooks } from 'remult/async-hooks';
+ *
+ * import { Task } from './entities/Task.js';
+ *
+ * initAsyncHooks();
+ *
+ * // Thx to the `initAsyncHooks` above,
+ * // we have isolated async contexts with multiple `withRemult()`,
+ * // without needing to initialize a `remultApi` all the time!
+ * withRemult(async () => {
+ *     remult.user = { id: '42' };
+ *     repo(Task).find()
+ * });
+ *
+ * withRemult(async () => {
+ *     remult.user = { id: '21' };
+ *     repo(Task).find()
+ * });
+ */
 function initAsyncHooks() {
     var _this = this;
     if (init)