@twin.org/synchronised-storage-service 0.0.1-next.9 → 0.0.3-next.1

package/docs/reference/classes/SynchronisedStorageService.md

@@ -1,13 +1,7 @@
-# Class: SynchronisedStorageService\<T\>
+# Class: SynchronisedStorageService
 
 Class for performing synchronised storage operations.
 
-## Type Parameters
-
-### T
-
-`T` *extends* `ISynchronisedEntity` = `ISynchronisedEntity`
-
 ## Implements
 
 - `ISynchronisedStorageComponent`
@@ -16,7 +10,7 @@ Class for performing synchronised storage operations.
 
 ### Constructor
 
-> **new SynchronisedStorageService**\<`T`\>(`options`): `SynchronisedStorageService`\<`T`\>
+> **new SynchronisedStorageService**(`options`): `SynchronisedStorageService`
 
 Create a new instance of SynchronisedStorageService.
 
@@ -30,45 +24,49 @@ The options for the service.
 
 #### Returns
 
-`SynchronisedStorageService`\<`T`\>
+`SynchronisedStorageService`
 
 ## Properties
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
+## Methods
 
-`ISynchronisedStorageComponent.CLASS_NAME`
+### className()
 
-## Methods
+> **className**(): `string`
 
-### start()
+Returns the class name of the component.
+
+#### Returns
 
-> **start**(`nodeIdentity`, `nodeLoggingConnectorType`, `componentState?`): `Promise`\<`void`\>
+`string`
 
-The component needs to be started when the node is initialized.
+The class name of the component.
 
-#### Parameters
+#### Implementation of
 
-##### nodeIdentity
+`ISynchronisedStorageComponent.className`
 
-`string`
+***
+
+### start()
 
-The identity of the node starting the component.
+> **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 
-##### nodeLoggingConnectorType
+The component needs to be started when the node is initialized.
 
-The node logging connector type, defaults to "node-logging".
+#### Parameters
 
-`undefined` | `string`
+##### nodeLoggingComponentType?
 
-##### componentState?
+`string`
 
-A persistent state which can be modified by the method.
+The node logging component type.
 
 #### Returns
 
@@ -84,27 +82,17 @@ Nothing.
 
 ### stop()
 
-> **stop**(`nodeIdentity`, `nodeLoggingConnectorType`, `componentState?`): `Promise`\<`void`\>
+> **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 
 The component needs to be stopped when the node is closed.
 
 #### Parameters
 
-##### nodeIdentity
+##### nodeLoggingComponentType?
 
 `string`
 
-The identity of the node stopping the component.
-
-##### nodeLoggingConnectorType
-
-The node logging connector type, defaults to "node-logging".
-
-`undefined` | `string`
-
-##### componentState?
-
-A persistent state which can be modified by the method.
+The node logging component type.
 
 #### Returns
 
@@ -120,24 +108,18 @@ Nothing.
 
 ### getDecryptionKey()
 
-> **getDecryptionKey**(`nodeIdentity`, `proof`): `Promise`\<`string`\>
+> **getDecryptionKey**(`actionRequest`): `Promise`\<`string`\>
 
 Get the decryption key for the synchronised storage.
 This is used to decrypt the data stored in the synchronised storage.
 
 #### Parameters
 
-##### nodeIdentity
-
-`string`
-
-The identity of the node requesting the decryption key.
+##### actionRequest
 
-##### proof
+`IIdentityAuthenticationActionRequest`
 
-`IProof`
-
-The proof of the request so we know the request is from the specified node.
+The action request used in the verifiable credential.
 
 #### Returns
 
@@ -153,7 +135,7 @@ The decryption key.
 
 ### syncChangeSet()
 
-> **syncChangeSet**(`syncChangeSet`): `Promise`\<`void`\>
+> **syncChangeSet**(`syncChangeSet`, `actionRequest`): `Promise`\<`void`\>
 
 Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
 
@@ -161,10 +143,16 @@ Synchronise a set of changes from an untrusted node, assumes this is a trusted n
 
 ##### syncChangeSet
 
-`ISyncChangeSet`\<`T`\>
+`ISyncChangeSet`
 
 The change set to synchronise.
 
+##### actionRequest
+
+`IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.
+
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/interfaces/ISynchronisedStorageServiceConfig.md

@@ -4,20 +4,6 @@ Configuration for the Synchronised Storage Service.
 
 ## Properties
 
-### synchronisedStorageMethodId?
-
-> `optional` **synchronisedStorageMethodId**: `string`
-
-The id of the identity method to use when signing/verifying requests and changesets.
-
-#### Default
-
-```ts
-synchronised-storage-assertion
-```
-
-***
-
 ### entityUpdateIntervalMinutes?
 
 > `optional` **entityUpdateIntervalMinutes**: `number`
@@ -36,7 +22,7 @@ How often to check for entity updates in minutes.
 
 > `optional` **consolidationIntervalMinutes**: `number`
 
-Interval to perform consolidation of changesets, only used if isTrustedNode is set.
+Interval to perform consolidation of changesets, only used if this is a trusted node.
 
 #### Default
 
@@ -50,7 +36,7 @@ Interval to perform consolidation of changesets, only used if isTrustedNode is s
 
 > `optional` **consolidationBatchSize**: `number`
 
-The number of entities to process in a single consolidation batch.
+The number of entities to process in a single consolidation batch, only used if this is a trusted node.
 
 #### Default
 
@@ -64,7 +50,7 @@ The number of entities to process in a single consolidation batch.
 
 > `optional` **maxConsolidations**: `number`
 
-The maximum number of consolidations to keep in storage.
+The maximum number of consolidations to keep in storage, only used if this is a trusted node.
 
 #### Default
 

package/docs/reference/interfaces/ISynchronisedStorageServiceConstructorOptions.md

@@ -70,30 +70,31 @@ verifiable-storage
 
 ***
 
-### identityConnectorType?
+### taskSchedulerComponentType?
 
-> `optional` **identityConnectorType**: `string`
+> `optional` **taskSchedulerComponentType**: `string`
 
-The identity connector.
+The task scheduler component.
 
 #### Default
 
 ```ts
-identity
+task-scheduler
 ```
 
 ***
 
-### taskSchedulerComponentType?
+### policyEnforcementPointComponentType?
 
-> `optional` **taskSchedulerComponentType**: `string`
+> `optional` **policyEnforcementPointComponentType**: `string`
 
-The task scheduler component.
+The rights management enforcement component to use for verifying untrusted node access.
+Only required on a trusted node to enforce access control.
 
 #### Default
 
 ```ts
-task-scheduler
+policy-enforcement-point
 ```
 
 ***

package/locales/en.json

@@ -3,11 +3,6 @@
 		"changeSetHelper": {
 			"changeSetApplyingChange": "Applying remote sync change with operation id \"{operation}\" for item with id \"{id}\"",
 			"changeSetStoring": "Storing remote sync change set with id \"{id}\"",
-			"verifyChangeSetProofMissing": "Verifying change set with id \"{id}\" failed, missing proof",
-			"verifyChangeSetProofInvalid": "Verifying change set with id \"{id}\" failed, missing proof",
-			"verifyChangeSetProofNodeIdentityMismatch": "Verifying change set with id \"{id}\" failed, the node identity does not match the proof",
-			"verifyChangeSetProofValid": "Verifying change set with id \"{id}\" succeeded",
-			"createdChangeSetProof": "Created change proof for change set with id \"{id}\", proof value is \"{proofValue}\"",
 			"getChangeSet": "Retrieving change set with id \"{changeSetStorageId}\"",
 			"getChangeSetEmpty": "No change set found with id \"{changeSetStorageId}\"",
 			"copyChangeSet": "Copying change set with id \"{changeSetStorageId}\"",
@@ -41,7 +36,9 @@
 			"consolidationCompleted": "Consolidation of remote sync state completed",
 			"addChangeSetToSyncState": "Adding change set with id \"{changeSetStorageId}\" to remote sync state for storage key \"{storageKey}\"",
 			"buildingChangeSet": "Building change set for storage key \"{storageKey}\" with \"{changeCount}\" changes",
-			"finalisingSyncChanges": "Finalising sync changes for storage key \"{storageKey}\""
+			"finalisingSyncChanges": "Finalising sync changes for storage key \"{storageKey}\"",
+			"createChangeSetRequestingItem": "Creating change set for key \"{storageKey}\", requesting item with id \"{id}\"",
+			"createChangeSetRespondingItem": "Responding to change set request for key \"{storageKey}\", item with id \"{id}\""
 		},
 		"synchronisedStorageService": {
 			"registerStorageKey": "Registering synchronised storage key \"{storageKey}\"",
@@ -52,10 +49,9 @@
 			"updateFromLocalSyncStateNoChanges": "No changes found in local sync state for key \"{storageKey}\", skipping update",
 			"builtStorageChangeSet": "Built storage change set for key \"{storageKey}\" with id \"{changeSetStorageId}\"",
 			"builtStorageChangeSetNone": "No changes found for key \"{storageKey}\", no storage change set created",
-			"createChangeSetRequestingItem": "Creating change set for key \"{storageKey}\", requesting item with id \"{id}\"",
-			"createChangeSetRespondingItem": "Responding to change set request for key \"{storageKey}\", item with id \"{id}\"",
 			"sendingChangeSetToTrustedNode": "Sending change set with id \"{changeSetStorageId}\" to trusted node for key \"{storageKey}\"",
-			"syncChangeSetForRemoteNode": "Synchronising change set with id \"{changeSetStorageId}\" for remote node for type \"{storageKey}\""
+			"decryptionKeyRequest": "Decryption key requested by node identity \"{nodeId}\"",
+			"syncChangeSetForRemoteNode": "Synchronising change set with id \"{changeSetStorageId}\" for node identity \"{nodeId}\""
 		},
 		"blobStorageHelper": {
 			"loadBlob": "Loading blob with id \"{blobId}\"",
@@ -69,16 +65,14 @@
 		}
 	},
 	"error": {
-		"synchronisedEntityStorageConnector": {
-			"missingRequiredProperty": "To use synchronised entity storage the entity schema must contain the property \"{requiredProperty}\"",
-			"missingRequiredPropertySort": "To use synchronised entity storage the entity schema must contain the property \"{requiredProperty}\" and it must be sortable"
-		},
 		"synchronisedStorageService": {
 			"notTrustedNode": "This method can only be called on a trusted node",
 			"entitySyncFailed": "Failed to sync synchronised entity storage connector",
 			"consolidationSyncFailed": "Failed to consolidate synchronised entity storage connector",
-			"invalidProof": "Invalid proof provided for synchronised entity storage connector",
-			"decryptionKeyNotFound": "Decryption key not found, ensure the synchronised storage component is initialised and the decryption key is set"
+			"decryptionKeyNotAllowed": "The node identity \"{nodeId}\" is not allowed to retrieve the decryption key",
+			"changeSetNotAllowed": "The node identity \"{nodeId}\" is not allowed to sync the change set with id \"{changeSetStorageId}\"",
+			"decryptionKeyNotFound": "Decryption key not found, ensure the synchronised storage component is initialised and the decryption key is set",
+			"incorrectActionType": "Incorrect action in credential \"{action}\", expecting \"{expecting}\""
 		},
 		"remoteSyncStateHelper": {
 			"finalisingSyncChangesFailed": "Failed to finalise sync changes for storage key \"{storageKey}\""
@@ -86,7 +80,8 @@
 		"blobStorageHelper": {
 			"loadBlobFailed": "Failed to load blob with id \"{blobId}\"",
 			"saveBlobFailed": "Failed to save blob",
-			"notTrustedNode": "Cannot save blob, this is not a trusted node"
+			"notTrustedNode": "Cannot save blob, this is not a trusted node",
+			"removeBlobFailed": "Failed to remove blob with id \"{blobId}\""
 		}
 	},
 	"warn": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/synchronised-storage-service",
-	"version": "0.0.1-next.9",
+	"version": "0.0.3-next.1",
 	"description": "Synchronised storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -17,35 +17,52 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/background-task-models": "next",
 		"@twin.org/blob-storage-models": "next",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/event-bus-models": "next",
+		"@twin.org/identity-authentication": "next",
 		"@twin.org/identity-models": "next",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next",
+		"@twin.org/rights-management-models": "next",
 		"@twin.org/standards-w3c-did": "next",
-		"@twin.org/synchronised-storage-models": "0.0.1-next.9",
+		"@twin.org/standards-w3c-odrl": "next",
+		"@twin.org/synchronised-storage-models": "0.0.3-next.1",
 		"@twin.org/verifiable-storage-models": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"synchronised-storage",
+		"service",
+		"microservice",
+		"business-logic"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/synchronised-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }