remult 3.0.4 → 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/esm/src/context.js

@@ -10,6 +10,7 @@ import { verifyFieldRelationInfo } from './remult3/relationInfoMember.js';
 import { remultStatic, resetFactory } from './remult-static.js';
 import { initDataProvider } from '../server/initDataProvider.js';
 import { SubscribableImp } from './remult3/SubscribableImp.js';
+import { getEntitySettings } from './remult3/getEntityRef.js';
 export class RemultAsyncLocalStorage {
     remultObjectStorage;
     static enable() {
@@ -65,10 +66,10 @@ export class Remult {
      * @param dataProvider - an optional alternative data provider to use. Useful for writing to offline storage or an alternative data provider
      */
     repo = (entity, dataProvider) => {
-        const info = createOldEntity(entity, this);
+        let info = getEntitySettings(entity)(remult);
         if (dataProvider === undefined) {
-            if (info?.options?.dataProvider) {
-                const d = info.options.dataProvider(this.dataProvider);
+            if (info?.dataProvider) {
+                const d = info.dataProvider(this.dataProvider);
                 if (d instanceof Promise) {
                     dataProvider = new DataProviderPromiseWrapper(d);
                 }
@@ -85,7 +86,7 @@ export class Remult {
             this.repCache.set(dataProvider, (dpCache = new Map()));
         let r = dpCache.get(entity);
         if (!r) {
-            dpCache.set(entity, (r = new RepositoryImplementation(entity, this, dataProvider, info)));
+            dpCache.set(entity, (r = new RepositoryImplementation(entity, this, dataProvider, createOldEntity(entity, this))));
             verifyFieldRelationInfo(r, this, dataProvider);
         }
         return r;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "3.0.4",
+    "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)

package/src/column-interfaces.d.ts

@@ -9,7 +9,10 @@ export interface FieldOptions<entityType = unknown, valueType = unknown> {
     caption?: string;
     /** If it can store null in the database */
     allowNull?: boolean;
-    /** If a value is required */
+    /** If a value is required. Short-cut to say `validate: Validators.required`.
+        @see option [validate](https://remult.dev/docs/ref_field#validate) below
+        @see validator [required](https://remult.dev/docs/ref_validators#required)
+     */
     required?: boolean;
     /**
      * Specifies whether this field should be included in the API. This can be configured

package/src/context.js

@@ -18,6 +18,7 @@ var relationInfoMember_js_1 = require("./remult3/relationInfoMember.js");
 var remult_static_js_1 = require("./remult-static.js");
 var initDataProvider_js_1 = require("../server/initDataProvider.js");
 var SubscribableImp_js_1 = require("./remult3/SubscribableImp.js");
+var getEntityRef_js_1 = require("./remult3/getEntityRef.js");
 var RemultAsyncLocalStorage = /** @class */ (function () {
     function RemultAsyncLocalStorage(remultObjectStorage) {
         this.remultObjectStorage = remultObjectStorage;
@@ -83,11 +84,10 @@ var Remult = /** @class */ (function () {
          * @param dataProvider - an optional alternative data provider to use. Useful for writing to offline storage or an alternative data provider
          */
         this.repo = function (entity, dataProvider) {
-            var _a;
-            var info = (0, RepositoryImplementation_js_1.createOldEntity)(entity, _this);
+            var info = (0, getEntityRef_js_1.getEntitySettings)(entity)(remult_proxy_js_1.remult);
             if (dataProvider === undefined) {
-                if ((_a = info === null || info === void 0 ? void 0 : info.options) === null || _a === void 0 ? void 0 : _a.dataProvider) {
-                    var d = info.options.dataProvider(_this.dataProvider);
+                if (info === null || info === void 0 ? void 0 : info.dataProvider) {
+                    var d = info.dataProvider(_this.dataProvider);
                     if (d instanceof Promise) {
                         dataProvider = new data_interfaces_js_1.DataProviderPromiseWrapper(d);
                     }
@@ -104,7 +104,7 @@ var Remult = /** @class */ (function () {
                 _this.repCache.set(dataProvider, (dpCache = new Map()));
             var r = dpCache.get(entity);
             if (!r) {
-                dpCache.set(entity, (r = new RepositoryImplementation_js_1.RepositoryImplementation(entity, _this, dataProvider, info)));
+                dpCache.set(entity, (r = new RepositoryImplementation_js_1.RepositoryImplementation(entity, _this, dataProvider, (0, RepositoryImplementation_js_1.createOldEntity)(entity, _this))));
                 (0, relationInfoMember_js_1.verifyFieldRelationInfo)(r, _this, dataProvider);
             }
             return r;