@twin.org/entity-storage-connector-memory 0.0.1-next.14 → 0.0.1-next.16

package/dist/cjs/index.cjs

@@ -36,7 +36,6 @@ class MemoryEntityStorageConnector {
     /**
      * Create a new instance of MemoryEntityStorageConnector.
      * @param options The options for the connector.
-     * @param options.entitySchema The schema for the entity.
      */
     constructor(options) {
         core.Guards.object(this.CLASS_NAME, "options", options);

package/dist/esm/index.mjs

@@ -34,7 +34,6 @@ class MemoryEntityStorageConnector {
     /**
      * Create a new instance of MemoryEntityStorageConnector.
      * @param options The options for the connector.
-     * @param options.entitySchema The schema for the entity.
      */
     constructor(options) {
         Guards.object(this.CLASS_NAME, "options", options);

package/dist/types/index.d.ts

@@ -1 +1,2 @@
 export * from "./memoryEntityStorageConnector";
+export * from "./models/IMemoryEntityStorageConnectorConstructorOptions";

package/dist/types/memoryEntityStorageConnector.d.ts

@@ -1,5 +1,6 @@
 import { type EntityCondition, type IEntitySchema, type SortDirection } from "@twin.org/entity";
 import type { IEntityStorageConnector } from "@twin.org/entity-storage-models";
+import type { IMemoryEntityStorageConnectorConstructorOptions } from "./models/IMemoryEntityStorageConnectorConstructorOptions";
 /**
  * Class for performing entity storage operations in-memory.
  */
@@ -11,11 +12,8 @@ export declare class MemoryEntityStorageConnector<T = unknown> implements IEntit
     /**
      * Create a new instance of MemoryEntityStorageConnector.
      * @param options The options for the connector.
-     * @param options.entitySchema The schema for the entity.
      */
-    constructor(options: {
-        entitySchema: string;
-    });
+    constructor(options: IMemoryEntityStorageConnectorConstructorOptions);
     /**
      * Get the schema for the entities.
      * @returns The schema for the entities.

package/dist/types/models/IMemoryEntityStorageConnectorConstructorOptions.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Options for the Memory Entity Storage Connector constructor.
+ */
+export interface IMemoryEntityStorageConnectorConstructorOptions {
+    /**
+     * The schema for the entity.
+     */
+    entitySchema: string;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/entity-storage-connector-memory - Changelog
 
-## v0.0.1-next.14
+## v0.0.1-next.16
 
 - Initial Release

package/docs/reference/classes/MemoryEntityStorageConnector.md

@@ -20,13 +20,11 @@ Create a new instance of MemoryEntityStorageConnector.
 
 #### Parameters
 
-• **options**
+##### options
 
-The options for the connector.
-
-• **options.entitySchema**: `string`
+[`IMemoryEntityStorageConnectorConstructorOptions`](../interfaces/IMemoryEntityStorageConnectorConstructorOptions.md)
 
-The schema for the entity.
+The options for the connector.
 
 #### Returns
 
@@ -48,13 +46,13 @@ Runtime name for the class.
 
 ### getSchema()
 
-> **getSchema**(): `IEntitySchema`\<`unknown`\>
+> **getSchema**(): `IEntitySchema`
 
 Get the schema for the entities.
 
 #### Returns
 
-`IEntitySchema`\<`unknown`\>
+`IEntitySchema`
 
 The schema for the entities.
 
@@ -72,15 +70,21 @@ Get an entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to get, or the index value if secondaryIndex is set.
 
-• **secondaryIndex?**: keyof `T`
+##### secondaryIndex?
+
+keyof `T`
 
 Get the item using a secondary index.
 
-• **conditions?**: `object`[]
+##### conditions?
+
+`object`[]
 
 The optional conditions to match for the entities.
 
@@ -104,11 +108,15 @@ Set an entity.
 
 #### Parameters
 
-• **entity**: `T`
+##### entity
+
+`T`
 
 The entity to set.
 
-• **conditions?**: `object`[]
+##### conditions?
+
+`object`[]
 
 The optional conditions to match for the entities.
 
@@ -132,11 +140,15 @@ Remove the entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to remove.
 
-• **conditions?**: `object`[]
+##### conditions?
+
+`object`[]
 
 The optional conditions to match for the entities.
 
@@ -154,51 +166,49 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
 
 Find all the entities which match the conditions.
 
 #### Parameters
 
-• **conditions?**: `EntityCondition`\<`T`\>
+##### conditions?
+
+`EntityCondition`\<`T`\>
 
 The conditions to match for the entities.
 
-• **sortProperties?**: `object`[]
+##### sortProperties?
+
+`object`[]
 
 The optional sort order.
 
-• **properties?**: keyof `T`[]
+##### properties?
+
+keyof `T`[]
 
 The optional properties to return, defaults to all.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to request the next page of entities.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.
 
-##### entities
-
-> **entities**: `Partial`\<`T`\>[]
-
-The entities, which can be partial if a limited keys list was provided.
-
-##### cursor?
-
-> `optional` **cursor**: `string`
-
-An optional cursor, when defined can be used to call find to get more entities.
-
 #### Implementation of
 
 `IEntityStorageConnector.query`

package/docs/reference/index.md

@@ -3,3 +3,7 @@
 ## Classes
 
 - [MemoryEntityStorageConnector](classes/MemoryEntityStorageConnector.md)
+
+## Interfaces
+
+- [IMemoryEntityStorageConnectorConstructorOptions](interfaces/IMemoryEntityStorageConnectorConstructorOptions.md)

package/docs/reference/interfaces/IMemoryEntityStorageConnectorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IMemoryEntityStorageConnectorConstructorOptions
+
+Options for the Memory Entity Storage Connector constructor.
+
+## Properties
+
+### entitySchema
+
+> **entitySchema**: `string`
+
+The schema for the entity.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-connector-memory",
-	"version": "0.0.1-next.14",
+	"version": "0.0.1-next.16",
 	"description": "Entity Storage connector implementation using in-memory storage",
 	"repository": {
 		"type": "git",
@@ -16,7 +16,7 @@
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.1-next.14",
+		"@twin.org/entity-storage-models": "0.0.1-next.16",
 		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
@@ -24,9 +24,9 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},