@yrest/cli 0.13.0 → 0.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -8,14 +8,17 @@
8
8
  [![npm downloads](https://img.shields.io/npm/dw/@yrest/cli)](https://www.npmjs.com/package/@yrest/cli)
9
9
  [![license](https://img.shields.io/npm/l/@yrest/cli)](LICENSE)
10
10
  [![CI](https://github.com/aggiovato/yRest/actions/workflows/ci.yml/badge.svg)](https://github.com/aggiovato/yRest/actions)
11
+ [![Netlify Status](https://api.netlify.com/api/v1/badges/cca9b352-b564-4027-a05d-af26728c8ac3/deploy-status)](https://app.netlify.com/projects/cca9b352-b564-4027-a05d-af26728c8ac3/deploys)
11
12
  [![Node](https://img.shields.io/node/v/@yrest/cli)](https://www.npmjs.com/package/@yrest/cli)
12
13
  [![TypeScript](https://img.shields.io/badge/TypeScript-ready-blue)](https://www.typescriptlang.org/)
13
- [![Socket](https://badge.socket.dev/npm/package/@yrest/cli/0.13.0)](https://socket.dev/npm/package/@yrest/cli)
14
+ [![Socket](https://badge.socket.dev/npm/package/@yrest/cli/0.13.1)](https://socket.dev/npm/package/@yrest/cli)
14
15
 
15
16
  YAML-powered json-server alternative. Zero-config REST API mock server with full CRUD, relations, filters and snapshots from a `db.yml` file.
16
17
 
17
18
  > Think `json-server`, but powered by YAML — with relations, filters, pagination, nested routes, snapshots and custom handlers.
18
19
 
20
+ **[📖 Full documentation](https://yrest-docs.netlify.app)** — Getting Started, CLI reference, YAML format, relations, custom routes, SSE streams, playground and more.
21
+
19
22
  ```yaml
20
23
  # db.yml
21
24
  users:
package/dist/index.d.mts CHANGED
@@ -105,10 +105,10 @@ type FieldDef = {
105
105
  * users:
106
106
  * name: required # shorthand
107
107
  * email:
108
- * required: true
109
- * format: email
108
+ * _required: true
109
+ * _format: email
110
110
  * age:
111
- * type: integer
111
+ * _type: integer
112
112
  * ```
113
113
  */
114
114
  type SchemaBlock = Record<string, Record<string, FieldDef>>;
package/dist/index.d.ts CHANGED
@@ -105,10 +105,10 @@ type FieldDef = {
105
105
  * users:
106
106
  * name: required # shorthand
107
107
  * email:
108
- * required: true
109
- * format: email
108
+ * _required: true
109
+ * _format: email
110
110
  * age:
111
- * type: integer
111
+ * _type: integer
112
112
  * ```
113
113
  */
114
114
  type SchemaBlock = Record<string, Record<string, FieldDef>>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yrest/cli",
3
- "version": "0.13.0",
3
+ "version": "0.13.1",
4
4
  "description": "YAML-powered json-server alternative. Zero-config REST API mock server with full CRUD, relations, filters and snapshots from a db.yml file.",
5
5
  "keywords": [
6
6
  "yrest",