@acodeninja/persist 3.0.0-next.16 → 3.0.0-next.18

package/README.md

@@ -9,6 +9,7 @@ A JSON based data modelling and persistence library with alternate storage mecha
 
 [![DeepSource](https://app.deepsource.com/gh/acodeninja/persist.svg/?label=active+issues&show_trend=true&token=Vd8_PJuRwwoq4_uBJ0_ymc06)](https://app.deepsource.com/gh/acodeninja/persist/)
 [![DeepSource](https://app.deepsource.com/gh/acodeninja/persist.svg/?label=code+coverage&show_trend=true&token=Vd8_PJuRwwoq4_uBJ0_ymc06)](https://app.deepsource.com/gh/acodeninja/persist/)
+![CodeRabbit PR Reviews](https://img.shields.io/coderabbit/prs/github/acodeninja/persist?utm_source=oss&utm_medium=github&utm_campaign=acodeninja%2Fpersist&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)
 
 ## Features
 

package/docs/storage-engines.md

@@ -8,6 +8,7 @@ To store models using an S3 Bucket, use the `S3` storage engine. To use the `S3`
 
 ```javascript
 import Persist from "@acodeninja/persist";
+import {S3Client} from "@aws-sdk/client-s3";
 import S3StorageEngine from "@acodeninja/persist/storage/s3";
 
 const connection = Persist.registerConnection('remote', new S3StorageEngine({
@@ -28,14 +29,14 @@ To store models using an HTTP server, use the `HTTP` storage engine. When using
 
 ```javascript
 import Persist from "@acodeninja/persist";
-import HTTPStorageEngine from "@acodeninja/persist/engine/storage/http";
+import HTTPStorageEngine from "@acodeninja/persist/storage/http";
 
 const connection = Persist.registerConnection('remote', new HTTPStorageEngine({
     baseUrl: 'https://api.example.com',
 }));
 
-export class Tag extends Persist.Type.Model {
-    static tag = Persist.Type.String.required;
+export class Tag extends Persist.Model {
+    static tag = Persist.Property.String.required;
 }
 
 await connection.put(new Tag({tag: 'documentation'}));

package/docs/structured-queries.md

@@ -41,7 +41,7 @@ To query for a `Person` called `Joe Bloggs` an exact query can be written:
 ```javascript
 import Persist from "@acodeninja/persist";
 
-const connection = Persist.getConnections('people');
+const connection = Persist.getConnection('people');
 
 await connection.find(Person, {
     name: {$is: 'Joe Bloggs'},
@@ -55,7 +55,7 @@ To query for a `Person` with name `Joe` a contains query can be written:
 ```javascript
 import Persist from "@acodeninja/persist";
 
-const connection = Persist.getConnections('people');
+const connection = Persist.getConnection('people');
 
 await connection.find(Person, {
     name: {$contains: 'Joe'},
@@ -69,7 +69,7 @@ To query for all instances of `Address` with a linked `Person` with a name that
 ```javascript
 import Persist from "@acodeninja/persist";
 
-const connection = Persist.getConnections('people');
+const connection = Persist.getConnection('people');
 
 await connection.find(Address, {
     people: {
@@ -87,7 +87,7 @@ To query for a `Person` who lives at `SW1 1AA` a combination of contains and exa
 ```javascript
 import Persist from "@acodeninja/persist";
 
-const connection = Persist.getConnections('people');
+const connection = Persist.getConnection('people');
 
 await connection.find(Person, {
     address: {
@@ -105,7 +105,7 @@ To query for anyone called `Joe Bloggs` who lives in the `SW1` postcode area, we
 ```javascript
 import Persist from "@acodeninja/persist";
 
-const connection = Persist.getConnections('people');
+const connection = Persist.getConnection('people');
 
 await connection.find(Person, {
     name: {$is: 'Joe Bloggs'},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acodeninja/persist",
-  "version": "3.0.0-next.16",
+  "version": "3.0.0-next.18",
   "description": "A JSON based data modelling and persistence module with alternate storage mechanisms.",
   "type": "module",
   "scripts": {

package/src/Persist.js

@@ -15,7 +15,7 @@ class Persist {
         ValidationError,
     };
 
-    static #connections = {};
+    static #connections = new Map();
 
     /**
      * Register a new connection.
@@ -25,9 +25,11 @@ class Persist {
      * @return {Connection}
      */
     static registerConnection(name, storage, models) {
-        this.#connections[name] = new Connection(storage, models);
+        const connection = new Connection(storage, models);
 
-        return this.getConnection(name);
+        Persist.#connections.set(name, connection);
+
+        return connection;
     }
 
     /**
@@ -36,7 +38,7 @@ class Persist {
      * @return {Connection|undefined}
      */
     static getConnection(name) {
-        return this.#connections[name];
+        return Persist.#connections.get(name);
     }
 }
 

package/src/data/FindIndex.js

@@ -43,12 +43,12 @@ class FindIndex {
     /**
      * Constructs a new `Query` instance with the provided query object.
      *
-     * @param {Model.constructor} constructor - The model class.
+     * @param {Model.constructor} modelConstructor - The model class.
      * @param {Record<string, Model>} index - The index dataset to search through.
      */
-    constructor(constructor, index) {
+    constructor(modelConstructor, index) {
         this.#index = index;
-        this.#modelConstructor = constructor;
+        this.#modelConstructor = modelConstructor;
     }
 
     /**
@@ -93,10 +93,11 @@ class FindIndex {
             if (subject.includes?.(inputQuery.$contains))
                 return true;
 
-            for (const value of subject) {
-                if (this.#matchesQuery(value, inputQuery.$contains))
-                    return true;
-            }
+            if (typeof subject[Symbol.iterator] === 'function')
+                for (const value of subject) {
+                    if (this.#matchesQuery(value, inputQuery.$contains))
+                        return true;
+                }
         }
 
         for (const key of Object.keys(inputQuery)) {

package/src/data/Model.js

@@ -171,6 +171,10 @@ class Model {
     /**
      * Returns a list of properties that are indexed.
      *
+     * - To link to properties of a model use `<name>`
+     * - To link to properties of linked models use `<model>.<name>`
+     * - To link to properties of many linked models use `<model>.[*].<name>`
+     *
      * @returns {Array<string>} - The indexed properties.
      * @abstract
      * @static
@@ -187,29 +191,15 @@ class Model {
      * @static
      */
     static indexedPropertiesResolved() {
-        return []
-            .concat(
-                Object.entries(this)
-                    .filter(([_name, type]) =>
-                        this.isModel(
-                            typeof type === 'function' &&
-                            !/^class/.test(Function.prototype.toString.call(type)) ?
-                                type() : type,
-                        ),
-                    )
-                    .map(([name, _type]) => `${name}.id`),
-            )
-            .concat(
-                Object.entries(this)
-                    .filter(([_name, type]) =>
-                        !/^class/.test(Function.prototype.toString.call(type)) || type.toString().includes('Array'),
-                    )
-                    .filter(([_name, type]) =>
-                        this.isModel(type._items ?? type()._items ?? type),
-                    )
-                    .map(([name, _type]) => `${name}.[*].id`),
-            )
-            .concat(this.indexedProperties());
+        return [
+            ...Object.entries(this)
+                .filter(([_name, type]) => !type._type && (this.isModel(type) || 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)))
+                .map(([name, _type]) => `${name}.[*].id`),
+            ...this.indexedProperties(),
+        ];
     }
 
     /**

package/src/engine/storage/HTTPStorageEngine.js

@@ -74,12 +74,12 @@ export default class HTTPStorageEngine extends StorageEngine {
 
     /**
      * Get a model's index data
-     * @param {Model.constructor} constructor
+     * @param {Model.constructor} modelConstructor
      * @return Promise<void>
      */
-    getIndex(constructor) {
+    getIndex(modelConstructor) {
         return this.#processFetch(
-            this.#generateURL([constructor.toString()]),
+            this.#generateURL([modelConstructor.name]),
             this.#getReadOptions(),
             {},
         );
@@ -87,13 +87,13 @@ export default class HTTPStorageEngine extends StorageEngine {
 
     /**
      * Put a model's index data
-     * @param {Model.constructor} constructor
+     * @param {Model.constructor} modelConstructor
      * @param {object} index
      * @throws MethodNotImplementedStorageEngineError
      * @return Promise<void>
      */
-    putIndex(constructor, index) {
-        return this.#processFetch(this.#generateURL([constructor.toString()]), {
+    putIndex(modelConstructor, index) {
+        return this.#processFetch(this.#generateURL([modelConstructor.name]), {
             ...this.#getWriteOptions(),
             body: JSON.stringify(index),
         });
@@ -101,13 +101,13 @@ export default class HTTPStorageEngine extends StorageEngine {
 
     /**
      * Get a model's raw search index data
-     * @param {Model.constructor} constructor
+     * @param {Model.constructor} modelConstructor
      * @throws MethodNotImplementedStorageEngineError
      * @return Promise<object>
      */
-    getSearchIndex(constructor) {
+    getSearchIndex(modelConstructor) {
         return this.#processFetch(
-            this.#generateURL([constructor.toString(), 'search']),
+            this.#generateURL([modelConstructor.name, 'search']),
             this.#getReadOptions(),
             {},
         );
@@ -115,13 +115,13 @@ export default class HTTPStorageEngine extends StorageEngine {
 
     /**
      * Put a model's raw and compiled search index data
-     * @param {Model.constructor} constructor
+     * @param {Model.constructor} modelConstructor
      * @param {Record<string, object>} index
      * @throws MethodNotImplementedStorageEngineError
      * @return Promise<void>
      */
-    putSearchIndex(constructor, index) {
-        return this.#processFetch(this.#generateURL([constructor.toString(), 'search']), {
+    putSearchIndex(modelConstructor, index) {
+        return this.#processFetch(this.#generateURL([modelConstructor.name, 'search']), {
             ...this.#getWriteOptions(),
             body: JSON.stringify(index),
         });

package/src/engine/storage/S3StorageEngine.js

@@ -85,12 +85,12 @@ class S3StorageEngine extends StorageEngine {
 
     /**
      * Get a model's index data
-     * @param {Model.constructor} constructor
+     * @param {Model.constructor} modelConstructor
      * @throws MethodNotImplementedStorageEngineError
      * @return Promise<object>
      */
-    async getIndex(constructor) {
-        const Key = this.#generatePath([constructor?.toString(), '_index.json']);
+    async getIndex(modelConstructor) {
+        const Key = this.#generatePath([modelConstructor.name, '_index.json']);
         try {
             const data = await this.configuration.client.send(new GetObjectCommand({
                 Bucket: this.configuration.bucket,
@@ -105,13 +105,13 @@ class S3StorageEngine extends StorageEngine {
 
     /**
      * Put a model's index data
-     * @param {Model.constructor} constructor
+     * @param {Model.constructor} modelConstructor
      * @param {object} index
      * @throws MethodNotImplementedStorageEngineError
      * @return Promise<void>
      */
-    async putIndex(constructor, index) {
-        const Key = this.#generatePath([constructor.toString(), '_index.json']);
+    async putIndex(modelConstructor, index) {
+        const Key = this.#generatePath([modelConstructor.name, '_index.json']);
         await this.configuration.client.send(new PutObjectCommand({
             Key,
             Bucket: this.configuration.bucket,
@@ -122,11 +122,11 @@ class S3StorageEngine extends StorageEngine {
 
     /**
      * Get a model's raw search index data
-     * @param {Model.constructor} constructor
+     * @param {Model.constructor} modelConstructor
      * @return Promise<Record<string, object>>
      */
-    async getSearchIndex(constructor) {
-        const Key = this.#generatePath([constructor.toString(), '_search_index.json']);
+    async getSearchIndex(modelConstructor) {
+        const Key = this.#generatePath([modelConstructor.name, '_search_index.json']);
 
         try {
             const data = await this.configuration.client.send(new GetObjectCommand({
@@ -142,12 +142,12 @@ class S3StorageEngine extends StorageEngine {
 
     /**
      * Put a model's search index data
-     * @param {Model.constructor} constructor
+     * @param {Model.constructor} modelConstructor
      * @param {Record<string, object>} index
      * @return Promise<void>
      */
-    async putSearchIndex(constructor, index) {
-        const Key = this.#generatePath([constructor.toString(), '_search_index.json']);
+    async putSearchIndex(modelConstructor, index) {
+        const Key = this.#generatePath([modelConstructor.name, '_search_index.json']);
 
         await this.configuration.client.send(new PutObjectCommand({
             Key,