remult 0.21.1 → 0.22.0

package/README.md

@@ -27,7 +27,6 @@
   </a>
 </div>
 
-
 <br/>
 
 <div align="center">
@@ -55,13 +54,13 @@
 as a single source of truth for your API, frontend type-safe API client and
 backend ORM**.
 
-* :zap: Zero-boilerplate CRUD API routes with paging, sorting, and filtering for Express / Fastify / Next.js / NestJS / Koa / others...
-* :ok_hand: Fullstack type-safety for API queries, mutations and RPC, without code generation
-* :sparkles: Input validation, defined once, runs both on the backend and on the frontend for best UX
-* :lock: Fine-grained code-based API authorization
-* :relieved: Incrementally adoptable
-* :rocket: Production ready
-* :mega: **NEW - Zero-boilerplate realtime live-queries**
+- :zap: Zero-boilerplate CRUD API routes with paging, sorting, and filtering for Express / Fastify / Next.js / NestJS / Koa / others...
+- :ok_hand: Fullstack type-safety for API queries, mutations and RPC, without code generation
+- :sparkles: Input validation, defined once, runs both on the backend and on the frontend for best UX
+- :lock: Fine-grained code-based API authorization
+- :relieved: Incrementally adoptable
+- :rocket: Production ready
+- :mega: **NEW - Zero-boilerplate realtime live-queries**
 
 ### Status
 
@@ -104,17 +103,17 @@ npm i remult
 ```ts
 // shared/product.ts
 
-import { Entity, Fields } from "remult";
+import { Entity, Fields } from "remult"
 
 @Entity("products", {
-  allowApiCrud: true,
+  allowApiCrud: true
 })
 export class Product {
   @Fields.string()
-  name = "";
+  name = ""
 
   @Fields.number()
-  unitPrice = 0;
+  unitPrice = 0
 }
 ```
 
@@ -123,20 +122,22 @@ export class Product {
 ```ts
 // backend/index.ts
 
-import express from "express";
-import { remultExpress } from "remult/remult-express";
-import { Product } from "../shared/product";
+import express from "express"
+import { remultExpress } from "remult/remult-express"
+import { Product } from "../shared/product"
 
-const port = 3001;
-const app = express();
+const port = 3001
+const app = express()
 
-app.use(remultExpress({
-  entities: [Product],
-}));
+app.use(
+  remultExpress({
+    entities: [Product]
+  })
+)
 
 app.listen(port, () => {
-  console.log(`Example API listening at http://localhost:${port}`);
-});
+  console.log(`Example API listening at http://localhost:${port}`)
+})
 ```
 
 ### :rocket: API Ready
@@ -152,15 +153,15 @@ app.listen(port, () => {
 ```ts
 // frontend/code.ts
 
-import { remult } from "remult";
-import { Product } from "../shared/product";
+import { remult } from "remult"
+import { Product } from "../shared/product"
 
 async function increasePriceOfTofu(priceIncrease: number) {
-  const productsRepo = remult.repo(Product);
+  const productsRepo = remult.repo(Product)
 
-  const product = await productsRepo.findFirst({ name: "Tofu" }); // filter is passed through API request all the way to the db
-  product.unitPrice += priceIncrease;
-  productsRepo.save(product); // mutation request updates the db with no boilerplate code
+  const product = await productsRepo.findFirst({ name: "Tofu" }) // filter is passed through API request all the way to the db
+  product.unitPrice += priceIncrease
+  productsRepo.save(product) // mutation request updates the db with no boilerplate code
 }
 ```
 
@@ -180,46 +181,46 @@ static async increasePriceOfTofu(priceIncrease: number) {
 ### :ballot_box_with_check: Data validation and constraints - defined once
 
 ```ts
-import { Entity, Fields, Validators } from "remult";
+import { Entity, Fields, Validators } from "remult"
 
 @Entity("products", {
-  allowApiCrud: true,
+  allowApiCrud: true
 })
 export class Product {
   @Fields.string({
-    validate: Validators.required,
+    validate: Validators.required
   })
-  name = "";
+  name = ""
 
   @Fields.string<Product>({
     validate: (product) => {
       if (product.description.trim().length < 50) {
-        throw "too short";
+        throw "too short"
       }
-    },
+    }
   })
-  description = "";
+  description = ""
 
   @Fields.number({
     validate: (_, field) => {
       if (field.value < 0) {
-        field.error = "must not be less than 0"; // or: 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;
+  unitPrice = 0
 }
 ```
 
 ### Enforced in frontend:
 
 ```ts
-const product = productsRepo.create();
+const product = productsRepo.create()
 
 try {
-  await productsRepo.save(product);
+  await productsRepo.save(product)
 } catch (e: any) {
-  console.error(e.message); // Browser console will display - "Name: required"
+  console.error(e.message) // Browser console will display - "Name: required"
 }
 ```
 
@@ -236,18 +237,18 @@ try {
 ```ts
 @Entity<Article>("Articles", {
   allowApiRead: true,
-  allowApiInsert: (remult) => remult.authenticated(),
-  allowApiUpdate: (remult, article) => article.author.id == remult.user.id,
+  allowApiInsert: (_, remult) => remult.authenticated(),
+  allowApiUpdate: (article, remult) => article.author.id == remult.user.id
 })
 export class Article {
   @Fields.string({ allowApiUpdate: false })
-  slug = "";
+  slug = ""
 
   @Field(() => Profile, { allowApiUpdate: false })
-  author!: Profile;
+  author!: Profile
 
   @Fields.string()
-  content = "";
+  content = ""
 }
 ```
 

package/SseSubscriptionServer.js

@@ -31,7 +31,7 @@ var SseSubscriptionServer = /** @class */ (function () {
                             delete c.channels[channel];
                         else
                             c.channels[channel] = true;
-                        res.success({ status: "ok" });
+                        res.success({ status: 'ok' });
                         this.debug();
                         return;
                     }
@@ -84,14 +84,14 @@ var SseSubscriptionServer = /** @class */ (function () {
         res.writeHead(200, {
             'Content-Type': 'text/event-stream',
             'Cache-Control': 'no-cache',
-            'Connection': 'keep-alive'
+            Connection: 'keep-alive',
         });
         var cc = new clientConnection(res);
         //const lastEventId = req.headers['last-event-id'];
         this.connections.push(cc);
         this.debug();
         //@ts-ignore
-        req.on("close", function () {
+        req.on('close', function () {
             cc.close();
             _this.connections = _this.connections.filter(function (s) { return s !== cc; });
             _this.debug();
@@ -102,7 +102,7 @@ var SseSubscriptionServer = /** @class */ (function () {
     SseSubscriptionServer.prototype.debug = function () {
         this.debugFileSaver(this.connections.map(function (x) { return ({
             id: x.connectionId,
-            channels: x.channels
+            channels: x.channels,
         }); }));
     };
     return SseSubscriptionServer;
@@ -114,7 +114,7 @@ var clientConnection = /** @class */ (function () {
         this.channels = {};
         this.closed = false;
         this.connectionId = uuid_1.v4();
-        this.write(this.connectionId, "connectionId");
+        this.write(this.connectionId, 'connectionId');
         this.sendLiveMessage();
     }
     clientConnection.prototype.close = function () {
@@ -123,11 +123,11 @@ var clientConnection = /** @class */ (function () {
         this.closed = true;
     };
     clientConnection.prototype.write = function (eventData, eventType) {
-        if (eventType === void 0) { eventType = "message"; }
-        var event = "event:" + eventType;
+        if (eventType === void 0) { eventType = 'message'; }
+        var event = 'event:' + eventType;
         // if (id != undefined)
         //     event += "\nid:" + id;
-        this.response.write(event + "\ndata:" + eventData + "\n\n");
+        this.response.write(event + '\ndata:' + eventData + '\n\n');
         if (this.response.flush)
             this.response.flush();
     };
@@ -135,7 +135,7 @@ var clientConnection = /** @class */ (function () {
         var _this = this;
         if (this.closed)
             return;
-        this.write("", "keep-alive");
+        this.write('', 'keep-alive');
         this.timeOutRef = setTimeout(function () {
             _this.sendLiveMessage();
         }, 45000);

package/ably.js

@@ -30,7 +30,7 @@ var AblySubscriptionClient = /** @class */ (function () {
                                             }];
                                 }
                             });
-                        }); }
+                        }); },
                     }];
             });
         });

package/esm/SseSubscriptionServer.js

@@ -22,7 +22,7 @@ export class SseSubscriptionServer {
                         delete c.channels[channel];
                     else
                         c.channels[channel] = true;
-                    res.success({ status: "ok" });
+                    res.success({ status: 'ok' });
                     this.debug();
                     return;
                 }
@@ -49,25 +49,25 @@ export class SseSubscriptionServer {
         res.writeHead(200, {
             'Content-Type': 'text/event-stream',
             'Cache-Control': 'no-cache',
-            'Connection': 'keep-alive'
+            Connection: 'keep-alive',
         });
         const cc = new clientConnection(res);
         //const lastEventId = req.headers['last-event-id'];
         this.connections.push(cc);
         this.debug();
         //@ts-ignore
-        req.on("close", () => {
+        req.on('close', () => {
             cc.close();
-            this.connections = this.connections.filter(s => s !== cc);
+            this.connections = this.connections.filter((s) => s !== cc);
             this.debug();
         });
         return cc;
     }
     //@internal
     debug() {
-        this.debugFileSaver(this.connections.map(x => ({
+        this.debugFileSaver(this.connections.map((x) => ({
             id: x.connectionId,
-            channels: x.channels
+            channels: x.channels,
         })));
     }
 }
@@ -77,7 +77,7 @@ export class clientConnection {
         this.channels = {};
         this.closed = false;
         this.connectionId = uuid();
-        this.write(this.connectionId, "connectionId");
+        this.write(this.connectionId, 'connectionId');
         this.sendLiveMessage();
     }
     close() {
@@ -85,18 +85,18 @@ export class clientConnection {
             clearTimeout(this.timeOutRef);
         this.closed = true;
     }
-    write(eventData, eventType = "message") {
-        let event = "event:" + eventType;
+    write(eventData, eventType = 'message') {
+        let event = 'event:' + eventType;
         // if (id != undefined)
         //     event += "\nid:" + id;
-        this.response.write(event + "\ndata:" + eventData + "\n\n");
+        this.response.write(event + '\ndata:' + eventData + '\n\n');
         if (this.response.flush)
             this.response.flush();
     }
     sendLiveMessage() {
         if (this.closed)
             return;
-        this.write("", "keep-alive");
+        this.write('', 'keep-alive');
         this.timeOutRef = setTimeout(() => {
             this.sendLiveMessage();
         }, 45000);

package/esm/ably.js

@@ -9,12 +9,12 @@ export class AblySubscriptionClient {
             },
             subscribe: async (channel, handler) => {
                 let myHandler = (y) => handler(y.data);
-                await this.ably.channels.get(channel).subscribe(y => myHandler(y));
+                await this.ably.channels.get(channel).subscribe((y) => myHandler(y));
                 return () => {
                     myHandler = () => { };
                     this.ably.channels.get(channel).unsubscribe();
                 };
-            }
+            },
         };
     }
 }

package/esm/angular/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from './src/public_api';

package/esm/angular/interfaces/index.js

@@ -0,0 +1 @@
+export * from './src/public_api';

package/esm/angular/interfaces/src/column-collection.d.ts

@@ -0,0 +1,70 @@
+import { FieldMetadata, FieldRef, EntityMetadata, ValueListItem, Remult, Repository, EntityOrderBy, EntityFilter } from "remult";
+import { DataControlInfo, DataControlSettings, ValueOrEntityExpression } from "./data-control-interfaces";
+import { FilterHelper } from "./filter-helper";
+export declare class FieldCollection<rowType = any> {
+    currentRow: () => any;
+    private allowUpdate;
+    filterHelper: FilterHelper<rowType>;
+    private showArea;
+    private _getRowColumn;
+    constructor(currentRow: () => any, allowUpdate: () => boolean, filterHelper: FilterHelper<rowType>, showArea: () => boolean, _getRowColumn: (row: rowType, col: FieldMetadata) => FieldRef<any, any>);
+    __showArea(): boolean;
+    __getColumn(map: DataControlSettings, record: any): any;
+    __visible(col: DataControlSettings, row: any): boolean;
+    allowClick(col: DataControlSettings<any, any>, row: any): boolean;
+    getRowColumn<T>(args: {
+        col: DataControlSettings<any>;
+        row: any;
+    }, what: (c: FieldRef<any, any>, row: any) => T): T;
+    __dataControlStyle(map: DataControlSettings): string;
+    private settingsByKey;
+    allowDesignMode: boolean;
+    add(...columns: DataControlInfo<rowType>[]): Promise<void>;
+    add(...columns: string[]): Promise<void>;
+    private doWhenWeHaveContext;
+    private remult;
+    setContext(remult: Remult): void;
+    buildDropDown(s: DataControlSettings): Promise<void>;
+    designMode: boolean;
+    colListChanged(): void;
+    _colListChangeListeners: (() => void)[];
+    onColListChange(action: (() => void)): void;
+    moveCol(col: DataControlSettings, move: number): void;
+    filterRows(col: DataControlSettings): void;
+    clearFilter(col: DataControlSettings): void;
+    _shouldShowFilterDialog(col: DataControlSettings): boolean;
+    deleteCol(col: DataControlSettings): void;
+    addCol(col: DataControlSettings, newCol: DataControlSettings): void;
+    _getEditable(col: DataControlSettings, row: rowType): boolean;
+    _click(col: DataControlSettings, row: any): void;
+    _getColDisplayValue(col: DataControlSettings, row: rowType): any;
+    _getColDataType(col: DataControlSettings): string;
+    _getColumnClass(col: DataControlSettings, row: any): any;
+    _getError(col: DataControlSettings, r: any): any;
+    autoGenerateColumnsBasedOnData(defs: EntityMetadata<any>): void;
+    __changeWidth(col: DataControlSettings, what: number): void;
+    _colValueChanged(col: DataControlSettings, row: any): false | undefined;
+    items: DataControlSettings[];
+    private gridColumns;
+    private nonGridColumns;
+    numOfColumnsInGrid: number;
+    private _lastColumnCount;
+    private _lastNumOfColumnsInGrid;
+    private augmented;
+    augment(augmenter: dataControlAugmenter, s: DataControlSettings): void;
+    private _initColumnsArrays;
+    getGridColumns(augmenter: dataControlAugmenter): DataControlSettings<any, any>[];
+    getNonGridColumns(augmenter: dataControlAugmenter): DataControlSettings<any, any>[];
+}
+export declare function valueOrEntityExpressionToValue<T, entityType>(f: ValueOrEntityExpression<T, entityType>, e: entityType): T;
+/** returns an array of values that can be used in the value list property of a data control object */
+export declare function getEntityValueList<T>(repository: Repository<T>, args?: {
+    idField?: (e: EntityMetadata<T>) => FieldMetadata;
+    captionField?: (e: EntityMetadata<T>) => FieldMetadata;
+    orderBy?: EntityOrderBy<T>;
+    where?: EntityFilter<T>;
+}): Promise<ExtendedValueListItem[]>;
+export interface ExtendedValueListItem extends ValueListItem {
+    entity?: any;
+}
+export declare type dataControlAugmenter = (f: FieldMetadata, op: DataControlSettings) => void;