ptech-shell-dev 1.7.0 → 1.8.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { LogLevel, RealtimeEnvelope, UserService, RequestContextService, RealtimeService, Lang, User, I18nService, ApiClient, NavigationService, ConfigService, PermissionService, SharedStateService, ObservabilityService, NotificationService, AnalyticsService, ObservabilityConfigPatch, ApiErrorPayload, ApiValidationErrors, ApiRetryOptions, MsalAccountInfoLike, NavigationAction, NavigationTo, NavigationNavigateOptions } from 'ptech-shell-sdk';
+import { LogLevel, RealtimeEnvelope, UserService, RequestContextService, RealtimeService, Lang, User, I18nService, ApiClient, NavigationService, ConfigService, PermissionService, SharedStateService, ObservabilityService, NotificationService, AnalyticsService, TenantService, AppSettingsService, ObservabilityConfigPatch, AppSettings, ApiErrorPayload, ApiValidationErrors, ApiRetryOptions, MsalAccountInfoLike, NavigationAction, NavigationTo, NavigationNavigateOptions } from 'ptech-shell-sdk';
 
 type ObservabilityTelemetryEvent = {
     level: LogLevel;
@@ -74,6 +74,8 @@ type StandaloneServices = {
     observability: ObservabilityService;
     notification: NotificationService;
     analytics: AnalyticsService;
+    tenantService: TenantService;
+    appSettingsService: AppSettingsService;
 };
 type ServiceRegisterMode = 'if-missing' | 'always';
 type StandaloneInitOptions = {
@@ -135,6 +137,23 @@ type StandaloneInitOptions = {
         envName?: string;
         apiBase?: string;
     };
+    /**
+     * Seed values for the standalone tenant service.
+     * Defaults to `{ tenantId: 'dev-tenant', tenantSlug: 'dev' }`.
+     */
+    tenant?: {
+        tenantId?: string | null;
+        tenantSlug?: string | null;
+    };
+    /**
+     * Seed/loader for the standalone app settings service.
+     * - `seed`: static per-appKey map returned by `load()`.
+     * - `fetcher`: override that takes precedence over seed.
+     */
+    appSettings?: {
+        seed?: Readonly<Record<string, AppSettings>>;
+        fetcher?: (appKey: string) => Promise<AppSettings>;
+    };
 };
 
 /**
@@ -182,6 +201,12 @@ type CreateStandaloneApiClientOptions = {
      */
     getRequestContext?: () => RequestContextService | undefined;
     requestContext?: RequestContextService;
+    /**
+     * Optional dynamic lookup for tenant service; header `X-Tenant-Id` is injected
+     * when the resolved snapshot has a non-empty `tenantId`.
+     */
+    getTenantService?: () => TenantService | undefined;
+    tenantService?: TenantService;
     defaultAuthScopes?: string[];
     defaultTimeoutMs?: number;
     defaultRetries?: ApiRetryOptions | false;
@@ -233,6 +258,32 @@ declare function isApiError(value: unknown): value is ApiError;
  */
 declare function createStandaloneApiClient(options: string | CreateStandaloneApiClientOptions): ApiClient;
 
+type CreateStandaloneAppSettingsServiceOptions = {
+    /**
+     * Static seed settings keyed by appKey.
+     * Returned instantly from `load()` and `get()` for dev/test scenarios.
+     */
+    seed?: Readonly<Record<string, AppSettings>>;
+    /**
+     * Optional async loader, overrides seed when provided.
+     * Useful when tests want to simulate latency or network failures.
+     */
+    fetcher?: (appKey: string) => Promise<AppSettings>;
+};
+/**
+ * WHY:
+ * - In-memory per-appKey settings store for standalone remote development.
+ * WHEN TO USE:
+ * - Use via initStandaloneServices so remotes can call `load(appKey)` without a host.
+ * WHEN NOT TO USE:
+ * - Do not use in production — host fetches from backend and owns cache invalidation.
+ * INVARIANTS:
+ * - `get()` returns null until `load()` resolves for that appKey.
+ * - `invalidate()` with no args drops all cached entries.
+ * - Listeners are scoped per appKey; invalidate emits for affected keys only.
+ */
+declare function createStandaloneAppSettingsService(options?: CreateStandaloneAppSettingsServiceOptions): AppSettingsService;
+
 type UiApiError = {
     i18nKey: string;
     params: Record<string, string | number>;
@@ -401,6 +452,23 @@ type CreateRequestContextServiceOptions = {
  */
 declare function createRequestContextService(options?: CreateRequestContextServiceOptions): RequestContextService;
 
+type CreateStandaloneTenantServiceOptions = {
+    tenantId?: string | null;
+    tenantSlug?: string | null;
+};
+/**
+ * WHY:
+ * - Provides a minimal in-memory TenantService for standalone remote dev.
+ * WHEN TO USE:
+ * - Use via initStandaloneServices when a remote runs without host.
+ * WHEN NOT TO USE:
+ * - Do not use in production — host registers its own tenant service.
+ * INVARIANTS:
+ * - getSnapshot returns a copy, never the mutable internal reference.
+ * - setTenant emits only when either field actually changes.
+ */
+declare function createStandaloneTenantService(options?: CreateStandaloneTenantServiceOptions): TenantService;
+
 /**
  * WHY:
  * - Provides mock user/session/auth token behavior for standalone shell development.
@@ -415,4 +483,4 @@ declare function createRequestContextService(options?: CreateRequestContextServi
  */
 declare function createStandaloneUserService(seedUser: User | null): UserService;
 
-export { ApiError, type CreateMsalUserServiceOptions, type CreateReactRouterNavigationAdapterOptions, type CreateStandaloneApiClientOptions, type CreateStandaloneObservabilityServiceOptions, type CreateStandaloneRealtimeServiceOptions, type MsalBrowserInstanceLike, type ObservabilityTelemetryEvent, type ObservabilityTelemetrySink, type ReactRouterCreateHrefFunctionLike, type ReactRouterLocationLike, type ReactRouterNavigateFunctionLike, type ReactRouterNavigationAdapter, type ReactRouterNavigationCapabilities, type RealtimeReconnectOptions, type RealtimeTransport, type RealtimeTransportConnectContext, type ServiceRegisterMode, type StandaloneInitOptions, type StandaloneServices, type UiApiError, createDevPreset, createMsalUserService, createReactRouterNavigationAdapter, createRequestContextService, createStandaloneApiClient, createStandaloneI18nService, createStandaloneRealtimeService, createStandaloneUserService, createTestServices, initStandaloneServices, isApiError, mapApiErrorToUiError };
+export { ApiError, type CreateMsalUserServiceOptions, type CreateReactRouterNavigationAdapterOptions, type CreateStandaloneApiClientOptions, type CreateStandaloneObservabilityServiceOptions, type CreateStandaloneRealtimeServiceOptions, type MsalBrowserInstanceLike, type ObservabilityTelemetryEvent, type ObservabilityTelemetrySink, type ReactRouterCreateHrefFunctionLike, type ReactRouterLocationLike, type ReactRouterNavigateFunctionLike, type ReactRouterNavigationAdapter, type ReactRouterNavigationCapabilities, type RealtimeReconnectOptions, type RealtimeTransport, type RealtimeTransportConnectContext, type ServiceRegisterMode, type StandaloneInitOptions, type StandaloneServices, type UiApiError, createDevPreset, createMsalUserService, createReactRouterNavigationAdapter, createRequestContextService, createStandaloneApiClient, createStandaloneAppSettingsService, createStandaloneI18nService, createStandaloneRealtimeService, createStandaloneTenantService, createStandaloneUserService, createTestServices, initStandaloneServices, isApiError, mapApiErrorToUiError };

package/dist/index.js

@@ -66,6 +66,7 @@ var DEFAULT_RETRY_OPTIONS = {
 var TRACE_HEADER = "traceparent";
 var CORRELATION_HEADER = "x-correlation-id";
 var CORRELATION_HEADERS = ["x-correlation-id", "x-request-id"];
+var TENANT_HEADER = "x-tenant-id";
 var IDEMPOTENT_METHODS = /* @__PURE__ */ new Set(["GET", "HEAD", "OPTIONS"]);
 function isApiError(value) {
   return value instanceof ApiError;
@@ -418,6 +419,7 @@ function resolveCreateOptions(input) {
     getUserService: input.getUserService ?? (input.userService ? () => input.userService : void 0),
     getNotificationService: input.getNotificationService ?? (input.notificationService ? () => input.notificationService : void 0),
     getRequestContext: input.getRequestContext ?? (input.requestContext ? () => input.requestContext : void 0),
+    getTenantService: input.getTenantService ?? (input.tenantService ? () => input.tenantService : void 0),
     defaultAuthScopes: input.defaultAuthScopes ?? [],
     defaultTimeoutMs: input.defaultTimeoutMs ?? DEFAULT_TIMEOUT_MS,
     defaultRetries: input.defaultRetries ?? DEFAULT_RETRY_OPTIONS
@@ -439,6 +441,19 @@ function applyRequestContextHeaders(headers, options) {
     headers.set(CORRELATION_HEADER, context.correlationId);
   }
 }
+function applyTenantHeader(headers, options) {
+  if (headers.has(TENANT_HEADER)) {
+    return;
+  }
+  const tenantService = options.getTenantService?.();
+  if (!tenantService) {
+    return;
+  }
+  const tenantId = tenantService.getSnapshot().tenantId;
+  if (tenantId && tenantId.length > 0) {
+    headers.set(TENANT_HEADER, tenantId);
+  }
+}
 function syncResponseContext(response, options) {
   const contextService = options.getRequestContext?.();
   if (!contextService) {
@@ -531,6 +546,7 @@ async function executeRaw(requestOptions, options) {
   const timeoutMs = requestOptions.timeoutMs ?? options.defaultTimeoutMs;
   const headers = new Headers(requestOptions.headers);
   applyRequestContextHeaders(headers, options);
+  applyTenantHeader(headers, options);
   await applyAuthorization(headers, requestOptions, options);
   const url = resolveUrl(options.apiBase, requestOptions.url);
   const body = resolveBody(requestOptions.body, headers);
@@ -611,6 +627,7 @@ function createStandaloneApiClient(options) {
     fetch: async (input, init) => {
       const headers = new Headers(init?.headers);
       applyRequestContextHeaders(headers, resolvedOptions);
+      applyTenantHeader(headers, resolvedOptions);
       await applyAuthorization(
         headers,
         {
@@ -645,6 +662,69 @@ function createStandaloneApiClient(options) {
   };
 }
 
+// src/services/appSettings.ts
+function createStandaloneAppSettingsService(options = {}) {
+  const cache = /* @__PURE__ */ new Map();
+  const listeners = /* @__PURE__ */ new Map();
+  function emit(appKey) {
+    const group = listeners.get(appKey);
+    if (!group) return;
+    for (const listener of group) {
+      listener();
+    }
+  }
+  async function resolveSettings(appKey) {
+    if (options.fetcher) {
+      return options.fetcher(appKey);
+    }
+    return options.seed?.[appKey] ?? {};
+  }
+  return {
+    get: (appKey) => cache.get(appKey) ?? null,
+    load: async (appKey) => {
+      const existing = cache.get(appKey);
+      if (existing) {
+        return existing;
+      }
+      const settings = await resolveSettings(appKey);
+      const snapshot = {
+        settings,
+        version: 1
+      };
+      cache.set(appKey, snapshot);
+      emit(appKey);
+      return snapshot;
+    },
+    subscribe: (appKey, listener) => {
+      let group = listeners.get(appKey);
+      if (!group) {
+        group = /* @__PURE__ */ new Set();
+        listeners.set(appKey, group);
+      }
+      group.add(listener);
+      return () => {
+        group?.delete(listener);
+        if (group && group.size === 0) {
+          listeners.delete(appKey);
+        }
+      };
+    },
+    invalidate: (appKey) => {
+      if (appKey === void 0) {
+        const affected = Array.from(cache.keys());
+        cache.clear();
+        for (const key of affected) {
+          emit(key);
+        }
+        return;
+      }
+      if (cache.delete(appKey)) {
+        emit(appKey);
+      }
+    }
+  };
+}
+
 // src/services/config.ts
 import { FEATURE_FLAGS } from "ptech-shell-sdk";
 var DEFAULT_FLAGS = {
@@ -1530,6 +1610,37 @@ function createStandaloneSharedStateService() {
   };
 }
 
+// src/services/tenant.ts
+function createStandaloneTenantService(options = {}) {
+  const listeners = /* @__PURE__ */ new Set();
+  let snapshot = {
+    tenantId: options.tenantId ?? "dev-tenant",
+    tenantSlug: options.tenantSlug ?? "dev"
+  };
+  function emit() {
+    for (const listener of listeners) {
+      listener();
+    }
+  }
+  return {
+    getSnapshot: () => ({ ...snapshot }),
+    setTenant: (tenantId, tenantSlug) => {
+      if (tenantId === snapshot.tenantId && tenantSlug === snapshot.tenantSlug) {
+        return { ...snapshot };
+      }
+      snapshot = { tenantId, tenantSlug };
+      emit();
+      return { ...snapshot };
+    },
+    subscribe: (listener) => {
+      listeners.add(listener);
+      return () => {
+        listeners.delete(listener);
+      };
+    }
+  };
+}
+
 // src/services/user.ts
 function createStandaloneUserService(seedUser) {
   const listeners = /* @__PURE__ */ new Set();
@@ -1604,11 +1715,15 @@ function createTestServices(options = {}) {
     realtime: realtimeOptions,
     navigationPath = "/standalone",
     featureFlags = {},
-    runtimeConfig = {}
+    runtimeConfig = {},
+    tenant,
+    appSettings
   } = options;
   const userService = createStandaloneUserService(user ?? null);
   const notificationService = createStandaloneNotificationService();
   const requestContext = createRequestContextService();
+  const tenantService = createStandaloneTenantService(tenant);
+  const appSettingsService = createStandaloneAppSettingsService(appSettings);
   return {
     i18n: createStandaloneI18nService(lang),
     userService,
@@ -1616,7 +1731,8 @@ function createTestServices(options = {}) {
       apiBase,
       getUserService: () => getService(TOKENS.userService) ?? userService,
       notificationService,
-      requestContext
+      requestContext,
+      tenantService
     }),
     navigation: createStandaloneNavigationService(navigationPath),
     configService: createStandaloneConfigService(
@@ -1636,7 +1752,9 @@ function createTestServices(options = {}) {
       getTraceContext: () => requestContext.getSnapshot()
     }),
     notification: notificationService,
-    analytics: createStandaloneAnalyticsService()
+    analytics: createStandaloneAnalyticsService(),
+    tenantService,
+    appSettingsService
   };
 }
 function initStandaloneServices(options = {}) {
@@ -1665,7 +1783,9 @@ function initStandaloneServices(options = {}) {
     [TOKENS.realtime, services.realtime],
     [TOKENS.observability, services.observability],
     [TOKENS.notification, services.notification],
-    [TOKENS.analytics, services.analytics]
+    [TOKENS.analytics, services.analytics],
+    [TOKENS.tenantService, services.tenantService],
+    [TOKENS.appSettingsService, services.appSettingsService]
   ];
   for (const [token, service] of tokenServiceMap) {
     if (registerMode === "always" || !getService(token)) {
@@ -2167,8 +2287,10 @@ export {
   createReactRouterNavigationAdapter,
   createRequestContextService,
   createStandaloneApiClient,
+  createStandaloneAppSettingsService,
   createStandaloneI18nService,
   createStandaloneRealtimeService,
+  createStandaloneTenantService,
   createStandaloneUserService,
   createTestServices,
   initStandaloneServices,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ptech-shell-dev",
-   "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Standalone/mock shell service implementations for Module Federation apps.",
   "type": "module",
   "main": "dist/index.js",
@@ -23,17 +23,17 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "ptech-shell-sdk": "^1.7.0"
+    "ptech-shell-sdk": "^1.8.0"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.13",
+    "react": "^19.2.4",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
   },
-  "peerDependencies": {
-    "react": ">=18"
-  },
-  "devDependencies": {
-    "@types/react": "^19.2.13",
-    "react": "^19.2.4",
-    "tsup": "^8.5.1",
-    "typescript": "^5.9.3"
-  },
   "keywords": [
     "micro-frontend",
     "module-federation",