remult 0.26.3 → 0.26.4

package/esm/src/remult3/Fields.js

@@ -1,8 +1,8 @@
 import { createId } from '@paralleldrive/cuid2';
 import { v4 as uuid } from 'uuid';
 import { ValueConverters } from '../valueConverters.js';
-import { buildOptions } from './RepositoryImplementation.js';
-import { Validators, createValueValidator, getEnumValues } from '../validators.js';
+import { buildOptions, fieldOptionalValuesFunctionKey, } from './RepositoryImplementation.js';
+import { Validators, createValueValidator, getEnumValues, } from '../validators.js';
 import { relationInfoMemberInOptions } from './relationInfoMember.js';
 import { remultStatic } from '../remult-static.js';
 import { addValidator } from './addValidator.js';
@@ -84,10 +84,10 @@ export class Fields {
         }, ...options);
     }
     /**
-   * 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.
-   */
+     * 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.
+     */
     static cuid(...options) {
         return Field(() => String, {
             allowApiUpdate: false,
@@ -129,7 +129,9 @@ export class Fields {
    */
     static literal(optionalValues, ...options) {
         return Fields.string({
-            validate: (entity, event) => Validators.in(optionalValues())(entity, event)
+            validate: (entity, event) => Validators.in(optionalValues())(entity, event),
+            //@ts-expect-error as we are adding this to options without it being defined in options
+            [fieldOptionalValuesFunctionKey]: optionalValues,
         }, ...options);
     }
     static enum(enumType, ...options) {
@@ -137,12 +139,16 @@ export class Fields {
         return Field(() => 
         //@ts-ignore
         enumType(), {
-            validate: (entity, event) => Validators.enum(enumType())(entity, event)
+            validate: (entity, event) => Validators.enum(enumType())(entity, event),
+            [fieldOptionalValuesFunctionKey]: () => getEnumValues(enumType()),
         }, ...options, (options) => {
+            options[fieldOptionalValuesFunctionKey] = () => getEnumValues(enumType());
             if (valueConverter === undefined) {
                 let enumObj = enumType();
                 let enumValues = getEnumValues(enumObj);
-                valueConverter = enumValues.find(x => typeof x === "string") ? ValueConverters.String : ValueConverters.Integer;
+                valueConverter = enumValues.find((x) => typeof x === 'string')
+                    ? ValueConverters.String
+                    : ValueConverters.Integer;
             }
             if (!options.valueConverter) {
                 options.valueConverter = valueConverter;

package/esm/src/remult3/RepositoryImplementation.js

@@ -16,6 +16,7 @@ import { entityDbName, fieldDbName, } from '../filter/filter-consumer-bridge-to-
 import { remultStatic } from '../remult-static.js';
 import { Validators } from '../validators.js';
 import { addValidator } from './addValidator.js';
+import { isOfType } from '../isOfType.js';
 //import  { remult } from "../remult-proxy";
 let classValidatorValidate = undefined;
 // import ("class-validator".toString())
@@ -2079,19 +2080,22 @@ export class ValueListInfo {
 }
 const typeCache = new Map();
 export function getValueList(type) {
-    {
-        const fr = type?.metadata?.valueType;
-        if (fr)
-            return ValueListInfo.get(fr).getValues();
-    }
-    {
-        const fr = type?.valueType;
-        if (fr)
-            return ValueListInfo.get(fr).getValues();
-    }
-    return ValueListInfo.get(type).getValues();
+    let meta = type?.metadata;
+    if (!meta && isOfType(type, 'options'))
+        meta = type;
+    type = meta?.valueType || type;
+    if (type) {
+        var options = type[storableMember];
+        if (options)
+            return ValueListInfo.get(type).getValues();
+    }
+    let optionalValues = meta?.options[fieldOptionalValuesFunctionKey];
+    if (optionalValues)
+        return optionalValues();
+    return undefined;
 }
 export const storableMember = Symbol.for('storableMember');
+export const fieldOptionalValuesFunctionKey = Symbol.for('fieldOptionalValues');
 export function buildOptions(options, remult) {
     let r = {};
     for (const o of options) {

package/esm/src/remult3/remult3.js

@@ -4,6 +4,10 @@ export {};
 //p1 - consider upsert (where,set)
 //p1 - consider id to also support keyof (id:['company','index'])
 //p1 - wait a second to close stream
+//p1 - add solid tutorial to the getting started page
+//p1 - update the examples section
+//p1 - support dbnamesof in sqlexpression of entity
+//p1 - adjust sql expression of entity docs to include a union example
 //p1 - reconsider update many, maybe the second parameter should be in a set option - break existing
 //p1 - add documentation for bun sqlite
 //p1 - describe entity
@@ -16,7 +20,7 @@ export {};
 //y2 - JY suggestion of having generate as part of the ensure schema - not sure
 //y2 - currently for string fields we default for 255 in knex (which is their default) why not just use text (varchar max) - and only use exact length when one is provided?
 //p2 - create foreign key constraints in user code - https://codesandbox.io/p/devbox/fk-validator-tdshcs
-//p1 - admin url1 - pocketbase use /_ for the admin //{allowed?:Allowed,url?:string} also checkout the admin* as it should probably be something else and didn't work in hono
+//p2 - admin url1 - pocketbase use /_ for the admin //{allowed?:Allowed,url?:string} also checkout the admin* as it should probably be something else and didn't work in hono
 //p1 - article auth.js with express - played with it, requires type="module" and a few more configurations - https://github.com/noam-honig/express-auth
 //y2 - fix validators cache
 //y2 - should we validate relations

package/package.json

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

package/server/expressBridge.d.ts

@@ -50,7 +50,10 @@ export interface RemultServerOptions<RequestType> {
     /** When set to true, will display an admin ui in the `/api/admin` url.
      * Can also be set to an arrow function for fine grained control
      * @example
-     * allowed: ()=> remult.isAllowed('admin')
+     * admin: true
+     * @example
+     * admin: ()=> remult.isAllowed('admin')
+     * @see [allowed](http://remult.dev/docs/allowed.html)
      */
     admin?: Allowed;
     /** Storage to use for backend methods that use queue */

package/src/remult3/Fields.d.ts

@@ -17,10 +17,10 @@ export declare class Fields {
     static updatedAt<entityType = any>(...options: (FieldOptions<entityType, Date> | ((options: FieldOptions<entityType, Date>, remult: Remult) => void))[]): ClassFieldDecorator<entityType, Date | undefined>;
     static uuid<entityType = any>(...options: (FieldOptions<entityType, string> | ((options: FieldOptions<entityType, string>, remult: Remult) => void))[]): ClassFieldDecorator<entityType, string | undefined>;
     /**
-   * 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.
-   */
+     * 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.
+     */
     static cuid<entityType = any>(...options: (FieldOptions<entityType, string> | ((options: FieldOptions<entityType, string>, remult: Remult) => void))[]): ClassFieldDecorator<entityType, string | undefined>;
     /**
    * Defines a field that can hold a value from a specified set of string literals.

package/src/remult3/Fields.js

@@ -87,7 +87,8 @@ var Fields = /** @class */ (function () {
         for (var _i = 0; _i < arguments.length; _i++) {
             options[_i] = arguments[_i];
         }
-        return Field.apply(void 0, tslib_1.__spreadArray([function () { return Number; }, {
+        return Field.apply(void 0, tslib_1.__spreadArray([function () { return Number; },
+            {
                 validate: validateNumber,
             }], tslib_1.__read(options), false));
     };
@@ -135,10 +136,10 @@ var Fields = /** @class */ (function () {
             }], tslib_1.__read(options), false));
     };
     /**
-   * 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.
-   */
+     * 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.
+     */
     Fields.cuid = function () {
         var options = [];
         for (var _i = 0; _i < arguments.length; _i++) {
@@ -184,15 +185,22 @@ var Fields = /** @class */ (function () {
    * // This approach allows easy management and updates of the allowed values for the `status` field.
    */
     Fields.literal = function (optionalValues) {
+        var _a;
         var options = [];
         for (var _i = 1; _i < arguments.length; _i++) {
             options[_i - 1] = arguments[_i];
         }
-        return Fields.string.apply(Fields, tslib_1.__spreadArray([{
-                validate: function (entity, event) { return validators_js_1.Validators.in(optionalValues())(entity, event); }
-            }], tslib_1.__read(options), false));
+        return Fields.string.apply(Fields, tslib_1.__spreadArray([(_a = {
+                    validate: function (entity, event) {
+                        return validators_js_1.Validators.in(optionalValues())(entity, event);
+                    }
+                },
+                //@ts-expect-error as we are adding this to options without it being defined in options
+                _a[RepositoryImplementation_js_1.fieldOptionalValuesFunctionKey] = optionalValues,
+                _a)], tslib_1.__read(options), false));
     };
     Fields.enum = function (enumType) {
+        var _a;
         var options = [];
         for (var _i = 1; _i < arguments.length; _i++) {
             options[_i - 1] = arguments[_i];
@@ -201,14 +209,20 @@ var Fields = /** @class */ (function () {
         return Field.apply(void 0, tslib_1.__spreadArray(tslib_1.__spreadArray([function () {
                 //@ts-ignore
                 return (enumType());
-            },
-            {
-                validate: function (entity, event) { return validators_js_1.Validators.enum(enumType())(entity, event); }
-            }], tslib_1.__read(options), false), [function (options) {
+            }, (_a = {
+                    validate: function (entity, event) { return validators_js_1.Validators.enum(enumType())(entity, event); }
+                },
+                _a[RepositoryImplementation_js_1.fieldOptionalValuesFunctionKey] = function () { return (0, validators_js_1.getEnumValues)(enumType()); },
+                _a)], tslib_1.__read(options), false), [function (options) {
+                options[RepositoryImplementation_js_1.fieldOptionalValuesFunctionKey] = function () {
+                    return (0, validators_js_1.getEnumValues)(enumType());
+                };
                 if (valueConverter === undefined) {
                     var enumObj = enumType();
                     var enumValues = (0, validators_js_1.getEnumValues)(enumObj);
-                    valueConverter = enumValues.find(function (x) { return typeof x === "string"; }) ? valueConverters_js_1.ValueConverters.String : valueConverters_js_1.ValueConverters.Integer;
+                    valueConverter = enumValues.find(function (x) { return typeof x === 'string'; })
+                        ? valueConverters_js_1.ValueConverters.String
+                        : valueConverters_js_1.ValueConverters.Integer;
                 }
                 if (!options.valueConverter) {
                     options.valueConverter = valueConverter;

package/src/remult3/RepositoryImplementation.d.ts

@@ -295,6 +295,7 @@ export declare function getValueList<T>(field: FieldRef<T>): T[];
 export declare function getValueList<T>(field: FieldMetadata<T>): T[];
 export declare function getValueList<T>(type: ClassType<T>): T[];
 export declare const storableMember: unique symbol;
+export declare const fieldOptionalValuesFunctionKey: unique symbol;
 export declare function buildOptions<entityType = any, valueType = any>(options: (FieldOptions<entityType, valueType> | ((options: FieldOptions<entityType, valueType>, remult: Remult) => void))[], remult: Remult): FieldOptions<entityType, valueType>;
 export declare function decorateColumnSettings<valueType>(settings: FieldOptions<any, valueType>, remult: Remult): FieldOptions<any, valueType>;
 export declare class EntityBase {

package/src/remult3/RepositoryImplementation.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRepository = exports.getEntityMetadata = exports.ControllerBase = exports.EntityBase = exports.decorateColumnSettings = exports.buildOptions = exports.storableMember = exports.getValueList = exports.ValueListInfo = exports.ValueListFieldType = exports.isAutoIncrement = exports.FieldType = exports.columnDefsImpl = exports.buildCaption = exports.CaptionTransformer = exports.FieldRefImplementation = exports.controllerRefImpl = exports.getControllerRef = exports.getFields = exports.rowHelperImplementation = exports.createOldEntity = exports.RepositoryImplementation = void 0;
+exports.getRepository = exports.getEntityMetadata = exports.ControllerBase = exports.EntityBase = exports.decorateColumnSettings = exports.buildOptions = exports.fieldOptionalValuesFunctionKey = exports.storableMember = exports.getValueList = exports.ValueListInfo = exports.ValueListFieldType = exports.isAutoIncrement = exports.FieldType = exports.columnDefsImpl = exports.buildCaption = exports.CaptionTransformer = exports.FieldRefImplementation = exports.controllerRefImpl = exports.getControllerRef = exports.getFields = exports.rowHelperImplementation = exports.createOldEntity = exports.RepositoryImplementation = void 0;
 var tslib_1 = require("tslib");
 var column_js_1 = require("../column.js");
 var CompoundIdField_js_1 = require("../CompoundIdField.js");
@@ -20,6 +20,7 @@ var filter_consumer_bridge_to_sql_request_js_1 = require("../filter/filter-consu
 var remult_static_js_1 = require("../remult-static.js");
 var validators_js_1 = require("../validators.js");
 var addValidator_js_1 = require("./addValidator.js");
+var isOfType_js_1 = require("../isOfType.js");
 //import  { remult } from "../remult-proxy";
 var classValidatorValidate = undefined;
 // import ("class-validator".toString())
@@ -3385,21 +3386,23 @@ var ValueListInfo = /** @class */ (function () {
 exports.ValueListInfo = ValueListInfo;
 var typeCache = new Map();
 function getValueList(type) {
-    var _a;
-    {
-        var fr = (_a = type === null || type === void 0 ? void 0 : type.metadata) === null || _a === void 0 ? void 0 : _a.valueType;
-        if (fr)
-            return ValueListInfo.get(fr).getValues();
+    var meta = type === null || type === void 0 ? void 0 : type.metadata;
+    if (!meta && (0, isOfType_js_1.isOfType)(type, 'options'))
+        meta = type;
+    type = (meta === null || meta === void 0 ? void 0 : meta.valueType) || type;
+    if (type) {
+        var options = type[exports.storableMember];
+        if (options)
+            return ValueListInfo.get(type).getValues();
     }
-    {
-        var fr = type === null || type === void 0 ? void 0 : type.valueType;
-        if (fr)
-            return ValueListInfo.get(fr).getValues();
-    }
-    return ValueListInfo.get(type).getValues();
+    var optionalValues = meta === null || meta === void 0 ? void 0 : meta.options[exports.fieldOptionalValuesFunctionKey];
+    if (optionalValues)
+        return optionalValues();
+    return undefined;
 }
 exports.getValueList = getValueList;
 exports.storableMember = Symbol.for('storableMember');
+exports.fieldOptionalValuesFunctionKey = Symbol.for('fieldOptionalValues');
 function buildOptions(options, remult) {
     var e_47, _a;
     var r = {};

package/src/remult3/remult3.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 //p1 - consider upsert (where,set)
 //p1 - consider id to also support keyof (id:['company','index'])
 //p1 - wait a second to close stream
+//p1 - add solid tutorial to the getting started page
+//p1 - update the examples section
+//p1 - support dbnamesof in sqlexpression of entity
+//p1 - adjust sql expression of entity docs to include a union example
 //p1 - reconsider update many, maybe the second parameter should be in a set option - break existing
 //p1 - add documentation for bun sqlite
 //p1 - describe entity
@@ -17,7 +21,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 //y2 - JY suggestion of having generate as part of the ensure schema - not sure
 //y2 - currently for string fields we default for 255 in knex (which is their default) why not just use text (varchar max) - and only use exact length when one is provided?
 //p2 - create foreign key constraints in user code - https://codesandbox.io/p/devbox/fk-validator-tdshcs
-//p1 - admin url1 - pocketbase use /_ for the admin //{allowed?:Allowed,url?:string} also checkout the admin* as it should probably be something else and didn't work in hono
+//p2 - admin url1 - pocketbase use /_ for the admin //{allowed?:Allowed,url?:string} also checkout the admin* as it should probably be something else and didn't work in hono
 //p1 - article auth.js with express - played with it, requires type="module" and a few more configurations - https://github.com/noam-honig/express-auth
 //y2 - fix validators cache
 //y2 - should we validate relations