remult 0.22.9-exp.0 → 0.22.9

package/esm/src/remult3/Fields.js

@@ -1,8 +1,7 @@
 import { createId } from '@paralleldrive/cuid2';
 import { v4 as uuid } from 'uuid';
 import { ValueConverters } from '../valueConverters';
-import { getEntityRef } from './getEntityRef';
-import { buildOptions, columnsOfType, } from './RepositoryImplementation';
+import { buildOptions, columnsOfType } from './RepositoryImplementation';
 import { relationInfoMember } from './relationInfoMember';
 export class Fields {
     /**
@@ -47,8 +46,8 @@ export class Fields {
     static createdAt(...options) {
         return Field(() => Date, {
             allowApiUpdate: false,
-            saving: (_, ref) => {
-                if (getEntityRef(_).isNew())
+            saving: (_, { isNew }, ref) => {
+                if (isNew)
                     ref.value = new Date();
             },
         }, ...options);
@@ -56,7 +55,7 @@ export class Fields {
     static updatedAt(...options) {
         return Field(() => Date, {
             allowApiUpdate: false,
-            saving: (_, ref) => {
+            saving: (_, _1, ref) => {
                 ref.value = new Date();
             },
         }, ...options);
@@ -65,7 +64,7 @@ export class Fields {
         return Field(() => String, {
             allowApiUpdate: false,
             defaultValue: () => uuid(),
-            saving: (_, r) => {
+            saving: (_, _1, r) => {
                 if (!r.value)
                     r.value = uuid();
             },
@@ -75,7 +74,7 @@ export class Fields {
         return Field(() => String, {
             allowApiUpdate: false,
             defaultValue: () => createId(),
-            saving: (_, r) => {
+            saving: (_, _1, r) => {
                 if (!r.value)
                     r.value = createId();
             },
@@ -87,25 +86,24 @@ export class Fields {
     static boolean(...options) {
         return Field(() => Boolean, ...options);
     }
-    //[ ] docking the move from reference to one will not be fun,since the parameter order changes
-    static reference(toEntityType, options) {
-        let op = (!options
-            ? {}
-            : options);
-        return Field(toEntityType, {
-            ...op,
-            //@ts-ignore
-            [relationInfoMember]: {
-                //field,
-                toType: toEntityType,
-                type: 'reference',
-            },
-        });
-    }
-    static many(toEntityType, options) {
+}
+export class Relations {
+    static toOne(toEntityType, options) {
         let op = (typeof options === 'string'
             ? { field: options }
-            : options);
+            : !options
+                ? {}
+                : options);
+        if (!op.field && !op.fields && !op.findOptions)
+            return Field(toEntityType, {
+                ...op,
+                //@ts-ignore
+                [relationInfoMember]: {
+                    //field,
+                    toType: toEntityType,
+                    type: 'reference',
+                },
+            });
         return Field(() => undefined, {
             ...op,
             serverExpression: () => undefined,
@@ -113,16 +111,14 @@ export class Fields {
             [relationInfoMember]: {
                 //field,
                 toType: toEntityType,
-                type: 'toMany',
+                type: 'toOne',
             },
         });
     }
-    static one(entity, toEntityType, options) {
+    static toMany(toEntityType, options) {
         let op = (typeof options === 'string'
             ? { field: options }
-            : !options
-                ? {}
-                : options);
+            : options);
         return Field(() => undefined, {
             ...op,
             serverExpression: () => undefined,
@@ -130,7 +126,7 @@ export class Fields {
             [relationInfoMember]: {
                 //field,
                 toType: toEntityType,
-                type: 'toOne',
+                type: 'toMany',
             },
         });
     }

package/esm/src/remult3/RepositoryImplementation.d.ts

@@ -3,27 +3,23 @@ import { LookupColumn } from '../column';
 import type { FieldMetadata, FieldOptions, ValueConverter, ValueListItem } from '../column-interfaces';
 import { Remult } from '../context';
 import type { EntityOptions } from '../entity';
-import type { ControllerRef, EntityFilter, EntityMetadata, EntityOrderBy, EntityRef, FieldRef, FieldsMetadata, FieldsRef, FindFirstOptions, FindFirstOptionsBase, FindOptions, IdMetadata, LiveQuery, OmitEB, QueryOptions, QueryResult, Repository, RepositoryRelations, Subscribable } from './remult3';
+import type { ControllerRef, EntityFilter, EntityMetadata, EntityOrderBy, EntityRef, FieldRef, FieldsMetadata, FieldsRef, FindFirstOptions, FindFirstOptionsBase, FindOptions, IdMetadata, LiveQuery, OmitEB, QueryOptions, QueryResult, Repository, Subscribable } from './remult3';
 import type { RefSubscriber } from './remult3';
 import type { entityEventListener } from '../__EntityValueProvider';
 import type { DataProvider, EntityDataProvider, EntityDataProviderFindOptions, ErrorInfo } from '../data-interfaces';
 import type { Unsubscribe } from '../live-query/SubscriptionChannel';
-import type { columnInfo } from './columnInfo';
-import { RelationLoader } from './relation-loader';
 export declare class RepositoryImplementation<entityType> implements Repository<entityType> {
     private entity;
     remult: Remult;
     private dataProvider;
-    private _info;
-    private defaultFindOptions?;
     createAfterFilter(orderBy: EntityOrderBy<entityType>, lastRow: entityType): Promise<EntityFilter<entityType>>;
-    relations(item: entityType): RepositoryRelations<entityType>;
+    private _info;
     private __edp;
     private get edp();
-    constructor(entity: ClassType<entityType>, remult: Remult, dataProvider: DataProvider, _info: EntityFullInfo<entityType>, defaultFindOptions?: FindOptions<entityType>);
+    constructor(entity: ClassType<entityType>, remult: Remult, dataProvider: DataProvider);
     idCache: Map<any, any>;
-    getCachedById(id: any, doNotLoadIfNotFound: boolean): entityType;
-    getCachedByIdAsync(id: any, doNotLoadIfNotFound: boolean): Promise<entityType>;
+    getCachedById(id: any): entityType;
+    getCachedByIdAsync(id: any): Promise<entityType>;
     addToCache(item: entityType): void;
     get metadata(): EntityMetadata<entityType>;
     listeners: entityEventListener<entityType>[];
@@ -50,7 +46,6 @@ export declare class RepositoryImplementation<entityType> implements Repository<
     save(item: Partial<OmitEB<entityType>>[]): Promise<entityType[]>;
     save(item: Partial<OmitEB<entityType>>): Promise<entityType>;
     liveQuery(options?: FindOptions<entityType>): LiveQuery<entityType>;
-    rawFind(options: FindOptions<entityType>, skipOrderByAndLimit: boolean, loader: RelationLoader): Promise<Awaited<entityType>[]>;
     find(options: FindOptions<entityType>, skipOrderByAndLimit?: boolean): Promise<entityType[]>;
     buildEntityDataProviderFindOptions(options: FindOptions<entityType>): Promise<EntityDataProviderFindOptions>;
     fromJsonArray(jsonItems: any[], load?: (entity: FieldsMetadata<entityType>) => FieldMetadata[]): Promise<Awaited<entityType>[]>;
@@ -103,7 +98,7 @@ declare abstract class rowHelperBase<T> {
     __validateEntity(): Promise<void>;
     __performColumnAndEntityValidations(): Promise<void>;
     toApiJson(includeRelatedEntities?: boolean): any;
-    _updateEntityBasedOnApi(body: any): Promise<void>;
+    _updateEntityBasedOnApi(body: any, ignoreApiAllowed?: boolean): Promise<void>;
 }
 export declare class rowHelperImplementation<T> extends rowHelperBase<T> implements EntityRef<T> {
     private info;
@@ -223,7 +218,28 @@ declare class EntityFullInfo<T> implements EntityMetadata<T> {
     caption: string;
 }
 export declare function FieldType<valueType = any>(...options: (FieldOptions<any, valueType> | ((options: FieldOptions<any, valueType>, remult: Remult) => void))[]): (target: any, context?: any) => any;
+export declare class Fields {
+    /**
+     * Stored as a JSON.stringify - to store as json use Fields.json
+     */
+    static object<entityType = any, valueType = any>(...options: (FieldOptions<entityType, valueType> | ((options: FieldOptions<entityType, valueType>, remult: Remult) => void))[]): (target: any, context: string | ClassFieldDecoratorContextStub<entityType, valueType | undefined>, c?: any) => void;
+    static json<entityType = any, valueType = any>(...options: (FieldOptions<entityType, valueType> | ((options: FieldOptions<entityType, valueType>, remult: Remult) => void))[]): (target: any, context: string | ClassFieldDecoratorContextStub<entityType, valueType | undefined>, c?: any) => void;
+    static dateOnly<entityType = any>(...options: (FieldOptions<entityType, Date> | ((options: FieldOptions<entityType, Date>, remult: Remult) => void))[]): (target: any, context: string | ClassFieldDecoratorContextStub<entityType, Date | undefined>, c?: any) => void;
+    static date<entityType = any>(...options: (FieldOptions<entityType, Date> | ((options: FieldOptions<entityType, Date>, remult: Remult) => void))[]): (target: any, context: string | ClassFieldDecoratorContextStub<entityType, Date | undefined>, c?: any) => void;
+    static integer<entityType = any>(...options: (FieldOptions<entityType, Number> | ((options: FieldOptions<entityType, Number>, remult: Remult) => void))[]): (target: any, context: string | ClassFieldDecoratorContextStub<entityType, number | undefined>, c?: any) => void;
+    static autoIncrement<entityType = any>(...options: (FieldOptions<entityType, Number> | ((options: FieldOptions<entityType, Number>, remult: Remult) => void))[]): (target: any, context: string | ClassFieldDecoratorContextStub<entityType, number | undefined>, c?: any) => void;
+    static number<entityType = any>(...options: (FieldOptions<entityType, Number> | ((options: FieldOptions<entityType, Number>, remult: Remult) => void))[]): (target: any, context: string | ClassFieldDecoratorContextStub<entityType, number | undefined>, c?: any) => void;
+    static createdAt<entityType = any>(...options: (FieldOptions<entityType, Date> | ((options: FieldOptions<entityType, Date>, remult: Remult) => void))[]): (target: any, context: string | ClassFieldDecoratorContextStub<entityType, Date | undefined>, c?: any) => void;
+    static updatedAt<entityType = any>(...options: (FieldOptions<entityType, Date> | ((options: FieldOptions<entityType, Date>, remult: Remult) => void))[]): (target: any, context: string | ClassFieldDecoratorContextStub<entityType, Date | undefined>, c?: any) => void;
+    static uuid<entityType = any>(...options: (FieldOptions<entityType, string> | ((options: FieldOptions<entityType, string>, remult: Remult) => void))[]): (target: any, context: string | ClassFieldDecoratorContextStub<entityType, string | undefined>, c?: any) => void;
+    static cuid<entityType = any>(...options: (FieldOptions<entityType, string> | ((options: FieldOptions<entityType, string>, remult: Remult) => void))[]): (target: any, context: string | ClassFieldDecoratorContextStub<entityType, string | undefined>, c?: any) => void;
+    static string<entityType = any>(...options: (StringFieldOptions<entityType> | ((options: StringFieldOptions<entityType>, remult: Remult) => void))[]): (target: any, context: string | ClassFieldDecoratorContextStub<entityType, string | undefined>, c?: any) => void;
+    static boolean<entityType = any>(...options: (FieldOptions<entityType, boolean> | ((options: FieldOptions<entityType, boolean>, remult: Remult) => void))[]): (target: any, context: string | ClassFieldDecoratorContextStub<entityType, boolean | undefined>, c?: any) => void;
+}
 export declare function isAutoIncrement(f: FieldMetadata): boolean;
+export interface StringFieldOptions<entityType = any> extends FieldOptions<entityType, string> {
+    maxLength?: number;
+}
 export declare function ValueListFieldType<valueType extends ValueListItem = any>(...options: (ValueListFieldOptions<any, valueType> | ((options: FieldOptions<any, valueType>, remult: Remult) => void))[]): (type: ClassType<valueType>, context?: any) => void;
 export interface ValueListFieldOptions<entityType, valueType> extends FieldOptions<entityType, valueType> {
     getValues?: () => valueType[];
@@ -261,9 +277,26 @@ export interface ClassDecoratorContextStub<Class extends new (...args: any) => a
     readonly name: string | undefined;
     addInitializer(initializer: (this: Class) => void): void;
 }
+/**Decorates fields that should be used as fields.
+ * for more info see: [Field Types](https://remult.dev/docs/field-types.html)
+ *
+ * FieldOptions can be set in two ways:
+ * @example
+ * // as an object
+ * @Fields.string({ includeInApi:false })
+ * title='';
+ * @example
+ * // as an arrow function that receives `remult` as a parameter
+ * @Fields.string((options,remult) => options.includeInApi = true)
+ * title='';
+ */
+export declare function Field<entityType = any, valueType = any>(valueType: () => ClassType<valueType>, ...options: (FieldOptions<entityType, valueType> | ((options: FieldOptions<entityType, valueType>, remult: Remult) => void))[]): (target: any, context: ClassFieldDecoratorContextStub<entityType, valueType | undefined> | string, c?: any) => void;
 export declare const storableMember: 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>;
+interface columnInfo {
+    key: string;
+    settings: (remult: Remult) => FieldOptions;
+}
 export declare class EntityBase {
     get _(): EntityRef<this>;
     save(): Promise<this>;
@@ -272,6 +305,9 @@ export declare class EntityBase {
     isNew(): boolean;
     get $(): FieldsRef<this>;
 }
+export declare class IdEntity extends EntityBase {
+    id: string;
+}
 export declare class ControllerBase {
     protected remult: Remult;
     constructor(remult?: Remult);
@@ -292,4 +328,5 @@ export declare function getEntityMetadata<entityType>(entity: EntityMetadataOver
 export declare function getRepository<entityType>(entity: RepositoryOverloads<entityType>): Repository<entityType>;
 export type EntityMetadataOverloads<entityType> = Repository<entityType> | EntityMetadata<entityType> | ClassType<entityType>;
 export type RepositoryOverloads<entityType> = Repository<entityType> | ClassType<entityType>;
+export declare function checkTarget(target: any): void;
 export {};