@enterprisestandard/esp 0.0.8-beta.20260205.5

package/README.md

@@ -0,0 +1,38 @@
+## @enterprisestandard/esp
+
+Helpers for ESP onboarding: when a new tenant is created on an ESA, an ESI calls the ESP to register the new tenant app so it appears in the ESP and can establish workload/SCIM connectivity. This package defines the registration contract and includes a small client and parsing helper. It is separate from the tenant API.
+
+### ESI (caller) example
+
+```ts
+import { registerTenantApp } from '@enterprisestandard/esp';
+
+await registerTenantApp('https://iam.example.com/api/es/tenant-apps', {
+  tenantId: 'tenant-123',
+  companyId: 'acme',
+  companyName: 'Acme Corp',
+  environmentType: 'PROD',
+  tenantUrl: 'https://tenant-123.example.com',
+  scimBaseUrl: 'https://tenant-123.example.com/api/es/iam',
+  workload: {
+    idpTokenUrl: 'https://sso.example.com/realms/acme/protocol/openid-connect/token',
+    clientId: 'es-iam',
+    clientSecret: 'secret',
+    issuer: 'https://sso.example.com/realms/acme',
+  },
+});
+```
+
+### ESP (receiver) example
+
+```ts
+import { parseRegisterTenantAppRequest } from '@enterprisestandard/esp';
+
+export async function handleRegisterTenantApp(request: Request) {
+  const payload = await parseRegisterTenantAppRequest(request);
+  // Persist payload as a new application/tenant entry in the ESP.
+  return new Response(JSON.stringify({ registered: true }), { status: 201 });
+}
+```
+
+See the main repository README for tenant management and workload identity concepts.

package/dist/index.d.ts

@@ -0,0 +1,79 @@
+import { EnvironmentType, WorkloadConfig } from "@enterprisestandard/core";
+type RegisterTenantAppPayload = {
+	/**
+	* App/tenant identifier (same tenantId used by the ESA).
+	*/
+	tenantId: string;
+	/**
+	* Company identifier (reporting only).
+	*/
+	companyId: string;
+	/**
+	* Company name.
+	*/
+	companyName: string;
+	/**
+	* Environment type (POC, DEV, QA, PROD).
+	*/
+	environmentType: EnvironmentType;
+	/**
+	* Base URL of the tenant (if known).
+	*/
+	tenantUrl?: string;
+	/**
+	* Display name for ESP UIs.
+	*/
+	displayName?: string;
+	/**
+	* Product identifier (optional categorization for ESPs/ESIs).
+	*/
+	productId?: string;
+	/**
+	* Application identifier (optional categorization for ESPs/ESIs).
+	*/
+	applicationId?: string;
+	/**
+	* Base URL for the ESA's SCIM endpoints (e.g. https://tenant/app/api/es/iam).
+	*/
+	scimBaseUrl?: string;
+	/**
+	* Workload identity configuration the ESP should use to call the ESA.
+	*/
+	workload?: WorkloadConfig;
+};
+type RegisterTenantAppResult = {
+	registered: true;
+	appId?: string;
+	message?: string;
+};
+type RegisterTenantAppError = {
+	status: number;
+	code?: string;
+	message?: string;
+	details?: unknown;
+};
+type TenantAppRegistry = {
+	register: (payload: RegisterTenantAppPayload) => Promise<RegisterTenantAppResult>;
+};
+/**
+* Parse and lightly validate a register-tenant-app request body.
+* Throws if required fields are missing or invalid.
+*/
+declare function parseRegisterTenantAppRequest(request: Request): Promise<RegisterTenantAppPayload>;
+type HeadersInit = Headers | Array<[string, string]> | Record<string, string>;
+type RegisterTenantAppOptions = {
+	headers?: HeadersInit;
+	fetch?: typeof fetch;
+};
+declare class RegisterTenantAppClientError extends Error {
+	readonly status: number;
+	readonly code?: string;
+	readonly details?: unknown;
+	constructor(error: RegisterTenantAppError);
+}
+/**
+* Register a tenant app with an ESP endpoint.
+* The ESP is responsible for authenticating the caller.
+*/
+declare function registerTenantApp(espRegistrationUrl: string, payload: RegisterTenantAppPayload, options?: RegisterTenantAppOptions): Promise<RegisterTenantAppResult>;
+export { registerTenantApp, parseRegisterTenantAppRequest, TenantAppRegistry, RegisterTenantAppResult, RegisterTenantAppPayload, RegisterTenantAppError, RegisterTenantAppClientError };

package/dist/index.js

@@ -0,0 +1 @@
+class Q extends Error{status;code;details;constructor(A){super(A.message??"Register tenant app failed.");this.name="RegisterTenantAppClientError",this.status=A.status,this.code=A.code,this.details=A.details,Object.setPrototypeOf(this,Q.prototype)}}async function H(A){let z={status:A.status,message:`Register tenant app failed with status ${A.status}.`},D=await A.text();if(!D)return z;try{let J=JSON.parse(D);return{status:A.status,code:J.code,message:J.message??z.message,details:J.details}}catch{return{...z,details:D}}}function R(A){if(!A)return{"Content-Type":"application/json"};if(Array.isArray(A))return[["Content-Type","application/json"],...A];if(A instanceof Headers){let z=new Headers(A);if(!z.has("Content-Type"))z.set("Content-Type","application/json");return z}return{"Content-Type":"application/json",...A}}async function w(A,z,D={}){let G=await(D.fetch??fetch)(A,{method:"POST",headers:R(D.headers),body:JSON.stringify(z)});if(!G.ok){let K=await H(G);throw new Q(K)}if(G.status===204)return{registered:!0};let L=await G.text();if(!L)return{registered:!0};try{return JSON.parse(L)}catch{return{registered:!0,message:"Registration succeeded; response was not JSON."}}}var Z=["POC","DEV","QA","PROD"];function $(A){return A!==null&&typeof A==="object"&&!Array.isArray(A)&&Object.getPrototypeOf(A)===Object.prototype}function W(A,z,D,J){let G=A[z];if(G===void 0||G===null){if(J)D.push(`${z} is required`);return}if(typeof G!=="string"){D.push(`${z} must be a string`);return}if(J&&G.trim().length===0){D.push(`${z} must not be empty`);return}return G}async function M(A){let z;try{z=await A.json()}catch{throw Error("Register tenant app payload must be valid JSON.")}if(!$(z))throw Error("Register tenant app payload must be an object.");let D=[],J=W(z,"tenantId",D,!0),G=W(z,"companyId",D,!0),L=W(z,"companyName",D,!0),K=W(z,"environmentType",D,!0);if(K&&!Z.includes(K))D.push(`environmentType must be one of ${Z.join(", ")}`);let B=["tenantUrl","displayName","productId","applicationId","scimBaseUrl"];for(let X of B)if(z[X]!==void 0&&typeof z[X]!=="string")D.push(`${X} must be a string`);if(z.workload!==void 0&&!$(z.workload))D.push("workload must be an object");if(D.length>0)throw Error(`Invalid register tenant app payload: ${D.join("; ")}`);return{...z,tenantId:J??"",companyId:G??"",companyName:L??"",environmentType:K}}export{w as registerTenantApp,M as parseRegisterTenantAppRequest,Q as RegisterTenantAppClientError};

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@enterprisestandard/esp",
+  "version": "0.0.8-beta.20260205.5",
+  "description": "Enterprise Standard ESP helpers",
+  "private": false,
+  "author": "enterprisestandard",
+  "license": "proprietary",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@enterprisestandard/core": "0.0.8-beta.20260205.5"
+  }
+}