sos-data-utils-ts 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.1.0
+
+- Add the dependency-free shared BFF API-layer contract.
+- Require capability-based public assistant routes and keep internal routes
+  explicitly separate.
+- Reject product-name public API prefixes by construction.

package/README.md

@@ -0,0 +1,24 @@
+# sos-data-utils-ts
+
+Product-neutral contracts shared outward from SOS channel infrastructure into
+human-health and animal products. This package has no dependency on GW CORE,
+`gdc-*`, `uhc-*` or `vet-*` packages.
+
+The first contract defines capability-based BFF route roots. Public products
+use `/api/assistant/*`; `/api/internal/*` is reserved for authenticated
+service-to-service adapters. Product-name prefixes such as `/api/unid`,
+`/api/uhc`, `/api/vetchain` and `/api/petchain` are not public API surfaces.
+
+Sector behavior remains in its owner:
+
+- `sos-*`: reusable channel, BFF and emergency primitives;
+- `uhc-*`: human-health extensions;
+- `vet-*`: animal/veterinary extensions;
+- the terminology service: international terminology and regional catalogs.
+
+## Verify
+
+```bash
+npm ci
+npm run check
+```

package/dist/bff-api.d.ts

@@ -0,0 +1,12 @@
+/** Capability-first route roots shared by SOS, human-health and animal BFFs. */
+export declare const SharedBffApiRoutes: Readonly<{
+    readonly assistant: "/api/assistant";
+    readonly internal: "/api/internal";
+}>;
+/**
+ * Validates one public BFF pathname against the shared capability surface.
+ * Product and sector names belong in the deploying adapter, never in the URL.
+ */
+export declare function assertSharedPublicBffRoute(pathname: string): string;
+/** Returns true only for the explicitly non-public service-to-service surface. */
+export declare function isSharedInternalBffRoute(pathname: string): boolean;

package/dist/bff-api.js

@@ -0,0 +1,32 @@
+/** Capability-first route roots shared by SOS, human-health and animal BFFs. */
+export const SharedBffApiRoutes = Object.freeze({
+    assistant: '/api/assistant',
+    internal: '/api/internal',
+});
+const PUBLIC_ROUTE_ROOTS = Object.freeze([
+    SharedBffApiRoutes.assistant,
+]);
+/**
+ * Validates one public BFF pathname against the shared capability surface.
+ * Product and sector names belong in the deploying adapter, never in the URL.
+ */
+export function assertSharedPublicBffRoute(pathname) {
+    const route = normalizedPathname(pathname);
+    if (!PUBLIC_ROUTE_ROOTS.some((root) => route === root || route.startsWith(`${root}/`))) {
+        throw new Error('shared_public_bff_route_required');
+    }
+    return route;
+}
+/** Returns true only for the explicitly non-public service-to-service surface. */
+export function isSharedInternalBffRoute(pathname) {
+    const route = normalizedPathname(pathname);
+    const root = SharedBffApiRoutes.internal;
+    return route === root || route.startsWith(`${root}/`);
+}
+function normalizedPathname(value) {
+    const route = String(value || '').trim();
+    if (!route.startsWith('/') || route.includes('?') || route.includes('#')) {
+        throw new Error('shared_public_bff_route_required');
+    }
+    return route.length > 1 ? route.replace(/\/+$/, '') : route;
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './bff-api.js';

package/dist/index.js

@@ -0,0 +1 @@
+export * from './bff-api.js';

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "sos-data-utils-ts",
+  "version": "0.1.0",
+  "description": "Product-neutral SOS channel and BFF contract utilities",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./bff-api": {
+      "types": "./dist/bff-api.d.ts",
+      "default": "./dist/bff-api.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "clean": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
+    "build": "npm run clean && tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "npm run build && node --test tests/*.test.mjs",
+    "check": "npm run typecheck && npm test",
+    "prepack": "npm run check"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.0",
+    "typescript": "^5.9.3"
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}