@lockerverse/react 0.2.155 → 0.2.157

package/guides/signup.md

@@ -0,0 +1,94 @@
+# Lockerverse signup guide
+
+Package: @lockerverse/react@0.2.157
+
+Generated from this release's maintained documentation. Do not edit this copy.
+
+Read [the shared integration guide](integration.md) first.
+
+## Signup component
+
+```tsx
+import {
+  LockerverseSignup,
+  type LockerverseSignupProps,
+  useLockerverseSignup,
+} from "@lockerverse/react/signup";
+import "@lockerverse/react/signup.css";
+
+const handleSignupComplete: NonNullable<
+  LockerverseSignupProps["onSignupComplete"]
+> = (submission) => {
+  console.info("Signup complete", submission.id);
+};
+
+export function Signup() {
+  const widget = useLockerverseSignup({
+    communitySlug: "your-community",
+    signupSlug: "your-signup",
+  });
+  return (
+    <LockerverseSignup
+      onSignupComplete={handleSignupComplete}
+      widget={widget}
+    />
+  );
+}
+```
+
+## Properties
+
+```ts
+type LockerverseSignupProps = {
+  widget: UseLockerverseSignupResult;
+  branding?: {
+    accentColor?: string;
+    imageUrl?: string | null;
+    name: string;
+  };
+  googlePlacesApiKey?: string;
+  onSignupComplete?: (submission: {
+    id: string;
+    submittedAt: string;
+  }) => void;
+  style?: LockerverseStyle;
+  theme?: "dark" | "light";
+};
+```
+
+Use `useLockerverseSignup(options)` and pass its result as `widget={widget}`.
+The hook is the only source for the client, definition, loading state, and load
+error. This entry does not import Stripe.
+
+The API, environment, community slug, and signup slug stay fixed for the
+mounted hook. To show a different signup, remount the owning component
+with a new React `key`. Theme, branding, and callbacks can change without a
+remount. `refresh()` reloads the same signup.
+
+Use the same `LockerverseStyle` tokens as payment and donate launcher. See
+[Theming](integration.md#styling) and the [live theme workbench](https://sdk.lockerverse.com/examples/theming).
+
+
+## Host integration and verification
+
+Use the saved `communitySlug`, `signupSlug`, `apiBaseUrl`, and `environment`
+from the prompt. Reuse the existing signup section and host theme. Load the
+live definition; do not hard-code fields, required flags, choices, or consent
+text. The SDK supplies loading, validation, error, and completion states.
+Show completion only through `onSignupComplete`. Do not turn this form into a
+payment flow, account signup, or a separate backend integration.
+
+Pass `googlePlacesApiKey` only when the host has an appropriate public,
+restricted browser key and address suggestions are wanted. Manual address
+entry must remain available. Never put private API keys or submitted contact
+data in page source, metadata, URLs, analytics, or logs.
+
+On an SSR host, fetch the definition through `createLockerverseSignupClient`
+from `@lockerverse/sdk/signup` and its `load()` method. Seed
+`useLockerverseSignup(options, { initialSignup })`; keep the available
+definition visible during refresh. Use the installed types for the complete
+validated snapshot. Read the shared guide for static-site constraints.
+
+Build and check the form on desktop and 390 by 844 mobile. Check keyboard access,
+required-field validation, loading and error states, and manual address entry
+when configured. Do not send a live signup submission during this check.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lockerverse/react",
-  "version": "0.2.155",
+  "version": "0.2.157",
   "description": "Tree-shakable React payment and signup UI for Lockerverse",
   "repository": {
     "type": "git",
@@ -118,13 +118,15 @@
       "types": "./dist/payment-primitives.d.ts",
       "import": "./dist/payment-primitives.js",
       "default": "./dist/payment-primitives.js"
-    }
+    },
+    "./guides/*": "./guides/*"
   },
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "guides"
   ],
   "dependencies": {
     "@base-ui/react": "1.6.0",
@@ -132,7 +134,7 @@
     "embla-carousel-react": "8.6.0",
     "lucide-react": "0.536.0",
     "valibot": "1.4.2",
-    "@lockerverse/sdk": "0.2.155"
+    "@lockerverse/sdk": "0.2.157"
   },
   "devDependencies": {
     "@size-limit/file": "13.0.3",
@@ -219,7 +221,7 @@
     }
   ],
   "scripts": {
-    "build": "tsdown",
+    "build": "node ../../scripts/build-integration-guides.mjs && tsdown",
     "pack:check": "pnpm build && pnpm pack --dry-run",
     "size": "size-limit",
     "pretest": "pnpm --filter @lockerverse/sdk build",