@yieldfabric/terminal 1.0.0

package/README.md

@@ -0,0 +1,118 @@
+# @yieldfabric/terminal
+
+Reusable AI-powered terminal component for YieldFabric applications.
+
+## Installation
+
+Published to the **public npm registry** — no scope `.npmrc`, no token:
+
+```bash
+npm install @yieldfabric/terminal
+```
+
+### Peer dependencies
+
+`react` and `react-dom` (^18) are peer deps — install them in the host app.
+All other runtime deps (`@xyflow/react`, `@mdxeditor/editor`, `framer-motion`,
+`lucide-react`, `react-markdown`, `dagre`, `@dicebear/*`) install
+automatically from the public npm registry.
+
+### Tailwind
+
+This package emits Tailwind utility classes. Add it to your `tailwind.config.js`
+`content` so the classes aren't purged:
+
+```js
+content: [
+  // ...your app globs
+  './node_modules/@yieldfabric/terminal/dist/**/*.{js,cjs}',
+],
+```
+
+### Third-party CSS
+
+The knowledge-graph and markdown-editor views import two stylesheets
+(`@xyflow/react/dist/style.css`, `@mdxeditor/editor/style.css`). These ride
+along as side-effect imports in the bundle — modern bundlers (Next.js, CRA,
+Vite) resolve them automatically; no manual import needed.
+
+## Usage
+
+### ExpandableTerminal (Header/Dropdown Style)
+
+```typescript
+import { ExpandableTerminal } from '@yieldfabric/terminal'
+import { useRouter } from 'next/navigation' // or react-router-dom
+
+const config = {
+  endpoints: [...],
+  welcomeMessage: "Welcome to YieldFabric!",
+  // ... other config
+}
+
+function MyComponent() {
+  const router = useRouter()
+  
+  return (
+    <ExpandableTerminal
+      config={config}
+      onCommandExecute={handleCommand}
+      onPageNavigation={(page) => router.push(page.path)}
+      onStreamRequest={handleStreaming}
+    />
+  )
+}
+```
+
+### EmbeddedTerminal (Embedded in Page)
+
+```typescript
+import { EmbeddedTerminal } from '@yieldfabric/terminal'
+
+function MyPage() {
+  return (
+    <EmbeddedTerminal
+      config={config}
+      onCommandExecute={handleCommand}
+      showHeader={true}
+      showWelcomeMessage={true}
+    />
+  )
+}
+```
+
+## Building
+
+Built with [tsup](https://tsup.egoist.dev/) → dual ESM + CJS bundles plus
+type declarations in `dist/`. Heavy deps stay external (consumers install
+them); the bundle carries only this package's own component source.
+
+```bash
+npm run build       # one-shot build → dist/
+npm run dev         # watch mode
+npm run typecheck   # tsc --noEmit
+```
+
+## Publishing
+
+Public scoped package on the **public npm registry** (`publishConfig.access:
+public`). Requires the `yieldfabric` scope = an npm org (or user) named
+`yieldfabric`. `npm login` once, then:
+
+```bash
+npm publish   # prepublishOnly cleans + rebuilds first
+```
+
+Bump `version` in `package.json` first (npm rejects re-publishing an existing
+version). The tarball ships `dist/` + `README.md` only — no `src/`, no maps.
+
+## Features
+
+- ✅ Framework-agnostic (works with Next.js, React, etc.)
+- ✅ TypeScript support with strict types
+- ✅ Streaming AI responses
+- ✅ Command history and autocomplete
+- ✅ Tailwind CSS styling
+- ✅ Page navigation suggestions
+- ✅ Fully customizable via config
+