@obul.ai/sdk 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,79 @@
+# @obul.ai/sdk
+
+Single-package Obul BFF SDK facade with browser client, server core, and framework adapters.
+
+## What is a BFF?
+BFF stands for **Backend For Frontend**. It's a small server that sits between your browser app and Obul's APIs. The browser only talks to your BFF, and the BFF handles OAuth, token storage, session cookies, and proxying API calls. This keeps secrets and tokens off the client and lets you enforce auth, rate limits, and request policies in one place.
+
+## Install
+```bash
+npm install @obul.ai/sdk
+```
+
+## Exports
+- `@obul.ai/sdk/browser` (browser client)
+- `@obul.ai/sdk/server` (server core)
+- `@obul.ai/sdk/adapters/express`
+- `@obul.ai/sdk/adapters/next`
+- `@obul.ai/sdk/adapters/hono`
+- `@obul.ai/sdk/adapters/cloudflare`
+
+## Example integrations
+
+### Express (BFF server)
+```js
+import express from "express"
+import { createObulExpressRouter } from "@obul.ai/sdk/adapters/express"
+
+const app = express()
+const router = createObulExpressRouter({
+  issuerUrl: process.env.OBUL_ISSUER_URL,
+  authEndpoint: process.env.OBUL_AUTH_ENDPOINT,
+  tokenEndpoint: process.env.OBUL_TOKEN_ENDPOINT,
+  revocationEndpoint: process.env.OBUL_REVOCATION_ENDPOINT,
+  apiBaseUrl: process.env.OBUL_API_BASE_URL,
+  clientId: process.env.OBUL_CLIENT_ID,
+  clientSecret: process.env.OBUL_CLIENT_SECRET,
+  redirectUri: process.env.OBUL_REDIRECT_URI,
+  scopes: (process.env.OBUL_SCOPES ?? "openid profile email").split(" ")
+})
+
+app.use(router)
+app.listen(3000)
+```
+
+### React / Vite (browser client)
+```ts
+import { createObulClient } from "@obul.ai/sdk/browser"
+
+const obul = createObulClient({
+  baseUrl: "", // BFF origin, if different from the browser origin
+  postLoginRedirect: window.location.href,
+  postLogoutRedirect: "/",
+  sessionCheckIntervalMs: 10_000
+})
+
+// Example: trigger login
+obul.signIn()
+```
+
+### Next.js (App Router, client component)
+```tsx
+"use client"
+
+import { useEffect, useMemo } from "react"
+import { createObulClient } from "@obul.ai/sdk/browser"
+
+export function ObulLoginButton() {
+  const obul = useMemo(() => createObulClient({ baseUrl: "" }), [])
+
+  useEffect(() => {
+    obul.getSession().catch(() => {})
+  }, [obul])
+
+  return <button onClick={() => obul.signIn()}>Sign in</button>
+}
+```
+
+## Repo
+See the repo for the Express example and additional docs.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@obul.ai/sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Single-package Obul BFF SDK facade with browser client, server core, and framework adapters.",
   "type": "module",
   "main": "dist/index.js",
@@ -40,7 +40,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "sideEffects": false,
   "scripts": {
@@ -54,10 +55,18 @@
     "next": ">=13.0.0"
   },
   "peerDependenciesMeta": {
-    "cookie-parser": { "optional": true },
-    "express": { "optional": true },
-    "hono": { "optional": true },
-    "next": { "optional": true }
+    "cookie-parser": {
+      "optional": true
+    },
+    "express": {
+      "optional": true
+    },
+    "hono": {
+      "optional": true
+    },
+    "next": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@types/cookie-parser": "^1.4.7",