@twin.org/synchronised-storage-models 0.0.1-next.8 → 0.0.3-next.1

package/docs/reference/interfaces/ISynchronisedEntity.md

@@ -2,6 +2,10 @@
 
 The base definition for synchronised entries.
 
+## Extends
+
+- [`ISynchronisedEntityCore`](ISynchronisedEntityCore.md)
+
 ## Properties
 
 ### id
@@ -12,16 +16,20 @@ The id of the entry.
 
 ***
 
-### dateModified
+### nodeId?
 
-> **dateModified**: `string`
+> `optional` **nodeId**: `string`
 
-The date the entry was modified
+The identity of the node that owns the entry.
 
 ***
 
-### nodeIdentity
+### dateModified
 
-> **nodeIdentity**: `string`
+> **dateModified**: `string`
 
-The identity of the node that owns the entry.
+The date the entry was modified.
+
+#### Inherited from
+
+[`ISynchronisedEntityCore`](ISynchronisedEntityCore.md).[`dateModified`](ISynchronisedEntityCore.md#datemodified)

package/docs/reference/interfaces/ISynchronisedEntityCore.md

@@ -0,0 +1,15 @@
+# Interface: ISynchronisedEntityCore
+
+The base definition for synchronised entries.
+
+## Extended by
+
+- [`ISynchronisedEntity`](ISynchronisedEntity.md)
+
+## Properties
+
+### dateModified
+
+> **dateModified**: `string`
+
+The date the entry was modified.

package/docs/reference/interfaces/ISynchronisedStorageComponent.md

@@ -10,24 +10,18 @@ Class for performing synchronised storage operations.
 
 ### 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
+##### actionRequest
 
-`string`
+`IIdentityAuthenticationActionRequest`
 
-The identity of the node requesting the decryption key.
-
-##### proof
-
-`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
 
@@ -39,7 +33,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.
 
@@ -51,6 +45,12 @@ Synchronise a set of changes from an untrusted node, assumes this is a trusted n
 
 The change set to synchronise.
 
+##### actionRequest
+
+`IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.
+
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/type-aliases/SyncNodeIdMode.md

@@ -0,0 +1,5 @@
+# Type Alias: SyncNodeIdMode
+
+> **SyncNodeIdMode** = *typeof* [`SyncNodeIdMode`](../variables/SyncNodeIdMode.md)\[keyof *typeof* [`SyncNodeIdMode`](../variables/SyncNodeIdMode.md)\]
+
+The mode to determine how node identities are matched.

package/docs/reference/type-aliases/SynchronisedStorageAssetTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: SynchronisedStorageAssetTypes
+
+> **SynchronisedStorageAssetTypes** = *typeof* [`SynchronisedStorageAssetTypes`](../variables/SynchronisedStorageAssetTypes.md)\[keyof *typeof* [`SynchronisedStorageAssetTypes`](../variables/SynchronisedStorageAssetTypes.md)\]
+
+The ODRL asset types for SynchronisedStorage.

package/docs/reference/type-aliases/SynchronisedStorageContexts.md

@@ -0,0 +1,5 @@
+# Type Alias: SynchronisedStorageContexts
+
+> **SynchronisedStorageContexts** = *typeof* [`SynchronisedStorageContexts`](../variables/SynchronisedStorageContexts.md)\[keyof *typeof* [`SynchronisedStorageContexts`](../variables/SynchronisedStorageContexts.md)\]
+
+The LD Contexts concerning SynchronisedStorage.

package/docs/reference/type-aliases/SynchronisedStorageTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: SynchronisedStorageTypes
+
+> **SynchronisedStorageTypes** = *typeof* [`SynchronisedStorageTypes`](../variables/SynchronisedStorageTypes.md)\[keyof *typeof* [`SynchronisedStorageTypes`](../variables/SynchronisedStorageTypes.md)\]
+
+The types of Synchronised Storage data.

package/docs/reference/variables/SyncChangeOperation.md

@@ -4,7 +4,7 @@
 
 The operations for a change.
 
-## Type declaration
+## Type Declaration
 
 ### Set
 

package/docs/reference/variables/{SyncNodeIdentityMode.md → SyncNodeIdMode.md}

@@ -1,10 +1,10 @@
-# Variable: SyncNodeIdentityMode
+# Variable: SyncNodeIdMode
 
-> `const` **SyncNodeIdentityMode**: `object`
+> `const` **SyncNodeIdMode**: `object`
 
 The mode to determine how node identities are matched.
 
-## Type declaration
+## Type Declaration
 
 ### Local
 

package/docs/reference/variables/SynchronisedStorageAssetTypes.md

@@ -0,0 +1,31 @@
+# Variable: SynchronisedStorageAssetTypes
+
+> `const` **SynchronisedStorageAssetTypes**: `object`
+
+The ODRL asset types for SynchronisedStorage.
+
+## Type Declaration
+
+### DecryptionKey
+
+> `readonly` **DecryptionKey**: `"decryption-key"` = `"decryption-key"`
+
+Decryption Key.
+
+### DecryptionKeyActions
+
+> `readonly` **DecryptionKeyActions**: readonly \[`"read"`\]
+
+Decryption Key Actions.
+
+### ChangeSet
+
+> `readonly` **ChangeSet**: `"change-set"` = `"change-set"`
+
+Change Set.
+
+### ChangeSetActions
+
+> `readonly` **ChangeSetActions**: readonly \[`"write"`\]
+
+Change Set Actions.

package/docs/reference/variables/SynchronisedStorageContexts.md

@@ -0,0 +1,13 @@
+# Variable: SynchronisedStorageContexts
+
+> `const` **SynchronisedStorageContexts**: `object`
+
+The LD Contexts concerning SynchronisedStorage.
+
+## Type Declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/synchronised-storage"` = `"https://schema.twindev.org/synchronised-storage"`
+
+The SynchronisedStorage LD Context.

package/docs/reference/variables/SynchronisedStorageTopics.md

@@ -4,7 +4,7 @@
 
 The topics for synchronised storage event bus notifications.
 
-## Type declaration
+## Type Declaration
 
 ### RegisterStorageKey
 

package/docs/reference/variables/SynchronisedStorageTypes.md

@@ -0,0 +1,19 @@
+# Variable: SynchronisedStorageTypes
+
+> `const` **SynchronisedStorageTypes**: `object`
+
+The types of Synchronised Storage data.
+
+## Type Declaration
+
+### SyncRequest
+
+> `readonly` **SyncRequest**: `"SyncRequest"` = `"SyncRequest"`
+
+Represents a synchronised storage request.
+
+### ChangeSet
+
+> `readonly` **ChangeSet**: `"ChangeSet"` = `"ChangeSet"`
+
+Represents a synchronised storage change set.

package/locales/en.json

@@ -1,3 +1 @@
-{
-	"error": {}
-}
+{}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/synchronised-storage-models",
-	"version": "0.0.1-next.8",
+	"version": "0.0.3-next.1",
 	"description": "Models which define the structure of the synchronised storage connectors and services",
 	"repository": {
 		"type": "git",
@@ -16,25 +16,41 @@
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
+		"@twin.org/identity-authentication": "next",
+		"@twin.org/identity-models": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/standards-w3c-did": "next"
+		"@twin.org/standards-w3c-did": "next",
+		"@twin.org/standards-w3c-odrl": "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",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/synchronised-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,88 +0,0 @@
-'use strict';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The operations for a change.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const SyncChangeOperation = {
-    /**
-     * An item was set in the storage.
-     */
-    Set: "set",
-    /**
-     * An item was deleted from the storage.
-     */
-    Delete: "delete"
-};
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The topics for synchronised storage event bus notifications.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const SynchronisedStorageTopics = {
-    /**
-     * Register a storage key for the synchronised storage.
-     */
-    RegisterStorageKey: "synchronised-storage:register-storage-key",
-    /**
-     * An item was changed in the storage by the local node.
-     */
-    LocalItemChange: "synchronised-storage:local-item-change",
-    /**
-     * A request has been made for a local item.
-     */
-    LocalItemRequest: "synchronised-storage:local-item-request",
-    /**
-     * A response to a local item request.
-     */
-    LocalItemResponse: "synchronised-storage:local-item-response",
-    /**
-     * Reset the storage.
-     */
-    Reset: "synchronised-storage:reset",
-    /**
-     * A request has been made for a batch.
-     */
-    BatchRequest: "synchronised-storage:batch-request",
-    /**
-     * A response to a batch.
-     */
-    BatchResponse: "synchronised-storage:batch-response",
-    /**
-     * An item was set in the storage by the remote node.
-     */
-    RemoteItemSet: "synchronised-storage:remote-item-set",
-    /**
-     * An item was removed from the storage by the remote node.
-     */
-    RemoteItemRemove: "synchronised-storage:remote-item-remove"
-};
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The mode to determine how node identities are matched.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const SyncNodeIdentityMode = {
-    /**
-     * Match the local node identity.
-     */
-    Local: "local",
-    /**
-     * Match all but the local node identity.
-     */
-    Remote: "remote",
-    /**
-     * All match both local and remote entities.
-     */
-    All: "all"
-};
-
-exports.SyncChangeOperation = SyncChangeOperation;
-exports.SyncNodeIdentityMode = SyncNodeIdentityMode;
-exports.SynchronisedStorageTopics = SynchronisedStorageTopics;

package/docs/reference/type-aliases/SyncNodeIdentityMode.md

@@ -1,5 +0,0 @@
-# Type Alias: SyncNodeIdentityMode
-
-> **SyncNodeIdentityMode** = *typeof* [`SyncNodeIdentityMode`](../variables/SyncNodeIdentityMode.md)\[keyof *typeof* [`SyncNodeIdentityMode`](../variables/SyncNodeIdentityMode.md)\]
-
-The mode to determine how node identities are matched.