@cobaltcore-dev/aurora 2.1.1 → 2.2.0

package/README.md

@@ -52,20 +52,21 @@ export function App() {
 
 ### `createServer(config)`
 
-| Option                            | Type          | Required | Default                    | Description                                                      |
-| --------------------------------- | ------------- | -------- | -------------------------- | ---------------------------------------------------------------- |
-| `identityEndpoint`                | `string`      | yes      | —                          | OpenStack Keystone v3 URL                                        |
-| `policyDir`                       | `string`      | yes      | —                          | Absolute path to a directory of OpenStack policy YAML files      |
-| `bffEndpoint`                     | `string`      | no       | `"/polaris-bff"`           | URL prefix for all tRPC routes                                   |
-| `viteRoot`                        | `string`      | no       | —                          | Directory that contains `dist/client/` in production             |
-| `defaultEndpointInterface`        | `string`      | no       | `"public"`                 | OpenStack service catalog interface                              |
-| `proxyUrl`                        | `string`      | no       | —                          | HTTP proxy for OpenStack calls (dev only, ignored in production) |
-| `cephRegion`                      | `string`      | no       | —                          | Ceph RGW region for S3 operations                                |
-| `imageMetadataExcludedProperties` | `string`      | no       | —                          | Comma-separated image metadata keys to hide in the UI            |
-| `cookieName`                      | `string`      | no       | `"dashboard-session-auth"` | Override the session cookie name                                 |
-| `crossDomainCookie`               | `boolean`     | no       | `true`                     | Share cookie across subdomains                                   |
-| `insecureCookies`                 | `boolean`     | no       | `false`                    | Disable `Secure` flag — only for HTTP-only local dev             |
-| `routers`                         | `AnyRouter[]` | no       | `[]`                       | Additional tRPC routers — see [Custom routers](#custom-routers)  |
+| Option                            | Type              | Required | Default                    | Description                                                                                       |
+| --------------------------------- | ----------------- | -------- | -------------------------- | ------------------------------------------------------------------------------------------------- |
+| `identityEndpoint`                | `string`          | yes      | —                          | OpenStack Keystone v3 URL                                                                         |
+| `policyDir`                       | `string`          | yes      | —                          | Absolute path to a directory of OpenStack policy YAML files                                       |
+| `bffEndpoint`                     | `string`          | no       | `"/polaris-bff"`           | URL prefix for all tRPC routes                                                                    |
+| `viteRoot`                        | `string`          | no       | —                          | Directory that contains `dist/client/` in production                                              |
+| `defaultEndpointInterface`        | `string`          | no       | `"public"`                 | OpenStack service catalog interface                                                               |
+| `proxyUrl`                        | `string`          | no       | —                          | HTTP proxy for OpenStack calls (dev only, ignored in production)                                  |
+| `cephRegion`                      | `string`          | no       | —                          | Ceph RGW region for S3 operations                                                                 |
+| `imageMetadataExcludedProperties` | `string`          | no       | —                          | Comma-separated image metadata keys to hide in the UI                                             |
+| `cookieName`                      | `string`          | no       | `"dashboard-session-auth"` | Override the session cookie name                                                                  |
+| `crossDomainCookie`               | `boolean`         | no       | `true`                     | Share cookie across subdomains                                                                    |
+| `insecureCookies`                 | `boolean`         | no       | `false`                    | Disable `Secure` flag — only for HTTP-only local dev                                              |
+| `routers`                         | `AnyRouter[]`     | no       | `[]`                       | Additional tRPC routers — see [Custom routers](#custom-routers)                                   |
+| `appConfig`                       | `AuroraAppConfig` | no       | -                          | Per-domain service/slot visibility and feature flags; see [App configuration](#app-configuration) |
 
 ## Custom routers
 
@@ -112,6 +113,12 @@ server.get("/healthz", async () => ({ ok: true }))
 await server.listen({ host: "0.0.0.0", port: 4000 })
 ```
 
+## App configuration
+
+`appConfig` controls which services and UI slots are visible and sets feature flags, globally and per domain. When omitted, Aurora is default-open: all catalog services and all registered slots render.
+
+See [docs/0015_app_config.md](./docs/0015_app_config.md) for the full reference including visibility fields, domain overrides, allow-beats-deny semantics, and how to load configuration from a YAML file.
+
 ### `<AuroraApp />`
 
 | Prop                | Type                            | Default          | Description                                                                                                         |
@@ -160,17 +167,16 @@ function MyFooter(_props: SlotProps) {
 
 ### Available slots
 
-| Slot                    | Location                                                                     | `auroraContext` extras         | Renders in shadow DOM |
-| ----------------------- | ---------------------------------------------------------------------------- | ------------------------------ | --------------------- |
-| `logo`                  | Page header, replacing the default Aurora logo                               | —                              | No                    |
-| `sideNavBanner`         | Bottom of the project side navigation                                        | —                              | Yes                   |
-| `pageFooter`            | Page footer, replacing the default empty footer                              | —                              | No                    |
-| `login`                 | Replaces the default login form — use in OIDC environments                   | —                              | No                    |
-| `serviceBadge`          | Inline next to each service label in the side nav and project home cards     | `currentService` (service key) | No                    |
-| `servicePageActions`    | Beside the page title in the service page header                             | `currentService` (service key) | No                    |
-| `serviceBanner`         | Below the page title divider on every service page                           | `currentService` (service key) | No                    |
-| `projectsBanner`        | Below the "Projects" heading on the projects list page                       | —                              | No                    |
-| `projectOverviewBanner` | Below the project description on the project overview page (`/projects/:id`) | —                              | No                    |
+| Slot                 | Location                                                                 | `auroraContext` extras         | Renders in shadow DOM |
+| -------------------- | ------------------------------------------------------------------------ | ------------------------------ | --------------------- |
+| `logo`               | Page header, replacing the default Aurora logo                           | —                              | No                    |
+| `sideNavBanner`      | Bottom of the project side navigation                                    | —                              | Yes                   |
+| `pageFooter`         | Page footer, replacing the default empty footer                          | —                              | No                    |
+| `login`              | Replaces the default login form — use in OIDC environments               | —                              | No                    |
+| `serviceBadge`       | Inline next to each service label in the side nav and project home cards | `currentService` (service key) | No                    |
+| `servicePageActions` | Beside the page title in the service page header                         | `currentService` (service key) | No                    |
+| `serviceBanner`      | Below the page title divider on every service page                       | `currentService` (service key) | No                    |
+| `projectsBanner`     | Below the "Projects" heading on the projects list page                   | —                              | No                    |
 
 The `serviceBadge`, `servicePageActions`, and `serviceBanner` slots receive `auroraContext.currentService` — a string identifying which service is being rendered (e.g. `"images"`, `"ceph-containers"`). Return `null` from these slots to suppress rendering for specific services.
 

package/dist/client/AuroraApp.d.ts

@@ -1,5 +1,6 @@
 import { FC } from 'react';
 import { TrpcClient } from './trpcClient';
+import { SlotName } from '../types/appConfig';
 /** Context object passed to every slot component. */
 export type SlotProps = {
     auroraContext: {
@@ -25,11 +26,16 @@ export type Slots = {
     servicePageActions?: FC<SlotProps>;
     /** Rendered below the "Projects" heading on the projects list page. Renders outside shadow DOM. */
     projectsBanner?: FC<SlotProps>;
-    /** Rendered below the project description on the project overview page (/projects/$projectId). Renders outside shadow DOM. */
-    projectOverviewBanner?: FC<SlotProps>;
     /** Rendered below the page title divider on every service page. Receives `auroraContext.currentService`. Renders outside shadow DOM. */
     serviceBanner?: FC<SlotProps>;
 };
+/**
+ * Compile-time guard: `SlotName` is declared in the JSX-free types module (so the server
+ * build can consume it) and must stay identical to the keys of `Slots`. If the two drift,
+ * the conditional below resolves to `false` and `Assert<false>` fails to compile.
+ */
+type Assert<T extends true> = T;
+export type _SlotNamesInSync = Assert<SlotName extends keyof Slots ? (keyof Slots extends SlotName ? true : false) : false>;
 /**
  * Payload for analytics tracking events.
  * Generic structure that supports multiple event sources (router, links, modals, etc.)
@@ -129,3 +135,4 @@ export type AuroraAppProps = {
     serviceExtensions?: ServiceExtension[];
 };
 export declare const AuroraApp: FC<AuroraAppProps>;
+export {};

package/dist/client/context/AppConfigContext.d.ts

@@ -0,0 +1,44 @@
+import { default as React } from 'react';
+import { FeatureBag, ResolvedAppConfig, ServiceFeatureMap } from '../../types/appConfig';
+/**
+ * Fetches the resolved domain configuration from the BFF and provides it to the tree.
+ *
+ * The `appConfig.get` procedure is public: before login it returns the base layer,
+ * and once authenticated it returns the base merged with any overrides matching the
+ * user's home domain. Because login happens in place (no page reload), we invalidate the
+ * query whenever the authenticated identity changes so the domain overrides are picked up.
+ *
+ * Must be rendered inside `AuthProvider` and the tRPC/React Query providers.
+ */
+export declare function AppConfigProvider({ children }: {
+    children: React.ReactNode;
+}): React.JSX.Element;
+/** Returns true while the initial appConfig fetch is in-flight. */
+export declare function useIsAppConfigLoading(): boolean;
+/**
+ * Returns the appConfig fetch state for rendering a status screen: the error (or null) and
+ * a `retry` to refetch. Use alongside {@link useIsAppConfigLoading} for the loading state.
+ */
+export declare function useAppConfigStatus(): {
+    error: unknown;
+    retry: () => void;
+};
+/**
+ * Returns the domain configuration resolved for the current user's domain.
+ *
+ * Return values after the initial fetch completes:
+ * - Populated `ResolvedAppConfig` — domain config was supplied and resolved successfully.
+ * - Empty object (`{}`) cast to `ResolvedAppConfig` — fetch succeeded but no domain config
+ *   was configured; all fields will be absent. Test with `Object.keys(config).length === 0`
+ *   if you need to distinguish this from a populated config.
+ * - `undefined` — fetch is still in-flight or has not yet started.
+ *
+ * Supply the generic parameters to get typed access to your own service and feature shapes:
+ * `useAppConfig<MyServices, MyFeatures>()`.
+ */
+export declare function useAppConfig<TServices extends ServiceFeatureMap = ServiceFeatureMap, TFeatures extends FeatureBag = FeatureBag>(): ResolvedAppConfig<TServices, TFeatures> | undefined;
+/**
+ * Reads a single app-wide feature flag from the resolved domain config.
+ * Returns undefined when the flag is unset or the config has not loaded yet.
+ */
+export declare function useFeature<T = boolean>(key: string): T | undefined;

package/dist/client/index.d.ts

@@ -2,6 +2,8 @@ export { AuroraApp, type AuroraAppProps, type Slots, type SlotProps, type TrackE
 export { type TrpcClient, type TrpcReact, type CreateTypedTrpcReact, type CreateTypedTrpcClient, trpcClient, trpcReactClient, trpcReact, } from './trpcClient';
 export { useAuth } from './store/AuthProvider';
 export { useDomainId, useScope } from './hooks';
+export { AppConfigProvider, useAppConfig, useFeature, useIsAppConfigLoading } from './context/AppConfigContext';
+export type { AuroraAppConfig, AppConfigBase, DomainOverride, ResolvedAppConfig, Visibility, VisibilityDelta, SlotConfigEntry, ServiceFeatureMap, FeatureBag, SlotName, } from '../types/appConfig';
 export type { RouteInfo, Crumb } from './routes/routeInfo';
 export { isRouteInfo } from './routes/routeInfo';
 export { usePushBreadcrumbs } from './hooks/usePushBreadcrumbs';