remult 0.25.8-exp.3 → 0.25.8-exp.5

package/esm/migrations/update-migrations-ts-file.js

@@ -1,5 +1,5 @@
 // consider replacing with https://www.npmjs.com/package/ts-morph
-import * as ts from 'typescript';
+import ts from 'typescript';
 import * as fs from 'fs';
 export async function updateMigrationsFile(filePath, steps) {
     let maxStep = -1;

package/esm/src/CompoundIdField.js

@@ -22,11 +22,17 @@ export class CompoundIdField {
         return Promise.resolve('');
     }
     getId(instance) {
+        let get = (field) => {
+            return instance[field.key];
+        };
+        if (typeof instance === 'function') {
+            get = instance;
+        }
         let r = '';
         this.fields.forEach((c) => {
             if (r.length > 0)
                 r += ',';
-            r += instance[c.key];
+            r += c.valueConverter.toJson(get(c));
         });
         return r;
     }
@@ -49,7 +55,7 @@ export class CompoundIdField {
         let val = value.toString();
         let id = val.split(',');
         this.fields.forEach((c, i) => {
-            result[c.key] = id[i];
+            result[c.key] = c.valueConverter.fromJson(id[i]);
         });
         return result;
     }

package/esm/src/data-api.js

@@ -23,16 +23,30 @@ export class DataApi {
     }
     async httpPost(res, req, body, serializeContext) {
         const action = req?.get('__action');
-        if (action?.startsWith(liveQueryAction))
+        function validateWhereInBody() {
+            if (!body?.where) {
+                throw {
+                    message: `POST with action ${action} must have a where clause in the body`,
+                    httpStatusCode: 400,
+                };
+            }
+        }
+        if (action?.startsWith(liveQueryAction)) {
+            validateWhereInBody();
             return this.liveQuery(res, req, body, serializeContext, action.substring(liveQueryAction.length));
+        }
         switch (action) {
             case 'get':
+                validateWhereInBody();
                 return this.getArray(res, req, body);
             case 'count':
+                validateWhereInBody();
                 return this.count(res, req, body);
             case 'deleteMany':
+                validateWhereInBody();
                 return this.deleteMany(res, req, body);
             case 'updateMany':
+                validateWhereInBody();
                 return this.updateManyImplementation(res, req, body);
             case 'endLiveQuery':
                 await this.remult.liveQueryStorage.remove(body.id);

package/esm/src/remult3/RepositoryImplementation.js

@@ -1186,7 +1186,7 @@ export class rowHelperImplementation extends rowHelperBase {
             return this.instance[y.key];
         };
         if (this.metadata.idMetadata.field instanceof CompoundIdField)
-            return this.metadata.idMetadata.field.fields.map(getVal).join(',');
+            return this.metadata.idMetadata.field.getId(getVal);
         return getVal(this.metadata.idMetadata.field);
     }
     saveMoreOriginalData() {

package/esm/src/remult3/remult3.js

@@ -1,7 +1,5 @@
 export {};
-//y1 - reconsider adding where to all in case of post - it is a breaking change and no longer required
-//y1 - review that with deleteMany, and updateMany I've taken a similar approach to get, that when the filter is complex, we go to post - one reason is that delete doesn't accept a body.
-//y1 - should the remult api be deleteMany({id:[1,2]}) or deleteMany({where:{id:[1,2]}})
+//p1 - should the remult api be deleteMany({id:[1,2]}) or deleteMany({where:{id:[1,2]}})
 //p1 - in this video I'll use remult to turn a frontend app to a fullstack app
 //y1 - getFields didn't work for kobi in the home component
 //y1 - consider replacing all errors with error classes that extend the base Error class

package/migrations/update-migrations-ts-file.js

@@ -3,13 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.updateMigrationsFile = void 0;
 var tslib_1 = require("tslib");
 // consider replacing with https://www.npmjs.com/package/ts-morph
-var ts = tslib_1.__importStar(require("typescript"));
+var typescript_1 = tslib_1.__importDefault(require("typescript"));
 var fs = tslib_1.__importStar(require("fs"));
 function updateMigrationsFile(filePath, steps) {
     return tslib_1.__awaiter(this, void 0, void 0, function () {
         function buildSteps() {
             return steps.map(function (step) {
-                return ts.factory.createPropertyAssignment(ts.factory.createIdentifier((++maxStep).toString()), ts.factory.createIdentifier(step));
+                return typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createIdentifier((++maxStep).toString()), typescript_1.default.factory.createIdentifier(step));
             });
         }
         var maxStep, importPath, importName, sourceFile, migrationsExportFound, updatedSourceFile, importFound_1, newMigrationsExport, code, prettier, err_1, options, err_2;
@@ -22,23 +22,23 @@ function updateMigrationsFile(filePath, steps) {
                     }
                     importPath = 'remult/migrations';
                     importName = 'Migrations';
-                    sourceFile = ts.createSourceFile(filePath, fs.readFileSync(filePath).toString(), ts.ScriptTarget.Latest, true);
+                    sourceFile = typescript_1.default.createSourceFile(filePath, fs.readFileSync(filePath).toString(), typescript_1.default.ScriptTarget.Latest, true);
                     migrationsExportFound = false;
-                    updatedSourceFile = ts.transform(sourceFile, [
+                    updatedSourceFile = typescript_1.default.transform(sourceFile, [
                         function (context) {
                             return function (node) {
                                 var visitor = function (node) {
-                                    if (ts.isVariableStatement(node) &&
+                                    if (typescript_1.default.isVariableStatement(node) &&
                                         node.declarationList.declarations.length > 0) {
                                         var declaration = node.declarationList.declarations[0];
-                                        if (ts.isIdentifier(declaration.name) &&
+                                        if (typescript_1.default.isIdentifier(declaration.name) &&
                                             declaration.name.text === 'migrations' &&
                                             declaration.initializer &&
-                                            ts.isObjectLiteralExpression(declaration.initializer)) {
+                                            typescript_1.default.isObjectLiteralExpression(declaration.initializer)) {
                                             migrationsExportFound = true;
                                             declaration.initializer.properties.forEach(function (property) {
-                                                if (ts.isPropertyAssignment(property)) {
-                                                    if (ts.isNumericLiteral(property.name)) {
+                                                if (typescript_1.default.isPropertyAssignment(property)) {
+                                                    if (typescript_1.default.isNumericLiteral(property.name)) {
                                                         var step = parseInt(property.name.text);
                                                         if (step > maxStep) {
                                                             maxStep = step;
@@ -49,18 +49,18 @@ function updateMigrationsFile(filePath, steps) {
                                             var steps_1 = buildSteps();
                                             // Found the "migrations" array
                                             // Update the initializer with the new steps
-                                            var updatedInitializer = ts.factory.updateObjectLiteralExpression(declaration.initializer, tslib_1.__spreadArray(tslib_1.__spreadArray([], tslib_1.__read(declaration.initializer.properties), false), tslib_1.__read(steps_1), false));
+                                            var updatedInitializer = typescript_1.default.factory.updateObjectLiteralExpression(declaration.initializer, tslib_1.__spreadArray(tslib_1.__spreadArray([], tslib_1.__read(declaration.initializer.properties), false), tslib_1.__read(steps_1), false));
                                             // Update the declaration with the new initializer
-                                            var updatedDeclaration = ts.factory.updateVariableDeclaration(declaration, declaration.name, undefined, declaration.type, // Preserve the original type annotation if present
+                                            var updatedDeclaration = typescript_1.default.factory.updateVariableDeclaration(declaration, declaration.name, undefined, declaration.type, // Preserve the original type annotation if present
                                             updatedInitializer);
-                                            return ts.factory.updateVariableStatement(node, node.modifiers, ts.factory.updateVariableDeclarationList(node.declarationList, [
+                                            return typescript_1.default.factory.updateVariableStatement(node, node.modifiers, typescript_1.default.factory.updateVariableDeclarationList(node.declarationList, [
                                                 updatedDeclaration,
                                             ]));
                                         }
                                     }
-                                    return ts.visitEachChild(node, visitor, context);
+                                    return typescript_1.default.visitEachChild(node, visitor, context);
                                 };
-                                return ts.visitNode(node, visitor);
+                                return typescript_1.default.visitNode(node, visitor);
                             };
                         },
                     ]).transformed[0];
@@ -69,11 +69,11 @@ function updateMigrationsFile(filePath, steps) {
                         // Check if the import statement already exists
                         sourceFile.statements.forEach(function (statement) {
                             var _a, _b;
-                            if (ts.isImportDeclaration(statement) &&
-                                ts.isStringLiteral(statement.moduleSpecifier) &&
+                            if (typescript_1.default.isImportDeclaration(statement) &&
+                                typescript_1.default.isStringLiteral(statement.moduleSpecifier) &&
                                 statement.moduleSpecifier.text === "".concat(importPath)) {
                                 (_b = (_a = statement.importClause) === null || _a === void 0 ? void 0 : _a.namedBindings) === null || _b === void 0 ? void 0 : _b.forEachChild(function (namedBinding) {
-                                    if (ts.isImportSpecifier(namedBinding) &&
+                                    if (typescript_1.default.isImportSpecifier(namedBinding) &&
                                         namedBinding.name.text === importName) {
                                         importFound_1 = true;
                                     }
@@ -82,20 +82,20 @@ function updateMigrationsFile(filePath, steps) {
                         });
                         // If the import statement doesn't exist, create it
                         if (!importFound_1) {
-                            updatedSourceFile = ts.factory.updateSourceFile(updatedSourceFile, tslib_1.__spreadArray([
-                                ts.factory.createExpressionStatement(ts.factory.createIdentifier("import type { ".concat(importName, " } from '").concat(importPath, "'")))
+                            updatedSourceFile = typescript_1.default.factory.updateSourceFile(updatedSourceFile, tslib_1.__spreadArray([
+                                typescript_1.default.factory.createExpressionStatement(typescript_1.default.factory.createIdentifier("import type { ".concat(importName, " } from '").concat(importPath, "'")))
                             ], tslib_1.__read(updatedSourceFile.statements), false));
                         }
-                        newMigrationsExport = ts.factory.createVariableStatement([ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)], ts.factory.createVariableDeclarationList([
-                            ts.factory.createVariableDeclaration('migrations', undefined, // You can add a type annotation here if needed
-                            ts.factory.createTypeReferenceNode(importName, undefined), ts.factory.createObjectLiteralExpression(buildSteps(), false)),
-                        ], ts.NodeFlags.Const));
+                        newMigrationsExport = typescript_1.default.factory.createVariableStatement([typescript_1.default.factory.createModifier(typescript_1.default.SyntaxKind.ExportKeyword)], typescript_1.default.factory.createVariableDeclarationList([
+                            typescript_1.default.factory.createVariableDeclaration('migrations', undefined, // You can add a type annotation here if needed
+                            typescript_1.default.factory.createTypeReferenceNode(importName, undefined), typescript_1.default.factory.createObjectLiteralExpression(buildSteps(), false)),
+                        ], typescript_1.default.NodeFlags.Const));
                         // Add the new export to the end of the file
-                        updatedSourceFile = ts.factory.updateSourceFile(updatedSourceFile, tslib_1.__spreadArray(tslib_1.__spreadArray([], tslib_1.__read(updatedSourceFile.statements), false), [
+                        updatedSourceFile = typescript_1.default.factory.updateSourceFile(updatedSourceFile, tslib_1.__spreadArray(tslib_1.__spreadArray([], tslib_1.__read(updatedSourceFile.statements), false), [
                             newMigrationsExport,
                         ], false));
                     }
-                    code = ts.createPrinter().printFile(updatedSourceFile);
+                    code = typescript_1.default.createPrinter().printFile(updatedSourceFile);
                     _a.label = 1;
                 case 1:
                     _a.trys.push([1, 9, , 10]);

package/package.json

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

package/src/CompoundIdField.js

@@ -28,11 +28,17 @@ var CompoundIdField = /** @class */ (function () {
         return Promise.resolve('');
     };
     CompoundIdField.prototype.getId = function (instance) {
+        var get = function (field) {
+            return instance[field.key];
+        };
+        if (typeof instance === 'function') {
+            get = instance;
+        }
         var r = '';
         this.fields.forEach(function (c) {
             if (r.length > 0)
                 r += ',';
-            r += instance[c.key];
+            r += c.valueConverter.toJson(get(c));
         });
         return r;
     };
@@ -48,7 +54,7 @@ var CompoundIdField = /** @class */ (function () {
         var val = value.toString();
         var id = val.split(',');
         this.fields.forEach(function (c, i) {
-            result[c.key] = id[i];
+            result[c.key] = c.valueConverter.fromJson(id[i]);
         });
         return result;
     };

package/src/data-api.js

@@ -25,13 +25,23 @@ var DataApi = /** @class */ (function () {
     };
     DataApi.prototype.httpPost = function (res, req, body, serializeContext) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
+            function validateWhereInBody() {
+                if (!(body === null || body === void 0 ? void 0 : body.where)) {
+                    throw {
+                        message: "POST with action ".concat(action, " must have a where clause in the body"),
+                        httpStatusCode: 400,
+                    };
+                }
+            }
             var action, _a;
             return tslib_1.__generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         action = req === null || req === void 0 ? void 0 : req.get('__action');
-                        if (action === null || action === void 0 ? void 0 : action.startsWith(rest_data_provider_js_1.liveQueryAction))
+                        if (action === null || action === void 0 ? void 0 : action.startsWith(rest_data_provider_js_1.liveQueryAction)) {
+                            validateWhereInBody();
                             return [2 /*return*/, this.liveQuery(res, req, body, serializeContext, action.substring(rest_data_provider_js_1.liveQueryAction.length))];
+                        }
                         _a = action;
                         switch (_a) {
                             case 'get': return [3 /*break*/, 1];
@@ -41,10 +51,18 @@ var DataApi = /** @class */ (function () {
                             case 'endLiveQuery': return [3 /*break*/, 5];
                         }
                         return [3 /*break*/, 7];
-                    case 1: return [2 /*return*/, this.getArray(res, req, body)];
-                    case 2: return [2 /*return*/, this.count(res, req, body)];
-                    case 3: return [2 /*return*/, this.deleteMany(res, req, body)];
-                    case 4: return [2 /*return*/, this.updateManyImplementation(res, req, body)];
+                    case 1:
+                        validateWhereInBody();
+                        return [2 /*return*/, this.getArray(res, req, body)];
+                    case 2:
+                        validateWhereInBody();
+                        return [2 /*return*/, this.count(res, req, body)];
+                    case 3:
+                        validateWhereInBody();
+                        return [2 /*return*/, this.deleteMany(res, req, body)];
+                    case 4:
+                        validateWhereInBody();
+                        return [2 /*return*/, this.updateManyImplementation(res, req, body)];
                     case 5: return [4 /*yield*/, this.remult.liveQueryStorage.remove(body.id)];
                     case 6:
                         _b.sent();

package/src/remult3/RepositoryImplementation.d.ts

@@ -4,7 +4,7 @@ import type { FieldMetadata, FieldOptions, ValueConverter, ValueListItem } from
 import { Remult } from '../context.js';
 import type { EntityOptions } from '../entity.js';
 import { Filter } from '../filter/filter-interfaces.js';
-import type { ControllerRef, ControllerRefForControllerBase, EntityFilter, EntityMetadata, EntityOrderBy, EntityRef, EntityRefForEntityBase, FieldRef, FieldsMetadata, FieldsRef, FieldsRefForEntityBase, FindFirstOptions, FindFirstOptionsBase, FindOptions, IdMetadata, LiveQuery, LoadOptions, MembersOnly, QueryOptions, QueryResult, Repository, RepositoryRelations, Subscribable } from './remult3.js';
+import type { ControllerRef, ControllerRefForControllerBase, EntityFilter, EntityMetadata, EntityOrderBy, EntityRef, EntityRefForEntityBase, FieldRef, FieldsMetadata, FieldsRef, FieldsRefForEntityBase, FindFirstOptions, FindFirstOptionsBase, FindOptions, IdMetadata, LiveQuery, LoadOptions, MembersOnly, QueryOptions, QueryResult, Repository, RepositoryRelations, Subscribable, idType } from './remult3.js';
 import type { RefSubscriber } from './remult3.js';
 import type { entityEventListener } from '../__EntityValueProvider.js';
 import type { DataProvider, EntityDataProvider, EntityDataProviderFindOptions, ErrorInfo } from '../data-interfaces.js';
@@ -41,22 +41,14 @@ export declare class RepositoryImplementation<entityType> implements Repository<
     addEventListener(listener: entityEventListener<entityType>): () => void;
     query(options?: QueryOptions<entityType>): QueryResult<entityType>;
     getEntityRef(entity: entityType): EntityRef<entityType>;
-    delete(id: entityType extends {
-        id?: number;
-    } ? number : entityType extends {
-        id?: string;
-    } ? string : string | number): Promise<void>;
+    delete(id: idType<entityType>): Promise<void>;
     delete(item: entityType): Promise<void>;
     insert(item: Partial<MembersOnly<entityType>>[]): Promise<entityType[]>;
     insert(item: Partial<MembersOnly<entityType>>): Promise<entityType>;
     get fields(): FieldsMetadata<entityType>;
     validate(entity: Partial<MembersOnly<entityType>>, ...fields: Extract<keyof MembersOnly<entityType>, string>[]): Promise<ErrorInfo<entityType> | undefined>;
     updateMany(where: EntityFilter<entityType>, set: Partial<MembersOnly<entityType>>): Promise<number>;
-    update(id: entityType extends {
-        id?: number;
-    } ? number : entityType extends {
-        id?: string;
-    } ? string : string | number, item: Partial<MembersOnly<entityType>>): Promise<entityType>;
+    update(id: idType<entityType>, item: Partial<MembersOnly<entityType>>): Promise<entityType>;
     update(originalItem: Partial<MembersOnly<entityType>>, item: Partial<MembersOnly<entityType>>): Promise<entityType>;
     private _getRefForExistingRow;
     save(item: Partial<MembersOnly<entityType>>[]): Promise<entityType[]>;

package/src/remult3/RepositoryImplementation.js

@@ -1956,7 +1956,7 @@ var rowHelperImplementation = /** @class */ (function (_super) {
             return _this.instance[y.key];
         };
         if (this.metadata.idMetadata.field instanceof CompoundIdField_js_1.CompoundIdField)
-            return this.metadata.idMetadata.field.fields.map(getVal).join(',');
+            return this.metadata.idMetadata.field.getId(getVal);
         return getVal(this.metadata.idMetadata.field);
     };
     rowHelperImplementation.prototype.saveMoreOriginalData = function () {

package/src/remult3/remult3.d.ts

@@ -239,10 +239,8 @@ export declare type MembersOnly<T> = {
     [K in keyof Omit<T, keyof EntityBase> as T[K] extends Function ? never : K]: T[K];
 };
 export declare type idType<entityType> = entityType extends {
-    id?: number;
-} ? number : entityType extends {
-    id?: string;
-} ? string : string | number;
+    id?: infer U;
+} ? U : string | number;
 /**used to perform CRUD operations on an `entityType` */
 export interface Repository<entityType> {
     /** returns a result array based on the provided options */
@@ -312,22 +310,14 @@ export interface Repository<entityType> {
      * @example
      * taskRepo.update(task.id,{...task,completed:true})
      */
-    update(id: entityType extends {
-        id?: number;
-    } ? number : entityType extends {
-        id?: string;
-    } ? string : string | number, item: Partial<MembersOnly<entityType>>): Promise<entityType>;
+    update(id: idType<entityType>, item: Partial<MembersOnly<entityType>>): Promise<entityType>;
     update(id: Partial<MembersOnly<entityType>>, item: Partial<MembersOnly<entityType>>): Promise<entityType>;
     /**
      * Updates all items that match the `where` condition.
      */
     updateMany(where: EntityFilter<entityType>, item: Partial<MembersOnly<entityType>>): Promise<number>;
     /** Deletes an Item*/
-    delete(id: entityType extends {
-        id?: number;
-    } ? number : entityType extends {
-        id?: string;
-    } ? string : string | number): Promise<void>;
+    delete(id: idType<entityType>): Promise<void>;
     delete(item: Partial<MembersOnly<entityType>>): Promise<void>;
     /**
      * Deletes all items that match the `where` condition.

package/src/remult3/remult3.js

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//y1 - reconsider adding where to all in case of post - it is a breaking change and no longer required
-//y1 - review that with deleteMany, and updateMany I've taken a similar approach to get, that when the filter is complex, we go to post - one reason is that delete doesn't accept a body.
-//y1 - should the remult api be deleteMany({id:[1,2]}) or deleteMany({where:{id:[1,2]}})
+//p1 - should the remult api be deleteMany({id:[1,2]}) or deleteMany({where:{id:[1,2]}})
 //p1 - in this video I'll use remult to turn a frontend app to a fullstack app
 //y1 - getFields didn't work for kobi in the home component
 //y1 - consider replacing all errors with error classes that extend the base Error class