digitaltwin-core 0.9.1 → 0.10.0

package/dist/utils/http_responses.d.ts

@@ -0,0 +1,155 @@
+/**
+ * @fileoverview HTTP response utilities for consistent API responses
+ *
+ * This module provides helper functions to create standardized DataResponse objects,
+ * reducing boilerplate code in component handlers and ensuring consistent API responses.
+ */
+import type { DataResponse } from '../components/types.js';
+/**
+ * HTTP status codes commonly used in the Digital Twin framework.
+ */
+export declare const HttpStatus: {
+    readonly OK: 200;
+    readonly CREATED: 201;
+    readonly MULTI_STATUS: 207;
+    readonly BAD_REQUEST: 400;
+    readonly UNAUTHORIZED: 401;
+    readonly FORBIDDEN: 403;
+    readonly NOT_FOUND: 404;
+    readonly INTERNAL_SERVER_ERROR: 500;
+};
+export type HttpStatusCode = (typeof HttpStatus)[keyof typeof HttpStatus];
+/**
+ * Creates a JSON response with the specified status and data.
+ *
+ * @param status - HTTP status code
+ * @param data - Data to serialize as JSON
+ * @returns DataResponse with JSON content type
+ *
+ * @example
+ * ```typescript
+ * return jsonResponse(200, { message: 'Success' })
+ * return jsonResponse(400, { error: 'Invalid input' })
+ * ```
+ */
+export declare function jsonResponse(status: number, data: object): DataResponse;
+/**
+ * Creates a successful JSON response (HTTP 200).
+ *
+ * @param data - Data to serialize as JSON
+ * @returns DataResponse with status 200
+ *
+ * @example
+ * ```typescript
+ * return successResponse({ message: 'Asset uploaded successfully' })
+ * ```
+ */
+export declare function successResponse(data: object): DataResponse;
+/**
+ * Creates an error response from an Error object or string.
+ *
+ * @param error - Error object or error message string
+ * @param status - HTTP status code (default: 500)
+ * @returns DataResponse with error message
+ *
+ * @example
+ * ```typescript
+ * return errorResponse(new Error('Something went wrong'))
+ * return errorResponse('Invalid input', 400)
+ * ```
+ */
+export declare function errorResponse(error: unknown, status?: number): DataResponse;
+/**
+ * Creates a 400 Bad Request response.
+ *
+ * @param message - Error message describing what's wrong with the request
+ * @returns DataResponse with status 400
+ *
+ * @example
+ * ```typescript
+ * return badRequestResponse('Missing required fields: description, source')
+ * ```
+ */
+export declare function badRequestResponse(message: string): DataResponse;
+/**
+ * Creates a 401 Unauthorized response.
+ *
+ * @param message - Error message (default: 'Authentication required')
+ * @returns DataResponse with status 401
+ *
+ * @example
+ * ```typescript
+ * return unauthorizedResponse()
+ * return unauthorizedResponse('Invalid authentication headers')
+ * ```
+ */
+export declare function unauthorizedResponse(message?: string): DataResponse;
+/**
+ * Creates a 403 Forbidden response.
+ *
+ * @param message - Error message describing why access is denied
+ * @returns DataResponse with status 403
+ *
+ * @example
+ * ```typescript
+ * return forbiddenResponse('You can only modify your own assets')
+ * ```
+ */
+export declare function forbiddenResponse(message: string): DataResponse;
+/**
+ * Creates a 404 Not Found response.
+ *
+ * @param message - Error message (default: 'Resource not found')
+ * @returns DataResponse with status 404
+ *
+ * @example
+ * ```typescript
+ * return notFoundResponse('Asset not found')
+ * ```
+ */
+export declare function notFoundResponse(message?: string): DataResponse;
+/**
+ * Creates a plain text response.
+ *
+ * @param status - HTTP status code
+ * @param content - Text content
+ * @returns DataResponse with text/plain content type
+ *
+ * @example
+ * ```typescript
+ * return textResponse(404, 'Asset not found')
+ * ```
+ */
+export declare function textResponse(status: number, content: string): DataResponse;
+/**
+ * Creates a binary/file response.
+ *
+ * @param content - File content as Buffer
+ * @param contentType - MIME type of the file
+ * @param filename - Optional filename for Content-Disposition header (triggers download)
+ * @returns DataResponse with appropriate content type
+ *
+ * @example
+ * ```typescript
+ * // For display/use in browser
+ * return fileResponse(buffer, 'model/gltf-binary')
+ *
+ * // For download
+ * return fileResponse(buffer, 'model/gltf-binary', 'model.glb')
+ * ```
+ */
+export declare function fileResponse(content: Buffer, contentType: string, filename?: string): DataResponse;
+/**
+ * Creates a 207 Multi-Status response for batch operations.
+ *
+ * @param message - Summary message
+ * @param results - Array of individual operation results
+ * @returns DataResponse with status 207
+ *
+ * @example
+ * ```typescript
+ * return multiStatusResponse('3/5 assets uploaded successfully', results)
+ * ```
+ */
+export declare function multiStatusResponse(message: string, results: unknown[]): DataResponse;
+//# sourceMappingURL=http_responses.d.ts.map

package/dist/utils/http_responses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http_responses.d.ts","sourceRoot":"","sources":["../../src/utils/http_responses.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAE1D;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;CASb,CAAA;AAEV,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAA;AAEzE;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,CAMvE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAE1D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,GAAE,MAAyC,GAAG,YAAY,CAG7G;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,CAEhE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,GAAE,MAAkC,GAAG,YAAY,CAE9F;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,CAE/D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,GAAE,MAA6B,GAAG,YAAY,CAErF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,YAAY,CAM1E;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,YAAY,CAYlG;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,YAAY,CAErF"}

package/dist/utils/http_responses.js

@@ -0,0 +1,190 @@
+/**
+ * @fileoverview HTTP response utilities for consistent API responses
+ *
+ * This module provides helper functions to create standardized DataResponse objects,
+ * reducing boilerplate code in component handlers and ensuring consistent API responses.
+ */
+/**
+ * HTTP status codes commonly used in the Digital Twin framework.
+ */
+export const HttpStatus = {
+    OK: 200,
+    CREATED: 201,
+    MULTI_STATUS: 207,
+    BAD_REQUEST: 400,
+    UNAUTHORIZED: 401,
+    FORBIDDEN: 403,
+    NOT_FOUND: 404,
+    INTERNAL_SERVER_ERROR: 500
+};
+/**
+ * Creates a JSON response with the specified status and data.
+ *
+ * @param status - HTTP status code
+ * @param data - Data to serialize as JSON
+ * @returns DataResponse with JSON content type
+ *
+ * @example
+ * ```typescript
+ * return jsonResponse(200, { message: 'Success' })
+ * return jsonResponse(400, { error: 'Invalid input' })
+ * ```
+ */
+export function jsonResponse(status, data) {
+    return {
+        status,
+        content: JSON.stringify(data),
+        headers: { 'Content-Type': 'application/json' }
+    };
+}
+/**
+ * Creates a successful JSON response (HTTP 200).
+ *
+ * @param data - Data to serialize as JSON
+ * @returns DataResponse with status 200
+ *
+ * @example
+ * ```typescript
+ * return successResponse({ message: 'Asset uploaded successfully' })
+ * ```
+ */
+export function successResponse(data) {
+    return jsonResponse(HttpStatus.OK, data);
+}
+/**
+ * Creates an error response from an Error object or string.
+ *
+ * @param error - Error object or error message string
+ * @param status - HTTP status code (default: 500)
+ * @returns DataResponse with error message
+ *
+ * @example
+ * ```typescript
+ * return errorResponse(new Error('Something went wrong'))
+ * return errorResponse('Invalid input', 400)
+ * ```
+ */
+export function errorResponse(error, status = HttpStatus.INTERNAL_SERVER_ERROR) {
+    const message = error instanceof Error ? error.message : String(error);
+    return jsonResponse(status, { error: message });
+}
+/**
+ * Creates a 400 Bad Request response.
+ *
+ * @param message - Error message describing what's wrong with the request
+ * @returns DataResponse with status 400
+ *
+ * @example
+ * ```typescript
+ * return badRequestResponse('Missing required fields: description, source')
+ * ```
+ */
+export function badRequestResponse(message) {
+    return jsonResponse(HttpStatus.BAD_REQUEST, { error: message });
+}
+/**
+ * Creates a 401 Unauthorized response.
+ *
+ * @param message - Error message (default: 'Authentication required')
+ * @returns DataResponse with status 401
+ *
+ * @example
+ * ```typescript
+ * return unauthorizedResponse()
+ * return unauthorizedResponse('Invalid authentication headers')
+ * ```
+ */
+export function unauthorizedResponse(message = 'Authentication required') {
+    return jsonResponse(HttpStatus.UNAUTHORIZED, { error: message });
+}
+/**
+ * Creates a 403 Forbidden response.
+ *
+ * @param message - Error message describing why access is denied
+ * @returns DataResponse with status 403
+ *
+ * @example
+ * ```typescript
+ * return forbiddenResponse('You can only modify your own assets')
+ * ```
+ */
+export function forbiddenResponse(message) {
+    return jsonResponse(HttpStatus.FORBIDDEN, { error: message });
+}
+/**
+ * Creates a 404 Not Found response.
+ *
+ * @param message - Error message (default: 'Resource not found')
+ * @returns DataResponse with status 404
+ *
+ * @example
+ * ```typescript
+ * return notFoundResponse('Asset not found')
+ * ```
+ */
+export function notFoundResponse(message = 'Resource not found') {
+    return jsonResponse(HttpStatus.NOT_FOUND, { error: message });
+}
+/**
+ * Creates a plain text response.
+ *
+ * @param status - HTTP status code
+ * @param content - Text content
+ * @returns DataResponse with text/plain content type
+ *
+ * @example
+ * ```typescript
+ * return textResponse(404, 'Asset not found')
+ * ```
+ */
+export function textResponse(status, content) {
+    return {
+        status,
+        content,
+        headers: { 'Content-Type': 'text/plain' }
+    };
+}
+/**
+ * Creates a binary/file response.
+ *
+ * @param content - File content as Buffer
+ * @param contentType - MIME type of the file
+ * @param filename - Optional filename for Content-Disposition header (triggers download)
+ * @returns DataResponse with appropriate content type
+ *
+ * @example
+ * ```typescript
+ * // For display/use in browser
+ * return fileResponse(buffer, 'model/gltf-binary')
+ *
+ * // For download
+ * return fileResponse(buffer, 'model/gltf-binary', 'model.glb')
+ * ```
+ */
+export function fileResponse(content, contentType, filename) {
+    const headers = { 'Content-Type': contentType };
+    if (filename) {
+        headers['Content-Disposition'] = `attachment; filename="${filename}"`;
+    }
+    return {
+        status: HttpStatus.OK,
+        content,
+        headers
+    };
+}
+/**
+ * Creates a 207 Multi-Status response for batch operations.
+ *
+ * @param message - Summary message
+ * @param results - Array of individual operation results
+ * @returns DataResponse with status 207
+ *
+ * @example
+ * ```typescript
+ * return multiStatusResponse('3/5 assets uploaded successfully', results)
+ * ```
+ */
+export function multiStatusResponse(message, results) {
+    return jsonResponse(HttpStatus.MULTI_STATUS, { message, results });
+}
+//# sourceMappingURL=http_responses.js.map

package/dist/utils/http_responses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http_responses.js","sourceRoot":"","sources":["../../src/utils/http_responses.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACtB,EAAE,EAAE,GAAG;IACP,OAAO,EAAE,GAAG;IACZ,YAAY,EAAE,GAAG;IACjB,WAAW,EAAE,GAAG;IAChB,YAAY,EAAE,GAAG;IACjB,SAAS,EAAE,GAAG;IACd,SAAS,EAAE,GAAG;IACd,qBAAqB,EAAE,GAAG;CACpB,CAAA;AAIV;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,IAAY;IACrD,OAAO;QACH,MAAM;QACN,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;QAC7B,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;KAClD,CAAA;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IACxC,OAAO,YAAY,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;AAC5C,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc,EAAE,SAAiB,UAAU,CAAC,qBAAqB;IAC3F,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACtE,OAAO,YAAY,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAA;AACnD,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAe;IAC9C,OAAO,YAAY,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAA;AACnE,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,oBAAoB,CAAC,UAAkB,yBAAyB;IAC5E,OAAO,YAAY,CAAC,UAAU,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAA;AACpE,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAe;IAC7C,OAAO,YAAY,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAA;AACjE,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAAC,UAAkB,oBAAoB;IACnE,OAAO,YAAY,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAA;AACjE,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,OAAe;IACxD,OAAO;QACH,MAAM;QACN,OAAO;QACP,OAAO,EAAE,EAAE,cAAc,EAAE,YAAY,EAAE;KAC5C,CAAA;AACL,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,YAAY,CAAC,OAAe,EAAE,WAAmB,EAAE,QAAiB;IAChF,MAAM,OAAO,GAA2B,EAAE,cAAc,EAAE,WAAW,EAAE,CAAA;IAEvE,IAAI,QAAQ,EAAE,CAAC;QACX,OAAO,CAAC,qBAAqB,CAAC,GAAG,yBAAyB,QAAQ,GAAG,CAAA;IACzE,CAAC;IAED,OAAO;QACH,MAAM,EAAE,UAAU,CAAC,EAAE;QACrB,OAAO;QACP,OAAO;KACV,CAAA;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAe,EAAE,OAAkB;IACnE,OAAO,YAAY,CAAC,UAAU,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAA;AACtE,CAAC"}

package/dist/utils/index.d.ts

@@ -2,4 +2,6 @@ export { Logger, LogLevel } from './logger.js';
 export { mapToDataRecord } from './map_to_data_record.js';
 export { servableEndpoint } from './servable_endpoint.js';
 export { extractZipContentStream, zipToDict, analyzeTilesetContent } from './zip_utils.js';
+export { HttpStatus, jsonResponse, successResponse, errorResponse, badRequestResponse, unauthorizedResponse, forbiddenResponse, notFoundResponse, textResponse, fileResponse, multiStatusResponse } from './http_responses.js';
+export type { HttpStatusCode } from './http_responses.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,uBAAuB,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,uBAAuB,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAC1F,OAAO,EACH,UAAU,EACV,YAAY,EACZ,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,mBAAmB,EACtB,MAAM,qBAAqB,CAAA;AAC5B,YAAY,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA"}

package/dist/utils/index.js

@@ -2,4 +2,5 @@ export { Logger, LogLevel } from './logger.js';
 export { mapToDataRecord } from './map_to_data_record.js';
 export { servableEndpoint } from './servable_endpoint.js';
 export { extractZipContentStream, zipToDict, analyzeTilesetContent } from './zip_utils.js';
+export { HttpStatus, jsonResponse, successResponse, errorResponse, badRequestResponse, unauthorizedResponse, forbiddenResponse, notFoundResponse, textResponse, fileResponse, multiStatusResponse } from './http_responses.js';
 //# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,uBAAuB,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,uBAAuB,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAC1F,OAAO,EACH,UAAU,EACV,YAAY,EACZ,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,mBAAmB,EACtB,MAAM,qBAAqB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "digitaltwin-core",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "description": "Minimalist framework to collect and handle data in a Digital Twin project",
   "license": "MIT",
   "author": "Axel Hoffmann",
@@ -22,7 +22,7 @@
     "build": "tsc",
     "dev": "tsc --watch",
     "clean": "rimraf dist",
-    "test": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts",
+    "test": "node -r ./bin/set-test-env.cjs --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts",
     "lint": "eslint src/**/*.ts",
     "lint:fix": "eslint src/**/*.ts --fix",
     "format": "prettier --write \"src/**/*.ts\"",
@@ -97,7 +97,6 @@
     "bullmq": "^5.56.5",
     "cors": "^2.8.5",
     "ioredis": "^5.6.1",
-    "japa": "^4.0.0",
     "jszip": "^3.10.1",
     "lodash": "^4.17.21",
     "multer": "^2.0.2",