@twin.org/entity-storage-connector-memory 0.0.2-next.9 → 0.0.3-next.10

package/docs/reference/interfaces/IMemoryEntityStorageConnectorConstructorOptions.md

@@ -4,8 +4,16 @@ Options for the Memory Entity Storage Connector constructor.
 
 ## Properties
 
-### entitySchema
+### entitySchema {#entityschema}
 
 > **entitySchema**: `string`
 
 The schema for the entity.
+
+***
+
+### partitionContextIds? {#partitioncontextids}
+
+> `optional` **partitionContextIds?**: `string`[]
+
+The keys to use from the context ids to create partitions.

package/locales/en.json

@@ -1 +1,13 @@
-{}
+{
+	"info": {
+		"memoryEntityStorageConnector": {
+			"storeTearingDown": "Tearing down entity storage",
+			"storeTornDown": "Entity storage torn down"
+		}
+	},
+	"health": {
+		"memoryEntityStorageConnector": {
+			"healthDescription": "Memory entity storage is always available"
+		}
+	}
+}

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/entity-storage-connector-memory",
-	"version": "0.0.2-next.9",
-	"description": "Entity Storage connector implementation using in-memory storage",
+	"version": "0.0.3-next.10",
+	"description": "In-memory connector for local development, testing and short-lived workloads.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/entity-storage.git",
+		"url": "git+https://github.com/iotaledger/entity-storage.git",
 		"directory": "packages/entity-storage-connector-memory"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,25 +14,25 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.2-next.9",
+		"@twin.org/entity-storage-models": "0.0.3-next.10",
+		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
@@ -54,5 +54,9 @@
 		"memory",
 		"in-memory",
 		"testing"
-	]
+	],
+	"bugs": {
+		"url": "git+https://github.com/iotaledger/entity-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,185 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-var entity = require('@twin.org/entity');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class for performing entity storage operations in-memory.
- */
-class MemoryEntityStorageConnector {
-    /**
-     * Default Page Size for cursor.
-     * @internal
-     */
-    static _DEFAULT_PAGE_SIZE = 40;
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "MemoryEntityStorageConnector";
-    /**
-     * The schema for the entity.
-     * @internal
-     */
-    _entitySchema;
-    /**
-     * The primary key.
-     * @internal
-     */
-    _primaryKey;
-    /**
-     * The storage for the in-memory items.
-     * @internal
-     */
-    _store;
-    /**
-     * Create a new instance of MemoryEntityStorageConnector.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        core.Guards.object(this.CLASS_NAME, "options", options);
-        core.Guards.stringValue(this.CLASS_NAME, "options.entitySchema", options.entitySchema);
-        this._entitySchema = entity.EntitySchemaFactory.get(options.entitySchema);
-        this._primaryKey = entity.EntitySchemaHelper.getPrimaryKey(this._entitySchema);
-        this._store = [];
-    }
-    /**
-     * Get the schema for the entities.
-     * @returns The schema for the entities.
-     */
-    getSchema() {
-        return this._entitySchema;
-    }
-    /**
-     * Get an entity.
-     * @param id The id of the entity to get, or the index value if secondaryIndex is set.
-     * @param secondaryIndex Get the item using a secondary index.
-     * @param conditions The optional conditions to match for the entities.
-     * @returns The object if it can be found or undefined.
-     */
-    async get(id, secondaryIndex, conditions) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        const index = this.findItem(id, secondaryIndex, conditions);
-        return index >= 0 ? this._store[index] : undefined;
-    }
-    /**
-     * Set an entity.
-     * @param entity The entity to set.
-     * @param conditions The optional conditions to match for the entities.
-     * @returns The id of the entity.
-     */
-    async set(entity$1, conditions) {
-        core.Guards.object(this.CLASS_NAME, "entity", entity$1);
-        entity.EntitySchemaHelper.validateEntity(entity$1, this.getSchema());
-        const existingIndex = this.findItem(entity$1[this._primaryKey.property], undefined, conditions);
-        if (existingIndex >= 0) {
-            this._store[existingIndex] = entity$1;
-        }
-        else {
-            this._store.push(entity$1);
-        }
-    }
-    /**
-     * Remove the entity.
-     * @param id The id of the entity to remove.
-     * @param conditions The optional conditions to match for the entities.
-     * @returns Nothing.
-     */
-    async remove(id, conditions) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        const index = this.findItem(id, undefined, conditions);
-        if (index >= 0) {
-            this._store.splice(index, 1);
-        }
-    }
-    /**
-     * Find all the entities which match the conditions.
-     * @param conditions The conditions to match for the entities.
-     * @param sortProperties The optional sort order.
-     * @param properties The optional properties to return, defaults to all.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
-     * @returns All the entities for the storage matching the conditions,
-     * and a cursor which can be used to request more entities.
-     */
-    async query(conditions, sortProperties, properties, cursor, pageSize) {
-        let allEntities = this._store.slice();
-        const entities = [];
-        const finalPageSize = pageSize ?? MemoryEntityStorageConnector._DEFAULT_PAGE_SIZE;
-        let nextCursor;
-        if (allEntities.length > 0) {
-            const finalSortKeys = entity.EntitySchemaHelper.buildSortProperties(this._entitySchema, sortProperties);
-            allEntities = entity.EntitySorter.sort(allEntities, finalSortKeys);
-            const startIndex = core.Coerce.number(cursor) ?? 0;
-            for (let i = startIndex; i < allEntities.length; i++) {
-                if (entity.EntityConditions.check(allEntities[i], conditions) && entities.length < finalPageSize) {
-                    entities.push(core.ObjectHelper.pick(allEntities[i], properties));
-                    if (entities.length >= finalPageSize) {
-                        if (i < allEntities.length - 1) {
-                            nextCursor = (i + 1).toString();
-                        }
-                        break;
-                    }
-                }
-            }
-        }
-        return {
-            entities,
-            cursor: nextCursor
-        };
-    }
-    /**
-     * Get the memory store.
-     * @returns The store.
-     */
-    getStore() {
-        return this._store;
-    }
-    /**
-     * Find the item in the store.
-     * @param id The id to search for.
-     * @param secondaryIndex The secondary index to search for.
-     * @param conditions The optional conditions to match for the entities.
-     * @returns The index of the item if found or -1.
-     * @internal
-     */
-    findItem(id, secondaryIndex, conditions) {
-        const finalConditions = [];
-        if (!core.Is.empty(secondaryIndex)) {
-            finalConditions.push({
-                property: secondaryIndex,
-                comparison: entity.ComparisonOperator.Equals,
-                value: id
-            });
-        }
-        if (core.Is.arrayValue(conditions)) {
-            // If we haven't added a secondary index condition we need to add the primary key condition.
-            if (finalConditions.length === 0) {
-                finalConditions.push({
-                    property: this._primaryKey.property,
-                    comparison: entity.ComparisonOperator.Equals,
-                    value: id
-                });
-            }
-            finalConditions.push(...conditions.map(c => ({
-                property: c.property,
-                comparison: entity.ComparisonOperator.Equals,
-                value: c.value
-            })));
-        }
-        if (finalConditions.length > 0) {
-            for (let i = 0; i < this._store.length; i++) {
-                if (entity.EntityConditions.check(this._store[i], { conditions: finalConditions })) {
-                    return i;
-                }
-            }
-        }
-        else {
-            return this._store.findIndex(e => e[this._primaryKey.property] === id);
-        }
-        return -1;
-    }
-}
-
-exports.MemoryEntityStorageConnector = MemoryEntityStorageConnector;

package/dist/esm/index.mjs

@@ -1,183 +0,0 @@
-import { Guards, Coerce, ObjectHelper, Is } from '@twin.org/core';
-import { EntitySchemaFactory, EntitySchemaHelper, EntitySorter, EntityConditions, ComparisonOperator } from '@twin.org/entity';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class for performing entity storage operations in-memory.
- */
-class MemoryEntityStorageConnector {
-    /**
-     * Default Page Size for cursor.
-     * @internal
-     */
-    static _DEFAULT_PAGE_SIZE = 40;
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "MemoryEntityStorageConnector";
-    /**
-     * The schema for the entity.
-     * @internal
-     */
-    _entitySchema;
-    /**
-     * The primary key.
-     * @internal
-     */
-    _primaryKey;
-    /**
-     * The storage for the in-memory items.
-     * @internal
-     */
-    _store;
-    /**
-     * Create a new instance of MemoryEntityStorageConnector.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        Guards.object(this.CLASS_NAME, "options", options);
-        Guards.stringValue(this.CLASS_NAME, "options.entitySchema", options.entitySchema);
-        this._entitySchema = EntitySchemaFactory.get(options.entitySchema);
-        this._primaryKey = EntitySchemaHelper.getPrimaryKey(this._entitySchema);
-        this._store = [];
-    }
-    /**
-     * Get the schema for the entities.
-     * @returns The schema for the entities.
-     */
-    getSchema() {
-        return this._entitySchema;
-    }
-    /**
-     * Get an entity.
-     * @param id The id of the entity to get, or the index value if secondaryIndex is set.
-     * @param secondaryIndex Get the item using a secondary index.
-     * @param conditions The optional conditions to match for the entities.
-     * @returns The object if it can be found or undefined.
-     */
-    async get(id, secondaryIndex, conditions) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
-        const index = this.findItem(id, secondaryIndex, conditions);
-        return index >= 0 ? this._store[index] : undefined;
-    }
-    /**
-     * Set an entity.
-     * @param entity The entity to set.
-     * @param conditions The optional conditions to match for the entities.
-     * @returns The id of the entity.
-     */
-    async set(entity, conditions) {
-        Guards.object(this.CLASS_NAME, "entity", entity);
-        EntitySchemaHelper.validateEntity(entity, this.getSchema());
-        const existingIndex = this.findItem(entity[this._primaryKey.property], undefined, conditions);
-        if (existingIndex >= 0) {
-            this._store[existingIndex] = entity;
-        }
-        else {
-            this._store.push(entity);
-        }
-    }
-    /**
-     * Remove the entity.
-     * @param id The id of the entity to remove.
-     * @param conditions The optional conditions to match for the entities.
-     * @returns Nothing.
-     */
-    async remove(id, conditions) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
-        const index = this.findItem(id, undefined, conditions);
-        if (index >= 0) {
-            this._store.splice(index, 1);
-        }
-    }
-    /**
-     * Find all the entities which match the conditions.
-     * @param conditions The conditions to match for the entities.
-     * @param sortProperties The optional sort order.
-     * @param properties The optional properties to return, defaults to all.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
-     * @returns All the entities for the storage matching the conditions,
-     * and a cursor which can be used to request more entities.
-     */
-    async query(conditions, sortProperties, properties, cursor, pageSize) {
-        let allEntities = this._store.slice();
-        const entities = [];
-        const finalPageSize = pageSize ?? MemoryEntityStorageConnector._DEFAULT_PAGE_SIZE;
-        let nextCursor;
-        if (allEntities.length > 0) {
-            const finalSortKeys = EntitySchemaHelper.buildSortProperties(this._entitySchema, sortProperties);
-            allEntities = EntitySorter.sort(allEntities, finalSortKeys);
-            const startIndex = Coerce.number(cursor) ?? 0;
-            for (let i = startIndex; i < allEntities.length; i++) {
-                if (EntityConditions.check(allEntities[i], conditions) && entities.length < finalPageSize) {
-                    entities.push(ObjectHelper.pick(allEntities[i], properties));
-                    if (entities.length >= finalPageSize) {
-                        if (i < allEntities.length - 1) {
-                            nextCursor = (i + 1).toString();
-                        }
-                        break;
-                    }
-                }
-            }
-        }
-        return {
-            entities,
-            cursor: nextCursor
-        };
-    }
-    /**
-     * Get the memory store.
-     * @returns The store.
-     */
-    getStore() {
-        return this._store;
-    }
-    /**
-     * Find the item in the store.
-     * @param id The id to search for.
-     * @param secondaryIndex The secondary index to search for.
-     * @param conditions The optional conditions to match for the entities.
-     * @returns The index of the item if found or -1.
-     * @internal
-     */
-    findItem(id, secondaryIndex, conditions) {
-        const finalConditions = [];
-        if (!Is.empty(secondaryIndex)) {
-            finalConditions.push({
-                property: secondaryIndex,
-                comparison: ComparisonOperator.Equals,
-                value: id
-            });
-        }
-        if (Is.arrayValue(conditions)) {
-            // If we haven't added a secondary index condition we need to add the primary key condition.
-            if (finalConditions.length === 0) {
-                finalConditions.push({
-                    property: this._primaryKey.property,
-                    comparison: ComparisonOperator.Equals,
-                    value: id
-                });
-            }
-            finalConditions.push(...conditions.map(c => ({
-                property: c.property,
-                comparison: ComparisonOperator.Equals,
-                value: c.value
-            })));
-        }
-        if (finalConditions.length > 0) {
-            for (let i = 0; i < this._store.length; i++) {
-                if (EntityConditions.check(this._store[i], { conditions: finalConditions })) {
-                    return i;
-                }
-            }
-        }
-        else {
-            return this._store.findIndex(e => e[this._primaryKey.property] === id);
-        }
-        return -1;
-    }
-}
-
-export { MemoryEntityStorageConnector };