@laboratoria/sdk-js 3.4.0 → 4.0.0-alpha.0

package/README.md

@@ -45,6 +45,63 @@ app.auth.signIn(email, password);
 app.auth.signOut();
 ```
 
+### Models
+
+The `app` object exposes data models used to access data. Each model represents
+a _type_ of object, which is stored in a database table.
+
+All models have the following methods and properties.
+
+#### CRUD methods
+
+* `create`
+* `delete`
+* `findById`
+* `findMany`
+* `update`
+* `upsert`
+
+#### Other methods
+
+* `parse`
+* `stats`
+* `validate`
+* `validateAttr`
+
+#### Properties
+
+* `relations`
+* `schema`
+
+### Model Schema
+
+Each _model_ has a _schema_ (`model.schema`) that describes the _shape_ of the
+data, what properties (columns) it has, what data types these columns are,
+whether they are _required_ or not, etc.
+
+The `model.schema` is an object with the following properties:
+
+* `inputProps`: An array listing properties to be taken into account when
+  building input UI or sending data (via `model.create`, `model.update`, etc).
+* `primaryKey`: Primary key in the underlying table.
+* `properties`: An object with the model properties. Each property is described
+  by an object having the following keys:
+  - `type`: It can be: `boolean`, `integer`, `string`, `date` o una referncia a
+    un modelo, en cuyo caso el string será el nombre del modelo de prisma.
+  - `default`
+  - `enum`
+  - `format`: `date-time`
+  - `$ref`
+  - `anyOf`
+  - `items`
+  - `inputType`
+  - `isRequired`
+  - `isScalar`
+  - `isRef`
+* `type`: The schema for the whole model will always be of type `object`.
+
+***
+
 ### Users
 
 ```js