@acodeninja/persist 3.0.0-next.26 → 3.0.0-next.28

package/src/Schema.js

@@ -14,7 +14,7 @@ class Schema {
      * It uses AJV for the validation process and integrates with model types and their specific validation rules.
      *
      * @param {Object|Model} rawSchema - The raw schema or model definition to be compiled.
-     * @returns {CompiledSchema} - A class that extends `CompiledSchema`, with the compiled schema and validator attached.
+     * @returns {CompiledSchema} - A compiled schema, ready to validate instances of the model.
      *
      * @example
      * const schemaClass = Schema.compile(MyModelSchema);
@@ -39,7 +39,7 @@ class Schema {
             const thisSchema = {};
 
             if (Model.isModel(schemaSegment)) {
-                thisSchema.required = ['id'];
+                thisSchema.required = [];
                 thisSchema.type = 'object';
                 thisSchema.additionalProperties = false;
                 thisSchema.properties = {
@@ -62,7 +62,7 @@ class Schema {
                         thisSchema.properties[name] = {
                             type: 'object',
                             additionalProperties: false,
-                            required: ['id'],
+                            required: [],
                             properties: {
                                 id: {
                                     type: 'string',

package/src/data/Model.js

@@ -151,6 +151,8 @@ class Model {
      * @static
      */
     static get required() {
+        const ThisModel = this;
+
         /**
          * A subclass of the current model with the `_required` flag set to `true`.
          * Used to indicate that the property is required during validation or schema generation.
@@ -159,11 +161,11 @@ class Model {
          * @extends {Model}
          * @private
          */
-        class Required extends this {
+        class Required extends ThisModel {
             static _required = true;
         }
 
-        Object.defineProperty(Required, 'name', {value: `${this.toString()}`});
+        Object.defineProperty(Required, 'name', {value: ThisModel.name});
 
         return Required;
     }
@@ -192,11 +194,17 @@ class Model {
      */
     static indexedPropertiesResolved() {
         return [
-            ...Object.entries(this)
-                .filter(([_name, type]) => !type._type && (this.isModel(type) || this.isModel(type())))
+            ...Object.entries(this.properties)
+                .filter(([name, type]) => !['indexedProperties', 'searchProperties'].includes(name) && !type._type && (this.isModel(type) || (typeof type === 'function' && this.isModel(type()))))
                 .map(([name, _type]) => `${name}.id`),
-            ...Object.entries(this)
-                .filter(([_name, type]) => !type._type && !this.isModel(type) && !type._items?._type && (this.isModel(type._items) || this.isModel(type()._items)))
+            ...Object.entries(this.properties)
+                .filter(([_name, type]) => {
+                    return !Model.isModel(type) && (
+                        (type._type === 'array' && this.isModel(type._items))
+                        ||
+                        (!type._type && typeof type === 'function' && this.isModel(type()._items))
+                    );
+                })
                 .map(([name, _type]) => `${name}.[*].id`),
             ...this.indexedProperties(),
             'id',
@@ -285,16 +293,62 @@ class Model {
      * @static
      *
      * @example
-     * export default class TestModel {
+     * export default class TestModel extends Model {
      *     static {
-     *         this.withName('TestModel');
-     *         this.string = Persist.Type.String;
+     *         TestModel.withName('TestModel');
+     *         TestModel.string = Persist.Property.String;
      *     }
      * }
      */
     static withName(name) {
         Object.defineProperty(this, 'name', {value: name});
     }
+
+    /**
+     * Discover model properties all the way up the prototype chain.
+     *
+     * @return {Model}
+     */
+    static get properties() {
+        const modelClass = this;
+        const props = {};
+        const chain = [];
+
+        let current = modelClass;
+        while (current !== Function.prototype) {
+            chain.push(current);
+            current = Object.getPrototypeOf(current);
+        }
+
+        for (const item of chain) {
+            for (const property of Object.getOwnPropertyNames(item)) {
+                if (
+                    [
+                        '_required',
+                        'fromData',
+                        'indexedProperties',
+                        'indexedPropertiesResolved',
+                        'isDryModel',
+                        'isModel',
+                        'length',
+                        'name',
+                        'properties',
+                        'prototype',
+                        'required',
+                        'searchProperties',
+                        'toString',
+                        'withName',
+                    ].includes(property)
+                ) continue;
+
+                if (Object.keys(props).includes(property)) continue;
+
+                props[property] = item[property];
+            }
+        }
+
+        return Object.assign(modelClass, props);
+    }
 }
 
 export default Model;

package/src/data/Property.js

@@ -5,6 +5,7 @@ import DateType from './properties/DateType.js';
 import NumberType from './properties/NumberType.js';
 import SlugType from './properties/SlugType.js';
 import StringType from './properties/StringType.js';
+import Type from './properties/Type.js';
 
 const Property = {
     Array: ArrayType,
@@ -14,6 +15,7 @@ const Property = {
     Number: NumberType,
     Slug: SlugType,
     String: StringType,
+    Type,
 };
 
 export default Property;

package/src/data/properties/ArrayType.js

@@ -51,12 +51,14 @@ class ArrayType {
              * const requiredArrayOfStrings = ArrayType.of(StringType).required;
              */
             static get required() {
+                const ThisType = this;
+
                 /**
                  * @class RequiredArrayOf
                  * @extends ArrayOf
                  * Represents a required array of a specific type.
                  */
-                class Required extends this {
+                class Required extends ThisType {
                     /** @type {boolean} Indicates that the array is required */
                     static _required = true;
 
@@ -70,7 +72,7 @@ class ArrayType {
                     }
                 }
 
-                Object.defineProperty(Required, 'name', {value: `Required${this.toString()}`});
+                Object.defineProperty(Required, 'name', {value: `Required${ThisType.name}`});
 
                 return Required;
             }

package/src/data/properties/BooleanType.js

@@ -15,9 +15,9 @@ class BooleanType extends Type {
          * @static
          * @property {string} _type - The type identifier for BooleanType, set to `'boolean'`.
          */
-        this._type = 'boolean';
+        BooleanType._type = 'boolean';
 
-        Object.defineProperty(this, 'name', {value: 'Boolean'});
+        Object.defineProperty(BooleanType, 'name', {value: 'Boolean'});
     }
 }
 

package/src/data/properties/CustomType.js

@@ -37,12 +37,12 @@ class CustomType {
         class Custom extends Type {
             static {
                 /** @type {string} The data type, which is 'object' */
-                this._type = 'object';
+                Custom._type = 'object';
 
                 /** @type {Object} The JSON schema that defines the structure and validation rules */
-                this._schema = schema;
+                Custom._schema = schema;
 
-                Object.defineProperty(this, 'name', {value: 'Custom'});
+                Object.defineProperty(Custom, 'name', {value: 'Custom'});
             }
         }
 
@@ -50,7 +50,7 @@ class CustomType {
     }
 
     static {
-        Object.defineProperty(this, 'name', {value: 'Custom'});
+        Object.defineProperty(CustomType, 'name', {value: 'Custom'});
     }
 }
 

package/src/data/properties/DateType.js

@@ -15,15 +15,15 @@ class DateType extends Type {
          * @static
          * @property {string} _type - The type identifier for DateType, set to `'string'`.
          */
-        this._type = 'string';
+        DateType._type = 'string';
 
         /**
          * @static
          * @property {string} _format - The format for DateType, set to `'iso-date-time'`.
          */
-        this._format = 'iso-date-time';
+        DateType._format = 'iso-date-time';
 
-        Object.defineProperty(this, 'name', {value: 'Date'});
+        Object.defineProperty(DateType, 'name', {value: 'Date'});
     }
 
     /**

package/src/data/properties/NumberType.js

@@ -15,9 +15,9 @@ class NumberType extends Type {
          * @static
          * @property {string} _type - The type identifier for NumberType, set to `'number'`.
          */
-        this._type = 'number';
+        NumberType._type = 'number';
 
-        Object.defineProperty(this, 'name', {value: 'Number'});
+        Object.defineProperty(NumberType, 'name', {value: 'Number'});
     }
 }
 

package/src/data/properties/SlugType.js

@@ -65,7 +65,7 @@ class SlugType extends ResolvedType {
     }
 
     static {
-        Object.defineProperty(this, 'name', {value: 'Slug'});
+        Object.defineProperty(SlugType, 'name', {value: 'Slug'});
     }
 }
 

package/src/data/properties/StringType.js

@@ -15,9 +15,9 @@ class StringType extends Type {
          * @static
          * @property {string} _type - The type identifier for the string type.
          */
-        this._type = 'string';
+        StringType._type = 'string';
 
-        Object.defineProperty(this, 'name', {value: 'String'});
+        Object.defineProperty(StringType, 'name', {value: 'String'});
     }
 }
 

package/src/data/properties/Type.js

@@ -53,6 +53,8 @@ class Type {
      * @returns {Type} A subclass of the current type with `_required` set to `true`.
      */
     static get required() {
+        const ThisType = this;
+
         /**
          * A subclass of the current type with the `_required` flag set to `true`.
          * Used to indicate that the property is required during validation or schema generation.
@@ -61,18 +63,18 @@ class Type {
          * @extends {Type}
          * @private
          */
-        class Required extends this {
+        class Required extends ThisType {
             static _required = true;
         }
 
         // Define the class name as "Required<OriginalTypeName>"
-        Object.defineProperty(Required, 'name', {value: `Required${this.toString()}`});
+        Object.defineProperty(Required, 'name', {value: `Required${ThisType.name}`});
 
         return Required;
     }
 
     static {
-        Object.defineProperty(this, 'name', {value: 'Type'});
+        Object.defineProperty(Type, 'name', {value: 'Type'});
     }
 }
 

package/src/engine/storage/StorageEngine.js

@@ -132,7 +132,9 @@ export class ModelNotFoundStorageEngineError extends StorageEngineError {
 export class DeleteHasUnintendedConsequencesStorageEngineError extends StorageEngineError {
     /**
      * @param {string} modelId
-     * @param {object} consequences
+     * @param {Object} consequences
+     * @param {Array<String>?} consequences.willDelete
+     * @param {Array<String>?} consequences.willUpdate
      */
     constructor(modelId, consequences) {
         super(`Deleting ${modelId} has unintended consequences`);