@acodeninja/persist 2.4.1-next.2 → 3.0.0-next.10

package/docs/code-quirks.md

@@ -54,15 +54,15 @@ export class Address extends Persist.Type.Model {
 
 By doing this, you ensure that model references are evaluated lazily, after all models have been initialized, preventing `ReferenceError` issues.
 
-## Using `HTTP` Engine in Browser
+## Using `HTTP` StorageEngine in Browser
 
 When implementing thee `HTTP` engine for code that runs in the web browser, you must pass `fetch` into the engine configuration and bind it to the `window` object.
 
 ```javascript
 import Persist from "@acodeninja/persist";
-import HTTPEngine from "@acodeninja/persist/engine/http";
+import HTTPStorageEngine from "@acodeninja/persist/engine/storage/http";
 
-Persist.addEngine('remote', HTTPEngine, {
+Persist.addEngine('remote', HTTPStorageEngine, {
     host: 'https://api.example.com',
     fetch: fetch.bind(window),
 });

package/docs/search-queries.md

@@ -37,9 +37,9 @@ To search for any `Person` who lives on station road, the following search query
 ```javascript
 import Persist from "@acodeninja/persist";
 import Person from "./Person";
-import FileEngine from "@acodeninja/persist/engine/file"
+import FileStorageEngine from "@acodeninja/persist/engine/storage/file"
 
-FileEngine
+FileStorageEngine
     .configure(configuration)
     .search(Person, 'station road');
 ```

package/docs/storage-engines.md

@@ -2,15 +2,15 @@
 
 Persist makes several storage engines available for use with the library
 
-## Filesystem Storage Engine
+## Filesystem Storage StorageEngine
 
 To store models using the local file system, use the `File` storage engine.
 
 ```javascript
 import Persist from "@acodeninja/persist";
-import FileEngine from "@acodeninja/persist/engine/file";
+import FileStorageEngine from "@acodeninja/persist/engine/storage/file";
 
-Persist.addEngine('local', FileEngine, {
+Persist.addEngine('local', FileStorageEngine, {
     path: '/app/storage',
 });
 
@@ -18,18 +18,18 @@ export class Tag extends Persist.Type.Model {
     static tag = Persist.Type.String.required;
 }
 
-await Persist.getEngine('local', FileEngine).put(new Tag({tag: 'documentation'}));
+await Persist.getEngine('local', FileStorageEngine).put(new Tag({tag: 'documentation'}));
 ```
 
-## HTTP Storage Engine
+## HTTP Storage StorageEngine
 
 To store models using an HTTP server, use the `HTTP` storage engine. When using the `HTTP` engine in the browser, refer to [code quirks](./code-quirks.md#using-http-engine-in-browser).
 
 ```javascript
 import Persist from "@acodeninja/persist";
-import HTTPEngine from "@acodeninja/persist/engine/http";
+import HTTPStorageEngine from "@acodeninja/persist/engine/storage/http";
 
-Persist.addEngine('remote', HTTPEngine, {
+Persist.addEngine('remote', HTTPStorageEngine, {
     host: 'https://api.example.com',
 });
 
@@ -37,18 +37,18 @@ export class Tag extends Persist.Type.Model {
     static tag = Persist.Type.String.required;
 }
 
-await Persist.getEngine('remote', HTTPEngine).put(new Tag({tag: 'documentation'}));
+await Persist.getEngine('remote', HTTPStorageEngine).put(new Tag({tag: 'documentation'}));
 ```
 
-## S3 Storage Engine
+## S3 Storage StorageEngine
 
 To store models using an S3 Bucket, use the `S3` storage engine. To use the `S3` engine you must also add the `@aws-sdk/client-s3` dependency to your `package.json` file.
 
 ```javascript
 import Persist from "@acodeninja/persist";
-import S3Engine from "@acodeninja/persist/engine/s3";
+import S3StorageEngine from "@acodeninja/persist/engine/storage/s3";
 
-Persist.addEngine('remote', S3Engine, {
+Persist.addEngine('remote', S3StorageEngine, {
     bucket: 'test-bucket',
     client: new S3Client(),
 });
@@ -57,5 +57,5 @@ export class Tag extends Persist.Type.Model {
     static tag = Persist.Type.String.required;
 }
 
-await Persist.getEngine('remote', S3Engine).put(new Tag({tag: 'documentation'}));
+await Persist.getEngine('remote', S3StorageEngine).put(new Tag({tag: 'documentation'}));
 ```

package/docs/structured-queries.md

@@ -40,9 +40,9 @@ To query for a `Person` called `Joe Bloggs` an exact query can be written:
 ```javascript
 import Persist from "@acodeninja/persist";
 import Person from "./Person";
-import FileEngine from "@acodeninja/persist/engine/file"
+import FileStorageEngine from "@acodeninja/persist/engine/storage/file"
 
-FileEngine
+FileStorageEngine
     .configure(configuration)
     .find(Person, {
         name: {$is: 'Joe Bloggs'},
@@ -56,9 +56,9 @@ To query for a `Person` with name `Joe` a contains query can be written:
 ```javascript
 import Persist from "@acodeninja/persist";
 import Person from "./Person";
-import FileEngine from "@acodeninja/persist/engine/file"
+import FileStorageEngine from "@acodeninja/persist/engine/storage/file"
 
-FileEngine
+FileStorageEngine
     .configure(configuration)
     .find(Person, {
         name: {$contains: 'Joe'},
@@ -72,9 +72,9 @@ To query for a `Person` who lives at `SW1 1AA` a combination of contains and exa
 ```javascript
 import Persist from "@acodeninja/persist";
 import Person from "./Person";
-import FileEngine from "@acodeninja/persist/engine/file"
+import FileStorageEngine from "@acodeninja/persist/engine/storage/file"
 
-FileEngine
+FileStorageEngine
     .configure(configuration)
     .find(Person, {
         address: {
@@ -92,9 +92,9 @@ To query for anyone called `Joe Bloggs` who lives in the `SW1` postcode area, we
 ```javascript
 import Persist from "@acodeninja/persist";
 import Person from "./Person";
-import FileEngine from "@acodeninja/persist/engine/file"
+import FileStorageEngine from "@acodeninja/persist/engine/storage/file"
 
-FileEngine
+FileStorageEngine
     .configure(configuration)
     .find(Person, {
         name: {$is: 'Joe Bloggs'},

package/docs/transactions.md

@@ -4,9 +4,9 @@ Create transactions to automatically roll back on failure.
 
 ```javascript
 import Persist from "@acodeninja/persist";
-import S3Engine from "@acodeninja/persist/engine/s3";
+import S3StorageEngine from "@acodeninja/persist/engine/storage/s3";
 
-Persist.addEngine('remote', S3Engine, {
+Persist.addEngine('remote', S3StorageEngine, {
     bucket: 'test-bucket',
     client: new S3Client(),
     transactions: true,
@@ -16,7 +16,7 @@ export class Tag extends Persist.Type.Model {
     static tag = Persist.Type.String.required;
 }
 
-const transaction = Persist.getEngine('remote', S3Engine).start();
+const transaction = Persist.getEngine('remote', S3StorageEngine).start();
 
 await transaction.put(new Tag({tag: 'documentation'}));
 await transaction.commit();

package/exports/engine/storage/file.js

@@ -0,0 +1,3 @@
+import FileStorageEngine from '../../../src/engine/storage/FileStorageEngine.js';
+
+export default FileStorageEngine;

package/exports/engine/storage/http.js

@@ -0,0 +1,3 @@
+import HTTPStorageEngine from '../../../src/engine/storage/HTTPStorageEngine.js';
+
+export default HTTPStorageEngine;

package/exports/engine/storage/s3.js

@@ -0,0 +1,3 @@
+import S3StorageEngine from '../../../src/engine/storage/S3StorageEngine.js';
+
+export default S3StorageEngine;

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": "2.4.1-next.2",
+  "version": "3.0.0-next.10",
   "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/SchemaCompiler.js

@@ -79,7 +79,11 @@ class SchemaCompiler {
                     schema.properties[name].items.format = property?._items._format;
                 }
 
-                if (Type.Model.isModel(property?._items)) {
+                const prop = typeof property?._items === 'function' &&
+                !/^class/.test(Function.prototype.toString.call(property?._items)) ?
+                    property?._items() : property?._items;
+
+                if (Type.Model.isModel(prop)) {
                     schema.properties[name].items = {
                         type: 'object',
                         additionalProperties: false,
@@ -87,7 +91,7 @@ class SchemaCompiler {
                         properties: {
                             id: {
                                 type: 'string',
-                                pattern: `^${property?._items.toString()}/[A-Z0-9]+$`,
+                                pattern: `^${prop.toString()}/[A-Z0-9]+$`,
                             },
                         },
                     };