@marinoscar/platform-web 0.1.0-next.3 → 0.1.0-next.5

package/dist/settings/testing/settings-route-ownership.suite.js

@@ -0,0 +1,115 @@
+// =============================================================================
+// Suite: route ownership (issues #55, #92, #742)
+// =============================================================================
+//
+// The route-ownership table is the one piece of this navigation that manual
+// testing cannot check: a route claimed by two destinations emits
+// `aria-current="page"` twice and highlights two rail rows, and a route claimed
+// by none silently highlights nothing. Both look fine on the screen you happen
+// to be standing on.
+//
+// So the suite reads the LIVE route table (an array the app exports, or the
+// text of its route file) and the app's own destination functions, never a copy
+// of either. It is moved from the first blocks of the reference app's
+// `destinations.test.ts`; what stayed there is what is about ITS destinations
+// (that Console is pinned, that the bottom bar caps at four, the AI
+// Playground's two permissions).
+// =============================================================================
+import { webConformanceSuites } from '../../testing/index.js';
+import { resolveAppRoutes } from './routes.js';
+function register(api, context) {
+    const { describe, it, expect } = api;
+    const view = context.destinations;
+    if (view === undefined) {
+        throw new Error("settings-route-ownership: the app passed no `destinations`. Pass its destination table, or skip the suite: `suites: { 'settings-route-ownership': { skip: 'why' } }`.");
+    }
+    const paths = () => resolveAppRoutes(context.routes).map((route) => route.path);
+    const ownersOf = (path) => Object.keys(view.routes).filter((key) => view.routes[key].some((prefix) => view.owns(prefix, path)));
+    describe('destinations: route ownership', () => {
+        it('finds the destination routes, the hubs and the public ones, so a broken route table cannot pass vacuously', () => {
+            const declared = paths();
+            expect(declared.length).toBeGreaterThanOrEqual(8);
+            expect(declared).toContain('/');
+            expect(declared).toContain(context.hubs.admin.path);
+            expect(declared).toContain(context.hubs.user.path);
+        });
+        it('claims every route exactly once, or deliberately not at all', () => {
+            const failures = [];
+            for (const path of paths()) {
+                const owners = ownersOf(path);
+                if (view.unowned.includes(path)) {
+                    if (owners.length > 0)
+                        failures.push(`${path} is listed as unowned but ${owners.join(', ')} claims it`);
+                }
+                else if (owners.length !== 1) {
+                    failures.push(`${path} should be owned by exactly one destination, owners: [${owners.join(', ')}]`);
+                }
+            }
+            expect(failures).toEqual([]);
+        });
+        it('lists every declared route as either owned or explicitly unowned', () => {
+            // The complement: a route neither claimed nor listed as deliberately
+            // unowned is an OVERSIGHT, and would pass the test above by being
+            // "unowned by accident".
+            const failures = paths()
+                .filter((path) => view.resolveActive(path) === null && !view.unowned.includes(path))
+                .map((path) => `${path} is neither owned by a destination nor listed as unowned`);
+            expect(failures).toEqual([]);
+        });
+        it('highlights NOTHING on the deliberately unowned routes', () => {
+            // No destination is better than a wrong one: the login screen does not belong to Home.
+            const failures = view.unowned.filter((path) => view.resolveActive(path) !== null).map((path) => `${path} activates ${String(view.resolveActive(path))}`);
+            expect(failures).toEqual([]);
+        });
+        it('gives every destination in the table a route it owns', () => {
+            // An external destination (a link to another site) owns no route.
+            const failures = view.destinations
+                .filter((destination) => destination.external !== true)
+                .filter((destination) => view.resolveActive(destination.path) !== destination.key)
+                .map((destination) => `${destination.path} activates ${String(view.resolveActive(destination.path))}, expected ${destination.key}`);
+            expect(view.destinations.length).toBeGreaterThanOrEqual(1);
+            expect(failures).toEqual([]);
+        });
+        it('matches a prefix only at a segment boundary', () => {
+            expect(view.owns('/settings', '/settings')).toEqual(true);
+            expect(view.owns('/settings', '/settings/profile')).toEqual(true);
+            expect(view.owns('/settings', '/settingsfoo')).toEqual(false);
+            expect(view.owns('/settings', '/settings-archive')).toEqual(false);
+        });
+        it('never lets an owned prefix with a suffix activate its destination', () => {
+            // A bare `startsWith` (what the old Sidebar did) matches `/settingsfoo`.
+            const failures = Object.entries(view.routes).flatMap(([key, prefixes]) => prefixes
+                .filter((prefix) => prefix !== '/')
+                .filter((prefix) => view.resolveActive(`${prefix}foo`) === key)
+                .map((prefix) => `${prefix}foo activates ${key}`));
+            expect(failures).toEqual([]);
+        });
+        it('activates the root destination on / only, and a destination for its child routes', () => {
+            // Every path starts with '/', so without the exact-match rule the root
+            // would own the entire app.
+            expect(view.owns('/', '/anything')).toEqual(false);
+            expect(view.owns('/', '/')).toEqual(true);
+            const failures = view.destinations
+                .filter((destination) => destination.external !== true)
+                .filter((destination) => destination.path !== '/')
+                .filter((destination) => view.resolveActive(`${destination.path}/child`) !== destination.key)
+                .map((destination) => `${destination.path}/child does not activate ${destination.key}`);
+            expect(failures).toEqual([]);
+        });
+    });
+}
+/**
+ * The suite behind `runPlatformWebConformance`: no route is claimed by two
+ * destinations or by none, and matching respects segment boundaries.
+ *
+ * @extensionPoint registry
+ * @stability experimental
+ */
+export const settingsRouteOwnershipSuite = {
+    id: 'settings-route-ownership',
+    title: 'destinations: route ownership',
+    description: 'Every route the app declares is owned by exactly one destination or deliberately by none, and ownership matches on segment boundaries (#55, #92).',
+    register,
+};
+webConformanceSuites.register(settingsRouteOwnershipSuite);
+//# sourceMappingURL=settings-route-ownership.suite.js.map

package/dist/settings/testing/settings-route-ownership.suite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings-route-ownership.suite.js","sourceRoot":"","sources":["../../../src/settings/testing/settings-route-ownership.suite.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,iDAAiD;AACjD,gFAAgF;AAChF,EAAE;AACF,4EAA4E;AAC5E,kEAAkE;AAClE,gFAAgF;AAChF,+EAA+E;AAC/E,qBAAqB;AACrB,EAAE;AACF,4EAA4E;AAC5E,gFAAgF;AAChF,sEAAsE;AACtE,8EAA8E;AAC9E,oEAAoE;AACpE,iCAAiC;AACjC,gFAAgF;AAGhF,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,SAAS,QAAQ,CAAC,GAA0B,EAAE,OAA8B;IAC1E,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IACrC,MAAM,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAElC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,uKAAuK,CACxK,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAG,GAAa,EAAE,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1F,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAY,EAAE,CAC1C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAuB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAE9H,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;QAC7C,EAAE,CAAC,2GAA2G,EAAE,GAAG,EAAE;YACnH,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAC;YAEzB,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YAChC,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACpD,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACrE,MAAM,QAAQ,GAAa,EAAE,CAAC;YAE9B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;gBAC3B,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC9B,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;oBAChC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;wBAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,6BAA6B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC1G,CAAC;qBAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC/B,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,yDAAyD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACtG,CAAC;YACH,CAAC;YAED,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;YAC1E,qEAAqE;YACrE,kEAAkE;YAClE,yBAAyB;YACzB,MAAM,QAAQ,GAAG,KAAK,EAAE;iBACrB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;iBACnF,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,0DAA0D,CAAC,CAAC;YAEpF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,uFAAuF;YACvF,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,cAAc,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;YAEzJ,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC9D,kEAAkE;YAClE,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY;iBAC/B,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,KAAK,IAAI,CAAC;iBACtD,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,WAAW,CAAC,GAAG,CAAC;iBACjF,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,GAAG,WAAW,CAAC,IAAI,cAAc,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,cAAc,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC;YAEtI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;YAC3D,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC1D,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC9D,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;YAC3E,yEAAyE;YACzE,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,EAAE,CACvE,QAAQ;iBACL,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,GAAG,CAAC;iBAClC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,MAAM,KAAK,CAAC,KAAK,GAAG,CAAC;iBAC9D,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,MAAM,iBAAiB,GAAG,EAAE,CAAC,CACpD,CAAC;YAEF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kFAAkF,EAAE,GAAG,EAAE;YAC1F,uEAAuE;YACvE,4BAA4B;YAC5B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACnD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAE1C,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY;iBAC/B,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,KAAK,IAAI,CAAC;iBACtD,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,GAAG,CAAC;iBACjD,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,WAAW,CAAC,IAAI,QAAQ,CAAC,KAAK,WAAW,CAAC,GAAG,CAAC;iBAC5F,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,GAAG,WAAW,CAAC,IAAI,4BAA4B,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC;YAE1F,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAwB;IAC9D,EAAE,EAAE,0BAA0B;IAC9B,KAAK,EAAE,+BAA+B;IACtC,WAAW,EACT,mJAAmJ;IACrJ,QAAQ;CACT,CAAC;AAEF,oBAAoB,CAAC,QAAQ,CAAC,2BAA2B,CAAC,CAAC"}

package/dist/settings/ui/ImageUpload.d.ts

@@ -0,0 +1,49 @@
+import type { ProfileImageMutationResponse } from '../headless/profile-image.js';
+/**
+ * Mirrors the API's limit; the server re-checks the actual bytes (#367).
+ *
+ * @stability experimental
+ */
+export declare const PROFILE_IMAGE_MAX_BYTES: number;
+/**
+ * Mirrors the API's allowed formats; the server validates by magic bytes.
+ *
+ * @stability experimental
+ */
+export declare const PROFILE_IMAGE_TYPES: readonly string[];
+/**
+ * Props of {@link ImageUpload}.
+ *
+ * @stability experimental
+ */
+export interface ImageUploadProps {
+    /**
+     * Called with the upload response once the server has stored the picture.
+     * The response carries the new settings document (and `version`), which the
+     * caller must adopt. `file` is the picked file, so the caller can preview it
+     * locally before any authenticated re-fetch completes.
+     */
+    onUploaded: (result: ProfileImageMutationResponse, file: File) => void | Promise<void>;
+    /** Lets the parent block conflicting actions while bytes are in flight. */
+    onUploadingChange?: (uploading: boolean) => void;
+    /** Disables the control. */
+    disabled?: boolean;
+    /** Button text, e.g. "Replace picture" when one already exists. */
+    label?: string;
+}
+/**
+ * The profile picture upload button: client-side type and size pre-checks, then
+ * the upload; the server stays authoritative.
+ *
+ * @param props - see {@link ImageUploadProps}.
+ * @returns the control.
+ *
+ * @example
+ * ```tsx
+ * <ImageUpload onUploaded={(result) => adopt(result.settings)} />
+ * ```
+ *
+ * @stability experimental
+ */
+export declare function ImageUpload({ onUploaded, onUploadingChange, disabled, label, }: ImageUploadProps): import("react").JSX.Element;
+//# sourceMappingURL=ImageUpload.d.ts.map

package/dist/settings/ui/ImageUpload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImageUpload.d.ts","sourceRoot":"","sources":["../../../src/settings/ui/ImageUpload.tsx"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AAEjF;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,QAAkB,CAAC;AACvD;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,EAAE,SAAS,MAAM,EAKhD,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,UAAU,EAAE,CAAC,MAAM,EAAE,4BAA4B,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvF,2EAA2E;IAC3E,iBAAiB,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IACjD,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAmBD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CAAC,EAC1B,UAAU,EACV,iBAAiB,EACjB,QAAgB,EAChB,KAAwB,GACzB,EAAE,gBAAgB,+BAwFlB"}

package/dist/settings/ui/ImageUpload.js

@@ -0,0 +1,96 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { useId, useRef, useState } from 'react';
+import { Alert, Box, Button, LinearProgress, Typography } from '@mui/material';
+import { CloudUpload as UploadIcon } from '@mui/icons-material';
+import { isPlatformApiError } from '../../core/index.js';
+import { useProfileImageClient } from '../headless/profile-image.js';
+/**
+ * Mirrors the API's limit; the server re-checks the actual bytes (#367).
+ *
+ * @stability experimental
+ */
+export const PROFILE_IMAGE_MAX_BYTES = 5 * 1024 * 1024;
+/**
+ * Mirrors the API's allowed formats; the server validates by magic bytes.
+ *
+ * @stability experimental
+ */
+export const PROFILE_IMAGE_TYPES = [
+    'image/jpeg',
+    'image/png',
+    'image/gif',
+    'image/webp',
+];
+function describeUploadError(err) {
+    if (isPlatformApiError(err)) {
+        // `ApiService` falls back to this literal when the body carried no message
+        // (e.g. a proxy's HTML 413 page), so only a real server message wins.
+        if (err.message && err.message !== 'Request failed') {
+            return err.message;
+        }
+        if (err.status === 413) {
+            return 'The image must be 5 MB or smaller.';
+        }
+        if (err.status === 400) {
+            return 'That file is not a supported image (JPEG, PNG, GIF or WebP).';
+        }
+    }
+    return 'Failed to upload the picture. Please try again.';
+}
+/**
+ * The profile picture upload button: client-side type and size pre-checks, then
+ * the upload; the server stays authoritative.
+ *
+ * @param props - see {@link ImageUploadProps}.
+ * @returns the control.
+ *
+ * @example
+ * ```tsx
+ * <ImageUpload onUploaded={(result) => adopt(result.settings)} />
+ * ```
+ *
+ * @stability experimental
+ */
+export function ImageUpload({ onUploaded, onUploadingChange, disabled = false, label = 'Upload picture', }) {
+    const [isUploading, setIsUploading] = useState(false);
+    const [error, setError] = useState(null);
+    const fileInputRef = useRef(null);
+    const hintId = useId();
+    const profileImage = useProfileImageClient();
+    const setUploading = (uploading) => {
+        setIsUploading(uploading);
+        onUploadingChange?.(uploading);
+    };
+    const handleFileSelect = async (event) => {
+        const file = event.target.files?.[0];
+        // Reset so choosing the same file again still fires `change`.
+        event.target.value = '';
+        if (!file)
+            return;
+        // Client-side pre-checks only save a round trip; the API is authoritative.
+        if (!PROFILE_IMAGE_TYPES.includes(file.type)) {
+            setError('Please choose a JPEG, PNG, GIF or WebP image.');
+            return;
+        }
+        if (file.size > PROFILE_IMAGE_MAX_BYTES) {
+            setError('The image must be 5 MB or smaller.');
+            return;
+        }
+        setError(null);
+        setUploading(true);
+        let result;
+        try {
+            result = await profileImage.upload(file);
+        }
+        catch (err) {
+            setError(describeUploadError(err));
+            setUploading(false);
+            return;
+        }
+        setUploading(false);
+        await onUploaded(result, file);
+    };
+    const isDisabled = disabled || isUploading;
+    return (_jsxs(Box, { children: [_jsx("input", { ref: fileInputRef, type: "file", accept: PROFILE_IMAGE_TYPES.join(','), onChange: handleFileSelect, style: { display: 'none' }, disabled: isDisabled, "data-testid": "profile-image-file-input" }), _jsx(Button, { variant: "outlined", size: "small", startIcon: _jsx(UploadIcon, {}), onClick: () => fileInputRef.current?.click(), disabled: isDisabled, "aria-describedby": hintId, children: isUploading ? 'Uploading...' : label }), _jsx(Typography, { id: hintId, variant: "caption", color: "text.secondary", sx: { display: 'block', mt: 0.5 }, children: "JPEG, PNG, GIF or WebP, up to 5 MB." }), isUploading && (_jsx(LinearProgress, { "aria-label": "Uploading picture", sx: { mt: 1, maxWidth: 240 } })), error && (_jsx(Alert, { severity: "error", sx: { mt: 1 }, onClose: () => setError(null), children: error }))] }));
+}
+//# sourceMappingURL=ImageUpload.js.map

package/dist/settings/ui/ImageUpload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImageUpload.js","sourceRoot":"","sources":["../../../src/settings/ui/ImageUpload.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEhD,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC/E,OAAO,EAAE,WAAW,IAAI,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAGrE;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AACvD;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAsB;IACpD,YAAY;IACZ,WAAW;IACX,WAAW;IACX,YAAY;CACb,CAAC;AAuBF,SAAS,mBAAmB,CAAC,GAAY;IACvC,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5B,2EAA2E;QAC3E,sEAAsE;QACtE,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,KAAK,gBAAgB,EAAE,CAAC;YACpD,OAAO,GAAG,CAAC,OAAO,CAAC;QACrB,CAAC;QACD,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACvB,OAAO,oCAAoC,CAAC;QAC9C,CAAC;QACD,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACvB,OAAO,8DAA8D,CAAC;QACxE,CAAC;IACH,CAAC;IACD,OAAO,iDAAiD,CAAC;AAC3D,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,WAAW,CAAC,EAC1B,UAAU,EACV,iBAAiB,EACjB,QAAQ,GAAG,KAAK,EAChB,KAAK,GAAG,gBAAgB,GACP;IACjB,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IACtD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;IACxD,MAAM,YAAY,GAAG,MAAM,CAAmB,IAAI,CAAC,CAAC;IACpD,MAAM,MAAM,GAAG,KAAK,EAAE,CAAC;IACvB,MAAM,YAAY,GAAG,qBAAqB,EAAE,CAAC;IAE7C,MAAM,YAAY,GAAG,CAAC,SAAkB,EAAE,EAAE;QAC1C,cAAc,CAAC,SAAS,CAAC,CAAC;QAC1B,iBAAiB,EAAE,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,KAAK,EAAE,KAAoC,EAAE,EAAE;QACtE,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QACrC,8DAA8D;QAC9D,KAAK,CAAC,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,IAAI;YAAE,OAAO;QAElB,2EAA2E;QAC3E,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7C,QAAQ,CAAC,+CAA+C,CAAC,CAAC;YAC1D,OAAO;QACT,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,GAAG,uBAAuB,EAAE,CAAC;YACxC,QAAQ,CAAC,oCAAoC,CAAC,CAAC;YAC/C,OAAO;QACT,CAAC;QAED,QAAQ,CAAC,IAAI,CAAC,CAAC;QACf,YAAY,CAAC,IAAI,CAAC,CAAC;QAEnB,IAAI,MAAoC,CAAC;QACzC,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,QAAQ,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC;YACnC,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO;QACT,CAAC;QAED,YAAY,CAAC,KAAK,CAAC,CAAC;QACpB,MAAM,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,QAAQ,IAAI,WAAW,CAAC;IAE3C,OAAO,CACL,MAAC,GAAG,eACF,gBACE,GAAG,EAAE,YAAY,EACjB,IAAI,EAAC,MAAM,EACX,MAAM,EAAE,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,EACrC,QAAQ,EAAE,gBAAgB,EAC1B,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAC1B,QAAQ,EAAE,UAAU,iBACR,0BAA0B,GACtC,EACF,KAAC,MAAM,IACL,OAAO,EAAC,UAAU,EAClB,IAAI,EAAC,OAAO,EACZ,SAAS,EAAE,KAAC,UAAU,KAAG,EACzB,OAAO,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,EAAE,EAC5C,QAAQ,EAAE,UAAU,sBACF,MAAM,YAEvB,WAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,GAC9B,EACT,KAAC,UAAU,IACT,EAAE,EAAE,MAAM,EACV,OAAO,EAAC,SAAS,EACjB,KAAK,EAAC,gBAAgB,EACtB,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,oDAGtB,EACZ,WAAW,IAAI,CACd,KAAC,cAAc,kBACF,mBAAmB,EAC9B,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,GAC5B,CACH,EACA,KAAK,IAAI,CACR,KAAC,KAAK,IAAC,QAAQ,EAAC,OAAO,EAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,YACjE,KAAK,GACA,CACT,IACG,CACP,CAAC;AACJ,CAAC"}

package/dist/settings/ui/OrgSettingsPage.d.ts

@@ -0,0 +1,41 @@
+import type { PageSlotsBase } from '../../core/index.js';
+/**
+ * The slots of {@link OrgSettingsPage}: the page-slot contract. `Sections` is
+ * drawn at both ends of the body, around the generated namespace cards, so an
+ * app's own organization setting (one that is not a registered namespace) sits
+ * beside them.
+ *
+ * @example
+ * ```tsx
+ * <OrgSettingsPage slots={{ Sections: ({ position }) => (position === 'bottom' ? <BillingContactCard /> : null) }} />
+ * ```
+ *
+ * @extensionPoint slot
+ * @stability experimental
+ */
+export type OrgSettingsPageSlots = PageSlotsBase;
+/**
+ * The props of {@link OrgSettingsPage}.
+ *
+ * @stability experimental
+ */
+export interface OrgSettingsPageProps {
+    /** Optional extension slots; omitted, the page renders exactly as it always did. */
+    slots?: OrgSettingsPageSlots;
+}
+/**
+ * The Organization settings page: one card per org-overridable namespace,
+ * generated from the descriptors `GET /org-settings` returns.
+ *
+ * @returns the page.
+ *
+ * @example
+ * ```tsx
+ * <Route path="/admin/settings/organization-settings" element={<OrgSettingsPage />} />
+ * ```
+ *
+ * @extensionPoint component
+ * @stability experimental
+ */
+export declare function OrgSettingsPage(props?: OrgSettingsPageProps): import("react").JSX.Element;
+//# sourceMappingURL=OrgSettingsPage.d.ts.map

package/dist/settings/ui/OrgSettingsPage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrgSettingsPage.d.ts","sourceRoot":"","sources":["../../../src/settings/ui/OrgSettingsPage.tsx"],"names":[],"mappings":"AAsCA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAgLzD;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,oFAAoF;IACpF,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAAC,KAAK,GAAE,oBAAyB,+BA0E/D"}

package/dist/settings/ui/OrgSettingsPage.js

@@ -0,0 +1,99 @@
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
+/**
+ * Organization settings (#733, PP-8.1): the CURRENT organization's overrides
+ * of the system settings namespaces that let an organization change them.
+ * Reached through the `Organization settings` card
+ * (`/admin/settings/organization-settings`, `org_settings:read`,
+ * `feature: 'orgs'`).
+ *
+ * THE FORM IS GENERATED from the namespace descriptors `GET /api/org-settings`
+ * returns (each field's kind: boolean, enum, number, string, or `other`, which
+ * the slice's own page manages). The page decides nothing: the API resolves
+ * the effective values, validates every write against the namespace's org
+ * schema and filters namespaces by their own permissions.
+ *
+ * WRITES ARE GATED INSIDE THE PAGE (Settings UI Pattern rule 3): without
+ * `org_settings:write` every control is disabled, never hidden; a namespace
+ * whose own write permission the caller lacks is read-only too
+ * (`writable: false`).
+ */
+import { useMemo, useState } from 'react';
+import { Alert, Box, Button, Card, CardContent, Chip, CircularProgress, Container, FormControlLabel, MenuItem, Stack, Switch, TextField, Typography, } from '@mui/material';
+import { PageSlotsFrame } from '../../core/index.js';
+import { useAuth, usePermissions } from '../../identity/index.js';
+import { orgSettingsFieldRenderer } from '../headless/org-field-renderers.js';
+import { useOrgSettings } from '../headless/use-org-settings.js';
+/** The page title (the card's title). */
+const ORG_SETTINGS_TITLE = 'Organization settings';
+function FieldControl({ namespace, field, value, inherited, disabled, onChange, }) {
+    // A draft `null` is a cleared control (the override will be removed), not "no draft".
+    const shown = value !== undefined ? value : inherited;
+    const label = field.name;
+    switch (field.kind) {
+        case 'boolean':
+            return (_jsx(FormControlLabel, { control: _jsx(Switch, { checked: shown === true, disabled: disabled, onChange: (e) => onChange(e.target.checked) }), label: label }));
+        case 'enum':
+            return (_jsx(TextField, { select: true, size: "small", label: label, value: typeof shown === 'string' ? shown : '', disabled: disabled, onChange: (e) => onChange(e.target.value), sx: { minWidth: 220 }, children: (field.options ?? []).map((option) => (_jsx(MenuItem, { value: option, children: option }, option))) }));
+        case 'number':
+            return (_jsx(TextField, { type: "number", size: "small", label: label, value: typeof shown === 'number' ? shown : '', disabled: disabled, slotProps: { htmlInput: { min: field.min, max: field.max, step: field.integer ? 1 : 'any' } }, onChange: (e) => onChange(e.target.value === '' ? null : Number(e.target.value)), sx: { minWidth: 220 } }));
+        case 'string':
+            return (_jsx(TextField, { size: "small", label: label, value: typeof shown === 'string' ? shown : '', disabled: disabled, slotProps: { htmlInput: { maxLength: field.maxLength } }, onChange: (e) => onChange(e.target.value), sx: { minWidth: 280 } }));
+        default: {
+            // An app that added this field to an org layer draws it itself
+            // (`registerOrgSettingsFieldRenderer`); otherwise the note below.
+            const Renderer = orgSettingsFieldRenderer(namespace, field.name);
+            if (Renderer) {
+                return (_jsx(Renderer, { namespace: namespace, field: field, value: value, inherited: inherited, disabled: disabled, onChange: onChange }));
+            }
+            return (_jsxs(Typography, { variant: "body2", color: "text.secondary", children: [label, ": managed by the ", "slice's", " own settings page."] }));
+        }
+    }
+}
+function NamespaceCard({ namespace, stored, effective, canWrite, isSaving, onSave, }) {
+    const [draft, setDraft] = useState({});
+    const disabled = !canWrite || !namespace.writable || isSaving;
+    const dirty = Object.keys(draft).length > 0;
+    return (_jsx(Card, { variant: "outlined", children: _jsxs(CardContent, { children: [_jsxs(Stack, { direction: "row", spacing: 1, sx: { alignItems: 'center', mb: 0.5 }, children: [_jsx(Typography, { variant: "h6", component: "h2", children: namespace.key }), _jsx(Chip, { size: "small", label: namespace.merge === 'override' ? 'Overrides' : 'Can only restrict' }), stored && _jsx(Chip, { size: "small", color: "primary", variant: "outlined", label: "Customised" })] }), _jsx(Typography, { variant: "body2", color: "text.secondary", sx: { mb: 2 }, children: namespace.description }), _jsx(Stack, { spacing: 2, children: namespace.fields.map((field) => (_jsx(Box, { children: _jsx(FieldControl, { namespace: namespace.key, field: field, value: field.name in draft ? draft[field.name] : stored?.[field.name], inherited: effective?.[field.name], disabled: disabled, onChange: (next) => setDraft((current) => ({ ...current, [field.name]: next })) }) }, field.name))) }), _jsxs(Stack, { direction: "row", spacing: 1, sx: { mt: 2 }, children: [_jsx(Button, { variant: "contained", disabled: disabled || !dirty, onClick: async () => {
+                                await onSave(draft);
+                                setDraft({});
+                            }, children: "Save" }), _jsx(Button, { disabled: disabled || !stored, onClick: async () => {
+                                await onSave(null);
+                                setDraft({});
+                            }, children: "Use the deployment values" })] })] }) }));
+}
+/**
+ * The Organization settings page: one card per org-overridable namespace,
+ * generated from the descriptors `GET /org-settings` returns.
+ *
+ * @returns the page.
+ *
+ * @example
+ * ```tsx
+ * <Route path="/admin/settings/organization-settings" element={<OrgSettingsPage />} />
+ * ```
+ *
+ * @extensionPoint component
+ * @stability experimental
+ */
+export function OrgSettingsPage(props = {}) {
+    const { slots } = props;
+    const { activeOrg } = useAuth();
+    const { hasPermission } = usePermissions();
+    const canWrite = hasPermission('org_settings:write');
+    const { settings, isLoading, error, isSaving, patch } = useOrgSettings();
+    const [saveError, setSaveError] = useState(null);
+    const namespaces = useMemo(() => settings?.namespaces ?? [], [settings]);
+    const description = activeOrg
+        ? `Override, for ${activeOrg.name}, the settings the deployment lets an organization change.`
+        : 'Override, for your current organization, the settings the deployment lets an organization change.';
+    return (_jsx(Container, { maxWidth: "lg", children: _jsx(Box, { sx: { py: { xs: 2, sm: 4 } }, children: _jsxs(PageSlotsFrame, { slots: slots, headerProps: { title: ORG_SETTINGS_TITLE, description: description, readOnly: !canWrite, actions: null }, header: _jsxs(_Fragment, { children: [_jsx(Typography, { variant: "h4", component: "h1", gutterBottom: true, children: ORG_SETTINGS_TITLE }), _jsx(Typography, { color: "text.secondary", sx: { mb: 3 }, children: description })] }), children: [!canWrite && (_jsx(Alert, { severity: "info", sx: { mb: 2 }, children: "You can view these settings. Changing them requires org_settings:write." })), (error || saveError) && (_jsx(Alert, { severity: "error", sx: { mb: 2 }, children: saveError ?? error })), isLoading ? (_jsx(Box, { sx: { display: 'flex', justifyContent: 'center', py: 6 }, children: _jsx(CircularProgress, { "aria-label": "Loading organization settings" }) })) : namespaces.length === 0 ? (_jsx(Typography, { color: "text.secondary", children: "No setting of this deployment can be changed per organization." })) : (_jsx(Stack, { spacing: 2, children: namespaces.map((namespace) => (_jsx(NamespaceCard, { namespace: namespace, stored: settings?.value[namespace.key], effective: settings?.effective[namespace.key], canWrite: canWrite, isSaving: isSaving, onSave: async (body) => {
+                                setSaveError(null);
+                                try {
+                                    await patch({ [namespace.key]: body });
+                                }
+                                catch (err) {
+                                    setSaveError(err instanceof Error ? err.message : 'Failed to save the organization settings');
+                                }
+                            } }, namespace.key))) }))] }) }) }));
+}
+//# sourceMappingURL=OrgSettingsPage.js.map

package/dist/settings/ui/OrgSettingsPage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrgSettingsPage.js","sourceRoot":"","sources":["../../../src/settings/ui/OrgSettingsPage.tsx"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC1C,OAAO,EACL,KAAK,EACL,GAAG,EACH,MAAM,EACN,IAAI,EACJ,WAAW,EACX,IAAI,EACJ,gBAAgB,EAChB,SAAS,EACT,gBAAgB,EAChB,QAAQ,EACR,KAAK,EACL,MAAM,EACN,SAAS,EACT,UAAU,GACX,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAEjE,yCAAyC;AACzC,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;AAInD,SAAS,YAAY,CAAC,EACpB,SAAS,EACT,KAAK,EACL,KAAK,EACL,SAAS,EACT,QAAQ,EACR,QAAQ,GAQT;IACC,sFAAsF;IACtF,MAAM,KAAK,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACtD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;IACzB,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,SAAS;YACZ,OAAO,CACL,KAAC,gBAAgB,IACf,OAAO,EAAE,KAAC,MAAM,IAAC,OAAO,EAAE,KAAK,KAAK,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAI,EAC7G,KAAK,EAAE,KAAK,GACZ,CACH,CAAC;QACJ,KAAK,MAAM;YACT,OAAO,CACL,KAAC,SAAS,IACR,MAAM,QACN,IAAI,EAAC,OAAO,EACZ,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAC7C,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EACzC,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,YAEpB,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CACrC,KAAC,QAAQ,IAAc,KAAK,EAAE,MAAM,YACjC,MAAM,IADM,MAAM,CAEV,CACZ,CAAC,GACQ,CACb,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO,CACL,KAAC,SAAS,IACR,IAAI,EAAC,QAAQ,EACb,IAAI,EAAC,OAAO,EACZ,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAC7C,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,EAC7F,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAChF,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,GACrB,CACH,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO,CACL,KAAC,SAAS,IACR,IAAI,EAAC,OAAO,EACZ,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAC7C,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,EAAE,EACxD,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EACzC,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,GACrB,CACH,CAAC;QACJ,OAAO,CAAC,CAAC,CAAC;YACR,+DAA+D;YAC/D,kEAAkE;YAClE,MAAM,QAAQ,GAAG,wBAAwB,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YACjE,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO,CACL,KAAC,QAAQ,IACP,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,GAClB,CACH,CAAC;YACJ,CAAC;YACD,OAAO,CACL,MAAC,UAAU,IAAC,OAAO,EAAC,OAAO,EAAC,KAAK,EAAC,gBAAgB,aAC/C,KAAK,uBAAmB,SAAS,2BACvB,CACd,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,EACrB,SAAS,EACT,MAAM,EACN,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,MAAM,GAQP;IACC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAQ,EAAE,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,CAAC,QAAQ,IAAI,CAAC,SAAS,CAAC,QAAQ,IAAI,QAAQ,CAAC;IAC9D,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAE5C,OAAO,CACL,KAAC,IAAI,IAAC,OAAO,EAAC,UAAU,YACtB,MAAC,WAAW,eACV,MAAC,KAAK,IAAC,SAAS,EAAC,KAAK,EAAC,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,EAAE,aACtE,KAAC,UAAU,IAAC,OAAO,EAAC,IAAI,EAAC,SAAS,EAAC,IAAI,YACpC,SAAS,CAAC,GAAG,GACH,EACb,KAAC,IAAI,IAAC,IAAI,EAAC,OAAO,EAAC,KAAK,EAAE,SAAS,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,mBAAmB,GAAI,EAC/F,MAAM,IAAI,KAAC,IAAI,IAAC,IAAI,EAAC,OAAO,EAAC,KAAK,EAAC,SAAS,EAAC,OAAO,EAAC,UAAU,EAAC,KAAK,EAAC,YAAY,GAAG,IAChF,EACR,KAAC,UAAU,IAAC,OAAO,EAAC,OAAO,EAAC,KAAK,EAAC,gBAAgB,EAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,YAC7D,SAAS,CAAC,WAAW,GACX,EACb,KAAC,KAAK,IAAC,OAAO,EAAE,CAAC,YACd,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAC/B,KAAC,GAAG,cACF,KAAC,YAAY,IACX,SAAS,EAAE,SAAS,CAAC,GAAG,EACxB,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EACrE,SAAS,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAClC,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,GAC/E,IARM,KAAK,CAAC,IAAI,CASd,CACP,CAAC,GACI,EACR,MAAC,KAAK,IAAC,SAAS,EAAC,KAAK,EAAC,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,aAC9C,KAAC,MAAM,IACL,OAAO,EAAC,WAAW,EACnB,QAAQ,EAAE,QAAQ,IAAI,CAAC,KAAK,EAC5B,OAAO,EAAE,KAAK,IAAI,EAAE;gCAClB,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC;gCACpB,QAAQ,CAAC,EAAE,CAAC,CAAC;4BACf,CAAC,qBAGM,EACT,KAAC,MAAM,IACL,QAAQ,EAAE,QAAQ,IAAI,CAAC,MAAM,EAC7B,OAAO,EAAE,KAAK,IAAI,EAAE;gCAClB,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC;gCACnB,QAAQ,CAAC,EAAE,CAAC,CAAC;4BACf,CAAC,0CAGM,IACH,IACI,GACT,CACR,CAAC;AACJ,CAAC;AA4BD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,eAAe,CAAC,QAA8B,EAAE;IAC9D,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IACxB,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,CAAC;IAChC,MAAM,EAAE,aAAa,EAAE,GAAG,cAAc,EAAE,CAAC;IAC3C,MAAM,QAAQ,GAAG,aAAa,CAAC,oBAAoB,CAAC,CAAC;IACrD,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,cAAc,EAAE,CAAC;IACzE,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;IAEhE,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,UAAU,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IACzE,MAAM,WAAW,GAAG,SAAS;QAC3B,CAAC,CAAC,iBAAiB,SAAS,CAAC,IAAI,4DAA4D;QAC7F,CAAC,CAAC,mGAAmG,CAAC;IAExG,OAAO,CACL,KAAC,SAAS,IAAC,QAAQ,EAAC,IAAI,YACtB,KAAC,GAAG,IAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,YAC/B,MAAC,cAAc,IACb,KAAK,EAAE,KAAK,EACZ,WAAW,EAAE,EAAE,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,EACxG,MAAM,EACJ,8BACE,KAAC,UAAU,IAAC,OAAO,EAAC,IAAI,EAAC,SAAS,EAAC,IAAI,EAAC,YAAY,kBACjD,kBAAkB,GACR,EACb,KAAC,UAAU,IAAC,KAAK,EAAC,gBAAgB,EAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,YAC7C,WAAW,GACD,IACZ,aAIN,CAAC,QAAQ,IAAI,CACZ,KAAC,KAAK,IAAC,QAAQ,EAAC,MAAM,EAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,wFAE5B,CACT,EACA,CAAC,KAAK,IAAI,SAAS,CAAC,IAAI,CACvB,KAAC,KAAK,IAAC,QAAQ,EAAC,OAAO,EAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,YAClC,SAAS,IAAI,KAAK,GACb,CACT,EAEA,SAAS,CAAC,CAAC,CAAC,CACX,KAAC,GAAG,IAAC,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,EAAE,YAC3D,KAAC,gBAAgB,kBAAY,+BAA+B,GAAG,GAC3D,CACP,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAC5B,KAAC,UAAU,IAAC,KAAK,EAAC,gBAAgB,+EAA4E,CAC/G,CAAC,CAAC,CAAC,CACF,KAAC,KAAK,IAAC,OAAO,EAAE,CAAC,YACd,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAC7B,KAAC,aAAa,IAEZ,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,EACtC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,SAAS,CAAC,GAAG,CAAsB,EAClE,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gCACrB,YAAY,CAAC,IAAI,CAAC,CAAC;gCACnB,IAAI,CAAC;oCACH,MAAM,KAAK,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;gCACzC,CAAC;gCAAC,OAAO,GAAG,EAAE,CAAC;oCACb,YAAY,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,0CAA0C,CAAC,CAAC;gCAChG,CAAC;4BACH,CAAC,IAbI,SAAS,CAAC,GAAG,CAclB,CACH,CAAC,GACI,CACT,IACgB,GACb,GACI,CACb,CAAC;AACJ,CAAC"}

package/dist/settings/ui/PluggableConfigForm.d.ts

@@ -0,0 +1,96 @@
+import type { TextFieldProps } from '@mui/material';
+import type { ConfigField, PluggableDescriptor } from '@marinoscar/platform-contract/settings';
+import type { ReactElement, ReactNode } from 'react';
+import type { SecretFieldSlots } from '../../credentials/index.js';
+/**
+ * What a field renderer in {@link PluggableConfigFormSlots.renderField} receives.
+ *
+ * @stability experimental
+ */
+export interface PluggableFieldRenderContext {
+    /** The field's descriptor. */
+    field: ConfigField;
+    /** The field's current value (`undefined` for a secret, which is write-only; see `secret`). */
+    value: unknown;
+    /** The typed replacement of a secret field; `''` for any other kind. */
+    secret: string;
+    /** Whether the whole form is disabled. */
+    disabled: boolean;
+    /** Reports a changed setting. */
+    onChange: (next: unknown) => void;
+    /** Reports a changed secret. */
+    onSecretChange: (next: string) => void;
+    /** The control the form would render, to wrap or to return as is. */
+    defaultControl: ReactElement;
+}
+/**
+ * The part overrides of {@link PluggableConfigForm}. Everything is optional;
+ * with none the rendering is the default.
+ *
+ * @stability experimental
+ */
+export interface PluggableConfigFormSlots {
+    /**
+     * Replaces the control of one field. Return `undefined` to keep the default
+     * (so an app overrides one field, say a `string` named `endpoint`, and
+     * leaves the rest alone). The form still owns the layout around it.
+     */
+    renderField?: (context: PluggableFieldRenderContext) => ReactNode | undefined;
+    /** Props spread onto the MUI `TextField` of `string`, `number` and `enum` fields, after the form's own. */
+    textField?: Partial<Omit<TextFieldProps, 'value' | 'onChange' | 'type' | 'select'>>;
+    /** Overrides for each `SecretField`. */
+    secretField?: SecretFieldSlots;
+    /** The note shown for an `other` field; default: "<label>: managed elsewhere." */
+    otherNote?: (field: ConfigField) => ReactNode;
+}
+/**
+ * The props of {@link PluggableConfigForm}.
+ *
+ * @extensionPoint slot
+ * @stability experimental
+ */
+export interface PluggableConfigFormProps {
+    /** The implementation, as the API described it. */
+    descriptor: PluggableDescriptor;
+    /** The current non-secret settings, by field name. */
+    value: Readonly<Record<string, unknown>>;
+    /** Receives one changed setting; `undefined` means the field was cleared. */
+    onChange: (name: string, next: unknown) => void;
+    /** The typed replacement of each secret, by name; `''` keeps the stored one. */
+    secrets: Readonly<Record<string, string>>;
+    /** Receives one typed secret. */
+    onSecretChange: (name: string, next: string) => void;
+    /** Disables every control (a viewer without the write permission). */
+    disabled?: boolean;
+    /** Part overrides. */
+    slots?: PluggableConfigFormSlots;
+}
+/**
+ * The form of one pluggable implementation, generated from its descriptor.
+ *
+ * Controlled and presentational: it renders the fields, the page saves.
+ * Secrets are write-only: a stored one is shown as saved, never as a value,
+ * and an untouched secret is left out of the payload by
+ * `usePluggableConfigForm`.
+ *
+ * @param props - see {@link PluggableConfigFormProps}.
+ * @returns the form fields.
+ *
+ * @example
+ * ```tsx
+ * const form = usePluggableConfigForm(descriptor, stored);
+ * <PluggableConfigForm
+ *   descriptor={descriptor}
+ *   value={form.value}
+ *   onChange={form.setField}
+ *   secrets={form.secrets}
+ *   onSecretChange={form.setSecret}
+ *   disabled={!canWrite}
+ * />
+ * ```
+ *
+ * @extensionPoint component
+ * @stability experimental
+ */
+export declare function PluggableConfigForm(props: PluggableConfigFormProps): ReactElement;
+//# sourceMappingURL=PluggableConfigForm.d.ts.map

package/dist/settings/ui/PluggableConfigForm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PluggableConfigForm.d.ts","sourceRoot":"","sources":["../../../src/settings/ui/PluggableConfigForm.tsx"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAE/F,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAEnE;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,8BAA8B;IAC9B,KAAK,EAAE,WAAW,CAAC;IACnB,+FAA+F;IAC/F,KAAK,EAAE,OAAO,CAAC;IACf,wEAAwE;IACxE,MAAM,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,QAAQ,EAAE,OAAO,CAAC;IAClB,iCAAiC;IACjC,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IAClC,gCAAgC;IAChC,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACvC,qEAAqE;IACrE,cAAc,EAAE,YAAY,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,SAAS,GAAG,SAAS,CAAC;IAC9E,2GAA2G;IAC3G,SAAS,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC;IACpF,wCAAwC;IACxC,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,kFAAkF;IAClF,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,SAAS,CAAC;CAC/C;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,mDAAmD;IACnD,UAAU,EAAE,mBAAmB,CAAC;IAChC,sDAAsD;IACtD,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACzC,6EAA6E;IAC7E,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IAChD,gFAAgF;IAChF,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1C,iCAAiC;IACjC,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACrD,sEAAsE;IACtE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sBAAsB;IACtB,KAAK,CAAC,EAAE,wBAAwB,CAAC;CAClC;AASD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,GAAG,YAAY,CAuBjF"}