remult 3.1.0-next.1 → 3.1.0

package/esm/src/remult3/Fields.js

@@ -84,51 +84,77 @@ export class Fields {
             ...options,
         });
     }
-    static _defaultIdFactory = () => crypto.randomUUID();
+    /**
+     * ### cuid
+     * @example
+     * ```ts
+     * import { Fields } from 'remult'
+     * import { createId } from '@paralleldrive/cuid2'
+     * Fields.defaultIdFactory = () => createId()
+     * ```
+     *
+     * ### nanoid
+     * @example
+     * ```ts
+     * import { Fields } from 'remult'
+     * import { nanoid } from 'nanoid'
+     * Fields.defaultIdFactory = () => nanoid()
+     * ```
+     *
+     */
     static get defaultIdFactory() {
-        return this._defaultIdFactory;
+        return (remultStatic.defaultIdFactory ??
+            (remultStatic.defaultIdFactory = () => crypto.randomUUID()));
     }
     static set defaultIdFactory(value) {
-        this._defaultIdFactory = value;
         remultStatic.defaultIdFactory = value;
     }
     /**
+     * ### Default
      * 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.
+     * ---
+     * ### Global `IdFactory`
+     * You can change the algorithm used to generate the id by setting `Fields.defaultIdFactory`
+     * globally. This code needs to be 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.
+     * ---
+     * ### Local `IdFactory`
+     * You can also pass an `idFactory` as an option to the `@Fields.id` to have a different value on this field.
      * @example
      * ```ts
      * import { createId } from '@paralleldrive/cuid2'
      * // import { v4 as uuid } from 'uuid'
+     * // import { nanoid } from 'nanoid'
      *
      * class MyEntity {
      *   \@Fields.id({
      *     idFactory: () => createId()
      *     // idFactory: () => uuid()
+     *     // idFactory: () => nanoid()
      *   })
      *   id: string = '';
      * }
      * ```
      */
     static id(options) {
-        let idFactory = options?.idFactory ?? remultStatic.defaultIdFactory;
         return Field(() => String, {
             allowApiUpdate: false,
-            defaultValue: () => idFactory(),
+            defaultValue: () => {
+                let idFactory = options?.idFactory ?? Fields.defaultIdFactory;
+                return idFactory();
+            },
             saving: (_, r) => {
-                if (!r.value)
+                if (!r.value) {
+                    let idFactory = options?.idFactory ?? Fields.defaultIdFactory;
                     r.value = idFactory();
+                }
             },
             ...options,
         });
@@ -202,8 +228,6 @@ export class Fields {
         return Field(() => Boolean, ...options);
     }
 }
-// Initialize remultStatic.defaultIdFactory with the default value
-remultStatic.defaultIdFactory = Fields.defaultIdFactory;
 export class Relations {
     /**
      * Define a to-one relation between entities, indicating a one-to-one relationship.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "3.1.0-next.1",
+    "version": "3.1.0",
     "description": "A CRUD framework for full-stack TypeScript",
     "homepage": "https://remult.dev",
     "repository": {

package/src/remult3/Fields.d.ts

@@ -17,33 +17,55 @@ export declare class Fields {
     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;
+    /**
+     * ### cuid
+     * @example
+     * ```ts
+     * import { Fields } from 'remult'
+     * import { createId } from '@paralleldrive/cuid2'
+     * Fields.defaultIdFactory = () => createId()
+     * ```
+     *
+     * ### nanoid
+     * @example
+     * ```ts
+     * import { Fields } from 'remult'
+     * import { nanoid } from 'nanoid'
+     * Fields.defaultIdFactory = () => nanoid()
+     * ```
+     *
+     */
     static get defaultIdFactory(): () => string;
     static set defaultIdFactory(value: () => string);
     /**
+     * ### Default
      * 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.
+     * ---
+     * ### Global `IdFactory`
+     * You can change the algorithm used to generate the id by setting `Fields.defaultIdFactory`
+     * globally. This code needs to be 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.
+     * ---
+     * ### Local `IdFactory`
+     * You can also pass an `idFactory` as an option to the `@Fields.id` to have a different value on this field.
      * @example
      * ```ts
      * import { createId } from '@paralleldrive/cuid2'
      * // import { v4 as uuid } from 'uuid'
+     * // import { nanoid } from 'nanoid'
      *
      * class MyEntity {
      *   \@Fields.id({
      *     idFactory: () => createId()
      *     // idFactory: () => uuid()
+     *     // idFactory: () => nanoid()
      *   })
      *   id: string = '';
      * }

package/src/remult3/Fields.js

@@ -135,51 +135,79 @@ var Fields = /** @class */ (function () {
         return Fields.id(tslib_1.__assign({ idFactory: function () { return crypto.randomUUID(); } }, options));
     };
     Object.defineProperty(Fields, "defaultIdFactory", {
+        /**
+         * ### cuid
+         * @example
+         * ```ts
+         * import { Fields } from 'remult'
+         * import { createId } from '@paralleldrive/cuid2'
+         * Fields.defaultIdFactory = () => createId()
+         * ```
+         *
+         * ### nanoid
+         * @example
+         * ```ts
+         * import { Fields } from 'remult'
+         * import { nanoid } from 'nanoid'
+         * Fields.defaultIdFactory = () => nanoid()
+         * ```
+         *
+         */
         get: function () {
-            return this._defaultIdFactory;
+            var _a;
+            return ((_a = remult_static_js_1.remultStatic.defaultIdFactory) !== null && _a !== void 0 ? _a : (remult_static_js_1.remultStatic.defaultIdFactory = function () { return crypto.randomUUID(); }));
         },
         set: function (value) {
-            this._defaultIdFactory = value;
             remult_static_js_1.remultStatic.defaultIdFactory = value;
         },
         enumerable: false,
         configurable: true
     });
     /**
+     * ### Default
      * 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.
+     * ---
+     * ### Global `IdFactory`
+     * You can change the algorithm used to generate the id by setting `Fields.defaultIdFactory`
+     * globally. This code needs to be 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.
+     * ---
+     * ### Local `IdFactory`
+     * You can also pass an `idFactory` as an option to the `@Fields.id` to have a different value on this field.
      * @example
      * ```ts
      * import { createId } from '@paralleldrive/cuid2'
      * // import { v4 as uuid } from 'uuid'
+     * // import { nanoid } from 'nanoid'
      *
      * class MyEntity {
      *   \@Fields.id({
      *     idFactory: () => createId()
      *     // idFactory: () => uuid()
+     *     // idFactory: () => nanoid()
      *   })
      *   id: string = '';
      * }
      * ```
      */
     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 idFactory(); }, saving: function (_, r) {
-                if (!r.value)
+        return Field(function () { return String; }, tslib_1.__assign({ allowApiUpdate: false, defaultValue: function () {
+                var _a;
+                var idFactory = (_a = options === null || options === void 0 ? void 0 : options.idFactory) !== null && _a !== void 0 ? _a : Fields.defaultIdFactory;
+                return idFactory();
+            }, saving: function (_, r) {
+                var _a;
+                if (!r.value) {
+                    var idFactory = (_a = options === null || options === void 0 ? void 0 : options.idFactory) !== null && _a !== void 0 ? _a : Fields.defaultIdFactory;
                     r.value = idFactory();
+                }
             } }, options));
     };
     /**
@@ -276,12 +304,9 @@ 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() {
     }