@sutrata/editor 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,87 @@
+# @sutrata/editor
+
+The React screenplay editor behind [Sutrata](https://github.com/sutrata/sutrata), for writing scripts in **Sutra**, a plain-text screenplay format for world languages. It's built on ProseMirror and handles Indic and other complex scripts properly:
+- Text is stored in logical order.
+- The cursor and selection move by grapheme cluster (user-perceived character).
+- Find/replace matches after NFC normalization, so differently encoded forms of the same text still match.
+
+This package contains the complete editor:
+- WYSIWYG and source modes, with smart Enter that cycles through screenplay elements.
+- A scene navigator, find/replace, a title-page form and screenplay styles.
+- Statistics, autocomplete and spellcheck.
+- Export to PDF, DOCX, Fountain and workflow reports, including romanized exports.
+- Localized UI.
+
+Sutra parsing and serialization come from [`@sutrata/parser`](https://www.npmjs.com/package/@sutrata/parser).
+
+## Install
+
+```bash
+npm install @sutrata/editor react react-dom
+```
+
+`react` and `react-dom` (^18.3) are peer dependencies.
+
+## Usage
+
+The editor doesn't read or write files itself. You pass it a `StorageAdapter`, and it saves, opens and keeps version history through that adapter. The same editor can therefore run on local files, in a desktop shell or against a server.
+
+```tsx
+import React from 'react'
+import { createRoot } from 'react-dom/client'
+import {
+  TranslationProvider,
+  LanguageProvider,
+  DocumentProvider,
+  AppShell,
+  type StorageAdapter,
+} from '@sutrata/editor'
+import '@sutrata/editor/dist/shell/fonts/fonts.css'
+import '@sutrata/editor/dist/styles/screenplay.css'
+
+const storageAdapter: StorageAdapter = {
+  // documents and version history
+  saveDocument: async (path, content) => { /* ... */ },
+  loadDocument: async (path) => null,
+  listVersions: async (path) => [],
+  // file dialogs
+  openFile: async () => null,        // { name, content, handle }
+  openDocx: async () => null,        // { name, buffer }
+  openStyleJson: async () => null,   // { name, text }
+  saveFile: async (name, content, handle) => null, // { savedName, handle }
+  // custom screenplay styles
+  saveStyle: async (style) => {},
+  loadAllStyles: async () => [],
+  deleteStyle: async (id) => {},
+}
+
+createRoot(document.getElementById('root')!).render(
+  <TranslationProvider>
+    <LanguageProvider>
+      <DocumentProvider storageAdapter={storageAdapter}>
+        <AppShell />
+      </DocumentProvider>
+    </LanguageProvider>
+  </TranslationProvider>,
+)
+```
+
+`StorageAdapter` also has optional methods: `saveVersion`, `deleteAllVersions`, `persistFileHandle` and `restoreFileHandle`. For a complete implementation built on IndexedDB and the File System Access API, see [`local-storage-adapter.ts`](https://github.com/sutrata/sutrata/blob/main/packages/app/src/local-storage-adapter.ts) in the Sutrata app.
+
+Inside the providers, `useDocument()` gives you the current Sutra text, its parsed AST and the editor state.
+
+### Fonts
+
+`fonts.css` declares Noto font faces for every supported script, loaded from `/fonts/*.woff2` on your own site. This package does not include the font files. Copy them from [`packages/app/public/fonts`](https://github.com/sutrata/sutrata/tree/main/packages/app/public/fonts) into your app's `/fonts/` path, or use your own `@font-face` rules. Without them, some scripts may display as missing-glyph boxes (tofu).
+
+## Extension points
+
+Beyond `StorageAdapter`, the package exports type definitions for more extension points: `AIProvider`, `SpeechProvider`, `SessionContext`, `PanelRegistry`, `CommandRegistry`, `ExportRegistry`, `CollabBinding` and `DecorationProvider`. **These are type-only previews and are not wired into the editor yet.** Their shapes may change before 1.0.
+
+## Status
+
+Pre-1.0. The API may change between minor versions.
+
+## License
+
+[GPL-3.0-or-later](https://github.com/sutrata/sutrata/blob/main/packages/editor/LICENSE).

package/dist/ai/generated-providers.json

@@ -1,5 +1,5 @@
 {
-    "generatedAt": "2026-09-24T06:55:45.925Z",
+    "generatedAt": "2026-09-24T07:18:07.361Z",
     "source": "https://github.com/foisalislambd/all-llm-provider-list",
     "providers": [
         {

package/package.json

@@ -1,16 +1,33 @@
 {
   "name": "@sutrata/editor",
-  "version": "0.1.0",
+  "version": "0.1.2",
+  "description": "React + ProseMirror screenplay editor for Sutra, with first-class support for Indic and other complex scripts.",
   "license": "GPL-3.0-or-later",
+  "keywords": [
+    "sutra",
+    "screenplay",
+    "editor",
+    "prosemirror",
+    "react",
+    "indic",
+    "unicode",
+    "fountain"
+  ],
+  "homepage": "https://github.com/sutrata/sutrata/tree/main/packages/editor#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sutrata/sutrata.git",
+    "directory": "packages/editor"
+  },
+  "bugs": {
+    "url": "https://github.com/sutrata/sutrata/issues"
+  },
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "scripts": {
-    "build": "node scripts/generate-providers.mjs && tsc && node scripts/copy-assets.mjs",
-    "generate:providers": "node scripts/generate-providers.mjs",
-    "test": "vitest run",
-    "test:watch": "vitest"
-  },
+  "files": [
+    "dist"
+  ],
   "dependencies": {
     "@codemirror/commands": "^6.10.3",
     "@codemirror/language": "^6.12.3",
@@ -18,7 +35,6 @@
     "@codemirror/theme-one-dark": "^6.1.3",
     "@codemirror/view": "^6.43.1",
     "@lezer/highlight": "^1.2.3",
-    "@sutrata/parser": "workspace:*",
     "diff": "^9.0.0",
     "docx": "^9.7.1",
     "jszip": "^3.10.1",
@@ -30,6 +46,9 @@
     "prosemirror-state": "^1.4.3",
     "prosemirror-transform": "^1.9.0",
     "prosemirror-view": "^1.33.0",
+    "@sutrata/parser": "0.1.1"
+  },
+  "peerDependencies": {
     "react": "^18.3.0",
     "react-dom": "^18.3.0"
   },
@@ -41,7 +60,15 @@
     "@types/react-dom": "^18.3.0",
     "@vitejs/plugin-react": "^4.3.0",
     "jsdom": "^29.1.1",
+    "react": "^18.3.0",
+    "react-dom": "^18.3.0",
     "typescript": "^5.4.0",
     "vitest": "^1.6.0"
+  },
+  "scripts": {
+    "build": "node scripts/generate-providers.mjs && tsc && node scripts/copy-assets.mjs",
+    "generate:providers": "node scripts/generate-providers.mjs",
+    "test": "vitest run",
+    "test:watch": "vitest"
   }
-}
+}

package/scripts/copy-assets.mjs

@@ -1,16 +0,0 @@
-import { mkdirSync, copyFileSync } from 'node:fs';
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const root = join(dirname(fileURLToPath(import.meta.url)), '..');
-
-const files = [
-  ['src/shell/fonts/fonts.css', 'dist/shell/fonts/fonts.css'],
-  ['src/styles/screenplay.css', 'dist/styles/screenplay.css'],
-  ['src/desktop-api.d.ts', 'dist/desktop-api.d.ts'],
-];
-
-for (const [from, to] of files) {
-  mkdirSync(dirname(join(root, to)), { recursive: true });
-  copyFileSync(join(root, from), join(root, to));
-}

package/scripts/generate-providers.mjs

@@ -1,127 +0,0 @@
-// Generates src/ai/generated-providers.json (and a copy at
-// packages/app/public/models-config.json) from the community-maintained
-// all-llm-provider-list registry, at build time.
-//
-// Only providers Sutrata can actually drive are kept: ones with a real
-// env_variable (i.e. a "paste an API key" auth model — this drops
-// OAuth/browser-cookie/local-only/no-auth entries) and either
-// openai_compatible: true, or Anthropic (the one vendor ai-client.ts still
-// calls via a bespoke request shape, since Anthropic has no OpenAI-compat
-// endpoint). Google/Gemini is retargeted at its official OpenAI-compat base
-// URL (https://generativelanguage.googleapis.com/v1beta/openai) so it flows
-// through the generic branch too, rather than needing its own adapter.
-//
-// TODO(future): this list is currently refreshed only when this script is
-// re-run at build time. A follow-up could instead fetch the upstream list
-// live each time the user opens the AI settings/onboarding dialog, so the
-// provider catalog stays current without a rebuild — intentionally not done
-// here to keep this change scoped.
-
-import { writeFileSync, existsSync } from 'node:fs';
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const root = join(dirname(fileURLToPath(import.meta.url)), '..');
-const editorOutPath = join(root, 'src/ai/generated-providers.json');
-const appOutPath = join(root, '../app/public/models-config.json');
-
-const SOURCE_URL = 'https://raw.githubusercontent.com/foisalislambd/all-llm-provider-list/main/data/providers.json';
-
-// id/baseUrl overrides for vendors Sutrata treats specially. Ids double as
-// localStorage key suffixes (sutrata_api_key_<id>) and, for anthropic, as
-// invokeProvider's branch discriminator — they must stay stable across
-// regenerations regardless of what the upstream slug says.
-//
-// `models` overrides are needed because the upstream list's popular_models
-// sometimes holds human-readable display names (e.g. "Claude Opus 4.8")
-// rather than API-ready model ids — fine for a dropdown label, but wrong if
-// sent verbatim as the `model` field. These two are the ids actually used
-// for testConnection() before listModels() has a chance to fetch live ones;
-// everyone else relies on listModels() to correct a bad static id at
-// first use.
-const OVERRIDES = {
-  anthropic: {
-    id: 'anthropic',
-    baseUrl: 'https://api.anthropic.com/v1',
-    models: [
-      { id: 'claude-opus-5', name: 'Claude Opus 5' },
-      { id: 'claude-sonnet-5', name: 'Claude Sonnet 5' },
-      { id: 'claude-haiku-4-5', name: 'Claude Haiku 4.5' },
-    ],
-  },
-  'google-ai-studio': {
-    id: 'gemini',
-    baseUrl: 'https://generativelanguage.googleapis.com/v1beta/openai',
-    models: [
-      { id: 'gemini-2.5-flash', name: 'Gemini 2.5 Flash' },
-      { id: 'gemini-2.5-pro', name: 'Gemini 2.5 Pro' },
-      { id: 'gemini-2.0-flash-lite', name: 'Gemini 2.0 Flash Lite' },
-    ],
-  },
-};
-OVERRIDES.gemini = OVERRIDES['google-ai-studio'];
-OVERRIDES.google = OVERRIDES['google-ai-studio'];
-
-const ESSENTIAL_IDS = new Set(['anthropic', 'gemini', 'groq']);
-
-function isSupported(entry) {
-  if (!entry.env_variable || !entry.api_base_url) return false;
-  const override = OVERRIDES[entry.slug];
-  return entry.openai_compatible === true || override?.id === 'anthropic';
-}
-
-function toProviderConfig(entry) {
-  const override = OVERRIDES[entry.slug];
-  const id = override?.id ?? entry.slug;
-  const baseUrl = override?.baseUrl ?? entry.api_base_url;
-  const config = {
-    id,
-    name: entry.name,
-    baseUrl,
-    models: override?.models ?? (entry.popular_models ?? []).map((m) => ({ id: m, name: m })),
-  };
-  if (ESSENTIAL_IDS.has(id)) config.essential = true;
-  return config;
-}
-
-async function main() {
-  let source;
-  try {
-    const res = await fetch(SOURCE_URL);
-    if (!res.ok) throw new Error(`HTTP ${res.status}`);
-    source = await res.json();
-  } catch (e) {
-    console.warn(`[generate-providers] Failed to fetch ${SOURCE_URL}: ${e}. Leaving existing generated files untouched.`);
-    if (!existsSync(editorOutPath)) {
-      console.error('[generate-providers] No existing generated-providers.json to fall back to — build will use the compiled-in defaults only.');
-    }
-    return;
-  }
-
-  const entries = Array.isArray(source) ? source : source.providers ?? [];
-  const seen = new Set();
-  const providers = [];
-  for (const entry of entries) {
-    if (!isSupported(entry)) continue;
-    const config = toProviderConfig(entry);
-    if (seen.has(config.id)) continue; // first match wins (upstream list order)
-    seen.add(config.id);
-    providers.push(config);
-  }
-
-  const output = {
-    generatedAt: new Date().toISOString(),
-    source: 'https://github.com/foisalislambd/all-llm-provider-list',
-    providers,
-  };
-
-  const json = JSON.stringify(output, null, 2) + '\n';
-  writeFileSync(editorOutPath, json);
-
-  const appConfig = { providers: output.providers };
-  writeFileSync(appOutPath, JSON.stringify(appConfig, null, 2) + '\n');
-
-  console.log(`[generate-providers] Wrote ${providers.length} providers to ${editorOutPath} and ${appOutPath}.`);
-}
-
-await main();