@tetrascience-npm/request 0.2.0-beta.106.2

package/dist/shared/middleware/tracing.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTracingMiddleware = createTracingMiddleware;
+const constants_1 = require("../constants");
+const generate_request_id_1 = require("../generate-request-id");
+const sanitize_url_1 = require("../sanitize-url");
+const utils_1 = require("./utils");
+/**
+ * Create middleware that injects tracing headers and optionally logs
+ * requests, responses, and errors.
+ *
+ * Headers injected (only if not already present):
+ * - ts-request-id (auto-generates UUID if not provided)
+ * - ts-session-id (if provided)
+ * - ts-initiating-service-name (if provided)
+ *
+ * @example
+ * ```ts
+ * client.use(createTracingMiddleware({
+ *   requestId: () => getRequestId(),
+ *   sessionId: () => getRequestContext().sessionId,
+ *   serviceName: 'my-service',
+ *   logger: console,
+ * }))
+ * ```
+ */
+function createTracingMiddleware(options) {
+    const logger = options?.logger;
+    return {
+        onRequest({ request, schemaPath }) {
+            (0, utils_1.setIfAbsent)(request, constants_1.REQUEST_ID_HEADER, () => (0, utils_1.resolve)(options?.requestId) ?? (0, generate_request_id_1.generateRequestId)());
+            (0, utils_1.setIfAbsent)(request, constants_1.SESSION_ID_HEADER, options?.sessionId);
+            (0, utils_1.setIfAbsent)(request, constants_1.INITIATING_SERVICE_NAME_HEADER, options?.serviceName);
+            if (logger) {
+                logger.debug('Outgoing request', {
+                    requestId: request.headers.get(constants_1.REQUEST_ID_HEADER),
+                    method: request.method,
+                    path: (0, sanitize_url_1.sanitizeUrl)(request.url),
+                    schemaPath,
+                });
+            }
+            return request;
+        },
+        onResponse({ request, response, schemaPath }) {
+            if (logger) {
+                logger.debug('Response received', {
+                    requestId: request.headers.get(constants_1.REQUEST_ID_HEADER),
+                    method: request.method,
+                    path: (0, sanitize_url_1.sanitizeUrl)(request.url),
+                    schemaPath,
+                    status: response.status,
+                });
+            }
+        },
+        onError({ request, error, schemaPath }) {
+            if (logger) {
+                logger.error('Request failed', {
+                    requestId: request.headers.get(constants_1.REQUEST_ID_HEADER),
+                    method: request.method,
+                    path: (0, sanitize_url_1.sanitizeUrl)(request.url),
+                    schemaPath,
+                    error: error instanceof Error ? error.message : String(error),
+                });
+            }
+        },
+    };
+}

package/dist/shared/middleware/utils.d.ts

@@ -0,0 +1,4 @@
+import type { HeaderValue } from '../types';
+export declare function resolve(value: HeaderValue | undefined): string | undefined;
+export declare function setIfAbsent(request: Request, header: string, value: HeaderValue | undefined): void;
+//# sourceMappingURL=utils.d.ts.map

package/dist/shared/middleware/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/shared/middleware/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,UAAU,CAAC;AAE1C,wBAAgB,OAAO,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAE1E;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,SAAS,GAAG,IAAI,CAKlG"}

package/dist/shared/middleware/utils.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolve = resolve;
+exports.setIfAbsent = setIfAbsent;
+function resolve(value) {
+    return typeof value === 'function' ? value() : value;
+}
+function setIfAbsent(request, header, value) {
+    const resolved = resolve(value);
+    if (resolved && !request.headers.has(header)) {
+        request.headers.set(header, resolved);
+    }
+}

package/dist/shared/middleware/validation.d.ts

@@ -0,0 +1,43 @@
+import type { Middleware } from 'openapi-fetch';
+/**
+ * Any object with a `.parse()` method, compatible with both Zod 3 and Zod 4.
+ */
+export interface Parseable {
+    parse(data: unknown): unknown;
+}
+/**
+ * A map of "METHOD /path" → schema for request body validation.
+ *
+ * Values must have a `.parse()` method (any Zod version works).
+ *
+ * Keys use the OpenAPI path template format, e.g.:
+ *   "POST /v1/dataapps/apps/manage"
+ *   "PUT /v1/dataapps/apps/{id}/labels"
+ */
+export type RequestBodySchemaMap = Record<string, Parseable>;
+export interface RequestValidationMiddlewareOptions {
+    /** Map of "METHOD /path" → Zod schema for request body validation. */
+    schemas: RequestBodySchemaMap;
+}
+/**
+ * Create openapi-fetch middleware that validates request bodies against
+ * Zod schemas before the request is sent over the wire.
+ *
+ * If the request body contains malformed JSON, `JSON.parse()` throws a
+ * `SyntaxError` and the request is never sent. If JSON parsing succeeds but
+ * schema validation fails, the schema's `.parse()` method throws (e.g. a
+ * `ZodError`) and the request is never sent.
+ * Endpoints without a matching schema are passed through without validation.
+ *
+ * @example
+ * ```ts
+ * import createClient from 'openapi-fetch';
+ * import {createRequestValidationMiddleware} from '@tetrascience-npm/request';
+ * import {requestBodySchemas} from './generated/request-schemas';
+ *
+ * const client = createClient<paths>({baseUrl: '...'});
+ * client.use(createRequestValidationMiddleware({schemas: requestBodySchemas}));
+ * ```
+ */
+export declare function createRequestValidationMiddleware(options: RequestValidationMiddlewareOptions): Middleware;
+//# sourceMappingURL=validation.d.ts.map

package/dist/shared/middleware/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../../src/shared/middleware/validation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;CAC9B;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAE7D,MAAM,WAAW,kCAAkC;IAClD,sEAAsE;IACtE,OAAO,EAAE,oBAAoB,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,iCAAiC,CAAC,OAAO,EAAE,kCAAkC,GAAG,UAAU,CAqBzG"}

package/dist/shared/middleware/validation.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRequestValidationMiddleware = createRequestValidationMiddleware;
+/**
+ * Create openapi-fetch middleware that validates request bodies against
+ * Zod schemas before the request is sent over the wire.
+ *
+ * If the request body contains malformed JSON, `JSON.parse()` throws a
+ * `SyntaxError` and the request is never sent. If JSON parsing succeeds but
+ * schema validation fails, the schema's `.parse()` method throws (e.g. a
+ * `ZodError`) and the request is never sent.
+ * Endpoints without a matching schema are passed through without validation.
+ *
+ * @example
+ * ```ts
+ * import createClient from 'openapi-fetch';
+ * import {createRequestValidationMiddleware} from '@tetrascience-npm/request';
+ * import {requestBodySchemas} from './generated/request-schemas';
+ *
+ * const client = createClient<paths>({baseUrl: '...'});
+ * client.use(createRequestValidationMiddleware({schemas: requestBodySchemas}));
+ * ```
+ */
+function createRequestValidationMiddleware(options) {
+    const { schemas } = options;
+    return {
+        async onRequest({ request, schemaPath }) {
+            const key = `${request.method} ${schemaPath}`;
+            const schema = schemas[key];
+            if (!schema)
+                return request;
+            const cloned = request.clone();
+            const rawText = await cloned.text();
+            if (rawText === '') {
+                return request;
+            }
+            const body = JSON.parse(rawText);
+            schema.parse(body);
+            return request;
+        },
+    };
+}

package/dist/shared/sanitize-url.d.ts

@@ -0,0 +1,3 @@
+/** Extract pathname from a URL, stripping query string and hash. */
+export declare function sanitizeUrl(url: string): string;
+//# sourceMappingURL=sanitize-url.d.ts.map

package/dist/shared/sanitize-url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sanitize-url.d.ts","sourceRoot":"","sources":["../../src/shared/sanitize-url.ts"],"names":[],"mappings":"AAAA,oEAAoE;AACpE,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAM/C"}

package/dist/shared/sanitize-url.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sanitizeUrl = sanitizeUrl;
+/** Extract pathname from a URL, stripping query string and hash. */
+function sanitizeUrl(url) {
+    try {
+        return new URL(url).pathname;
+    }
+    catch {
+        return url.split(/[?#]/)[0];
+    }
+}

package/dist/shared/types.d.ts

@@ -0,0 +1,10 @@
+/** Logger interface for request tracking middleware. */
+export interface RequestTrackingLogger {
+    info(message: string, meta?: Record<string, unknown>): void;
+    warn(message: string, meta?: Record<string, unknown>): void;
+    error(message: string, meta?: Record<string, unknown>): void;
+    debug(message: string, meta?: Record<string, unknown>): void;
+}
+/** A header value: static string or function resolved per-request. */
+export type HeaderValue = string | (() => string | undefined);
+//# sourceMappingURL=types.d.ts.map

package/dist/shared/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/shared/types.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,MAAM,WAAW,qBAAqB;IACrC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC5D,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC5D,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC7D,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC7D;AAED,sEAAsE;AACtE,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC"}

package/dist/shared/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,98 @@
+{
+	"name": "@tetrascience-npm/request",
+	"version": "0.2.0-beta.106.2",
+	"description": "Request tracking middleware for TetraScience services and data apps (client + server).",
+	"license": "Apache-2.0",
+	"packageManager": "yarn@4.1.0",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"bin": {
+		"generate-request-schemas": "dist/cli/generate-schemas.js",
+		"generate-service-client": "dist/cli/generate-client.js"
+	},
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js"
+		},
+		"./client": {
+			"types": "./dist/client/index.d.ts",
+			"default": "./dist/client/index.js"
+		},
+		"./server": {
+			"types": "./dist/server/index.d.ts",
+			"default": "./dist/server/index.js"
+		}
+	},
+	"files": [
+		"dist/**/*.js",
+		"dist/**/*.d.ts",
+		"dist/**/*.d.ts.map",
+		"server.js",
+		"server.d.ts",
+		"client.js",
+		"client.d.ts"
+	],
+	"peerDependencies": {
+		"js-yaml": ">=4.0.0",
+		"openapi-fetch": ">=0.17.0",
+		"openapi-typescript": ">=7.0.0",
+		"openapi-zod-client": ">=1.0.0",
+		"zod": ">=3.0.0"
+	},
+	"peerDependenciesMeta": {
+		"js-yaml": {
+			"optional": true
+		},
+		"openapi-typescript": {
+			"optional": true
+		},
+		"openapi-zod-client": {
+			"optional": true
+		},
+		"zod": {
+			"optional": true
+		}
+	},
+	"resolutions": {
+		"vite": ">=7.3.2"
+	},
+	"devDependencies": {
+		"@types/js-yaml": "^4.0.9",
+		"@types/node": "^20.11.17",
+		"@typescript-eslint/eslint-plugin": "^5.59.11",
+		"@typescript-eslint/parser": "^5.59.11",
+		"@vitest/coverage-v8": "^3.1.1",
+		"eslint": "^8.49.0",
+		"eslint-config-prettier": "^9.0.0",
+		"husky": "^8.0.3",
+		"jsdom": "^26.1.0",
+		"lint-staged": "^14.0.1",
+		"openapi-fetch": "^0.17.0",
+		"prettier": "^3.0.3",
+		"typescript": "^5.3.3",
+		"vitest": "^3.1.1",
+		"zod": "^3.24.0"
+	},
+	"scripts": {
+		"lint": "eslint .",
+		"test": "vitest run",
+		"test:coverage": "vitest run --coverage",
+		"build": "tsc -p tsconfig.build.json",
+		"clean": "tsc -b --clean",
+		"check": "tsc --noEmit",
+		"prepare": "husky"
+	},
+	"prettier": {
+		"printWidth": 120,
+		"useTabs": true,
+		"bracketSpacing": false,
+		"trailingComma": "all"
+	},
+	"lint-staged": {
+		"*.{yml,json,ts,js,md,yaml,html}": "prettier --write"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}

package/server.d.ts

@@ -0,0 +1 @@
+export * from './dist/server/index';

package/server.js

@@ -0,0 +1 @@
+module.exports = require('./dist/server/index.js');