@syntrologie/runtime-sdk 1.0.1 → 2.0.0-canary.1

package/dist/widgets/WidgetRegistry.d.ts

@@ -0,0 +1,139 @@
+/**
+ * Widget Registry
+ *
+ * Extensible registry for mountable widget components.
+ * Apps can register custom widgets that can be rendered via mountWidget actions.
+ */
+/**
+ * Cleanup function returned when unmounting a widget.
+ */
+export type WidgetCleanup = () => void;
+/**
+ * Mountable widget component interface.
+ *
+ * Widgets must implement this interface to be registered and mounted
+ * via the Surfaces system or mountWidget actions.
+ */
+export interface MountableWidget {
+    /**
+     * Mount the widget into a container element.
+     *
+     * @param container - The DOM element to mount into
+     * @param config - Configuration/props for the widget
+     * @returns A cleanup function to unmount the widget, or void
+     */
+    mount(container: HTMLElement, config?: Record<string, unknown>): WidgetCleanup | void;
+    /**
+     * Optional: Update the widget with new config.
+     * If not provided, the widget will be unmounted and remounted on updates.
+     *
+     * @param container - The DOM element containing the widget
+     * @param config - New configuration/props
+     */
+    update?(container: HTMLElement, config?: Record<string, unknown>): void;
+}
+/**
+ * Widget registration entry.
+ */
+export interface WidgetRegistration {
+    /** Widget ID (e.g., "gamification:leaderboard") */
+    id: string;
+    /** The widget component */
+    widget: MountableWidget;
+    /** Source app ID or "built-in" */
+    source: "built-in" | string;
+    /** Optional metadata */
+    metadata?: {
+        name?: string;
+        description?: string;
+        icon?: string;
+    };
+}
+/**
+ * Mounted widget handle.
+ */
+export interface MountedWidgetHandle {
+    /** The widget ID */
+    widgetId: string;
+    /** The container element */
+    container: HTMLElement;
+    /** Unmount the widget */
+    unmount: () => void;
+    /** Update the widget config */
+    update: (config?: Record<string, unknown>) => void;
+}
+/**
+ * Extensible registry for widget components.
+ *
+ * Allows apps to register custom widgets that can be rendered via
+ * mountWidget actions or directly through the Surfaces system.
+ */
+export declare class WidgetRegistry {
+    private widgets;
+    private mountedWidgets;
+    private mountIdCounter;
+    constructor();
+    /**
+     * Register a widget.
+     *
+     * @param id - The widget ID (e.g., "gamification:leaderboard")
+     * @param widget - The widget component
+     * @param source - The source app ID (for tracking)
+     * @param metadata - Optional metadata about the widget
+     */
+    register(id: string, widget: MountableWidget, source?: string, metadata?: WidgetRegistration["metadata"]): void;
+    /**
+     * Unregister a widget.
+     *
+     * @param id - The widget ID to unregister
+     * @returns true if the widget was unregistered, false if not found or built-in
+     */
+    unregister(id: string): boolean;
+    /**
+     * Unregister all widgets from a specific source.
+     *
+     * @param source - The source app ID
+     */
+    unregisterBySource(source: string): void;
+    /**
+     * Get a widget by ID.
+     */
+    get(id: string): MountableWidget | undefined;
+    /**
+     * Get the full registration for a widget.
+     */
+    getRegistration(id: string): WidgetRegistration | undefined;
+    /**
+     * Check if a widget exists.
+     */
+    has(id: string): boolean;
+    /**
+     * Mount a widget into a container.
+     *
+     * @param id - The widget ID
+     * @param container - The DOM element to mount into
+     * @param config - Configuration/props for the widget
+     * @returns A handle for managing the mounted widget
+     */
+    mount(id: string, container: HTMLElement, config?: Record<string, unknown>): MountedWidgetHandle;
+    /**
+     * List all registered widget IDs.
+     */
+    list(): string[];
+    /**
+     * List all registrations.
+     */
+    listRegistrations(): WidgetRegistration[];
+    /**
+     * Get all widgets from a specific source.
+     */
+    getBySource(source: string): WidgetRegistration[];
+    /**
+     * Clean up all mounted widgets.
+     */
+    destroy(): void;
+}
+/**
+ * Default singleton instance of WidgetRegistry.
+ */
+export declare const widgetRegistry: WidgetRegistry;

package/dist/widgets/WidgetRegistry.js

@@ -0,0 +1,182 @@
+/**
+ * Widget Registry
+ *
+ * Extensible registry for mountable widget components.
+ * Apps can register custom widgets that can be rendered via mountWidget actions.
+ */
+/**
+ * Extensible registry for widget components.
+ *
+ * Allows apps to register custom widgets that can be rendered via
+ * mountWidget actions or directly through the Surfaces system.
+ */
+export class WidgetRegistry {
+    constructor() {
+        this.widgets = new Map();
+        this.mountedWidgets = new Map();
+        this.mountIdCounter = 0;
+        // Built-in widgets can be registered here if needed
+    }
+    /**
+     * Register a widget.
+     *
+     * @param id - The widget ID (e.g., "gamification:leaderboard")
+     * @param widget - The widget component
+     * @param source - The source app ID (for tracking)
+     * @param metadata - Optional metadata about the widget
+     */
+    register(id, widget, source = "custom", metadata) {
+        if (this.widgets.has(id)) {
+            const existing = this.widgets.get(id);
+            if (existing.source === "built-in") {
+                throw new Error(`Cannot override built-in widget: ${id}`);
+            }
+            console.warn(`[WidgetRegistry] Overriding widget: ${id}`);
+        }
+        this.widgets.set(id, {
+            id,
+            widget,
+            source,
+            metadata,
+        });
+    }
+    /**
+     * Unregister a widget.
+     *
+     * @param id - The widget ID to unregister
+     * @returns true if the widget was unregistered, false if not found or built-in
+     */
+    unregister(id) {
+        const existing = this.widgets.get(id);
+        if (!existing) {
+            return false;
+        }
+        if (existing.source === "built-in") {
+            console.warn(`[WidgetRegistry] Cannot unregister built-in widget: ${id}`);
+            return false;
+        }
+        this.widgets.delete(id);
+        return true;
+    }
+    /**
+     * Unregister all widgets from a specific source.
+     *
+     * @param source - The source app ID
+     */
+    unregisterBySource(source) {
+        for (const [id, registration] of this.widgets.entries()) {
+            if (registration.source === source) {
+                this.widgets.delete(id);
+            }
+        }
+    }
+    /**
+     * Get a widget by ID.
+     */
+    get(id) {
+        var _a;
+        return (_a = this.widgets.get(id)) === null || _a === void 0 ? void 0 : _a.widget;
+    }
+    /**
+     * Get the full registration for a widget.
+     */
+    getRegistration(id) {
+        return this.widgets.get(id);
+    }
+    /**
+     * Check if a widget exists.
+     */
+    has(id) {
+        return this.widgets.has(id);
+    }
+    /**
+     * Mount a widget into a container.
+     *
+     * @param id - The widget ID
+     * @param container - The DOM element to mount into
+     * @param config - Configuration/props for the widget
+     * @returns A handle for managing the mounted widget
+     */
+    mount(id, container, config) {
+        const registration = this.widgets.get(id);
+        if (!registration) {
+            throw new Error(`Widget not found: ${id}`);
+        }
+        const mountId = `widget-mount-${++this.mountIdCounter}`;
+        container.setAttribute("data-widget-mount-id", mountId);
+        container.setAttribute("data-widget-id", id);
+        // Mount the widget
+        const cleanup = registration.widget.mount(container, config);
+        // Track the mounted widget
+        this.mountedWidgets.set(mountId, {
+            cleanup: cleanup !== null && cleanup !== void 0 ? cleanup : undefined,
+            container,
+        });
+        const handle = {
+            widgetId: id,
+            container,
+            unmount: () => {
+                var _a;
+                const mounted = this.mountedWidgets.get(mountId);
+                if (mounted) {
+                    (_a = mounted.cleanup) === null || _a === void 0 ? void 0 : _a.call(mounted);
+                    this.mountedWidgets.delete(mountId);
+                    container.removeAttribute("data-widget-mount-id");
+                    container.removeAttribute("data-widget-id");
+                    container.innerHTML = "";
+                }
+            },
+            update: (newConfig) => {
+                var _a;
+                if (registration.widget.update) {
+                    registration.widget.update(container, newConfig);
+                }
+                else {
+                    // Unmount and remount with new config
+                    const mounted = this.mountedWidgets.get(mountId);
+                    if (mounted) {
+                        (_a = mounted.cleanup) === null || _a === void 0 ? void 0 : _a.call(mounted);
+                        container.innerHTML = "";
+                        const newCleanup = registration.widget.mount(container, newConfig);
+                        mounted.cleanup = newCleanup !== null && newCleanup !== void 0 ? newCleanup : undefined;
+                    }
+                }
+            },
+        };
+        return handle;
+    }
+    /**
+     * List all registered widget IDs.
+     */
+    list() {
+        return Array.from(this.widgets.keys());
+    }
+    /**
+     * List all registrations.
+     */
+    listRegistrations() {
+        return Array.from(this.widgets.values());
+    }
+    /**
+     * Get all widgets from a specific source.
+     */
+    getBySource(source) {
+        return Array.from(this.widgets.values()).filter((registration) => registration.source === source);
+    }
+    /**
+     * Clean up all mounted widgets.
+     */
+    destroy() {
+        var _a;
+        for (const [mountId, mounted] of this.mountedWidgets.entries()) {
+            (_a = mounted.cleanup) === null || _a === void 0 ? void 0 : _a.call(mounted);
+            mounted.container.innerHTML = "";
+        }
+        this.mountedWidgets.clear();
+    }
+}
+/**
+ * Default singleton instance of WidgetRegistry.
+ */
+export const widgetRegistry = new WidgetRegistry();
+//# sourceMappingURL=WidgetRegistry.js.map

package/dist/widgets/WidgetRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WidgetRegistry.js","sourceRoot":"","sources":["../../src/widgets/WidgetRegistry.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAiEH;;;;;GAKG;AACH,MAAM,OAAO,cAAc;IAKzB;QAJQ,YAAO,GAAG,IAAI,GAAG,EAA8B,CAAC;QAChD,mBAAc,GAAG,IAAI,GAAG,EAA+D,CAAC;QACxF,mBAAc,GAAG,CAAC,CAAC;QAGzB,oDAAoD;IACtD,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CACN,EAAU,EACV,MAAuB,EACvB,SAAiB,QAAQ,EACzB,QAAyC;QAEzC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAE,CAAC;YACvC,IAAI,QAAQ,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;gBACnC,MAAM,IAAI,KAAK,CAAC,oCAAoC,EAAE,EAAE,CAAC,CAAC;YAC5D,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE,EAAE,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE;YACnB,EAAE;YACF,MAAM;YACN,MAAM;YACN,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,EAAU;QACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACtC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YACnC,OAAO,CAAC,IAAI,CAAC,uDAAuD,EAAE,EAAE,CAAC,CAAC;YAC1E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAAc;QAC/B,KAAK,MAAM,CAAC,EAAE,EAAE,YAAY,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YACxD,IAAI,YAAY,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBACnC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,EAAU;;QACZ,OAAO,MAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,0CAAE,MAAM,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,EAAU;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,EAAU;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CACH,EAAU,EACV,SAAsB,EACtB,MAAgC;QAEhC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;QAC7C,CAAC;QAED,MAAM,OAAO,GAAG,gBAAgB,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC;QACxD,SAAS,CAAC,YAAY,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;QACxD,SAAS,CAAC,YAAY,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;QAE7C,mBAAmB;QACnB,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAE7D,2BAA2B;QAC3B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE;YAC/B,OAAO,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,SAAS;YAC7B,SAAS;SACV,CAAC,CAAC;QAEH,MAAM,MAAM,GAAwB;YAClC,QAAQ,EAAE,EAAE;YACZ,SAAS;YAET,OAAO,EAAE,GAAG,EAAE;;gBACZ,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACjD,IAAI,OAAO,EAAE,CAAC;oBACZ,MAAA,OAAO,CAAC,OAAO,uDAAI,CAAC;oBACpB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;oBACpC,SAAS,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC;oBAClD,SAAS,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;oBAC5C,SAAS,CAAC,SAAS,GAAG,EAAE,CAAC;gBAC3B,CAAC;YACH,CAAC;YAED,MAAM,EAAE,CAAC,SAAmC,EAAE,EAAE;;gBAC9C,IAAI,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;oBAC/B,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;gBACnD,CAAC;qBAAM,CAAC;oBACN,sCAAsC;oBACtC,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;oBACjD,IAAI,OAAO,EAAE,CAAC;wBACZ,MAAA,OAAO,CAAC,OAAO,uDAAI,CAAC;wBACpB,SAAS,CAAC,SAAS,GAAG,EAAE,CAAC;wBACzB,MAAM,UAAU,GAAG,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;wBACnE,OAAO,CAAC,OAAO,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,SAAS,CAAC;oBAC5C,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,IAAI;QACF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAc;QACxB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAC7C,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,KAAK,MAAM,CACjD,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,OAAO;;QACL,KAAK,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC;YAC/D,MAAA,OAAO,CAAC,OAAO,uDAAI,CAAC;YACpB,OAAO,CAAC,SAAS,CAAC,SAAS,GAAG,EAAE,CAAC;QACnC,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,cAAc,EAAE,CAAC"}

package/dist/widgets/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Widgets Module
+ *
+ * Extensible widget registry for mountable components.
+ */
+export { WidgetRegistry, widgetRegistry, } from "./WidgetRegistry";
+export type { MountableWidget, WidgetRegistration, MountedWidgetHandle, WidgetCleanup, } from "./WidgetRegistry";

package/dist/widgets/index.js

@@ -0,0 +1,7 @@
+/**
+ * Widgets Module
+ *
+ * Extensible widget registry for mountable components.
+ */
+export { WidgetRegistry, widgetRegistry, } from "./WidgetRegistry";
+//# sourceMappingURL=index.js.map

package/dist/widgets/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/widgets/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,cAAc,EACd,cAAc,GACf,MAAM,kBAAkB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syntrologie/runtime-sdk",
-  "version": "1.0.1",
+  "version": "2.0.0-canary.1",
   "description": "Syntrologie Runtime SDK for web experimentation and analytics",
   "license": "UNLICENSED",
   "private": false,
@@ -23,6 +23,10 @@
       "import": "./dist/index.js",
       "require": "./dist/index.js"
     },
+    "./types": {
+      "types": "./dist/types-only.d.ts",
+      "import": "./dist/types-only.js"
+    },
     "./react": {
       "types": "./dist/react.d.ts",
       "import": "./dist/react.js",
@@ -37,12 +41,12 @@
     "dist",
     "schema",
     "scripts/validate-config.mjs",
-    "README.md",
     "CAPABILITIES.md"
   ],
   "scripts": {
     "clean": "rm -rf dist",
-    "build": "npm run build:lib && npm run build:cdn",
+    "aggregate-capabilities": "node ./scripts/aggregate-capabilities.mjs",
+    "build": "npm run aggregate-capabilities && npm run build:lib && npm run build:cdn",
     "build:lib": "tsc --project tsconfig.build.json",
     "build:cdn": "node ./scripts/build-cdn.js",
     "validate-config": "node ./scripts/validate-config.mjs",
@@ -52,6 +56,12 @@
     "@floating-ui/dom": "~1.6.13",
     "@growthbook/growthbook": "~1.6.2",
     "@growthbook/growthbook-react": "~1.6.2",
+    "@syntrologie/app-content": "*",
+    "@syntrologie/app-faq": "*",
+    "@syntrologie/app-gamification": "*",
+    "@syntrologie/app-nav": "*",
+    "@syntrologie/app-navigation": "*",
+    "@syntrologie/app-overlays": "*",
     "posthog-js": "~1.302.2",
     "react": ">=18.0.0",
     "react-dom": ">=18.0.0",