@businessdash/sdk 0.9.60 → 0.9.80

package/dist/framework-support.js

@@ -0,0 +1,323 @@
+/**
+ * Which framework versions each adapter supports — one source of truth,
+ * consumed by `package.json` peer ranges, the docs matrix, and (later) the
+ * runtime mismatch warning.
+ *
+ * WHY THIS EXISTS
+ *
+ * Frameworks break their own APIs. When one ships a major that reworks
+ * reactivity or JSX, an adapter written against the old dialect stops
+ * compiling for anyone who upgrades — and, just as bad, our docs keep showing
+ * one implementation as if it were universal. A developer on the new major
+ * follows a page that silently describes the old one.
+ *
+ * The blast radius is already small by design: every binding is a thin view
+ * over the framework-agnostic core (`createFormController` in
+ * `@businessdash/sdk/forms`). Values, validation, conditional visibility,
+ * multi-step navigation, uploads and submit lifecycle all live there and
+ * survive any framework major untouched. Only the binding layer — how an
+ * external store becomes reactive state, and how a list renders — is
+ * version-sensitive.
+ *
+ * `frameworkApis` names exactly which imports each binding leans on, so when
+ * a major lands the question "does this break us?" is a diff against a list
+ * rather than a reread of 1,400 lines.
+ *
+ * WHEN A MAJOR BREAKS AN ADAPTER
+ *
+ * Add a second entry for the same adapter with the new range and a distinct
+ * `dialect`, rather than rewriting the existing one. Both ship; the docs show
+ * both; consumers on either major get working code. Retire the old entry only
+ * when that major is genuinely out of support.
+ */
+/** Human-readable names, in the order the docs table renders them. */
+export const CAPABILITY_LABELS = {
+    forms: "Forms",
+    "client-di": "Shared client",
+    chatbot: "AI chat",
+    auth: "Customer auth",
+    storefront: "Storefront",
+    cart: "Cart",
+    checkout: "Checkout",
+    blog: "Blog",
+    "customer-portal": "Customer portal",
+    "marketing-pages": "Marketing pages",
+    followers: "Followers",
+    "social-links": "Social links",
+    "email-verify": "Email verification",
+    "phone-verify": "Phone verification",
+};
+export const ALL_CAPABILITIES = Object.keys(CAPABILITY_LABELS);
+/**
+ * Everything `@businessdash/sdk/react` exposes — the full product.
+ *
+ * Note how much of it is `embed`: storefront, cart and blog are hosted pages in
+ * every binding INCLUDING React. No framework has a native storefront, so on
+ * those surfaces the other bindings are not behind — there is simply nothing
+ * more to have yet.
+ */
+const FULL_SURFACE = {
+    forms: "native",
+    "client-di": "native",
+    chatbot: "both",
+    auth: "native",
+    // `both`: the hosted iframe widget AND the headless controller. The native
+    // path is `useStorefront` / `useChatbot` over `store-core` / `chat-core`.
+    storefront: "both",
+    cart: "both",
+    checkout: "both",
+    blog: "both",
+    "customer-portal": "both",
+    "marketing-pages": "native",
+    followers: "native",
+    "social-links": "native",
+    "email-verify": "native",
+    "phone-verify": "native",
+};
+/**
+ * Forms, a shared client, and the two native surfaces every binding now has.
+ *
+ * `storefront`, `cart` and `chatbot` are `native` rather than `both` here: these
+ * bindings expose the headless controllers, not the hosted iframe widgets. They
+ * render into the consumer's own DOM, which is the harder and better half.
+ */
+const FORMS_AND_CLIENT = {
+    forms: "native",
+    "client-di": "native",
+    storefront: "native",
+    cart: "native",
+    chatbot: "native",
+    blog: "native",
+    auth: "native",
+    checkout: "native",
+    followers: "native",
+    "marketing-pages": "native",
+    "email-verify": "native",
+    "phone-verify": "native",
+    "social-links": "native",
+    "customer-portal": "native",
+};
+export const FRAMEWORK_SUPPORT = [
+    {
+        entry: "@businessdash/sdk/react",
+        pkg: "react",
+        range: ">=18.0.0 <20",
+        dialect: "default",
+        shipMode: "compiled",
+        frameworkApis: [
+            "useSyncExternalStore",
+            "useState",
+            "useMemo",
+            "useEffect",
+            "useId",
+            "createContext",
+            "useContext",
+        ],
+        capabilities: FULL_SURFACE,
+        status: "supported",
+    },
+    {
+        entry: "@businessdash/sdk/solid",
+        pkg: "solid-js",
+        range: ">=1.8.0 <2",
+        dialect: "v1",
+        shipMode: "source",
+        frameworkApis: [
+            "from",
+            "createSignal",
+            "createMemo",
+            "createContext",
+            "useContext",
+            "createUniqueId",
+            "onMount",
+            "onCleanup",
+            "For",
+            "Show",
+            "Switch",
+            "Match",
+        ],
+        capabilities: {
+            forms: "native",
+            "client-di": "native",
+            // The hosted widget plus `createChat`. React additionally ships
+            // `<ChatbotInline>`, a rendered chat UI that Solid does not have — the
+            // headless controller beneath them is the same.
+            chatbot: "both",
+            auth: "native",
+            storefront: "both",
+            cart: "both",
+            checkout: "both",
+            blog: "both",
+            "customer-portal": "both",
+            followers: "native",
+            "social-links": "native",
+            "marketing-pages": "native",
+            "email-verify": "native",
+            "phone-verify": "native",
+        },
+        status: "supported",
+        notes: "Solid 2.0 shipped 2026-08 with a substantial API rework. This adapter is written against the 1.x dialect and is NOT yet verified on 2.x — a `v2` entry alongside this one is the intended shape, not a rewrite of it.",
+    },
+    {
+        entry: "@businessdash/sdk/vue",
+        pkg: "vue",
+        range: ">=3.3.0 <4",
+        dialect: "default",
+        shipMode: "source",
+        frameworkApis: [
+            "defineComponent",
+            "ref",
+            "computed",
+            "onMounted",
+            "onUnmounted",
+            "provide",
+            "inject",
+            "h",
+        ],
+        capabilities: FORMS_AND_CLIENT,
+        status: "supported",
+    },
+    {
+        entry: "@businessdash/sdk/svelte",
+        pkg: "svelte",
+        range: ">=5.0.0 <6",
+        dialect: "runes",
+        shipMode: "source",
+        frameworkApis: ["$state", "$derived", "$effect", "onMount", "onDestroy"],
+        capabilities: FORMS_AND_CLIENT,
+        status: "supported",
+        notes: "Written against Svelte 5 runes. Svelte 4's store-based dialect is a separate entry if it's ever needed.",
+    },
+    {
+        entry: "@businessdash/sdk/qwik",
+        pkg: "@builder.io/qwik",
+        range: ">=1.5.0 <2",
+        dialect: "default",
+        shipMode: "source",
+        frameworkApis: [
+            "component$",
+            "useSignal",
+            "useStore",
+            "useVisibleTask$",
+            "useComputed$",
+        ],
+        capabilities: {
+            forms: "native",
+            storefront: "native",
+            cart: "native",
+            chatbot: "native",
+            blog: "native",
+            auth: "native",
+            checkout: "native",
+            followers: "native",
+            "marketing-pages": "native",
+            "email-verify": "native",
+            "phone-verify": "native",
+            "social-links": "native",
+            "customer-portal": "native",
+        },
+        status: "untested",
+    },
+    {
+        entry: "@businessdash/sdk/angular",
+        pkg: "@angular/core",
+        range: ">=17.0.0",
+        dialect: "standalone",
+        shipMode: "source",
+        frameworkApis: ["Component", "signal", "computed", "effect", "inject"],
+        capabilities: FORMS_AND_CLIENT,
+        status: "untested",
+        notes: "Written against standalone components + signals (Angular 17+).",
+    },
+    {
+        entry: "@businessdash/sdk/vanilla",
+        pkg: "(none)",
+        range: "*",
+        dialect: "default",
+        shipMode: "compiled",
+        frameworkApis: [],
+        capabilities: {
+            forms: "native",
+            storefront: "native",
+            cart: "native",
+            chatbot: "native",
+            blog: "native",
+            auth: "native",
+            checkout: "native",
+            followers: "native",
+            "marketing-pages": "native",
+            "email-verify": "native",
+            "phone-verify": "native",
+            "social-links": "native",
+            "customer-portal": "native",
+        },
+        status: "supported",
+        notes: "No framework dependency — the fallback that cannot be broken by anyone else's major.",
+    },
+    {
+        entry: "@businessdash/sdk/element",
+        pkg: "(none)",
+        range: "*",
+        dialect: "default",
+        shipMode: "compiled",
+        frameworkApis: ["customElements"],
+        capabilities: FORMS_AND_CLIENT,
+        status: "supported",
+        notes: "Web component. Works inside any framework, and is the recommended escape hatch when a framework major outpaces its adapter.",
+    },
+];
+/** All adapters for one framework package — several when majors diverge. */
+export function supportFor(pkg) {
+    return FRAMEWORK_SUPPORT.filter((f) => f.pkg === pkg);
+}
+export const REACT_TARGETS = [
+    {
+        name: "React",
+        entry: "@businessdash/sdk/react",
+        requires: "Nothing — import and render.",
+        starter: "React-Bun",
+        status: "supported",
+    },
+    {
+        name: "Next.js (App Router)",
+        entry: "@businessdash/sdk/react",
+        requires: 'Nothing as of 0.9.61 — the adapter now carries its own `"use client"` boundary, so components import directly into a server-rendered page. Before that, every component needed a hand-written client wrapper.',
+        starter: "T3-App",
+        status: "supported",
+    },
+    {
+        name: "Astro",
+        entry: "@businessdash/sdk/react",
+        requires: "`@astrojs/react`, and a client directive on the island (`<ContactForm client:load />`) — without one Astro renders it to static HTML and no handler ever attaches.",
+        starter: "Astro",
+        status: "supported",
+    },
+    {
+        name: "Remix / React Router 7",
+        entry: "@businessdash/sdk/react",
+        requires: "Nothing — no RSC boundary to cross.",
+        starter: "Remix",
+        status: "supported",
+    },
+    {
+        name: "TanStack Start",
+        entry: "@businessdash/sdk/react",
+        requires: "Nothing — no RSC boundary to cross.",
+        starter: "Tanstack-Start",
+        status: "supported",
+    },
+    {
+        name: "Preact",
+        entry: "@businessdash/sdk/react",
+        requires: "The standard `preact/compat` alias in your bundler — nothing SDK-specific. The binding imports nine runtime symbols from `react` and never imports `react-dom`, so it is renderer-agnostic; `test/preact-compat.test.ts` renders components on both and asserts identical markup.",
+        status: "supported",
+    },
+    {
+        name: "React Native / Expo",
+        entry: "@businessdash/sdk/native",
+        requires: "The `native` entry, not `react` — the DOM components don't render there. Data access and auth are shared; the UI is yours.",
+        starter: "React-Native",
+        status: "supported",
+    },
+];
+//# sourceMappingURL=framework-support.js.map

package/dist/framework-support.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"framework-support.js","sourceRoot":"","sources":["../src/framework-support.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AA6EH,sEAAsE;AACtE,MAAM,CAAC,MAAM,iBAAiB,GAAyC;IACtE,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,eAAe;IAC5B,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,eAAe;IACrB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,iBAAiB,EAAE,iBAAiB;IACpC,iBAAiB,EAAE,iBAAiB;IACpC,SAAS,EAAE,WAAW;IACtB,cAAc,EAAE,cAAc;IAC9B,cAAc,EAAE,oBAAoB;IACpC,cAAc,EAAE,oBAAoB;CACpC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAiB,CAAC;AAE/E;;;;;;;GAOG;AACH,MAAM,YAAY,GAAqB;IACtC,KAAK,EAAE,QAAQ;IACf,WAAW,EAAE,QAAQ;IACrB,OAAO,EAAE,MAAM;IACf,IAAI,EAAE,QAAQ;IACd,2EAA2E;IAC3E,0EAA0E;IAC1E,UAAU,EAAE,MAAM;IAClB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,MAAM;IAChB,IAAI,EAAE,MAAM;IACZ,iBAAiB,EAAE,MAAM;IACzB,iBAAiB,EAAE,QAAQ;IAC3B,SAAS,EAAE,QAAQ;IACnB,cAAc,EAAE,QAAQ;IACxB,cAAc,EAAE,QAAQ;IACxB,cAAc,EAAE,QAAQ;CACxB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,gBAAgB,GAAqB;IAC1C,KAAK,EAAE,QAAQ;IACf,WAAW,EAAE,QAAQ;IACrB,UAAU,EAAE,QAAQ;IACpB,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,QAAQ;IACjB,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,QAAQ;IAClB,SAAS,EAAE,QAAQ;IACnB,iBAAiB,EAAE,QAAQ;IAC3B,cAAc,EAAE,QAAQ;IACxB,cAAc,EAAE,QAAQ;IACxB,cAAc,EAAE,QAAQ;IACxB,iBAAiB,EAAE,QAAQ;CAC3B,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAgC;IAC7D;QACC,KAAK,EAAE,yBAAyB;QAChC,GAAG,EAAE,OAAO;QACZ,KAAK,EAAE,cAAc;QACrB,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,UAAU;QACpB,aAAa,EAAE;YACd,sBAAsB;YACtB,UAAU;YACV,SAAS;YACT,WAAW;YACX,OAAO;YACP,eAAe;YACf,YAAY;SACZ;QACD,YAAY,EAAE,YAAY;QAC1B,MAAM,EAAE,WAAW;KACnB;IACD;QACC,KAAK,EAAE,yBAAyB;QAChC,GAAG,EAAE,UAAU;QACf,KAAK,EAAE,YAAY;QACnB,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,QAAQ;QAClB,aAAa,EAAE;YACd,MAAM;YACN,cAAc;YACd,YAAY;YACZ,eAAe;YACf,YAAY;YACZ,gBAAgB;YAChB,SAAS;YACT,WAAW;YACX,KAAK;YACL,MAAM;YACN,QAAQ;YACR,OAAO;SACP;QACD,YAAY,EAAE;YACb,KAAK,EAAE,QAAQ;YACf,WAAW,EAAE,QAAQ;YACrB,gEAAgE;YAChE,uEAAuE;YACvE,gDAAgD;YAChD,OAAO,EAAE,MAAM;YACf,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,MAAM;YAClB,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,MAAM;YACZ,iBAAiB,EAAE,MAAM;YACzB,SAAS,EAAE,QAAQ;YACnB,cAAc,EAAE,QAAQ;YACxB,iBAAiB,EAAE,QAAQ;YAC3B,cAAc,EAAE,QAAQ;YACxB,cAAc,EAAE,QAAQ;SACxB;QACD,MAAM,EAAE,WAAW;QACnB,KAAK,EACJ,uNAAuN;KACxN;IACD;QACC,KAAK,EAAE,uBAAuB;QAC9B,GAAG,EAAE,KAAK;QACV,KAAK,EAAE,YAAY;QACnB,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,QAAQ;QAClB,aAAa,EAAE;YACd,iBAAiB;YACjB,KAAK;YACL,UAAU;YACV,WAAW;YACX,aAAa;YACb,SAAS;YACT,QAAQ;YACR,GAAG;SACH;QACD,YAAY,EAAE,gBAAgB;QAC9B,MAAM,EAAE,WAAW;KACnB;IACD;QACC,KAAK,EAAE,0BAA0B;QACjC,GAAG,EAAE,QAAQ;QACb,KAAK,EAAE,YAAY;QACnB,OAAO,EAAE,OAAO;QAChB,QAAQ,EAAE,QAAQ;QAClB,aAAa,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC;QACxE,YAAY,EAAE,gBAAgB;QAC9B,MAAM,EAAE,WAAW;QACnB,KAAK,EACJ,yGAAyG;KAC1G;IACD;QACC,KAAK,EAAE,wBAAwB;QAC/B,GAAG,EAAE,kBAAkB;QACvB,KAAK,EAAE,YAAY;QACnB,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,QAAQ;QAClB,aAAa,EAAE;YACd,YAAY;YACZ,WAAW;YACX,UAAU;YACV,iBAAiB;YACjB,cAAc;SACd;QACD,YAAY,EAAE;YACb,KAAK,EAAE,QAAQ;YACf,UAAU,EAAE,QAAQ;YACpB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;YACjB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,QAAQ;YACnB,iBAAiB,EAAE,QAAQ;YAC3B,cAAc,EAAE,QAAQ;YACxB,cAAc,EAAE,QAAQ;YACxB,cAAc,EAAE,QAAQ;YACxB,iBAAiB,EAAE,QAAQ;SAC3B;QACD,MAAM,EAAE,UAAU;KAClB;IACD;QACC,KAAK,EAAE,2BAA2B;QAClC,GAAG,EAAE,eAAe;QACpB,KAAK,EAAE,UAAU;QACjB,OAAO,EAAE,YAAY;QACrB,QAAQ,EAAE,QAAQ;QAClB,aAAa,EAAE,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,CAAC;QACtE,YAAY,EAAE,gBAAgB;QAC9B,MAAM,EAAE,UAAU;QAClB,KAAK,EAAE,gEAAgE;KACvE;IACD;QACC,KAAK,EAAE,2BAA2B;QAClC,GAAG,EAAE,QAAQ;QACb,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,UAAU;QACpB,aAAa,EAAE,EAAE;QACjB,YAAY,EAAE;YACb,KAAK,EAAE,QAAQ;YACf,UAAU,EAAE,QAAQ;YACpB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;YACjB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,QAAQ;YACnB,iBAAiB,EAAE,QAAQ;YAC3B,cAAc,EAAE,QAAQ;YACxB,cAAc,EAAE,QAAQ;YACxB,cAAc,EAAE,QAAQ;YACxB,iBAAiB,EAAE,QAAQ;SAC3B;QACD,MAAM,EAAE,WAAW;QACnB,KAAK,EACJ,sFAAsF;KACvF;IACD;QACC,KAAK,EAAE,2BAA2B;QAClC,GAAG,EAAE,QAAQ;QACb,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,UAAU;QACpB,aAAa,EAAE,CAAC,gBAAgB,CAAC;QACjC,YAAY,EAAE,gBAAgB;QAC9B,MAAM,EAAE,WAAW;QACnB,KAAK,EACJ,6HAA6H;KAC9H;CACD,CAAC;AAEF,4EAA4E;AAC5E,MAAM,UAAU,UAAU,CAAC,GAAW;IACrC,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;AACvD,CAAC;AA8BD,MAAM,CAAC,MAAM,aAAa,GAA2B;IACpD;QACC,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,yBAAyB;QAChC,QAAQ,EAAE,8BAA8B;QACxC,OAAO,EAAE,WAAW;QACpB,MAAM,EAAE,WAAW;KACnB;IACD;QACC,IAAI,EAAE,sBAAsB;QAC5B,KAAK,EAAE,yBAAyB;QAChC,QAAQ,EACP,+MAA+M;QAChN,OAAO,EAAE,QAAQ;QACjB,MAAM,EAAE,WAAW;KACnB;IACD;QACC,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,yBAAyB;QAChC,QAAQ,EACP,oKAAoK;QACrK,OAAO,EAAE,OAAO;QAChB,MAAM,EAAE,WAAW;KACnB;IACD;QACC,IAAI,EAAE,wBAAwB;QAC9B,KAAK,EAAE,yBAAyB;QAChC,QAAQ,EAAE,qCAAqC;QAC/C,OAAO,EAAE,OAAO;QAChB,MAAM,EAAE,WAAW;KACnB;IACD;QACC,IAAI,EAAE,gBAAgB;QACtB,KAAK,EAAE,yBAAyB;QAChC,QAAQ,EAAE,qCAAqC;QAC/C,OAAO,EAAE,gBAAgB;QACzB,MAAM,EAAE,WAAW;KACnB;IACD;QACC,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,yBAAyB;QAChC,QAAQ,EACP,mRAAmR;QACpR,MAAM,EAAE,WAAW;KACnB;IACD;QACC,IAAI,EAAE,qBAAqB;QAC3B,KAAK,EAAE,0BAA0B;QACjC,QAAQ,EACP,4HAA4H;QAC7H,OAAO,EAAE,cAAc;QACvB,MAAM,EAAE,WAAW;KACnB;CACD,CAAC"}