remult 3.1.0-next.1 → 3.1.1

package/esm/index.js

@@ -1,4 +1,5 @@
 export { ArrayEntityDataProvider } from './src/data-providers/array-entity-data-provider.js';
+export { standardSchema } from './src/standard-schema/index.js';
 export { EntityBase, ControllerBase, FieldType, getFields, ValueListFieldType, getValueList, ValueListInfo, } from './src/remult3/RepositoryImplementation.js';
 import { LabelTransformer } from './src/remult3/RepositoryImplementation.js';
 export { LabelTransformer } from './src/remult3/RepositoryImplementation.js';

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/esm/src/standard-schema/StandardSchemaV1.js

@@ -0,0 +1 @@
+export {};

package/esm/src/standard-schema/index.js

@@ -0,0 +1,52 @@
+/**
+ * Implementation of the [Standard Schema](https://standardschema.dev/) specification
+ *
+ * @usage
+ * ```ts
+ * // The schema for the entire entity
+ * const schema = standardSchema(repo(User))
+ *
+ * // The schema for a specific field
+ * const schema = standardSchema(repo(User), 'id')
+ *
+ * // The schema for multiple fields
+ * const schema = standardSchema(repo(User), 'name', 'age')
+ * ```
+ */
+export function standardSchema(repo, ...fields) {
+    return {
+        '~standard': {
+            version: 1,
+            vendor: 'remult',
+            async validate(value) {
+                const item = value;
+                try {
+                    const error = await repo.validate(item, ...fields);
+                    if (error && error.modelState) {
+                        return {
+                            issues: Object.entries(error.modelState).map(([key, message]) => ({
+                                message: message,
+                                path: [key],
+                            })),
+                        };
+                    }
+                }
+                catch (err) {
+                    if (err instanceof Error) {
+                        return { issues: [{ message: err.message, path: [] }] };
+                    }
+                }
+                if (fields.length > 0) {
+                    const filteredItem = {};
+                    for (const field of fields) {
+                        if (field in item) {
+                            filteredItem[field] = item[field];
+                        }
+                    }
+                    return { value: filteredItem };
+                }
+                return { value: item };
+            },
+        },
+    };
+}

package/index.d.ts

@@ -4,6 +4,7 @@ export { ArrayEntityDataProvider } from './src/data-providers/array-entity-data-
 export type { ClassType } from './classType.js';
 export { ValidateFieldEvent, MembersOnly, NumericKeys, FieldsMetadata, FieldRef, IdFieldRef, FieldsRef, EntityMetadata, EntityOrderBy, EntityFilter, FindOptions, FindOptionsBase, QueryResult, QueryOptions, UpsertOptions, Repository, GroupByOptions, GroupByResult, FindFirstOptions, ComparisonValueFilter, ValueFilter, IdFilter, ContainsStringValueFilter, EntityRef, SortSegments, Paginator, LiveQuery, LiveQueryChangeInfo, Subscribable, RefSubscriber, RefSubscriberBase, RelationOptions, ObjectMembersOnly, MembersToInclude, RepositoryRelations, EntityIdFields, ClassFieldDecorator, ClassFieldDecoratorContextStub, //n1 consider removing in ts5
 LifecycleEvent, FieldsRefBase, FieldsRefForEntityBase, RepositoryRelationsForEntityBase, ControllerRefForControllerBase, ControllerRefBase, ControllerRef, EntityRefForEntityBase, IdMetadata, FindFirstOptionsBase, } from './src/remult3/remult3.js';
+export { standardSchema } from './src/standard-schema/index.js';
 export { EntityBase, ControllerBase, FieldType, getFields, ValueListFieldType, getValueList, ValueListFieldOptions, ValueListInfo, } from './src/remult3/RepositoryImplementation.js';
 export { LabelTransformer } from './src/remult3/RepositoryImplementation.js';
 /**

package/index.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InMemoryLiveQueryStorage = exports.remult = exports.ValueConverters = exports.createValueValidator = exports.createValueValidatorWithArgs = exports.createValidatorWithArgs = exports.createValidator = exports.valueValidator = exports.Validators = exports.UrlBuilder = exports.Filter = exports.CompoundIdField = exports.Sort = exports.EventSource = exports.isBackend = exports.withRemult = exports.Remult = exports.Allow = exports.ForbiddenError = exports.ProgressListener = exports.BackendMethod = exports.Controller = exports.JsonEntityIndexedDbStorage = exports.JsonEntityOpfsStorage = exports.JsonDataProvider = exports.dbNamesOf = exports.CustomSqlFilterBuilder = exports.SqlDatabase = exports.InMemoryDataProvider = exports.RestDataProvider = exports.EntityError = exports.describeEntity = exports.describeBackendMethods = exports.describeClass = exports.IdEntity = exports.Relations = exports.Fields = exports.Field = exports.getEntityRef = exports.Entity = exports.CaptionTransformer = exports.LabelTransformer = exports.ValueListInfo = exports.getValueList = exports.ValueListFieldType = exports.getFields = exports.FieldType = exports.ControllerBase = exports.EntityBase = exports.ArrayEntityDataProvider = void 0;
-exports.SubscriptionChannel = void 0;
+exports.remult = exports.ValueConverters = exports.createValueValidator = exports.createValueValidatorWithArgs = exports.createValidatorWithArgs = exports.createValidator = exports.valueValidator = exports.Validators = exports.UrlBuilder = exports.Filter = exports.CompoundIdField = exports.Sort = exports.EventSource = exports.isBackend = exports.withRemult = exports.Remult = exports.Allow = exports.ForbiddenError = exports.ProgressListener = exports.BackendMethod = exports.Controller = exports.JsonEntityIndexedDbStorage = exports.JsonEntityOpfsStorage = exports.JsonDataProvider = exports.dbNamesOf = exports.CustomSqlFilterBuilder = exports.SqlDatabase = exports.InMemoryDataProvider = exports.RestDataProvider = exports.EntityError = exports.describeEntity = exports.describeBackendMethods = exports.describeClass = exports.IdEntity = exports.Relations = exports.Fields = exports.Field = exports.getEntityRef = exports.Entity = exports.CaptionTransformer = exports.LabelTransformer = exports.ValueListInfo = exports.getValueList = exports.ValueListFieldType = exports.getFields = exports.FieldType = exports.ControllerBase = exports.EntityBase = exports.standardSchema = exports.ArrayEntityDataProvider = void 0;
+exports.SubscriptionChannel = exports.InMemoryLiveQueryStorage = void 0;
 exports.repo = repo;
 var array_entity_data_provider_js_1 = require("./src/data-providers/array-entity-data-provider.js");
 Object.defineProperty(exports, "ArrayEntityDataProvider", { enumerable: true, get: function () { return array_entity_data_provider_js_1.ArrayEntityDataProvider; } });
+var index_js_1 = require("./src/standard-schema/index.js");
+Object.defineProperty(exports, "standardSchema", { enumerable: true, get: function () { return index_js_1.standardSchema; } });
 var RepositoryImplementation_js_1 = require("./src/remult3/RepositoryImplementation.js");
 Object.defineProperty(exports, "EntityBase", { enumerable: true, get: function () { return RepositoryImplementation_js_1.EntityBase; } });
 Object.defineProperty(exports, "ControllerBase", { enumerable: true, get: function () { return RepositoryImplementation_js_1.ControllerBase; } });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "3.1.0-next.1",
+    "version": "3.1.1",
     "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() {
     }

package/src/standard-schema/StandardSchemaV1.d.ts

@@ -0,0 +1,56 @@
+/** The Standard Schema interface. */
+export interface StandardSchemaV1<Input = unknown, Output = Input> {
+    /** The Standard Schema properties. */
+    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
+}
+export declare namespace StandardSchemaV1 {
+    /** The Standard Schema properties interface. */
+    export interface Props<Input = unknown, Output = Input> {
+        /** The version number of the standard. */
+        readonly version: 1;
+        /** The vendor name of the schema library. */
+        readonly vendor: string;
+        /** Validates unknown input values. */
+        readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>;
+        /** Inferred types associated with the schema. */
+        readonly types?: Types<Input, Output> | undefined;
+    }
+    /** The result interface of the validate function. */
+    export type Result<Output> = SuccessResult<Output> | FailureResult;
+    /** The result interface if validation succeeds. */
+    export interface SuccessResult<Output> {
+        /** The typed output value. */
+        readonly value: Output;
+        /** The non-existent issues. */
+        readonly issues?: undefined;
+    }
+    /** The result interface if validation fails. */
+    export interface FailureResult {
+        /** The issues of failed validation. */
+        readonly issues: ReadonlyArray<Issue>;
+    }
+    /** The issue interface of the failure output. */
+    export interface Issue {
+        /** The error message of the issue. */
+        readonly message: string;
+        /** The path of the issue, if any. */
+        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
+    }
+    /** The path segment interface of the issue. */
+    export interface PathSegment {
+        /** The key representing a path segment. */
+        readonly key: PropertyKey;
+    }
+    /** The Standard Schema types interface. */
+    export interface Types<Input = unknown, Output = Input> {
+        /** The input type of the schema. */
+        readonly input: Input;
+        /** The output type of the schema. */
+        readonly output: Output;
+    }
+    /** Infers the input type of a Standard Schema. */
+    export type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
+    /** Infers the output type of a Standard Schema. */
+    export type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
+    export {};
+}

package/src/standard-schema/StandardSchemaV1.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/standard-schema/index.d.ts

@@ -0,0 +1,22 @@
+import type { MembersOnly, Repository } from '../../index.js';
+import type { StandardSchemaV1 } from './StandardSchemaV1.js';
+type OutputType<entityType, fields extends string[]> = fields extends [] ? Partial<entityType> : Pick<entityType, Extract<keyof entityType, fields[number]>>;
+interface RemultEntitySchema<entityType, fields extends string[] = []> extends StandardSchemaV1<Partial<entityType>, OutputType<entityType, fields>> {
+}
+/**
+ * Implementation of the [Standard Schema](https://standardschema.dev/) specification
+ *
+ * @usage
+ * ```ts
+ * // The schema for the entire entity
+ * const schema = standardSchema(repo(User))
+ *
+ * // The schema for a specific field
+ * const schema = standardSchema(repo(User), 'id')
+ *
+ * // The schema for multiple fields
+ * const schema = standardSchema(repo(User), 'name', 'age')
+ * ```
+ */
+export declare function standardSchema<entityType, fieldsType extends Extract<keyof MembersOnly<entityType>, string>[] = []>(repo: Repository<entityType>, ...fields: fieldsType): RemultEntitySchema<entityType, fieldsType>;
+export {};

package/src/standard-schema/index.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.standardSchema = standardSchema;
+var tslib_1 = require("tslib");
+/**
+ * Implementation of the [Standard Schema](https://standardschema.dev/) specification
+ *
+ * @usage
+ * ```ts
+ * // The schema for the entire entity
+ * const schema = standardSchema(repo(User))
+ *
+ * // The schema for a specific field
+ * const schema = standardSchema(repo(User), 'id')
+ *
+ * // The schema for multiple fields
+ * const schema = standardSchema(repo(User), 'name', 'age')
+ * ```
+ */
+function standardSchema(repo) {
+    var fields = [];
+    for (var _i = 1; _i < arguments.length; _i++) {
+        fields[_i - 1] = arguments[_i];
+    }
+    return {
+        '~standard': {
+            version: 1,
+            vendor: 'remult',
+            validate: function (value) {
+                return tslib_1.__awaiter(this, void 0, void 0, function () {
+                    var item, error, err_1, filteredItem, fields_1, fields_1_1, field;
+                    var e_1, _a;
+                    return tslib_1.__generator(this, function (_b) {
+                        switch (_b.label) {
+                            case 0:
+                                item = value;
+                                _b.label = 1;
+                            case 1:
+                                _b.trys.push([1, 3, , 4]);
+                                return [4 /*yield*/, repo.validate.apply(repo, tslib_1.__spreadArray([item], tslib_1.__read(fields), false))];
+                            case 2:
+                                error = _b.sent();
+                                if (error && error.modelState) {
+                                    return [2 /*return*/, {
+                                            issues: Object.entries(error.modelState).map(function (_a) {
+                                                var _b = tslib_1.__read(_a, 2), key = _b[0], message = _b[1];
+                                                return ({
+                                                    message: message,
+                                                    path: [key],
+                                                });
+                                            }),
+                                        }];
+                                }
+                                return [3 /*break*/, 4];
+                            case 3:
+                                err_1 = _b.sent();
+                                if (err_1 instanceof Error) {
+                                    return [2 /*return*/, { issues: [{ message: err_1.message, path: [] }] }];
+                                }
+                                return [3 /*break*/, 4];
+                            case 4:
+                                if (fields.length > 0) {
+                                    filteredItem = {};
+                                    try {
+                                        for (fields_1 = tslib_1.__values(fields), fields_1_1 = fields_1.next(); !fields_1_1.done; fields_1_1 = fields_1.next()) {
+                                            field = fields_1_1.value;
+                                            if (field in item) {
+                                                filteredItem[field] = item[field];
+                                            }
+                                        }
+                                    }
+                                    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                                    finally {
+                                        try {
+                                            if (fields_1_1 && !fields_1_1.done && (_a = fields_1.return)) _a.call(fields_1);
+                                        }
+                                        finally { if (e_1) throw e_1.error; }
+                                    }
+                                    return [2 /*return*/, { value: filteredItem }];
+                                }
+                                return [2 /*return*/, { value: item }];
+                        }
+                    });
+                });
+            },
+        },
+    };
+}