@twin.org/auditable-item-stream-service 0.0.3-next.20 → 0.0.3-next.22

package/dist/es/auditableItemStreamRoutes.js

@@ -1,12 +1,13 @@
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
-import { HttpParameterHelper } from "@twin.org/api-models";
+import { HttpContextIdKeys, HttpParameterHelper, HttpUrlHelper } from "@twin.org/api-models";
 import { AuditableItemStreamContexts, AuditableItemStreamTypes } from "@twin.org/auditable-item-stream-models";
+import { ContextIdStore } from "@twin.org/context";
 import { Coerce, ComponentFactory, Guards, Is } from "@twin.org/core";
 import { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
 import { HeaderHelper, HeaderTypes, HttpStatusCode, MimeTypes } from "@twin.org/web";
 /**
- * The source used when communicating about these routes.
+ * The source identifier used when communicating errors from these routes.
  */
 const ROUTES_SOURCE = "auditableItemStreamRoutes";
 /**
@@ -975,6 +976,35 @@ export function generateRestRoutesAuditableItemStream(baseRouteName, componentNa
             }
         ]
     };
+    const removeProofRoute = {
+        operationId: "auditableItemStreamRemoveProof",
+        summary: "Remove the proof from a stream",
+        tag: tagsAuditableItemStream[0].name,
+        method: "DELETE",
+        path: `${baseRouteName}/:id/proof`,
+        handler: async (httpRequestContext, request) => auditableItemStreamRemoveProof(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IAuditableItemStreamRemoveProofRequest",
+            examples: [
+                {
+                    id: "auditableItemStreamRemoveProofRequestExample",
+                    request: {
+                        pathParams: {
+                            id: "ais:1234567890"
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "INoContentResponse"
+            },
+            {
+                type: "INotFoundResponse"
+            }
+        ]
+    };
     return [
         createRoute,
         getRoute,
@@ -990,7 +1020,8 @@ export function generateRestRoutesAuditableItemStream(baseRouteName, componentNa
         listEntriesRoute,
         listEntriesNoStreamRoute,
         listEntryObjectsRoute,
-        listEntryObjectsNoStreamRoute
+        listEntryObjectsNoStreamRoute,
+        removeProofRoute
     ];
 }
 /**
@@ -1023,7 +1054,6 @@ export async function auditableItemStreamGet(httpRequestContext, componentName,
     Guards.object(ROUTES_SOURCE, "request", request);
     Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
-    const hostingComponent = ComponentFactory.get(httpRequestContext.hostingComponentType ?? "hosting");
     const component = ComponentFactory.get(componentName);
     const result = await component.get(request.pathParams.id, request.query?.cursor, Coerce.integer(request.query?.limit), {
         includeEntries: Coerce.boolean(request.query?.includeEntries),
@@ -1035,7 +1065,8 @@ export async function auditableItemStreamGet(httpRequestContext, componentName,
         [HeaderTypes.ContentType]: request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? MimeTypes.JsonLd : MimeTypes.Json
     };
     if (Is.stringValue(result.cursor)) {
-        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(await hostingComponent.buildPublicUrl(httpRequestContext.serverRequest.url), { cursor: result.cursor }, "next");
+        const contextIds = await ContextIdStore.getContextIds();
+        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(HttpUrlHelper.replaceOrigin(httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin]), { cursor: result.cursor }, "next");
     }
     return {
         headers,
@@ -1098,7 +1129,7 @@ export async function auditableItemStreamClose(httpRequestContext, componentName
     };
 }
 /**
- * Query the stream.
+ * List all streams.
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
@@ -1107,14 +1138,14 @@ export async function auditableItemStreamClose(httpRequestContext, componentName
 export async function auditableItemStreamList(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request", request);
     Guards.object(ROUTES_SOURCE, "request.query", request.query);
-    const hostingComponent = ComponentFactory.get(httpRequestContext.hostingComponentType ?? "hosting");
     const component = ComponentFactory.get(componentName);
     const result = await component.query(HttpParameterHelper.objectFromString(request.query?.conditions), request.query?.orderBy, request.query?.orderByDirection, HttpParameterHelper.arrayFromString(request.query?.properties), request.query?.cursor, Coerce.integer(request.query?.limit));
     const headers = {
         [HeaderTypes.ContentType]: request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? MimeTypes.JsonLd : MimeTypes.Json
     };
     if (Is.stringValue(result.cursor)) {
-        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(await hostingComponent.buildPublicUrl(httpRequestContext.serverRequest.url), { cursor: result.cursor }, "next");
+        const contextIds = await ContextIdStore.getContextIds();
+        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(HttpUrlHelper.replaceOrigin(httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin]), { cursor: result.cursor }, "next");
     }
     return {
         headers,
@@ -1144,7 +1175,7 @@ export async function auditableItemStreamCreateEntry(httpRequestContext, compone
     };
 }
 /**
- * Get the stream.
+ * Delete an entry from the stream.
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
@@ -1230,7 +1261,7 @@ export async function auditableItemStreamGetEntryObject(httpRequestContext, comp
     };
 }
 /**
- * Query the stream.
+ * List the entries for a stream.
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
@@ -1240,7 +1271,6 @@ export async function auditableItemStreamListEntries(httpRequestContext, compone
     Guards.object(ROUTES_SOURCE, "request", request);
     Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
-    const hostingComponent = ComponentFactory.get(httpRequestContext.hostingComponentType ?? "hosting");
     const component = ComponentFactory.get(componentName);
     const result = await component.getEntries(request.pathParams.id, {
         conditions: HttpParameterHelper.objectFromString(request.query?.conditions),
@@ -1254,7 +1284,8 @@ export async function auditableItemStreamListEntries(httpRequestContext, compone
         [HeaderTypes.ContentType]: request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? MimeTypes.JsonLd : MimeTypes.Json
     };
     if (Is.stringValue(result.cursor)) {
-        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(await hostingComponent.buildPublicUrl(httpRequestContext.serverRequest.url), { cursor: result.cursor }, "next");
+        const contextIds = await ContextIdStore.getContextIds();
+        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(HttpUrlHelper.replaceOrigin(httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin]), { cursor: result.cursor }, "next");
     }
     return {
         headers,
@@ -1262,7 +1293,7 @@ export async function auditableItemStreamListEntries(httpRequestContext, compone
     };
 }
 /**
- * Query the stream.
+ * List entries across all streams.
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
@@ -1270,7 +1301,6 @@ export async function auditableItemStreamListEntries(httpRequestContext, compone
  */
 export async function auditableItemStreamListEntriesNoStream(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request", request);
-    const hostingComponent = ComponentFactory.get(httpRequestContext.hostingComponentType ?? "hosting");
     const component = ComponentFactory.get(componentName);
     const result = await component.getEntries(undefined, {
         conditions: HttpParameterHelper.objectFromString(request.query?.conditions),
@@ -1284,7 +1314,8 @@ export async function auditableItemStreamListEntriesNoStream(httpRequestContext,
         [HeaderTypes.ContentType]: request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? MimeTypes.JsonLd : MimeTypes.Json
     };
     if (Is.stringValue(result.cursor)) {
-        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(await hostingComponent.buildPublicUrl(httpRequestContext.serverRequest.url), { cursor: result.cursor }, "next");
+        const contextIds = await ContextIdStore.getContextIds();
+        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(HttpUrlHelper.replaceOrigin(httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin]), { cursor: result.cursor }, "next");
     }
     return {
         headers,
@@ -1292,7 +1323,7 @@ export async function auditableItemStreamListEntriesNoStream(httpRequestContext,
     };
 }
 /**
- * Query the stream objects.
+ * List the entry objects for a stream.
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
@@ -1302,7 +1333,6 @@ export async function auditableItemStreamListEntryObjects(httpRequestContext, co
     Guards.object(ROUTES_SOURCE, "request", request);
     Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
-    const hostingComponent = ComponentFactory.get(httpRequestContext.hostingComponentType ?? "hosting");
     const component = ComponentFactory.get(componentName);
     const result = await component.getEntryObjects(request.pathParams.id, {
         conditions: HttpParameterHelper.objectFromString(request.query?.conditions),
@@ -1315,7 +1345,8 @@ export async function auditableItemStreamListEntryObjects(httpRequestContext, co
         [HeaderTypes.ContentType]: request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? MimeTypes.JsonLd : MimeTypes.Json
     };
     if (Is.stringValue(result.cursor)) {
-        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(await hostingComponent.buildPublicUrl(httpRequestContext.serverRequest.url), { cursor: result.cursor }, "next");
+        const contextIds = await ContextIdStore.getContextIds();
+        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(HttpUrlHelper.replaceOrigin(httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin]), { cursor: result.cursor }, "next");
     }
     return {
         headers,
@@ -1323,7 +1354,7 @@ export async function auditableItemStreamListEntryObjects(httpRequestContext, co
     };
 }
 /**
- * Query the stream objects.
+ * List entry objects across all streams.
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
@@ -1331,7 +1362,6 @@ export async function auditableItemStreamListEntryObjects(httpRequestContext, co
  */
 export async function auditableItemStreamListEntryObjectsNoStream(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request", request);
-    const hostingComponent = ComponentFactory.get(httpRequestContext.hostingComponentType ?? "hosting");
     const component = ComponentFactory.get(componentName);
     const result = await component.getEntryObjects(undefined, {
         conditions: HttpParameterHelper.objectFromString(request.query?.conditions),
@@ -1344,11 +1374,29 @@ export async function auditableItemStreamListEntryObjectsNoStream(httpRequestCon
         [HeaderTypes.ContentType]: request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? MimeTypes.JsonLd : MimeTypes.Json
     };
     if (Is.stringValue(result.cursor)) {
-        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(await hostingComponent.buildPublicUrl(httpRequestContext.serverRequest.url), { cursor: result.cursor }, "next");
+        const contextIds = await ContextIdStore.getContextIds();
+        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(HttpUrlHelper.replaceOrigin(httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin]), { cursor: result.cursor }, "next");
     }
     return {
         headers,
         body: result.entries
     };
 }
+/**
+ * Remove the proof from a stream.
+ * @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 auditableItemStreamRemoveProof(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
+    Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
+    const component = ComponentFactory.get(componentName);
+    await component.removeProof(request.pathParams.id);
+    return {
+        statusCode: HttpStatusCode.noContent
+    };
+}
 //# sourceMappingURL=auditableItemStreamRoutes.js.map