@stage5/lumine 0.1.0 → 0.1.1

package/README.md

@@ -28,11 +28,12 @@ unpublished changes. For projects you own, run `lumine launch` to publish the
 saved changes, or `lumine save --publish` to save and publish in one step.
 
 Pulled workspaces include `AGENTS.md` and `CLAUDE.md` guides for local coding
-agents, plus `.twinkle/lumine-project.json` metadata that tells agents whether
-the checkout is writable, publishable, or a contribution branch. These guide
-files are not uploaded by `lumine save`. Build apps run in sandboxed iframes
-without native form submission, so use JavaScript-handled inputs and buttons
-instead of `<form>` elements.
+agents, `TWINKLE_BUILD_SDK.md` with the current Build SDK reference, plus
+`.twinkle/lumine-project.json` metadata that tells agents whether the checkout
+is writable, publishable, or a contribution branch. These guide files are not
+uploaded by `lumine save`. Build apps run in sandboxed iframes without native
+form submission, so use JavaScript-handled inputs and buttons instead of
+`<form>` elements.
 
 After pulling a project, run an agent from the pulled folder:
 

package/bin/lumine.js

@@ -19,9 +19,36 @@ const PROJECT_METADATA_DIR = ".twinkle";
 const PROJECT_METADATA_FILE = "lumine-project.json";
 const DEFAULT_SAVE_SUMMARY = "Saved from Lumine CLI.";
 const EXCLUDED_UPLOAD_DIRS = new Set([".git", ".twinkle", "node_modules"]);
-const EXCLUDED_UPLOAD_FILES = new Set([".DS_Store", "AGENTS.md", "CLAUDE.md"]);
+const SDK_REFERENCE_FILE = "TWINKLE_BUILD_SDK.md";
+const EXCLUDED_UPLOAD_FILES = new Set([
+  ".DS_Store",
+  "AGENTS.md",
+  "CLAUDE.md",
+  SDK_REFERENCE_FILE,
+]);
 const LUMINE_AGENT_INSTRUCTIONS_MARKER =
   "<!-- Lumine CLI Agent Instructions -->";
+const LUMINE_SDK_REFERENCE_MARKER = "<!-- Lumine CLI SDK Reference -->";
+const BUNDLED_SDK_REFERENCE_URL = new URL(
+  "../sdk/BUILD_SDK_INDEX.md",
+  import.meta.url,
+);
+const SDK_REFERENCE_FALLBACK = `${LUMINE_SDK_REFERENCE_MARKER}
+# Twinkle Build SDK Reference
+
+The bundled SDK reference could not be loaded from this Lumine CLI package.
+
+Use these current source-of-truth rules:
+
+- Read .twinkle/lumine-project.json before editing.
+- Use Twinkle.capabilities.get() or Twinkle.capabilities.can(actionName) before relying on gated SDK calls.
+- Use Twinkle.privateDb for simple private per-user preferences, drafts, settings, and small JSON state.
+- Use Twinkle.userDb only for advanced private SQLite tables, indexes, many rows, filtered queries, or aggregates.
+- Use Twinkle.sharedDb for shared multi-user JSON data.
+- Use Twinkle.ai.chat with history entries shaped as { role, content }, not { text }.
+- Use Twinkle.preview for canvas, WebGL, Three.js, fullscreen, and game layout.
+- Prefer existing documented Twinkle.* methods over guessing names from old code.
+`;
 const LUMINE_AGENT_INSTRUCTIONS = `${LUMINE_AGENT_INSTRUCTIONS_MARKER}
 # Lumine Project Agent Guide
 
@@ -32,6 +59,7 @@ Lumine CLI as the source of truth for saving this workspace back to Twinkle.
 
 - Read .twinkle/lumine-project.json before changing files.
 - Treat build.canWrite, build.canPublish, and build.contributionRootBuildId as authoritative.
+- Read ${SDK_REFERENCE_FILE} before adding, removing, or changing any Twinkle.* SDK calls.
 - If build.canWrite is false, do not save changes.
 - If build.canPublish is false or contributionRootBuildId is set, this checkout is a contribution branch. Save only to this branch and do not run lumine launch or lumine save --publish.
 - Do not edit another local checkout to bypass branch rules.
@@ -55,11 +83,12 @@ lumine save --summary "Describe the change"
 - Build apps run in sandboxed iframes without allow-forms. Do not use <form> elements, native form submission, requestSubmit(), or browser form navigation. Build input flows with JavaScript-handled inputs and buttons instead.
 - For canvas, WebGL, Three.js, fullscreen, or game builds, use Twinkle.preview for layout. Do not size roots from 100vh, 100vw, 100dvh, 100dvw, window.innerWidth, window.innerHeight, visualViewport, or document viewport dimensions.
 - For Three.js, use import * as THREE from '/build/vendor/three/0.160.0/three.module.min.js';.
+- Do not invent or guess Twinkle.* SDK method names. Use ${SDK_REFERENCE_FILE} as the local SDK reference and prefer Twinkle.capabilities checks for gated features.
 
 ## Completion Report
 
-Report the changed files, the lumine save result, the build or branch id, and
-whether the result is published or unpublished changes.
+Report the changed files, any SDK methods used, the lumine save result, the
+build or branch id, and whether the result is published or unpublished changes.
 `;
 const AGENT_INSTRUCTION_FILES = ["AGENTS.md", "CLAUDE.md"];
 const COMMANDS = new Set([
@@ -709,6 +738,7 @@ async function pullBuildFiles({ options, auth, buildId }) {
   const dir = path.resolve(options.dir || defaultWorkspaceDir(build));
   await writeProjectFiles({ dir, files });
   await writeAgentInstructions({ dir });
+  await writeSdkReference({ dir });
   await writeProjectMetadata({
     dir,
     options,
@@ -739,6 +769,30 @@ async function writeAgentInstructions({ dir }) {
   }
 }
 
+async function writeSdkReference({ dir }) {
+  const filePath = path.join(dir, SDK_REFERENCE_FILE);
+  try {
+    const existing = await fs.readFile(filePath, "utf8");
+    if (!existing.includes(LUMINE_SDK_REFERENCE_MARKER)) {
+      return;
+    }
+  } catch (error) {
+    if (error.code !== "ENOENT") throw error;
+  }
+  await fs.writeFile(filePath, await loadSdkReference(), "utf8");
+}
+
+async function loadSdkReference() {
+  try {
+    const rawReference = await fs.readFile(BUNDLED_SDK_REFERENCE_URL, "utf8");
+    const reference = rawReference.trim();
+    if (reference) return `${LUMINE_SDK_REFERENCE_MARKER}\n${reference}\n`;
+  } catch {
+    // Fall through to the compact reference so pulled workspaces still guide agents.
+  }
+  return SDK_REFERENCE_FALLBACK;
+}
+
 async function collectProjectFiles(dir) {
   const root = path.resolve(dir);
   const files = [];
@@ -1023,6 +1077,7 @@ function printPullResult(result) {
     `Pulled ${result.fileCount} file${result.fileCount === 1 ? "" : "s"} to ${result.dir}`,
   );
   console.log(`Entry: ${entryPath}`);
+  console.log(`SDK reference: ${SDK_REFERENCE_FILE}`);
   console.log(`Next: cd ${shellQuote(result.dir)}`);
   if (build.canWrite === false) {
     console.log("This checkout is read-only for the current CLI login.");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stage5/lumine",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Command line tools for launching Lumine builds on Twinkle.",
   "type": "module",
   "bin": {
@@ -8,6 +8,7 @@
   },
   "files": [
     "bin",
+    "sdk",
     "README.md"
   ],
   "publishConfig": {

package/sdk/BUILD_SDK_INDEX.md

@@ -0,0 +1,454 @@
+# Build SDK Index
+
+Version: 1.23.0
+Updated: 2026-05-24
+Generated: 2026-05-25T00:43:05.370Z
+
+## Notes
+- This SDK is injected into Build iframes via the Build preview/runtime.
+- Widgets call SDK methods; the parent proxies to the API.
+- Data API methods require scoped tokens handled by the parent; some namespaces include write methods.
+- Use Twinkle.privateDb as the default private per-user persistence layer for preferences, drafts, settings, and small JSON state.
+- Use Twinkle.userDb only for advanced private SQLite needs such as tables, indexes, many rows, filtered queries, or aggregates.
+- Use Twinkle.leaderboards for public Build scoreboards. Signed-in viewers are ranked by Twinkle username; guests can submit with a display name.
+- Use Twinkle.sharedDb for custom shared multi-user structured data, guestbooks, votes, and append-only run history.
+- Use Twinkle.subjects.search for in-app subject pickers. Twinkle.mount remains an optional host-provided preselection/context shortcut, not a data API.
+- Use Twinkle.aiStories for read-only existing AI Story galleries, readers, quizzes, and remix tools.
+- Use Twinkle.grammarbles for public Grammarbles question-bank trainer apps and optional signed-in viewer attempt-history filtering.
+- Use Twinkle.chess for chess engine play and analysis; app code still owns chess rules, legal moves, board state, and UI.
+- Use Twinkle.world for realtime multiplayer rooms, avatar presence, movement, emotes, and lightweight actions; keep durable MMO state in sharedDb/privateDb.
+- Use Twinkle.characters.chat for real Zero/Ciel NPC dialogue with shared room context and AI Energy-aware thinking modes.
+- Twinkle.ai.chat history entries must use { role, content }; map local message.text fields to content before passing history.
+
+## Token Scopes
+files:read, user:read, users:read, dailyReflections:read, content:read, sharedDb:read, sharedDb:write, privateDb:read, privateDb:write, files:write, chat:read, chat:write, notifications:read, notifications:write, reminders:read, reminders:write
+
+## Namespaces
+
+### Twinkle.capabilities
+- async get() | scopes: none
+- async can(actionName) | scopes: none
+- async listActions() | scopes: none
+- async refresh() | scopes: none
+
+### Twinkle.viewer
+- async get() | scopes: none
+- async refresh() | scopes: none
+
+### Twinkle.preview
+- getLayout() | scopes: none
+  - Read the host preview layout and derive a fixed-world scale from layout.playfield before sizing a canvas, sprites, or mobile game UI.
+  - Example: const WORLD = { width: 360, height: 640 }; const layout = Twinkle.preview.getLayout(); const scale = Math.min(layout.playfield.width / WORLD.width, layout.playfield.height / WORLD.height);
+- reserveInsets({ top, right, bottom, left }) | scopes: none
+  - Reserve host-aware safe space for HUD bars, touch controls, or other overlays before clamping gameplay.
+  - Example: Twinkle.preview.reserveInsets({ top: 72, bottom: 120, left: 0, right: 0 });
+- setPlayfield({ x, y, width, height } | null) | scopes: none
+  - Declare the actual playable rectangle when the game area is smaller than the raw canvas.
+  - Example: Twinkle.preview.setPlayfield({ x: layout.playfield.x, y: layout.playfield.y, width: layout.playfield.width, height: layout.playfield.height });
+- reportGameplayState({ playfieldBounds?, playerBounds? } | null) | scopes: none
+  - Report live player or avatar bounds so the preview host can detect floor, wall, or out-of-bounds issues.
+  - Example: Twinkle.preview.reportGameplayState({ playerBounds: { x: player.x, y: player.y, width: player.width, height: player.height } });
+- getGameplayTelemetry() | scopes: none
+  - Read the latest preview-side gameplay telemetry snapshot.
+- clearGameplayState() | scopes: none
+- clearReservedInsets() | scopes: none
+- subscribe(listener, { immediate } = {}) | scopes: none
+  - Listen for host layout changes so a fixed-world game scale or canvas surface stays synced after resize, mobile viewport changes, or embedded runtime layout shifts.
+  - Example: const unsubscribe = Twinkle.preview.subscribe((layout) => syncGameLayout(layout), { immediate: true });
+
+### Twinkle.mount
+- async get() | scopes: none
+- async refresh() | scopes: none
+
+### Twinkle.notifications
+- getLaunchTarget() | scopes: none
+  - Read the current notification launch target, if the app was opened from a Build notification.
+- onLaunchTarget(listener, { immediate } = {}) | scopes: none
+  - Listen for notification launch targets while the Build app is already open.
+  - Example: const off = Twinkle.notifications.onLaunchTarget((launchTarget) => focusEntry(launchTarget?.target?.focus?.entryId));
+- async getSubjectUpdateSubscription(subjectId) | scopes: notifications:read
+  - Read whether the current viewer is subscribed to Build notifications for updates to a subject.
+  - Example: const { subscription } = await Twinkle.notifications.getSubjectUpdateSubscription(subjectId);
+- async subscribeToSubjectUpdates(subjectId, { target } = {}) | scopes: notifications:write
+  - Subscribe the current viewer to notifications when the original subject author adds a new page or update.
+  - Example: await Twinkle.notifications.subscribeToSubjectUpdates(subjectId, { target: { view: 'book', subjectId } });
+- async unsubscribeFromSubjectUpdates(subjectId) | scopes: notifications:write
+  - Unsubscribe the current viewer from Build notifications for a subject's new pages or updates.
+
+### Twinkle.chess
+- async bestMove({ fen, depth?, skillLevel?, maxTimeMs?, timeoutMs? }) | scopes: none
+  - Ask the parent-hosted Stockfish engine for the best move from a FEN position.
+  - Example: const result = await Twinkle.chess.bestMove({ fen: game.fen(), skillLevel: 8, maxTimeMs: 1000 });
+if (result.success) game.move({ from: result.from, to: result.to, promotion: result.promotion || undefined });
+- async evaluate({ fen, depth?, skillLevel?, maxTimeMs?, timeoutMs? }) | scopes: none
+  - Analyze a FEN position and return Stockfish's current best move plus centipawn or mate evaluation.
+  - Example: const analysis = await Twinkle.chess.evaluate({ fen: game.fen(), depth: 12 });
+console.log(analysis.bestMove, analysis.evaluation, analysis.mate);
+
+### Twinkle.files
+- async saveAs({ fileName, url, dataUrl, data, text, json, bytes, blob, file, mimeType } = {}) | scopes: none
+  - Download a generated or remote file to the viewer's local device through the parent frame without opening a popup.
+  - Example: await Twinkle.files.saveAs({ fileName: 'fashion-guide.png', dataUrl: imageUrl, mimeType: 'image/png' });
+- async uploadGenerated({ fileName, url, dataUrl, data, text, json, bytes, blob, file, mimeType } = {}) | scopes: files:write
+  - Upload an app-generated file to Twinkle-hosted cloud storage without opening a picker, then store the returned asset refs in sharedDb/privateDb/userDb.
+  - Example: const { assets } = await Twinkle.files.uploadGenerated({ fileName: 'fashion-guide.png', dataUrl: generatedImageUrl, mimeType: 'image/png' });
+- async pickAndUpload({ accept, multiple } = {}) | scopes: files:write
+  - Pick supported local files and upload them to Twinkle-hosted cloud storage, then store the returned asset refs in sharedDb/privateDb/userDb.
+  - Example: const { assets, canceled } = await Twinkle.files.pickAndUpload({ accept: 'image/*,.pdf', multiple: true });
+- async list({ cursor, limit } = {}) | scopes: files:read
+  - List the current viewer's uploaded runtime files for this build.
+  - Example: const { assets, usage } = await Twinkle.files.list({ limit: 20 });
+- async delete(assetId) | scopes: files:write
+  - Delete one of the current viewer's uploaded runtime files and free up Twinkle.files quota.
+  - Example: await Twinkle.files.delete(assetId);
+
+### Twinkle.ai
+- async listPrompts() | scopes: none
+- async chat({ promptId, message, history, systemPrompt, requestId, onText, onStatus } = {}) | scopes: none
+  - Generate text with the default Lumine text model, optionally streaming text updates through onText.
+  - Example: const chatHistory = conversation.slice(-12).map((entry) => ({ role: entry.role === 'assistant' ? 'assistant' : 'user', content: entry.text }));
+const result = await Twinkle.ai.chat({ message, history: chatHistory, systemPrompt: 'You are a cheerful pirate helper who answers in one sentence.', onText: (text, meta) => renderReply(text), onStatus: (status) => setThinking(status === 'thinking') });
+- async generateObject({ prompt, expectedStructure, thinkingMode, mode, instructions, systemPrompt } = {}) | scopes: none
+  - Generate a validated structured JSON object for app decisions, routing, grading, and game-state logic.
+  - Example: const { object } = await Twinkle.ai.generateObject({ thinkingMode: 'medium', prompt: 'Classify the player intent from: ' + playerText, expectedStructure: { action: 'string', targetCharacter: 'string', confidence: 0, shouldAskFollowUp: false } });
+- onChatStatus(listener) | scopes: none
+  - Listen to shared runtime AI chat stream events.
+- async generateImage({ prompt, referenceImageB64, previousResponseId, previousImageId, engine, quality, requestId, onStatus, timeoutMs } = {}) | scopes: none
+  - Generate or edit an image from a prompt and optional base64/data-URL reference image.
+  - Example: const result = await Twinkle.ai.generateImage({ prompt: 'Create a fashion guide portrait for this face with flattering colors and outfit ideas', referenceImageB64, quality: 'high', onStatus: (status) => console.log(status.stage) });
+- onImageGenerationStatus(listener) | scopes: none
+  - Subscribe to real-time image generation status events forwarded into the build iframe.
+  - Example: const unsubscribe = Twinkle.ai.onImageGenerationStatus((status) => console.log(status.stage));
+
+### Twinkle.characters
+- async chat({ character, thinkingMode, message, history, roomContext, scene, systemPrompt, instructions, includeWebsiteContext, requestId, onText, onStatus } = {}) | scopes: none
+  - Talk to Zero or Ciel from a Build app, either as a final-response call or streaming RPG-style dialogue text with onText/onStatus.
+  - Example: const dialogueHistory = recentTurns.slice(-16).map((entry) => ({ role: entry.role === 'assistant' ? 'assistant' : 'user', content: entry.text, speaker: entry.speaker }));
+const result = await Twinkle.characters.chat({ character: 'zero', thinkingMode: thinkHard ? 'high' : 'medium', message: playerText, history: dialogueHistory, roomContext, scene: { location: 'classroom', nearbyCharacters: ['zero', 'ciel'] }, includeWebsiteContext: false, onText: (text) => renderDialogue(text) });
+- onChatStatus(listener) | scopes: none
+  - Listen to shared Zero/Ciel runtime chat stream events.
+
+### Twinkle.userDb
+- async query(sql, params) | scopes: none
+  - Run a SELECT against advanced private per-user SQLite. Use Twinkle.privateDb instead for simple preferences, drafts, settings, or small JSON state.
+- async exec(sql, params) | scopes: none
+  - Run a write or schema statement against advanced private per-user SQLite.
+
+### Twinkle.subjects
+- async getMySubjects({ limit, cursor } = {}) | scopes: content:read
+- async search({ query, limit, cursor } = {}) | scopes: content:read
+  - Search Twinkle subjects by text for subject picker UIs, book apps, scrapbooks, and galleries.
+  - Example: const { subjects } = await Twinkle.subjects.search({ query: searchText, limit: 12 });
+- async getSubject(subjectId) | scopes: content:read
+- async getSubjectComments(subjectId, { limit, cursor } = {}) | scopes: content:read
+
+### Twinkle.aiStories
+- async list({ limit, cursor, difficulty, type, isListening, userId, hasImage, hasQuestions } = {}) | scopes: content:read
+  - List completed existing user-generated AI Stories newest first for galleries, quiz apps, readers, and image/story collections.
+  - Example: const { stories } = await Twinkle.aiStories.list({ hasImage: true, hasQuestions: true, limit: 12 });
+- async search({ query, limit, cursor, difficulty, type, isListening, userId, hasImage, hasQuestions } = {}) | scopes: content:read
+  - Search completed existing user-generated AI Stories by topic or story text for galleries, quizzes, and readers.
+  - Example: const { stories } = await Twinkle.aiStories.search({ query: searchText, hasQuestions: true, limit: 12 });
+- async get(storyId) | scopes: content:read
+  - Fetch one completed existing AI Story by id, including story text, media URLs, and normalized questions when available.
+  - Example: const { story } = await Twinkle.aiStories.get(storyId);
+
+### Twinkle.grammarbles
+- async listQuestions({ level, limit, cursor } = {}) | scopes: content:read
+  - Read public Grammarbles questions and answers by level with rating/id cursor pagination.
+  - Example: const page = await Twinkle.grammarbles.listQuestions({ level: 3, limit: 100 }); const question = page.questions[Math.floor(Math.random() * page.questions.length)];
+- async getMyQuestionHistory({ level, limit, cursor } = {}) | scopes: content:read
+  - Read the signed-in viewer's real Grammarbles attempt rows for trainer filtering.
+  - Example: const history = await Twinkle.grammarbles.getMyQuestionHistory({ level: selectedLevel, limit: 500 }); const answeredIds = new Set(history.attempts.map((attempt) => attempt.questionId));
+
+### Twinkle.subjectComments
+- async list(subjectId, { limit, cursor, sortBy, includeReplies, author, authorUserId, replyScope } = {}) | scopes: content:read
+  - Read a subject's comment stream with stable keyset pagination, oldest/newest ordering, author filters, and optional same-author reply scoping.
+  - Example: const { subjects } = await Twinkle.subjects.search({ query: searchText, limit: 12 }); const subjectId = pickedSubject.id; const page = await Twinkle.subjectComments.list(subjectId, { sortBy: 'oldest', author: 'subjectPoster', includeReplies: true, replyScope: 'ownThread', limit: 50 });
+
+### Twinkle.profileComments
+- async getProfileComments({ profileUserId, limit, offset, sortBy, includeReplies, range, since, until } = {}) | scopes: content:read
+- async getProfileCommentIds({ profileUserId, limit, offset, sortBy, includeReplies, range, since, until } = {}) | scopes: content:read
+- async getCommentsByIds(idsOrOpts) | scopes: content:read
+- async getProfileCommentCounts(idsOrOpts) | scopes: content:read
+
+### Twinkle.leaderboards
+- async get({ boardKey = 'default', limit, cursor } = {}) | scopes: none
+  - Read score-sorted personal-best leaderboard rows for this Build app.
+- async submit({ boardKey = 'default', score, displayName, meta } = {}) | scopes: none
+  - Submit a score to a public Build leaderboard using server-owned viewer identity.
+
+### Twinkle.sharedDb
+- async getTopics() | scopes: sharedDb:read
+- async createTopic(name) | scopes: sharedDb:write
+- async getEntries(topicName, { limit, pageSize, cursor, order, sort, direction } = {}) | scopes: sharedDb:read
+  - Read shared topic rows with cursor pagination.
+- async loadMoreEntries(topicName, { limit, pageSize, cursor, order, sort, direction } = {}) | scopes: sharedDb:read
+  - Fetch the next sharedDb page.
+- async addEntry(topicName, data, { notify } = {}) | scopes: sharedDb:write
+  - Append a shared JSON row, optionally creating a Twinkle notification from the canonical write.
+- async updateEntry(entryId, data, { notify } = {}) | scopes: sharedDb:write
+  - Update a viewer-owned shared row, optionally notifying safe recipients from the canonical write.
+- async deleteEntry(entryId) | scopes: sharedDb:write
+
+### Twinkle.chat
+- async listRooms() | scopes: chat:read
+- async createRoom({ roomKey, name }) | scopes: chat:write
+- async listMessages(roomKey, { cursor, limit } = {}) | scopes: chat:read
+- async sendMessage(roomKey, textOrOptions, options) | scopes: chat:write
+- async deleteMessage(messageId) | scopes: chat:write
+- subscribe(roomKey, listener) | scopes: chat:read
+
+### Twinkle.world
+- async join({ worldKey = 'default', roomKey = 'main', instanceId = 'main', presence, player } = {}) | scopes: none
+  - Join a realtime Build world room and receive a snapshot plus a session handle for presence updates, actions, and room events.
+  - Example: const world = await Twinkle.world.join({ roomKey: 'town-square', presence: { x: 0, y: 0, z: 0, facing: 'south' }, player: { name: avatarName } });
+world.subscribe((event) => updateRemotePlayers(event.players));
+world.updatePresence({ x, y, z, facing });
+- leaveAll() | scopes: none
+  - Leave every active world session in the current iframe.
+
+### Twinkle.users
+- async getUser(userId) | scopes: user:read
+- async getUsers({ search, userIds, cursor, limit } = {}) | scopes: users:read
+
+### Twinkle.reflections
+- async getDailyReflections({ userIds, cursor, lastId, limit } = {}) | scopes: dailyReflections:read
+- async getDailyReflectionsByUser(userId, { cursor, lastId, limit } = {}) | scopes: dailyReflections:read
+
+### Twinkle.privateDb
+- async get(key) | scopes: privateDb:read
+  - Read one key from the default private per-user JSON store.
+- async list({ prefix, limit, cursor } = {}) | scopes: privateDb:read
+  - List keys from the default private per-user JSON store.
+- async set(key, value) | scopes: privateDb:write
+  - Upsert one JSON-serializable value in the default private per-user store.
+- async remove(key) | scopes: privateDb:write
+  - Delete one key from the default private per-user JSON store.
+
+### Twinkle.reminders
+- async list({ includeDisabled, limit } = {}) | scopes: reminders:read
+- async create({ title, body, targetPath, payload, schedule, isEnabled }) | scopes: reminders:write
+- async update(reminderId, patch) | scopes: reminders:write
+- async remove(reminderId) | scopes: reminders:write
+- async getDue({ now, autoAcknowledge, limit } = {}) | scopes: reminders:read
+
+## Examples
+
+### Daily reflection feed
+
+```js
+const feed = await Twinkle.reflections.getDailyReflections({ limit: 20 });
+```
+
+### Advanced per-user SQLite
+Use Twinkle.userDb only when the app needs private relational tables, indexes, filtered queries, or aggregates. Use Twinkle.privateDb for simple settings and small JSON state.
+Keywords: sqlite, userDb, advanced private data, relational, tables, indexes
+
+```js
+await Twinkle.userDb.exec('CREATE TABLE IF NOT EXISTS follows (userId INT PRIMARY KEY, followedAt INTEGER)');
+```
+
+### List my subjects
+
+```js
+const { subjects } = await Twinkle.subjects.getMySubjects({ limit: 10 });
+subjects.forEach(s => console.log(s.id, s.title));
+```
+
+### Search subjects for a picker
+Use this when the app should ask the viewer which Twinkle subject to turn into a book, scrapbook, or gallery.
+Keywords: subject, search, picker, book, mount
+
+```js
+const { subjects } = await Twinkle.subjects.search({ query: searchText, limit: 12 });
+// Let the viewer pick one, then use picked.id with getSubject and subjectComments.list.
+```
+
+### Build a book from a subject
+Ask the viewer to choose a subject with Twinkle.subjects.search, optionally preselecting Twinkle.mount.get() when the host provides a subject. Then fetch metadata and read the subject comment stream oldest-first. Filter to author:'subjectPoster' when only the poster's comments should become pages, and use replyScope:'ownThread' when including poster replies.
+Keywords: subject, comments, book, pages, search, picker, mount, subject poster
+
+```js
+const mount = await Twinkle.mount.get();
+const initialSubjectId = mount?.type === 'subject' ? mount.id : null;
+const { subjects } = initialSubjectId
+  ? { subjects: [] }
+  : await Twinkle.subjects.search({ query: searchText, limit: 12 });
+const subjectId = initialSubjectId || pickedSubject.id;
+const { subject } = await Twinkle.subjects.getSubject(subjectId);
+const { comments, pagination } = await Twinkle.subjectComments.list(subjectId, {
+  sortBy: 'oldest',
+  author: 'subjectPoster',
+  includeReplies: true,
+  replyScope: 'ownThread',
+  limit: 50
+});
+console.log('Title:', subject.title, 'Pages:', comments.length, 'hasMore:', pagination?.hasMore);
+```
+
+### Search AI Stories for a quiz app
+Use existing user-generated AI Stories as source material for visual galleries, readers, and question-based games.
+Keywords: ai stories, story, quiz, questions, image, gallery
+
+```js
+const { stories } = await Twinkle.aiStories.search({
+  query: searchText,
+  hasQuestions: true,
+  hasImage: true,
+  limit: 12
+});
+const picked = stories[0];
+console.log(picked.topic, picked.imageUrl, picked.questions.length);
+```
+
+### Recent profile comments
+
+```js
+const { comments, pagination } = await Twinkle.profileComments.getProfileComments({
+  sortBy: 'newest',
+  includeReplies: true,
+  limit: 20
+});
+console.log('Loaded comments:', comments.length, 'hasMore:', pagination?.hasMore);
+```
+
+### Build leaderboard
+Submit personal-best scores for signed-in viewers and guests, then read score-sorted rankings.
+Keywords: leaderboard, leaderboards, scoreboard, scores, rankings, personal best, guest scores
+
+```js
+const boardKey = 'main';
+const finalScore = computeFinalScoreForFinishedRun();
+const viewer = await Twinkle.viewer.get();
+const guestName = savedGuestName || readGuestNameFromInput();
+if (viewer.isGuest && !guestName) {
+  showGuestNameForm();
+  return;
+}
+
+await Twinkle.leaderboards.submit({
+  boardKey,
+  score: finalScore,
+  displayName: viewer.isGuest ? guestName : undefined,
+  meta: { mode: 'classic' }
+});
+
+const page = await Twinkle.leaderboards.get({ boardKey, limit: 10 });
+renderLeaderboard(page.entries, page.personalBest);
+```
+
+### Paginated shared feed
+
+```js
+const pageSize = 12;
+let nextCursor = null;
+
+async function loadFirstPage() {
+  const page = await Twinkle.sharedDb.getEntries('posts', { pageSize });
+  nextCursor = page.cursor;
+  renderPosts(page.entries, { append: false, hasMore: page.hasMore });
+}
+
+async function loadMorePosts() {
+  if (!nextCursor) return;
+  const page = await Twinkle.sharedDb.loadMoreEntries('posts', { pageSize, cursor: nextCursor });
+  nextCursor = page.cursor;
+  renderPosts(page.entries, { append: true, hasMore: page.hasMore });
+}
+```
+
+### Update a shared entry
+
+```js
+const { entry } = await Twinkle.sharedDb.updateEntry(entryId, { name: 'Alice', score: 99 });
+console.log('Updated:', entry.data);
+```
+
+### Store private user settings
+Default private per-user key/value storage for preferences, drafts, settings, and small JSON state.
+Keywords: storage, private storage, privateDb, settings, preferences, drafts, small JSON
+
+```js
+await Twinkle.privateDb.set('prefs.theme', { mode: 'mint' });
+const { item } = await Twinkle.privateDb.get('prefs.theme');
+console.log('Theme:', item?.value?.mode);
+```
+
+### Build a lobby chat
+
+```js
+await Twinkle.chat.createRoom({ roomKey: 'lobby', name: 'Lobby' });
+const unsubscribe = Twinkle.chat.subscribe('lobby', (event) => console.log('chat event', event));
+await Twinkle.chat.sendMessage('lobby', 'hello');
+```
+
+### Realtime MMO town room
+Use Twinkle.world for live avatar presence and lightweight room actions, while durable state like inventory and quests stays in sharedDb/privateDb.
+Keywords: multiplayer, mmo, town, presence, avatars, movement, three.js, realtime
+
+```js
+const world = await Twinkle.world.join({
+  worldKey: 'town',
+  roomKey: 'square',
+  presence: { x: 0, y: 0, z: 0, facing: 'south', animation: 'idle' },
+  player: { name: avatarName }
+});
+
+world.subscribe((event) => {
+  renderPlayers(event.players);
+  if (event.type === 'action.received' && event.action?.type === 'emote') {
+    showEmote(event.sessionId, event.action.data.emote);
+  }
+});
+
+// Throttle this in the game loop, for example 5-15 times per second.
+await world.updatePresence({ x: player.x, y: player.y, z: player.z, facing });
+await world.send('emote', { emote: 'wave' });
+```
+
+### Play chess against the computer
+Use the parent-managed Stockfish helper for the computer move while app code owns the board, legal moves, and game-over state.
+Keywords: chess, stockfish, computer opponent, board game, fen
+
+```js
+const result = await Twinkle.chess.bestMove({ fen: game.fen(), skillLevel: 7, maxTimeMs: 1000 });
+if (result.success) {
+  game.move({ from: result.from, to: result.to, promotion: result.promotion || undefined });
+  renderBoard(game);
+}
+
+const strongest = await Twinkle.chess.bestMove({ fen: game.fen(), skillLevel: 20, maxTimeMs: 60000 });
+```
+
+### Upload files and store shared metadata
+
+```js
+const { assets, canceled } = await Twinkle.files.pickAndUpload({ accept: 'image/*,.pdf', multiple: true });
+if (!canceled) {
+  for (const asset of assets) {
+    await Twinkle.sharedDb.addEntry('uploads', { assetId: asset.id, url: asset.url, thumbUrl: asset.thumbUrl, fileName: asset.fileName, mimeType: asset.mimeType });
+  }
+}
+```
+
+### List and remove uploaded files
+
+```js
+const { assets, usage } = await Twinkle.files.list({ limit: 20 });
+if (assets[0]) {
+  await Twinkle.files.delete(assets[0].id);
+}
+console.log('Remaining quota bytes:', usage?.remainingBytes);
+```
+
+### Create a daily focus reminder
+
+```js
+await Twinkle.reminders.create({
+  title: 'Pick your top 3',
+  body: 'Choose your focus tasks for today.',
+  schedule: { type: 'daily', timeZone: 'America/Los_Angeles', hour: 9, minute: 0 },
+  targetPath: '/focus'
+});
+```