@aglyn/aglyn 1.0.0-beta.229 → 1.0.0-beta.231

package/src/lib/plugin-manager/feature-plugins.d.ts

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 import type { OrgPermissions } from '../app-utils/org-permissions';
+import type { ReleaseFlagKey } from '../app-utils/release-flags';
 import type { SeoAuditReport } from '../app-utils/seo-audit';
 import type { SeoListingFieldKey } from '../app-utils/seo-listing-fields';
 import type { AglynOrgBilling, OrgFeatureFlags } from '../foundation';
@@ -583,6 +584,16 @@ export declare const CONSOLE_WIDGET_SLOTS: {
     readonly orgDashboard: "orgDashboard";
     /** Host dashboard commerce summary. Props: hostId, org. */
     readonly commerceGlance: "commerceGlance";
+    /**
+     * A site's Analytics page, below its own traffic cards (AGL-3605): a
+     * section of analytics a plugin computes from what the site records — a
+     * funnel, say. Props: hostId, orgId (the workspace, or undefined while it
+     * loads).
+     *
+     * A section rather than a glance, so a widget here owns a whole card: its
+     * own range picker, its own plan answer and its own empty state.
+     */
+    readonly hostAnalytics: "hostAnalytics";
     /** Org Data page body. Props: orgId, org. */
     readonly orgData: "orgData";
     /** Besigner functions (ƒx) panel. Props: hostId. */
@@ -732,6 +743,18 @@ export declare const CONSOLE_WIDGET_SLOTS: {
      * widget.
      */
     readonly hostTheme: "hostTheme";
+    /**
+     * Inside the theme editor's Typography card (AGL-3656): the control that
+     * chooses the site's fonts. Props: {@link ConsoleThemeEditorFontsZoneProps}
+     * — the site, the editor's draft, and `updateDraft`, which changes the
+     * draft as any of the editor's own controls does.
+     *
+     * A widget here edits the draft and never writes: the editor's Save keeps
+     * the change and Discard drops it, with the preview beside it following
+     * every step. With no widget the editor offers its own short list of
+     * fonts, so a workspace without a fonts plugin can still choose one.
+     */
+    readonly themeEditorFonts: "themeEditorFonts";
     /**
      * The staff overview, among its platform-wide cards (AGL-3080). No props:
      * the overview is about the platform, not one org, so a widget here reads
@@ -978,6 +1001,15 @@ export declare const CONSOLE_WIDGET_SLOTS: {
      * person decides.
      */
     readonly sitePackageItemPreview: "sitePackageItemPreview";
+    /**
+     * The media library, beside its Upload media and New folder actions and
+     * again in its empty state (AGL-3602): another way to add a file. Props:
+     * {@link ConsoleMediaLibraryZoneProps}. The `hostScreens` contract — a
+     * widget runs its own flow and writes nothing through the library — with
+     * one door back: `onCreated`, which the widget calls with the assets it
+     * added so the library shows them, selected.
+     */
+    readonly mediaLibrary: "mediaLibrary";
 };
 export type ConsoleWidgetSlot = (typeof CONSOLE_WIDGET_SLOTS)[keyof typeof CONSOLE_WIDGET_SLOTS];
 /** What the `besignerPageProperties` zone hands each widget (AGL-3475). */
@@ -1018,6 +1050,23 @@ export type ConsoleHostTemplatesZoneProps = ConsoleHostScreensZoneProps;
 export type ConsoleHostLayoutsZoneProps = ConsoleHostScreensZoneProps;
 /** See {@link ConsoleHostTemplatesZoneProps}. */
 export type ConsoleHostComponentsZoneProps = ConsoleHostScreensZoneProps;
+/** What the `mediaLibrary` zone hands each widget (AGL-3602). */
+export interface ConsoleMediaLibraryZoneProps {
+    /**
+     * The site whose library is open; for the organization's library, the site
+     * on screen when there is one (a site's Media tab, a picker opened for a
+     * site), else `null`.
+     */
+    hostId: string | null;
+    /** The org the library belongs to; `undefined` while it resolves. */
+    orgId: string | undefined;
+    /** Which library is open: a site's own, or the organization's. */
+    library: 'host' | 'org';
+    /** The folder open in the library, where new files land; `null` for none. */
+    folderId: string | null;
+    /** Hands the library the assets a widget added, to show and select them. */
+    onCreated: (mediaIds: readonly string[]) => void;
+}
 /** What the `orgSites` zone hands each widget (AGL-2911). */
 export interface ConsoleOrgSitesZoneProps {
     /** Always `null`: the zone belongs to the organization, not to one site. */
@@ -1294,6 +1343,18 @@ export interface ConsoleHostThemeZoneProps {
      */
     proposeDraft: (theme: HostTheme, key: string) => void;
 }
+/** What the `themeEditorFonts` zone hands each widget (AGL-3656). */
+export interface ConsoleThemeEditorFontsZoneProps {
+    /** The site whose theme is being edited; `null` on an editor that names none. */
+    hostId: string | null;
+    /** The editor's draft: the saved theme with every unsaved edit on it. */
+    draft: HostTheme;
+    /**
+     * Changes the draft. The updater gets the draft as it is when the change
+     * applies, so two edits in one tick both land.
+     */
+    updateDraft: (updater: (draft: HostTheme) => HostTheme) => void;
+}
 /**
  * The zones on the STAFF pages (AGL-2939): the staff overview, the staff org
  * page, its detail zone, and the staff user page.
@@ -1516,8 +1577,56 @@ export interface ConsoleWidget {
      * part of it. Absent without an upsell, for the reason `permission` gives.
      */
     featureFlag?: keyof OrgFeatureFlags;
+    /**
+     * Mount this widget as its own upsell when the ONLY thing missing is the
+     * plan entitlement (AGL-3601).
+     *
+     * Without it a widget whose `featureFlag` the plan lacks is absent, as
+     * above. With it, the shell still mounts it — with `entitled={false}` and
+     * an `upgrade` prop ({@link ConsoleWidgetUpgrade}) — but only when every
+     * other gate passes (the reader's permission, the plugin being on for this
+     * workspace and this site) and the missing flag is one an add-on this
+     * workspace can buy switches on. Where nothing can be bought the widget
+     * stays absent, so the widget never has to decide that itself.
+     *
+     * The widget owns what it draws in that state, and must not open the
+     * feature: the shell has decided the plan does not include it.
+     */
+    showWhenNotEntitled?: boolean;
+    /**
+     * The release flag this widget is behind, which the shell resolves from the
+     * flags it already loads for every page (AGL-3601) — staff bypass applied,
+     * as the server's own doors apply it. The widget is absent while the flag
+     * is off for this workspace, and while the flags have not settled, so a
+     * control is never drawn and then taken away.
+     *
+     * For a widget that would otherwise have to ask a server door whether its
+     * feature exists before it draws anything.
+     */
+    releaseFlag?: ReleaseFlagKey;
     Component: ComponentType<any>;
 }
+/**
+ * Where a widget mounted by {@link ConsoleWidget.showWhenNotEntitled} sends a
+ * reader to buy what it lacks. The shell builds it, so no extension supplies a
+ * URL the console's own chrome then renders.
+ */
+export interface ConsoleWidgetUpgrade {
+    /** The workspace's Billing page, at the section that sells add-ons. */
+    billingHref: string;
+    /** Whether the reader may buy it (`billing.manage`). */
+    canManageBilling: boolean;
+}
+/**
+ * The props the shell adds to a widget that declared
+ * {@link ConsoleWidget.showWhenNotEntitled}, beside its zone's own.
+ * `entitled` is `true` when the plan includes the feature, and `upgrade`
+ * is present only when it is `false`.
+ */
+export interface ConsoleWidgetEntitlementProps {
+    entitled?: boolean;
+    upgrade?: ConsoleWidgetUpgrade;
+}
 /**
  * Console half of the pattern: everything a feature contributes to the
  * console shell. Declarative — the shell owns rendering and applies the
@@ -1678,6 +1787,46 @@ export interface ConsoleStaffPage {
     ownsSubtree?: boolean;
     Component: ComponentType<ConsoleStaffPageProps>;
 }
+/** What the console's generic public route hands a public page. */
+export interface ConsolePublicPageProps {
+    /** The plugin that registered the page, the URL's first segment after `/kiosk`. */
+    pluginId: PluginId;
+    /** The page's own path, as it registered it (`/display`). */
+    path: string;
+}
+/**
+ * A full-screen console page that needs NO staff session (AGL-3608): served
+ * at `/kiosk/{pluginId}{path}` by the console's generic public route, outside
+ * the workspace shell, with only the console theme around it.
+ *
+ * The case is a device a business sets down in front of the public — a
+ * screen facing a customer, a sign-in tablet at a front desk — which is
+ * nobody's console session and must never become one. The shell draws no
+ * nav, no workspace, no org switcher and no plugin providers here, and the
+ * route loads this one plugin's console bundle and nothing else.
+ *
+ * Neither the extension's `featureFlag` nor its `permission` applies: there is
+ * no member to ask. The page proves itself to its own API routes — a pairing
+ * code exchanged for a device token, say — and every read it makes must be
+ * refused server-side without that proof. Treat everything the page renders
+ * as visible to whoever is standing in front of the device.
+ *
+ * The plugin also declares each path in its manifest as
+ * `contributes.console.publicRoutes`, which is what lets the route load the
+ * bundle only for a path that exists. First-party plugins only: the route
+ * reads the console's generated manifest, never a marketplace install.
+ */
+export interface ConsolePublicPage {
+    /**
+     * The path beneath `/kiosk/{pluginId}`, with its leading slash
+     * (`/display`). Matched exactly. It is in URLs saved on devices — treat it
+     * as persisted.
+     */
+    path: string;
+    /** The browser tab's title, which is also what a home-screen shortcut shows. */
+    title: string;
+    Component: ComponentType<ConsolePublicPageProps>;
+}
 export interface ConsoleExtension {
     pluginId: PluginId;
     displayName: string;
@@ -1763,6 +1912,12 @@ export interface ConsoleExtension {
      * Neither `featureFlag` nor `permission` applies to them.
      */
     staffPages?: readonly ConsoleStaffPage[];
+    /**
+     * Full-screen pages that need no staff session (AGL-3608) — see
+     * {@link ConsolePublicPage}. Neither `featureFlag` nor `permission` applies
+     * to them.
+     */
+    publicPages?: readonly ConsolePublicPage[];
     /**
      * App-level providers the shell mounts around every console page
      * (AGL-419) — e.g. the marketplace plugin's AI-assist provider.
@@ -1888,6 +2043,24 @@ export declare function listConsoleStaffPages(enabledPluginIds?: readonly Plugin
  * symptom — the same rule {@link resolveConsolePluginPage} applies to paths.
  */
 export declare function resolveConsoleStaffPage(id: string, enabledPluginIds?: readonly PluginId[]): ConsoleStaffPageEntry | undefined;
+/** A public page flattened with its owning extension's id. */
+export interface ConsolePublicPageEntry extends ConsolePublicPage {
+    pluginId: PluginId;
+}
+/** `pos-display`, `/pos-display/` and `/pos-display` all name `/pos-display`. */
+export declare function normalizeConsolePublicPath(path: string): string;
+/** Every registered public page, in registration order. */
+export declare function listConsolePublicPages(enabledPluginIds?: readonly PluginId[]): ConsolePublicPageEntry[];
+/**
+ * The public page at `/kiosk/{pluginId}{path}` (AGL-3608), or `undefined`.
+ *
+ * Scoped to the ONE plugin the URL names, because the registry is a
+ * session-wide union (AGL-758): a device that once loaded another plugin
+ * must not have that plugin answer a path in this one's namespace. Two
+ * extensions of the same plugin claiming one path resolve to nothing and
+ * say so, the rule {@link resolveConsoleStaffPage} applies to ids.
+ */
+export declare function resolveConsolePublicPage(pluginId: PluginId, path: string): ConsolePublicPageEntry | undefined;
 /** Widgets registered for a slot, across every extension (AGL-419). */
 export declare function listConsoleWidgets(slot: string, enabledPluginIds?: readonly PluginId[]): Array<{
     extension: ConsoleExtension;

package/src/lib/plugin-manager/feature-plugins.js

@@ -117,6 +117,15 @@ import { _ as _extends } from "@swc/helpers/_/_extends";
    * row, no heading) when no widget survives the gates.
    */ orgDashboard: 'orgDashboard',
     /** Host dashboard commerce summary. Props: hostId, org. */ commerceGlance: 'commerceGlance',
+    /**
+   * A site's Analytics page, below its own traffic cards (AGL-3605): a
+   * section of analytics a plugin computes from what the site records — a
+   * funnel, say. Props: hostId, orgId (the workspace, or undefined while it
+   * loads).
+   *
+   * A section rather than a glance, so a widget here owns a whole card: its
+   * own range picker, its own plan answer and its own empty state.
+   */ hostAnalytics: 'hostAnalytics',
     /** Org Data page body. Props: orgId, org. */ orgData: 'orgData',
     /** Besigner functions (ƒx) panel. Props: hostId. */ besignerFunctions: 'besignerFunctions',
     /**
@@ -270,6 +279,17 @@ import { _ as _extends } from "@swc/helpers/_/_extends";
    * widget.
    */ hostTheme: 'hostTheme',
     /**
+   * Inside the theme editor's Typography card (AGL-3656): the control that
+   * chooses the site's fonts. Props: {@link ConsoleThemeEditorFontsZoneProps}
+   * — the site, the editor's draft, and `updateDraft`, which changes the
+   * draft as any of the editor's own controls does.
+   *
+   * A widget here edits the draft and never writes: the editor's Save keeps
+   * the change and Discard drops it, with the preview beside it following
+   * every step. With no widget the editor offers its own short list of
+   * fonts, so a workspace without a fonts plugin can still choose one.
+   */ themeEditorFonts: 'themeEditorFonts',
+    /**
    * The staff overview, among its platform-wide cards (AGL-3080). No props:
    * the overview is about the platform, not one org, so a widget here reads
    * what its plugin holds across every workspace through its own staff
@@ -483,7 +503,15 @@ import { _ as _extends } from "@swc/helpers/_/_extends";
    * or its value list. The widget reads nothing it is not handed beyond what
    * its preview always reads, and never writes: the import writes, after the
    * person decides.
-   */ sitePackageItemPreview: 'sitePackageItemPreview'
+   */ sitePackageItemPreview: 'sitePackageItemPreview',
+    /**
+   * The media library, beside its Upload media and New folder actions and
+   * again in its empty state (AGL-3602): another way to add a file. Props:
+   * {@link ConsoleMediaLibraryZoneProps}. The `hostScreens` contract — a
+   * widget runs its own flow and writes nothing through the library — with
+   * one door back: `onCreated`, which the widget calls with the assets it
+   * added so the library shows them, selected.
+   */ mediaLibrary: 'mediaLibrary'
 };
 /**
  * The zones on the STAFF pages (AGL-2939): the staff overview, the staff org
@@ -746,6 +774,39 @@ function matchNavItemHref(navItem, itemHref, href) {
     }
     return matches[0];
 }
+/** `pos-display`, `/pos-display/` and `/pos-display` all name `/pos-display`. */ export function normalizeConsolePublicPath(path) {
+    return `/${String(path != null ? path : '').split('/').filter(Boolean).join('/')}`;
+}
+/** Every registered public page, in registration order. */ export function listConsolePublicPages(enabledPluginIds) {
+    return listConsoleExtensions(enabledPluginIds).flatMap((extension)=>{
+        var _extension_publicPages;
+        return ((_extension_publicPages = extension.publicPages) != null ? _extension_publicPages : []).map((page)=>_extends({}, page, {
+                path: normalizeConsolePublicPath(page.path),
+                pluginId: extension.pluginId
+            }));
+    });
+}
+/**
+ * The public page at `/kiosk/{pluginId}{path}` (AGL-3608), or `undefined`.
+ *
+ * Scoped to the ONE plugin the URL names, because the registry is a
+ * session-wide union (AGL-758): a device that once loaded another plugin
+ * must not have that plugin answer a path in this one's namespace. Two
+ * extensions of the same plugin claiming one path resolve to nothing and
+ * say so, the rule {@link resolveConsoleStaffPage} applies to ids.
+ */ export function resolveConsolePublicPage(pluginId, path) {
+    if (!pluginId) return undefined;
+    const wanted = normalizeConsolePublicPath(path);
+    if (wanted === '/') return undefined;
+    const matches = listConsolePublicPages([
+        pluginId
+    ]).filter((page)=>page.path === wanted);
+    if (matches.length > 1) {
+        console.error(`[aglyn] public page "/kiosk/${pluginId}${wanted}" is registered more ` + 'than once; refusing to guess which one to serve.');
+        return undefined;
+    }
+    return matches[0];
+}
 /** Widgets registered for a slot, across every extension (AGL-419). */ export function listConsoleWidgets(slot, enabledPluginIds) {
     const out = [];
     for (const extension of listConsoleExtensions(enabledPluginIds)){