From fdbfe26a81bb40ddfe106f6917b6cb31c86ad593 Mon Sep 17 00:00:00 2001 From: Herve Tribouilloy Date: Fri, 23 Oct 2026 14:45:18 +0100 Subject: [PATCH 1/5] Add subscription runtime shadow widget --- widgets/subscription/api/index.ts | 1 + .../api/runtime-shadow-widget.tsx | 37 ++++++ widgets/subscription/capability.json | 26 +++++ widgets/subscription/index.html | 31 +++++ widgets/subscription/package.json | 39 +++++++ widgets/subscription/public/default.json | 11 ++ widgets/subscription/src/Config.ts | 106 ++++++++++++++++++ widgets/subscription/src/ConfigSchema.ts | 30 +++++ .../subscription/src/ConfigSchemaRuntime.ts | 22 ++++ widgets/subscription/src/Widget.tsx | 21 ++++ widgets/subscription/src/WidgetView.tsx | 20 ++++ .../src/activity/Context/ActivityContext.tsx | 4 + .../Context/ActivityContextProvider.tsx | 31 +++++ .../activity/Context/useActivityContext.ts | 11 ++ .../src/bootstrap/WidgetWrapper.tsx | 35 ++++++ .../src/bootstrap/widget-root.tsx | 26 +++++ .../src/components/WidgetSubscription.tsx | 20 ++++ .../src/components/global/Circle.tsx | 37 ++++++ .../src/components/global/SpinnerOverlay.tsx | 8 ++ .../src/components/global/StandardSpinner.tsx | 14 +++ widgets/subscription/src/entrypoints/npm.tsx | 47 ++++++++ widgets/subscription/src/entrypoints/ssr.tsx | 22 ++++ widgets/subscription/src/lib/error.ts | 10 ++ .../src/lib/graphqlResponseNormalizer.ts | 47 ++++++++ widgets/subscription/src/ssr/bootstrap.ts | 16 +++ .../src/state/System/SystemState.tsx | 4 + .../src/state/System/SystemStateProvider.tsx | 41 +++++++ widgets/subscription/src/state/System/type.ts | 5 + .../src/state/System/useSystemState.ts | 11 ++ widgets/subscription/src/styles/entry.ts | 5 + widgets/subscription/src/styles/main.css | 13 +++ .../src/tests/subscription.spec.ts | 34 ++++++ widgets/subscription/src/types/global.d.ts | 9 ++ .../subscription/tests/subscription.spec.ts | 34 ++++++ widgets/subscription/tsconfig.app.json | 7 ++ widgets/subscription/tsconfig.json | 8 ++ widgets/subscription/tsconfig.node.json | 10 ++ widgets/subscription/vite.config.ts | 49 ++++++++ widgets/subscription/vite.npm.config.ts | 31 +++++ 39 files changed, 933 insertions(+) create mode 100644 widgets/subscription/api/index.ts create mode 100644 widgets/subscription/api/runtime-shadow-widget.tsx create mode 100644 widgets/subscription/capability.json create mode 100644 widgets/subscription/index.html create mode 100644 widgets/subscription/package.json create mode 100644 widgets/subscription/public/default.json create mode 100644 widgets/subscription/src/Config.ts create mode 100644 widgets/subscription/src/ConfigSchema.ts create mode 100644 widgets/subscription/src/ConfigSchemaRuntime.ts create mode 100644 widgets/subscription/src/Widget.tsx create mode 100644 widgets/subscription/src/WidgetView.tsx create mode 100644 widgets/subscription/src/activity/Context/ActivityContext.tsx create mode 100644 widgets/subscription/src/activity/Context/ActivityContextProvider.tsx create mode 100644 widgets/subscription/src/activity/Context/useActivityContext.ts create mode 100644 widgets/subscription/src/bootstrap/WidgetWrapper.tsx create mode 100644 widgets/subscription/src/bootstrap/widget-root.tsx create mode 100644 widgets/subscription/src/components/WidgetSubscription.tsx create mode 100644 widgets/subscription/src/components/global/Circle.tsx create mode 100644 widgets/subscription/src/components/global/SpinnerOverlay.tsx create mode 100644 widgets/subscription/src/components/global/StandardSpinner.tsx create mode 100644 widgets/subscription/src/entrypoints/npm.tsx create mode 100644 widgets/subscription/src/entrypoints/ssr.tsx create mode 100644 widgets/subscription/src/lib/error.ts create mode 100644 widgets/subscription/src/lib/graphqlResponseNormalizer.ts create mode 100644 widgets/subscription/src/ssr/bootstrap.ts create mode 100644 widgets/subscription/src/state/System/SystemState.tsx create mode 100644 widgets/subscription/src/state/System/SystemStateProvider.tsx create mode 100644 widgets/subscription/src/state/System/type.ts create mode 100644 widgets/subscription/src/state/System/useSystemState.ts create mode 100644 widgets/subscription/src/styles/entry.ts create mode 100644 widgets/subscription/src/styles/main.css create mode 100644 widgets/subscription/src/tests/subscription.spec.ts create mode 100644 widgets/subscription/src/types/global.d.ts create mode 100644 widgets/subscription/tests/subscription.spec.ts create mode 100644 widgets/subscription/tsconfig.app.json create mode 100644 widgets/subscription/tsconfig.json create mode 100644 widgets/subscription/tsconfig.node.json create mode 100644 widgets/subscription/vite.config.ts create mode 100644 widgets/subscription/vite.npm.config.ts diff --git a/widgets/subscription/api/index.ts b/widgets/subscription/api/index.ts new file mode 100644 index 00000000..76da1c21 --- /dev/null +++ b/widgets/subscription/api/index.ts @@ -0,0 +1 @@ +export { Widget } from "../src/Widget"; diff --git a/widgets/subscription/api/runtime-shadow-widget.tsx b/widgets/subscription/api/runtime-shadow-widget.tsx new file mode 100644 index 00000000..e6c221fa --- /dev/null +++ b/widgets/subscription/api/runtime-shadow-widget.tsx @@ -0,0 +1,37 @@ +import { WIDGET_ID } from "../src/Config.ts"; + +import type { WidgetApi } from "@reactedge/public-api/widget"; +import type {ReactEdgeRuntimeConfig} from "@reactedge/public-api/runtime.ts"; + +import {ShadowHostProvider} from "@reactedge/framework/host.ts"; +import {createRoot} from "react-dom/client"; +import {WidgetRoot} from "../src/bootstrap/widget-root.tsx" +import {styles} from "../src/styles/entry.ts"; + +const mount = ( + el: HTMLElement, + contract: unknown, + bootstrap: unknown, + runtime: ReactEdgeRuntimeConfig +) => { + const hostProvider = new ShadowHostProvider(styles) + + createRoot(hostProvider.getMountedHost(el)).render( + + ) +}; + +const api: WidgetApi = { + mount, +}; + +if (typeof window !== "undefined") { + window[`ReactEdge_${WIDGET_ID}`] = api; +} + +export { mount }; \ No newline at end of file diff --git a/widgets/subscription/capability.json b/widgets/subscription/capability.json new file mode 100644 index 00000000..573e89a2 --- /dev/null +++ b/widgets/subscription/capability.json @@ -0,0 +1,26 @@ +{ + "id": "subscription", + "widget": "subscription", + "description": "Displays a subscription call to action using Magento GraphQL runtime integration.", + "exampleContract": { + "data": { + "title": "Subscribe and save" + }, + "settings": { + "colour": "#b42318" + }, + "integration": { + "requires": ["magentoGraphql"] + } + }, + "signals": { + "consumes": [], + "emits": [] + }, + "runtime": { + "rendering": [ + "client", + "ssr" + ] + } +} diff --git a/widgets/subscription/index.html b/widgets/subscription/index.html new file mode 100644 index 00000000..cd7f5527 --- /dev/null +++ b/widgets/subscription/index.html @@ -0,0 +1,31 @@ + + + + + + + + + + \ No newline at end of file diff --git a/widgets/subscription/package.json b/widgets/subscription/package.json new file mode 100644 index 00000000..f497859c --- /dev/null +++ b/widgets/subscription/package.json @@ -0,0 +1,39 @@ +{ + "name": "widget-subscription", + "private": true, + "version": "0.0.1", + "type": "module", + "scripts": { + "dev": "vite", + "build": "tsc -b && vite build", + "build:ssr": "vite build -c vite.npm.config.ts", + "analyze": "ANALYZE=true vite build", + "lint": "eslint .", + "preview": "vite preview" + }, + "dependencies": { + "zod": "^4.4.3" + }, + "devDependencies": { + "@eslint/js": "^9.39.1", + "@types/node": "^24.10.1", + "@types/react": "^19.2.5", + "@types/react-dom": "^19.2.3", + "@vitejs/plugin-react-swc": "^4.2.2", + "eslint": "^9.39.1", + "eslint-plugin-react-hooks": "^7.0.1", + "eslint-plugin-react-refresh": "^0.4.24", + "globals": "^16.5.0", + "postcss": "^8.5.6", + "postcss-prefix-selector": "^2.1.1", + "rollup-plugin-visualizer": "^7.0.1", + "tsx": "^4.21.0", + "typescript": "~5.9.3", + "typescript-eslint": "^8.46.4", + "vite": "^7.2.4" + }, + "peerDependencies": { + "react": "^19.2.0", + "react-dom": "^19.2.0" + } +} diff --git a/widgets/subscription/public/default.json b/widgets/subscription/public/default.json new file mode 100644 index 00000000..912d91a9 --- /dev/null +++ b/widgets/subscription/public/default.json @@ -0,0 +1,11 @@ +{ + "data": { + "title": "Subscribe and save" + }, + "settings": { + "colour": "red" + }, + "integration": { + "requires": ["magentoGraphql"] + } +} diff --git a/widgets/subscription/src/Config.ts b/widgets/subscription/src/Config.ts new file mode 100644 index 00000000..faa8c650 --- /dev/null +++ b/widgets/subscription/src/Config.ts @@ -0,0 +1,106 @@ +import {parseConfig, type SchemaWidgetConfig} from "./ConfigSchema.ts"; +import type {WidgetActivity} from "@reactedge/framework/activity"; +import {parseRuntimeConfig, type SchemaRuntimeConfig} from "./ConfigSchemaRuntime.ts"; + +export interface WidgetConfig { + readonly data: { + title: string; + } + + readonly settings: { + colour: string; + }; + + readonly runtime: RuntimeConfig + readonly integrations: ResolvedConfigIntegrations +} + +export interface RuntimeConfig { + storeCode: string; + sku: string; +} + +export interface ReactEdgeRuntimeConfig { + readonly integrations: ReactEdgeRuntimeIntegrations; + readonly context: RuntimeConfig +} + +export interface ReactEdgeRuntimeIntegrations { + readonly magentoGraphql: { + readonly api: string + }; +} + +export interface ResolvedConfigIntegrations { + readonly magentoGraphql: { + readonly api: string + }; +} + +export const WIDGET_ID = 'subscription'; + +/** + * Validates and resolves the Subscription widget configuration. + * + * Both the widget contract and the runtime configuration are treated + * as untrusted input. Once validated, the configuration is normalized, + * resolved and frozen before being exposed to the React application. + * + * This function represents the trust boundary between the ReactEdge + * runtime and the widget implementation. + * + * The resolved configuration includes the Magento GraphQL integration + * required by this widget's runtime. + * + * @param contract - Widget contract supplied by the host platform. + * @param runtime - Runtime services supplied by the orchestrator. + * @param activity - Activity logger for bootstrap events. + * @returns An immutable Subscription configuration. + * @throws When either configuration is invalid. + */ +export function readWidgetConfig( + contract: unknown, + runtime: unknown, + activity?: WidgetActivity +): WidgetConfig { + try { + const parsedContract = parseConfig(contract); + const parsedRuntime = parseRuntimeConfig(runtime) + const resolved = resolveConfig(parsedContract, parsedRuntime); + + activity?.log( + 'bootstrap', + 'Config resolved', + resolved + ); + + return Object.freeze(resolved); + + } catch (e) { + activity?.log( + 'bootstrap', + 'Invalid widget contract', + e instanceof Error? e.message: e, + 'error' + ); + + throw e; + } +} + +export function resolveConfig( + widget: SchemaWidgetConfig, + runtime: SchemaRuntimeConfig +): WidgetConfig { + return { + data: widget.data, + settings: widget.settings, + runtime: { + storeCode: runtime.context.storeCode, + sku: runtime.context.sku + }, + integrations: { + magentoGraphql: runtime.integrations?.magentoGraphql + } + }; +} diff --git a/widgets/subscription/src/ConfigSchema.ts b/widgets/subscription/src/ConfigSchema.ts new file mode 100644 index 00000000..f0164fb8 --- /dev/null +++ b/widgets/subscription/src/ConfigSchema.ts @@ -0,0 +1,30 @@ +import { z } from 'zod'; + +const IntegrationSchema = z.enum([ + "magentoGraphql" +]); + +const WidgetDataSchema = z.object({ + title: z.string().min(1), +}).strict(); + +const WidgetSettingsSchema = z.object({ + colour: z.string().min(1), +}).strict(); + +export const WidgetConfigSchema = z.object({ + data: WidgetDataSchema, + settings: WidgetSettingsSchema, + integration: z.object({ + requires: z.array(IntegrationSchema).default(["magentoGraphql"]) + }).strict() +}).strict(); + +export type SchemaWidgetConfig = + z.infer; + +export function parseConfig( + input: unknown +): SchemaWidgetConfig { + return WidgetConfigSchema.parse(input); +} diff --git a/widgets/subscription/src/ConfigSchemaRuntime.ts b/widgets/subscription/src/ConfigSchemaRuntime.ts new file mode 100644 index 00000000..ef7a4493 --- /dev/null +++ b/widgets/subscription/src/ConfigSchemaRuntime.ts @@ -0,0 +1,22 @@ +import { z } from 'zod'; + +export const SchemaRuntimeConfig = z.object({ + integrations: z.object({ + magentoGraphql: z.object({ + api: z.string().url(), + }).strict(), + }).strict(), + context: z.object({ + storeCode: z.string(), + sku: z.string() + }).strict() +}).strict(); + +export type SchemaRuntimeConfig = + z.infer; + +export function parseRuntimeConfig( + input: unknown +): SchemaRuntimeConfig { + return SchemaRuntimeConfig.parse(input); +} diff --git a/widgets/subscription/src/Widget.tsx b/widgets/subscription/src/Widget.tsx new file mode 100644 index 00000000..abd70ca0 --- /dev/null +++ b/widgets/subscription/src/Widget.tsx @@ -0,0 +1,21 @@ +import {WidgetRoot} from "./bootstrap/widget-root.tsx"; +import {createRoot} from "react-dom/client"; +import type {RuntimeWidgetOptions} from "@reactedge/public-api/WidgetOptions.ts"; +import {ShadowHostProvider} from "@reactedge/framework/host.ts"; +import { styles } from "./styles/entry.ts"; + +export function Widget({ + container, + contract, + runtime +}: RuntimeWidgetOptions) { + const hostProvider = new ShadowHostProvider(styles); + const host = hostProvider.getMountedHost(container); + + createRoot(host).render( + + ); +} \ No newline at end of file diff --git a/widgets/subscription/src/WidgetView.tsx b/widgets/subscription/src/WidgetView.tsx new file mode 100644 index 00000000..efee4e44 --- /dev/null +++ b/widgets/subscription/src/WidgetView.tsx @@ -0,0 +1,20 @@ +import {readWidgetConfig} from "./Config.ts"; +import {SystemStateProvider} from "./state/System/SystemStateProvider.tsx"; +import {WidgetSubscription} from "./components/WidgetSubscription.tsx"; + +type Props = { + contract: unknown; + runtime: unknown; +}; + +export const WidgetView = ({ contract, runtime }: Props) => { + + const config = readWidgetConfig(contract, runtime); + + if (!config) return null; + + return + + +}; + diff --git a/widgets/subscription/src/activity/Context/ActivityContext.tsx b/widgets/subscription/src/activity/Context/ActivityContext.tsx new file mode 100644 index 00000000..81be6cc3 --- /dev/null +++ b/widgets/subscription/src/activity/Context/ActivityContext.tsx @@ -0,0 +1,4 @@ +import {createContext} from "react"; +import type {WidgetActivity} from "@reactedge/framework/activity"; + +export const LocalInstanceStateContext = createContext(undefined); \ No newline at end of file diff --git a/widgets/subscription/src/activity/Context/ActivityContextProvider.tsx b/widgets/subscription/src/activity/Context/ActivityContextProvider.tsx new file mode 100644 index 00000000..e1afaf74 --- /dev/null +++ b/widgets/subscription/src/activity/Context/ActivityContextProvider.tsx @@ -0,0 +1,31 @@ +import {type ReactNode} from "react"; +import {WIDGET_ID} from "../../Config.ts"; +import {LocalInstanceStateContext} from "./ActivityContext.tsx"; +import {WidgetActivity} from "@reactedge/framework/activity"; + +interface InstanceStateProviderProps { + children: ReactNode; + hostElement?: HTMLElement; +} + +const LocalStateProvider = LocalInstanceStateContext.Provider; + +export const ActivityContextProvider: React.FC = ({ + children, + hostElement + }) => { + + const host = hostElement ?? document.documentElement; + + const activity = new WidgetActivity(WIDGET_ID, host.dataset.instance) + + return ( + + {children} + + ); +}; diff --git a/widgets/subscription/src/activity/Context/useActivityContext.ts b/widgets/subscription/src/activity/Context/useActivityContext.ts new file mode 100644 index 00000000..7a61a77d --- /dev/null +++ b/widgets/subscription/src/activity/Context/useActivityContext.ts @@ -0,0 +1,11 @@ +import {useContext} from "react"; +import {LocalInstanceStateContext} from "./ActivityContext.tsx"; +import type {WidgetActivity} from "@reactedge/framework/activity"; + +export function useActivityContext(): WidgetActivity { + const context = useContext(LocalInstanceStateContext); + if (!context) { + throw new Error("useInstanceState must be used within InstanceStateProvider"); + } + return context; +} \ No newline at end of file diff --git a/widgets/subscription/src/bootstrap/WidgetWrapper.tsx b/widgets/subscription/src/bootstrap/WidgetWrapper.tsx new file mode 100644 index 00000000..fabe519b --- /dev/null +++ b/widgets/subscription/src/bootstrap/WidgetWrapper.tsx @@ -0,0 +1,35 @@ +import {useActivityContext} from "../activity/Context/useActivityContext.ts"; +import {readWidgetConfig} from "../Config.ts"; +import {useEffect, useState} from "react"; +import {SystemStateProvider} from "../state/System/SystemStateProvider.tsx"; +import {SpinnerOverlay} from "../components/global/SpinnerOverlay.tsx"; +import {WidgetSubscription} from "../components/WidgetSubscription.tsx"; + +type Props = { + contract: unknown, + runtime: unknown; +} + +export default function WidgetWrapper({contract, runtime}: Props) { + const activity = useActivityContext() + const [bootReady, setBootReady] = useState(false); + const config = readWidgetConfig(contract, runtime, activity); + + useEffect(() => { + if (!config) return; + + // delay first meaningful render + requestAnimationFrame(() => { + setBootReady(true); + }); + }, [config]); + + if (!config) return null; + + return + {!bootReady + ? + : + } + +} \ No newline at end of file diff --git a/widgets/subscription/src/bootstrap/widget-root.tsx b/widgets/subscription/src/bootstrap/widget-root.tsx new file mode 100644 index 00000000..4ba810f9 --- /dev/null +++ b/widgets/subscription/src/bootstrap/widget-root.tsx @@ -0,0 +1,26 @@ +import {WIDGET_ID} from "../Config.ts"; +import {ActivityContextProvider} from "../activity/Context/ActivityContextProvider.tsx"; +import WidgetWrapper from "./WidgetWrapper.tsx"; + +interface WidgetRootProps { + contract: unknown; + runtime: unknown; + bootstrap?: unknown; + hostElement?: HTMLElement; +} + +export function WidgetRoot({ + contract, + runtime, + hostElement, +}: WidgetRootProps) { + return ( +
+ + + +
+ ); +} \ No newline at end of file diff --git a/widgets/subscription/src/components/WidgetSubscription.tsx b/widgets/subscription/src/components/WidgetSubscription.tsx new file mode 100644 index 00000000..94c5c9ad --- /dev/null +++ b/widgets/subscription/src/components/WidgetSubscription.tsx @@ -0,0 +1,20 @@ +import type { WidgetConfig } from "../Config"; + +type Props = { + config: WidgetConfig; +}; + +export const WidgetSubscription = ({ config }: Props) => { + return ( +
+

+ {config.data.title} +

+

Choose a subscription option that works for you.

+
+ ); +}; diff --git a/widgets/subscription/src/components/global/Circle.tsx b/widgets/subscription/src/components/global/Circle.tsx new file mode 100644 index 00000000..6f01f52f --- /dev/null +++ b/widgets/subscription/src/components/global/Circle.tsx @@ -0,0 +1,37 @@ + + +type SpinnerProps = { + size?: number; +}; + +export function Circle({ size = 40 }: SpinnerProps) { + + return ( + + ); +} diff --git a/widgets/subscription/src/components/global/SpinnerOverlay.tsx b/widgets/subscription/src/components/global/SpinnerOverlay.tsx new file mode 100644 index 00000000..51b2ee01 --- /dev/null +++ b/widgets/subscription/src/components/global/SpinnerOverlay.tsx @@ -0,0 +1,8 @@ +import {StandardSpinner} from "./StandardSpinner.tsx"; + +export const SpinnerOverlay = () => { + + return ( + + ) +} \ No newline at end of file diff --git a/widgets/subscription/src/components/global/StandardSpinner.tsx b/widgets/subscription/src/components/global/StandardSpinner.tsx new file mode 100644 index 00000000..6c006762 --- /dev/null +++ b/widgets/subscription/src/components/global/StandardSpinner.tsx @@ -0,0 +1,14 @@ +import {Circle} from "./Circle.tsx"; + +type SpinnerProps = { + size?: number; +}; + +export function StandardSpinner({ size = 40 }: SpinnerProps) { + + return ( +
+ +
+ ); +} diff --git a/widgets/subscription/src/entrypoints/npm.tsx b/widgets/subscription/src/entrypoints/npm.tsx new file mode 100644 index 00000000..4be4eb57 --- /dev/null +++ b/widgets/subscription/src/entrypoints/npm.tsx @@ -0,0 +1,47 @@ +import {Widget} from "../Widget.tsx"; +import {ResourceLoader} from "@reactedge/framework/contract.ts"; +import {WidgetActivity} from "@reactedge/framework/activity"; +import {WIDGET_ID} from "../Config.ts"; + +async function main() { + const loader = new ResourceLoader(); + const activity = new WidgetActivity(WIDGET_ID) + const contract = await loader.loadContract("default.json"); + const bootstrap = await loader.loadContract("data.json"); + const runtime = await loader.loadRuntime(); + + const container = document.getElementById("root")!; + + const mode = __REACTEDGE_MODE__; + + if (mode === "hydrate") { + activity.debug("Hydrating existing HTML", { + contract, + bootstrap, + runtime, + html: container.innerHTML + }); + } else { + activity.debug("Rendering from scratch"); + } + + if (mode === "hydrate") { + Widget({ + container, + contract, + bootstrap, + runtime, + hydrate: true + }); + } else { + Widget({ + container, + contract, + bootstrap, + runtime, + hydrate: false + }); + } +} + +main(); \ No newline at end of file diff --git a/widgets/subscription/src/entrypoints/ssr.tsx b/widgets/subscription/src/entrypoints/ssr.tsx new file mode 100644 index 00000000..10f1abe2 --- /dev/null +++ b/widgets/subscription/src/entrypoints/ssr.tsx @@ -0,0 +1,22 @@ +import { renderToString } from 'react-dom/server'; +import {WIDGET_ID} from "../Config.ts"; +import type { ReactEdgeRuntimeConfig } from "../Config.ts"; +import { WidgetView } from "../WidgetView.tsx"; + +export type BootstrapData = Record; + +export const renderHtml = ( + config: unknown, + runtime: ReactEdgeRuntimeConfig, + _bootstrap: BootstrapData +): string => { + return renderToString( +
+ +
+ ); +}; + +export { buildBootstrap } from '../ssr/bootstrap'; + +export { loadRuntime } from '../ssr/bootstrap'; diff --git a/widgets/subscription/src/lib/error.ts b/widgets/subscription/src/lib/error.ts new file mode 100644 index 00000000..9c9954d2 --- /dev/null +++ b/widgets/subscription/src/lib/error.ts @@ -0,0 +1,10 @@ +export function getError(err: unknown): Error { + if (err instanceof Error) { + return err; + } else { + return { + name: "unknonw", + message: err as string + }; + } +} \ No newline at end of file diff --git a/widgets/subscription/src/lib/graphqlResponseNormalizer.ts b/widgets/subscription/src/lib/graphqlResponseNormalizer.ts new file mode 100644 index 00000000..a3852896 --- /dev/null +++ b/widgets/subscription/src/lib/graphqlResponseNormalizer.ts @@ -0,0 +1,47 @@ +import type {WidgetActivity} from "@reactedge/framework/activity"; + +const PATCH_ON_DEFAULT = true; + +export function normalizeGraphqlResponse( + rawText: string, + activity?: WidgetActivity +) { + try { + return JSON.parse(rawText); + } catch (err) { + if (!PATCH_ON_DEFAULT) { + throw err; + } + + // Demo-only fallback: + // Extract the last JSON object from concatenated payload + const idxData = rawText.indexOf('{"data"'); + const idxErrors = rawText.indexOf('{"errors"'); + + const idx = + idxData !== -1 && idxErrors !== -1 ? Math.min(idxData, idxErrors) : + idxData !== -1 ? idxData : + idxErrors !== -1 ? idxErrors : + -1; + + if (idx === -1) { + throw new Error("GraphQL fallback failed: cannot find JSON payload start."); + } + + const candidate = rawText.slice(idx); + + activity?.log('graphql-invalid-json', 'GraphQL normalised raw text', { + candidate: candidate + }); + + try { + const parsed = JSON.parse(candidate); + + activity?.log('graphql-invalid-json',"⚠ DEMO PATCH ACTIVE: GraphQL response was polluted. Fallback parser used.", null, 'warn'); + + return parsed; + } catch { + throw new Error("GraphQL fallback parsing failed."); + } + } +} diff --git a/widgets/subscription/src/ssr/bootstrap.ts b/widgets/subscription/src/ssr/bootstrap.ts new file mode 100644 index 00000000..8b7e0a8e --- /dev/null +++ b/widgets/subscription/src/ssr/bootstrap.ts @@ -0,0 +1,16 @@ +import type { ReactEdgeRuntimeConfig } from "../Config.ts"; +import { WIDGET_ID } from "../Config.ts"; +import fs from 'node:fs/promises'; + +export async function loadRuntime(): Promise { + const path = + `./widgets/${WIDGET_ID}/public/reactedge-runtime.json`; + + return JSON.parse( + await fs.readFile(path, 'utf8') + ); +} + +export async function buildBootstrap(_runtime: ReactEdgeRuntimeConfig) { + return {}; +} diff --git a/widgets/subscription/src/state/System/SystemState.tsx b/widgets/subscription/src/state/System/SystemState.tsx new file mode 100644 index 00000000..00462f2c --- /dev/null +++ b/widgets/subscription/src/state/System/SystemState.tsx @@ -0,0 +1,4 @@ +import {createContext} from "react"; +import type {SystemState} from "./type.ts"; + +export const LocalSystemStateContext = createContext(undefined); \ No newline at end of file diff --git a/widgets/subscription/src/state/System/SystemStateProvider.tsx b/widgets/subscription/src/state/System/SystemStateProvider.tsx new file mode 100644 index 00000000..798e8a1f --- /dev/null +++ b/widgets/subscription/src/state/System/SystemStateProvider.tsx @@ -0,0 +1,41 @@ +import React from "react"; +import {type ReactNode, useMemo} from "react"; +import {LocalSystemStateContext} from "./SystemState.tsx"; +import type {WidgetActivity} from "@reactedge/framework/activity"; +import type {ResolvedConfigIntegrations, RuntimeConfig} from "../../Config.ts"; +import {createGraphqlService} from "@reactedge/framework/graphql/graphql.service.ts"; + +interface SystemStateProviderProps { + children: ReactNode; + config: ResolvedConfigIntegrations; + runtime: RuntimeConfig; + activity?: WidgetActivity +} + +const LocalStateProvider = LocalSystemStateContext.Provider; + +export const SystemStateProvider: React.FC = ({ + children, + config, + runtime, + activity +}) => { + if (!config?.magentoGraphql?.api) { + throw new Error('GraphQL client cannot be created without API endpoint'); + } + + const graphqlClient = useMemo( + () => createGraphqlService(config.magentoGraphql.api, runtime.storeCode, activity), + [config.magentoGraphql?.api, runtime.storeCode, activity] + ); + + return ( + + {children} + + ); +}; \ No newline at end of file diff --git a/widgets/subscription/src/state/System/type.ts b/widgets/subscription/src/state/System/type.ts new file mode 100644 index 00000000..9e6dc875 --- /dev/null +++ b/widgets/subscription/src/state/System/type.ts @@ -0,0 +1,5 @@ +import type {GraphqlClient} from "@reactedge/framework/graphql/graphqlClient.ts"; + +export interface SystemState { + graphqlClient: GraphqlClient; +} \ No newline at end of file diff --git a/widgets/subscription/src/state/System/useSystemState.ts b/widgets/subscription/src/state/System/useSystemState.ts new file mode 100644 index 00000000..cb883c49 --- /dev/null +++ b/widgets/subscription/src/state/System/useSystemState.ts @@ -0,0 +1,11 @@ +import {useContext} from "react"; +import type {SystemState} from "./type.ts"; +import {LocalSystemStateContext} from "./SystemState.tsx"; + +export function useSystemState(): SystemState { + const context = useContext(LocalSystemStateContext); + if (!context) { + throw new Error("useSystemState must be used within SystemStateProvider"); + } + return context; +} \ No newline at end of file diff --git a/widgets/subscription/src/styles/entry.ts b/widgets/subscription/src/styles/entry.ts new file mode 100644 index 00000000..c960ab03 --- /dev/null +++ b/widgets/subscription/src/styles/entry.ts @@ -0,0 +1,5 @@ +import main from "./main.css?inline"; + +export const styles = [ + main, +]; \ No newline at end of file diff --git a/widgets/subscription/src/styles/main.css b/widgets/subscription/src/styles/main.css new file mode 100644 index 00000000..9fa99e90 --- /dev/null +++ b/widgets/subscription/src/styles/main.css @@ -0,0 +1,13 @@ +section { + font-family: system-ui, sans-serif; + padding: 1rem; +} + +h1 { + margin: 0 0 0.5rem; + font-size: 1.5rem; +} + +p { + margin: 0; +} diff --git a/widgets/subscription/src/tests/subscription.spec.ts b/widgets/subscription/src/tests/subscription.spec.ts new file mode 100644 index 00000000..27c2c8c7 --- /dev/null +++ b/widgets/subscription/src/tests/subscription.spec.ts @@ -0,0 +1,34 @@ +import { expect, test } from "@playwright/test"; +import type { Locator } from "@playwright/test"; + +test.describe('Subscription Widget', () => { + let subscription: Locator; + + test.beforeEach(async ({ page }) => { + await page.goto('/?reactedge_debug=eager'); + subscription = page.locator('subscription-widget'); + await expect(subscription).toBeVisible(); + }); + + test('Subscription widget renders its configured title', async () => { + const title = subscription.locator( + 'h1[data-subscription-title]' + ); + + await expect(title).toBeVisible(); + await expect(title).toHaveText('Subscribe and save'); + }); + + test('Subscription widget renders the title colour', async () => { + const title = subscription.locator( + 'h1[data-subscription-title]' + ); + + const colour = await title.evaluate( + (element: HTMLElement) => + getComputedStyle(element).color + ); + + expect(colour).not.toBe('rgb(0, 0, 0)'); + }); +}); diff --git a/widgets/subscription/src/types/global.d.ts b/widgets/subscription/src/types/global.d.ts new file mode 100644 index 00000000..99c9f6c7 --- /dev/null +++ b/widgets/subscription/src/types/global.d.ts @@ -0,0 +1,9 @@ +export {}; + +declare global { + interface Window { + __REACTEDGE_DEBUG__?: boolean; + [key: `ReactEdge_${string}`]: WidgetApi; + } + const __REACTEDGE_MODE__: "render" | "hydrate"; +} diff --git a/widgets/subscription/tests/subscription.spec.ts b/widgets/subscription/tests/subscription.spec.ts new file mode 100644 index 00000000..c0b7cebc --- /dev/null +++ b/widgets/subscription/tests/subscription.spec.ts @@ -0,0 +1,34 @@ +import { expect, test } from "@playwright/test"; +import type { Locator } from "@playwright/test"; + +test.describe('Subscription Widget', () => { + let subscription: Locator; + + test.beforeEach(async ({ page }) => { + await page.goto('/?reactedge_debug=eager'); + subscription = page.locator('subscription-widget'); + await expect(subscription).toBeVisible(); + }); + + test('Subscription widget renders its configured title', async () => { + const title = subscription.locator( + 'h1[data-subscription-title]' + ); + + await expect(title).toBeVisible(); + await expect(title).toHaveText('Subscribe and save'); + }); + + test('Subscription widget renders the title colour', async () => { + const title = subscription.locator( + 'h1[data-subscription-title]' + ); + + const colour = await title.evaluate( + element => getComputedStyle(element).color + ); + + expect(colour).not.toBe('rgb(0, 0, 0)'); + }); + +}); diff --git a/widgets/subscription/tsconfig.app.json b/widgets/subscription/tsconfig.app.json new file mode 100644 index 00000000..705ab148 --- /dev/null +++ b/widgets/subscription/tsconfig.app.json @@ -0,0 +1,7 @@ +{ + "extends": "../../packages/widget-build/shared-resources/tsconfig.app.widget.json", + "compilerOptions": { + "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo" + }, + "include": ["src", "api"] +} \ No newline at end of file diff --git a/widgets/subscription/tsconfig.json b/widgets/subscription/tsconfig.json new file mode 100644 index 00000000..4ebbbc80 --- /dev/null +++ b/widgets/subscription/tsconfig.json @@ -0,0 +1,8 @@ +{ + "files": [], + "references": [ + { "path": "./tsconfig.app.json" }, + { "path": "./tsconfig.node.json" } + ], + "extends": "../../tsconfig.json" +} diff --git a/widgets/subscription/tsconfig.node.json b/widgets/subscription/tsconfig.node.json new file mode 100644 index 00000000..620f3ec4 --- /dev/null +++ b/widgets/subscription/tsconfig.node.json @@ -0,0 +1,10 @@ +{ + "extends": "../../packages/widget-build/shared-resources/tsconfig.node.widget.json", + "compilerOptions": { + "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo" + }, + "include": [ + "vite.config.ts", + "vite.npm.config.ts" + ] +} diff --git a/widgets/subscription/vite.config.ts b/widgets/subscription/vite.config.ts new file mode 100644 index 00000000..a24d7915 --- /dev/null +++ b/widgets/subscription/vite.config.ts @@ -0,0 +1,49 @@ +import { defineConfig } from "vite"; +import react from "@vitejs/plugin-react-swc"; +import pkg from "./package.json" with { type: "json" }; +import { fileURLToPath } from "node:url"; +import { dirname, resolve } from "node:path"; + +import { manifestPlugin } from "../../packages/widget-build/shared-resources/widget-preset/manifestPlugin.ts"; +import { createWidgetBuildDefaults } from "../../packages/widget-build/shared-resources/widget-preset/createReactEdgeConfig.ts"; +import { reactEdgeVisualizer } from "../../packages/widget-build/shared-resources/widget-preset/reactEdgeVisualizer.ts"; + +const isAnalyze = process.env.ANALYZE === "true"; +const widgetName = pkg.name.replace(/^widget-/, ""); +const widgetDir = dirname(fileURLToPath(import.meta.url)); + +export default defineConfig({ + resolve: { + alias: { + "@reactedge": resolve( + widgetDir, + "../../packages/widget-build/shared-resources" + ), + }, + }, + + plugins: [ + react(), + reactEdgeVisualizer(isAnalyze), + manifestPlugin({ + widgetName, + version: pkg.version, + }), + ], + + define: { + "process.env.NODE_ENV": JSON.stringify("production"), + }, + + build: createWidgetBuildDefaults({ + widgetName, + version: pkg.version, + entry: resolve(widgetDir, "api/runtime-shadow-widget.tsx"), + outDir: resolve( + widgetDir, + `../../workspace/release/source/${widgetName}` + ), + emitCss: false, + sourcemap: false + }), +}); \ No newline at end of file diff --git a/widgets/subscription/vite.npm.config.ts b/widgets/subscription/vite.npm.config.ts new file mode 100644 index 00000000..71f83cc3 --- /dev/null +++ b/widgets/subscription/vite.npm.config.ts @@ -0,0 +1,31 @@ +import { defineConfig} from "vite"; +import type { BuildOptions } from "vite" +import react from "@vitejs/plugin-react-swc"; +import pkg from "./package.json" with { type: "json" }; +import {dirname, resolve} from "node:path"; +import {createNpmBuildDefaults} from "../../packages/widget-build/shared-resources/widget-preset/createReactEdgeConfig.ts"; +import {fileURLToPath} from "node:url"; + +const widgetName = pkg.name.replace(/^widget-/, ""); +const widgetDir = dirname(fileURLToPath(import.meta.url)); + +export default defineConfig({ + resolve: { + alias: { + "@reactedge": resolve( + widgetDir, + "../../packages/widget-build/shared-resources" + ), + }, + }, + publicDir: resolve(import.meta.dirname, "public"), + plugins: [react(), ], + define: { + __REACTEDGE_MODE__: JSON.stringify( + process.env.REACTEDGE_MODE ?? "render" + ), + }, + build: createNpmBuildDefaults({ + widgetName + }), +}); \ No newline at end of file From 11cc19d16822ca78aae2461ec0dbc72dde81e320 Mon Sep 17 00:00:00 2001 From: Herve Tribouilloy Date: Fri, 23 Oct 2026 14:52:13 +0100 Subject: [PATCH 2/5] Render subscription plans from widget contract --- widgets/subscription/capability.json | 22 ++++- widgets/subscription/public/default.json | 22 ++++- widgets/subscription/src/Config.ts | 10 +++ widgets/subscription/src/ConfigSchema.ts | 10 +++ .../src/components/WidgetSubscription.tsx | 64 +++++++++++++-- widgets/subscription/src/styles/main.css | 82 +++++++++++++++++-- .../src/tests/subscription.spec.ts | 14 ++-- .../subscription/tests/subscription.spec.ts | 23 ++++-- 8 files changed, 214 insertions(+), 33 deletions(-) diff --git a/widgets/subscription/capability.json b/widgets/subscription/capability.json index 573e89a2..dc898bfc 100644 --- a/widgets/subscription/capability.json +++ b/widgets/subscription/capability.json @@ -4,10 +4,28 @@ "description": "Displays a subscription call to action using Magento GraphQL runtime integration.", "exampleContract": { "data": { - "title": "Subscribe and save" + "title": "Subscribe & Save", + "oneTimePurchaseLabel": "One-time purchase", + "subscriptionLabel": "Subscribe & Save up to 10% Off", + "plansTitle": "Subscription Options", + "subscribeButtonLabel": "Subscribe", + "plans": [ + { + "id": "weekly", + "frequency": "Weekly", + "discount": "10% Off", + "termsUrl": "#weekly-terms" + }, + { + "id": "monthly", + "frequency": "Monthly", + "discount": "5% Off", + "termsUrl": "#monthly-terms" + } + ] }, "settings": { - "colour": "#b42318" + "colour": "#25a846" }, "integration": { "requires": ["magentoGraphql"] diff --git a/widgets/subscription/public/default.json b/widgets/subscription/public/default.json index 912d91a9..ef7184bc 100644 --- a/widgets/subscription/public/default.json +++ b/widgets/subscription/public/default.json @@ -1,9 +1,27 @@ { "data": { - "title": "Subscribe and save" + "title": "Subscribe & Save", + "oneTimePurchaseLabel": "One-time purchase", + "subscriptionLabel": "Subscribe & Save up to 10% Off", + "plansTitle": "Subscription Options", + "subscribeButtonLabel": "Subscribe", + "plans": [ + { + "id": "weekly", + "frequency": "Weekly", + "discount": "10% Off", + "termsUrl": "#weekly-terms" + }, + { + "id": "monthly", + "frequency": "Monthly", + "discount": "5% Off", + "termsUrl": "#monthly-terms" + } + ] }, "settings": { - "colour": "red" + "colour": "#25a846" }, "integration": { "requires": ["magentoGraphql"] diff --git a/widgets/subscription/src/Config.ts b/widgets/subscription/src/Config.ts index faa8c650..ca7620d3 100644 --- a/widgets/subscription/src/Config.ts +++ b/widgets/subscription/src/Config.ts @@ -5,6 +5,16 @@ import {parseRuntimeConfig, type SchemaRuntimeConfig} from "./ConfigSchemaRuntim export interface WidgetConfig { readonly data: { title: string; + oneTimePurchaseLabel: string; + subscriptionLabel: string; + plansTitle: string; + subscribeButtonLabel: string; + plans: { + id: string; + frequency: string; + discount: string; + termsUrl: string; + }[]; } readonly settings: { diff --git a/widgets/subscription/src/ConfigSchema.ts b/widgets/subscription/src/ConfigSchema.ts index f0164fb8..c6afe8d9 100644 --- a/widgets/subscription/src/ConfigSchema.ts +++ b/widgets/subscription/src/ConfigSchema.ts @@ -6,6 +6,16 @@ const IntegrationSchema = z.enum([ const WidgetDataSchema = z.object({ title: z.string().min(1), + oneTimePurchaseLabel: z.string().min(1), + subscriptionLabel: z.string().min(1), + plansTitle: z.string().min(1), + subscribeButtonLabel: z.string().min(1), + plans: z.array(z.object({ + id: z.string().min(1), + frequency: z.string().min(1), + discount: z.string().min(1), + termsUrl: z.string().min(1), + }).strict()).min(1), }).strict(); const WidgetSettingsSchema = z.object({ diff --git a/widgets/subscription/src/components/WidgetSubscription.tsx b/widgets/subscription/src/components/WidgetSubscription.tsx index 94c5c9ad..b4aa3aea 100644 --- a/widgets/subscription/src/components/WidgetSubscription.tsx +++ b/widgets/subscription/src/components/WidgetSubscription.tsx @@ -1,3 +1,4 @@ +import { useState } from "react"; import type { WidgetConfig } from "../Config"; type Props = { @@ -5,16 +6,65 @@ type Props = { }; export const WidgetSubscription = ({ config }: Props) => { + const [purchaseType, setPurchaseType] = useState<"one-time" | "subscription">("subscription"); + const [selectedPlan, setSelectedPlan] = useState(""); + return ( -
-

+
+

{config.data.title}

-

Choose a subscription option that works for you.

+ + + + + + {purchaseType === "subscription" && ( +
+ {config.data.plansTitle} + {config.data.plans.map(plan => ( +
+ + Terms & Conditions +
+ ))} +
+ )} + +
); }; diff --git a/widgets/subscription/src/styles/main.css b/widgets/subscription/src/styles/main.css index 9fa99e90..7a236bef 100644 --- a/widgets/subscription/src/styles/main.css +++ b/widgets/subscription/src/styles/main.css @@ -1,13 +1,83 @@ -section { - font-family: system-ui, sans-serif; +.subscription-card { + display: grid; + gap: 0.75rem; + max-width: 26rem; padding: 1rem; + border: 1px solid #e3e3e3; + border-radius: 0.5rem; + background: #fafafa; + font-family: system-ui, sans-serif; + color: #222; +} + +.subscription-card h1 { + margin: 0; + font-size: 1rem; + font-weight: 600; } -h1 { - margin: 0 0 0.5rem; - font-size: 1.5rem; +.purchase-choice, +.plan-choice { + display: flex; + align-items: center; + gap: 0.5rem; + cursor: pointer; } -p { +.subscription-card input { margin: 0; + accent-color: #1877f2; +} + +.subscription-plans { + display: grid; + gap: 0.75rem; + margin: 0; + padding: 0; + border: 0; +} + +.subscription-plans legend { + width: 100%; + margin-bottom: 0.25rem; + padding: 0 0 0.5rem; + border-bottom: 1px solid #e3e3e3; + font-size: 0.875rem; + font-weight: 600; +} + +.plan-option { + display: grid; + justify-items: start; + gap: 0.2rem; + font-size: 0.875rem; +} + +.plan-option a { + margin-left: 1.4rem; + color: #1681c4; + text-decoration: none; +} + +.plan-option a:hover { + text-decoration: underline; +} + +.subscribe-button { + justify-self: start; + margin-top: 0.25rem; + padding: 0.65rem 1.25rem; + border: 0; + border-radius: 0.4rem; + color: #fff; + font: inherit; + font-weight: 600; + cursor: pointer; +} + +.subscribe-button:focus-visible, +.subscription-card input:focus-visible, +.plan-option a:focus-visible { + outline: 2px solid #1877f2; + outline-offset: 2px; } diff --git a/widgets/subscription/src/tests/subscription.spec.ts b/widgets/subscription/src/tests/subscription.spec.ts index 27c2c8c7..cec47789 100644 --- a/widgets/subscription/src/tests/subscription.spec.ts +++ b/widgets/subscription/src/tests/subscription.spec.ts @@ -16,19 +16,17 @@ test.describe('Subscription Widget', () => { ); await expect(title).toBeVisible(); - await expect(title).toHaveText('Subscribe and save'); + await expect(title).toHaveText('Subscribe & Save'); }); - test('Subscription widget renders the title colour', async () => { - const title = subscription.locator( - 'h1[data-subscription-title]' - ); + test('Subscription widget renders the configured button colour', async () => { + const button = subscription.getByRole('button', { name: 'Subscribe' }); - const colour = await title.evaluate( + const backgroundColour = await button.evaluate( (element: HTMLElement) => - getComputedStyle(element).color + getComputedStyle(element).backgroundColor ); - expect(colour).not.toBe('rgb(0, 0, 0)'); + expect(backgroundColour).toBe('rgb(37, 168, 70)'); }); }); diff --git a/widgets/subscription/tests/subscription.spec.ts b/widgets/subscription/tests/subscription.spec.ts index c0b7cebc..fdbcfd3f 100644 --- a/widgets/subscription/tests/subscription.spec.ts +++ b/widgets/subscription/tests/subscription.spec.ts @@ -16,19 +16,26 @@ test.describe('Subscription Widget', () => { ); await expect(title).toBeVisible(); - await expect(title).toHaveText('Subscribe and save'); + await expect(title).toHaveText('Subscribe & Save'); }); - test('Subscription widget renders the title colour', async () => { - const title = subscription.locator( - 'h1[data-subscription-title]' - ); + test('Subscription widget renders the configured button colour', async () => { + const button = subscription.getByRole('button', { name: 'Subscribe' }); - const colour = await title.evaluate( - element => getComputedStyle(element).color + const backgroundColour = await button.evaluate( + element => getComputedStyle(element).backgroundColor ); - expect(colour).not.toBe('rgb(0, 0, 0)'); + expect(backgroundColour).toBe('rgb(37, 168, 70)'); + }); + + test('Subscription widget renders contract-provided plans', async () => { + await expect(subscription.getByText('One-time purchase')).toBeVisible(); + await expect(subscription.getByText('Subscribe & Save up to 10% Off')).toBeVisible(); + await expect(subscription.getByText('Subscription Options')).toBeVisible(); + await expect(subscription.getByText('Weekly - 10% Off')).toBeVisible(); + await expect(subscription.getByText('Monthly - 5% Off')).toBeVisible(); + await expect(subscription.getByRole('button', { name: 'Subscribe' })).toBeVisible(); }); }); From 7b2ab2c483cbbd94301442c404f32a1053f8b81d Mon Sep 17 00:00:00 2001 From: Herve Tribouilloy Date: Fri, 23 Oct 2026 14:55:52 +0100 Subject: [PATCH 3/5] Split subscription styles by UI component --- widgets/subscription/src/styles/main.css | 84 +------------------ .../src/styles/subscription-card.css | 83 ++++++++++++++++++ 2 files changed, 84 insertions(+), 83 deletions(-) create mode 100644 widgets/subscription/src/styles/subscription-card.css diff --git a/widgets/subscription/src/styles/main.css b/widgets/subscription/src/styles/main.css index 7a236bef..df8800f6 100644 --- a/widgets/subscription/src/styles/main.css +++ b/widgets/subscription/src/styles/main.css @@ -1,83 +1 @@ -.subscription-card { - display: grid; - gap: 0.75rem; - max-width: 26rem; - padding: 1rem; - border: 1px solid #e3e3e3; - border-radius: 0.5rem; - background: #fafafa; - font-family: system-ui, sans-serif; - color: #222; -} - -.subscription-card h1 { - margin: 0; - font-size: 1rem; - font-weight: 600; -} - -.purchase-choice, -.plan-choice { - display: flex; - align-items: center; - gap: 0.5rem; - cursor: pointer; -} - -.subscription-card input { - margin: 0; - accent-color: #1877f2; -} - -.subscription-plans { - display: grid; - gap: 0.75rem; - margin: 0; - padding: 0; - border: 0; -} - -.subscription-plans legend { - width: 100%; - margin-bottom: 0.25rem; - padding: 0 0 0.5rem; - border-bottom: 1px solid #e3e3e3; - font-size: 0.875rem; - font-weight: 600; -} - -.plan-option { - display: grid; - justify-items: start; - gap: 0.2rem; - font-size: 0.875rem; -} - -.plan-option a { - margin-left: 1.4rem; - color: #1681c4; - text-decoration: none; -} - -.plan-option a:hover { - text-decoration: underline; -} - -.subscribe-button { - justify-self: start; - margin-top: 0.25rem; - padding: 0.65rem 1.25rem; - border: 0; - border-radius: 0.4rem; - color: #fff; - font: inherit; - font-weight: 600; - cursor: pointer; -} - -.subscribe-button:focus-visible, -.subscription-card input:focus-visible, -.plan-option a:focus-visible { - outline: 2px solid #1877f2; - outline-offset: 2px; -} +@import "./subscription-card.css"; diff --git a/widgets/subscription/src/styles/subscription-card.css b/widgets/subscription/src/styles/subscription-card.css new file mode 100644 index 00000000..7a236bef --- /dev/null +++ b/widgets/subscription/src/styles/subscription-card.css @@ -0,0 +1,83 @@ +.subscription-card { + display: grid; + gap: 0.75rem; + max-width: 26rem; + padding: 1rem; + border: 1px solid #e3e3e3; + border-radius: 0.5rem; + background: #fafafa; + font-family: system-ui, sans-serif; + color: #222; +} + +.subscription-card h1 { + margin: 0; + font-size: 1rem; + font-weight: 600; +} + +.purchase-choice, +.plan-choice { + display: flex; + align-items: center; + gap: 0.5rem; + cursor: pointer; +} + +.subscription-card input { + margin: 0; + accent-color: #1877f2; +} + +.subscription-plans { + display: grid; + gap: 0.75rem; + margin: 0; + padding: 0; + border: 0; +} + +.subscription-plans legend { + width: 100%; + margin-bottom: 0.25rem; + padding: 0 0 0.5rem; + border-bottom: 1px solid #e3e3e3; + font-size: 0.875rem; + font-weight: 600; +} + +.plan-option { + display: grid; + justify-items: start; + gap: 0.2rem; + font-size: 0.875rem; +} + +.plan-option a { + margin-left: 1.4rem; + color: #1681c4; + text-decoration: none; +} + +.plan-option a:hover { + text-decoration: underline; +} + +.subscribe-button { + justify-self: start; + margin-top: 0.25rem; + padding: 0.65rem 1.25rem; + border: 0; + border-radius: 0.4rem; + color: #fff; + font: inherit; + font-weight: 600; + cursor: pointer; +} + +.subscribe-button:focus-visible, +.subscription-card input:focus-visible, +.plan-option a:focus-visible { + outline: 2px solid #1877f2; + outline-offset: 2px; +} From 49e1b8872e25aa149a340eb9dbbabe3aa74b4055 Mon Sep 17 00:00:00 2001 From: Herve Tribouilloy Date: Fri, 23 Oct 2026 14:58:30 +0100 Subject: [PATCH 4/5] Split subscription styles into intent files --- widgets/subscription/src/styles/entry.ts | 10 ++- widgets/subscription/src/styles/main.css | 6 +- .../src/styles/purchase-options.css | 17 +++++ .../src/styles/subscribe-button.css | 16 +++++ .../src/styles/subscription-card.css | 66 ------------------- .../src/styles/subscription-plans.css | 38 +++++++++++ 6 files changed, 85 insertions(+), 68 deletions(-) create mode 100644 widgets/subscription/src/styles/purchase-options.css create mode 100644 widgets/subscription/src/styles/subscribe-button.css create mode 100644 widgets/subscription/src/styles/subscription-plans.css diff --git a/widgets/subscription/src/styles/entry.ts b/widgets/subscription/src/styles/entry.ts index c960ab03..86deebf4 100644 --- a/widgets/subscription/src/styles/entry.ts +++ b/widgets/subscription/src/styles/entry.ts @@ -1,5 +1,13 @@ import main from "./main.css?inline"; +import subscriptionCard from "./subscription-card.css?inline"; +import purchaseOptions from "./purchase-options.css?inline"; +import subscriptionPlans from "./subscription-plans.css?inline"; +import subscribeButton from "./subscribe-button.css?inline"; export const styles = [ main, -]; \ No newline at end of file + subscriptionCard, + purchaseOptions, + subscriptionPlans, + subscribeButton, +]; diff --git a/widgets/subscription/src/styles/main.css b/widgets/subscription/src/styles/main.css index df8800f6..4cd982c3 100644 --- a/widgets/subscription/src/styles/main.css +++ b/widgets/subscription/src/styles/main.css @@ -1 +1,5 @@ -@import "./subscription-card.css"; +*, +*::before, +*::after { + box-sizing: border-box; +} diff --git a/widgets/subscription/src/styles/purchase-options.css b/widgets/subscription/src/styles/purchase-options.css new file mode 100644 index 00000000..75ea284e --- /dev/null +++ b/widgets/subscription/src/styles/purchase-options.css @@ -0,0 +1,17 @@ +.purchase-choice, +.plan-choice { + display: flex; + align-items: center; + gap: 0.5rem; + cursor: pointer; +} + +.subscription-card input { + margin: 0; + accent-color: #1877f2; +} + +.subscription-card input:focus-visible { + outline: 2px solid #1877f2; + outline-offset: 2px; +} diff --git a/widgets/subscription/src/styles/subscribe-button.css b/widgets/subscription/src/styles/subscribe-button.css new file mode 100644 index 00000000..2ae5a770 --- /dev/null +++ b/widgets/subscription/src/styles/subscribe-button.css @@ -0,0 +1,16 @@ +.subscribe-button { + justify-self: start; + margin-top: 0.25rem; + padding: 0.65rem 1.25rem; + border: 0; + border-radius: 0.4rem; + color: #fff; + font: inherit; + font-weight: 600; + cursor: pointer; +} + +.subscribe-button:focus-visible { + outline: 2px solid #1877f2; + outline-offset: 2px; +} diff --git a/widgets/subscription/src/styles/subscription-card.css b/widgets/subscription/src/styles/subscription-card.css index 7a236bef..331cb1a1 100644 --- a/widgets/subscription/src/styles/subscription-card.css +++ b/widgets/subscription/src/styles/subscription-card.css @@ -15,69 +15,3 @@ font-size: 1rem; font-weight: 600; } - -.purchase-choice, -.plan-choice { - display: flex; - align-items: center; - gap: 0.5rem; - cursor: pointer; -} - -.subscription-card input { - margin: 0; - accent-color: #1877f2; -} - -.subscription-plans { - display: grid; - gap: 0.75rem; - margin: 0; - padding: 0; - border: 0; -} - -.subscription-plans legend { - width: 100%; - margin-bottom: 0.25rem; - padding: 0 0 0.5rem; - border-bottom: 1px solid #e3e3e3; - font-size: 0.875rem; - font-weight: 600; -} - -.plan-option { - display: grid; - justify-items: start; - gap: 0.2rem; - font-size: 0.875rem; -} - -.plan-option a { - margin-left: 1.4rem; - color: #1681c4; - text-decoration: none; -} - -.plan-option a:hover { - text-decoration: underline; -} - -.subscribe-button { - justify-self: start; - margin-top: 0.25rem; - padding: 0.65rem 1.25rem; - border: 0; - border-radius: 0.4rem; - color: #fff; - font: inherit; - font-weight: 600; - cursor: pointer; -} - -.subscribe-button:focus-visible, -.subscription-card input:focus-visible, -.plan-option a:focus-visible { - outline: 2px solid #1877f2; - outline-offset: 2px; -} diff --git a/widgets/subscription/src/styles/subscription-plans.css b/widgets/subscription/src/styles/subscription-plans.css new file mode 100644 index 00000000..85ea8637 --- /dev/null +++ b/widgets/subscription/src/styles/subscription-plans.css @@ -0,0 +1,38 @@ +.subscription-plans { + display: grid; + gap: 0.75rem; + margin: 0; + padding: 0; + border: 0; +} + +.subscription-plans legend { + width: 100%; + margin-bottom: 0.25rem; + padding: 0 0 0.5rem; + border-bottom: 1px solid #e3e3e3; + font-size: 0.875rem; + font-weight: 600; +} + +.plan-option { + display: grid; + justify-items: start; + gap: 0.2rem; + font-size: 0.875rem; +} + +.plan-option a { + margin-left: 1.4rem; + color: #1681c4; + text-decoration: none; +} + +.plan-option a:hover { + text-decoration: underline; +} + +.plan-option a:focus-visible { + outline: 2px solid #1877f2; + outline-offset: 2px; +} From 3645f6b501a437e9fbe840a7665fa1878602a7c5 Mon Sep 17 00:00:00 2001 From: Herve Tribouilloy Date: Fri, 23 Oct 2026 15:12:36 +0100 Subject: [PATCH 5/5] Hook subscription button to storefront submit event --- .../src/components/WidgetSubscription.tsx | 62 +++++++++++++++++-- .../src/integration/subscriptionSubmit.ts | 30 +++++++++ .../src/styles/subscribe-button.css | 6 ++ 3 files changed, 93 insertions(+), 5 deletions(-) create mode 100644 widgets/subscription/src/integration/subscriptionSubmit.ts diff --git a/widgets/subscription/src/components/WidgetSubscription.tsx b/widgets/subscription/src/components/WidgetSubscription.tsx index b4aa3aea..cfdac108 100644 --- a/widgets/subscription/src/components/WidgetSubscription.tsx +++ b/widgets/subscription/src/components/WidgetSubscription.tsx @@ -1,16 +1,53 @@ import { useState } from "react"; import type { WidgetConfig } from "../Config"; +import { submitSubscriptionSelection } from "../integration/subscriptionSubmit"; type Props = { config: WidgetConfig; }; export const WidgetSubscription = ({ config }: Props) => { - const [purchaseType, setPurchaseType] = useState<"one-time" | "subscription">("subscription"); + const [purchaseType, setPurchaseType] = useState< + "one-time" | "subscription" + >("subscription"); const [selectedPlan, setSelectedPlan] = useState(""); + const [submitError, setSubmitError] = useState(""); + + const handleSubscribe = () => { + const plan = config.data.plans.find(({ id }) => id === selectedPlan); + if (purchaseType === "subscription" && !plan) { + setSubmitError("Select a subscription plan to continue."); + return; + } + + const handled = submitSubscriptionSelection({ + purchaseType, + sku: config.runtime.sku, + storeCode: config.runtime.storeCode, + ...(purchaseType === "subscription" && plan + ? { + plan: { + id: plan.id, + frequency: plan.frequency, + discount: plan.discount, + termsUrl: plan.termsUrl, + }, + } + : {}), + }); + + setSubmitError( + handled + ? "" + : "Subscription checkout is not connected on this page." + ); + }; return ( -
+

{config.data.title}

@@ -21,7 +58,10 @@ export const WidgetSubscription = ({ config }: Props) => { name="purchase-type" value="one-time" checked={purchaseType === "one-time"} - onChange={() => setPurchaseType("one-time")} + onChange={() => { + setPurchaseType("one-time"); + setSubmitError(""); + }} /> {config.data.oneTimePurchaseLabel} @@ -32,7 +72,10 @@ export const WidgetSubscription = ({ config }: Props) => { name="purchase-type" value="subscription" checked={purchaseType === "subscription"} - onChange={() => setPurchaseType("subscription")} + onChange={() => { + setPurchaseType("subscription"); + setSubmitError(""); + }} /> {config.data.subscriptionLabel} @@ -48,7 +91,10 @@ export const WidgetSubscription = ({ config }: Props) => { name="subscription-plan" value={plan.id} checked={selectedPlan === plan.id} - onChange={() => setSelectedPlan(plan.id)} + onChange={() => { + setSelectedPlan(plan.id); + setSubmitError(""); + }} /> {plan.frequency} - {plan.discount} @@ -62,9 +108,15 @@ export const WidgetSubscription = ({ config }: Props) => { className="subscribe-button" type="button" style={{ backgroundColor: config.settings.colour }} + onClick={handleSubscribe} > {config.data.subscribeButtonLabel} + {submitError && ( +

+ {submitError} +

+ )}
); }; diff --git a/widgets/subscription/src/integration/subscriptionSubmit.ts b/widgets/subscription/src/integration/subscriptionSubmit.ts new file mode 100644 index 00000000..41c73faa --- /dev/null +++ b/widgets/subscription/src/integration/subscriptionSubmit.ts @@ -0,0 +1,30 @@ +export interface SubscriptionSubmitDetail { + purchaseType: "one-time" | "subscription"; + sku: string; + storeCode: string; + plan?: { + id: string; + frequency: string; + discount: string; + termsUrl: string; + }; +} + +/** + * Dispatches the storefront action for a selected purchase option. + * A storefront handler acknowledges the request synchronously with + * event.preventDefault() and then performs its Magento integration. + */ +export function submitSubscriptionSelection( + detail: SubscriptionSubmitDetail +): boolean { + const event = new CustomEvent( + "reactedge:subscription:submit", + { + detail, + cancelable: true, + } + ); + + return !window.dispatchEvent(event); +} diff --git a/widgets/subscription/src/styles/subscribe-button.css b/widgets/subscription/src/styles/subscribe-button.css index 2ae5a770..c7a33cc6 100644 --- a/widgets/subscription/src/styles/subscribe-button.css +++ b/widgets/subscription/src/styles/subscribe-button.css @@ -14,3 +14,9 @@ outline: 2px solid #1877f2; outline-offset: 2px; } + +.subscription-submit-error { + margin: 0; + color: #b42318; + font-size: 0.875rem; +}