@acodeninja/persist 3.0.0-next.1 → 3.0.0-next.2

package/jest.config.cjs

@@ -0,0 +1,26 @@
+/** @type {import('jest').Config} */
+const config = {
+    coveragePathIgnorePatterns: [
+        'node_modules',
+        'test/fixtures',
+        'test/mocks',
+        'test/scripts',
+    ],
+    coverageThreshold: {
+        global: {
+            branches: 100,
+            functions: 100,
+            lines: 100,
+            statements: 100,
+        },
+    },
+    testMatch: [
+        '**/*.test.js',
+    ],
+    watchPathIgnorePatterns: [
+        'coverage/',
+        'test/fixtures/minified',
+    ],
+};
+
+module.exports = config;

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@acodeninja/persist",
-  "version": "3.0.0-next.1",
+  "version": "3.0.0-next.2",
   "description": "A JSON based data modelling and persistence module with alternate storage mechanisms.",
   "type": "module",
   "scripts": {
-    "test": "ava",
-    "test:watch": "ava --watch",
-    "test:coverage": "c8 --experimental-monocart --100 --reporter=console-details ava",
-    "test:coverage:report": "c8 --experimental-monocart --100 --lcov --reporter=console-details --reporter=v8 ava",
+    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest",
+    "test:watch": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest --watch",
+    "test:coverage": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest --collect-coverage",
     "lint": "eslint ./",
     "prepare": "husky"
   },
@@ -38,14 +37,12 @@
     "@commitlint/cli": "^19.6.1",
     "@commitlint/config-conventional": "^19.6.0",
     "@eslint/js": "^9.19.0",
+    "@jest/globals": "^29.7.0",
     "@semantic-release/commit-analyzer": "^13.0.1",
-    "ava": "^6.2.0",
-    "c8": "^10.1.3",
     "eslint": "^9.19.0",
     "globals": "^15.14.0",
     "husky": "^9.1.7",
-    "monocart-coverage-reports": "^2.12.0",
-    "semantic-release": "^24.2.1",
-    "sinon": "^19.0.2"
+    "jest": "^29.7.0",
+    "semantic-release": "^24.2.1"
   }
 }

package/src/Query.js

@@ -69,10 +69,10 @@ class Query {
      *
      * @private
      * @param {*} subject - The subject to be matched.
-     * @param {Object} [inputQuery=this.query] - The query to match against. Defaults to `this.query` if not provided.
+     * @param {Object} inputQuery - The query to match against.
      * @returns {boolean} True if the subject matches the query, otherwise false.
      */
-    _matchesQuery(subject, inputQuery = this.query) {
+    _matchesQuery(subject, inputQuery) {
         if (['string', 'number', 'boolean'].includes(typeof inputQuery)) return subject === inputQuery;
 
         if (inputQuery?.$is !== undefined && subject === inputQuery.$is) return true;

package/src/engine/StorageEngine.js

@@ -0,0 +1,250 @@
+import Type from '../type/index.js';
+import _ from 'lodash';
+
+export default class StorageEngine {
+    /**
+     * @param {Object} configuration
+     * @param {Array<Type.Model.constructor>?} models
+     */
+    constructor(configuration = {}, models = null) {
+        this.configuration = configuration;
+        this.models = Object.fromEntries((models ?? []).map(model => [model.name, model]));
+    }
+
+    /**
+     * Persists a model if it has changed, and updates all related models and their indexes
+     * @param {Type.Model} model
+     * @return {Promise<void>}
+     */
+    async put(model) {
+        const processedModels = [];
+        const modelsToPut = [];
+        const modelsToReindex = {};
+
+        /**
+         * @param {Type.Model} modelToProcess
+         * @return {Promise<void>}
+         */
+        const processModel = async (modelToProcess) => {
+            if (processedModels.includes(modelToProcess.id)) return;
+
+            processedModels.push(modelToProcess.id);
+
+            if (!Object.keys(this.models).includes(modelToProcess.constructor.name)) throw new ModelNotRegisteredStorageEngineError(modelToProcess, this);
+
+            modelToProcess.validate();
+            const currentModel = await this.get(modelToProcess.id).catch(() => null);
+
+            const modelToProcessHasChanged = (JSON.stringify(currentModel?.toData() || {}) !== JSON.stringify(modelToProcess.toData()));
+
+            if (modelToProcessHasChanged) modelsToPut.push(modelToProcess);
+
+            if (
+                Boolean(modelToProcess.constructor.indexedProperties().length) &&
+                this._indexedFieldsHaveChanged(currentModel, modelToProcess)
+            ) {
+                const modelToProcessConstructor = this.getModelConstructorFromId(modelToProcess.id);
+                modelsToReindex[modelToProcessConstructor] = modelsToReindex[modelToProcessConstructor] || [];
+                modelsToReindex[modelToProcessConstructor].push(modelToProcess);
+            }
+
+            for (const [field, value] of Object.entries(modelToProcess)) {
+                if (Type.Model.isModel(value)) {
+                    await processModel(modelToProcess[field]);
+                }
+            }
+        };
+
+        await processModel(model);
+
+        await Promise.all(modelsToPut.map(m => this._putModel(m.toData())));
+        await Promise.all(Object.entries(modelsToReindex).map(async ([constructor, models]) => {
+            const modelConstructor = this.models[constructor];
+            const index = await this._getIndex(modelConstructor);
+
+            await this._putIndex(modelConstructor, {
+                ...index || {},
+                ...Object.fromEntries(models.map(m => [m.id, m.toIndexData()])),
+            });
+        }));
+    }
+
+    /**
+     * Decide if two models indexable fields have changed
+     * @param {Type.Model} currentModel
+     * @param {Type.Model} modelToProcess
+     * @return {boolean}
+     * @private
+     */
+    _indexedFieldsHaveChanged(currentModel, modelToProcess) {
+        return !currentModel || Boolean(
+            modelToProcess.constructor.indexedProperties()
+                .filter(field => JSON.stringify(_.get(currentModel, field)) !== JSON.stringify(_.get(modelToProcess, field)))
+                .length,
+        );
+    }
+
+    /**
+     * Get a model by its id
+     * @param {string} modelId
+     * @return {Promise<void>}
+     */
+    get(modelId) {
+        try {
+            this.getModelConstructorFromId(modelId);
+        } catch (e) {
+            return Promise.reject(e);
+        }
+        return this._getModel(modelId);
+    }
+
+    /**
+     * Get the model constructor from a model id
+     * @param {string} modelId
+     * @return {Model.constructor}
+     */
+    getModelConstructorFromId(modelId) {
+        const modelName = modelId.split('/')[0];
+        const constructor = this.models[modelName];
+
+        if (!constructor) throw new ModelNotRegisteredStorageEngineError(modelName, this);
+
+        return constructor;
+    }
+
+    /**
+     * Get model classes that are directly linked to the given model in either direction
+     * @param {Type.Model.constructor} model
+     * @return {Record<string, Record<string, Type.Model.constructor>>}
+     */
+    getLinksFor(model) {
+        return Object.fromEntries(
+            Object.entries(this.getAllModelLinks())
+                .filter(([modelName, links]) =>
+                    model.name === modelName ||
+                    Object.values(links).some((link) => link.name === model.name),
+                ),
+        );
+    }
+
+    /**
+     * Get all model links
+     * @return {Record<string, Record<string, Type.Model.constructor>>}
+     */
+    getAllModelLinks() {
+        return Object.entries(this.models)
+            .map(([registeredModelName, registeredModelClass]) =>
+                Object.entries(registeredModelClass)
+                    .map(([propertyName, propertyType]) => [
+                        registeredModelName,
+                        propertyName,
+                        typeof propertyType === 'function' && !Type.Model.isModel(propertyType) ? propertyType() : propertyType,
+                    ])
+                    .filter(([_m, _p, type]) => Type.Model.isModel(type))
+                    .map(([containingModel, propertyName, propertyType]) => ({
+                        containingModel,
+                        propertyName,
+                        propertyType,
+                    })),
+            )
+            .flat()
+            .reduce((accumulator, {containingModel, propertyName, propertyType}) => ({
+                ...accumulator,
+                [containingModel]: {
+                    ...accumulator[containingModel] || {},
+                    [propertyName]: propertyType,
+                },
+            }), {});
+    }
+
+    /**
+     * Update a model
+     * @param {Model} _model
+     * @throws MethodNotImplementedStorageEngineError
+     * @return Promise<void>
+     */
+    _putModel(_model) {
+        return Promise.reject(new MethodNotImplementedStorageEngineError('_putModel', this));
+    }
+
+    /**
+     * Get a model
+     * @param {string} _id
+     * @throws MethodNotImplementedStorageEngineError
+     * @throws ModelNotFoundStorageEngineError
+     * @return Promise<void>
+     */
+    _getModel(_id) {
+        return Promise.reject(new MethodNotImplementedStorageEngineError('_getModel', this));
+    }
+
+    /**
+     * Get a model's index data
+     * @param {Model.constructor} _modelConstructor
+     * @throws MethodNotImplementedStorageEngineError
+     * @return Promise<void>
+     */
+    _getIndex(_modelConstructor) {
+        return Promise.reject(new MethodNotImplementedStorageEngineError('_getIndex', this));
+    }
+
+    /**
+     * Put a model's index data
+     * @param {Model.constructor} _modelConstructor
+     * @param {object} _data
+     * @throws MethodNotImplementedStorageEngineError
+     * @return Promise<void>
+     */
+    _putIndex(_modelConstructor, _data) {
+        return Promise.reject(new MethodNotImplementedStorageEngineError('_putIndex', this));
+    }
+}
+
+/**
+ * @class StorageEngineError
+ * @extends Error
+ */
+export class StorageEngineError extends Error {
+}
+
+/**
+ * @class ModelNotRegisteredStorageEngineError
+ * @extends StorageEngineError
+ */
+export class ModelNotRegisteredStorageEngineError extends StorageEngineError {
+    /**
+     * @param {Type.Model} model
+     * @param {StorageEngine} storageEngine
+     */
+    constructor(model, storageEngine) {
+        const modelName = typeof model === 'string' ? model : model.constructor.name;
+        super(`The model ${modelName} is not registered in the storage engine ${storageEngine.constructor.name}`);
+    }
+}
+
+/**
+ * @class MethodNotImplementedStorageEngineError
+ * @extends StorageEngineError
+ */
+export class MethodNotImplementedStorageEngineError extends StorageEngineError {
+    /**
+     * @param {string} method
+     * @param {StorageEngine} storageEngine
+     */
+    constructor(method, storageEngine) {
+        super(`The method ${method} is not implemented in the storage engine ${storageEngine.constructor.name}`);
+    }
+}
+
+/**
+ * @class ModelNotFoundStorageEngineError
+ * @extends StorageEngineError
+ */
+export class ModelNotFoundStorageEngineError extends StorageEngineError {
+    /**
+     * @param {string} modelId
+     */
+    constructor(modelId) {
+        super(`The model ${modelId} was not found`);
+    }
+}

package/src/engine/storage/FileStorageEngine.js

@@ -113,6 +113,13 @@ class FileStorageEngine extends StorageEngine {
      * @throws {FailedWriteFileStorageEngineError} Throws if the index cannot be written to the file system.
      */
     static async putIndex(index) {
+        /**
+         * Process an index of models
+         * @param {string} location
+         * @param {Array<Model>} models
+         * @throws FailedWriteFileStorageEngineError
+         * @return {Promise<void>}
+         */
         const processIndex = async (location, models) => {
             const filePath = join(this.configuration.path, location, '_index.json');
             const currentIndex = JSON.parse((await this.configuration.filesystem.readFile(filePath).catch(() => '{}')).toString());

package/src/engine/storage/HTTPStorageEngine.js

@@ -186,6 +186,12 @@ class HTTPStorageEngine extends StorageEngine {
      * @throws {HTTPRequestFailedError} Thrown if the PUT request fails.
      */
     static async putIndex(index) {
+        /**
+         * Process an index of models
+         * @param {string} location
+         * @param {Array<Model>} models
+         * @return {Promise<void>}
+         */
         const processIndex = async (location, models) => {
             const url = new URL([
                 this.configuration.host,

package/src/engine/storage/S3StorageEngine.js

@@ -136,6 +136,13 @@ class S3StorageEngine extends StorageEngine {
      * @throws {FailedPutS3StorageEngineError} Thrown if there is an error during the S3 PutObject operation.
      */
     static async putIndex(index) {
+        /**
+         * Process an index of models
+         * @param {string} location
+         * @param {Array<Model>} models
+         * @throws FailedPutS3StorageEngineError
+         * @return {Promise<void>}
+         */
         const processIndex = async (location, models) => {
             const Key = [this.configuration.prefix, location, '_index.json'].filter(e => Boolean(e)).join('/');
             const currentIndex = await this.getIndex(location);

package/src/engine/storage/StorageEngine.js

@@ -186,6 +186,11 @@ class StorageEngine {
         const uploadedModels = [];
         const indexUpdates = {};
 
+        /**
+         * Process a model, putting updates to the model and all linked models.
+         * @param {Model} m
+         * @return {Promise<void>}
+         */
         const processModel = async (m) => {
             if (!uploadedModels.includes(m.id)) {
                 m.validate();
@@ -389,6 +394,11 @@ class StorageEngine {
         this.checkConfiguration();
         const hydratedModels = {};
 
+        /**
+         * Hydrate a model
+         * @param {Model} modelToProcess
+         * @return {Promise<Model>}
+         */
         const hydrateModel = async (modelToProcess) => {
             hydratedModels[modelToProcess.id] = modelToProcess;
 
@@ -405,6 +415,13 @@ class StorageEngine {
             return modelToProcess;
         };
 
+        /**
+         * Hydrate a dry sub model
+         * @param property
+         * @param modelToProcess
+         * @param name
+         * @return {Promise<Model>}
+         */
         const hydrateSubModel = async (property, modelToProcess, name) => {
             if (hydratedModels[property.id]) {
                 return hydratedModels[property.id];
@@ -418,6 +435,13 @@ class StorageEngine {
             return hydratedSubModel;
         };
 
+        /**
+         * Hydrate an array of dry models
+         * @param property
+         * @param modelToProcess
+         * @param name
+         * @return {Promise<Awaited<*>[]>}
+         */
         const hydrateModelList = async (property, modelToProcess, name) => {
             const subModelClass = getSubModelClass(modelToProcess, name, true);
 
@@ -440,6 +464,13 @@ class StorageEngine {
             }));
         };
 
+        /**
+         * Get the class of a sub model
+         * @param modelToProcess
+         * @param name
+         * @param isArray
+         * @return {Model.constructor|Type}
+         */
         function getSubModelClass(modelToProcess, name, isArray = false) {
             const constructorField = modelToProcess.constructor[name];
 
@@ -460,6 +491,10 @@ class StorageEngine {
      * @returns {StorageEngine} A new engine instance with the applied configuration.
      */
     static configure(configuration) {
+        /**
+         * @class ConfiguredStore
+         * @extends StorageEngine
+         */
         class ConfiguredStore extends this {
             static configuration = configuration;
         }

package/src/type/simple/BooleanType.js

@@ -1,15 +1,15 @@
-import SimpleType from './SimpleType.js';
+import Type from '../Type.js';
 
 /**
  * Class representing a boolean type.
  *
  * This class is used to define and handle data of the boolean type.
- * It extends the {@link SimpleType} class to represent string-specific behavior.
+ * It extends the {@link Type} class to represent string-specific behavior.
  *
  * @class BooleanType
- * @extends SimpleType
+ * @extends Type
  */
-class BooleanType extends SimpleType {
+class BooleanType extends Type {
     static {
         /**
          * @static

package/src/type/simple/DateType.js

@@ -1,15 +1,15 @@
-import SimpleType from './SimpleType.js';
+import Type from '../Type.js';
 
 /**
  * Class representing a date type with ISO date-time format.
  *
  * This class is used to define and handle data of the date type.
- * It extends the {@link SimpleType} class to represent string-specific behavior.
+ * It extends the {@link Type} class to represent string-specific behavior.
  *
  * @class DateType
- * @extends SimpleType
+ * @extends Type
  */
-class DateType extends SimpleType {
+class DateType extends Type {
     static {
         /**
          * @static

package/src/type/simple/NumberType.js

@@ -1,15 +1,15 @@
-import SimpleType from './SimpleType.js';
+import Type from '../Type.js';
 
 /**
  * Class representing a number type.
  *
  * This class is used to define and handle data of the number type.
- * It extends the {@link SimpleType} class to represent string-specific behavior.
+ * It extends the {@link Type} class to represent string-specific behavior.
  *
  * @class NumberType
- * @extends SimpleType
+ * @extends Type
  */
-class NumberType extends SimpleType {
+class NumberType extends Type {
     static {
         /**
          * @static

package/src/type/simple/StringType.js

@@ -1,15 +1,15 @@
-import SimpleType from './SimpleType.js';
+import Type from '../Type.js';
 
 /**
  * Class representing a string type.
  *
  * This class is used to define and handle data of the string type.
- * It extends the {@link SimpleType} class to represent string-specific behavior.
+ * It extends the {@link Type} class to represent string-specific behavior.
  *
  * @class StringType
- * @extends SimpleType
+ * @extends Type
  */
-class StringType extends SimpleType {
+class StringType extends Type {
     static {
         /**
          * @static

package/src/type/simple/SimpleType.js

@@ -1,14 +0,0 @@
-import Type from '../Type.js';
-
-/**
- * Class representing a simple type.
- *
- * This serves as a base class for primitive or simple types such as string, number, or boolean.
- *
- * @class SimpleType
- * @extends Type
- */
-class SimpleType extends Type {
-}
-
-export default SimpleType;