@twin.org/entity-storage-connector-memory 0.0.3-next.3 → 0.0.3-next.31

package/docs/examples.md

@@ -1 +1,78 @@
-# @twin.org/entity-storage-connector-memory - Examples
+# Entity Storage Connector Memory Examples
+
+Use these snippets to perform fast in-memory storage operations during development and unit testing.
+
+## MemoryEntityStorageConnector
+
+```typescript
+import { MemoryEntityStorageConnector } from '@twin.org/entity-storage-connector-memory';
+import {
+  ComparisonOperator,
+  LogicalOperator,
+  SortDirection,
+  type EntityCondition
+} from '@twin.org/entity';
+
+interface Profile {
+  id: string;
+  email: string;
+  status: 'active' | 'inactive';
+  createdAt: string;
+}
+
+const connector = new MemoryEntityStorageConnector<Profile>({
+  entitySchema: 'Profile',
+  partitionContextIds: ['tenantId']
+});
+
+const className = connector.className();
+const schema = connector.getSchema();
+
+await connector.set({
+  id: 'profile-1',
+  email: 'ada@example.com',
+  status: 'active',
+  createdAt: '2026-03-09T10:30:00.000Z'
+});
+
+const byPrimaryKey = await connector.get('profile-1');
+const bySecondaryIndex = await connector.get('ada@example.com', 'email');
+
+const activeCondition: EntityCondition<Profile> = {
+  logicalOperator: LogicalOperator.And,
+  conditions: [
+    {
+      property: 'status',
+      comparison: ComparisonOperator.Equals,
+      value: 'active'
+    }
+  ]
+};
+
+const result = await connector.query(
+  activeCondition,
+  [{ property: 'createdAt', sortDirection: SortDirection.Descending }],
+  ['id', 'email', 'status'],
+  undefined,
+  25
+);
+
+await connector.remove('profile-1');
+```
+
+```typescript
+import { MemoryEntityStorageConnector } from '@twin.org/entity-storage-connector-memory';
+
+interface Profile {
+  id: string;
+  email: string;
+  status: 'active' | 'inactive';
+  createdAt: string;
+}
+
+const connector = new MemoryEntityStorageConnector<Profile>({
+  entitySchema: 'Profile'
+});
+
+const store = connector.getStore();
+```

package/docs/reference/classes/MemoryEntityStorageConnector.md

@@ -1,6 +1,14 @@
 # Class: MemoryEntityStorageConnector\<T\>
 
-Class for performing entity storage operations in-memory.
+Class for performing entity storage operations in-memory backed by a shared object buffer.
+
+All reads and writes are serialised with a per-schema lock so that concurrent async
+access, including across worker threads, never produces torn or lost updates.
+
+All connector instances that share the same entity schema name share the same underlying
+buffer, making data written in one instance immediately visible in another, including
+across worker threads when the main thread forwards worker messages to the lock and
+buffer handlers.
 
 ## Type Parameters
 
@@ -11,6 +19,7 @@ Class for performing entity storage operations in-memory.
 ## Implements
 
 - `IEntityStorageConnector`\<`T`\>
+- `IEntityStorageMigrationConnector`\<`T`\>
 
 ## Constructors
 
@@ -34,7 +43,7 @@ The options for the connector.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -42,7 +51,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -60,7 +69,25 @@ The class name of the component.
 
 ***
 
-### getSchema()
+### health() {#health}
+
+> **health**(): `Promise`\<`IHealth`[]\>
+
+Returns the health status of the component.
+
+#### Returns
+
+`Promise`\<`IHealth`[]\>
+
+The health status of the component.
+
+#### Implementation of
+
+`IEntityStorageConnector.health`
+
+***
+
+### getSchema() {#getschema}
 
 > **getSchema**(): `IEntitySchema`
 
@@ -78,7 +105,33 @@ The schema for the entities.
 
 ***
 
-### get()
+### bootstrap() {#bootstrap}
+
+> **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
+
+Bootstrap the component by creating and initializing any resources it needs.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the bootstrapping process was successful.
+
+#### Implementation of
+
+`IEntityStorageConnector.bootstrap`
+
+***
+
+### get() {#get}
 
 > **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`T` \| `undefined`\>
 
@@ -116,7 +169,7 @@ The object if it can be found or undefined.
 
 ***
 
-### set()
+### set() {#set}
 
 > **set**(`entity`, `conditions?`): `Promise`\<`void`\>
 
@@ -140,7 +193,7 @@ The optional conditions to match for the entities.
 
 `Promise`\<`void`\>
 
-The id of the entity.
+Resolves when the entity has been stored.
 
 #### Implementation of
 
@@ -148,7 +201,33 @@ The id of the entity.
 
 ***
 
-### remove()
+### setBatch() {#setbatch}
+
+> **setBatch**(`entities`): `Promise`\<`void`\>
+
+Set multiple entities in a batch.
+
+#### Parameters
+
+##### entities
+
+`T`[]
+
+The entities to set.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageConnector.setBatch`
+
+***
+
+### remove() {#remove}
 
 > **remove**(`id`, `conditions?`): `Promise`\<`void`\>
 
@@ -180,7 +259,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
@@ -231,14 +310,248 @@ and a cursor which can be used to request more entities.
 
 ***
 
-### getStore()
+### empty() {#empty}
 
-> **getStore**(): `T`[]
+> **empty**(): `Promise`\<`void`\>
 
-Get the memory store.
+Remove all entities from the storage.
 
 #### Returns
 
-`T`[]
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageConnector.empty`
+
+***
+
+### removeBatch() {#removebatch}
+
+> **removeBatch**(`ids`): `Promise`\<`void`\>
+
+Remove multiple entities by id.
+
+#### Parameters
+
+##### ids
+
+`string`[]
+
+The ids of the entities to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageConnector.removeBatch`
+
+***
+
+### teardown() {#teardown}
+
+> **teardown**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
+
+Teardown the storage by clearing the underlying shared buffer for this schema.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the teardown process was successful.
+
+#### Implementation of
+
+`IEntityStorageConnector.teardown`
+
+***
+
+### count() {#count}
+
+> **count**(`conditions?`): `Promise`\<`number`\>
+
+Count all the entities which match the conditions.
+
+#### Parameters
+
+##### conditions?
+
+`EntityCondition`\<`T`\>
+
+The optional conditions to match for the entities.
+
+#### Returns
+
+`Promise`\<`number`\>
+
+The total count of entities in the storage.
+
+#### Implementation of
+
+`IEntityStorageConnector.count`
+
+***
+
+### getStore() {#getstore}
+
+> **getStore**(): `Promise`\<`T`[]\>
+
+Get all entities in the memory store.
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+All stored entities with partition keys removed.
+
+***
+
+### getPartitionContextIds() {#getpartitioncontextids}
+
+> **getPartitionContextIds**(): `Promise`\<`IContextIds`[]\>
+
+Get a unique list of all the context ids from the storage.
+
+#### Returns
+
+`Promise`\<`IContextIds`[]\>
+
+The list of unique context ids.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.getPartitionContextIds`
+
+***
+
+### createTargetConnector() {#createtargetconnector}
+
+> **createTargetConnector**\<`U`\>(`newEntitySchema`): `Promise`\<`IEntityStorageConnector`\<`U`\>\>
+
+Create the target connector for performing the migration it will use a temporary storage location.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### newEntitySchema
+
+`string`
+
+The name of the new entity schema to create the connector for.
+
+#### Returns
+
+`Promise`\<`IEntityStorageConnector`\<`U`\>\>
+
+Connector for performing the migration.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.createTargetConnector`
+
+***
+
+### finalizeMigration() {#finalizemigration}
+
+> **finalizeMigration**\<`U`\>(`targetConnector`, `options?`, `loggingComponentType?`): `Promise`\<`IEntityStorageConnector`\<`U`\>\>
+
+Finalize the migration by tearing down the old connector and replacing it with the target connector.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### targetConnector
+
+`IEntityStorageConnector`\<`U`\>
+
+The target connector to finalize the migration with.
+
+##### options?
+
+`IMigrationOptions`
+
+The options to control how the migration is finalized.
+
+##### loggingComponentType?
+
+`string`
+
+The optional component type to use for logging the migration progress.
+
+#### Returns
+
+`Promise`\<`IEntityStorageConnector`\<`U`\>\>
+
+A promise that resolves when the migration is finalized.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.finalizeMigration`
+
+***
+
+### cleanupMigration() {#cleanupmigration}
+
+> **cleanupMigration**\<`U`\>(`targetConnector`, `options?`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Cleanup the migration if a migration fails or needs to be aborted.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### targetConnector
+
+`IEntityStorageConnector`\<`U`\> \| `undefined`
+
+The target connector to cleanup the migration with.
+
+##### options?
+
+`IMigrationOptions`
+
+The options to control how the migration is cleaned up.
+
+##### loggingComponentType?
+
+`string`
+
+The optional component type to use for logging the migration progress.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the migration is cleaned up.
+
+#### Implementation of
 
-The store.
+`IEntityStorageMigrationConnector.cleanupMigration`

package/docs/reference/index.md

@@ -6,4 +6,5 @@
 
 ## Interfaces
 
+- [IMemoryEntityStorageConnectorConfig](interfaces/IMemoryEntityStorageConnectorConfig.md)
 - [IMemoryEntityStorageConnectorConstructorOptions](interfaces/IMemoryEntityStorageConnectorConstructorOptions.md)

package/docs/reference/interfaces/IMemoryEntityStorageConnectorConfig.md

@@ -0,0 +1,40 @@
+# Interface: IMemoryEntityStorageConnectorConfig
+
+Configuration for the Memory Entity Storage Connector.
+
+## Properties
+
+### storageKey {#storagekey}
+
+> **storageKey**: `string`
+
+Key to use for the shared buffer instead of the entity schema type.
+Use this to give two connectors with the same entitySchema separate storage.
+
+***
+
+### initialCapacityBytes? {#initialcapacitybytes}
+
+> `optional` **initialCapacityBytes?**: `number`
+
+Initial capacity in bytes for the shared entity buffer.
+
+#### Default
+
+```ts
+16 MiB.
+```
+
+***
+
+### maxCapacityBytes? {#maxcapacitybytes}
+
+> `optional` **maxCapacityBytes?**: `number`
+
+Maximum JSON payload size in bytes for the shared entity buffer.
+
+#### Default
+
+```ts
+256 MiB.
+```

package/docs/reference/interfaces/IMemoryEntityStorageConnectorConstructorOptions.md

@@ -4,7 +4,7 @@ Options for the Memory Entity Storage Connector constructor.
 
 ## Properties
 
-### entitySchema
+### entitySchema {#entityschema}
 
 > **entitySchema**: `string`
 
@@ -12,8 +12,16 @@ The schema for the entity.
 
 ***
 
-### partitionContextIds?
+### partitionContextIds? {#partitioncontextids}
 
-> `optional` **partitionContextIds**: `string`[]
+> `optional` **partitionContextIds?**: `string`[]
 
 The keys to use from the context ids to create partitions.
+
+***
+
+### config {#config}
+
+> **config**: [`IMemoryEntityStorageConnectorConfig`](IMemoryEntityStorageConnectorConfig.md)
+
+Configuration for storage key and capacity settings.

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 for \"{entityType}\" is always available"
+		}
+	}
+}

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/entity-storage-connector-memory",
-	"version": "0.0.3-next.3",
-	"description": "Entity Storage connector implementation using in-memory storage",
+	"version": "0.0.3-next.31",
+	"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/twin-entity-storage.git",
 		"directory": "packages/entity-storage-connector-memory"
 	},
 	"author": "martyn.janes@iota.org",
@@ -17,7 +17,8 @@
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.3-next.3",
+		"@twin.org/entity-storage-models": "0.0.3-next.31",
+		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/es/index.js",
@@ -55,7 +56,7 @@
 		"testing"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/entity-storage/issues"
+		"url": "git+https://github.com/iotaledger/twin-entity-storage/issues"
 	},
 	"homepage": "https://twindev.org"
 }