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

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Synchronised Storage Models
+
+Models which define the structure of the synchronised-storage contracts and connectors.
+
+## Installation
+
+```shell
+npm install @twin.org/synchronised-storage-models
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/cjs/index.cjs

@@ -0,0 +1,40 @@
+'use strict';
+
+// 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 schema type for the synchronised storage.
+     */
+    RegisterSchemaType: "synchronised-storage:register-schema-type",
+    /**
+     * An item was set in the storage by the local node.
+     */
+    LocalItemSet: "synchronised-storage:local-item-set",
+    /**
+     * An item was removed from the storage by the local node.
+     */
+    LocalItemRemove: "synchronised-storage:local-item-remove",
+    /**
+     * A request has been made for a consolidation batch.
+     */
+    ConsolidationBatchRequest: "synchronised-storage:consolidation-batch-request",
+    /**
+     * A response to a consolidation batch.
+     */
+    ConsolidationBatchResponse: "synchronised-storage:consolidation-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"
+};
+
+exports.SynchronisedStorageTopics = SynchronisedStorageTopics;

package/dist/esm/index.mjs

@@ -0,0 +1,38 @@
+// 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 schema type for the synchronised storage.
+     */
+    RegisterSchemaType: "synchronised-storage:register-schema-type",
+    /**
+     * An item was set in the storage by the local node.
+     */
+    LocalItemSet: "synchronised-storage:local-item-set",
+    /**
+     * An item was removed from the storage by the local node.
+     */
+    LocalItemRemove: "synchronised-storage:local-item-remove",
+    /**
+     * A request has been made for a consolidation batch.
+     */
+    ConsolidationBatchRequest: "synchronised-storage:consolidation-batch-request",
+    /**
+     * A response to a consolidation batch.
+     */
+    ConsolidationBatchResponse: "synchronised-storage:consolidation-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"
+};
+
+export { SynchronisedStorageTopics };

package/dist/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./models/api/ISyncChangeSetRequest";
+export * from "./models/eventBus/ISyncConsolidationBatchRequest";
+export * from "./models/eventBus/ISyncConsolidationBatchResponse";
+export * from "./models/eventBus/ISyncItemRemove";
+export * from "./models/eventBus/ISyncItemSet";
+export * from "./models/eventBus/ISyncRegisterSchemaType";
+export * from "./models/ISynchronisedEntity";
+export * from "./models/ISynchronisedStorageComponent";
+export * from "./models/synchronisedStorageTopics";

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

@@ -0,0 +1,13 @@
+/**
+ * The base definition for synchronised entries.
+ */
+export interface ISynchronisedEntity {
+    /**
+     * The date the entry was modified
+     */
+    dateModified: string;
+    /**
+     * The identity of the node that owns the entry.
+     */
+    nodeIdentity: string;
+}

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

@@ -0,0 +1,12 @@
+import type { IComponent } from "@twin.org/core";
+/**
+ * Class for performing synchronised storage operations.
+ */
+export interface ISynchronisedStorageComponent extends IComponent {
+    /**
+     * Synchronise a complete set of changes, assumes this is a trusted node.
+     * @param changeSetStorageId The id of the change set to synchronise in blob storage.
+     * @returns Nothing.
+     */
+    syncChangeSet(changeSetStorageId: string): Promise<void>;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Request a trusted node to perform a sync request for a changeset.
+ */
+export interface ISyncChangeSetRequest {
+    /**
+     * The query parameters.
+     */
+    query: {
+        /**
+         * The storage id of the changeset.
+         */
+        changeSetStorageId: string;
+    };
+}

package/dist/types/models/eventBus/ISyncConsolidationBatchRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Request for a local consolidation batch.
+ */
+export interface ISyncConsolidationBatchRequest {
+    /**
+     * The type of the schema for the entities in the batch.
+     */
+    schemaType: string;
+    /**
+     * The size of the consolidation batch.
+     */
+    consolidationBatchSize: number;
+}

package/dist/types/models/eventBus/ISyncConsolidationBatchResponse.d.ts

@@ -0,0 +1,21 @@
+import type { ISynchronisedEntity } from "../ISynchronisedEntity";
+/**
+ * Response for a local consolidation batch.
+ */
+export interface ISyncConsolidationBatchResponse<T extends ISynchronisedEntity> {
+    /**
+     * The type of the schema for the entities in the batch.
+     */
+    schemaType: string;
+    /**
+     * The entities in the consolidation batch.
+     */
+    entities: {
+        id: string;
+        entity: T;
+    }[];
+    /**
+     * Is this the last entry in the batch?
+     */
+    lastEntry: boolean;
+}

package/dist/types/models/eventBus/ISyncItemRemove.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The payload for an item remove.
+ */
+export interface ISyncItemRemove {
+    /**
+     * The type of the schema being removed.
+     */
+    schemaType: string;
+    /**
+     * The entity being removed from the item set.
+     */
+    id: string;
+}

package/dist/types/models/eventBus/ISyncItemSet.d.ts

@@ -0,0 +1,18 @@
+import type { ISynchronisedEntity } from "../ISynchronisedEntity";
+/**
+ * The payload for an item set.
+ */
+export interface ISyncItemSet<T extends ISynchronisedEntity = ISynchronisedEntity> {
+    /**
+     * The type of the schema being set.
+     */
+    schemaType: string;
+    /**
+     * The id of the item being set.
+     */
+    id: string;
+    /**
+     * The entity being set in the item set.
+     */
+    entity: T;
+}

package/dist/types/models/eventBus/ISyncRegisterSchemaType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Register a type with synchronised storage so that it can perform consolidations.
+ */
+export interface ISyncRegisterSchemaType {
+    /**
+     * The type of the schema being registered.
+     */
+    schemaType: string;
+}

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

@@ -0,0 +1,37 @@
+/**
+ * The topics for synchronised storage event bus notifications.
+ */
+export declare const SynchronisedStorageTopics: {
+    /**
+     * Register a schema type for the synchronised storage.
+     */
+    readonly RegisterSchemaType: "synchronised-storage:register-schema-type";
+    /**
+     * An item was set in the storage by the local node.
+     */
+    readonly LocalItemSet: "synchronised-storage:local-item-set";
+    /**
+     * An item was removed from the storage by the local node.
+     */
+    readonly LocalItemRemove: "synchronised-storage:local-item-remove";
+    /**
+     * A request has been made for a consolidation batch.
+     */
+    readonly ConsolidationBatchRequest: "synchronised-storage:consolidation-batch-request";
+    /**
+     * A response to a consolidation batch.
+     */
+    readonly ConsolidationBatchResponse: "synchronised-storage:consolidation-batch-response";
+    /**
+     * An item was set in the storage by the remote node.
+     */
+    readonly RemoteItemSet: "synchronised-storage:remote-item-set";
+    /**
+     * An item was removed from the storage by the remote node.
+     */
+    readonly RemoteItemRemove: "synchronised-storage:remote-item-remove";
+};
+/**
+ * The topics for synchronised storage event bus notifications.
+ */
+export type SynchronisedStorageTopics = (typeof SynchronisedStorageTopics)[keyof typeof SynchronisedStorageTopics];

package/docs/changelog.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## [0.0.1-next.1](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.0...synchronised-storage-models-v0.0.1-next.1) (2025-07-18)
+
+
+### Features
+
+* initial commit ([16949b8](https://github.com/twinfoundation/synchronised-storage/commit/16949b8e5bdb190f053c52af352290e3fd964f9a))
+
+## @twin.org/synchronised-storage-models - Changelog

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/synchronised-storage-models - Examples

package/docs/reference/index.md

@@ -0,0 +1,20 @@
+# @twin.org/synchronised-storage-models
+
+## Interfaces
+
+- [ISynchronisedEntity](interfaces/ISynchronisedEntity.md)
+- [ISynchronisedStorageComponent](interfaces/ISynchronisedStorageComponent.md)
+- [ISyncChangeSetRequest](interfaces/ISyncChangeSetRequest.md)
+- [ISyncConsolidationBatchRequest](interfaces/ISyncConsolidationBatchRequest.md)
+- [ISyncConsolidationBatchResponse](interfaces/ISyncConsolidationBatchResponse.md)
+- [ISyncItemRemove](interfaces/ISyncItemRemove.md)
+- [ISyncItemSet](interfaces/ISyncItemSet.md)
+- [ISyncRegisterSchemaType](interfaces/ISyncRegisterSchemaType.md)
+
+## Type Aliases
+
+- [SynchronisedStorageTopics](type-aliases/SynchronisedStorageTopics.md)
+
+## Variables
+
+- [SynchronisedStorageTopics](variables/SynchronisedStorageTopics.md)

package/docs/reference/interfaces/ISyncChangeSetRequest.md

@@ -0,0 +1,17 @@
+# Interface: ISyncChangeSetRequest
+
+Request a trusted node to perform a sync request for a changeset.
+
+## Properties
+
+### query
+
+> **query**: `object`
+
+The query parameters.
+
+#### changeSetStorageId
+
+> **changeSetStorageId**: `string`
+
+The storage id of the changeset.

package/docs/reference/interfaces/ISyncConsolidationBatchRequest.md

@@ -0,0 +1,19 @@
+# Interface: ISyncConsolidationBatchRequest
+
+Request for a local consolidation batch.
+
+## Properties
+
+### schemaType
+
+> **schemaType**: `string`
+
+The type of the schema for the entities in the batch.
+
+***
+
+### consolidationBatchSize
+
+> **consolidationBatchSize**: `number`
+
+The size of the consolidation batch.

package/docs/reference/interfaces/ISyncConsolidationBatchResponse.md

@@ -0,0 +1,41 @@
+# Interface: ISyncConsolidationBatchResponse\<T\>
+
+Response for a local consolidation batch.
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`ISynchronisedEntity`](ISynchronisedEntity.md)
+
+## Properties
+
+### schemaType
+
+> **schemaType**: `string`
+
+The type of the schema for the entities in the batch.
+
+***
+
+### entities
+
+> **entities**: `object`[]
+
+The entities in the consolidation batch.
+
+#### id
+
+> **id**: `string`
+
+#### entity
+
+> **entity**: `T`
+
+***
+
+### lastEntry
+
+> **lastEntry**: `boolean`
+
+Is this the last entry in the batch?

package/docs/reference/interfaces/ISyncItemRemove.md

@@ -0,0 +1,19 @@
+# Interface: ISyncItemRemove
+
+The payload for an item remove.
+
+## Properties
+
+### schemaType
+
+> **schemaType**: `string`
+
+The type of the schema being removed.
+
+***
+
+### id
+
+> **id**: `string`
+
+The entity being removed from the item set.

package/docs/reference/interfaces/ISyncItemSet.md

@@ -0,0 +1,33 @@
+# Interface: ISyncItemSet\<T\>
+
+The payload for an item set.
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`ISynchronisedEntity`](ISynchronisedEntity.md) = [`ISynchronisedEntity`](ISynchronisedEntity.md)
+
+## Properties
+
+### schemaType
+
+> **schemaType**: `string`
+
+The type of the schema being set.
+
+***
+
+### id
+
+> **id**: `string`
+
+The id of the item being set.
+
+***
+
+### entity
+
+> **entity**: `T`
+
+The entity being set in the item set.

package/docs/reference/interfaces/ISyncRegisterSchemaType.md

@@ -0,0 +1,11 @@
+# Interface: ISyncRegisterSchemaType
+
+Register a type with synchronised storage so that it can perform consolidations.
+
+## Properties
+
+### schemaType
+
+> **schemaType**: `string`
+
+The type of the schema being registered.

package/docs/reference/interfaces/ISynchronisedEntity.md

@@ -0,0 +1,19 @@
+# Interface: ISynchronisedEntity
+
+The base definition for synchronised entries.
+
+## Properties
+
+### dateModified
+
+> **dateModified**: `string`
+
+The date the entry was modified
+
+***
+
+### nodeIdentity
+
+> **nodeIdentity**: `string`
+
+The identity of the node that owns the entry.

package/docs/reference/interfaces/ISynchronisedStorageComponent.md

@@ -0,0 +1,29 @@
+# Interface: ISynchronisedStorageComponent
+
+Class for performing synchronised storage operations.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### syncChangeSet()
+
+> **syncChangeSet**(`changeSetStorageId`): `Promise`\<`void`\>
+
+Synchronise a complete set of changes, assumes this is a trusted node.
+
+#### Parameters
+
+##### changeSetStorageId
+
+`string`
+
+The id of the change set to synchronise in blob storage.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

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

@@ -0,0 +1,5 @@
+# Type Alias: SynchronisedStorageTopics
+
+> **SynchronisedStorageTopics** = *typeof* [`SynchronisedStorageTopics`](../variables/SynchronisedStorageTopics.md)\[keyof *typeof* [`SynchronisedStorageTopics`](../variables/SynchronisedStorageTopics.md)\]
+
+The topics for synchronised storage event bus notifications.

package/docs/reference/variables/SynchronisedStorageTopics.md

@@ -0,0 +1,49 @@
+# Variable: SynchronisedStorageTopics
+
+> `const` **SynchronisedStorageTopics**: `object`
+
+The topics for synchronised storage event bus notifications.
+
+## Type declaration
+
+### RegisterSchemaType
+
+> `readonly` **RegisterSchemaType**: `"synchronised-storage:register-schema-type"` = `"synchronised-storage:register-schema-type"`
+
+Register a schema type for the synchronised storage.
+
+### LocalItemSet
+
+> `readonly` **LocalItemSet**: `"synchronised-storage:local-item-set"` = `"synchronised-storage:local-item-set"`
+
+An item was set in the storage by the local node.
+
+### LocalItemRemove
+
+> `readonly` **LocalItemRemove**: `"synchronised-storage:local-item-remove"` = `"synchronised-storage:local-item-remove"`
+
+An item was removed from the storage by the local node.
+
+### ConsolidationBatchRequest
+
+> `readonly` **ConsolidationBatchRequest**: `"synchronised-storage:consolidation-batch-request"` = `"synchronised-storage:consolidation-batch-request"`
+
+A request has been made for a consolidation batch.
+
+### ConsolidationBatchResponse
+
+> `readonly` **ConsolidationBatchResponse**: `"synchronised-storage:consolidation-batch-response"` = `"synchronised-storage:consolidation-batch-response"`
+
+A response to a consolidation batch.
+
+### RemoteItemSet
+
+> `readonly` **RemoteItemSet**: `"synchronised-storage:remote-item-set"` = `"synchronised-storage:remote-item-set"`
+
+An item was set in the storage by the remote node.
+
+### RemoteItemRemove
+
+> `readonly` **RemoteItemRemove**: `"synchronised-storage:remote-item-remove"` = `"synchronised-storage:remote-item-remove"`
+
+An item was removed from the storage by the remote node.

package/locales/en.json

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

package/package.json

@@ -0,0 +1,39 @@
+{
+	"name": "@twin.org/synchronised-storage-models",
+	"version": "0.0.1-next.1",
+	"description": "Models which define the structure of the synchronised storage connectors and services",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/synchronised-storage.git",
+		"directory": "packages/synchronised-storage-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}