remult 0.18.1 → 0.19.0-exp.2

package/live-query/data-provider-live-query-storage.js

@@ -14,17 +14,20 @@ var DataProviderLiveQueryStorage = /** @class */ (function () {
     }
     DataProviderLiveQueryStorage.prototype.ensureSchema = function () {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var _a, _b;
+            var dp, _a, _b;
             return tslib_1.__generator(this, function (_c) {
                 switch (_c.label) {
                     case 0: return [4 /*yield*/, this.dataProvider];
                     case 1:
-                        _b = (_a = (_c.sent())).ensureSchema;
+                        dp = _c.sent();
+                        if (!dp.ensureSchema) return [3 /*break*/, 4];
+                        _b = (_a = dp).ensureSchema;
                         return [4 /*yield*/, this.repo];
                     case 2: return [4 /*yield*/, _b.apply(_a, [[(_c.sent()).metadata]])];
                     case 3:
                         _c.sent();
-                        return [2 /*return*/];
+                        _c.label = 4;
+                    case 4: return [2 /*return*/];
                 }
             });
         });
@@ -58,9 +61,25 @@ var DataProviderLiveQueryStorage = /** @class */ (function () {
     };
     DataProviderLiveQueryStorage.prototype.remove = function (queryId) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var _this = this;
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.repo.then(function (repo) { return repo.delete(queryId); }).catch(function () { })];
+                    case 0: return [4 /*yield*/, this.repo.then(function (repo) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+                            var r;
+                            return tslib_1.__generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0: return [4 /*yield*/, repo.findId(queryId)];
+                                    case 1:
+                                        r = _a.sent();
+                                        if (!r) return [3 /*break*/, 3];
+                                        return [4 /*yield*/, repo.delete(r)];
+                                    case 2:
+                                        _a.sent();
+                                        _a.label = 3;
+                                    case 3: return [2 /*return*/];
+                                }
+                            });
+                        }); }).catch(function () { })];
                     case 1:
                         _a.sent();
                         return [2 /*return*/];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "0.18.1",
+    "version": "0.19.0-exp.2",
     "description": "A CRUD framework for full-stack TypeScript",
     "main": "index.js",
     "types": "index.d.ts",

package/src/column-interfaces.d.ts

@@ -1,6 +1,6 @@
 import { ClassType } from '../classType';
 import { Allowed, AllowedForInstance } from './context';
-import { EntityMetadata, FieldRef } from './remult3';
+import { EntityMetadata, FieldRef, OmitEB } from './remult3';
 export interface FieldOptions<entityType = any, valueType = any> {
     /** A human readable name for the field. Can be used to achieve a consistent caption for a field throughout the app
     * @example
@@ -75,7 +75,7 @@ export interface FieldOptions<entityType = any, valueType = any> {
     key?: string;
 }
 /**Metadata for a `Field`, this metadata can be used in the user interface to provide a richer UI experience */
-export interface FieldMetadata<valueType = any> {
+export interface FieldMetadata<valueType = any, entityType = any> {
     /** The field's member name in an object.
      * @example
      * const taskRepo = remult.repo(Task);
@@ -109,15 +109,38 @@ export interface FieldMetadata<valueType = any> {
     /** indicates that this field should only be included in select statement, and excluded from update or insert. useful for db generated ids etc... */
     readonly dbReadOnly: boolean;
     /** the Value converter for this field */
-    readonly valueConverter: ValueConverter<valueType>;
+    readonly valueConverter: Required<ValueConverter<valueType>>;
+    /** Get the display value for a specific item
+     * @example
+     * repo.fields.createDate.displayValue(task) //will display the date as defined in the `displayValue` option defined for it.
+    */
+    displayValue(item: Partial<OmitEB<entityType>>): string;
+    apiUpdateAllowed(item: Partial<OmitEB<entityType>>): boolean;
+    readonly includedInApi: boolean;
+    /** Adapts the value for usage with html input
+     * @example
+     * @Fields.dateOnly()
+     * birthDate = new Date(1976,5,16)
+     * //...
+     * input.value = repo.fields.birthDate.toInput(person) // will return '1976-06-16'
+     */
+    toInput(value: valueType, inputType?: string): string;
+    /** Adapts the value for usage with html input
+     * @example
+     * @Fields.dateOnly()
+     * birthDate = new Date(1976,5,16)
+     * //...
+     * person.birthDate = repo.fields.birthDate.fromInput(personFormState) // will return Date
+     */
+    fromInput(inputValue: string, inputType?: string): valueType;
 }
 export interface ValueConverter<valueType> {
     fromJson?(val: any): valueType;
     toJson?(val: valueType): any;
     fromDb?(val: any): valueType;
     toDb?(val: valueType): any;
-    toInput?(val: valueType, inputType: string): string;
-    fromInput?(val: string, inputType: string): valueType;
+    toInput?(val: valueType, inputType?: string): string;
+    fromInput?(val: string, inputType?: string): valueType;
     displayValue?(val: valueType): string;
     readonly fieldTypeInDb?: string;
     readonly inputType?: string;

package/src/column.d.ts

@@ -6,10 +6,15 @@ export declare function makeTitle(name: string): string;
 export declare class CompoundIdField implements FieldMetadata<string> {
     fields: FieldMetadata[];
     constructor(...columns: FieldMetadata[]);
+    apiUpdateAllowed(item: any): boolean;
+    displayValue(item: any): string;
+    includedInApi: boolean;
+    toInput(value: string, inputType?: string): string;
+    fromInput(inputValue: string, inputType?: string): string;
     getDbName(): Promise<string>;
     getId(instance: any): string;
     options: FieldOptions<any, any>;
-    get valueConverter(): ValueConverter<string>;
+    get valueConverter(): Required<ValueConverter<string>>;
     target: ClassType<any>;
     readonly: true;
     allowNull: boolean;

package/src/column.js

@@ -20,6 +20,18 @@ var CompoundIdField = /** @class */ (function () {
         }
         this.fields = columns;
     }
+    CompoundIdField.prototype.apiUpdateAllowed = function (item) {
+        throw new Error('Method not implemented.');
+    };
+    CompoundIdField.prototype.displayValue = function (item) {
+        throw new Error('Method not implemented.');
+    };
+    CompoundIdField.prototype.toInput = function (value, inputType) {
+        throw new Error('Method not implemented.');
+    };
+    CompoundIdField.prototype.fromInput = function (inputValue, inputType) {
+        throw new Error('Method not implemented.');
+    };
     CompoundIdField.prototype.getDbName = function () {
         return Promise.resolve("");
     };

package/src/data-api.js

@@ -6,7 +6,6 @@ var filter_interfaces_1 = require("./filter/filter-interfaces");
 var context_1 = require("./context");
 var filter_interfaces_2 = require("./filter/filter-interfaces");
 var server_action_1 = require("./server-action");
-var getId_1 = require("./remult3/getId");
 var rest_data_provider_1 = require("./data-providers/rest-data-provider");
 var DataApi = /** @class */ (function () {
     function DataApi(repository, remult) {
@@ -228,7 +227,7 @@ var DataApi = /** @class */ (function () {
                         data = {
                             requestJson: serializeRequest(),
                             findOptionsJson: rest_data_provider_1.findOptionsToJson(r.findOptions, this.repository.metadata),
-                            lastIds: r.r.map(function (y) { return getId_1.getId(_this.repository.metadata, y); })
+                            lastIds: r.r.map(function (y) { return _this.repository.metadata.idMetadata.getId(y); })
                         };
                         return [4 /*yield*/, this.remult.liveQueryStorage.add({
                                 entityKey: this.repository.metadata.key,

package/src/entity.d.ts

@@ -1,5 +1,5 @@
 import { Allowed, AllowedForInstance } from "./context";
-import { FieldMetadata as FieldMetadata } from './column-interfaces';
+import { FieldMetadata } from './column-interfaces';
 import { EntityOrderBy, FieldsMetadata, EntityFilter, EntityRef, EntityMetadata } from "./remult3";
 export interface EntityOptions<entityType = any> {
     /**A human readable name for the entity */

package/src/live-query/SubscriptionChannel.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SubscriptionChannel = exports.liveQueryKeepAliveRoute = exports.LiveQuerySubscriber = exports.streamUrl = void 0;
 var tslib_1 = require("tslib");
 var index_1 = require("../../index");
-var getId_1 = require("../remult3/getId");
 var uuid_1 = require("uuid");
 var data_api_1 = require("../data-api");
 exports.streamUrl = 'stream';
@@ -115,15 +114,15 @@ var LiveQuerySubscriber = /** @class */ (function () {
                                             _this.setAllItems(message.data);
                                             break;
                                         case "replace": {
-                                            items = items.map(function (x) { return getId_1.getId(_this.repo.metadata, x) === message.data.oldId ? message.data.item : x; });
+                                            items = items.map(function (x) { return _this.repo.metadata.idMetadata.getId(x) === message.data.oldId ? message.data.item : x; });
                                             break;
                                         }
                                         case "add":
-                                            items = items.filter(function (x) { return getId_1.getId(_this.repo.metadata, x) !== getId_1.getId(_this.repo.metadata, message.data.item); });
+                                            items = items.filter(function (x) { return _this.repo.metadata.idMetadata.getId(x) !== _this.repo.metadata.idMetadata.getId(message.data.item); });
                                             items.push(message.data.item);
                                             break;
                                         case "remove":
-                                            items = items.filter(function (x) { return getId_1.getId(_this.repo.metadata, x) !== message.data.id; });
+                                            items = items.filter(function (x) { return _this.repo.metadata.idMetadata.getId(x) !== message.data.id; });
                                             break;
                                     }
                                     ;

package/src/remult-proxy.js

@@ -16,6 +16,18 @@ var RemultProxy = /** @class */ (function () {
             }
             var self = _this;
             return {
+                get fields() {
+                    var _a;
+                    return (_a = self.remultFactory()).repo.apply(_a, tslib_1.__spread(args)).metadata.fields;
+                },
+                validate: function () {
+                    var _a, _b;
+                    var args2 = [];
+                    for (var _i = 0; _i < arguments.length; _i++) {
+                        args2[_i] = arguments[_i];
+                    }
+                    return (_a = (_b = self.remultFactory()).repo.apply(_b, tslib_1.__spread(args))).validate.apply(_a, tslib_1.__spread(args2));
+                },
                 addEventListener: function () {
                     var _a, _b;
                     var args2 = [];

package/src/remult3/RepositoryImplementation.d.ts

@@ -5,7 +5,7 @@ import { EntityMetadata, FieldRef, FieldsRef, EntityFilter, FindOptions, Reposit
 import { ClassType } from "../../classType";
 import { Remult } from "../context";
 import { entityEventListener } from "../__EntityValueProvider";
-import { DataProvider, EntityDataProvider, EntityDataProviderFindOptions } from "../data-interfaces";
+import { DataProvider, EntityDataProvider, EntityDataProviderFindOptions, ErrorInfo } from "../data-interfaces";
 import { RefSubscriber } from ".";
 import { Unsubscribe } from "../live-query/SubscriptionChannel";
 export declare class RepositoryImplementation<entityType> implements Repository<entityType> {
@@ -34,6 +34,8 @@ export declare class RepositoryImplementation<entityType> implements Repository<
     delete(item: entityType): Promise<void>;
     insert(item: Partial<OmitEB<entityType>>[]): Promise<entityType[]>;
     insert(item: Partial<OmitEB<entityType>>): Promise<entityType>;
+    get fields(): FieldsMetadata<entityType>;
+    validate(entity: Partial<OmitEB<entityType>>, ...fields: (Extract<keyof OmitEB<entityType>, string>)[]): Promise<ErrorInfo<entityType> | undefined>;
     update(id: (entityType extends {
         id?: number;
     } ? number : entityType extends {
@@ -54,6 +56,7 @@ export declare class RepositoryImplementation<entityType> implements Repository<
     findFirst(where?: EntityFilter<entityType>, options?: FindFirstOptions<entityType>, skipOrderByAndLimit?: boolean): Promise<entityType>;
     private fieldsOf;
     create(item?: Partial<OmitEB<entityType>>): entityType;
+    fixTypes(item: any): Promise<any>;
     findId(id: any, options?: FindFirstOptionsBase<entityType>): Promise<entityType>;
 }
 export declare function __updateEntityBasedOnWhere<T>(entityDefs: EntityMetadata<T>, where: EntityFilter<T>, r: T): void;
@@ -84,6 +87,7 @@ declare abstract class rowHelperBase<T> {
         [key: string]: string;
     };
     protected __assertValidity(): void;
+    buildErrorInfoObject(): ErrorInfo<any>;
     abstract get fields(): FieldsRef<T>;
     catchSaveErrors(err: any): any;
     __clearErrorsAndReportChanged(): void;
@@ -93,7 +97,7 @@ declare abstract class rowHelperBase<T> {
     originalValues: any;
     saveOriginalData(): void;
     saveMoreOriginalData(): void;
-    validate(): Promise<boolean>;
+    validate(): Promise<ErrorInfo<any>>;
     __validateEntity(): Promise<void>;
     __performColumnAndEntityValidations(): Promise<void>;
     toApiJson(): any;
@@ -180,12 +184,18 @@ export declare function buildCaption(caption: string | ((remult: Remult) => stri
 export declare class columnDefsImpl implements FieldMetadata {
     private settings;
     private entityDefs;
+    private remult;
     constructor(settings: FieldOptions, entityDefs: EntityFullInfo<any>, remult: Remult);
+    apiUpdateAllowed(item: any): boolean;
+    displayValue(item: any): string;
+    get includedInApi(): boolean;
+    toInput(value: any, inputType?: string): string;
+    fromInput(inputValue: string, inputType?: string): any;
     getDbName(): Promise<string>;
     options: FieldOptions<any, any>;
     target: ClassType<any>;
     readonly: boolean;
-    valueConverter: ValueConverter<any>;
+    valueConverter: Required<ValueConverter<any>>;
     allowNull: boolean;
     caption: string;
     get dbName(): any;
@@ -203,10 +213,10 @@ declare class EntityFullInfo<T> implements EntityMetadata<T> {
     readonly key: string;
     options: EntityOptions<any>;
     constructor(columnsInfo: FieldOptions[], entityInfo: EntityOptions, remult: Remult, entityType: ClassType<T>, key: string);
-    get apiUpdateAllowed(): boolean;
+    apiUpdateAllowed(item: T): boolean;
     get apiReadAllowed(): boolean;
-    get apiDeleteAllowed(): boolean;
-    get apiInsertAllowed(): boolean;
+    apiDeleteAllowed(item: T): boolean;
+    apiInsertAllowed(item: T): boolean;
     dbNamePromise: Promise<string>;
     getDbName(): Promise<string>;
     idMetadata: IdMetadata<T>;