@terreno/mcp 0.23.0 → 0.24.0

package/src/docs/versioned/0.23.0/implementationPlans/terreno-langfuse-integration.md

@@ -0,0 +1,145 @@
+# @terreno/langfuse
+
+A TerrenoApp plugin that integrates [Langfuse](https://langfuse.com) into Terreno backends and frontends. Provides prompt management with MongoDB caching, OpenTelemetry tracing, Vercel AI SDK helpers, React hooks, and an admin UI — all wired up via `.install()`.
+
+> **Prerequisite:** This package relies on the new TerrenoApp plugin system (see [PR #149](https://github.com/FlourishHealth/terreno/pull/149)). TerrenoApp must support `.install()` before this package can be used.
+
+## Why
+
+LLM apps need prompt versioning, observability, and iteration tools. Langfuse provides all of this, but integrating it requires boilerplate (client setup, caching, tracing config, admin endpoints). This package eliminates that — one `.install()` call on the backend, one `<Provider>` on the frontend.
+
+## Architecture
+
+```
+Backend (.install)                    Frontend (<Provider>)
+─────────────────                     ────────────────────
+• Langfuse client init                • usePrompt(name) → cached prompt
+• MongoDB prompt cache (via Mongoose) • usePrompts() → list all
+• OpenTelemetry tracing setup         • useTrace() → telemetry helpers
+• Admin API routes (/api/prompts,     • useEvaluation() → submit scores
+  /api/traces, /api/playground)       • Admin UI pages (prompts, traces,
+• Vercel AI SDK helpers                 playground, dashboard)
+```
+
+The backend proxies Langfuse's API behind authenticated admin routes. The frontend talks to those routes, never directly to Langfuse. MongoDB sits in front of all prompt fetches with configurable TTL, reusing the existing Mongoose connection from `@terreno/api`.
+
+## Data Models
+
+```typescript
+interface LangfuseAppOptions {
+  secretKey: string;
+  publicKey: string;
+  baseUrl?: string;              // default: Langfuse Cloud EU
+  adminPath?: string;            // default: '/admin/langfuse'
+  enableAdminUI?: boolean;       // default: true
+  enableTracing?: boolean;       // default: true
+  serviceName?: string;          // default: 'terreno-app'
+  cache?: {
+    promptTtlSeconds?: number;   // default: 60
+    traceTtlSeconds?: number;    // default: 300
+  };
+  evaluation?: {
+    enabled?: boolean;
+    scoringFunctions?: ScoringFunction[];
+  };
+}
+
+interface ScoringFunction {
+  name: string;
+  description: string;
+  scoreType: 'numeric' | 'categorical' | 'boolean';
+  categories?: string[];
+  range?: { min: number; max: number };
+}
+```
+
+## Package Structure
+
+```
+langfuse/src/
+├── backend/
+│   ├── LangfuseApp.ts       # TerrenoApp plugin class (.install entry point)
+│   ├── client.ts             # Langfuse SDK wrapper (singleton)
+│   ├── cache.ts              # Mongoose model for cached entries with TTL index
+│   ├── prompts.ts            # getPrompt, compilePrompt (cache-first → Langfuse fallback)
+│   ├── tracing.ts            # NodeSDK + LangfuseSpanProcessor setup/shutdown
+│   ├── vercel-ai.ts          # preparePromptForAI(), createTelemetryConfig()
+│   ├── types.ts
+│   └── routes/
+│       ├── prompts.ts        # CRUD + cache invalidation
+│       ├── traces.ts         # List/view traces
+│       ├── playground.ts     # Compile + test prompts
+│       └── evaluations.ts    # Submit/retrieve scores (optional)
+├── frontend/
+│   ├── LangfuseProvider.tsx  # React context (apiBaseUrl, publicKey)
+│   ├── hooks/                # usePrompt, usePrompts, useTrace, useEvaluation
+│   ├── components/           # PromptEditor, PromptPlayground, TraceViewer, EvaluationForm
+│   └── pages/                # PromptsPage, DashboardPage, TracesPage, PlaygroundPage
+└── index.ts                  # Re-exports everything (backend + frontend)
+```
+
+## Implementation Phases
+
+### Phase 1: Core package ✅ COMPLETED
+Package scaffold (`package.json`, `tsconfig.json`, `index.ts` re-exports), Langfuse client singleton with Cloud EU/US and self-hosted URL support, MongoDB cache layer (Mongoose model with TTL index on `expiresAt` for automatic expiry — no Redis needed, reuses the existing Mongoose connection), prompt management (`getPrompt` cache-first with Langfuse fallback, `compilePrompt` with `{{variable}}` interpolation, write-through `createPrompt`/`updatePromptLabels` with cache invalidation), OpenTelemetry tracing (`@opentelemetry/sdk-node` + `LangfuseSpanProcessor`), Vercel AI SDK helpers (`preparePromptForAI` returning `{ prompt, telemetry, config }`), the `LangfuseApp` plugin class (`.install()` wires up client + cache + tracing + admin routes + `res.locals.langfuse`, `.shutdown()` for cleanup), React hooks (`usePrompt`, `usePrompts`, `useTrace`, `useEvaluation` — all talking to admin API routes, never Langfuse directly), and `LangfuseProvider`. Peer deps on `@terreno/api`, `@terreno/ui`, `react`, and optional `ai` (Vercel AI SDK).
+
+### Phase 2: Admin UI ✅ COMPLETED
+Built with `@terreno/ui` components. Pages: prompt list, prompt detail/editor, playground (compile + test with LLM), trace explorer, dashboard with counts. Components are also exported individually for embedding in custom admin pages.
+
+## Usage
+
+```typescript
+// Backend — one line to install
+TerrenoApp.create({ ... })
+  .install(LangfuseApp, {
+    secretKey: process.env.LANGFUSE_SECRET_KEY!,
+    publicKey: process.env.LANGFUSE_PUBLIC_KEY!,
+  })
+  .start();
+
+// Backend — use in route handlers
+const { prompt, telemetry, config } = await preparePromptForAI({
+  promptName: 'answer-question',
+  variables: { query },
+  userId,
+});
+const result = await generateText({ model, prompt, ...config, experimental_telemetry: telemetry });
+
+// Frontend — wrap app
+<LangfuseProvider apiBaseUrl="/admin/langfuse/api">
+  <App />
+</LangfuseProvider>
+
+// Frontend — use hooks
+const { prompt, compile, isLoading } = usePrompt('chat-assistant');
+```
+
+## Key Decisions
+
+- **MongoDB is used for caching** via a Mongoose model with a TTL index. No Redis dependency — reuses the existing Mongoose connection from `@terreno/api`, keeping infrastructure simple.
+- **Frontend never talks to Langfuse directly.** All access goes through the backend admin routes, keeping keys server-side.
+- **Evaluation is opt-in** via `evaluation.enabled`. Scoring functions are configured at install time.
+- **Vercel AI SDK is an optional peer dep.** The `preparePromptForAI` helper is the primary integration point.
+
+## Dependencies
+
+| Package | Purpose |
+|---------|---------|
+| `langfuse` | Langfuse Node.js SDK (client, prompts, scoring) |
+| `@langfuse/otel` | Langfuse OpenTelemetry span processor |
+| `@opentelemetry/sdk-node` | OpenTelemetry Node SDK |
+| `mongoose` | MongoDB ODM (peer dep from @terreno/api) |
+
+## Files to Modify Outside This Package ✅ COMPLETED
+
+- **Root `package.json`**: Add `langfuse` to workspaces, add deps to catalog ✅
+- **`api/src/TerrenoApp.ts`**: TerrenoPlugin interface already supported via `register()` ✅
+- **`example-backend/`** and **`example-frontend/`**: Usage examples added ✅
+
+## References
+
+- [Langfuse TypeScript SDK](https://langfuse.com/docs/observability/sdk/typescript/overview)
+- [Langfuse Prompt Management](https://langfuse.com/docs/prompt-management/get-started)
+- [Vercel AI SDK Integration](https://langfuse.com/integrations/frameworks/vercel-ai-sdk)
+- [TypeScript SDK v4](https://langfuse.com/changelog/2025-08-28-typescript-sdk-v4-ga)
+- [TerrenoApp PR #149](https://github.com/FlourishHealth/terreno/pull/149)

package/src/docs/versioned/0.23.0/implementationPlans/upgrade-banner.md

@@ -0,0 +1,275 @@
+# Implementation Plan: Upgrade Banner
+
+*When an engineer is assigned to a project but before you begin coding, you should fill in the implementation plan and get feedback from the engineering team. Once you have finished or you make any changes, tag Josh with the @ symbol so he can review. Also tag anyone else that needs to be notified, has conflicting work, etc.*
+
+## Models
+
+### VersionConfig (new, singleton)
+
+```typescript
+// api/src/models/versionConfig.ts
+
+import {createdUpdatedPlugin} from "../plugins";
+import mongoose from "mongoose";
+
+const versionConfigSchema = new mongoose.Schema<VersionConfigDocument>(
+  {
+    webWarningVersion: {
+      type: Number,
+      default: 0,
+      description: "Build number at which web users see a warning toast",
+    },
+    webRequiredVersion: {
+      type: Number,
+      default: 0,
+      description: "Build number at which web users are blocked from using the app",
+    },
+    mobileWarningVersion: {
+      type: Number,
+      default: 0,
+      description: "Build number at which mobile users see a warning toast",
+    },
+    mobileRequiredVersion: {
+      type: Number,
+      default: 0,
+      description: "Build number at which mobile users are blocked from using the app",
+    },
+    warningMessage: {
+      type: String,
+      default: "A new version is available. Please update for the best experience.",
+      description: "Message shown in the warning toast",
+    },
+    requiredMessage: {
+      type: String,
+      default: "This version is no longer supported. Please update to continue.",
+      description: "Message shown on the blocking screen",
+    },
+    updateUrl: {
+      type: String,
+      description: "App store or download URL for mobile updates (optional, falls back to expo-updates)",
+    },
+  },
+  { strict: "throw", toJSON: { virtuals: true }, toObject: { virtuals: true } }
+);
+
+versionConfigSchema.plugin(createdUpdatedPlugin);
+```
+
+**Key design points:**
+- Singleton — only one document in the collection
+- All version fields default to `0` (meaning "no constraint"), so the check returns "ok" until an admin configures thresholds
+- Per-platform version thresholds (web vs mobile), shared messages
+- `updateUrl` is optional — mobile falls back to expo-updates OTA
+
+## APIs
+
+### 1. Version Check (public, built-in)
+
+| | |
+|---|---|
+| Method | `GET /version-check` |
+| Auth | None (public) |
+| Query Params | `version` (integer build number), `platform` ("web" \| "mobile") |
+| Response | `{status: "ok" \| "warning" \| "required", message?: string, updateUrl?: string}` |
+| Notes | Requires explicit registration via `VersionCheckPlugin` (e.g., `app.register(new VersionCheckPlugin())`). Returns `{status: "ok"}` if no VersionConfig document exists. |
+
+**Logic:**
+```
+if platform version < requiredVersion → status: "required", message: requiredMessage, updateUrl
+else if platform version < warningVersion → status: "warning", message: warningMessage, updateUrl
+else → status: "ok"
+```
+
+### 2. Admin: Get Version Config
+
+| | |
+|---|---|
+| Method | `GET /admin/version-config` |
+| Auth | `Permissions.IsAdmin` |
+| Response | The singleton VersionConfig document (or defaults if none exists) |
+
+### 3. Admin: Update Version Config
+
+| | |
+|---|---|
+| Method | `PUT /admin/version-config` |
+| Auth | `Permissions.IsAdmin` |
+| Body | All VersionConfig fields |
+| Response | Updated VersionConfig document |
+| Notes | Upsert — creates if doesn't exist, updates if it does. |
+
+Custom routes (not modelRouter) since it's a singleton — no list, no delete, no `:id` params.
+
+## Notifications
+
+No notifications required for this feature. The upgrade system is passive — it checks on app mount and shows in-app UI only.
+
+## UI
+
+### Component 1: `UpgradeRequiredScreen` (new, `@terreno/ui`)
+
+- Full-screen page with centered content
+- Warning icon, the `requiredMessage` text, and an "Update" button
+- Update button behavior controlled by `onUpdate` callback prop:
+  - **Web:** calls `window.location.reload()`
+  - **Mobile:** attempts `expo-updates` OTA → falls back to opening `updateUrl` via `Linking`
+- No back button, no navigation, no dismiss — user is stuck here
+- Props: `message: string`, `onUpdate: () => void`
+
+### Component 2: `useUpgradeCheck` hook (new, `@terreno/rtk`)
+
+- Called in consuming app's root layout
+- On mount: `GET /version-check?version={buildNumber}&platform={web|mobile}`
+- If `"warning"`: shows persistent toast with message + "Update" action button
+- If `"required"`: returns a flag for the consuming app to render `UpgradeRequiredScreen`
+- Returns: `{isRequired: boolean, requiredMessage?: string, onUpdate: () => void}`
+- Skips check if build number is missing/unknown (dev environment)
+- `onUpdate` handles platform logic: web refresh, mobile expo-updates or Linking to updateUrl
+
+### Component 3: Admin Version Config Screen (new, `@terreno/admin-frontend`)
+
+- Form with fields: webWarningVersion, webRequiredVersion, mobileWarningVersion, mobileRequiredVersion, warningMessage, requiredMessage, updateUrl
+- Single "Save" button that PUTs the singleton
+- Accessible from the admin model list as a special entry
+
+### Navigation Flow
+
+```
+App mounts → useUpgradeCheck() fires
+  → "ok"       → normal app
+  → "warning"  → normal app + persistent toast with "Update" button + dismiss X
+  → "required" → UpgradeRequiredScreen (blocks everything)
+```
+
+## Phases
+
+### Phase 1: Backend + Admin
+
+- VersionConfig Mongoose model in `@terreno/api`
+- `GET /version-check` public endpoint via `VersionCheckPlugin`
+- `GET/PUT /admin/version-config` admin routes
+- Admin frontend screen for version config
+- Unit tests for the version check logic
+- Example backend wired up
+
+**Deliverable:** Admin can configure version thresholds and the public endpoint responds correctly.
+
+### Phase 2: Client + CI
+
+- `UpgradeRequiredScreen` component in `@terreno/ui`
+- `useUpgradeCheck` hook in `@terreno/rtk`
+- `app.config.ts` helper for build number injection via `expo.extra.buildNumber`
+- Example frontend wired up with the hook
+- GitHub Actions snippet for `git rev-list --count HEAD`
+
+**Deliverable:** Client apps can check version on mount and show warning toast or blocking screen.
+
+## Feature Flags & Migrations
+
+- **No feature flag needed.** The system is inert by default — the endpoint returns `"ok"` until an admin creates a VersionConfig document with non-zero thresholds.
+- **No data migration needed.** New model, new collection, starts empty.
+- **Rollout:** Ship it. Apps that don't call `useUpgradeCheck()` are unaffected.
+
+## Activity Log & User Updates
+
+No activity logging needed for this feature. Version config changes are admin-only and low-frequency.
+
+## Not Included / Future Work
+
+- Per-user or per-role version targeting
+- Gradual rollout / percentage-based enforcement
+- Push notifications for version updates
+- Automatic semver bumping (stays manual via git tags)
+- Periodic polling (only checks on mount for now)
+- Per-app configs for multi-frontend backends
+- Version check middleware on every API response
+- Analytics on how many users are on which versions
+
+
+# Research: Terreno Upgrade Banner System
+
+## Summary
+
+The Terreno codebase already sends `App-Version` and `App-Platform` headers with every API request via RTK's base query. Building an upgrade banner system requires: (1) a backend model + built-in endpoint for version config, (2) admin screens to manage it, (3) a client hook + prebuilt UI, and (4) CI automation for commit-count-based versioning. The existing `AdminApp` plugin pattern, `Banner` component, toast system, and `Page` component provide strong foundations to build on.
+
+## Context
+
+- **Problem:** No mechanism to notify users their app is outdated. Stale clients can hit deprecated APIs or miss critical fixes.
+- **Current state:** RTK already sends `App-Version` (from `Constants.expoConfig?.version`) and `App-Platform` ("web"/"mobile") on every request (`rtk/src/emptyApi.ts:164-177`). But nothing consumes these headers or enforces version constraints.
+- **Goal:** Two-tier system — soft warning (dismissible toast/banner) and hard block (full-screen, no dismiss). Admin-configurable. Auto-versioned via CI.
+
+## Decisions
+
+- **Per-platform config:** Yes — separate thresholds for web vs mobile since web can force-refresh but mobile needs app store update.
+- **Update mechanism:** Platform-specific — web forces page refresh, mobile triggers expo-updates OTA if available, falls back to app store link.
+- **Endpoint location:** `VersionCheckPlugin` registered with `TerrenoApp` — opt-in per app.
+- **Config storage:** Mongoose model (database-backed) so admins can change without redeploy.
+
+## Findings
+
+### Finding 1: Existing Version Infrastructure in RTK
+
+`rtk/src/emptyApi.ts:164-177` — Every API request already includes:
+```typescript
+const version = Constants.expoConfig?.version ?? "Unknown";
+headers.set("App-Version", version);
+headers.set("App-Platform", IsWeb ? "web" : "mobile");
+```
+
+The version comes from `expo-constants` → `app.json`'s `version` field. Currently `example-frontend/app.json` has `"version": "1.0.0"`.
+
+### Finding 2: Admin Backend Plugin Pattern
+
+`admin-backend/src/adminApp.ts` — The `AdminApp` class provides the pattern:
+- Constructor takes config, `register(app)` adds routes to Express
+- Uses `modelRouter` with `Permissions.IsAdmin` for all CRUD
+- Exposes a `/admin/config` metadata endpoint
+
+### Finding 3: Admin Frontend Patterns
+
+`admin-frontend/` uses a data-driven approach:
+- `useAdminConfig(api, baseUrl)` fetches model metadata
+- `useAdminApi(api, routePath, modelName)` generates CRUD hooks dynamically
+- All screens accept `baseUrl` and `api` props
+- For upgrade config, we need a custom admin screen (singleton config, not a collection)
+
+### Finding 4: UI Components Available
+
+**Banner** (`ui/src/Banner.tsx`) — status variants, persistent dismiss, action button
+**Toast** (`ui/src/Toast.tsx`) — `useToast()` with warn/info/error variants, persistent mode
+**Page** (`ui/src/Page.tsx`) — Full-screen layout for the blocking screen
+**Modal** (`ui/src/Modal.tsx`) — Dialog, but Page is better for hard block (zero escape)
+
+### Finding 5: GitHub Actions & Versioning
+
+Current flow: manual git tag → `publish-on-tag.yml` → selective npm publish.
+No existing build number system. `app.json` version is static.
+`git rev-list --count HEAD` provides simple, monotonically increasing build numbers.
+
+### Finding 6: RTK Store Integration
+
+`example-frontend/store/index.ts` — store combines auth, appState, API reducers.
+`_layout.tsx` checks auth state and routes conditionally — upgrade check follows same pattern.
+
+## Recommendation
+
+**Add to core packages** — spread across:
+- `@terreno/api` — VersionConfig model + public `GET /version-check` endpoint (via `VersionCheckPlugin`)
+- `@terreno/admin-frontend` — Custom admin screen for version config
+- `@terreno/rtk` — `useUpgradeCheck` hook
+- `@terreno/ui` — `UpgradeRequiredScreen` blocking component
+
+**Versioning:** `git rev-list --count HEAD` as integer build number. Helper in CI to set `expo.version` at build time.
+
+**API:** `GET /version-check?version=123&platform=web` — public, no auth. Returns `{status: "ok" | "warning" | "required", message?, updateUrl?}`.
+
+## References
+
+- `rtk/src/emptyApi.ts:164-177` — Existing App-Version header
+- `admin-backend/src/adminApp.ts` — Plugin registration pattern
+- `admin-frontend/src/useAdminApi.tsx` — Dynamic RTK hook generation
+- `ui/src/Banner.tsx` — Banner component
+- `ui/src/Toast.tsx` — Toast notification system
+- `ui/src/Page.tsx` — Full-screen page layout
+- `example-frontend/app/_layout.tsx` — Root layout with auth routing
+- `.github/workflows/publish-on-tag.yml` — Current CI/CD versioning

package/src/docs/versioned/0.23.0/reference/README.md

@@ -0,0 +1,22 @@
+# Reference
+
+Technical reference for Terreno packages and APIs. Information-oriented, precise descriptions.
+
+## Packages
+
+- [@terreno/api](api.md) — modelRouter, auth, permissions, setupServer
+- [@terreno/ui](ui.md) — Components, theming, layout
+- [@terreno/rtk](rtk.md) — Auth slice, SDK codegen, token handling
+- [@terreno/admin-backend](admin-backend.md) — Auto-generated admin CRUD endpoints
+- [@terreno/admin-frontend](admin-frontend.md) — Admin panel UI components
+- [@terreno/feature-flags](feature-flags.md) — Feature flags and A/B testing plugin
+- [@terreno/mcp](mcp-server.md) — AI coding assistant integration (MCP)
+
+## Configuration
+
+- [Environment Variables](environment-variables.md) — Complete environment variable reference for all packages
+
+## Other references
+
+- Root [package.json](https://github.com/flourishhealth/terreno/blob/master/package.json) — Workspace scripts and catalog
+- Per-package `package.json` in each package directory — Commands and dependencies

package/src/docs/versioned/0.23.0/reference/admin-backend.md

@@ -0,0 +1,122 @@
+# @terreno/admin-backend
+
+Backend plugin that auto-generates admin CRUD endpoints for Mongoose models. Works with `@terreno/admin-frontend` to provide a complete admin panel solution.
+
+## Quick Start
+
+``````typescript
+import {AdminApp} from "@terreno/admin-backend";
+import {User, Todo} from "./models";
+
+const admin = new AdminApp({
+  basePath: "/admin",
+  models: [
+    {
+      model: User,
+      routePath: "/users",
+      displayName: "Users",
+      listFields: ["email", "name", "admin"],
+      defaultSort: "-created",
+    },
+    {
+      model: Todo,
+      routePath: "/todos",
+      displayName: "Todos",
+      listFields: ["title", "completed", "ownerId"],
+    },
+  ],
+});
+
+admin.register(app);
+``````
+
+This creates:
+- `GET /admin/config` — Model metadata endpoint
+- Standard CRUD routes for each model at `{basePath}{routePath}`
+- All routes protected with `Permissions.IsAdmin`
+
+## AdminApp Options
+
+``````typescript
+interface AdminOptions {
+  models: AdminModelConfig[];
+  basePath?: string;  // Default: "/admin"
+}
+
+interface AdminModelConfig {
+  model: Model<any>;
+  routePath: string;      // e.g., "/users"
+  displayName: string;    // e.g., "Users"
+  listFields: string[];   // Fields shown in table
+  defaultSort?: string;   // Default: "-created"
+}
+``````
+
+## Generated Routes
+
+For each model, creates standard modelRouter CRUD endpoints:
+
+- `GET {basePath}{routePath}` — List (paginated, sortable)
+- `POST {basePath}{routePath}` — Create
+- `GET {basePath}{routePath}/:id` — Read
+- `PATCH {basePath}{routePath}/:id` — Update
+- `DELETE {basePath}{routePath}/:id` — Delete
+
+## Config Endpoint
+
+`GET {basePath}/config` returns metadata for all registered models:
+
+``````typescript
+{
+  models: [
+    {
+      name: "User",
+      routePath: "/admin/users",
+      displayName: "Users",
+      listFields: ["email", "name", "admin"],
+      defaultSort: "-created",
+      fields: {
+        email: {
+          type: "string",
+          required: true,
+          description: "User email address"
+        },
+        admin: {
+          type: "boolean",
+          required: false,
+          default: false
+        }
+      }
+    }
+  ]
+}
+``````
+
+Field metadata includes:
+- `type` — Field type (string, number, boolean, date, objectid, etc.)
+- `required` — Whether field is required
+- `description` — From schema (ensure all fields have descriptions!)
+- `enum` — Enum values if applicable
+- `default` — Default value
+- `ref` — Referenced model name for ObjectId refs
+
+## Permissions
+
+All admin routes use `Permissions.IsAdmin`, which checks `user.admin === true`.
+
+**Important:** Only expose models that should be editable via admin panel. Avoid sensitive internal models.
+
+## Best Practices
+
+- Add `description` to all model fields — flows through to admin UI
+- Use `listFields` to control which columns appear in table views
+- Set `defaultSort` to control initial ordering (usually `"-created"`)
+- Keep `routePath` simple and pluralized (`"/users"`, `"/todos"`)
+
+## Integration
+
+Works seamlessly with `@terreno/admin-frontend`. The frontend uses the `/admin/config` endpoint to:
+- Discover available models
+- Generate forms with proper field types
+- Render references as clickable links
+- Validate required fields