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

package/docs/reference/classes/FirestoreEntityStorageConnector.md

@@ -0,0 +1,235 @@
+# Class: FirestoreEntityStorageConnector\<T\>
+
+Class for performing entity storage operations using Firestore.
+
+## Type Parameters
+
+• **T** = `unknown`
+
+## Implements
+
+- `IEntityStorageConnector`\<`T`\>
+
+## Constructors
+
+### new FirestoreEntityStorageConnector()
+
+> **new FirestoreEntityStorageConnector**\<`T`\>(`options`): [`FirestoreEntityStorageConnector`](FirestoreEntityStorageConnector.md)\<`T`\>
+
+Create a new instance of FirestoreEntityStorageConnector.
+
+#### 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**: [`IFirestoreEntityStorageConnectorConfig`](../interfaces/IFirestoreEntityStorageConnectorConfig.md)
+
+The configuration for the connector.
+
+#### Returns
+
+[`FirestoreEntityStorageConnector`](FirestoreEntityStorageConnector.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`\>
+
+Bootstrap the component by creating and initializing any resources it needs.
+
+#### Parameters
+
+• **nodeLoggingConnectorType?**: `string`
+
+The node logging connector type, defaults to "node-logging".
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the bootstrapping process was successful.
+
+#### 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.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the entity to get.
+
+• **secondaryIndex?**: keyof `T`
+
+The optional secondary index to use.
+
+• **conditions?**: `object`[]
+
+The optional conditions to apply to the query.
+
+#### 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 apply to the update.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### 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 apply to the delete.
+
+#### 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.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The matching entities and a cursor for the next page.
+
+##### 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

@@ -0,0 +1,9 @@
+# @twin.org/entity-storage-connector-gcp-firestore
+
+## Classes
+
+- [FirestoreEntityStorageConnector](classes/FirestoreEntityStorageConnector.md)
+
+## Interfaces
+
+- [IFirestoreEntityStorageConnectorConfig](interfaces/IFirestoreEntityStorageConnectorConfig.md)

package/docs/reference/interfaces/IFirestoreEntityStorageConnectorConfig.md

@@ -0,0 +1,63 @@
+# Interface: IFirestoreEntityStorageConnectorConfig
+
+Configuration for the Firestore Entity Storage Connector.
+
+## Properties
+
+### projectId
+
+> **projectId**: `string`
+
+The GCP project ID.
+
+***
+
+### databaseId?
+
+> `optional` **databaseId**: `string`
+
+The database ID, if omitted default database will be used.
+
+***
+
+### collectionName
+
+> **collectionName**: `string`
+
+The name of the collection for the storage.
+
+***
+
+### credentials?
+
+> `optional` **credentials**: `string`
+
+The GCP credentials, a base64 encoded version of the JWTInput data type.
+
+***
+
+### endpoint?
+
+> `optional` **endpoint**: `string`
+
+It's usually only used with an emulator (e.g., "localhost:8080").
+
+***
+
+### settings?
+
+> `optional` **settings**: `object`
+
+Optional settings for Firestore client initialization.
+
+#### maxIdleChannels?
+
+> `optional` **maxIdleChannels**: `number`
+
+The maximum number of idle channels to keep open.
+
+#### timeout?
+
+> `optional` **timeout**: `number`
+
+The custom timeout for requests (in milliseconds).

package/locales/en.json

@@ -0,0 +1,23 @@
+{
+	"info": {
+		"firestoreEntityStorageConnector": {
+			"firestoreCreating": "Creating Firestore",
+			"firestoreCreated": "Created Firestore"
+		}
+	},
+	"error": {
+		"firestoreEntityStorageConnector": {
+			"firestoreCreationFailed": "Failed to connect to Firestore",
+			"setEntityFailed": "Failed to set entity \"{id}\"",
+			"getEntityFailed": "Failed to get entity \"{id}\"",
+			"removeEntityFailed": "Failed to remove entity \"{id}\"",
+			"queryFailed": "The query failed when issuing the following command \"{queryDescription}\"",
+			"collectionDeleteFailed": "Failed to delete collection \"{collectionName}\"",
+			"unsupportedComparisonOperator": "Comparison operator \"{comparison}\" is not supported",
+			"firestoreClientNotInitialized": "Firestore client not initialized",
+			"undefinedProperty": "Property \"{key}\" is undefined. Firestore does not support undefined values.",
+			"missingProjectId": "Project ID is required",
+			"documentDoesNotExist": "The document with id {id} does not exist."
+		}
+	}
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+	"name": "@twin.org/entity-storage-connector-gcp-firestore",
+	"version": "0.0.1-next.12",
+	"description": "Entity Storage connector implementation using GCP Firestore storage",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/entity-storage.git",
+		"directory": "packages/entity-storage-connector-gcp-firestore"
+	},
+	"author": "cornel.filip@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@google-cloud/firestore": "^7.10.0",
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-models": "0.0.1-next.6",
+		"@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"
+	]
+}