remult 0.26.23 → 0.27.0

package/src/remult3/__updateEntityBasedOnWhere.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.__updateEntityBasedOnWhere = void 0;
+exports.__updateEntityBasedOnWhere = __updateEntityBasedOnWhere;
 var filter_interfaces_js_1 = require("../filter/filter-interfaces.js");
 function __updateEntityBasedOnWhere(entityDefs, where, r) {
     var w = filter_interfaces_js_1.Filter.fromEntityFilter(entityDefs, where);
@@ -29,4 +29,3 @@ function __updateEntityBasedOnWhere(entityDefs, where, r) {
         });
     }
 }
-exports.__updateEntityBasedOnWhere = __updateEntityBasedOnWhere;

package/src/remult3/addValidator.d.ts

@@ -1,2 +1,2 @@
 import type { FieldOptions } from '../column-interfaces.js';
-export declare function addValidator(validators: FieldOptions['validate'], newValidator: FieldOptions['validate'], atStart?: boolean): import("../column-interfaces.js").FieldValidator<any, any> | import("../column-interfaces.js").FieldValidator<any, any>[];
+export declare function addValidator<entityType, valueType>(validators: FieldOptions<entityType, valueType>['validate'], newValidator: FieldOptions<entityType, valueType>['validate'], atStart?: boolean): import("../column-interfaces.js").FieldValidator<entityType, valueType> | import("../column-interfaces.js").FieldValidator<entityType, valueType>[] | undefined;

package/src/remult3/addValidator.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addValidator = void 0;
+exports.addValidator = addValidator;
 var tslib_1 = require("tslib");
 function addValidator(validators, newValidator, atStart) {
     if (atStart === void 0) { atStart = false; }
@@ -17,4 +17,3 @@ function addValidator(validators, newValidator, atStart) {
     return atStart
         ? tslib_1.__spreadArray(tslib_1.__spreadArray([], tslib_1.__read(newValidators), false), tslib_1.__read(validatorsArray), false) : tslib_1.__spreadArray(tslib_1.__spreadArray([], tslib_1.__read(validatorsArray), false), tslib_1.__read(newValidators), false);
 }
-exports.addValidator = addValidator;

package/src/remult3/classDescribers.d.ts

@@ -1,7 +1,7 @@
-import { ClassType } from '../../classType.js';
-import { EntityOptions } from '../entity.js';
-import { BackendMethodOptions } from '../server-action.js';
-type Descriptor<T = any> = (a: T, b: string, c?: any) => void;
+import type { ClassType } from '../../classType.js';
+import type { EntityOptions } from '../entity.js';
+import { type BackendMethodOptions } from '../server-action.js';
+type Descriptor<T = unknown> = (a: T, b: string, c?: any) => void;
 type FieldsDescriptor<T> = T extends new (...args: any[]) => infer R ? {
     [K in keyof R]?: Descriptor;
 } : never;

package/src/remult3/classDescribers.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.describeEntity = exports.describeBackendMethods = exports.describeClass = void 0;
+exports.describeClass = describeClass;
+exports.describeBackendMethods = describeBackendMethods;
+exports.describeEntity = describeEntity;
 var server_action_js_1 = require("../server-action.js");
 var entity_js_1 = require("./entity.js");
 function describeClass(classType, classDescriber, members, staticMembers) {
@@ -23,7 +25,6 @@ function describeClass(classType, classDescriber, members, staticMembers) {
             Object.defineProperty(classType, staticFieldKey, prop);
     }
 }
-exports.describeClass = describeClass;
 function describeBackendMethods(classType, backendMethods) {
     var result = {};
     for (var key in backendMethods) {
@@ -34,8 +35,6 @@ function describeBackendMethods(classType, backendMethods) {
     }
     describeClass(classType, undefined, undefined, result);
 }
-exports.describeBackendMethods = describeBackendMethods;
 function describeEntity(classType, key, fields, options) {
     describeClass(classType, (0, entity_js_1.Entity)(key, options), fields);
 }
-exports.describeEntity = describeEntity;

package/src/remult3/columnInfo.d.ts

@@ -2,5 +2,5 @@ import type { FieldOptions } from '../column-interfaces.js';
 import type { Remult } from '../context.js';
 export interface columnInfo {
     key: string;
-    settings: (remult: Remult) => FieldOptions;
+    settings: (remult: Remult) => FieldOptions<unknown, unknown>;
 }

package/src/remult3/entity.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Entity = void 0;
+exports.Entity = Entity;
 var tslib_1 = require("tslib");
 var context_js_1 = require("../context.js");
 var getEntityRef_js_1 = require("./getEntityRef.js");
@@ -35,11 +35,10 @@ function Entity(key) {
         options[_i - 1] = arguments[_i];
     }
     return function (target, info) {
-        var _a;
         for (var rawFilterMember in target) {
             if (Object.prototype.hasOwnProperty.call(target, rawFilterMember)) {
                 var element = target[rawFilterMember];
-                if ((_a = element === null || element === void 0 ? void 0 : element.rawFilterInfo) === null || _a === void 0 ? void 0 : _a.rawFilterTranslator) {
+                if (element === null || element === void 0 ? void 0 : element.rawFilterInfo) {
                     if (!element.rawFilterInfo.key)
                         element.rawFilterInfo.key = rawFilterMember;
                 }
@@ -85,4 +84,3 @@ function Entity(key) {
         return target;
     };
 }
-exports.Entity = Entity;

package/src/remult3/getEntityRef.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEntityKey = exports.getEntitySettings = exports.entityInfo_key = exports.entityInfo = exports.entityMember = exports.getEntityRef = void 0;
+exports.entityInfo_key = exports.entityInfo = exports.entityMember = void 0;
+exports.getEntityRef = getEntityRef;
+exports.getEntitySettings = getEntitySettings;
+exports.getEntityKey = getEntityKey;
 /**
  * Retrieves the EntityRef object associated with the specified entity instance.
  * The EntityRef provides methods for performing operations on the entity instance.
@@ -20,7 +23,6 @@ function getEntityRef(entity, throwException) {
             ' was not initialized using a context');
     return x;
 }
-exports.getEntityRef = getEntityRef;
 exports.entityMember = Symbol.for('entityMember');
 exports.entityInfo = Symbol.for('entityInfo');
 exports.entityInfo_key = Symbol.for('entityInfo_key');
@@ -38,8 +40,6 @@ function getEntitySettings(entity, throwError) {
             " is not a known entity, did you forget to set @Entity() or did you forget to add the '@' before the call to Entity?");
     return info;
 }
-exports.getEntitySettings = getEntitySettings;
 function getEntityKey(entity) {
     return entity[exports.entityInfo_key];
 }
-exports.getEntityKey = getEntityKey;

package/src/remult3/relation-loader.d.ts

@@ -2,7 +2,7 @@ import type { RelationLoaderHelper } from './relation-loader-types.js';
 import type { FindOptions } from './remult3.js';
 export declare class RelationLoader {
     entityLoaders: Map<any, EntityLoader>;
-    promises: any[];
+    promises: Promise<any>[];
     load(rel: RelationLoaderHelper<any>, findOptions: FindOptions<any>): Promise<any[]>;
     constructor();
     resolveAll(): Promise<void>;

package/src/remult3/relationInfoMember.d.ts

@@ -3,7 +3,7 @@ import type { FieldMetadata, FieldOptions } from '../column-interfaces.js';
 import type { Remult } from '../context.js';
 import type { DataProvider } from '../data-interfaces.js';
 import type { RelationOptions, Repository } from './remult3.js';
-export declare function relationInfoMemberInOptions(toEntityType: () => ClassType<any>, type: RelationFieldInfo['type']): FieldOptions<any, any>;
+export declare function relationInfoMemberInOptions(toEntityType: () => ClassType<any>, type: RelationFieldInfo['type']): FieldOptions;
 /**
  * @deprecated
  */
@@ -15,10 +15,10 @@ export interface RelationInfo {
     toType: () => any;
     type: RelationFieldInfo['type'];
 }
-export declare function getRelationFieldInfo(field: FieldMetadata): RelationFieldInfo;
+export declare function getRelationFieldInfo(field: FieldMetadata): RelationFieldInfo | undefined;
 export interface RelationFieldInfo {
     type: 'reference' | 'toOne' | 'toMany';
-    options: RelationOptions<any, any, any>;
+    options: RelationOptions<unknown, unknown, unknown>;
     toEntity: any;
     toRepo: Repository<unknown>;
     getFields(): RelationFields;

package/src/remult3/relationInfoMember.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyFieldRelationInfo = exports.getRelationFieldInfo = exports.getRelationInfo = exports.relationInfoMemberInOptions = void 0;
+exports.relationInfoMemberInOptions = relationInfoMemberInOptions;
+exports.getRelationInfo = getRelationInfo;
+exports.getRelationFieldInfo = getRelationFieldInfo;
+exports.verifyFieldRelationInfo = verifyFieldRelationInfo;
 var tslib_1 = require("tslib");
 var CompoundIdField_js_1 = require("../CompoundIdField.js");
 function relationInfoMemberInOptions(toEntityType, type) {
@@ -12,7 +15,6 @@ function relationInfoMemberInOptions(toEntityType, type) {
         },
         _a;
 }
-exports.relationInfoMemberInOptions = relationInfoMemberInOptions;
 var relationInfoMember = Symbol.for('relationInfo');
 /**
  * @deprecated
@@ -20,12 +22,10 @@ var relationInfoMember = Symbol.for('relationInfo');
 function getRelationInfo(options) {
     return options === null || options === void 0 ? void 0 : options[relationInfoMember];
 }
-exports.getRelationInfo = getRelationInfo;
 var fieldRelationInfo = Symbol.for('fieldRelationInfo');
 function getRelationFieldInfo(field) {
     return field[fieldRelationInfo];
 }
-exports.getRelationFieldInfo = getRelationFieldInfo;
 function verifyFieldRelationInfo(repo, remult, dp) {
     var e_1, _a;
     var _loop_1 = function (field) {
@@ -147,4 +147,3 @@ function verifyFieldRelationInfo(repo, remult, dp) {
         finally { if (e_1) throw e_1.error; }
     }
 }
-exports.verifyFieldRelationInfo = verifyFieldRelationInfo;

package/src/remult3/remult3.d.ts

@@ -8,18 +8,18 @@ import type { SortSegment } from '../sort.js';
 import type { EntityBase } from './RepositoryImplementation.js';
 export interface EntityRefBase<entityType> extends Subscribable {
     hasErrors(): boolean;
-    undoChanges(): any;
+    undoChanges(): void;
     save(): Promise<entityType>;
     reload(): Promise<entityType>;
     delete(): Promise<void>;
     isNew(): boolean;
     wasChanged(): boolean;
     wasDeleted(): boolean;
-    error: string;
+    error: string | undefined;
     getId(): idType<entityType>;
     getOriginalId(): idType<entityType>;
-    repository: Repository<entityType>;
-    metadata: EntityMetadata<entityType>;
+    repository: Repository<unknown>;
+    metadata: EntityMetadata<unknown>;
     toApiJson(): any;
     validate(): Promise<ErrorInfo<entityType> | undefined>;
     readonly apiUpdateAllowed: boolean;
@@ -36,8 +36,8 @@ export interface EntityRefForEntityBase<entityType> extends EntityRefBase<entity
     fields: FieldsRefForEntityBase<entityType>;
     relations: RepositoryRelationsForEntityBase<entityType>;
 }
-export interface ValidateFieldEvent<entityType = any, valueType = any> {
-    error: string;
+export interface ValidateFieldEvent<entityType = unknown, valueType = unknown> {
+    error?: string;
     value: valueType;
     originalValue: valueType;
     valueChanged(): boolean;
@@ -95,7 +95,7 @@ export interface LifecycleEvent<entityType> {
 }
 export interface ControllerRefBase<entityType> extends Subscribable {
     hasErrors(): boolean;
-    error: string;
+    error: string | undefined;
     validate(): Promise<ErrorInfo<entityType> | undefined>;
     readonly isLoading: boolean;
 }
@@ -119,19 +119,19 @@ export type FieldsRefBase<entityType> = {
     toArray(): FieldRef<entityType, any>[];
 };
 export type FieldsMetadata<entityType> = {
-    [Properties in keyof MembersOnly<entityType>]: FieldMetadata<entityType[Properties], entityType>;
+    [Properties in keyof MembersOnly<entityType>]-?: FieldMetadata<entityType[Properties], entityType>;
 } & {
-    find(fieldMetadataOrKey: FieldMetadata | string): FieldMetadata<any, entityType>;
+    find(fieldMetadataOrKey: FieldMetadata | string): FieldMetadata<unknown, entityType>;
     [Symbol.iterator]: () => IterableIterator<FieldMetadata<any, entityType>>;
     toArray(): FieldMetadata<any, entityType>[];
 };
 export type FieldsRef<entityType> = FieldsRefBase<entityType> & {
-    [Properties in keyof MembersOnly<entityType>]: NonNullable<entityType[Properties]> extends {
+    [Properties in keyof MembersOnly<entityType>]-?: NonNullable<entityType[Properties]> extends {
         id?: number | string;
     } ? IdFieldRef<entityType, entityType[Properties]> : FieldRef<entityType, entityType[Properties]>;
 };
 export type FieldsRefForEntityBase<entityType> = FieldsRefBase<entityType> & {
-    [Properties in keyof Omit<entityType, keyof EntityBase>]: NonNullable<entityType[Properties]> extends {
+    [Properties in keyof Omit<entityType, keyof EntityBase>]-?: NonNullable<entityType[Properties]> extends {
         id?: number | string;
     } ? IdFieldRef<entityType, entityType[Properties]> : FieldRef<entityType, entityType[Properties]>;
 };
@@ -145,15 +145,15 @@ export interface IdFieldRef<entityType, valueType> extends FieldRef<entityType,
         id?: number;
     } ? number : valueType extends {
         id?: string;
-    } ? string : string | number): any;
+    } ? string : string | number): void;
     getId(): valueType extends {
         id?: number;
     } ? number : valueType extends {
         id?: string;
     } ? string : string | number;
 }
-export interface FieldRef<entityType = any, valueType = any> extends Subscribable {
-    error: string;
+export interface FieldRef<entityType = unknown, valueType = unknown> extends Subscribable {
+    error: string | undefined;
     displayValue: string;
     value: valueType;
     originalValue: valueType;
@@ -162,12 +162,15 @@ export interface FieldRef<entityType = any, valueType = any> extends Subscribabl
     entityRef: EntityRef<entityType>;
     container: entityType;
     metadata: FieldMetadata<valueType>;
+    /**
+     * Loads the related value - returns null if the related value is not found
+     */
     load(): Promise<valueType>;
     valueIsNull(): boolean;
     originalValueIsNull(): boolean;
     validate(): Promise<boolean>;
 }
-export interface IdMetadata<entityType = any> {
+export interface IdMetadata<entityType = unknown> {
     /** Extracts the id value of an entity item. Useful in cases where the id column is not called id
      * @example
      * repo.metadata.idMetadata.getId(task)
@@ -180,7 +183,7 @@ export interface IdMetadata<entityType = any> {
     createIdInFilter(items: Partial<MembersOnly<entityType>>[]): EntityFilter<entityType>;
 }
 /** Metadata for an `Entity`, this metadata can be used in the user interface to provide a richer UI experience  */
-export interface EntityMetadata<entityType = any> {
+export interface EntityMetadata<entityType = unknown> {
     /** The Entity's key also used as it's url  */
     readonly key: string;
     /** Metadata for the Entity's fields */
@@ -265,16 +268,16 @@ export interface Repository<entityType> {
      * @example
      * await taskRepo.findFirst({ completed:false },{ createIfNotFound: true })
      *      */
-    findFirst(where?: EntityFilter<entityType>, options?: FindFirstOptions<entityType>): Promise<entityType>;
+    findFirst(where?: EntityFilter<entityType>, options?: FindFirstOptions<entityType>): Promise<entityType | undefined>;
     /** returns the first item that matchers the `where` condition
      * @example
      * await taskRepo.findOne({ where:{ completed:false }})
      * @example
      * await taskRepo.findFirst({ where:{ completed:false }, createIfNotFound: true })
      *      */
-    findOne(options?: FindFirstOptions<entityType>): Promise<entityType>;
-    /** returns the items that matches the idm the result is cached unless specified differently in the `options` parameter */
-    findId(id: idType<entityType>, options?: FindFirstOptionsBase<entityType>): Promise<entityType>;
+    findOne(options?: FindFirstOptions<entityType>): Promise<entityType | undefined>;
+    /** returns the items that matches the id. If id is undefined | null, returns null */
+    findId(id: idType<entityType>, options?: FindFirstOptionsBase<entityType>): Promise<entityType | undefined | null>;
     /**  An alternative form of fetching data from the API server, which is intended for operating on large numbers of entity objects.
      *
      * It also has it's own paging mechanism that can be used n paging scenarios.

package/src/remult3/remult3.js

@@ -16,6 +16,21 @@ exports.flags = {
 //p1 - replace uuid with crypto.randomUUID and allow custom fallback NO
 //p1 - add nanoid - NO
 //p1 - add id and use luid by default, but allow changes with Fields.id.defaultIdProvider NO but defaultProvider yes
+/*p1
+ * field, fieldType ,ValueListFieldType, - return optional parameter for decorators
+ * options to remultExpress tc... should be mandatory
+ * return value converter to previous typing
+ * add breaking change notification about findOne and findFirst and findId
+ */
+//p1 - fix query docs to also explain how it can be used for infinite scroll and pagination.
+//y1 - 'test expression columns without aliases'
+//y1 - ts issue with fields - when a field is optional, it's $ is also optional and thats a problem
+//p1 - vite 5.3 supports ts5 decorators - check and adapt.
+//p1 - see if I can fix the no alias problem in selects
+//p1 - add luid - it's cool for order by.
+//p1 - replace uuid with crypto.randomUUID and allow custom fallback
+//p1 - add nanoid
+//p1 - add id and use luid by default, but allow changes with Fields.id.defaultIdProvider
 //p1 - explain the benefits of changing the default provider for testing in docs.
 //p1 - fix sqlite to  support alter table when adding a column with ensure schema = on
 //p1 - fix app custom filters example for multiple filters.

package/src/remult3/repository-internals.d.ts

@@ -7,9 +7,9 @@ export interface RepositoryInternal<entityType> {
     _fromJsonArray(jsonItems: any[], loadOptions: LoadOptions<entityType>): Promise<entityType[]>;
     _buildEntityDataProviderFindOptions(options: FindOptions<entityType>): Promise<EntityDataProviderFindOptions>;
     _translateWhereToFilter(where: EntityFilter<entityType>): Promise<Filter>;
-    _getCachedById(id: any, doNotLoadIfNotFound: boolean): entityType;
-    _getCachedByIdAsync(id: any, doNotLoadIfNotFound: boolean): Promise<entityType>;
-    _addToCache(item: entityType): any;
+    _getCachedById(id: any, doNotLoadIfNotFound: boolean): entityType | undefined;
+    _getCachedByIdAsync(id: any, doNotLoadIfNotFound: boolean): Promise<entityType | undefined>;
+    _addToCache(item: entityType): void;
     _getFocusedRelationRepo(field: FieldMetadata, item: any): {
         toRepo: Repository<any>;
         returnNull: boolean;

package/src/remult3/repository-internals.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInternalKey = exports.getRepositoryInternals = void 0;
+exports.getInternalKey = void 0;
+exports.getRepositoryInternals = getRepositoryInternals;
 function getRepositoryInternals(repo) {
     var x = repo;
     if (typeof x[exports.getInternalKey] === 'function')
         return x[exports.getInternalKey]();
     throw Error('Error getting repository internal from ' + repo);
 }
-exports.getRepositoryInternals = getRepositoryInternals;
 exports.getInternalKey = Symbol.for('getInternal');

package/src/server-action.d.ts

@@ -54,7 +54,7 @@ export interface ClassMethodDecoratorContextStub<This = unknown, Value extends (
     };
 }
 /** Indicates that the decorated methods runs on the backend. See: [Backend Methods](https://remult.dev/docs/backendMethods.html) */
-export declare function BackendMethod<type = any>(options: BackendMethodOptions<type>): (target: any, context: ClassMethodDecoratorContextStub<type> | string, descriptor?: any) => any;
+export declare function BackendMethod<type = unknown>(options: BackendMethodOptions<type>): (target: any, context: ClassMethodDecoratorContextStub<type> | string, descriptor?: any) => any;
 export interface jobWasQueuedResult {
     queuedJobId?: string;
 }
@@ -74,6 +74,6 @@ export declare function prepareReceivedArgs(types: any[], args: any[], remult: R
 export declare const classBackendMethodsArray: unique symbol;
 export interface ActionInterface {
     doWork: (args: any[], self: any, baseUrl?: string, http?: RestDataProviderHttpProvider) => Promise<any>;
-    __register(reg: (url: string, queue: boolean, allowed: AllowedForInstance<any>, what: (data: any, req: Remult, res: DataApiResponse) => void) => void): any;
+    __register(reg: (url: string, queue: boolean, allowed: AllowedForInstance<any>, what: (data: any, req: Remult, res: DataApiResponse) => void) => void): void;
 }
 export {};