remult 0.9.25 → 0.9.29

package/index.d.ts

@@ -1,4 +1,4 @@
-export { Field, UUIDField, FieldsMetadata, Entity, EntityBase, ControllerBase, FieldRef, Fields, EntityMetadata, EntityOrderBy, EntityFilter, FindOptions, QueryResult, QueryOptions, Repository, FieldType, FindFirstOptions, ComparisonValueFilter, ValueFilter, ContainsStringValueFilter, getFields, EntityRef, getEntityRef, SortSegments, ValueListFieldType, DateOnlyField, JsonField, IntegerField, OmitEB, Paginator, CaptionTransformer } from './src/remult3';
+export { Field, UuidField, FieldsMetadata, Entity, EntityBase, ControllerBase, FieldRef, Fields, EntityMetadata, EntityOrderBy, EntityFilter, FindOptions, QueryResult, QueryOptions, Repository, FieldType, FindFirstOptions, ComparisonValueFilter, ValueFilter, ContainsStringValueFilter, getFields, EntityRef, getEntityRef, SortSegments, ValueListFieldType, DateOnlyField, JsonField, IntegerField, OmitEB, Paginator, CaptionTransformer } from './src/remult3';
 export { EntityOptions } from './src/entity';
 export { DataProvider, EntityDataProvider, EntityDataProviderFindOptions, ErrorInfo, RestDataProviderHttpProvider } from './src/data-interfaces';
 export { SqlCommand, SqlImplementation, SqlResult } from './src/sql-command';

package/index.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Validators = exports.UrlBuilder = exports.FilterConsumerBridgeToSqlRequest = exports.Filter = exports.CompoundIdField = exports.OneToMany = exports.Sort = exports.IdEntity = exports.EventSource = exports.isBackend = exports.Remult = exports.Allow = exports.ProgressListener = exports.BackendMethod = exports.Controller = exports.JsonDataProvider = exports.SqlDatabase = exports.WebSqlDataProvider = exports.ArrayEntityDataProvider = exports.InMemoryDataProvider = exports.RestDataProvider = exports.CaptionTransformer = exports.IntegerField = exports.JsonField = exports.DateOnlyField = exports.ValueListFieldType = exports.getEntityRef = exports.getFields = exports.FieldType = exports.ControllerBase = exports.EntityBase = exports.Entity = exports.UUIDField = exports.Field = void 0;
+exports.Validators = exports.UrlBuilder = exports.FilterConsumerBridgeToSqlRequest = exports.Filter = exports.CompoundIdField = exports.OneToMany = exports.Sort = exports.IdEntity = exports.EventSource = exports.isBackend = exports.Remult = exports.Allow = exports.ProgressListener = exports.BackendMethod = exports.Controller = exports.JsonDataProvider = exports.SqlDatabase = exports.WebSqlDataProvider = exports.ArrayEntityDataProvider = exports.InMemoryDataProvider = exports.RestDataProvider = exports.CaptionTransformer = exports.IntegerField = exports.JsonField = exports.DateOnlyField = exports.ValueListFieldType = exports.getEntityRef = exports.getFields = exports.FieldType = exports.ControllerBase = exports.EntityBase = exports.Entity = exports.UuidField = exports.Field = void 0;
 /*
  * Public API Surface of remult
  */
 var remult3_1 = require("./src/remult3");
 Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return remult3_1.Field; } });
-Object.defineProperty(exports, "UUIDField", { enumerable: true, get: function () { return remult3_1.UUIDField; } });
+Object.defineProperty(exports, "UuidField", { enumerable: true, get: function () { return remult3_1.UuidField; } });
 Object.defineProperty(exports, "Entity", { enumerable: true, get: function () { return remult3_1.Entity; } });
 Object.defineProperty(exports, "EntityBase", { enumerable: true, get: function () { return remult3_1.EntityBase; } });
 Object.defineProperty(exports, "ControllerBase", { enumerable: true, get: function () { return remult3_1.ControllerBase; } });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "0.9.25",
+    "version": "0.9.29",
     "description": "remult core lib",
     "homepage": "https://remult.dev/",
     "repository": {

package/readme.md

@@ -1,13 +1,44 @@
 # Remult
 ![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg) [![npm version](https://badge.fury.io/js/remult.svg)](https://badge.fury.io/js/remult)
 
-Remult is an unopinionated CRUD framework for fullstack TypeScript development.
+## What is Remult?
 
-### Define Entity classes
+**Remult** is a fullstack CRUD framework which uses your TypeScript model types to provide:
+
+* Secured REST API (highly configurable)
+* Type-safe frontend API client
+* Type-safe backend query builder
+
+### Remult :heart: Monorepos
+
+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 level.
+
+
+## Installation
+```sh
+npm i remult
+```
+
+### Setup API backend using a Node.js Express middleware
+```ts
+import express from 'express';
+import { remultExpress } from 'remult/remult-express';
+
+const port = 3001;
+const app = express();
+
+app.use(remultExpress());
+
+app.listen(port, () => {
+  console.log(`Example API listening at http://localhost:${port}`);
+});
+```
+
+## Define model classes
 ```ts
 import { Entity, EntityBase, Field } from 'remult';
 
-@Entity('Products', {
+@Entity('products', {
     allowApiCrud: true
 })
 export class Product extends EntityBase {
@@ -18,27 +49,79 @@ export class Product extends EntityBase {
   unitPrice: number = 0;
 }
 ```
-### Find and manipulate data in front end code...
+
+### :rocket: API Ready
+```sh
+> curl http://localhost:3001/api/products
+
+[{"name":"Tofu","unitPrice":5}]
+```
+
+## Find and manipulate data in type-safe frontend code
 ```ts
-static increasePriceOfTofu(priceIncrease: number) {
-  const product = await remult.repo(Product).findFirst({ name:'Tofu' });
+async function increasePriceOfTofu(priceIncrease: number) {
+  const product = await remult.repo(Product).findFirst({ name: 'Tofu' });
 
   product.unitPrice += priceIncrease;
-  await product.save();
+  product.save();
 }
 ```
-### ...*exactly* the same way as in back end code
+
+### ...*exactly* the same way as in backend code
 ```ts
 @BackendMethod({ allowed: Allow.authenticated })
-static increasePriceOfTofu(priceIncrease: number, remult?: Remult) {
-  const product = await remult.repo(Product).findFirst({ name:'Tofu' });
+static async increasePriceOfTofu(priceIncrease: number, remult?: Remult) {
+  const product = await remult!.repo(Product).findFirst({ name: 'Tofu' });
 
   product.unitPrice += priceIncrease;
+  product.save();
+}
+```
+
+## :ballot_box_with_check: Data validation and constraints - defined once
+
+```ts
+import { Entity, EntityBase, Field } from 'remult';
+import { Min } from 'class-validator';
+
+@Entity('products', {
+    allowApiCrud: true
+})
+export class Product extends EntityBase {
+    @Field<Product>({
+        validate: p => {
+            if (p.name.trim().length == 0)
+                p.$.name.error = 'required';
+        }
+    })
+    name: string = '';
+
+    @Field()
+    @Min(0)
+    unitPrice: number = 0;
+}
+```
+
+### Enforced in frontend:
+```ts
+const product = remult.repo(Product).create();
+
+try {
   await product.save();
 }
+catch {
+  console.error(product._.error); // Browser console will display - "Name: required"
+}
 ```
 
-### Secure the API with Fine-grained Authorization
+### Enforced in backend:
+```sh
+> curl -d "{""unitPrice"":-1}" -H "Content-Type: application/json" -X POST http://localhost:3001/api/products
+
+{"modelState":{"unitPrice":"unitPrice must not be less than 0","name":"required"},"message":"Name: required"}
+```
+
+## :lock: Secure the API with fine-grained authorization
 ```ts
 @Entity<Article>('Articles', {
     allowApiRead: true,
@@ -57,26 +140,5 @@ export class Article extends EntityBase {
 }
 ```
 
-## Remult handles the REST:
-* Secured back-end API endpoints for Entities and back-end methods
-* CRUD API requests (front end) / database commands (back end)
-* Object-relational mapping
-* Validations
-* Caching
-* Authorization
-
-## Installation
-```sh
-npm i remult
-```
-
-## API Setup using Express
-```ts
-import * as express from 'express';
-import { remultExpress } from 'remult/remult-express';
-import 'entities';
-
-let app = express();
-app.use(remultExpress());
-app.listen(3002, () => console.log("Server started"));
-```
+## Getting started
+The best way to learn Remult is by following a tutorial of a simple fullstack Todo app using [React](https://remult.dev/tutorials/tutorial-react.html) or [Angular](https://remult.dev/tutorials/tutorial-angular.html).

package/src/data-api.d.ts

@@ -30,4 +30,4 @@ export interface DataApiRequest {
     get(key: string): any;
 }
 export declare function determineSort(sortUrlParm: string, dirUrlParam: string): any;
-export declare function serializeError(data: ErrorInfo): ErrorInfo;
+export declare function serializeError(data: ErrorInfo): ErrorInfo<any>;

package/src/data-interfaces.d.ts

@@ -1,6 +1,6 @@
 import { Sort } from './sort';
 import { Filter } from './filter/filter-interfaces';
-import { EntityMetadata } from './remult3';
+import { EntityMetadata, OmitEB } from './remult3';
 export interface DataProvider {
     getEntityDataProvider(entity: EntityMetadata): EntityDataProvider;
     transaction(action: (dataProvider: DataProvider) => Promise<void>): Promise<void>;
@@ -26,10 +26,12 @@ export interface RestDataProviderHttpProvider {
     get(url: string): Promise<any>;
 }
 export declare function extractSort(sort: any): Sort;
-export interface ErrorInfo {
+export interface ErrorInfo<entityType = any> {
     message?: string;
     modelState?: {
         [key: string]: string;
+    } & {
+        [Properties in keyof Partial<OmitEB<entityType>>]?: string;
     };
     stack?: string;
     exception?: any;

package/src/remult3/RepositoryImplementation.d.ts

@@ -201,7 +201,7 @@ export declare function JsonField<entityType = any, valueType = any>(...options:
 export declare function DateOnlyField<entityType = any>(...options: (FieldOptions<entityType, Date> | ((options: FieldOptions<entityType, Date>, remult: Remult) => void))[]): (target: any, key: any, c?: any) => void;
 export declare function IntegerField<entityType = any>(...options: (FieldOptions<entityType, Number> | ((options: FieldOptions<entityType, Number>, remult: Remult) => void))[]): (target: any, key: any, c?: any) => void;
 export declare function ValueListFieldType<entityType = any, valueType extends ValueListItem = any>(type: ClassType<valueType>, ...options: (FieldOptions<entityType, valueType> | ((options: FieldOptions<entityType, valueType>, remult: Remult) => void))[]): (target: any) => any;
-export declare function UUIDField<entityType = any, valueType = any>(...options: (FieldOptions<entityType, valueType> | ((options: FieldOptions<entityType, valueType>, remult: Remult) => void))[]): (target: any, key: any, c?: any) => void;
+export declare function UuidField<entityType = any, valueType = any>(...options: (FieldOptions<entityType, valueType> | ((options: FieldOptions<entityType, valueType>, remult: Remult) => void))[]): (target: any, key: any, c?: any) => void;
 export declare function Field<entityType = any, valueType = any>(...options: (FieldOptions<entityType, valueType> | ((options: FieldOptions<entityType, valueType>, remult: Remult) => void))[]): (target: any, key: any, c?: any) => void;
 export declare function decorateColumnSettings<valueType>(settings: FieldOptions<any, valueType>, remult: Remult): FieldOptions<any, valueType>;
 interface columnInfo {