remult 0.13.21 → 0.13.24

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "remult",
-    "version": "0.13.21",
-    "description": "remult core lib",
+    "version": "0.13.24",
+    "description": "A CRUD framework for full-stack TypeScript",
     "homepage": "https://remult.dev/",
     "repository": {
         "type": "git",
@@ -13,7 +13,6 @@
     },
     "dependencies": {
         "uuid": "^8.3.2",
-        "body-parser": "^1.18.3",
         "reflect-metadata": "^0.1.13",
         "tslib": "^2.3.1"
     }

package/readme.md

@@ -4,7 +4,7 @@
   </a>
   <h1>Remult</h1>
 	<a href="https://circleci.com/gh/remult/remult/tree/master">
-		<img alt="CircleCI" src="https://circleci.com/gh/remult/remult/tree/master.svg?style=svg">
+		<img alt="CircleCI" src="https://circleci.com/gh/remult/remult/tree/master.svg?style=shield">
 	</a>
 	<a href="https://codecov.io/gh/remult/remult">
         	<img src="https://codecov.io/gh/remult/remult/branch/master/graph/badge.svg?token=LYWQRUN3D1"/>
@@ -18,33 +18,36 @@
 	<a href="https://www.npmjs.com/package/remult">
 		<img alt="npm downloads" src="https://img.shields.io/npm/dm/remult">
 	</a>
-	<a href="https://snyk.io/test/npm/remult">
-		<img alt="snyk" src="https://snyk.io/test/npm/remult/badge.svg"/>
-		</a>
-	<a href="https://github.com/remult/remult/pulse" alt="Activity">
-        <img src="https://img.shields.io/github/commit-activity/m/remult/remult" /></a>
+	<a href="https://discord.gg/GXHk7ZfuG5">
+		<img alt="chat on discord" src="https://img.shields.io/badge/chat-on%20discord-blueviolet"/>
+	</a>
 </div>
 
 ## What is Remult?
 
-**Remult** is a fullstack CRUD framework that uses your TypeScript model types to provide:
+**Remult** is a full-stack CRUD framework that uses your TypeScript model types to provide:
 
 * Secure REST API (highly configurable)
 * Type-safe frontend API client
 * Type-safe backend query builder
 
-#### Remult :heart: Monorepos
+#### Remult :heart: Code Sharing
 
-Using a `monorepo` approach, with model types shared between frontend and backend code, Remult can enforce data validation and constraints, defined once, on both frontend and REST API levels.
+With model types shared between frontend and backend code, Remult can **enforce data validation and constraints, defined once, both in the front-end and witin back-end API routes**.
 
 ## Getting started
-The best way to learn Remult is by following a tutorial of a simple Todo app with a Node.js Express backend. There's one [using a React frontend](https://remult.dev/tutorials/tutorial-react.html) and one [using Angular](https://remult.dev/tutorials/tutorial-angular.html).
+The best way to learn Remult is by following a tutorial of a simple Todo web app with a Node.js Express backend. 
+
+* [Tutorial with React](https://remult.dev/tutorials/react/) 
+* [Tutorial with Angular](https://remult.dev/tutorials/angular/)
 
 ## Installation
 ```sh
 npm i remult
 ```
 
+## Usage
+
 ### Setup API backend using a Node.js Express middleware
 ```ts
 import express from 'express';
@@ -60,14 +63,14 @@ app.listen(port, () => {
 });
 ```
 
-## Define model classes
+### Define model classes
 ```ts
-import { Entity, EntityBase, Fields } from 'remult';
+import { Entity, Fields } from 'remult';
 
 @Entity('products', {
     allowApiCrud: true
 })
-export class Product extends EntityBase {
+export class Product {
   @Fields.string()
   name = '';
 
@@ -83,13 +86,14 @@ export class Product extends EntityBase {
 [{"name":"Tofu","unitPrice":5}]
 ```
 
-## Find and manipulate data in type-safe frontend code
+### Find and manipulate data in type-safe frontend code
 ```ts
 async function increasePriceOfTofu(priceIncrease: number) {
-  const product = await remult.repo(Product).findFirst({ name: 'Tofu' });
+  const productsRepo = remult.repo(Product);
 
+  const product = await productsRepo.findFirst({ name: 'Tofu' });
   product.unitPrice += priceIncrease;
-  product.save();
+  productsRepo.save(product);
 }
 ```
 
@@ -97,26 +101,27 @@ async function increasePriceOfTofu(priceIncrease: number) {
 ```ts
 @BackendMethod({ allowed: Allow.authenticated })
 static async increasePriceOfTofu(priceIncrease: number, remult?: Remult) {
-  const product = await remult!.repo(Product).findFirst({ name: 'Tofu' });
+  const productsRepo = remult!.repo(Product);
 
+  const product = await productsRepo.findFirst({ name: 'Tofu' });
   product.unitPrice += priceIncrease;
-  product.save();
+  productsRepo.save(product);
 }
 ```
 
-## :ballot_box_with_check: Data validation and constraints - defined once
+### :ballot_box_with_check: Data validation and constraints - defined once
 
 ```ts
-import { Entity, EntityBase, Fields } from 'remult';
+import { Entity, Fields } from 'remult';
 
 @Entity('products', {
     allowApiCrud: true
 })
-export class Product extends EntityBase {
+export class Product {
     @Fields.string<Product>({
         validate: product => {
             if (product.name.trim().length == 0)
-                product.$.name.error = 'required';
+                throw 'required';
         }
     })
     name = '';
@@ -124,7 +129,7 @@ export class Product extends EntityBase {
     @Fields.number({
         validate: (_, field) => {
             if (field.value < 0)
-                field.error = "must not be less than 0";
+                throw "must not be less than 0";
         }
     })
     unitPrice = 0;
@@ -133,31 +138,31 @@ export class Product extends EntityBase {
 
 ### Enforced in frontend:
 ```ts
-const product = remult.repo(Product).create();
+const product = productsRepo.create();
 
 try {
-  await product.save();
+  await productsRepo.save(product);
 }
-catch {
-  console.error(product._.error); // Browser console will display - "Name: required"
+catch (e: any) {
+  console.error(e.message); // Browser console will display - "Name: required"
 }
 ```
 
 ### Enforced in backend:
 ```sh
-> curl -d "{""unitPrice"":-1}" -H "Content-Type: application/json" -X POST http://localhost:3001/api/products
+> curl http://localhost:3001/api/products -H "Content-Type: application/json" -d "{""unitPrice"":-1}"
 
 {"modelState":{"unitPrice":"must not be less than 0","name":"required"},"message":"Name: required"}
 ```
 
-## :lock: Secure the API with fine-grained authorization
+### :lock: Secure the API with fine-grained authorization
 ```ts
 @Entity<Article>('Articles', {
     allowApiRead: true,
     allowApiInsert: remult => remult.authenticated(),
     allowApiUpdate: (remult, article) => article.author.id == remult.user.id
 })
-export class Article extends EntityBase {
+export class Article {
     @Fields.string({ allowApiUpdate: false })
     slug = '';
     
@@ -168,3 +173,13 @@ export class Article extends EntityBase {
     content = '';
 }
 ```
+
+## Example App
+
+[CRM demo](https://github.com/remult/crm-demo) with a React + [MUI](https://mui.com) front-end and Postgres database.
+
+## Contributing
+Contributions are welcome. See [CONTRIBUTING](CONTRIBUTING.md).
+
+## License
+Remult is [MIT Licensed](LICENSE).

package/server/expressBridge.d.ts

@@ -6,10 +6,10 @@ import { DataApi, DataApiRequest, DataApiResponse } from '../src/data-api';
 import { AllowedForInstance } from '../src/context';
 import { ClassType } from '../classType';
 export declare function remultExpress(options?: {
-    /** Determines the Data Provider
-  
-  * @see  [Optional Databases](https://remult.dev/docs/databases.html)
-  */
+    /** Sets a database connection for Remult.
+     *
+     * @see [Connecting to a Database](https://remult.dev/docs/databases.html).
+    */
     dataProvider?: DataProvider | Promise<DataProvider> | (() => Promise<DataProvider | undefined>);
     bodySizeLimit?: string;
     disableAutoApi?: boolean;
@@ -20,6 +20,7 @@ export declare function remultExpress(options?: {
     defaultGetLimit?: number;
     entities?: ClassType<any>[];
     controllers?: ClassType<any>[];
+    bodyParser?: boolean;
 }): RemultExpressBridge;
 export interface RemultExpressBridge extends express.RequestHandler {
     getRemult(req: express.Request): Promise<Remult>;

package/server/expressBridge.js

@@ -4,7 +4,6 @@ exports.JobsInQueueEntity = exports.EntityQueueStorage = exports.ExpressRequestB
 var tslib_1 = require("tslib");
 var __1 = require("../");
 var express = require("express");
-var bodyParser = require("body-parser");
 var register_actions_on_server_1 = require("./register-actions-on-server");
 var register_entities_on_server_1 = require("./register-entities-on-server");
 var JsonEntityFileStorage_1 = require("./JsonEntityFileStorage");
@@ -29,8 +28,10 @@ function remultExpress(options) {
     if (!options.queueStorage) {
         options.queueStorage = new InMemoryQueueStorage();
     }
-    app.use(bodyParser.json({ limit: options.bodySizeLimit }));
-    app.use(bodyParser.urlencoded({ extended: true, limit: options.bodySizeLimit }));
+    if ((options === null || options === void 0 ? void 0 : options.bodyParser) !== false) {
+        app.use(express.json({ limit: options.bodySizeLimit }));
+        app.use(express.urlencoded({ extended: true, limit: options.bodySizeLimit }));
+    }
     var dataProvider;
     if (typeof options.dataProvider === "function") {
         dataProvider = options.dataProvider();
@@ -62,8 +63,13 @@ function remultExpress(options) {
         bridge.logApiEndPoints = options.logApiEndPoints;
     var apiArea = bridge.addArea(__1.Remult.apiBaseUrl);
     if (!options.disableAutoApi) {
-        register_actions_on_server_1.registerActionsOnServer(apiArea);
-        register_entities_on_server_1.registerEntitiesOnServer(apiArea);
+        var actions = [];
+        if (options.entities)
+            actions.push.apply(actions, tslib_1.__spread(options.entities));
+        if (options.controllers)
+            actions.push.apply(actions, tslib_1.__spread(options.controllers));
+        register_actions_on_server_1.registerActionsOnServer(apiArea, actions);
+        register_entities_on_server_1.registerEntitiesOnServer(apiArea, options.entities);
     }
     return Object.assign(app, {
         getRemult: function (req) { return bridge.getRemult(req); },

package/server/register-actions-on-server.d.ts

@@ -1,2 +1,3 @@
 import { SiteArea } from "./expressBridge";
-export declare function registerActionsOnServer(area: SiteArea): void;
+import { ClassType } from "../classType";
+export declare function registerActionsOnServer(area: SiteArea, controllers?: ClassType<any>[]): void;

package/server/register-actions-on-server.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerActionsOnServer = void 0;
+var tslib_1 = require("tslib");
 var server_action_1 = require("../src/server-action");
-function registerActionsOnServer(area) {
+function registerActionsOnServer(area, controllers) {
+    var e_1, _a, e_2, _b;
     var addAction = function (a) {
         var x = a[server_action_1.serverActionField];
         if (!x) {
@@ -11,8 +13,38 @@ function registerActionsOnServer(area) {
         area.addAction(x);
     };
     server_action_1.actionInfo.runningOnServer = true;
-    server_action_1.actionInfo.allActions.forEach(function (a) {
-        addAction(a);
-    });
+    if (controllers && controllers.length > 0) {
+        try {
+            for (var controllers_1 = tslib_1.__values(controllers), controllers_1_1 = controllers_1.next(); !controllers_1_1.done; controllers_1_1 = controllers_1.next()) {
+                var c = controllers_1_1.value;
+                var z = c[server_action_1.classBackendMethodsArray];
+                if (z)
+                    try {
+                        for (var z_1 = (e_2 = void 0, tslib_1.__values(z)), z_1_1 = z_1.next(); !z_1_1.done; z_1_1 = z_1.next()) {
+                            var a = z_1_1.value;
+                            addAction(a);
+                        }
+                    }
+                    catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                    finally {
+                        try {
+                            if (z_1_1 && !z_1_1.done && (_b = z_1.return)) _b.call(z_1);
+                        }
+                        finally { if (e_2) throw e_2.error; }
+                    }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (controllers_1_1 && !controllers_1_1.done && (_a = controllers_1.return)) _a.call(controllers_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    }
+    else
+        server_action_1.actionInfo.allActions.forEach(function (a) {
+            addAction(a);
+        });
 }
 exports.registerActionsOnServer = registerActionsOnServer;

package/server/register-entities-on-server.d.ts

@@ -1,2 +1,3 @@
 import { SiteArea } from "./expressBridge";
-export declare function registerEntitiesOnServer(area: SiteArea): void;
+import { ClassType } from "../classType";
+export declare function registerEntitiesOnServer(area: SiteArea, entities?: ClassType<any>[]): void;

package/server/register-entities-on-server.js

@@ -4,9 +4,11 @@ exports.registerEntitiesOnServer = void 0;
 var remult3_1 = require("../src/remult3");
 var context_1 = require("../src/context");
 var data_api_1 = require("../src/data-api");
-function registerEntitiesOnServer(area) {
+function registerEntitiesOnServer(area, entities) {
+    if (!entities)
+        entities = context_1.allEntities;
     //add Api Entries
-    context_1.allEntities.forEach(function (e) {
+    entities.forEach(function (e) {
         var key = remult3_1.getEntityKey(e);
         if (key != undefined)
             area.add(key, function (c) {

package/src/data-providers/web-sql-data-provider.d.ts

@@ -6,7 +6,7 @@ export declare class WebSqlDataProvider implements SqlImplementation, __RowsOfDa
     rows: {
         [tableName: string]: any;
     };
-    constructor(databaseName: string);
+    constructor(databaseName: string, databaseSize?: number);
     getLimitSqlSyntax(limit: number, offset: number): string;
     entityIsUsedForTheFirstTime(entity: EntityMetadata): Promise<void>;
     dropTable(entity: EntityMetadata): Promise<void>;

package/src/data-providers/web-sql-data-provider.js

@@ -7,10 +7,11 @@ var sql_database_1 = require("./sql-database");
 var filter_consumer_bridge_to_sql_request_1 = require("../filter/filter-consumer-bridge-to-sql-request");
 //SqlDatabase.LogToConsole = true;
 var WebSqlDataProvider = /** @class */ (function () {
-    function WebSqlDataProvider(databaseName) {
+    function WebSqlDataProvider(databaseName, databaseSize) {
+        if (databaseSize === void 0) { databaseSize = 2 * 1024 * 1024; }
         this.databaseName = databaseName;
         //@ts-ignore
-        this.db = window.openDatabase(databaseName, '1.0', databaseName, 2 * 1024 * 1024);
+        this.db = window.openDatabase(databaseName, '1.0', databaseName, databaseSize);
     }
     WebSqlDataProvider.prototype.getLimitSqlSyntax = function (limit, offset) {
         return ' limit ' + limit + ' offset ' + offset;

package/src/remult3/RepositoryImplementation.d.ts

@@ -224,7 +224,7 @@ export declare function isAutoIncrement(f: FieldMetadata): boolean;
 export interface StringFieldOptions<entityType = any> extends FieldOptions<entityType, string> {
     maxLength?: number;
 }
-export declare function ValueListFieldType<entityType = any, valueType extends ValueListItem = any>(...options: (ValueListFieldOptions<entityType, valueType> | ((options: FieldOptions<entityType, valueType>, remult: Remult) => void))[]): (type: ClassType<valueType>) => void;
+export declare function ValueListFieldType<valueType extends ValueListItem = any>(...options: (ValueListFieldOptions<any, valueType> | ((options: FieldOptions<any, valueType>, remult: Remult) => void))[]): (type: ClassType<valueType>) => void;
 export interface ValueListFieldOptions<entityType, valueType> extends FieldOptions<entityType, valueType> {
     getValues?: () => valueType[];
 }

package/src/remult3/remult3.d.ts

@@ -82,7 +82,7 @@ export interface FieldRef<entityType = any, valueType = any> extends Subscribabl
     valueChanged(): boolean;
     entityRef: EntityRef<entityType>;
     container: entityType;
-    metadata: FieldMetadata<entityType>;
+    metadata: FieldMetadata<valueType>;
     load(): Promise<valueType>;
     valueIsNull(): boolean;
     originalValueIsNull(): boolean;
@@ -245,7 +245,7 @@ export interface FindOptionsBase<entityType> extends LoadOptions<entityType> {
     /** filters the data
     * @example
     * await taskRepo.find({where: { completed:false }})
-    * @see For more usage examples see [EntityFilter](https://remult.github.io/guide/entityFilter.html)
+    * @see For more usage examples see [EntityFilter](https://remult.dev/docs/entityFilter.html)
     */
     where?: EntityFilter<entityType>;
     /** Determines the order of items returned .

package/src/server-action.d.ts

@@ -66,4 +66,5 @@ export declare class ProgressListener {
 }
 export declare function prepareArgsToSend(types: any[], args: any[]): any[];
 export declare function prepareReceivedArgs(types: any[], args: any[], remult: Remult, ds: DataProvider, res: DataApiResponse): Promise<any[]>;
+export declare const classBackendMethodsArray: unique symbol;
 export {};

package/src/server-action.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.prepareReceivedArgs = exports.prepareArgsToSend = exports.ProgressListener = exports.BackendMethod = exports.Controller = exports.serverActionField = exports.actionInfo = exports.myServerAction = exports.Action = void 0;
+exports.classBackendMethodsArray = exports.prepareReceivedArgs = exports.prepareArgsToSend = exports.ProgressListener = exports.BackendMethod = exports.Controller = exports.serverActionField = exports.actionInfo = exports.myServerAction = exports.Action = void 0;
 var tslib_1 = require("tslib");
 require("reflect-metadata");
 var context_1 = require("./context");
@@ -216,7 +216,7 @@ function BackendMethod(options) {
                     });
                 });
             };
-            exports.actionInfo.allActions.push(descriptor.value);
+            registerAction(target, descriptor);
             descriptor.value[exports.serverActionField] = serverAction_1;
             return descriptor;
         }
@@ -479,7 +479,7 @@ function BackendMethod(options) {
                 });
             });
         };
-        exports.actionInfo.allActions.push(descriptor.value);
+        registerAction(target.constructor, descriptor);
         descriptor.value[exports.serverActionField] = serverAction;
         return descriptor;
     };
@@ -488,6 +488,10 @@ exports.BackendMethod = BackendMethod;
 var customUndefined = {
     _isUndefined: true
 };
+function registerAction(target, descriptor) {
+    (target[exports.classBackendMethodsArray] || (target[exports.classBackendMethodsArray] = [])).push(descriptor.value);
+    exports.actionInfo.allActions.push(descriptor.value);
+}
 function isCustomUndefined(x) {
     return x && x._isUndefined;
 }
@@ -592,3 +596,4 @@ function prepareReceivedArgs(types, args, remult, ds, res) {
     });
 }
 exports.prepareReceivedArgs = prepareReceivedArgs;
+exports.classBackendMethodsArray = Symbol('classBackendMethodsArray');