@openlearning/widget-framework 1.0.0

package/dist/DevApp.d.ts

@@ -0,0 +1,13 @@
+import React from "react";
+import type { WidgetConfigBase, LearnerViewProps, SetupViewProps } from "./types";
+export interface DevAppProps<T extends WidgetConfigBase = WidgetConfigBase> {
+    LearnerViewComponent: React.ComponentType<LearnerViewProps<T>>;
+    SetupViewComponent: React.ComponentType<SetupViewProps<T>>;
+    defaultConfig: T;
+}
+/**
+ * Generic development app for testing LearnerView and SetupView components locally
+ * Use ?mode=setup to test setup view, defaults to learner view
+ */
+export declare function DevApp<T extends WidgetConfigBase = WidgetConfigBase>({ LearnerViewComponent, SetupViewComponent, defaultConfig, }: DevAppProps<T>): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=DevApp.d.ts.map

package/dist/DevApp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevApp.d.ts","sourceRoot":"","sources":["../src/DevApp.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,cAAc,EAAyB,MAAM,SAAS,CAAC;AAEzG,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;IACxE,oBAAoB,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,kBAAkB,EAAE,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3D,aAAa,EAAE,CAAC,CAAC;CAClB;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB,EAAE,EACpE,oBAAoB,EACpB,kBAAkB,EAClB,aAAa,GACd,EAAE,WAAW,CAAC,CAAC,CAAC,2CAiDhB"}

package/dist/DevApp.js

@@ -0,0 +1,29 @@
+import { jsx as _jsx, Fragment as _Fragment } from "react/jsx-runtime";
+/**
+ * Generic development app for testing LearnerView and SetupView components locally
+ * Use ?mode=setup to test setup view, defaults to learner view
+ */
+export function DevApp({ LearnerViewComponent, SetupViewComponent, defaultConfig, }) {
+    const handleConfigSave = (newConfig) => {
+        console.log("[Mock PostMessage Out] SAVE_CONFIG:", newConfig);
+    };
+    const complete = () => {
+        console.log("[Mock PostMessage Out] COMPLETE");
+    };
+    const share = (attachments, thumbnail) => {
+        console.log("[Mock PostMessage Out] SHARE:", { attachments, thumbnail });
+    };
+    const resize = (height) => {
+        console.log("[Mock PostMessage Out] RESIZE:", height);
+    };
+    const saveLearnerData = (name, value) => {
+        console.log("[Mock PostMessage Out] SET_VALUE:", { name, value });
+    };
+    const reinit = () => {
+        console.log("[Mock PostMessage Out] REINIT");
+    };
+    const urlParams = new URLSearchParams(window.location.search);
+    const currentMode = urlParams.get("mode") || "learner";
+    return (_jsx(_Fragment, { children: currentMode === "setup" ? (_jsx(SetupViewComponent, { config: defaultConfig, onChange: handleConfigSave, onResize: resize, onReinit: reinit })) : (_jsx(LearnerViewComponent, { config: defaultConfig, onComplete: complete, onShare: share, onResize: resize, onSave: saveLearnerData, onReinit: reinit })) }));
+}
+//# sourceMappingURL=DevApp.js.map

package/dist/DevApp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevApp.js","sourceRoot":"","sources":["../src/DevApp.tsx"],"names":[],"mappings":";AASA;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAgD,EACpE,oBAAoB,EACpB,kBAAkB,EAClB,aAAa,GACE;IACf,MAAM,gBAAgB,GAAG,CAAC,SAAY,EAAE,EAAE;QACxC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,SAAS,CAAC,CAAC;IAChE,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,GAAG,EAAE;QACpB,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;IACjD,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,CAAC,WAAyB,EAAE,SAAiB,EAAE,EAAE;QAC7D,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;IAC3E,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,CAAC,MAAc,EAAE,EAAE;QAChC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,KAAgB,EAAE,EAAE;QACzD,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACpE,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,GAAG,EAAE;QAClB,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IAC/C,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC9D,MAAM,WAAW,GAAI,SAAS,CAAC,GAAG,CAAC,MAAM,CAAyB,IAAI,SAAS,CAAC;IAEhF,OAAO,CACL,4BACG,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,CACzB,KAAC,kBAAkB,IACjB,MAAM,EAAE,aAAa,EACrB,QAAQ,EAAE,gBAAgB,EAC1B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GAChB,CACH,CAAC,CAAC,CAAC,CACF,KAAC,oBAAoB,IACnB,MAAM,EAAE,aAAa,EACrB,UAAU,EAAE,QAAQ,EACpB,OAAO,EAAE,KAAK,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,eAAe,EACvB,QAAQ,EAAE,MAAM,GAChB,CACH,GACA,CACJ,CAAC;AACJ,CAAC"}

package/dist/createLearnerEntry.d.ts

@@ -0,0 +1,16 @@
+import React from "react";
+import type { WidgetConfigBase, Attachment, JSONValue, LearnerViewProps } from "./types";
+export interface LearnerEntryProps<T extends WidgetConfigBase = WidgetConfigBase> {
+    config: T | null;
+    onComplete: () => void;
+    onShare: (attachments: Attachment[], thumbnail: string) => void;
+    onResize: (height: number) => void;
+    onSave: (name: string, value: JSONValue) => void;
+    onReinit: () => void;
+}
+/**
+ * Factory function to create a learner entry point
+ * Pass your LearnerView component that accepts LearnerViewProps<T>
+ */
+export declare function createLearnerEntry<T extends WidgetConfigBase = WidgetConfigBase>(LearnerViewComponent: React.ComponentType<LearnerViewProps<T>>): void;
+//# sourceMappingURL=createLearnerEntry.d.ts.map

package/dist/createLearnerEntry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createLearnerEntry.d.ts","sourceRoot":"","sources":["../src/createLearnerEntry.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAIzF,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;IAC9E,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC;IACjB,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,OAAO,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;IAChE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IACjD,QAAQ,EAAE,MAAM,IAAI,CAAC;CACtB;AAID;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB,EAC9E,oBAAoB,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,QA+D/D"}

package/dist/createLearnerEntry.js

@@ -0,0 +1,43 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import React from "react";
+import ReactDOM from "react-dom/client";
+import { useParentMessaging } from "./useParentMessaging";
+import { useWidgetConfig } from "./useWidgetConfig";
+const DEFAULT_HEIGHT = 700;
+/**
+ * Factory function to create a learner entry point
+ * Pass your LearnerView component that accepts LearnerViewProps<T>
+ */
+export function createLearnerEntry(LearnerViewComponent) {
+    const InitLearnerView = () => {
+        const { globalConfig, subscribe, sendMessage } = useParentMessaging();
+        const config = useWidgetConfig(globalConfig, subscribe);
+        const complete = React.useCallback(() => {
+            sendMessage("complete");
+        }, [sendMessage]);
+        const share = React.useCallback((attachments, thumbnail) => {
+            sendMessage("share", { attachments, thumbnail });
+        }, [sendMessage]);
+        const resize = React.useCallback((height) => {
+            sendMessage("resize", { height });
+        }, [sendMessage]);
+        const save = React.useCallback((name, value) => {
+            sendMessage("set", { name, value });
+        }, [sendMessage]);
+        const reinit = React.useCallback(() => {
+            sendMessage("ready");
+        }, [sendMessage]);
+        React.useEffect(() => {
+            // Notify parent that widget is ready
+            sendMessage("ready");
+            sendMessage("resize", { height: DEFAULT_HEIGHT });
+        }, [sendMessage]);
+        if (!config) {
+            return _jsx("div", { className: "p-4", children: "Loading..." });
+        }
+        return (_jsx(LearnerViewComponent, { config: config, onComplete: complete, onShare: share, onResize: resize, onSave: save, onReinit: reinit }));
+    };
+    // Render the component
+    ReactDOM.createRoot(document.getElementById("root")).render(_jsx(React.StrictMode, { children: _jsx(InitLearnerView, {}) }));
+}
+//# sourceMappingURL=createLearnerEntry.js.map

package/dist/createLearnerEntry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createLearnerEntry.js","sourceRoot":"","sources":["../src/createLearnerEntry.tsx"],"names":[],"mappings":";AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,QAAQ,MAAM,kBAAkB,CAAC;AAExC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAWpD,MAAM,cAAc,GAAG,GAAG,CAAC;AAE3B;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAChC,oBAA8D;IAE9D,MAAM,eAAe,GAAG,GAAG,EAAE;QAC3B,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,kBAAkB,EAAK,CAAC;QACzE,MAAM,MAAM,GAAG,eAAe,CAAI,YAAY,EAAE,SAAS,CAAC,CAAC;QAE3D,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;YACtC,WAAW,CAAC,UAAU,CAAC,CAAC;QAC1B,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAElB,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,CAC7B,CAAC,WAAyB,EAAE,SAAiB,EAAE,EAAE;YAC/C,WAAW,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;QACnD,CAAC,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QAEF,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAC9B,CAAC,MAAc,EAAE,EAAE;YACjB,WAAW,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QACpC,CAAC,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QAEF,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAC5B,CAAC,IAAY,EAAE,KAAgB,EAAE,EAAE;YACjC,WAAW,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACtC,CAAC,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QAEF,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;YACpC,WAAW,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAElB,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;YACnB,qCAAqC;YACrC,WAAW,CAAC,OAAO,CAAC,CAAC;YACrB,WAAW,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;QACpD,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAElB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,cAAK,SAAS,EAAC,KAAK,2BAAiB,CAAC;QAC/C,CAAC;QAED,OAAO,CACL,KAAC,oBAAoB,IACnB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,QAAQ,EACpB,OAAO,EAAE,KAAK,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,IAAI,EACZ,QAAQ,EAAE,MAAM,GAChB,CACH,CAAC;IACJ,CAAC,CAAC;IAEF,uBAAuB;IACvB,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAE,CAAC,CAAC,MAAM,CAC1D,KAAC,KAAK,CAAC,UAAU,cACf,KAAC,eAAe,KAAG,GACF,CACpB,CAAC;AACJ,CAAC"}

package/dist/createSetupEntry.d.ts

@@ -0,0 +1,14 @@
+import React from "react";
+import type { WidgetConfigBase, SetupViewProps } from "./types";
+export interface SetupEntryProps<T extends WidgetConfigBase = WidgetConfigBase> {
+    config: T | null;
+    onChange: (value: T) => void;
+    onResize: (height: number) => void;
+    onReinit: () => void;
+}
+/**
+ * Factory function to create a setup entry point
+ * Pass your SetupView component that accepts SetupViewProps<T> and default config
+ */
+export declare function createSetupEntry<T extends WidgetConfigBase = WidgetConfigBase>(SetupViewComponent: React.ComponentType<SetupViewProps<T>>, defaultConfig: T): void;
+//# sourceMappingURL=createSetupEntry.d.ts.map

package/dist/createSetupEntry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createSetupEntry.d.ts","sourceRoot":"","sources":["../src/createSetupEntry.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,KAAK,EAAE,gBAAgB,EAAa,cAAc,EAAE,MAAM,SAAS,CAAC;AAI3E,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;IAC5E,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC;IACjB,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IAC7B,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,QAAQ,EAAE,MAAM,IAAI,CAAC;CACtB;AAID;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB,EAC5E,kBAAkB,EAAE,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAC1D,aAAa,EAAE,CAAC,QAoDjB"}

package/dist/createSetupEntry.js

@@ -0,0 +1,36 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import React from "react";
+import ReactDOM from "react-dom/client";
+import { useParentMessaging } from "./useParentMessaging";
+import { useWidgetConfig } from "./useWidgetConfig";
+const DEFAULT_HEIGHT = 700;
+/**
+ * Factory function to create a setup entry point
+ * Pass your SetupView component that accepts SetupViewProps<T> and default config
+ */
+export function createSetupEntry(SetupViewComponent, defaultConfig) {
+    const InitSetupView = () => {
+        const { globalConfig, subscribe, sendMessage } = useParentMessaging();
+        const config = useWidgetConfig(globalConfig || defaultConfig, subscribe);
+        const handleConfigChange = React.useCallback((value) => {
+            sendMessage("set", { name: "config", value });
+        }, [sendMessage]);
+        const resize = React.useCallback((height) => {
+            sendMessage("resize", { height });
+        }, [sendMessage]);
+        const reinit = React.useCallback(() => {
+            sendMessage("ready");
+        }, [sendMessage]);
+        React.useEffect(() => {
+            // Notify parent that widget is ready and resize
+            sendMessage("resize", { height: DEFAULT_HEIGHT });
+        }, [sendMessage]);
+        if (!config) {
+            return _jsx("div", { className: "p-4", children: "Loading..." });
+        }
+        return (_jsx(SetupViewComponent, { config: config, onChange: handleConfigChange, onResize: resize, onReinit: reinit }));
+    };
+    // Render the component
+    ReactDOM.createRoot(document.getElementById("root")).render(_jsx(React.StrictMode, { children: _jsx(InitSetupView, {}) }));
+}
+//# sourceMappingURL=createSetupEntry.js.map

package/dist/createSetupEntry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createSetupEntry.js","sourceRoot":"","sources":["../src/createSetupEntry.tsx"],"names":[],"mappings":";AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,QAAQ,MAAM,kBAAkB,CAAC;AAExC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AASpD,MAAM,cAAc,GAAG,GAAG,CAAC;AAE3B;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAC9B,kBAA0D,EAC1D,aAAgB;IAEhB,MAAM,aAAa,GAAG,GAAG,EAAE;QACzB,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,kBAAkB,EAAK,CAAC;QACzE,MAAM,MAAM,GAAG,eAAe,CAC5B,YAAY,IAAI,aAAa,EAC7B,SAAS,CACV,CAAC;QAEF,MAAM,kBAAkB,GAAG,KAAK,CAAC,WAAW,CAC1C,CAAC,KAAQ,EAAE,EAAE;YACX,WAAW,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAChD,CAAC,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QAEF,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAC9B,CAAC,MAAc,EAAE,EAAE;YACjB,WAAW,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QACpC,CAAC,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QAEF,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;YACpC,WAAW,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAElB,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;YACnB,gDAAgD;YAChD,WAAW,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;QACpD,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAElB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,cAAK,SAAS,EAAC,KAAK,2BAAiB,CAAC;QAC/C,CAAC;QAED,OAAO,CACL,KAAC,kBAAkB,IACjB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,kBAAkB,EAC5B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GAChB,CACH,CAAC;IACJ,CAAC,CAAC;IAEF,uBAAuB;IACvB,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAE,CAAC,CAAC,MAAM,CAC1D,KAAC,KAAK,CAAC,UAAU,cACf,KAAC,aAAa,KAAG,GACA,CACpB,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Widget Framework
+ * Shared utilities for building OpenLearning widgets
+ */
+export { createLearnerEntry, type LearnerEntryProps, } from "./createLearnerEntry";
+export { createSetupEntry, type SetupEntryProps, } from "./createSetupEntry";
+export { DevApp, type DevAppProps } from "./DevApp";
+export { defineWidgetProject, type WidgetProjectConfig, } from "./setupProject";
+export { useParentMessaging } from "./useParentMessaging";
+export { useWidgetConfig } from "./useWidgetConfig";
+export type { JSONValue, Attachment, WidgetConfigBase, LearnerViewProps, SetupViewProps, ParentMessage, ParentMessagingCallbacks, } from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,kBAAkB,EAClB,KAAK,iBAAiB,GACvB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,gBAAgB,EAChB,KAAK,eAAe,GACrB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAE,KAAK,WAAW,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EACL,mBAAmB,EACnB,KAAK,mBAAmB,GACzB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,YAAY,EACV,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,wBAAwB,GACzB,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,11 @@
+/**
+ * Widget Framework
+ * Shared utilities for building OpenLearning widgets
+ */
+export { createLearnerEntry, } from "./createLearnerEntry";
+export { createSetupEntry, } from "./createSetupEntry";
+export { DevApp } from "./DevApp";
+export { defineWidgetProject, } from "./setupProject";
+export { useParentMessaging } from "./useParentMessaging";
+export { useWidgetConfig } from "./useWidgetConfig";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,kBAAkB,GAEnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,gBAAgB,GAEjB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAoB,MAAM,UAAU,CAAC;AACpD,OAAO,EACL,mBAAmB,GAEpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/setupProject.d.ts

@@ -0,0 +1,18 @@
+import type React from "react";
+import type { WidgetConfigBase, LearnerViewProps, SetupViewProps } from "./types";
+/**
+ * Configuration object that defines a widget project
+ * Create this once and import it in your entry files
+ */
+export interface WidgetProjectConfig<T extends WidgetConfigBase = WidgetConfigBase> {
+    LearnerView: React.ComponentType<LearnerViewProps<T>>;
+    SetupView: React.ComponentType<SetupViewProps<T>>;
+    defaultConfig: T;
+    devMode?: boolean;
+}
+/**
+ * Creates a validated project configuration
+ * Use in a central config file (e.g., src/widget.config.ts)
+ */
+export declare function defineWidgetProject<T extends WidgetConfigBase = WidgetConfigBase>(config: WidgetProjectConfig<T>): WidgetProjectConfig<T>;
+//# sourceMappingURL=setupProject.d.ts.map

package/dist/setupProject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupProject.d.ts","sourceRoot":"","sources":["../src/setupProject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAElF;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;IAChF,WAAW,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IACtD,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,aAAa,EAAE,CAAC,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB,EAC/E,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAC7B,mBAAmB,CAAC,CAAC,CAAC,CAExB"}

package/dist/setupProject.js

@@ -0,0 +1,8 @@
+/**
+ * Creates a validated project configuration
+ * Use in a central config file (e.g., src/widget.config.ts)
+ */
+export function defineWidgetProject(config) {
+    return config;
+}
+//# sourceMappingURL=setupProject.js.map

package/dist/setupProject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupProject.js","sourceRoot":"","sources":["../src/setupProject.ts"],"names":[],"mappings":"AAcA;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAA8B;IAE9B,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Core widget types - projects extend these with their specific config types
+ */
+export type JSONValue = string | number | boolean | null | {
+    [x: string]: JSONValue;
+} | JSONValue[];
+export interface Attachment {
+    url: string;
+    title: string;
+    contentType: string;
+    height: number;
+}
+/**
+ * Base interface for widget config
+ */
+export type WidgetConfigBase = JSONValue;
+/**
+ * Standard props for Learner View components
+ */
+export interface LearnerViewProps<T extends WidgetConfigBase = WidgetConfigBase> {
+    config: T;
+    onSave?: (name: string, value: JSONValue) => void;
+    onShare?: (attachments: Attachment[], thumbnail: string) => void;
+    onComplete?: () => void;
+    onResize?: (height: number) => void;
+    onReinit?: () => void;
+}
+/**
+ * Standard props for Setup View components
+ */
+export interface SetupViewProps<T extends WidgetConfigBase = WidgetConfigBase> {
+    config: T;
+    onChange?: (config: JSONValue) => void;
+    onResize?: (height: number) => void;
+    onReinit?: () => void;
+}
+/**
+ * Parent message types for widget communication
+ */
+export interface ParentMessage {
+    action: "init" | "ready" | "resize" | "complete" | "share" | "set" | "error";
+    setup?: {
+        config: WidgetConfigBase;
+    };
+    height?: number;
+    name?: string;
+    value?: JSONValue;
+    attachments?: Attachment[];
+    thumbnail?: string;
+}
+/**
+ * Callbacks for parent messaging
+ */
+export interface ParentMessagingCallbacks {
+    onResize?: (height: number) => void;
+    onConfigInit?: (config: WidgetConfigBase) => void;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAC1B,SAAS,EAAE,CAAC;AAEhB,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;IAC7E,MAAM,EAAE,CAAC,CAAC;IACV,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IAClD,OAAO,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;IACjE,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IACxB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;IAC3E,MAAM,EAAE,CAAC,CAAC;IACV,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI,CAAC;IACvC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,EACF,MAAM,GACN,OAAO,GACP,QAAQ,GACR,UAAU,GACV,OAAO,GACP,KAAK,GACL,OAAO,CAAC;IACZ,KAAK,CAAC,EAAE;QAAE,MAAM,EAAE,gBAAgB,CAAA;KAAE,CAAC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;CACnD"}

package/dist/types.js

@@ -0,0 +1,5 @@
+/**
+ * Core widget types - projects extend these with their specific config types
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/useParentMessaging.d.ts

@@ -0,0 +1,11 @@
+import type { WidgetConfigBase } from "./types";
+/**
+ * Hook to handle parent window messaging
+ * Manages config state and subscription pattern for widget communication
+ */
+export declare function useParentMessaging<T extends WidgetConfigBase = WidgetConfigBase>(): {
+    globalConfig: T;
+    subscribe: (callback: (config: T) => void) => () => void;
+    sendMessage: (action: string, payload?: Record<string, unknown>) => void;
+};
+//# sourceMappingURL=useParentMessaging.d.ts.map

package/dist/useParentMessaging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useParentMessaging.d.ts","sourceRoot":"","sources":["../src/useParentMessaging.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAa,gBAAgB,EAAiB,MAAM,SAAS,CAAC;AAE1E;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;;0BA6C/B,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI;0BAWnB,MAAM,YAAY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;EASzF"}

package/dist/useParentMessaging.js

@@ -0,0 +1,66 @@
+import React from "react";
+/**
+ * Hook to handle parent window messaging
+ * Manages config state and subscription pattern for widget communication
+ */
+export function useParentMessaging() {
+    const globalConfigRef = React.useRef(null);
+    const subscribersRef = React.useRef(new Set());
+    const [, setTrigger] = React.useState({});
+    React.useEffect(() => {
+        const handleMessage = (event) => {
+            console.log("Received message:", event);
+            if (event.source !== window.parent)
+                return;
+            let eventData = null;
+            if (typeof event.data === "string") {
+                try {
+                    eventData = JSON.parse(event.data);
+                }
+                catch {
+                    return;
+                }
+            }
+            else if (event.data && typeof event.data === "object") {
+                eventData = event.data;
+            }
+            if (!eventData || eventData.action !== "init")
+                return;
+            const { setup } = eventData;
+            if (setup?.config) {
+                globalConfigRef.current = setup.config;
+            }
+            // Notify all subscribers with the new config
+            subscribersRef.current.forEach((callback) => {
+                if (globalConfigRef.current) {
+                    callback(globalConfigRef.current);
+                }
+            });
+            // Trigger re-render to reflect new config
+            setTrigger({});
+        };
+        window.addEventListener("message", handleMessage);
+        return () => {
+            window.removeEventListener("message", handleMessage);
+        };
+    }, []);
+    const subscribe = React.useCallback((callback) => {
+        subscribersRef.current.add(callback);
+        // Call immediately if config already loaded
+        if (globalConfigRef.current) {
+            callback(globalConfigRef.current);
+        }
+        return () => {
+            subscribersRef.current.delete(callback);
+        };
+    }, []);
+    const sendMessage = React.useCallback((action, payload) => {
+        window.parent.postMessage({ action, ...payload }, "*");
+    }, []);
+    return {
+        globalConfig: globalConfigRef.current,
+        subscribe,
+        sendMessage,
+    };
+}
+//# sourceMappingURL=useParentMessaging.js.map

package/dist/useParentMessaging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useParentMessaging.js","sourceRoot":"","sources":["../src/useParentMessaging.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B;;;GAGG;AACH,MAAM,UAAU,kBAAkB;IAChC,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,CAAW,IAAI,CAAC,CAAC;IACrD,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,GAAG,EAAuB,CAAC,CAAC;IACpE,MAAM,CAAC,EAAE,UAAU,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAE1C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,aAAa,GAAG,CAAC,KAA4B,EAAE,EAAE;YACrD,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;YACxC,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM;gBAAE,OAAO;YAE3C,IAAI,SAAS,GAAyB,IAAI,CAAC;YAC3C,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACnC,IAAI,CAAC;oBACH,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAkB,CAAC;gBACtD,CAAC;gBAAC,MAAM,CAAC;oBACP,OAAO;gBACT,CAAC;YACH,CAAC;iBAAM,IAAI,KAAK,CAAC,IAAI,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACxD,SAAS,GAAG,KAAK,CAAC,IAAqB,CAAC;YAC1C,CAAC;YAED,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,MAAM;gBAAE,OAAO;YAEtD,MAAM,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;YAC5B,IAAI,KAAK,EAAE,MAAM,EAAE,CAAC;gBAClB,eAAe,CAAC,OAAO,GAAG,KAAK,CAAC,MAAW,CAAC;YAC9C,CAAC;YAED,6CAA6C;YAC7C,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;gBAC1C,IAAI,eAAe,CAAC,OAAO,EAAE,CAAC;oBAC5B,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;gBACpC,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,0CAA0C;YAC1C,UAAU,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QAClD,OAAO,GAAG,EAAE;YACV,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QACvD,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,QAA6B,EAAE,EAAE;QACpE,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrC,4CAA4C;QAC5C,IAAI,eAAe,CAAC,OAAO,EAAE,CAAC;YAC5B,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,GAAG,EAAE;YACV,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC1C,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,MAAc,EAAE,OAAiC,EAAE,EAAE;QAC1F,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC;IACzD,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO;QACL,YAAY,EAAE,eAAe,CAAC,OAAO;QACrC,SAAS;QACT,WAAW;KACZ,CAAC;AACJ,CAAC"}

package/dist/useWidgetConfig.d.ts

@@ -0,0 +1,7 @@
+import type { WidgetConfigBase } from "./types";
+/**
+ * Hook to use widget config with subscription pattern
+ * Handles config state updates from parent messaging
+ */
+export declare function useWidgetConfig<T extends WidgetConfigBase = WidgetConfigBase>(globalConfig: T | null, subscribe: (callback: (config: T) => void) => () => void): T;
+//# sourceMappingURL=useWidgetConfig.d.ts.map

package/dist/useWidgetConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useWidgetConfig.d.ts","sourceRoot":"","sources":["../src/useWidgetConfig.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD;;;GAGG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB,EAC3E,YAAY,EAAE,CAAC,GAAG,IAAI,EACtB,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,KAAK,MAAM,IAAI,KAiBzD"}

package/dist/useWidgetConfig.js

@@ -0,0 +1,19 @@
+import React from "react";
+/**
+ * Hook to use widget config with subscription pattern
+ * Handles config state updates from parent messaging
+ */
+export function useWidgetConfig(globalConfig, subscribe) {
+    const [config, setConfig] = React.useState(globalConfig);
+    React.useEffect(() => {
+        if (globalConfig) {
+            setConfig(globalConfig);
+        }
+        const unsubscribe = subscribe((newConfig) => {
+            setConfig(newConfig);
+        });
+        return unsubscribe;
+    }, [globalConfig, subscribe]);
+    return config;
+}
+//# sourceMappingURL=useWidgetConfig.js.map

package/dist/useWidgetConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useWidgetConfig.js","sourceRoot":"","sources":["../src/useWidgetConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B;;;GAGG;AACH,MAAM,UAAU,eAAe,CAC7B,YAAsB,EACtB,SAAwD;IAExD,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAW,YAAY,CAAC,CAAC;IAEnE,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,YAAY,EAAE,CAAC;YACjB,SAAS,CAAC,YAAY,CAAC,CAAC;QAC1B,CAAC;QAED,MAAM,WAAW,GAAG,SAAS,CAAC,CAAC,SAAY,EAAE,EAAE;YAC7C,SAAS,CAAC,SAAS,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC,EAAE,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAE9B,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@openlearning/widget-framework",
+  "version": "1.0.0",
+  "description": "Framework for building OpenLearning widgets with parent-window messaging and configuration management",
+  "type": "module",
+  "license": "MIT",
+  "author": "OpenLearning",
+  "homepage": "https://widgets.openlearning.com",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.5",
+    "typescript": "~5.9.3"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
+  }
+}