@domnia/shop-sdk-react 0.0.0-stage → 1.0.0-alpha.0

package/README.md

@@ -1,3 +1,50 @@
-# Temporary Holding Version
+# @domnia/shop-sdk-react
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+React components to embed Domnia's booking, checkout and purchase flows.
+
+```sh
+pnpm add @domnia/shop-sdk-react
+```
+
+`react` and `react-dom` ≥ 19 are peer dependencies; everything else (i18n, state, notifications) is
+bundled. Import the compiled stylesheet once — no Tailwind needed on your side:
+
+```ts
+import '@domnia/shop-sdk-react/styles.css';
+```
+
+## Usage
+
+```tsx
+import { useState } from 'react';
+import { DomniaSdkProvider, CalendarAvailabilityFlowSdk, CheckoutFlowSdk } from '@domnia/shop-sdk-react';
+
+export default function BookingPage() {
+  const [orderId, setOrderId] = useState<string | null>(null);
+
+  return (
+    <DomniaSdkProvider apiKey={process.env.NEXT_PUBLIC_DOMNIA_SDK_KEY!}>
+      {orderId ? (
+        <CheckoutFlowSdk orderId={orderId} locale="it" onGoHome={() => setOrderId(null)} />
+      ) : (
+        <CalendarAvailabilityFlowSdk productIds={[2620, 2621]} locale="it" onNavigateToCheckout={setOrderId} />
+      )}
+    </DomniaSdkProvider>
+  );
+}
+```
+
+| Export                                                                 | What it is                                                                    |
+| ---------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
+| `DomniaSdkProvider`                                                    | Resolves the API key and holds the SDK's state; every component goes under it |
+| `CalendarAvailabilityFlowSdk`                                          | Availability and selection; hands back an `orderId`                           |
+| `CheckoutFlowSdk`                                                      | Checkout of an existing order                                                 |
+| `PurchaseFlowSdk`                                                      | Selection **and** checkout in one container, no page navigation               |
+| `confirmOrder` / `downloadTickets`                                     | For the payment return page, where no component is mounted                    |
+| `createLocalStorageSdkStore` / `createNoopSdkStore`, `SdkStoreAdapter` | Control or replace the persisted state                                        |
+
+The components are marked `'use client'`, so they can be imported from a Next.js Server Component.
+
+Full documentation — props, the payment-return page, state persistence — is in the SDK docs of
+your Domnia portal. Not using React? See [`@domnia/shop-sdk`](https://www.npmjs.com/package/@domnia/shop-sdk)
+(script tag / custom elements) and [`@domnia/shop-sdk-vue`](https://www.npmjs.com/package/@domnia/shop-sdk-vue).