Brandapp Sdk Install

Brandapp SDK Install

> This is NOT the SDK you know. Read node_modules/@reopt-ai/brandapp-sdk/docs/ before writing code (the package ships docs at top-level docs/, not dist/docs/). Heed deprecation notices — 2.0 renamed every env var without aliases; 3.0 rewrote the webhook contract and blocks clientSecret in the browser (read docs/migration.md).

When to apply

A consumer project adopting @reopt-ai/brandapp-sdk for the first time. Triggers: "install", "init", "setup", "bootstrap", "apply SDK", "brandapp integration" against @reopt-ai/brandapp-sdk.

Step 1 — Pin agent rules into AGENTS.md / CLAUDE.md

Source of truth for the rules block: the module's own agent-rules file, once it ships one. @reopt-ai/brandapp-sdk does not ship one as of 3.1.0, so use the fallback agent-rules.md bundled with this skill.

Append to the consumer's AGENTS.md (fall back to CLAUDE.md if AGENTS.md is absent — never both). Wrap the content between:

…content from source above…

Idempotent: if the markers already exist, replace only the content between them. Never touch text outside the markers — the consumer's own rules live there.

Step 2 — Consumer-side setup (this skill owns; docs cannot)

These are properties of the consumer project, not the module. They will not appear in the module's docs/.

1. Public npm registry — no token or scoped .npmrc entry is required. Inspect the project .npmrc and npm config get @reopt-ai:registry; if the scope still resolves to GitHub Packages, remove only the legacy project entry @reopt-ai:registry=https://npm.pkg.github.com before installing. Preserve unrelated registry/auth settings, and ask before changing user/global npm config.

1. Env namespace (2.0+) — 3 tiers, no aliases for renamed vars:

| Prefix | Owner | Purpose | |---|---|---| | BRANDAPP_* | Consumer | Credentials (BRANDAPP_CLIENT_ID/SECRET, BRANDAPP_ID, BRANDAPP_WEBHOOK_SECRET) | | REOPT_* | Platform | Host overrides only (REOPT_BASE_URL, REOPT_ID_BASE_URL) | | BRANDAPP_SDK_* | Consumer | Behavior toggles (BRANDAPP_SDK_DEBUG, BRANDAPP_SDK_LOG_FORMAT) | | NEXT_PUBLIC_BRANDAPP_* | Browser | Public subset (e.g. NEXT_PUBLIC_BRANDAPP_EAV_HASH) |

Pre-2.0 REOPT_CLIENT_* / REOPT_BRANDAPP_ID / REOPT_WEBHOOK_SECRET / REOPT_SDK_* are gone. Migrate .env before bumping.

3.0 — no clientSecret in the browser. NEXT_PUBLIC_BRANDAPP_CLIENT_SECRET is forbidden; createReoptSDK / createBrandappProvider throw CONFIG_BROWSER_SECRET if a clientSecret reaches a browser. Client-side SDK: mint a short-lived scoped token server-side (POST /api/v1/brandapp/{id}/token/mint) and construct with { brandappId, token } (token-only config — clientId/clientSecret optional when token is set). Server-side clientId+clientSecret is unchanged.

1. Peer deps — better-auth is required when using Auth. Optional: @ai-sdk/provider, @tanstack/react-query.

1. Optional dev-mode bootstrap — npx @reopt-ai/cli brandapp init scaffolds the offline dev server (see reopt-brandapp skill). It does not create .env.local, lib/sdk.ts, lib/auth.ts, auth route handler, or webhook route — those remain this skill's responsibility.

Step 3 — Route to module docs

For everything else (code generation, API surface, version-specific behavior, error handling), route to module docs. Do not duplicate API surface here — read the file. Module docs are pinned to the installed version; this skill is not.

Paths are relative to node_modules/@reopt-ai/brandapp-sdk/docs/. api-reference.md is the combined surface (SDK init, Auth, EAV, webhooks, service token, React hooks); the rest are topic files.

| Task signal | Read | |---|---| | SDK init (createReoptSDK / createLazySDK, lib/sdk.ts; token-only client config), Better Auth + OAuth (lib/auth.ts), EAV (defineEntity / defineSchema, linkedTo, drift hash, backfill), webhooks (createWebhookHandler, verifySignature(timestamp, body, signature, secret), toleranceMs, contactCreated/workflowRun* events — 3.0 contract), service token (Authorization: Bearer, 1.12+), React hooks, AI (sdk.ai.models() / sdk.ai.stream, useAiStream, useAiAgents) | docs/api-reference.md | | Env vars + 3-tier namespace, host split (brand.reopt.ai / id.reopt.ai) | docs/environment.md | | Error classes / codes (AuthError, ForbiddenError, AuthUserRecordExistsError, LimitExceededError, CreditLimitError 402, ModelAccessError 403, ModelNotFoundError 404, ContentFilterError 422, RequiredTermsError 422 (3.1), LIVE_MODE_UNSUPPORTED 409 (3.1), CONFIG_BROWSER_SECRET, QUERY_TOO_LARGE; isReoptSDKError / isCreditLimitError / isModelAccessError / isRequiredTermsError) | docs/errors.md | | Plans catalog + hosted checkout (3.1: plans.createCheckout / getCheckout / cancel, sandbox vs live LIVE_MODE_UNSUPPORTED, RequiredTermsError → terms.list/consent retry) — not yet in docs/ | @reopt-ai/brandapp-sdk/plans types (dist/plans/index.d.ts) | | Marketing site / CMS (toMetadata, toSitemapItems, toRssFeed, verifySession, optimizeUrl; cms is read-only from 1.8+) | docs/cms.md | | File upload / management | docs/files.md | | Dev server (createDevServer, instrumentation.ts, offline development) | docs/dev-server.md | | Version migration / breaking changes | docs/migration.md | | Testing the integration | docs/testing.md |

Safety

• Do not add GitHub Packages auth for @reopt-ai/*; the packages are public on npm. Remove only the legacy project-level scope override and preserve unrelated registry settings.
• Never put NODE_TLS_REJECT_UNAUTHORIZED=0 in .env — script-scope only.
• BRANDAPP_ID is the brandappId (app), not the brandId (brand).
• BETTER_AUTH_URL must match the browser-facing origin exactly.
• createReoptAdapter / createReoptOAuth / createReoptBetterAuth throw in browser runtimes — keep behind import "server-only".
• Never pass clientSecret (or the webhook secret) into client bundles — 3.0 throws CONFIG_BROWSER_SECRET; use a server-minted { token } client-side.
• The in-memory dev server refuses to start under NODE_ENV=production (3.0); only override with REOPT_DEV_SERVER_ALLOW_PRODUCTION=1 for deliberate offline tests, never a real deploy.

Verify

1. npx tsc --noEmit passes.
2. (Auth) curl -I http://localhost:3000/api/auth/ok → 200.
3. (Any module) await sdk.eav.entities.list() succeeds from a server component. 401 → credentials. 404 → BRANDAPP_ID.
4. (Optional) mirror apps/brandapp-playground/app/health/ for a 12-probe deploy check.

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: reopt-ai
• Source: reopt-ai/reopt-skills
• License: MIT
• Homepage: https://skills.sh/reopt-ai/reopt-skills

Install and usage instructions live in the source repository linked above.