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

package/README.md

@@ -1,6 +1,6 @@
-# TWIN Entity Storage Models
+# Entity Storage Models
 
-Models which define the structure of the entity storage contracts and connectors.
+This package defines the shared domain models that standardise storage contracts, requests, responses and connector capabilities. It is designed to work with the wider storage ecosystem so applications can keep behaviour consistent across connectors and environments.
 
 ## Installation
 

package/dist/{esm/index.mjs → es/factories/entityStorageConnectorFactory.js}

@@ -1,11 +1,9 @@
-import { Factory } from '@twin.org/core';
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@twin.org/core";
 /**
  * Factory for creating entity storage connectors.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const EntityStorageConnectorFactory = Factory.createFactory("entity-storage");
-
-export { EntityStorageConnectorFactory };
+export const EntityStorageConnectorFactory = Factory.createFactory("entity-storage");
+//# sourceMappingURL=entityStorageConnectorFactory.js.map

package/dist/es/factories/entityStorageConnectorFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entityStorageConnectorFactory.js","sourceRoot":"","sources":["../../../src/factories/entityStorageConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,6BAA6B,GACzC,OAAO,CAAC,aAAa,CAA0B,gBAAgB,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IEntityStorageConnector } from \"../models/IEntityStorageConnector.js\";\n\n/**\n * Factory for creating entity storage connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const EntityStorageConnectorFactory =\n\tFactory.createFactory<IEntityStorageConnector>(\"entity-storage\");\n"]}

package/dist/es/index.js

@@ -0,0 +1,17 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./factories/entityStorageConnectorFactory.js";
+export * from "./models/api/IEntityStorageCountRequest.js";
+export * from "./models/api/IEntityStorageEmptyRequest.js";
+export * from "./models/api/IEntityStorageCountResponse.js";
+export * from "./models/api/IEntityStorageGetRequest.js";
+export * from "./models/api/IEntityStorageGetResponse.js";
+export * from "./models/api/IEntityStorageListRequest.js";
+export * from "./models/api/IEntityStorageListResponse.js";
+export * from "./models/api/IEntityStorageRemoveBatchRequest.js";
+export * from "./models/api/IEntityStorageRemoveRequest.js";
+export * from "./models/api/IEntityStorageSetBatchRequest.js";
+export * from "./models/api/IEntityStorageSetRequest.js";
+export * from "./models/IEntityStorageComponent.js";
+export * from "./models/IEntityStorageConnector.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,8CAA8C,CAAC;AAC7D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,kDAAkD,CAAC;AACjE,cAAc,6CAA6C,CAAC;AAC5D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0CAA0C,CAAC;AACzD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/entityStorageConnectorFactory.js\";\nexport * from \"./models/api/IEntityStorageCountRequest.js\";\nexport * from \"./models/api/IEntityStorageEmptyRequest.js\";\nexport * from \"./models/api/IEntityStorageCountResponse.js\";\nexport * from \"./models/api/IEntityStorageGetRequest.js\";\nexport * from \"./models/api/IEntityStorageGetResponse.js\";\nexport * from \"./models/api/IEntityStorageListRequest.js\";\nexport * from \"./models/api/IEntityStorageListResponse.js\";\nexport * from \"./models/api/IEntityStorageRemoveBatchRequest.js\";\nexport * from \"./models/api/IEntityStorageRemoveRequest.js\";\nexport * from \"./models/api/IEntityStorageSetBatchRequest.js\";\nexport * from \"./models/api/IEntityStorageSetRequest.js\";\nexport * from \"./models/IEntityStorageComponent.js\";\nexport * from \"./models/IEntityStorageConnector.js\";\n"]}

package/dist/es/models/IEntityStorageComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEntityStorageComponent.js.map

package/dist/es/models/IEntityStorageComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageComponent.js","sourceRoot":"","sources":["../../../src/models/IEntityStorageComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { EntityCondition, SortDirection } from \"@twin.org/entity\";\n\n/**\n * Interface describing an entity storage component.\n */\nexport interface IEntityStorageComponent<T = unknown> extends IComponent {\n\t/**\n\t * Set an entity.\n\t * @param entity The entity to set.\n\t * @returns The id of the entity.\n\t */\n\tset(entity: T): Promise<void>;\n\n\t/**\n\t * Set multiple entities in a batch.\n\t * @param entities The entities to set.\n\t * @returns Nothing.\n\t */\n\tsetBatch(entities: T[]): Promise<void>;\n\n\t/**\n\t * Get an entity.\n\t * @param id The id of the entity to get, or the index value if secondaryIndex is set.\n\t * @param secondaryIndex Get the item using a secondary index.\n\t * @returns The object if it can be found or undefined.\n\t */\n\tget(id: string, secondaryIndex?: keyof T): Promise<T | undefined>;\n\n\t/**\n\t * Remove the entity.\n\t * @param id The id of the entity to remove.\n\t * @returns Nothing.\n\t */\n\tremove(id: string): Promise<void>;\n\n\t/**\n\t * Remove multiple entities by id.\n\t * @param ids The ids of the entities to remove.\n\t * @returns Nothing.\n\t */\n\tremoveBatch(ids: string[]): Promise<void>;\n\n\t/**\n\t * Query all the entities which match the conditions.\n\t * @param conditions The conditions to match for the entities.\n\t * @param orderBy The order for the results.\n\t * @param orderByDirection The direction for the order, defaults to ascending.\n\t * @param properties The optional properties to return, defaults to all.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit The suggested number of entities to return in each chunk, in some scenarios can return a different amount.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t */\n\tquery(\n\t\tconditions?: EntityCondition<T>,\n\t\torderBy?: keyof T,\n\t\torderByDirection?: SortDirection,\n\t\tproperties?: (keyof T)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: Partial<T>[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}>;\n\n\t/**\n\t * Remove all entities from the storage.\n\t * @returns Nothing.\n\t */\n\tempty(): Promise<void>;\n\n\t/**\n\t * Count all the entities which match the conditions.\n\t * @returns The total count of entities in the storage.\n\t */\n\tcount(): Promise<number>;\n}\n"]}

package/dist/es/models/IEntityStorageConnector.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEntityStorageConnector.js.map

package/dist/es/models/IEntityStorageConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageConnector.js","sourceRoot":"","sources":["../../../src/models/IEntityStorageConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { EntityCondition, IEntitySchema, SortDirection } from \"@twin.org/entity\";\n\n/**\n * Interface describing an entity storage connector.\n */\nexport interface IEntityStorageConnector<T = unknown> extends IComponent {\n\t/**\n\t * Get the schema for the entities.\n\t * @returns The schema for the entities.\n\t */\n\tgetSchema(): IEntitySchema;\n\n\t/**\n\t * Set an entity.\n\t * @param entity The entity to set.\n\t * @param conditions The optional conditions to match for the entities.\n\t * @returns The id of the entity.\n\t */\n\tset(entity: T, conditions?: { property: keyof T; value: unknown }[]): Promise<void>;\n\n\t/**\n\t * Set multiple entities in a batch.\n\t * @param entities The entities to set.\n\t * @returns Nothing.\n\t */\n\tsetBatch(entities: T[]): Promise<void>;\n\n\t/**\n\t * Get an entity.\n\t * @param id The id of the entity to get, or the index value if secondaryIndex is set.\n\t * @param secondaryIndex Get the item using a secondary index.\n\t * @param conditions The optional conditions to match for the entities.\n\t * @returns The object if it can be found or undefined.\n\t */\n\tget(\n\t\tid: string,\n\t\tsecondaryIndex?: keyof T,\n\t\tconditions?: { property: keyof T; value: unknown }[]\n\t): Promise<T | undefined>;\n\n\t/**\n\t * Remove the entity.\n\t * @param id The id of the entity to remove.\n\t * @param conditions The optional conditions to match for the entities.\n\t * @returns Nothing.\n\t */\n\tremove(id: string, conditions?: { property: keyof T; value: unknown }[]): Promise<void>;\n\n\t/**\n\t * Remove multiple entities by id.\n\t * @param ids The ids of the entities to remove.\n\t * @returns Nothing.\n\t */\n\tremoveBatch(ids: string[]): Promise<void>;\n\n\t/**\n\t * Query all the entities which match the conditions.\n\t * @param conditions The conditions to match for the entities.\n\t * @param sortProperties The optional sort order.\n\t * @param properties The optional properties to return, defaults to all.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit The suggested number of entities to return in each chunk, in some scenarios can return a different amount.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t */\n\tquery(\n\t\tconditions?: EntityCondition<T>,\n\t\tsortProperties?: {\n\t\t\tproperty: keyof T;\n\t\t\tsortDirection: SortDirection;\n\t\t}[],\n\t\tproperties?: (keyof T)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: Partial<T>[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}>;\n\n\t/**\n\t * Remove all entities from the storage.\n\t * @returns Nothing.\n\t */\n\tempty(): Promise<void>;\n\n\t/**\n\t * Count all the entities which match the conditions.\n\t * @returns The total count of entities in the storage.\n\t */\n\tcount(): Promise<number>;\n}\n"]}

package/dist/es/models/api/IEntityStorageCountRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageCountRequest.js.map

package/dist/es/models/api/IEntityStorageCountRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageCountRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageCountRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Count the entries in entity storage.\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface IEntityStorageCountRequest {}\n"]}

package/dist/es/models/api/IEntityStorageCountResponse.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageCountResponse.js.map

package/dist/es/models/api/IEntityStorageCountResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageCountResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageCountResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The response for counting entries in entity storage.\n */\nexport interface IEntityStorageCountResponse {\n\t/**\n\t * The body of the response.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The total count of entities.\n\t\t */\n\t\tcount: number;\n\t};\n}\n"]}

package/dist/es/models/api/IEntityStorageEmptyRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageEmptyRequest.js.map

package/dist/es/models/api/IEntityStorageEmptyRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageEmptyRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageEmptyRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Remove all entries from entity storage.\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface IEntityStorageEmptyRequest {}\n"]}

package/dist/es/models/api/IEntityStorageGetRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageGetRequest.js.map

package/dist/es/models/api/IEntityStorageGetRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageGetRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Get an entry from entity storage.\n */\nexport interface IEntityStorageGetRequest {\n\t/**\n\t * The parameters from the path.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the entity to get.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The secondary index to query with the id.\n\t\t */\n\t\tsecondaryIndex?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IEntityStorageGetResponse.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageGetResponse.js.map

package/dist/es/models/api/IEntityStorageGetResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageGetResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Get an entry from entity storage.\n */\nexport interface IEntityStorageGetResponse {\n\t/**\n\t * The data for the requested entity.\n\t */\n\tbody: unknown;\n}\n"]}

package/dist/es/models/api/IEntityStorageListRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEntityStorageListRequest.js.map

package/dist/es/models/api/IEntityStorageListRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageListRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageListRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SortDirection } from \"@twin.org/entity\";\n\n/**\n * Query the entries from entity storage.\n */\nexport interface IEntityStorageListRequest {\n\t/**\n\t * The parameters from the query.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The condition for the query as JSON version of EntityCondition type.\n\t\t */\n\t\tconditions?: string;\n\n\t\t/**\n\t\t * The order property for the results.\n\t\t */\n\t\torderBy?: string;\n\n\t\t/**\n\t\t * The direction for the order, defaults to desc.\n\t\t */\n\t\torderByDirection?: SortDirection;\n\n\t\t/**\n\t\t * The properties to return in the response as a comma separated list, by default returns all properties.\n\t\t */\n\t\tproperties?: string;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\n\t\t/**\n\t\t * The cursor to get next chunk of data, returned in previous response.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IEntityStorageListResponse.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageListResponse.js.map

package/dist/es/models/api/IEntityStorageListResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageListResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageListResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Response to getting the list of entries from a query.\n */\nexport interface IEntityStorageListResponse {\n\t/**\n\t * The list of entries from the query.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The entities from the query.\n\t\t */\n\t\tentities: unknown[];\n\n\t\t/**\n\t\t * The cursor for the next page.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IEntityStorageRemoveBatchRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageRemoveBatchRequest.js.map

package/dist/es/models/api/IEntityStorageRemoveBatchRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageRemoveBatchRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageRemoveBatchRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Remove multiple entries from entity storage by id.\n */\nexport interface IEntityStorageRemoveBatchRequest {\n\t/**\n\t * The ids of the entities to remove.\n\t */\n\tbody: string[];\n}\n"]}

package/dist/es/models/api/IEntityStorageRemoveRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageRemoveRequest.js.map

package/dist/es/models/api/IEntityStorageRemoveRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageRemoveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageRemoveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Remove an entry from entity storage.\n */\nexport interface IEntityStorageRemoveRequest {\n\t/**\n\t * The parameters from the path.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the entity to remove.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/IEntityStorageSetBatchRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageSetBatchRequest.js.map

package/dist/es/models/api/IEntityStorageSetBatchRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageSetBatchRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageSetBatchRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Set multiple entries in entity storage.\n */\nexport interface IEntityStorageSetBatchRequest {\n\t/**\n\t * The entities to set.\n\t */\n\tbody: unknown[];\n}\n"]}

package/dist/es/models/api/IEntityStorageSetRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageSetRequest.js.map

package/dist/es/models/api/IEntityStorageSetRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageSetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageSetRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Set an entry in entity storage.\n */\nexport interface IEntityStorageSetRequest {\n\t/**\n\t * The data to be used in the entity.\n\t */\n\tbody: unknown;\n}\n"]}

package/dist/types/factories/entityStorageConnectorFactory.d.ts

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IEntityStorageConnector } from "../models/IEntityStorageConnector";
+import type { IEntityStorageConnector } from "../models/IEntityStorageConnector.js";
 /**
  * Factory for creating entity storage connectors.
  */

package/dist/types/index.d.ts

@@ -1,9 +1,14 @@
-export * from "./factories/entityStorageConnectorFactory";
-export * from "./models/api/IEntityStorageGetRequest";
-export * from "./models/api/IEntityStorageGetResponse";
-export * from "./models/api/IEntityStorageListRequest";
-export * from "./models/api/IEntityStorageListResponse";
-export * from "./models/api/IEntityStorageRemoveRequest";
-export * from "./models/api/IEntityStorageSetRequest";
-export * from "./models/IEntityStorageComponent";
-export * from "./models/IEntityStorageConnector";
+export * from "./factories/entityStorageConnectorFactory.js";
+export * from "./models/api/IEntityStorageCountRequest.js";
+export * from "./models/api/IEntityStorageEmptyRequest.js";
+export * from "./models/api/IEntityStorageCountResponse.js";
+export * from "./models/api/IEntityStorageGetRequest.js";
+export * from "./models/api/IEntityStorageGetResponse.js";
+export * from "./models/api/IEntityStorageListRequest.js";
+export * from "./models/api/IEntityStorageListResponse.js";
+export * from "./models/api/IEntityStorageRemoveBatchRequest.js";
+export * from "./models/api/IEntityStorageRemoveRequest.js";
+export * from "./models/api/IEntityStorageSetBatchRequest.js";
+export * from "./models/api/IEntityStorageSetRequest.js";
+export * from "./models/IEntityStorageComponent.js";
+export * from "./models/IEntityStorageConnector.js";

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

@@ -7,38 +7,46 @@ export interface IEntityStorageComponent<T = unknown> extends IComponent {
     /**
      * Set an entity.
      * @param entity The entity to set.
-     * @param userIdentity The user identity to use with storage operations.
      * @returns The id of the entity.
      */
-    set(entity: T, userIdentity?: string): Promise<void>;
+    set(entity: T): Promise<void>;
+    /**
+     * Set multiple entities in a batch.
+     * @param entities The entities to set.
+     * @returns Nothing.
+     */
+    setBatch(entities: T[]): Promise<void>;
     /**
      * 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 userIdentity The user identity to use with storage operations.
      * @returns The object if it can be found or undefined.
      */
-    get(id: string, secondaryIndex?: keyof T, userIdentity?: string): Promise<T | undefined>;
+    get(id: string, secondaryIndex?: keyof T): Promise<T | undefined>;
     /**
      * Remove the entity.
      * @param id The id of the entity to remove.
-     * @param userIdentity The user identity to use with storage operations.
      * @returns Nothing.
      */
-    remove(id: string, userIdentity?: string): Promise<void>;
+    remove(id: string): Promise<void>;
+    /**
+     * Remove multiple entities by id.
+     * @param ids The ids of the entities to remove.
+     * @returns Nothing.
+     */
+    removeBatch(ids: string[]): Promise<void>;
     /**
      * Query all the entities which match the conditions.
      * @param conditions The conditions to match for the entities.
      * @param orderBy The order for the results.
      * @param orderByDirection The direction for the order, defaults to ascending.
      * @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.
-     * @param userIdentity The user identity to use with storage operations.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit 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.
      */
-    query(conditions?: EntityCondition<T>, orderBy?: keyof T, orderByDirection?: SortDirection, properties?: (keyof T)[], cursor?: string, pageSize?: number, userIdentity?: string): Promise<{
+    query(conditions?: EntityCondition<T>, orderBy?: keyof T, orderByDirection?: SortDirection, properties?: (keyof T)[], cursor?: string, limit?: number): Promise<{
         /**
          * The entities, which can be partial if a limited keys list was provided.
          */
@@ -48,4 +56,14 @@ export interface IEntityStorageComponent<T = unknown> extends IComponent {
          */
         cursor?: string;
     }>;
+    /**
+     * Remove all entities from the storage.
+     * @returns Nothing.
+     */
+    empty(): Promise<void>;
+    /**
+     * Count all the entities which match the conditions.
+     * @returns The total count of entities in the storage.
+     */
+    count(): Promise<number>;
 }

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

@@ -19,6 +19,12 @@ export interface IEntityStorageConnector<T = unknown> extends IComponent {
         property: keyof T;
         value: unknown;
     }[]): Promise<void>;
+    /**
+     * Set multiple entities in a batch.
+     * @param entities The entities to set.
+     * @returns Nothing.
+     */
+    setBatch(entities: T[]): Promise<void>;
     /**
      * Get an entity.
      * @param id The id of the entity to get, or the index value if secondaryIndex is set.
@@ -40,20 +46,26 @@ export interface IEntityStorageConnector<T = unknown> extends IComponent {
         property: keyof T;
         value: unknown;
     }[]): Promise<void>;
+    /**
+     * Remove multiple entities by id.
+     * @param ids The ids of the entities to remove.
+     * @returns Nothing.
+     */
+    removeBatch(ids: string[]): Promise<void>;
     /**
      * Query 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.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit 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.
      */
     query(conditions?: EntityCondition<T>, sortProperties?: {
         property: keyof T;
         sortDirection: SortDirection;
-    }[], properties?: (keyof T)[], cursor?: string, pageSize?: number): Promise<{
+    }[], properties?: (keyof T)[], cursor?: string, limit?: number): Promise<{
         /**
          * The entities, which can be partial if a limited keys list was provided.
          */
@@ -63,4 +75,14 @@ export interface IEntityStorageConnector<T = unknown> extends IComponent {
          */
         cursor?: string;
     }>;
+    /**
+     * Remove all entities from the storage.
+     * @returns Nothing.
+     */
+    empty(): Promise<void>;
+    /**
+     * Count all the entities which match the conditions.
+     * @returns The total count of entities in the storage.
+     */
+    count(): Promise<number>;
 }

package/dist/types/models/api/IEntityStorageCountRequest.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Count the entries in entity storage.
+ */
+export interface IEntityStorageCountRequest {
+}

package/dist/types/models/api/IEntityStorageCountResponse.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The response for counting entries in entity storage.
+ */
+export interface IEntityStorageCountResponse {
+    /**
+     * The body of the response.
+     */
+    body: {
+        /**
+         * The total count of entities.
+         */
+        count: number;
+    };
+}

package/dist/types/models/api/IEntityStorageEmptyRequest.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Remove all entries from entity storage.
+ */
+export interface IEntityStorageEmptyRequest {
+}

package/dist/types/models/api/IEntityStorageListRequest.d.ts

@@ -24,9 +24,9 @@ export interface IEntityStorageListRequest {
          */
         properties?: string;
         /**
-         * The number of entries to return per page.
+         * Limit the number of entities to return.
          */
-        pageSize?: number | string;
+        limit?: string;
         /**
          * The cursor to get next chunk of data, returned in previous response.
          */

package/dist/types/models/api/IEntityStorageRemoveBatchRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Remove multiple entries from entity storage by id.
+ */
+export interface IEntityStorageRemoveBatchRequest {
+    /**
+     * The ids of the entities to remove.
+     */
+    body: string[];
+}

package/dist/types/models/api/IEntityStorageSetBatchRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Set multiple entries in entity storage.
+ */
+export interface IEntityStorageSetBatchRequest {
+    /**
+     * The entities to set.
+     */
+    body: unknown[];
+}