@twin.org/auditable-item-stream-service 0.9.1-next.1 → 0.9.1-next.3

package/dist/es/auditableItemStreamRoutes.js

@@ -1,11 +1,11 @@
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
-import { HttpContextIdKeys, HttpParameterHelper, HttpUrlHelper } from "@twin.org/api-models";
+import { HttpContextIdKeys, HttpHeaderHelper, 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 { Coerce, ComponentFactory, Guards } from "@twin.org/core";
 import { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
-import { HeaderHelper, HeaderTypes, HttpStatusCode, MimeTypes } from "@twin.org/web";
+import { HeaderTypes, HttpStatusCode, MimeTypes } from "@twin.org/web";
 /**
  * The source identifier used when communicating errors from these routes.
  */
@@ -32,7 +32,7 @@ export function generateRestRoutesAuditableItemStream(baseRouteName, componentNa
         tag: tagsAuditableItemStream[0].name,
         method: "POST",
         path: `${baseRouteName}/`,
-        handler: async (httpRequestContext, request) => auditableItemStreamCreate(httpRequestContext, componentName, request),
+        handler: async (httpRequestContext, request) => auditableItemStreamCreate(httpRequestContext, componentName, request, baseRouteName),
         requestType: {
             type: "IAuditableItemStreamCreateRequest",
             examples: [
@@ -437,7 +437,7 @@ export function generateRestRoutesAuditableItemStream(baseRouteName, componentNa
         tag: tagsAuditableItemStream[0].name,
         method: "POST",
         path: `${baseRouteName}/:id/entries`,
-        handler: async (httpRequestContext, request) => auditableItemStreamCreateEntry(httpRequestContext, componentName, request),
+        handler: async (httpRequestContext, request) => auditableItemStreamCreateEntry(httpRequestContext, componentName, request, baseRouteName),
         requestType: {
             type: "IAuditableItemStreamCreateEntryRequest",
             examples: [
@@ -1029,18 +1029,21 @@ export function generateRestRoutesAuditableItemStream(baseRouteName, componentNa
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
+ * @param baseRouteName The base route name for the API.
  * @returns The response object with additional http response properties.
  */
-export async function auditableItemStreamCreate(httpRequestContext, componentName, request) {
+export async function auditableItemStreamCreate(httpRequestContext, componentName, request, baseRouteName) {
     Guards.object(ROUTES_SOURCE, "request", request);
     Guards.object(ROUTES_SOURCE, "request.body", request.body);
     const component = ComponentFactory.get(componentName);
     const id = await component.create(request.body);
+    const contextIds = await ContextIdStore.getContextIds();
+    const publicOrigin = contextIds?.[HttpContextIdKeys.PublicOrigin];
+    const headers = {};
+    HttpHeaderHelper.buildId(headers, id, HttpUrlHelper.combineOriginPath(publicOrigin, `${baseRouteName}/:id`));
     return {
         statusCode: HttpStatusCode.created,
-        headers: {
-            [HeaderTypes.Location]: id
-        }
+        headers
     };
 }
 /**
@@ -1061,13 +1064,10 @@ export async function auditableItemStreamGet(httpRequestContext, componentName,
         verifyStream: Coerce.boolean(request.query?.verifyStream),
         verifyEntries: Coerce.boolean(request.query?.verifyEntries)
     });
-    const headers = {
-        [HeaderTypes.ContentType]: request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? MimeTypes.JsonLd : MimeTypes.Json
-    };
-    if (Is.stringValue(result.cursor)) {
-        const contextIds = await ContextIdStore.getContextIds();
-        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(HttpUrlHelper.replaceOrigin(httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin]), { cursor: result.cursor }, "next");
-    }
+    const headers = {};
+    HttpHeaderHelper.buildJsonContentType(headers, request.headers);
+    const contextIds = await ContextIdStore.getContextIds();
+    HttpHeaderHelper.buildCursor(headers, httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin], result.cursor);
     return {
         headers,
         body: result.stream
@@ -1140,13 +1140,10 @@ export async function auditableItemStreamList(httpRequestContext, componentName,
     Guards.object(ROUTES_SOURCE, "request.query", request.query);
     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)) {
-        const contextIds = await ContextIdStore.getContextIds();
-        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(HttpUrlHelper.replaceOrigin(httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin]), { cursor: result.cursor }, "next");
-    }
+    const headers = {};
+    HttpHeaderHelper.buildJsonContentType(headers, request.headers);
+    const contextIds = await ContextIdStore.getContextIds();
+    HttpHeaderHelper.buildCursor(headers, httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin], result.cursor);
     return {
         headers,
         body: result.entries
@@ -1157,9 +1154,10 @@ export async function auditableItemStreamList(httpRequestContext, componentName,
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
+ * @param baseRouteName The base route name for the API.
  * @returns The response object with additional http response properties.
  */
-export async function auditableItemStreamCreateEntry(httpRequestContext, componentName, request) {
+export async function auditableItemStreamCreateEntry(httpRequestContext, componentName, request, baseRouteName) {
     Guards.object(ROUTES_SOURCE, "request", request);
     Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     Guards.object(ROUTES_SOURCE, "request.body", request.body);
@@ -1167,11 +1165,13 @@ export async function auditableItemStreamCreateEntry(httpRequestContext, compone
     Guards.objectValue(ROUTES_SOURCE, "request.body.entryObject", request.body.entryObject);
     const component = ComponentFactory.get(componentName);
     const id = await component.createEntry(request.pathParams.id, request.body.entryObject);
+    const contextIds = await ContextIdStore.getContextIds();
+    const publicOrigin = contextIds?.[HttpContextIdKeys.PublicOrigin];
+    const headers = {};
+    HttpHeaderHelper.buildId(headers, id, HttpUrlHelper.combineOriginPath(publicOrigin, `${baseRouteName}/:streamId/entries/:id`));
     return {
         statusCode: HttpStatusCode.created,
-        headers: {
-            [HeaderTypes.Location]: id
-        }
+        headers
     };
 }
 /**
@@ -1228,12 +1228,10 @@ export async function auditableItemStreamGetEntry(httpRequestContext, componentN
     const result = await component.getEntry(request.pathParams.id, request.pathParams.entryId, {
         verifyEntry: Coerce.boolean(request.query?.verifyEntry)
     });
+    const headers = {};
+    HttpHeaderHelper.buildJsonContentType(headers, request.headers);
     return {
-        headers: {
-            [HeaderTypes.ContentType]: request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd
-                ? MimeTypes.JsonLd
-                : MimeTypes.Json
-        },
+        headers,
         body: result
     };
 }
@@ -1251,12 +1249,10 @@ export async function auditableItemStreamGetEntryObject(httpRequestContext, comp
     Guards.stringValue(ROUTES_SOURCE, "request.pathParams.entryId", request.pathParams.entryId);
     const component = ComponentFactory.get(componentName);
     const result = await component.getEntryObject(request.pathParams.id, request.pathParams.entryId);
+    const headers = {};
+    HttpHeaderHelper.buildJsonContentType(headers, request.headers);
     return {
-        headers: {
-            [HeaderTypes.ContentType]: request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd
-                ? MimeTypes.JsonLd
-                : MimeTypes.Json
-        },
+        headers,
         body: result
     };
 }
@@ -1280,13 +1276,10 @@ export async function auditableItemStreamListEntries(httpRequestContext, compone
         limit: Coerce.integer(request.query?.limit),
         cursor: request.query?.cursor
     });
-    const headers = {
-        [HeaderTypes.ContentType]: request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? MimeTypes.JsonLd : MimeTypes.Json
-    };
-    if (Is.stringValue(result.cursor)) {
-        const contextIds = await ContextIdStore.getContextIds();
-        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(HttpUrlHelper.replaceOrigin(httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin]), { cursor: result.cursor }, "next");
-    }
+    const headers = {};
+    HttpHeaderHelper.buildJsonContentType(headers, request.headers);
+    const contextIds = await ContextIdStore.getContextIds();
+    HttpHeaderHelper.buildCursor(headers, httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin], result.cursor);
     return {
         headers,
         body: result.entries
@@ -1310,13 +1303,10 @@ export async function auditableItemStreamListEntriesNoStream(httpRequestContext,
         limit: Coerce.integer(request.query?.limit),
         cursor: request.query?.cursor
     });
-    const headers = {
-        [HeaderTypes.ContentType]: request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? MimeTypes.JsonLd : MimeTypes.Json
-    };
-    if (Is.stringValue(result.cursor)) {
-        const contextIds = await ContextIdStore.getContextIds();
-        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(HttpUrlHelper.replaceOrigin(httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin]), { cursor: result.cursor }, "next");
-    }
+    const headers = {};
+    HttpHeaderHelper.buildJsonContentType(headers, request.headers);
+    const contextIds = await ContextIdStore.getContextIds();
+    HttpHeaderHelper.buildCursor(headers, httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin], result.cursor);
     return {
         headers,
         body: result.entries
@@ -1341,13 +1331,10 @@ export async function auditableItemStreamListEntryObjects(httpRequestContext, co
         limit: Coerce.integer(request.query?.limit),
         cursor: request.query?.cursor
     });
-    const headers = {
-        [HeaderTypes.ContentType]: request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? MimeTypes.JsonLd : MimeTypes.Json
-    };
-    if (Is.stringValue(result.cursor)) {
-        const contextIds = await ContextIdStore.getContextIds();
-        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(HttpUrlHelper.replaceOrigin(httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin]), { cursor: result.cursor }, "next");
-    }
+    const headers = {};
+    HttpHeaderHelper.buildJsonContentType(headers, request.headers);
+    const contextIds = await ContextIdStore.getContextIds();
+    HttpHeaderHelper.buildCursor(headers, httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin], result.cursor);
     return {
         headers,
         body: result.entries
@@ -1370,13 +1357,10 @@ export async function auditableItemStreamListEntryObjectsNoStream(httpRequestCon
         limit: Coerce.integer(request.query?.limit),
         cursor: request.query?.cursor
     });
-    const headers = {
-        [HeaderTypes.ContentType]: request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? MimeTypes.JsonLd : MimeTypes.Json
-    };
-    if (Is.stringValue(result.cursor)) {
-        const contextIds = await ContextIdStore.getContextIds();
-        headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(HttpUrlHelper.replaceOrigin(httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin]), { cursor: result.cursor }, "next");
-    }
+    const headers = {};
+    HttpHeaderHelper.buildJsonContentType(headers, request.headers);
+    const contextIds = await ContextIdStore.getContextIds();
+    HttpHeaderHelper.buildCursor(headers, httpRequestContext.serverRequest.url, contextIds?.[HttpContextIdKeys.PublicOrigin], result.cursor);
     return {
         headers,
         body: result.entries