@twin.org/entity-storage-connector-cosmosdb 0.0.1-next.12

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

@@ -0,0 +1,21 @@
+/**
+ * Configuration for the Cosmos DB Entity Storage Connector.
+ */
+export interface ICosmosDbEntityStorageConnectorConfig {
+    /**
+     * The endpoint for the Cosmos DB instance.
+     */
+    endpoint: string;
+    /**
+     * The primary key for the Cosmos DB instance.
+     */
+    key: string;
+    /**
+     * The ID of the database to be used.
+     */
+    databaseId: string;
+    /**
+     * The ID of the container for the storage.
+     */
+    containerId: string;
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/entity-storage-connector-cosmosdb - Changelog
+
+## v0.0.1-next.12
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/entity-storage-connector-cosmosdb - Examples

package/docs/reference/classes/CosmosDbEntityStorageConnector.md

@@ -0,0 +1,246 @@
+# Class: CosmosDbEntityStorageConnector\<T\>
+
+Class for performing entity storage operations using Cosmos DB.
+
+## Type Parameters
+
+• **T** = `unknown`
+
+## Implements
+
+- `IEntityStorageConnector`\<`T`\>
+
+## Constructors
+
+### new CosmosDbEntityStorageConnector()
+
+> **new CosmosDbEntityStorageConnector**\<`T`\>(`options`): [`CosmosDbEntityStorageConnector`](CosmosDbEntityStorageConnector.md)\<`T`\>
+
+Create a new instance of CosmosDbEntityStorageConnector.
+
+#### Parameters
+
+• **options**
+
+The options for the connector.
+
+• **options.entitySchema**: `string`
+
+The schema for the entity.
+
+• **options.loggingConnectorType?**: `string`
+
+The type of logging connector to use, defaults to no logging.
+
+• **options.config**: [`ICosmosDbEntityStorageConnectorConfig`](../interfaces/ICosmosDbEntityStorageConnectorConfig.md)
+
+The configuration for the connector.
+
+#### Returns
+
+[`CosmosDbEntityStorageConnector`](CosmosDbEntityStorageConnector.md)\<`T`\>
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IEntityStorageConnector.CLASS_NAME`
+
+## Methods
+
+### bootstrap()
+
+> **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\>
+
+Initialize the Cosmos DB environment.
+
+#### Parameters
+
+• **nodeLoggingConnectorType?**: `string`
+
+Optional type of the logging connector.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+A promise that resolves to a boolean indicating success.
+
+#### Implementation of
+
+`IEntityStorageConnector.bootstrap`
+
+***
+
+### getSchema()
+
+> **getSchema**(): `IEntitySchema`\<`unknown`\>
+
+Get the schema for the entities.
+
+#### Returns
+
+`IEntitySchema`\<`unknown`\>
+
+The schema for the entities.
+
+#### Implementation of
+
+`IEntityStorageConnector.getSchema`
+
+***
+
+### get()
+
+> **get**(`id`, `secondaryIndex`?, `conditions`?): `Promise`\<`undefined` \| `T`\>
+
+Get an entity from Cosmos DB.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the entity to get, or the index value if secondaryIndex is set.
+
+• **secondaryIndex?**: keyof `T`
+
+Get the item using a secondary index.
+
+• **conditions?**: `object`[]
+
+The optional conditions to match for the entities.
+
+#### Returns
+
+`Promise`\<`undefined` \| `T`\>
+
+The object if it can be found or undefined.
+
+#### Implementation of
+
+`IEntityStorageConnector.get`
+
+***
+
+### set()
+
+> **set**(`entity`, `conditions`?): `Promise`\<`void`\>
+
+Set an entity.
+
+#### Parameters
+
+• **entity**: `T`
+
+The entity to set.
+
+• **conditions?**: `object`[]
+
+The optional conditions to match for the entities.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+The id of the entity.
+
+#### Implementation of
+
+`IEntityStorageConnector.set`
+
+***
+
+### remove()
+
+> **remove**(`id`, `conditions`?): `Promise`\<`void`\>
+
+Remove the entity.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the entity to remove.
+
+• **conditions?**: `object`[]
+
+The optional conditions to match for the entities.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageConnector.remove`
+
+***
+
+### query()
+
+> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+
+Find all the entities which match the conditions.
+
+#### Parameters
+
+• **conditions?**: `EntityCondition`\<`T`\>
+
+The conditions to match for the entities.
+
+• **sortProperties?**: `object`[]
+
+The optional sort order.
+
+• **properties?**: keyof `T`[]
+
+The optional properties to return, defaults to all.
+
+• **cursor?**: `string`
+
+The cursor to request the next page of entities.
+
+• **pageSize?**: `number`
+
+The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+All the entities for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+##### entities
+
+> **entities**: `Partial`\<`T`\>[]
+
+##### cursor?
+
+> `optional` **cursor**: `string`
+
+#### Implementation of
+
+`IEntityStorageConnector.query`
+
+***
+
+### containerDelete()
+
+> **containerDelete**(): `Promise`\<`void`\>
+
+Delete the container.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/index.md

@@ -0,0 +1,9 @@
+# @twin.org/entity-storage-connector-cosmosdb
+
+## Classes
+
+- [CosmosDbEntityStorageConnector](classes/CosmosDbEntityStorageConnector.md)
+
+## Interfaces
+
+- [ICosmosDbEntityStorageConnectorConfig](interfaces/ICosmosDbEntityStorageConnectorConfig.md)

package/docs/reference/interfaces/ICosmosDbEntityStorageConnectorConfig.md

@@ -0,0 +1,35 @@
+# Interface: ICosmosDbEntityStorageConnectorConfig
+
+Configuration for the Cosmos DB Entity Storage Connector.
+
+## Properties
+
+### endpoint
+
+> **endpoint**: `string`
+
+The endpoint for the Cosmos DB instance.
+
+***
+
+### key
+
+> **key**: `string`
+
+The primary key for the Cosmos DB instance.
+
+***
+
+### databaseId
+
+> **databaseId**: `string`
+
+The ID of the database to be used.
+
+***
+
+### containerId
+
+> **containerId**: `string`
+
+The ID of the container for the storage.

package/locales/en.json

@@ -0,0 +1,23 @@
+{
+	"info": {
+		"cosmosDbEntityStorageConnector": {
+			"databaseCreating": "Database \"{databaseName}\" creating",
+			"databaseExists": "Database \"{databaseName}\" created or it already exists",
+			"containerExists": "Container \"{containerName}\" created or it already exists"
+		}
+	},
+	"error": {
+		"cosmosDbEntityStorageConnector": {
+			"setFailed": "Unable to set entity \"{id}\"",
+			"getFailed": "Unable to get entity \"{id}\"",
+			"removeFailed": "Unable to remove entity \"{id}\"",
+			"queryFailed": "The query failed",
+			"comparisonNotSupported": "Comparison operator \"{comparison}\" is not supported",
+			"conditionalNotSupported": "Conditional operator \"{operator}\" is not supported",
+			"sortSingle": "You can only sort by a single property",
+			"sortNotIndexed": "The property \"{property}\" is not indexed and cannot be used for sorting",
+			"containerNotExisting": "The expected container definition is undefined",
+			"containerNotCreated": "The container couldn't be created"
+		}
+	}
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "@twin.org/entity-storage-connector-cosmosdb",
+	"version": "0.0.1-next.12",
+	"description": "Entity Storage connector implementation using CosmosDB storage",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/entity-storage.git",
+		"directory": "packages/entity-storage-connector-cosmosdb"
+	},
+	"author": "adrian.sanchez.sequeira@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@azure/cosmos": "^4.1.1",
+		"@azure/identity": "^4.4.1",
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-models": "0.0.1-next.12",
+		"@twin.org/logging-models": "next",
+		"@twin.org/nameof": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}