remult 3.0.6 → 3.0.7-next.0

package/server/initAsyncHooks.d.ts

@@ -1,29 +1,4 @@
 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,31 +7,6 @@ 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/server/remult-api-server.d.ts

@@ -94,7 +94,7 @@ export interface RemultServerOptions<RequestType> {
         sendError: (httpStatusCode: number, body: any) => void;
     }) => Promise<void> | undefined;
     /**
-     * Modules are here to group code by feature.
+     * Modules are here to group code by feature. [Module Guide](https://remult.dev/docs/modules)
      *
      * @example
      * import { Module } from 'remult/server'

package/src/column-interfaces.d.ts

@@ -12,11 +12,12 @@ export interface FieldOptions<entityType = unknown, valueType = unknown> {
      * <input placeholder={taskRepo.metadata.fields.title.label}/>
      */
     label?: string;
-    /** If it can store null in the database */
+    /** If it can store `null` in the database. @default false */
     allowNull?: boolean;
     /** 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)
+     * @default false
+     * @see option [validate](https://remult.dev/docs/ref_field#validate)
+     * @see validator [required](https://remult.dev/docs/ref_validators#required)
      */
     required?: boolean;
     /**

package/src/remult-static.d.ts

@@ -21,6 +21,7 @@ export declare const remultStatic: {
     };
     fieldOptionsEnricher: any;
     labelTransformer: any;
+    defaultIdFactory: () => string;
     defaultDataProvider: () => Promise<DataProvider | undefined>;
 };
 export declare function defaultFactory(): Remult;

package/src/remult-static.js

@@ -25,6 +25,7 @@ var x = {
     },
     fieldOptionsEnricher: undefined,
     labelTransformer: undefined,
+    defaultIdFactory: undefined,
     defaultDataProvider: function () {
         return undefined;
     },

package/src/remult3/Fields.d.ts

@@ -15,13 +15,43 @@ export declare class Fields {
     static number<entityType = unknown>(...options: (FieldOptions<entityType, number> | ((options: FieldOptions<entityType, number>, remult: Remult) => void))[]): ClassFieldDecorator<entityType, number | undefined>;
     static createdAt<entityType = unknown>(...options: (FieldOptions<entityType, Date> | ((options: FieldOptions<entityType, Date>, remult: Remult) => void))[]): ClassFieldDecorator<entityType, Date | undefined>;
     static updatedAt<entityType = unknown>(...options: (FieldOptions<entityType, Date> | ((options: FieldOptions<entityType, Date>, remult: Remult) => void))[]): ClassFieldDecorator<entityType, Date | undefined>;
+    /** @deprecated use `@Fields.id()` instead */
     static uuid<entityType = unknown>(...options: (FieldOptions<entityType, string> | ((options: FieldOptions<entityType, string>, remult: Remult) => void))[]): ClassFieldDecorator<entityType, string | undefined>;
+    private static _defaultIdFactory;
+    static get defaultIdFactory(): () => string;
+    static set defaultIdFactory(value: () => string);
     /**
-     * A CUID (Collision Resistant Unique Identifier) field.
-     * This id value is determined on the backend on insert, and can't be updated through the API.
-     * The CUID is generated using the `@paralleldrive/cuid2` npm package.
+     * Defines a field that will be used as the id of the entity.
+     * By default it will use `crypto.randomUUID` to generate the id.
+     *
+     * You can change the algorithm used to generate the id by setting the `Fields.defaultIdFactory`
+     * to a different function like:
+     *
+     * This needs to be done in a shared file to be accessible frontend and backend.
+     *
+     * ```ts
+     * import { createId } from '@paralleldrive/cuid2'
+     * Fields.defaultIdFactory = () => createId()
+     * ```
+     *
+     * You can also pass an id factory as an option to the `@Fields.id` to have a different value locally.
+     * @example
+     * ```ts
+     * import { createId } from '@paralleldrive/cuid2'
+     * // import { v4 as uuid } from 'uuid'
+     *
+     * class MyEntity {
+     *   \@Fields.id({
+     *     idFactory: () => createId()
+     *     // idFactory: () => uuid()
+     *   })
+     *   id: string = '';
+     * }
+     * ```
      */
-    static cuid<entityType = unknown>(...options: (FieldOptions<entityType, string> | ((options: FieldOptions<entityType, string>, remult: Remult) => void))[]): ClassFieldDecorator<entityType, string | undefined>;
+    static id<entityType = unknown>(options?: FieldOptions<entityType, string> & {
+        idFactory?: () => string;
+    }): ClassFieldDecorator<entityType, string | undefined>;
     /**
    * Defines a field that can hold a value from a specified set of string literals.
    * @param {() => readonly valueType[]} optionalValues - A function that returns an array of allowed string literals.

package/src/remult3/Fields.js

@@ -4,8 +4,6 @@ exports.Relations = exports.Fields = void 0;
 exports.Field = Field;
 exports.checkTarget = checkTarget;
 var tslib_1 = require("tslib");
-var cuid2_1 = require("@paralleldrive/cuid2");
-var uuid_1 = require("uuid");
 var valueConverters_js_1 = require("../valueConverters.js");
 var RepositoryImplementation_js_1 = require("./RepositoryImplementation.js");
 var validators_js_1 = require("../validators.js");
@@ -128,53 +126,62 @@ var Fields = /** @class */ (function () {
                 },
             }], tslib_1.__read(options), false));
     };
+    /** @deprecated use `@Fields.id()` instead */
     Fields.uuid = function () {
         var options = [];
         for (var _i = 0; _i < arguments.length; _i++) {
             options[_i] = arguments[_i];
         }
-        return Field.apply(void 0, tslib_1.__spreadArray([function () { return String; },
-            {
-                allowApiUpdate: false,
-                defaultValue: function () { return (0, uuid_1.v4)(); },
-                saving: function (_, r) {
-                    if (!r.value)
-                        r.value = (0, uuid_1.v4)();
-                },
-            }], tslib_1.__read(options), false));
+        return Fields.id(tslib_1.__assign({ idFactory: function () { return crypto.randomUUID(); } }, options));
     };
+    Object.defineProperty(Fields, "defaultIdFactory", {
+        get: function () {
+            return this._defaultIdFactory;
+        },
+        set: function (value) {
+            this._defaultIdFactory = value;
+            remult_static_js_1.remultStatic.defaultIdFactory = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
     /**
-     * A CUID (Collision Resistant Unique Identifier) field.
-     * This id value is determined on the backend on insert, and can't be updated through the API.
-     * The CUID is generated using the `@paralleldrive/cuid2` npm package.
+     * Defines a field that will be used as the id of the entity.
+     * By default it will use `crypto.randomUUID` to generate the id.
+     *
+     * You can change the algorithm used to generate the id by setting the `Fields.defaultIdFactory`
+     * to a different function like:
+     *
+     * This needs to be done in a shared file to be accessible frontend and backend.
+     *
+     * ```ts
+     * import { createId } from '@paralleldrive/cuid2'
+     * Fields.defaultIdFactory = () => createId()
+     * ```
+     *
+     * You can also pass an id factory as an option to the `@Fields.id` to have a different value locally.
+     * @example
+     * ```ts
+     * import { createId } from '@paralleldrive/cuid2'
+     * // import { v4 as uuid } from 'uuid'
+     *
+     * class MyEntity {
+     *   \@Fields.id({
+     *     idFactory: () => createId()
+     *     // idFactory: () => uuid()
+     *   })
+     *   id: string = '';
+     * }
+     * ```
      */
-    Fields.cuid = function () {
-        var options = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            options[_i] = arguments[_i];
-        }
-        return Field.apply(void 0, tslib_1.__spreadArray([function () { return String; },
-            {
-                allowApiUpdate: false,
-                defaultValue: function () { return (0, cuid2_1.createId)(); },
-                saving: function (_, r) {
-                    if (!r.value)
-                        r.value = (0, cuid2_1.createId)();
-                },
-            }], tslib_1.__read(options), false));
+    Fields.id = function (options) {
+        var _a;
+        var idFactory = (_a = options === null || options === void 0 ? void 0 : options.idFactory) !== null && _a !== void 0 ? _a : remult_static_js_1.remultStatic.defaultIdFactory;
+        return Field(function () { return String; }, tslib_1.__assign({ allowApiUpdate: false, defaultValue: function () { return ((options === null || options === void 0 ? void 0 : options.allowNull) ? null : idFactory()); }, saving: function (_, r) {
+                if (!r.value && !(options === null || options === void 0 ? void 0 : options.allowNull))
+                    r.value = idFactory();
+            } }, options));
     };
-    // static id<entityType = unknown>(
-    //   options?: FieldOptions<entityType, string> & { idFactory?: () => string },
-    // ): ClassFieldDecorator<entityType, string | undefined> {
-    //   let buildId = options?.idFactory ?? createId
-    //   return Field(() => String, {
-    //     allowApiUpdate: false,
-    //     defaultValue: () => buildId(),
-    //     saving: (_, r) => {
-    //       if (!r.value) r.value = buildId()
-    //     },
-    //   })
-    // }
     /**
    * Defines a field that can hold a value from a specified set of string literals.
    * @param {() => readonly valueType[]} optionalValues - A function that returns an array of allowed string literals.
@@ -269,9 +276,12 @@ var Fields = /** @class */ (function () {
         }
         return Field.apply(void 0, tslib_1.__spreadArray([function () { return Boolean; }], tslib_1.__read(options), false));
     };
+    Fields._defaultIdFactory = function () { return crypto.randomUUID(); };
     return Fields;
 }());
 exports.Fields = Fields;
+// Initialize remultStatic.defaultIdFactory with the default value
+remult_static_js_1.remultStatic.defaultIdFactory = Fields.defaultIdFactory;
 var Relations = /** @class */ (function () {
     function Relations() {
     }

package/src/remult3/IdEntity.js

@@ -10,7 +10,7 @@ var IdEntity = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     tslib_1.__decorate([
-        Fields_js_1.Fields.uuid(),
+        Fields_js_1.Fields.id(),
         tslib_1.__metadata("design:type", String)
     ], IdEntity.prototype, "id", void 0);
     return IdEntity;

package/src/remult3/RepositoryImplementation.d.ts

@@ -243,7 +243,7 @@ export declare const LabelTransformer: {
      */
     transformLabel: (remult: Remult, key: string, label: string, entityMetaData: EntityMetadata<any>) => string;
     /**
-     * @obsolete use LabelTransformer.transformLabel instead
+     * @deprecated use LabelTransformer.transformLabel instead
      */
     transformCaption: (remult: Remult, key: string, label: string, entityMetaData: EntityMetadata<any>) => string;
 };

package/src/remult3/entity.d.ts

@@ -9,7 +9,7 @@ import type { ClassDecoratorContextStub } from './remult3.js';
  *    allowApiCrud: true
  * })
  * export class Task {
- *    @Fields.uuid()
+ *    @Fields.id()
  *    id!: string;
  *    @Fields.string()
  *    title = '';

package/src/remult3/entity.js

@@ -13,7 +13,7 @@ var remult_static_js_1 = require("../remult-static.js");
  *    allowApiCrud: true
  * })
  * export class Task {
- *    @Fields.uuid()
+ *    @Fields.id()
  *    id!: string;
  *    @Fields.string()
  *    title = '';