remult 0.13.27 → 0.13.31

package/package.json

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

package/readme.md

@@ -21,6 +21,9 @@
 	<a href="https://discord.gg/GXHk7ZfuG5">
 		<img alt="chat on discord" src="https://img.shields.io/badge/chat-on%20discord-blueviolet"/>
 	</a>
+	<a href="https://twitter.com/remultjs">
+	<img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/remultjs?style=social">
+	</a>
 </div>
 
 ## What is Remult?
@@ -114,24 +117,29 @@ static async increasePriceOfTofu(priceIncrease: number, remult?: Remult) {
 ### :ballot_box_with_check: Data validation and constraints - defined once
 
 ```ts
-import { Entity, Fields } from 'remult';
+import { Entity, Fields, Validators } from 'remult';
 
 @Entity('products', {
     allowApiCrud: true
 })
 export class Product {
+    @Fields.string({
+        validate: Validators.required
+    })
+    name = '';
+
     @Fields.string<Product>({
         validate: product => {
-            if (product.name.trim().length == 0)
-                throw 'required';
+            if (product.description.trim().length < 50)
+                throw "too short";
         }
     })
-    name = '';
+    description = '';
 
     @Fields.number({
         validate: (_, field) => {
             if (field.value < 0)
-                throw "must not be less than 0";
+                field.error = "must not be less than 0"; // or: throw "must not be less than 0";
         }
     })
     unitPrice = 0;
@@ -181,7 +189,11 @@ export class Article {
 [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).
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+* :speech_balloon: Any feedback or suggestions? Start a [discussion](https://github.com/remult/remult/discussions).
+* :muscle: Want to help out? Look for "help wanted" labeled [issues](https://github.com/remult/remult/issues).
+* :star: Give this repo a star.
 
 ## License
 Remult is [MIT Licensed](LICENSE).

package/remult-middleware.d.ts

@@ -0,0 +1,2 @@
+import { RemultMiddlewareOptions } from './server/expressBridge';
+export declare function remultMiddleware(options?: RemultMiddlewareOptions): import("./server/expressBridge").RemultExpressBridge;

package/remult-middleware.js

@@ -0,0 +1,64 @@
+import { remultMiddlewareBase } from './server/expressBridge';
+export function remultMiddleware(options) {
+    const m = new middleware();
+    let app = Object.assign(m, (req, res, next) => m.handleRequest(req, res, next));
+    return remultMiddlewareBase(app, options);
+}
+class middleware {
+    constructor() {
+        this.map = new Map();
+    }
+    route(path) {
+        //consider using:
+        //* https://raw.githubusercontent.com/cmorten/opine/main/src/utils/pathToRegex.ts
+        //* https://github.com/pillarjs/path-to-regexp
+        let r = path.toLowerCase();
+        let m = new Map();
+        this.map.set(r, m);
+        const route = {
+            get: (h) => {
+                m.set("get", h);
+                return route;
+            },
+            put: (h) => {
+                m.set("put", h);
+                return route;
+            },
+            post: (h) => {
+                m.set("post", h);
+                return route;
+            },
+            delete: (h) => {
+                m.set("delete", h);
+                return route;
+            }
+        };
+        return route;
+    }
+    handleRequest(req, res, next) {
+        let lowerPath = req.path.toLowerCase();
+        let m = this.map.get(lowerPath);
+        if (m) {
+            let h = m.get(req.method.toLowerCase());
+            if (h) {
+                h(req, res, next);
+                return;
+            }
+        }
+        let idPosition = req.path.lastIndexOf('/');
+        if (idPosition >= 0) {
+            lowerPath = req.path.substring(0, idPosition) + '/:id';
+            m = this.map.get(lowerPath);
+            if (m) {
+                let h = m.get(req.method.toLowerCase());
+                if (h) {
+                    req.params.id = req.path.substring(idPosition + 1);
+                    h(req, res, next);
+                    return;
+                }
+            }
+        }
+        console.log(req.path);
+        next();
+    }
+}

package/server/expressBridge.d.ts

@@ -37,6 +37,7 @@ declare class ExpressBridge {
     dataProvider: DataProvider | Promise<DataProvider>;
     openApiDoc(options: {
         title: string;
+        version?: string;
     }): any;
     backendMethodsOpenApi: {
         path: string;

package/server/expressBridge.js

@@ -61,7 +61,9 @@ function remultExpress(options) {
     var bridge = new ExpressBridge(app, new inProcessQueueHandler(options.queueStorage), options.initRequest, dataProvider);
     if (options.logApiEndPoints !== undefined)
         bridge.logApiEndPoints = options.logApiEndPoints;
-    var apiArea = bridge.addArea((options === null || options === void 0 ? void 0 : options.rootPath) || __1.Remult.apiBaseUrl);
+    if (options.rootPath === undefined)
+        options.rootPath = __1.Remult.apiBaseUrl;
+    var apiArea = bridge.addArea(options.rootPath);
     if (!options.disableAutoApi) {
         var actions = [];
         if (options.entities)
@@ -91,11 +93,14 @@ var ExpressBridge = /** @class */ (function () {
     ExpressBridge.prototype.openApiDoc = function (options) {
         var e_1, _a, e_2, _b;
         var r = new __1.Remult();
+        if (!options.version)
+            options.version = "1.0.0";
         var spec = {
-            info: { title: options.title },
+            info: { title: options.title, version: options.version },
             openapi: "3.0.0",
             //swagger: "2.0",
             "components": {
+                "schemas": {},
                 "securitySchemes": {
                     "bearerAuth": {
                         "scheme": "bearer",
@@ -104,8 +109,7 @@ var ExpressBridge = /** @class */ (function () {
                     }
                 }
             },
-            paths: {},
-            definitions: {}
+            paths: {}
         };
         var validationError = {
             "400": {
@@ -113,7 +117,7 @@ var ExpressBridge = /** @class */ (function () {
                 "content": {
                     "application/json": {
                         "schema": {
-                            "$ref": "#/definitions/InvalidResponse"
+                            "$ref": "#/components/schemas/InvalidResponse"
                         }
                     }
                 }
@@ -180,12 +184,12 @@ var ExpressBridge = /** @class */ (function () {
                     }
                     finally { if (e_3) throw e_3.error; }
                 }
-                spec.definitions[key] = {
+                spec.components.schemas[key] = {
                     type: "object",
                     properties: properties
                 };
                 var definition = {
-                    "$ref": "#/definitions/" + key
+                    "$ref": "#/components/schemas/" + key
                 };
                 var secure = function (condition, def, item) {
                     item.tags = [meta.key];
@@ -204,28 +208,28 @@ var ExpressBridge = /** @class */ (function () {
                             "description": "limit the number of returned rows, default 100",
                             "required": false,
                             "style": "simple",
-                            "type": "int"
+                            "schema": { "type": "integer" }
                         },
                         {
                             "name": "_page",
                             "in": "query",
                             "description": "to be used for paging",
                             "required": false,
-                            "type": "int"
+                            "schema": { "type": "integer" }
                         },
                         {
                             "name": "_sort",
                             "in": "query",
                             "description": "the columns to sort on",
                             "required": false,
-                            "type": "string"
+                            "schema": { "type": "string" }
                         },
                         {
                             "name": "_order",
                             "in": "query",
                             "description": "the sort order to user for the columns in `_sort`",
                             "required": false,
-                            "type": "string"
+                            "schema": { "type": "string" }
                         }], parameters),
                     responses: {
                         "200": {
@@ -246,14 +250,14 @@ var ExpressBridge = /** @class */ (function () {
                     "in": "path",
                     "description": "id of " + key,
                     "required": true,
-                    "type": "string"
+                    "schema": { "type": "string" },
                 };
                 var itemInBody = {
                     "requestBody": {
                         "content": {
                             "application/json": {
                                 "schema": {
-                                    "$ref": "#/definitions/" + key
+                                    "$ref": "#/components/schemas/" + key
                                 }
                             }
                         }
@@ -267,7 +271,7 @@ var ExpressBridge = /** @class */ (function () {
                             "content": {
                                 "application/json": {
                                     "schema": {
-                                        "$ref": "#/definitions/" + key
+                                        "$ref": "#/components/schemas/" + key
                                     }
                                 }
                             }
@@ -280,7 +284,7 @@ var ExpressBridge = /** @class */ (function () {
                             "content": {
                                 "application/json": {
                                     "schema": {
-                                        "$ref": "#/definitions/" + key
+                                        "$ref": "#/components/schemas/" + key
                                     }
                                 }
                             }
@@ -297,7 +301,7 @@ var ExpressBridge = /** @class */ (function () {
                             "content": {
                                 "application/json": {
                                     "schema": {
-                                        "$ref": "#/definitions/" + key
+                                        "$ref": "#/components/schemas/" + key
                                     }
                                 }
                             }
@@ -376,7 +380,7 @@ var ExpressBridge = /** @class */ (function () {
             }
             finally { if (e_2) throw e_2.error; }
         }
-        spec.definitions["InvalidResponse"] = {
+        spec.components.schemas["InvalidResponse"] = {
             "type": "object",
             properties: {
                 "message": {
@@ -856,3 +860,4 @@ var JobsInQueueEntity = /** @class */ (function (_super) {
     return JobsInQueueEntity;
 }(__1.IdEntity));
 exports.JobsInQueueEntity = JobsInQueueEntity;
+context_1.allEntities.splice(context_1.allEntities.indexOf(JobsInQueueEntity), 1);

package/src/column-interfaces.d.ts

@@ -14,18 +14,18 @@ export interface FieldOptions<entityType = any, valueType = any> {
     allowApiUpdate?: AllowedForInstance<entityType>;
     /** An arrow function that'll be used to perform validations on it
      * @example
-     * .@Fields.string({
+     * @Fields.string({
      *   validate: Validators.required
      * })
      * @example
-     * .@Fields.string<Task>({
+     * @Fields.string<Task>({
      *    validate: task=>{
      *      if (task.title.length<3)
      *          throw "Too Short";
      *   }
      * })
      * @example
-     * .@Fields.string({
+     * @Fields.string({
      *    validate: (_, fieldRef)=>{
      *      if (fieldRef.value.length<3)
      *          fieldRef.error = "Too Short";

package/src/context.js

@@ -41,28 +41,28 @@ var HttpProviderBridgeToRestDataProviderHttpProvider = /** @class */ (function (
 }());
 exports.HttpProviderBridgeToRestDataProviderHttpProvider = HttpProviderBridgeToRestDataProviderHttpProvider;
 function retry(what) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     return tslib_1.__awaiter(this, void 0, void 0, function () {
         var err_1;
-        return tslib_1.__generator(this, function (_d) {
-            switch (_d.label) {
+        return tslib_1.__generator(this, function (_e) {
+            switch (_e.label) {
                 case 0:
                     if (!true) return [3 /*break*/, 7];
-                    _d.label = 1;
+                    _e.label = 1;
                 case 1:
-                    _d.trys.push([1, 3, , 6]);
+                    _e.trys.push([1, 3, , 6]);
                     return [4 /*yield*/, what()];
-                case 2: return [2 /*return*/, _d.sent()];
+                case 2: return [2 /*return*/, _e.sent()];
                 case 3:
-                    err_1 = _d.sent();
-                    if (!(((_a = err_1.message) === null || _a === void 0 ? void 0 : _a.startsWith("Error occurred while trying to proxy")) || ((_b = err_1.message) === null || _b === void 0 ? void 0 : _b.startsWith("Error occured while trying to proxy")) || ((_c = err_1.message) === null || _c === void 0 ? void 0 : _c.startsWith("Gateway Timeout")))) return [3 /*break*/, 5];
+                    err_1 = _e.sent();
+                    if (!(((_a = err_1.message) === null || _a === void 0 ? void 0 : _a.startsWith("Error occurred while trying to proxy")) || ((_b = err_1.message) === null || _b === void 0 ? void 0 : _b.startsWith("Error occured while trying to proxy")) || ((_c = err_1.message) === null || _c === void 0 ? void 0 : _c.includes("http proxy error")) || ((_d = err_1.message) === null || _d === void 0 ? void 0 : _d.startsWith("Gateway Timeout")))) return [3 /*break*/, 5];
                     return [4 /*yield*/, new Promise(function (res, req) {
                             setTimeout(function () {
                                 res({});
                             }, 250);
                         })];
                 case 4:
-                    _d.sent();
+                    _e.sent();
                     return [3 /*break*/, 0];
                 case 5: throw err_1;
                 case 6: return [3 /*break*/, 0];

package/src/data-providers/array-entity-data-provider.js

@@ -4,7 +4,6 @@ exports.ArrayEntityDataProvider = void 0;
 var tslib_1 = require("tslib");
 var filter_interfaces_1 = require("../filter/filter-interfaces");
 var column_1 = require("../column");
-var sort_1 = require("../sort");
 var ArrayEntityDataProvider = /** @class */ (function () {
     function ArrayEntityDataProvider(entity, rows) {
         var e_1, _a;
@@ -220,34 +219,38 @@ var ArrayEntityDataProvider = /** @class */ (function () {
     ArrayEntityDataProvider.prototype.insert = function (data) {
         var _a;
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var idf, lastRow, j;
-            return tslib_1.__generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        idf = this.entity.idMetadata.field;
-                        if (!!(idf instanceof column_1.CompoundIdField)) return [3 /*break*/, 3];
-                        if (!(((_a = idf.options.valueConverter) === null || _a === void 0 ? void 0 : _a.fieldTypeInDb) === 'autoincrement')) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this.find({ orderBy: new sort_1.Sort({ field: idf, isDescending: true }) })];
-                    case 1:
-                        lastRow = _b.sent();
-                        if (lastRow.length > 0)
-                            data[idf.key] = lastRow[0][idf.key] + 1;
-                        else
-                            data[idf.key] = 1;
-                        _b.label = 2;
-                    case 2:
-                        if (data[idf.key])
-                            this.rows.forEach(function (i) {
-                                if (data[idf.key] == i[idf.key])
-                                    throw Error("id already exists");
-                            });
-                        _b.label = 3;
-                    case 3:
-                        j = this.translateToJson(data);
-                        this.verifyThatRowHasAllNotNullColumns(j);
-                        this.rows.push(j);
-                        return [2 /*return*/, Promise.resolve(this.translateFromJson(j))];
+            var idf, _b, _c, row, j;
+            var e_6, _d;
+            return tslib_1.__generator(this, function (_e) {
+                idf = this.entity.idMetadata.field;
+                if (!(idf instanceof column_1.CompoundIdField)) {
+                    if (((_a = idf.options.valueConverter) === null || _a === void 0 ? void 0 : _a.fieldTypeInDb) === 'autoincrement') {
+                        data[idf.key] = 1;
+                        try {
+                            for (_b = tslib_1.__values(this.rows), _c = _b.next(); !_c.done; _c = _b.next()) {
+                                row = _c.value;
+                                if (row[idf.key] >= data[idf.key])
+                                    data[idf.key] = row[idf.key] + 1;
+                            }
+                        }
+                        catch (e_6_1) { e_6 = { error: e_6_1 }; }
+                        finally {
+                            try {
+                                if (_c && !_c.done && (_d = _b.return)) _d.call(_b);
+                            }
+                            finally { if (e_6) throw e_6.error; }
+                        }
+                    }
+                    if (data[idf.key])
+                        this.rows.forEach(function (i) {
+                            if (data[idf.key] == i[idf.key])
+                                throw Error("id already exists");
+                        });
                 }
+                j = this.translateToJson(data);
+                this.verifyThatRowHasAllNotNullColumns(j);
+                this.rows.push(j);
+                return [2 /*return*/, Promise.resolve(this.translateFromJson(j))];
             });
         });
     };
@@ -287,7 +290,7 @@ var FilterConsumerBridgeToObject = /** @class */ (function () {
         throw new Error('Custom Filter should be translated before it gets here');
     };
     FilterConsumerBridgeToObject.prototype.or = function (orElements) {
-        var e_6, _a;
+        var e_7, _a;
         try {
             for (var orElements_1 = tslib_1.__values(orElements), orElements_1_1 = orElements_1.next(); !orElements_1_1.done; orElements_1_1 = orElements_1.next()) {
                 var element = orElements_1_1.value;
@@ -298,12 +301,12 @@ var FilterConsumerBridgeToObject = /** @class */ (function () {
                 }
             }
         }
-        catch (e_6_1) { e_6 = { error: e_6_1 }; }
+        catch (e_7_1) { e_7 = { error: e_7_1 }; }
         finally {
             try {
                 if (orElements_1_1 && !orElements_1_1.done && (_a = orElements_1.return)) _a.call(orElements_1);
             }
-            finally { if (e_6) throw e_6.error; }
+            finally { if (e_7) throw e_7.error; }
         }
         this.ok = false;
     };
@@ -316,7 +319,7 @@ var FilterConsumerBridgeToObject = /** @class */ (function () {
             this.ok = false;
     };
     FilterConsumerBridgeToObject.prototype.isIn = function (col, val) {
-        var e_7, _a;
+        var e_8, _a;
         try {
             for (var val_1 = tslib_1.__values(val), val_1_1 = val_1.next(); !val_1_1.done; val_1_1 = val_1.next()) {
                 var v = val_1_1.value;
@@ -325,12 +328,12 @@ var FilterConsumerBridgeToObject = /** @class */ (function () {
                 }
             }
         }
-        catch (e_7_1) { e_7 = { error: e_7_1 }; }
+        catch (e_8_1) { e_8 = { error: e_8_1 }; }
         finally {
             try {
                 if (val_1_1 && !val_1_1.done && (_a = val_1.return)) _a.call(val_1);
             }
-            finally { if (e_7) throw e_7.error; }
+            finally { if (e_8) throw e_8.error; }
         }
         this.ok = false;
     };

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

@@ -109,15 +109,16 @@ var WebSqlDataProvider = /** @class */ (function () {
     };
     WebSqlDataProvider.prototype.addColumnSqlSyntax = function (x, dbName) {
         var result = dbName;
+        var nullNumber = x.allowNull ? "" : " default 0 not null";
         if (x.valueType == Date)
             result += " integer";
         else if (x.valueType == Boolean)
-            result += " integer default 0 not null";
+            result += " integer " + nullNumber;
         else if (x.valueType == Number) {
             if (!x.valueConverter.fieldTypeInDb)
-                result += ' real default 0 not null';
+                result += ' real ' + nullNumber;
             else
-                result += ' ' + x.valueConverter.fieldTypeInDb + ' default 0 not null';
+                result += ' ' + x.valueConverter.fieldTypeInDb + ' ' + nullNumber;
         }
         else
             result += " text" + (x.allowNull ? " " : " default '' not null ");

package/src/entity.d.ts

@@ -29,7 +29,7 @@ export interface EntityOptions<entityType = any> {
     apiPrefilter?: EntityFilter<entityType> | (() => EntityFilter<entityType> | Promise<EntityFilter<entityType>>);
     /** A filter that will be used for all queries from this entity both from the API and from within the backend.
      * @example
-     * fixedWhereFilter: { archive:false }
+     * backendPrefilter: { archive:false }
      * @see [EntityFilter](http://remult.dev/docs/entityFilter.html)
      */
     backendPrefilter?: EntityFilter<entityType> | (() => EntityFilter<entityType> | Promise<EntityFilter<entityType>>);
@@ -45,7 +45,7 @@ export interface EntityOptions<entityType = any> {
     * If the `error` property of the entity's ref or any of it's fields will be set, the save will be aborted and an exception will be thrown.
     * this is the place to run logic that we want to run in any case before an entity is saved.
     * @example
-    * .@Entity<Task>("tasks", {
+    * @Entity<Task>("tasks", {
     * saving: async task => {
     *      task.lastUpdated = new Date()
     *  }
@@ -68,8 +68,15 @@ export interface EntityOptions<entityType = any> {
     dbName?: string;
     /** For entities that are based on SQL expressions instead of a physical table or view*/
     sqlExpression?: string | ((entity: FieldsMetadata<entityType>) => string | Promise<string>);
-    /** An arrow function that identifies the `id` column to use for this entity */
-    id?: (entity: FieldsMetadata<entityType>) => FieldMetadata;
+    /** An arrow function that identifies the `id` column to use for this entity
+     * @example
+     * //Single column id
+     * @Entity<Products>("products", { id:p=>p.productCode })
+     * @example
+     * //Multiple columns id
+     * @Entity<OrderDetails>("orderDetails", { id:od=> [od.orderId, od.productCode] })
+    */
+    id?: (entity: FieldsMetadata<entityType>) => FieldMetadata | FieldMetadata[];
     entityRefInit?: (ref: EntityRef<entityType>, row: entityType) => void;
     apiRequireId?: Allowed;
 }

package/src/remult3/RepositoryImplementation.d.ts

@@ -256,11 +256,11 @@ export declare function getValueList<T>(type: ClassType<T>): T[];
  * FieldOptions can be set in two ways:
  * @example
  * // as an object
- * .@Fields.string({ includeInApi:false })
+ * @Fields.string({ includeInApi:false })
  * title='';
  * @example
  * // as an arrow function that receives `remult` as a parameter
- * .@Fields.string((options,remult) => options.includeInApi = true)
+ * @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, key: any, c?: any) => void;
@@ -289,13 +289,14 @@ export declare function BuildEntity<entityType>(c: ClassType<entityType>, key: s
  *    @Fields.boolean()
  *    completed = false;
  * }
- * *EntityOptions can be set in two ways:*
+ * @note
+ * EntityOptions can be set in two ways:
  * @example
  * // as an object
- * .@Entity("tasks",{ allowApiCrud:true })
+ * @Entity("tasks",{ allowApiCrud:true })
  * @example
  * // as an arrow function that receives `remult` as a parameter
- * .@Entity("tasks", (options,remult) => options.allowApiCrud = true)
+ * @Entity("tasks", (options,remult) => options.allowApiCrud = true)
  */
 export declare function Entity<entityType>(key: string, ...options: (EntityOptions<entityType> | ((options: EntityOptions<entityType>, remult: Remult) => void))[]): (target: any) => any;
 export declare class EntityBase {

package/src/remult3/RepositoryImplementation.js

@@ -2181,7 +2181,15 @@ var EntityFullInfo = /** @class */ (function () {
         this.fields = r;
         this.caption = buildCaption(entityInfo.caption, this.key, remult);
         if (entityInfo.id) {
-            this.idMetadata.field = entityInfo.id(this.fields);
+            var r_2 = entityInfo.id(this.fields);
+            if (Array.isArray(r_2)) {
+                if (r_2.length > 1)
+                    this.idMetadata.field = new (column_1.CompoundIdField.bind.apply(column_1.CompoundIdField, tslib_1.__spread([void 0], r_2)))();
+                else if (r_2.length == 1)
+                    this.idMetadata.field = r_2[0];
+            }
+            else
+                this.idMetadata.field = r_2;
         }
         else {
             if (this.fields["id"])
@@ -2331,8 +2339,8 @@ var Fields = /** @class */ (function () {
 }());
 exports.Fields = Fields;
 function isAutoIncrement(f) {
-    var _a;
-    return ((_a = f.options.valueConverter) === null || _a === void 0 ? void 0 : _a.fieldTypeInDb) === 'autoincrement';
+    var _a, _b;
+    return ((_b = (_a = f.options) === null || _a === void 0 ? void 0 : _a.valueConverter) === null || _b === void 0 ? void 0 : _b.fieldTypeInDb) === 'autoincrement';
 }
 exports.isAutoIncrement = isAutoIncrement;
 function ValueListFieldType() {
@@ -2467,11 +2475,11 @@ exports.getValueList = getValueList;
  * FieldOptions can be set in two ways:
  * @example
  * // as an object
- * .@Fields.string({ includeInApi:false })
+ * @Fields.string({ includeInApi:false })
  * title='';
  * @example
  * // as an arrow function that receives `remult` as a parameter
- * .@Fields.string((options,remult) => options.includeInApi = true)
+ * @Fields.string((options,remult) => options.includeInApi = true)
  * title='';
  */
 function Field(valueType) {
@@ -2637,13 +2645,14 @@ exports.BuildEntity = BuildEntity;
  *    @Fields.boolean()
  *    completed = false;
  * }
- * *EntityOptions can be set in two ways:*
+ * @note
+ * EntityOptions can be set in two ways:
  * @example
  * // as an object
- * .@Entity("tasks",{ allowApiCrud:true })
+ * @Entity("tasks",{ allowApiCrud:true })
  * @example
  * // as an arrow function that receives `remult` as a parameter
- * .@Entity("tasks", (options,remult) => options.allowApiCrud = true)
+ * @Entity("tasks", (options,remult) => options.allowApiCrud = true)
  */
 function Entity(key) {
     var options = [];

package/src/remult3/remult3.d.ts

@@ -112,7 +112,12 @@ export declare type OmitEB<T> = Omit<T, keyof import('./RepositoryImplementation
 export interface Repository<entityType> {
     /** returns a result array based on the provided options */
     find(options?: FindOptions<entityType>): Promise<entityType[]>;
-    /** returns the first item that matchers the `where` condition */
+    /** returns the first item that matchers the `where` condition
+     * @example
+     * await taskRepo.findFirst({ completed:false })
+     * @example
+     * await taskRepo.findFirst({ completed:false },{ createIfNotFound: true })
+     *      */
     findFirst(where?: EntityFilter<entityType>, options?: FindFirstOptions<entityType>): Promise<entityType>;
     /** returns the items that matches the idm the result is cached unless specified differently in the `options` parameter */
     findId(id: entityType extends {
@@ -285,7 +290,7 @@ export interface QueryResult<entityType> {
     [Symbol.asyncIterator](): {
         next: () => Promise<IteratorResult<entityType, entityType>>;
     };
-    /** returns the number of rows that match the query critiria */
+    /** returns the number of rows that match the query criteria */
     count(): Promise<number>;
     /** Returns a `Paginator` object that is used for efficient paging */
     paginator(): Promise<Paginator<entityType>>;
@@ -300,7 +305,7 @@ export interface Paginator<entityType> {
     items: entityType[];
     /** True if next page exists */
     hasNextPage: boolean;
-    /** Get's the next page in the query's result set */
+    /** Gets the next page in the `query`'s result set */
     nextPage(): Promise<Paginator<entityType>>;
     /** the count of the total items in the `query`'s result */
     count(): Promise<number>;

package/src/shared-tests/test-update-with-null.spec.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var tslib_1 = require("tslib");
+var sql_database_1 = require("../data-providers/sql-database");
 var remult3_1 = require("../remult3");
 var db_tests_setup_1 = require("./db-tests-setup");
 var testNull = /** @class */ (function (_super) {
@@ -8,6 +9,7 @@ var testNull = /** @class */ (function (_super) {
     function testNull() {
         var _this = _super !== null && _super.apply(this, arguments) || this;
         _this.id = 0;
+        _this.numberWithNull = null;
         return _this;
     }
     tslib_1.__decorate([
@@ -18,6 +20,10 @@ var testNull = /** @class */ (function (_super) {
         remult3_1.Field(undefined, { allowNull: true }),
         tslib_1.__metadata("design:type", Object)
     ], testNull.prototype, "myCol", void 0);
+    tslib_1.__decorate([
+        remult3_1.Fields.integer({ allowNull: true }),
+        tslib_1.__metadata("design:type", Number)
+    ], testNull.prototype, "numberWithNull", void 0);
     testNull = tslib_1.__decorate([
         remult3_1.Entity('testNull', { allowApiCrud: true })
     ], testNull);
@@ -49,3 +55,35 @@ db_tests_setup_1.testAll("test that update null works", function (_a) {
         });
     });
 }, false);
+db_tests_setup_1.testAll("test number with null", function (_a) {
+    var createEntity = _a.createEntity;
+    return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+        var r, i, _b, _c;
+        return tslib_1.__generator(this, function (_d) {
+            switch (_d.label) {
+                case 0: return [4 /*yield*/, createEntity(testNull)];
+                case 1:
+                    r = _d.sent();
+                    return [4 /*yield*/, r.insert({ id: 1, myCol: { value: 'abc' }, numberWithNull: null })];
+                case 2:
+                    i = _d.sent();
+                    expect(i.numberWithNull).toBe(null);
+                    _b = expect;
+                    return [4 /*yield*/, r.count({ numberWithNull: null })];
+                case 3:
+                    _b.apply(void 0, [_d.sent()]).toBe(1);
+                    i.numberWithNull = 0;
+                    return [4 /*yield*/, i.save()];
+                case 4:
+                    _d.sent();
+                    expect(i.numberWithNull).toBe(0);
+                    sql_database_1.SqlDatabase.LogToConsole = true;
+                    _c = expect;
+                    return [4 /*yield*/, r.count({ numberWithNull: null })];
+                case 5:
+                    _c.apply(void 0, [_d.sent()]).toBe(0);
+                    return [2 /*return*/];
+            }
+        });
+    });
+}, false);

package/valueConverters.js

@@ -86,6 +86,8 @@ var ValueConverters = /** @class */ (function () {
                 return undefined;
             return val.replace(/-/g, '');
         }, fromDb: function (val) {
+            if (val === null)
+                return null;
             if (!val)
                 return undefined;
             return new Date(val.substring(0, 4) + '-' + val.substring(4, 6) + '-' + val.substring(6, 8));
@@ -110,6 +112,8 @@ var ValueConverters = /** @class */ (function () {
     };
     ValueConverters.Number = {
         fromDb: function (value) {
+            if (value === null)
+                return null;
             if (value !== undefined)
                 return +value;
             return undefined;