@twin.org/api-processors 0.0.1 → 0.0.2-next.2

package/dist/cjs/index.cjs

@@ -437,6 +437,39 @@ class LoggingProcessor {
     }
 }
 
+/**
+ * Process the JSON-LD mime type.
+ */
+class JsonLdMimeTypeProcessor {
+    /**
+     * The namespace supported by the processor.
+     */
+    static NAMESPACE = "json-ld";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "JsonLdMimeTypeProcessor";
+    /**
+     * Get the MIME types that this handler can handle.
+     * @returns The MIME types that this handler can handle.
+     */
+    getTypes() {
+        return [web.MimeTypes.JsonLd];
+    }
+    /**
+     * Handle content.
+     * @param body The body to process.
+     * @returns The processed body.
+     */
+    async handle(body) {
+        const json = core.ObjectHelper.fromBytes(body);
+        if (core.Is.empty(json) || core.Is.empty(json["@context"])) {
+            throw new core.GeneralError(this.CLASS_NAME, "invalidJsonLd");
+        }
+        return json;
+    }
+}
+
 /**
  * Process the JWT mime type.
  */
@@ -466,6 +499,7 @@ class JwtMimeTypeProcessor {
     }
 }
 
+exports.JsonLdMimeTypeProcessor = JsonLdMimeTypeProcessor;
 exports.JwtMimeTypeProcessor = JwtMimeTypeProcessor;
 exports.LoggingProcessor = LoggingProcessor;
 exports.NodeIdentityProcessor = NodeIdentityProcessor;

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 import { HttpErrorHelper } from '@twin.org/api-models';
-import { Is, NotFoundError, Guards, ObjectHelper, Coerce, Converter } from '@twin.org/core';
+import { Is, NotFoundError, Guards, ObjectHelper, Coerce, GeneralError, Converter } from '@twin.org/core';
 import { HttpStatusCode, HeaderTypes, MimeTypes } from '@twin.org/web';
 import { LoggingConnectorFactory } from '@twin.org/logging-models';
 
@@ -435,6 +435,39 @@ class LoggingProcessor {
     }
 }
 
+/**
+ * Process the JSON-LD mime type.
+ */
+class JsonLdMimeTypeProcessor {
+    /**
+     * The namespace supported by the processor.
+     */
+    static NAMESPACE = "json-ld";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "JsonLdMimeTypeProcessor";
+    /**
+     * Get the MIME types that this handler can handle.
+     * @returns The MIME types that this handler can handle.
+     */
+    getTypes() {
+        return [MimeTypes.JsonLd];
+    }
+    /**
+     * Handle content.
+     * @param body The body to process.
+     * @returns The processed body.
+     */
+    async handle(body) {
+        const json = ObjectHelper.fromBytes(body);
+        if (Is.empty(json) || Is.empty(json["@context"])) {
+            throw new GeneralError(this.CLASS_NAME, "invalidJsonLd");
+        }
+        return json;
+    }
+}
+
 /**
  * Process the JWT mime type.
  */
@@ -464,4 +497,4 @@ class JwtMimeTypeProcessor {
     }
 }
 
-export { JwtMimeTypeProcessor, LoggingProcessor, NodeIdentityProcessor, RestRouteProcessor, SocketRouteProcessor, StaticUserIdentityProcessor };
+export { JsonLdMimeTypeProcessor, JwtMimeTypeProcessor, LoggingProcessor, NodeIdentityProcessor, RestRouteProcessor, SocketRouteProcessor, StaticUserIdentityProcessor };

package/dist/types/index.d.ts

@@ -3,6 +3,7 @@ export * from "./data/socketRouteProcessor";
 export * from "./identity/nodeIdentityProcessor";
 export * from "./identity/staticUserIdentityProcessor";
 export * from "./logging/loggingProcessor";
+export * from "./mimeType/jsonLdMimeTypeProcessor";
 export * from "./mimeType/jwtMimeTypeProcessor";
 export * from "./models/ILoggingProcessorConfig";
 export * from "./models/ILoggingProcessorConstructorOptions";

package/dist/types/mimeType/jsonLdMimeTypeProcessor.d.ts

@@ -0,0 +1,25 @@
+import type { IMimeTypeProcessor } from "@twin.org/api-models";
+/**
+ * Process the JSON-LD mime type.
+ */
+export declare class JsonLdMimeTypeProcessor implements IMimeTypeProcessor {
+    /**
+     * The namespace supported by the processor.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Get the MIME types that this handler can handle.
+     * @returns The MIME types that this handler can handle.
+     */
+    getTypes(): string[];
+    /**
+     * Handle content.
+     * @param body The body to process.
+     * @returns The processed body.
+     */
+    handle(body: Uint8Array): Promise<unknown>;
+}

package/docs/changelog.md

@@ -1,5 +1,35 @@
 # @twin.org/api-processors - Changelog
 
+## [0.0.2-next.2](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.1...api-processors-v0.0.2-next.2) (2025-07-17)
+
+
+### Miscellaneous Chores
+
+* **api-processors:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.1 to 0.0.2-next.2
+
+## [0.0.2-next.1](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.0...api-processors-v0.0.2-next.1) (2025-07-08)
+
+
+### Features
+
+* add json-ld mime type processor and auth admin component ([8861791](https://github.com/twinfoundation/api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.0 to 0.0.2-next.1
+
 ## 0.0.1 (2025-07-03)
 
 

package/docs/reference/classes/JsonLdMimeTypeProcessor.md

@@ -0,0 +1,81 @@
+# Class: JsonLdMimeTypeProcessor
+
+Process the JSON-LD mime type.
+
+## Implements
+
+- `IMimeTypeProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new JsonLdMimeTypeProcessor**(): `JsonLdMimeTypeProcessor`
+
+#### Returns
+
+`JsonLdMimeTypeProcessor`
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"json-ld"`
+
+The namespace supported by the processor.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IMimeTypeProcessor.CLASS_NAME`
+
+## Methods
+
+### getTypes()
+
+> **getTypes**(): `string`[]
+
+Get the MIME types that this handler can handle.
+
+#### Returns
+
+`string`[]
+
+The MIME types that this handler can handle.
+
+#### Implementation of
+
+`IMimeTypeProcessor.getTypes`
+
+***
+
+### handle()
+
+> **handle**(`body`): `Promise`\<`unknown`\>
+
+Handle content.
+
+#### Parameters
+
+##### body
+
+`Uint8Array`
+
+The body to process.
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+The processed body.
+
+#### Implementation of
+
+`IMimeTypeProcessor.handle`

package/docs/reference/index.md

@@ -7,6 +7,7 @@
 - [NodeIdentityProcessor](classes/NodeIdentityProcessor.md)
 - [StaticUserIdentityProcessor](classes/StaticUserIdentityProcessor.md)
 - [LoggingProcessor](classes/LoggingProcessor.md)
+- [JsonLdMimeTypeProcessor](classes/JsonLdMimeTypeProcessor.md)
 - [JwtMimeTypeProcessor](classes/JwtMimeTypeProcessor.md)
 
 ## Interfaces

package/locales/en.json

@@ -10,6 +10,9 @@
 			"jwtMissing": "The JSON Web token could not be found in the authorization header or a cookie",
 			"jwtSignatureInvalid": "The JSON Web token signature could not be validated",
 			"jwtExpired": "The JSON Web token has expired"
+		},
+		"jsonLdMimeTypeProcessor": {
+			"invalidJsonLd": "The JSON-LD content is invalid or missing '@context'."
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-processors",
-	"version": "0.0.1",
+	"version": "0.0.2-next.2",
 	"description": "Route processors for use with API servers",
 	"repository": {
 		"type": "git",
@@ -14,13 +14,11 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "^0.0.1",
-		"@twin.org/core": "^0.0.1",
-		"@twin.org/entity": "^0.0.1",
-		"@twin.org/entity-storage-models": "^0.0.1-next.2",
-		"@twin.org/logging-models": "^0.0.1-next.2",
-		"@twin.org/nameof": "^0.0.1",
-		"@twin.org/web": "^0.0.1"
+		"@twin.org/api-models": "0.0.2-next.2",
+		"@twin.org/core": "next",
+		"@twin.org/logging-models": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/web": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",