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

package/dist/es/index.js

@@ -0,0 +1,13 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./entities/syncSnapshotEntry.js";
+export * from "./models/ISynchronisedStorageServiceConfig.js";
+export * from "./models/ISynchronisedStorageServiceConstructorOptions.js";
+export * from "./models/ISyncPointerStore.js";
+export * from "./models/ISyncSnapshot.js";
+export * from "./models/ISyncState.js";
+export * from "./restEntryPoints.js";
+export * from "./schema.js";
+export * from "./synchronisedStorageRoutes.js";
+export * from "./synchronisedStorageService.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,2DAA2D,CAAC;AAC1E,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./entities/syncSnapshotEntry.js\";\nexport * from \"./models/ISynchronisedStorageServiceConfig.js\";\nexport * from \"./models/ISynchronisedStorageServiceConstructorOptions.js\";\nexport * from \"./models/ISyncPointerStore.js\";\nexport * from \"./models/ISyncSnapshot.js\";\nexport * from \"./models/ISyncState.js\";\nexport * from \"./restEntryPoints.js\";\nexport * from \"./schema.js\";\nexport * from \"./synchronisedStorageRoutes.js\";\nexport * from \"./synchronisedStorageService.js\";\n"]}

package/dist/es/models/ISyncPointerStore.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ISyncPointerStore.js.map

package/dist/es/models/ISyncPointerStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISyncPointerStore.js","sourceRoot":"","sources":["../../../src/models/ISyncPointerStore.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The object definition for the sync pointer store.\n */\nexport interface ISyncPointerStore {\n\t/**\n\t * The version of the sync pointer store.\n\t */\n\tversion: string;\n\n\t/**\n\t * The mapping from storage keys to sync pointers.\n\t */\n\tsyncPointers: { [key: string]: string };\n}\n"]}

package/dist/es/models/ISyncSnapshot.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ISyncSnapshot.js.map

package/dist/es/models/ISyncSnapshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISyncSnapshot.js","sourceRoot":"","sources":["../../../src/models/ISyncSnapshot.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The object definition for a sync snapshot.\n */\nexport interface ISyncSnapshot {\n\t/**\n\t * The version of the sync state.\n\t */\n\tversion: string;\n\n\t/**\n\t * The id of the snapshot.\n\t */\n\tid: string;\n\n\t/**\n\t * The date the snapshot was created.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The date the snapshot was last modified.\n\t */\n\tdateModified: string;\n\n\t/**\n\t * Is this a consolidated snapshot?\n\t */\n\tisConsolidated: boolean;\n\n\t/**\n\t * The epoch of the snapshot.\n\t */\n\tepoch: number;\n\n\t/**\n\t * The ids of the storage for the change sets in the snapshot.\n\t */\n\tchangeSetStorageIds: string[];\n}\n"]}

package/dist/es/models/ISyncState.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ISyncState.js.map

package/dist/es/models/ISyncState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISyncState.js","sourceRoot":"","sources":["../../../src/models/ISyncState.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISyncSnapshot } from \"./ISyncSnapshot.js\";\n\n/**\n * The object definition for a sync state.\n */\nexport interface ISyncState {\n\t/**\n\t * The version of the sync state.\n\t */\n\tversion: string;\n\n\t/**\n\t * The storage type contained in the sync state.\n\t */\n\tstorageKey: string;\n\n\t/**\n\t * The snapshots.\n\t */\n\tsnapshots: ISyncSnapshot[];\n}\n"]}

package/dist/es/models/ISynchronisedStorageServiceConfig.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ISynchronisedStorageServiceConfig.js.map

package/dist/es/models/ISynchronisedStorageServiceConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISynchronisedStorageServiceConfig.js","sourceRoot":"","sources":["../../../src/models/ISynchronisedStorageServiceConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for the Synchronised Storage Service.\n */\nexport interface ISynchronisedStorageServiceConfig {\n\t/**\n\t * How often to check for entity updates in minutes.\n\t * @default 5\n\t */\n\tentityUpdateIntervalMinutes?: number;\n\n\t/**\n\t * Interval to perform consolidation of changesets, only used if this is a trusted node.\n\t * @default 60\n\t */\n\tconsolidationIntervalMinutes?: number;\n\n\t/**\n\t * The number of entities to process in a single consolidation batch, only used if this is a trusted node.\n\t * @default 1000\n\t */\n\tconsolidationBatchSize?: number;\n\n\t/**\n\t * The maximum number of consolidations to keep in storage, only used if this is a trusted node.\n\t * @default 5\n\t */\n\tmaxConsolidations?: number;\n\n\t/**\n\t * The encryption key id from the vault to use for blob storage, only required for trusted nodes, untrusted nodes will request the key.\n\t * @default synchronised-storage-blob-encryption-key\n\t */\n\tblobStorageEncryptionKeyId?: string;\n\n\t/**\n\t * The verifiable storage key to use, already expected to be created.\n\t * if the key is not found in the keys.json it is considered to be a custom verifiable storage id.\n\t * @default local\n\t */\n\tverifiableStorageKeyId: \"mainnet\" | \"testnet\" | \"devnet\" | string;\n\n\t/**\n\t * Override the default trust generator.\n\t */\n\toverrideTrustGeneratorType?: string;\n}\n"]}

package/dist/es/models/ISynchronisedStorageServiceConstructorOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ISynchronisedStorageServiceConstructorOptions.js.map

package/dist/es/models/ISynchronisedStorageServiceConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISynchronisedStorageServiceConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/ISynchronisedStorageServiceConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISynchronisedStorageServiceConfig } from \"./ISynchronisedStorageServiceConfig.js\";\n\n/**\n * Options for the Synchronised Storage Service constructor.\n */\nexport interface ISynchronisedStorageServiceConstructorOptions {\n\t/**\n\t * The logging component.\n\t */\n\tloggingComponentType?: string;\n\n\t/**\n\t * The event bus component type.\n\t */\n\teventBusComponentType?: string;\n\n\t/**\n\t * The vault connector type.\n\t */\n\tvaultConnectorType?: string;\n\n\t/**\n\t * The entity storage connector type to use for sync snapshots.\n\t * @default sync-snapshot-entry\n\t */\n\tsyncSnapshotStorageConnectorType?: string;\n\n\t/**\n\t * The blob storage connector used for remote sync state.\n\t * @default blob-storage\n\t */\n\tblobStorageConnectorType?: string;\n\n\t/**\n\t * The verifiable storage connector type to use for decentralised state.\n\t * @default verifiable-storage\n\t */\n\tverifiableStorageConnectorType?: string;\n\n\t/**\n\t * The task scheduler component.\n\t * @default task-scheduler\n\t */\n\ttaskSchedulerComponentType?: string;\n\n\t/**\n\t * The type of the trust component.\n\t * @default trust\n\t */\n\ttrustComponentType?: string;\n\n\t/**\n\t * The synchronised entity storage component type to use if this node is not trusted.\n\t * If this is set, this node uses it as the trusted node to store changesets.\n\t */\n\ttrustedSynchronisedStorageComponentType?: string;\n\n\t/**\n\t * The configuration for the connector.\n\t */\n\tconfig: ISynchronisedStorageServiceConfig;\n}\n"]}

package/dist/es/restEntryPoints.js

@@ -0,0 +1,10 @@
+import { generateRestRoutesSynchronisedStorage, tagsSynchronisedStorage } from "./synchronisedStorageRoutes.js";
+export const restEntryPoints = [
+    {
+        name: "synchronised-storage",
+        defaultBaseRoute: "synchronised-storage",
+        tags: tagsSynchronisedStorage,
+        generateRoutes: generateRestRoutesSynchronisedStorage
+    }
+];
+//# sourceMappingURL=restEntryPoints.js.map

package/dist/es/restEntryPoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"restEntryPoints.js","sourceRoot":"","sources":["../../src/restEntryPoints.ts"],"names":[],"mappings":"AAGA,OAAO,EACN,qCAAqC,EACrC,uBAAuB,EACvB,MAAM,gCAAgC,CAAC;AAExC,MAAM,CAAC,MAAM,eAAe,GAA2B;IACtD;QACC,IAAI,EAAE,sBAAsB;QAC5B,gBAAgB,EAAE,sBAAsB;QACxC,IAAI,EAAE,uBAAuB;QAC7B,cAAc,EAAE,qCAAqC;KACrD;CACD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteEntryPoint } from \"@twin.org/api-models\";\nimport {\n\tgenerateRestRoutesSynchronisedStorage,\n\ttagsSynchronisedStorage\n} from \"./synchronisedStorageRoutes.js\";\n\nexport const restEntryPoints: IRestRouteEntryPoint[] = [\n\t{\n\t\tname: \"synchronised-storage\",\n\t\tdefaultBaseRoute: \"synchronised-storage\",\n\t\ttags: tagsSynchronisedStorage,\n\t\tgenerateRoutes: generateRestRoutesSynchronisedStorage\n\t}\n];\n"]}

package/dist/es/schema.js

@@ -0,0 +1,11 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { EntitySchemaFactory, EntitySchemaHelper } from "@twin.org/entity";
+import { SyncSnapshotEntry } from "./entities/syncSnapshotEntry.js";
+/**
+ * Initialize the schema for the synchronised service.
+ */
+export function initSchema() {
+    EntitySchemaFactory.register("SyncSnapshotEntry", () => EntitySchemaHelper.getSchema(SyncSnapshotEntry));
+}
+//# sourceMappingURL=schema.js.map

package/dist/es/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/schema.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAEpE;;GAEG;AACH,MAAM,UAAU,UAAU;IACzB,mBAAmB,CAAC,QAAQ,sBAA8B,GAAG,EAAE,CAC9D,kBAAkB,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAC/C,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { EntitySchemaFactory, EntitySchemaHelper } from \"@twin.org/entity\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { SyncSnapshotEntry } from \"./entities/syncSnapshotEntry.js\";\n\n/**\n * Initialize the schema for the synchronised service.\n */\nexport function initSchema(): void {\n\tEntitySchemaFactory.register(nameof<SyncSnapshotEntry>(), () =>\n\t\tEntitySchemaHelper.getSchema(SyncSnapshotEntry)\n\t);\n}\n"]}

package/dist/es/synchronisedStorageRoutes.js

@@ -0,0 +1,142 @@
+import { ComponentFactory, Guards } from "@twin.org/core";
+import { SynchronisedStorageContexts, SynchronisedStorageTypes } from "@twin.org/synchronised-storage-models";
+import { HeaderHelper, HeaderTypes, HttpStatusCode } from "@twin.org/web";
+/**
+ * The source used when communicating about these routes.
+ */
+const ROUTES_SOURCE = "synchronisedStorageRoutes";
+/**
+ * The tag to associate with the routes.
+ */
+export const tagsSynchronisedStorage = [
+    {
+        name: "Synchronised Storage",
+        description: "Endpoints which are modelled to access a synchronised storage contract."
+    }
+];
+/**
+ * The REST routes for synchronised storage.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @returns The generated routes.
+ */
+export function generateRestRoutesSynchronisedStorage(baseRouteName, componentName) {
+    const syncChangeSetRoute = {
+        operationId: "synchronisedStorageSyncChangeSetRequest",
+        summary: "Request that the node perform a sync request for a changeset.",
+        tag: tagsSynchronisedStorage[0].name,
+        method: "POST",
+        path: `${baseRouteName}/sync-changeset`,
+        handler: async (httpRequestContext, request) => synchronisedStorageSyncChangeSetRequest(httpRequestContext, componentName, request),
+        requestType: {
+            type: "ISyncChangeSetRequest",
+            examples: [
+                {
+                    id: "synchronisedStorageSyncChangeSetRequestExample",
+                    request: {
+                        headers: {
+                            [HeaderTypes.Authorization]: "z3V32BP9ShC...z3V32BP9ShC"
+                        },
+                        body: {
+                            "@context": SynchronisedStorageContexts.ContextRoot,
+                            type: SynchronisedStorageTypes.ChangeSet,
+                            id: "0909090909090909090909090909090909090909090909090909090909090909",
+                            dateCreated: "2025-05-29T01:00:00.000Z",
+                            dateModified: "2025-05-29T01:00:00.000Z",
+                            nodeId: "did:entity-storage:0xd2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2",
+                            changes: [
+                                {
+                                    entity: {
+                                        dateModified: "2025-01-01T00:00:00.000Z"
+                                    },
+                                    id: "test-id-1",
+                                    operation: "set"
+                                }
+                            ],
+                            storageKey: "test-type"
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "INoContentResponse"
+            }
+        ],
+        skipAuth: true
+    };
+    const getDecryptionKeyRoute = {
+        operationId: "synchronisedStorageGetDecryptionKeyRequest",
+        summary: "Request the decryption key.",
+        tag: tagsSynchronisedStorage[0].name,
+        method: "POST",
+        path: `${baseRouteName}/decryption-key`,
+        handler: async (httpRequestContext, request) => synchronisedStorageGetDecryptionKeyRequest(httpRequestContext, componentName, request),
+        requestType: {
+            type: "ISyncChangeSetRequest",
+            examples: [
+                {
+                    id: "synchronisedStorageSyncGetDecryptionKeyRequestExample",
+                    request: {}
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "ISyncDecryptionKeyResponse",
+                examples: [
+                    {
+                        id: "synchronisedStorageSyncGetDecryptionKeyResponseExample",
+                        response: {
+                            body: {
+                                decryptionKey: "z5efBErQs3YBLZoH7jgKMQaRc9YjAxA5XSYKmW3FmTBDw9WionT2NS2x1SMvcRyBvw53cSSoaCT1xQH9tkWngGCX3"
+                            }
+                        }
+                    }
+                ]
+            },
+            {
+                type: "IUnauthorizedResponse"
+            }
+        ],
+        skipAuth: true
+    };
+    return [syncChangeSetRoute, getDecryptionKeyRoute];
+}
+/**
+ * Perform the sync change set operation.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function synchronisedStorageSyncChangeSetRequest(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request.headers", request.headers);
+    Guards.object(ROUTES_SOURCE, "request", request);
+    Guards.object(ROUTES_SOURCE, "request.body", request.body);
+    const component = ComponentFactory.get(componentName);
+    await component.syncChangeSet(request.body, HeaderHelper.extractBearer(httpRequestContext.serverRequest.headers?.[HeaderTypes.Authorization]));
+    return {
+        statusCode: HttpStatusCode.noContent
+    };
+}
+/**
+ * Request the decryption key.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function synchronisedStorageGetDecryptionKeyRequest(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request.headers", request.headers);
+    Guards.object(ROUTES_SOURCE, "request", request);
+    const component = ComponentFactory.get(componentName);
+    const key = await component.getDecryptionKey(HeaderHelper.extractBearer(httpRequestContext.serverRequest.headers?.[HeaderTypes.Authorization]));
+    return {
+        body: {
+            decryptionKey: key
+        }
+    };
+}
+//# sourceMappingURL=synchronisedStorageRoutes.js.map

package/dist/es/synchronisedStorageRoutes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"synchronisedStorageRoutes.js","sourceRoot":"","sources":["../../src/synchronisedStorageRoutes.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAE1D,OAAO,EACN,2BAA2B,EAC3B,wBAAwB,EAKxB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE1E;;GAEG;AACH,MAAM,aAAa,GAAG,2BAA2B,CAAC;AAElD;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAW;IAC9C;QACC,IAAI,EAAE,sBAAsB;QAC5B,WAAW,EAAE,yEAAyE;KACtF;CACD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,qCAAqC,CACpD,aAAqB,EACrB,aAAqB;IAErB,MAAM,kBAAkB,GAA0D;QACjF,WAAW,EAAE,yCAAyC;QACtD,OAAO,EAAE,+DAA+D;QACxE,GAAG,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC,IAAI;QACpC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,GAAG,aAAa,iBAAiB;QACvC,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,uCAAuC,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QACpF,WAAW,EAAE;YACZ,IAAI,yBAAiC;YACrC,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,gDAAgD;oBACpD,OAAO,EAAE;wBACR,OAAO,EAAE;4BACR,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,2BAA2B;yBACxD;wBACD,IAAI,EAAE;4BACL,UAAU,EAAE,2BAA2B,CAAC,WAAW;4BACnD,IAAI,EAAE,wBAAwB,CAAC,SAAS;4BACxC,EAAE,EAAE,kEAAkE;4BACtE,WAAW,EAAE,0BAA0B;4BACvC,YAAY,EAAE,0BAA0B;4BACxC,MAAM,EACL,uFAAuF;4BACxF,OAAO,EAAE;gCACR;oCACC,MAAM,EAAE;wCACP,YAAY,EAAE,0BAA0B;qCACxC;oCACD,EAAE,EAAE,WAAW;oCACf,SAAS,EAAE,KAAK;iCAChB;6BACD;4BACD,UAAU,EAAE,WAAW;yBACvB;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;SACD;QACD,QAAQ,EAAE,IAAI;KACd,CAAC;IAEF,MAAM,qBAAqB,GAAsE;QAChG,WAAW,EAAE,4CAA4C;QACzD,OAAO,EAAE,6BAA6B;QACtC,GAAG,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC,IAAI;QACpC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,GAAG,aAAa,iBAAiB;QACvC,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,0CAA0C,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QACvF,WAAW,EAAE;YACZ,IAAI,yBAAiC;YACrC,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,uDAAuD;oBAC3D,OAAO,EAAE,EAAE;iBACX;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,8BAAsC;gBAC1C,QAAQ,EAAE;oBACT;wBACC,EAAE,EAAE,wDAAwD;wBAC5D,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,aAAa,EACZ,2FAA2F;6BAC5F;yBACD;qBACD;iBACD;aACD;YACD;gBACC,IAAI,yBAAiC;aACrC;SACD;QACD,QAAQ,EAAE,IAAI;KACd,CAAC;IAEF,OAAO,CAAC,kBAAkB,EAAE,qBAAqB,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,uCAAuC,CAC5D,kBAAuC,EACvC,aAAqB,EACrB,OAA8B;IAE9B,MAAM,CAAC,MAAM,CACZ,aAAa,qBAEb,OAAO,CAAC,OAAO,CACf,CAAC;IACF,MAAM,CAAC,MAAM,CAAwB,aAAa,aAAmB,OAAO,CAAC,CAAC;IAC9E,MAAM,CAAC,MAAM,CAAgC,aAAa,kBAAwB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhG,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAgC,aAAa,CAAC,CAAC;IACrF,MAAM,SAAS,CAAC,aAAa,CAC5B,OAAO,CAAC,IAAI,EACZ,YAAY,CAAC,aAAa,CACzB,kBAAkB,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,aAAa,CAAC,CACrE,CACD,CAAC;IACF,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,SAAS;KACpC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,0CAA0C,CAC/D,kBAAuC,EACvC,aAAqB,EACrB,OAAkC;IAElC,MAAM,CAAC,MAAM,CACZ,aAAa,qBAEb,OAAO,CAAC,OAAO,CACf,CAAC;IACF,MAAM,CAAC,MAAM,CAA4B,aAAa,aAAmB,OAAO,CAAC,CAAC;IAElF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAgC,aAAa,CAAC,CAAC;IACrF,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,gBAAgB,CAC3C,YAAY,CAAC,aAAa,CACzB,kBAAkB,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,aAAa,CAAC,CACrE,CACD,CAAC;IACF,OAAO;QACN,IAAI,EAAE;YACL,aAAa,EAAE,GAAG;SAClB;KACD,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIHttpRequestContext,\n\tINoContentResponse,\n\tIRestRoute,\n\tITag,\n\tIUnauthorizedResponse\n} from \"@twin.org/api-models\";\nimport { ComponentFactory, Guards } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport {\n\tSynchronisedStorageContexts,\n\tSynchronisedStorageTypes,\n\ttype ISyncChangeSetRequest,\n\ttype ISyncDecryptionKeyRequest,\n\ttype ISyncDecryptionKeyResponse,\n\ttype ISynchronisedStorageComponent\n} from \"@twin.org/synchronised-storage-models\";\nimport { HeaderHelper, HeaderTypes, HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The source used when communicating about these routes.\n */\nconst ROUTES_SOURCE = \"synchronisedStorageRoutes\";\n\n/**\n * The tag to associate with the routes.\n */\nexport const tagsSynchronisedStorage: ITag[] = [\n\t{\n\t\tname: \"Synchronised Storage\",\n\t\tdescription: \"Endpoints which are modelled to access a synchronised storage contract.\"\n\t}\n];\n\n/**\n * The REST routes for synchronised storage.\n * @param baseRouteName Prefix to prepend to the paths.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @returns The generated routes.\n */\nexport function generateRestRoutesSynchronisedStorage(\n\tbaseRouteName: string,\n\tcomponentName: string\n): IRestRoute[] {\n\tconst syncChangeSetRoute: IRestRoute<ISyncChangeSetRequest, INoContentResponse> = {\n\t\toperationId: \"synchronisedStorageSyncChangeSetRequest\",\n\t\tsummary: \"Request that the node perform a sync request for a changeset.\",\n\t\ttag: tagsSynchronisedStorage[0].name,\n\t\tmethod: \"POST\",\n\t\tpath: `${baseRouteName}/sync-changeset`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tsynchronisedStorageSyncChangeSetRequest(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<ISyncChangeSetRequest>(),\n\t\t\texamples: [\n\t\t\t\t{\n\t\t\t\t\tid: \"synchronisedStorageSyncChangeSetRequestExample\",\n\t\t\t\t\trequest: {\n\t\t\t\t\t\theaders: {\n\t\t\t\t\t\t\t[HeaderTypes.Authorization]: \"z3V32BP9ShC...z3V32BP9ShC\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\"@context\": SynchronisedStorageContexts.ContextRoot,\n\t\t\t\t\t\t\ttype: SynchronisedStorageTypes.ChangeSet,\n\t\t\t\t\t\t\tid: \"0909090909090909090909090909090909090909090909090909090909090909\",\n\t\t\t\t\t\t\tdateCreated: \"2025-05-29T01:00:00.000Z\",\n\t\t\t\t\t\t\tdateModified: \"2025-05-29T01:00:00.000Z\",\n\t\t\t\t\t\t\tnodeId:\n\t\t\t\t\t\t\t\t\"did:entity-storage:0xd2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2\",\n\t\t\t\t\t\t\tchanges: [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tentity: {\n\t\t\t\t\t\t\t\t\t\tdateModified: \"2025-01-01T00:00:00.000Z\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tid: \"test-id-1\",\n\t\t\t\t\t\t\t\t\toperation: \"set\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\tstorageKey: \"test-type\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t}\n\t\t],\n\t\tskipAuth: true\n\t};\n\n\tconst getDecryptionKeyRoute: IRestRoute<ISyncDecryptionKeyRequest, ISyncDecryptionKeyResponse> = {\n\t\toperationId: \"synchronisedStorageGetDecryptionKeyRequest\",\n\t\tsummary: \"Request the decryption key.\",\n\t\ttag: tagsSynchronisedStorage[0].name,\n\t\tmethod: \"POST\",\n\t\tpath: `${baseRouteName}/decryption-key`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tsynchronisedStorageGetDecryptionKeyRequest(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<ISyncChangeSetRequest>(),\n\t\t\texamples: [\n\t\t\t\t{\n\t\t\t\t\tid: \"synchronisedStorageSyncGetDecryptionKeyRequestExample\",\n\t\t\t\t\trequest: {}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<ISyncDecryptionKeyResponse>(),\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"synchronisedStorageSyncGetDecryptionKeyResponseExample\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tdecryptionKey:\n\t\t\t\t\t\t\t\t\t\"z5efBErQs3YBLZoH7jgKMQaRc9YjAxA5XSYKmW3FmTBDw9WionT2NS2x1SMvcRyBvw53cSSoaCT1xQH9tkWngGCX3\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: nameof<IUnauthorizedResponse>()\n\t\t\t}\n\t\t],\n\t\tskipAuth: true\n\t};\n\n\treturn [syncChangeSetRoute, getDecryptionKeyRoute];\n}\n\n/**\n * Perform the sync change set operation.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function synchronisedStorageSyncChangeSetRequest(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: ISyncChangeSetRequest\n): Promise<INoContentResponse> {\n\tGuards.object<ISyncChangeSetRequest[\"headers\"]>(\n\t\tROUTES_SOURCE,\n\t\tnameof(request.headers),\n\t\trequest.headers\n\t);\n\tGuards.object<ISyncChangeSetRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.object<ISyncChangeSetRequest[\"body\"]>(ROUTES_SOURCE, nameof(request.body), request.body);\n\n\tconst component = ComponentFactory.get<ISynchronisedStorageComponent>(componentName);\n\tawait component.syncChangeSet(\n\t\trequest.body,\n\t\tHeaderHelper.extractBearer(\n\t\t\thttpRequestContext.serverRequest.headers?.[HeaderTypes.Authorization]\n\t\t)\n\t);\n\treturn {\n\t\tstatusCode: HttpStatusCode.noContent\n\t};\n}\n\n/**\n * Request the decryption key.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function synchronisedStorageGetDecryptionKeyRequest(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: ISyncDecryptionKeyRequest\n): Promise<ISyncDecryptionKeyResponse> {\n\tGuards.object<ISyncChangeSetRequest[\"headers\"]>(\n\t\tROUTES_SOURCE,\n\t\tnameof(request.headers),\n\t\trequest.headers\n\t);\n\tGuards.object<ISyncDecryptionKeyRequest>(ROUTES_SOURCE, nameof(request), request);\n\n\tconst component = ComponentFactory.get<ISynchronisedStorageComponent>(componentName);\n\tconst key = await component.getDecryptionKey(\n\t\tHeaderHelper.extractBearer(\n\t\t\thttpRequestContext.serverRequest.headers?.[HeaderTypes.Authorization]\n\t\t)\n\t);\n\treturn {\n\t\tbody: {\n\t\t\tdecryptionKey: key\n\t\t}\n\t};\n}\n"]}