remult 0.16.2 → 0.16.3-exp.0

package/README.md

@@ -3,51 +3,71 @@
     <img src="https://github.com/remult/remult/raw/master/docs/.vuepress/public/logo.png" width="140" height="140">
   </a>
   <h1>Remult</h1>
-	<a href="https://circleci.com/gh/remult/remult/tree/master">
+	<a href="https://circleci.com/gh/remult/remult/tree/master" rel="nofollow">
 		<img alt="CircleCI" src="https://circleci.com/gh/remult/remult/tree/master.svg?style=shield">
 	</a>
-	<a href="https://codecov.io/gh/remult/remult">
+	<a href="https://codecov.io/gh/remult/remult" rel="nofollow">
         	<img src="https://codecov.io/gh/remult/remult/branch/master/graph/badge.svg?token=LYWQRUN3D1"/>
       	</a>
-    	<a href="https://raw.githubusercontent.com/remult/remult/master/LICENSE">
+    	<a href="https://raw.githubusercontent.com/remult/remult/master/LICENSE" rel="nofollow">
 		<img alt="GitHub license" src="https://img.shields.io/badge/license-MIT-blue.svg">
 	</a>
-	<a href="https://www.npmjs.com/package/remult">
+	<a href="https://www.npmjs.com/package/remult" rel="nofollow">
 		<img alt="npm version" src="https://badge.fury.io/js/remult.svg">
 	</a>
-	<a href="https://www.npmjs.com/package/remult">
+	<a href="https://www.npmjs.com/package/remult" rel="nofollow">
 		<img alt="npm downloads" src="https://img.shields.io/npm/dm/remult">
 	</a>
-	<a href="https://discord.gg/GXHk7ZfuG5">
-		<img alt="chat on discord" src="https://img.shields.io/badge/chat-on%20discord-blueviolet"/>
+	<a href="https://discord.gg/GXHk7ZfuG5" rel="nofollow">
+		<img alt="Join Discord" src="https://badgen.net/discord/online-members/GXHk7ZfuG5?icon=discord&label=Discord"/>
 	</a>
-	<a href="https://twitter.com/remultjs">
-	<img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/remultjs?style=social">
+  <a href="https://twitter.com/intent/tweet?text=Remult%20-%20open-source%20CRUD%20framework%20for%20full-stack%20TypeScript%0A%0A%40remultjs%0A&url=https%3A%2F%2Fgithub.com%2Fremult%2Fremult">
+    <img alt="Twitter URL" src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2Fintent%2Ftweet%3Ftext%3DRemult%2520-%2520open-source%2520CRUD%2520framework%2520for%2520full-stack%2520TypeScript%250A%250A%2540remultjs%250A%26url%3Dhttps%253A%252F%252Fgithub.com%252Fremult%252Fremult">
+  </a>
+	<a href="https://twitter.com/remultjs" rel="nofollow">
+	  <img alt="Twitter Follow" src="https://img.shields.io/twitter/url.svg?label=Follow%20%40remultjs&style=social&url=https%3A%2F%2Ftwitter.com%2FRemultJs">
 	</a>
 </div>
 <hr/>
 
-[Getting Started](#getting-started) | [Documentation](#documentation) | [Example Apps](#example-apps)
+[Getting Started](#getting-started) | [Documentation](#documentation) |
+[Example Apps](#example-apps)
 
 ## What is Remult?
 
-**Remult** is a full-stack CRUD framework that uses your **TypeScript entities as a single source of truth for your API, frontend type-safe API client and backend ORM**.
+**Remult** is a full-stack CRUD framework that uses your **TypeScript entities
+as a single source of truth for your API, frontend type-safe API client and
+backend ORM**.
 
 ### Status
 
-Remult is **production-ready** and, in fact, used in production apps since 2018. However, we’re keeping the major version at zero so we can use community feedback to finalize the v1 API.
+Remult is **production-ready** and, in fact, used in production apps since 2018.
+However, we’re keeping the major version at zero so we can use community
+feedback to finalize the v1 API.
 
 ## Motivation
 
-Full-stack web development is (still) too complicated. **Simple CRUD, a common requirement of any business application, should be simple to build, maintain, and extend** when the need arises.
+Full-stack web development is (still) too complicated. **Simple CRUD, a common
+requirement of any business application, should be simple to build, maintain,
+and extend** when the need arises.
 
-Remult abstracts away repetitive, boilerplate, error-prone, and poorly designed code on the one hand, and enables total flexibility and control on the other. **Remult helps building fullstack apps using only TypeScript code you can easily follow and safely refactor**, and fits nicely into any existing or new project by being minimalistic and completely unopinionated regarding the developer’s choice of other frameworks and tools.
+Remult abstracts away repetitive, boilerplate, error-prone, and poorly designed
+code on the one hand, and enables total flexibility and control on the other.
+**Remult helps building fullstack apps using only TypeScript code you can easily
+follow and safely refactor**, and fits nicely into any existing or new project
+by being minimalistic and completely unopinionated regarding the developer’s
+choice of other frameworks and tools.
 
-Other frameworks tend to fall into either too much abstraction (no-code, low-code, BaaS) or partial abstraction (MVC frameworks, GraphQL, ORMs, API generators, code generators), and tend to be opinionated regarding the development tool-chain, deployment environment, configuration/conventions or DSL. Remult attempts to strike a better balance.
+Other frameworks tend to fall into either too much abstraction (no-code,
+low-code, BaaS) or partial abstraction (MVC frameworks, GraphQL, ORMs, API
+generators, code generators), and tend to be opinionated regarding the
+development tool-chain, deployment environment, configuration/conventions or
+DSL. Remult attempts to strike a better balance.
 
 ## Installation
 
-The *remult* package is one and the same for both the frontend bundle and the backend. Install it once for a monolith project or per-repo in a monorepo.
+The _remult_ package is one and the same for both the frontend bundle and the
+backend. Install it once for a monolith project or per-repo in a monorepo.
 
 ```sh
 npm i remult
@@ -56,17 +76,18 @@ npm i remult
 ## Usage
 
 ### Define model classes
+
 ```ts
 // shared/product.ts
 
-import { Entity, Fields } from 'remult';
+import { Entity, Fields } from "remult";
 
-@Entity('products', {
-    allowApiCrud: true
+@Entity("products", {
+  allowApiCrud: true,
 })
 export class Product {
   @Fields.string()
-  name = '';
+  name = "";
 
   @Fields.number()
   unitPrice = 0;
@@ -74,18 +95,19 @@ export class Product {
 ```
 
 ### Setup API backend using an Express middleware
+
 ```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();
 
 app.use(remultExpress({
-  entities: [Product]
+  entities: [Product],
 }));
 
 app.listen(port, () => {
@@ -94,6 +116,7 @@ app.listen(port, () => {
 ```
 
 ### :rocket: API Ready
+
 ```sh
 > curl http://localhost:3001/api/products
 
@@ -101,24 +124,26 @@ app.listen(port, () => {
 ```
 
 ### Find and manipulate data in type-safe frontend code
+
 ```ts
 // frontend/code.ts
 
-import { Remult } from 'remult';
-import { Product } from '../shared/product';
+import { Remult } from "remult";
+import { Product } from "../shared/product";
 
 const remult = new Remult();
 
 async function increasePriceOfTofu(priceIncrease: number) {
   const productsRepo = remult.repo(Product);
 
-  const product = await productsRepo.findFirst({ name: 'Tofu' }); // filter is passed through API request all the way to the db
+  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
 }
 ```
 
-### ...*exactly* the same way as in backend code
+### ..._exactly_ the same way as in backend code
+
 ```ts
 @BackendMethod({ allowed: Allow.authenticated })
 static async increasePriceOfTofu(priceIncrease: number, remult?: Remult) {
@@ -133,48 +158,51 @@ static async increasePriceOfTofu(priceIncrease: number, remult?: Remult) {
 ### :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
+@Entity("products", {
+  allowApiCrud: true,
 })
 export class Product {
-    @Fields.string({
-        validate: Validators.required
-    })
-    name = '';
-
-    @Fields.string<Product>({
-        validate: product => {
-            if (product.description.trim().length < 50)
-                throw "too short";
-        }
-    })
-    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";
-        }
-    })
-    unitPrice = 0;
+  @Fields.string({
+    validate: Validators.required,
+  })
+  name = "";
+
+  @Fields.string<Product>({
+    validate: (product) => {
+      if (product.description.trim().length < 50) {
+        throw "too short";
+      }
+    },
+  })
+  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";
+      }
+    },
+  })
+  unitPrice = 0;
 }
 ```
 
 ### Enforced in frontend:
+
 ```ts
 const product = productsRepo.create();
 
 try {
   await productsRepo.save(product);
-}
-catch (e: any) {
+} catch (e: any) {
   console.error(e.message); // Browser console will display - "Name: required"
 }
 ```
 
 ### Enforced in backend:
+
 ```sh
 > curl http://localhost:3001/api/products -H "Content-Type: application/json" -d "{""unitPrice"":-1}"
 
@@ -182,58 +210,78 @@ catch (e: any) {
 ```
 
 ### :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
+@Entity<Article>("Articles", {
+  allowApiRead: true,
+  allowApiInsert: (remult) => remult.authenticated(),
+  allowApiUpdate: (remult, article) => article.author.id == remult.user.id,
 })
 export class Article {
-    @Fields.string({ allowApiUpdate: false })
-    slug = '';
-    
-    @Field(() => Profile, { allowApiUpdate: false })
-    author!: Profile;
-
-    @Fields.string()
-    content = '';
+  @Fields.string({ allowApiUpdate: false })
+  slug = "";
+
+  @Field(() => Profile, { allowApiUpdate: false })
+  author!: Profile;
+
+  @Fields.string()
+  content = "";
 }
 ```
 
 ## What about complex CRUD?
 
-While simple CRUD shouldn’t require any backend coding, using Remult means having the ability to handle any complex scenario by controlling the backend in numerous ways:
-
-* Backend computed (read-only) fields - from simple [expressions](https://remult.dev/docs/ref_field.html#serverexpression) to complex data lookups or even direct db access (SQL)
-* Custom side-effects with [entity lifecycle hooks](https://remult.dev/docs/ref_entity.html#saving) (before/after saving/deleting)
-* Backend only updatable fields (e.g. “last updated at”)
-* Many-to-one [relations](https://remult.dev/docs/entity-relations.html) with [lazy/eager loading](https://remult.dev/docs/lazy-loading-of-related-entities.html)
-* Roll-your-own type-safe endpoints with [Backend Methods](https://remult.dev/docs/backendMethods.html)
-* Roll-your-own low-level endpoints (Express, Fastify, koa, others…)
+While simple CRUD shouldn’t require any backend coding, using Remult means
+having the ability to handle any complex scenario by controlling the backend in
+numerous ways:
+
+- Backend computed (read-only) fields - from simple
+  [expressions](https://remult.dev/docs/ref_field.html#serverexpression) to
+  complex data lookups or even direct db access (SQL)
+- Custom side-effects with
+  [entity lifecycle hooks](https://remult.dev/docs/ref_entity.html#saving)
+  (before/after saving/deleting)
+- Backend only updatable fields (e.g. “last updated at”)
+- Many-to-one [relations](https://remult.dev/docs/entity-relations.html) with
+  [lazy/eager loading](https://remult.dev/docs/lazy-loading-of-related-entities.html)
+- Roll-your-own type-safe endpoints with
+  [Backend Methods](https://remult.dev/docs/backendMethods.html)
+- Roll-your-own low-level endpoints (Express, Fastify, koa, others…)
 
 ## Getting started
-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/)
-* [Tutorial with Vue](https://remult.dev/tutorials/vue/)
-* [Tutorial with Next.js](https://remult.dev/tutorials/react-next/)
+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/)
+- [Tutorial with Vue](https://remult.dev/tutorials/vue/)
+- [Tutorial with Next.js](https://remult.dev/tutorials/react-next/)
 
 ## Documentation
-The [documentation](https://remult.dev/docs) covers the main features of Remult. However, it is still a work-in-progress.
+
+The [documentation](https://remult.dev/docs) covers the main features of Remult.
+However, it is still a work-in-progress.
 
 ## Example Apps
 
-* Fullstack TodoMVC example with React and Express. ([Source code](https://github.com/remult/TodoMVC-eample) | [CodeSandbox](https://codesandbox.io/s/github/remult/TodoMVC-example?file=/src/frontend/App.tsx))
+- Fullstack TodoMVC example with React and Express.
+  ([Source code](https://github.com/remult/TodoMVC-eample) |
+  [CodeSandbox](https://codesandbox.io/s/github/remult/TodoMVC-example?file=/src/frontend/App.tsx))
 
-* [CRM demo](https://github.com/remult/crm-demo) with a React + [MUI](https://mui.com) front-end and Postgres database.
+- [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.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.
+- :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/esm/src/remult3/RepositoryImplementation.d.ts

@@ -309,8 +309,8 @@ export declare class EntityBase {
     get $(): FieldsRef<this>;
 }
 export declare class ControllerBase {
-    protected remult: Remult;
-    constructor(remult: Remult);
+    protected remult?: Remult;
+    constructor(remult?: Remult);
     assign(values: Partial<Omit<this, keyof EntityBase>>): this;
     get $(): FieldsRef<this>;
     get _(): ControllerRef<this>;

package/esm/src/remult3/RepositoryImplementation.js

@@ -1673,8 +1673,8 @@ export class ControllerBase {
         assign(this, values);
         return this;
     }
-    get $() { return getFields(this); }
-    get _() { return getControllerRef(this); }
+    get $() { return getFields(this, this.remult); }
+    get _() { return getControllerRef(this, this.remult); }
 }
 class QueryResultImpl {
     constructor(options, repo) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "0.16.2",
+    "version": "0.16.3-exp.0",
     "description": "A CRUD framework for full-stack TypeScript",
     "main": "index.js",
     "types": "index.d.ts",

package/src/remult3/RepositoryImplementation.d.ts

@@ -309,8 +309,8 @@ export declare class EntityBase {
     get $(): FieldsRef<this>;
 }
 export declare class ControllerBase {
-    protected remult: Remult;
-    constructor(remult: Remult);
+    protected remult?: Remult;
+    constructor(remult?: Remult);
     assign(values: Partial<Omit<this, keyof EntityBase>>): this;
     get $(): FieldsRef<this>;
     get _(): ControllerRef<this>;

package/src/remult3/RepositoryImplementation.js

@@ -2745,12 +2745,12 @@ var ControllerBase = /** @class */ (function () {
         return this;
     };
     Object.defineProperty(ControllerBase.prototype, "$", {
-        get: function () { return getFields(this); },
+        get: function () { return getFields(this, this.remult); },
         enumerable: false,
         configurable: true
     });
     Object.defineProperty(ControllerBase.prototype, "_", {
-        get: function () { return getControllerRef(this); },
+        get: function () { return getControllerRef(this, this.remult); },
         enumerable: false,
         configurable: true
     });