@yrest/cli 0.9.0 → 0.11.0

package/dist/index.d.mts

@@ -4,6 +4,48 @@ import * as http from 'http';
 
 /** A single REST resource item. Field names and value types are user-defined in the YAML file. */
 type Resource = Record<string, unknown>;
+/**
+ * Descriptor for a single field declared in the `_schema` block.
+ *
+ * All properties are optional — omit what you don't need. Fields not mentioned
+ * in `_schema` are inferred from the collection data and treated as optional.
+ *
+ * Shorthand: `fieldName: required` normalises to `{ required: true }`.
+ */
+type FieldDef = {
+    /** If `true`, the field is listed in the OpenAPI `required` array and (Phase B) validated on POST/PUT. */
+    required?: boolean;
+    /** Explicit type override. If absent, inferred from the data. */
+    type?: "string" | "integer" | "number" | "boolean" | "object" | "array";
+    /** OpenAPI `format` hint (e.g. `email`, `date`, `uuid`, `uri`, `date-time`). */
+    format?: string;
+    /** Restricts the field to a fixed set of values. */
+    enum?: unknown[];
+    /** Human-readable description included in the OpenAPI spec. */
+    description?: string;
+    /** Default value included in the OpenAPI spec. */
+    default?: unknown;
+};
+/**
+ * Field-level schema declarations for one or more collections, parsed from `_schema` in the YAML.
+ *
+ * - Outer key: collection name.
+ * - Inner key: field name within that collection.
+ * - Value: {@link FieldDef} descriptor (or the string shorthand `"required"` / `"optional"`).
+ *
+ * @example
+ * ```yaml
+ * _schema:
+ *   users:
+ *     name: required          # shorthand
+ *     email:
+ *       required: true
+ *       format: email
+ *     age:
+ *       type: integer
+ * ```
+ */
+type SchemaBlock = Record<string, Record<string, FieldDef>>;
 /**
  * The full in-memory database.
  * Keys are collection names (e.g. `"users"`); values are arrays of {@link Resource} items.
@@ -38,11 +80,17 @@ type Data = Record<string, Resource[]>;
 type RelationDef = {
     type: "many2one";
     target: string;
+    foreignKey?: string;
     nested?: boolean;
+    carDirect?: string;
+    carInverse?: string;
 } | {
     type: "one2one";
     target: string;
+    foreignKey?: string;
     nested?: boolean;
+    carDirect?: string;
+    carInverse?: string;
 } | {
     type: "many2many";
     target: string;
@@ -50,6 +98,8 @@ type RelationDef = {
     foreignKey: string;
     otherKey: string;
     nested?: boolean;
+    carDirect?: string;
+    carInverse?: string;
 };
 /**
  * Relational mappings declared under `_rel` in the YAML file, normalised to {@link RelationDef}.
@@ -180,6 +230,8 @@ interface YrestStorage {
     getData(): Data;
     /** Returns the relational mappings declared under `_rel`. */
     getRelations(): Relations;
+    /** Returns the field-level schema declarations from `_schema`, or `{}` if absent. */
+    getSchema(): SchemaBlock;
     /**
      * Returns the items in a named collection, or `undefined` if it does not exist.
      *
@@ -481,16 +533,6 @@ type YrestServerOptions = YrestServerBaseOptions & ({
  */
 declare function createYrestServer(options: YrestServerOptions): YrestServer;
 
-/**
- * Creates a {@link YrestStorage} instance backed by the given YAML file.
- *
- * The file is read and parsed eagerly on construction. The `_rel` key is
- * extracted as relational metadata; `_routes` as custom route declarations;
- * all other top-level keys become collections.
- *
- * @param filePath - Relative or absolute path to the YAML database file.
- * @throws {Error} If the file cannot be read or its YAML is invalid.
- */
 declare function createYrestStorage(filePath: string): YrestStorage;
 
 export { type CustomRoute, type Data, type Handler, type HandlerMap, type HandlerRequest, type HandlerResponse, type Relations, type Resource, type YrestOptions, type YrestServer, type YrestServerBaseOptions, type YrestServerOptions, type YrestStorage, createServer, createYrestServer, createYrestServerFromStorage, createYrestStorage, yrest, yrestOptionsSchema };

package/dist/index.d.ts

@@ -4,6 +4,48 @@ import * as http from 'http';
 
 /** A single REST resource item. Field names and value types are user-defined in the YAML file. */
 type Resource = Record<string, unknown>;
+/**
+ * Descriptor for a single field declared in the `_schema` block.
+ *
+ * All properties are optional — omit what you don't need. Fields not mentioned
+ * in `_schema` are inferred from the collection data and treated as optional.
+ *
+ * Shorthand: `fieldName: required` normalises to `{ required: true }`.
+ */
+type FieldDef = {
+    /** If `true`, the field is listed in the OpenAPI `required` array and (Phase B) validated on POST/PUT. */
+    required?: boolean;
+    /** Explicit type override. If absent, inferred from the data. */
+    type?: "string" | "integer" | "number" | "boolean" | "object" | "array";
+    /** OpenAPI `format` hint (e.g. `email`, `date`, `uuid`, `uri`, `date-time`). */
+    format?: string;
+    /** Restricts the field to a fixed set of values. */
+    enum?: unknown[];
+    /** Human-readable description included in the OpenAPI spec. */
+    description?: string;
+    /** Default value included in the OpenAPI spec. */
+    default?: unknown;
+};
+/**
+ * Field-level schema declarations for one or more collections, parsed from `_schema` in the YAML.
+ *
+ * - Outer key: collection name.
+ * - Inner key: field name within that collection.
+ * - Value: {@link FieldDef} descriptor (or the string shorthand `"required"` / `"optional"`).
+ *
+ * @example
+ * ```yaml
+ * _schema:
+ *   users:
+ *     name: required          # shorthand
+ *     email:
+ *       required: true
+ *       format: email
+ *     age:
+ *       type: integer
+ * ```
+ */
+type SchemaBlock = Record<string, Record<string, FieldDef>>;
 /**
  * The full in-memory database.
  * Keys are collection names (e.g. `"users"`); values are arrays of {@link Resource} items.
@@ -38,11 +80,17 @@ type Data = Record<string, Resource[]>;
 type RelationDef = {
     type: "many2one";
     target: string;
+    foreignKey?: string;
     nested?: boolean;
+    carDirect?: string;
+    carInverse?: string;
 } | {
     type: "one2one";
     target: string;
+    foreignKey?: string;
     nested?: boolean;
+    carDirect?: string;
+    carInverse?: string;
 } | {
     type: "many2many";
     target: string;
@@ -50,6 +98,8 @@ type RelationDef = {
     foreignKey: string;
     otherKey: string;
     nested?: boolean;
+    carDirect?: string;
+    carInverse?: string;
 };
 /**
  * Relational mappings declared under `_rel` in the YAML file, normalised to {@link RelationDef}.
@@ -180,6 +230,8 @@ interface YrestStorage {
     getData(): Data;
     /** Returns the relational mappings declared under `_rel`. */
     getRelations(): Relations;
+    /** Returns the field-level schema declarations from `_schema`, or `{}` if absent. */
+    getSchema(): SchemaBlock;
     /**
      * Returns the items in a named collection, or `undefined` if it does not exist.
      *
@@ -481,16 +533,6 @@ type YrestServerOptions = YrestServerBaseOptions & ({
  */
 declare function createYrestServer(options: YrestServerOptions): YrestServer;
 
-/**
- * Creates a {@link YrestStorage} instance backed by the given YAML file.
- *
- * The file is read and parsed eagerly on construction. The `_rel` key is
- * extracted as relational metadata; `_routes` as custom route declarations;
- * all other top-level keys become collections.
- *
- * @param filePath - Relative or absolute path to the YAML database file.
- * @throws {Error} If the file cannot be read or its YAML is invalid.
- */
 declare function createYrestStorage(filePath: string): YrestStorage;
 
 export { type CustomRoute, type Data, type Handler, type HandlerMap, type HandlerRequest, type HandlerResponse, type Relations, type Resource, type YrestOptions, type YrestServer, type YrestServerBaseOptions, type YrestServerOptions, type YrestStorage, createServer, createYrestServer, createYrestServerFromStorage, createYrestStorage, yrest, yrestOptionsSchema };