remult 0.23.0-exp.3 → 0.23.0-exp.5

package/README.md

@@ -1,31 +1,48 @@
 <div align="center">
   <a href="http://remult.dev/">
-    <img src="https://github.com/remult/remult/raw/master/docs/public/logo.png" width="140" height="140">
+    <img
+      src="https://github.com/remult/remult/raw/master/docs/public/logo.png"
+      width="140"
+      height="140"
+    />
   </a>
   <h1>Remult</h1>
   <p>Full-stack CRUD, simplified, with SSOT TypeScript entities</p>
-	<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" 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" 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" rel="nofollow">
-		<img alt="npm version" src="https://badge.fury.io/js/remult.svg">
-	</a>
-	<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" rel="nofollow">
-		<img alt="Join Discord" src="https://badgen.net/discord/online-members/GXHk7ZfuG5?icon=discord&label=Discord"/>
-	</a>
+  <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" 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"
+    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" rel="nofollow">
+    <img alt="npm version" src="https://badge.fury.io/js/remult.svg" />
+  </a>
+  <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" rel="nofollow">
+    <img
+      alt="Join Discord"
+      src="https://badgen.net/discord/online-members/GXHk7ZfuG5?icon=discord&label=Discord"
+    />
   </a>
 </div>
 
-<br/>
+<br />
 
 <div align="center">
   <a href="#getting-started">Getting Started</a> |
@@ -33,12 +50,15 @@
   <a href="#example-apps">Example Apps</a>
 </div>
 
-<hr/>
-<br/>
+<hr />
+<br />
 
 <a href="https://www.youtube.com/watch?v=rEoScmSVNUE" target="_blank">
   <p align="center">
-    <img src="https://github.com/remult/remult/raw/master/static/images/video-thumbnail.jpg" alt="Video thumbnail"  />
+    <img
+      src="https://github.com/remult/remult/raw/master/static/images/video-thumbnail.jpg"
+      alt="Video thumbnail"
+    />
   </p>
 </a>
 
@@ -101,14 +121,14 @@ npm i remult
 ```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
@@ -120,17 +140,17 @@ 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()
 
 app.use(
   remultExpress({
-    entities: [Product]
-  })
+    entities: [Product],
+  }),
 )
 
 app.listen(port, () => {
@@ -151,13 +171,13 @@ 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 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
 }
@@ -179,32 +199,32 @@ 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
+@Entity('products', {
+  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
 }
@@ -233,20 +253,20 @@ try {
 ### :lock: Secure the API with fine-grained authorization
 
 ```ts
-@Entity<Article>("Articles", {
+@Entity<Article>('Articles', {
   allowApiRead: true,
   allowApiInsert: (_, remult) => remult.authenticated(),
-  allowApiUpdate: (article, remult) => article.author.id == remult.user.id
+  allowApiUpdate: (article, remult) => article.author.id == remult.user.id,
 })
 export class Article {
   @Fields.string({ allowApiUpdate: false })
-  slug = ""
+  slug = ''
 
   @Field(() => Profile, { allowApiUpdate: false })
   author!: Profile
 
   @Fields.string()
-  content = ""
+  content = ''
 }
 ```
 

package/esm/src/entity.js

@@ -1 +1,2 @@
 export {};
+//[ ]  make lazy only on field and not in Field Options

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "0.23.0-exp.3",
+    "version": "0.23.0-exp.5",
     "description": "A CRUD framework for full-stack TypeScript",
     "types": "index.d.ts",
     "module": "esm/index.js",

package/src/entity.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//[ ]  make lazy only on field and not in Field Options