openwriter 0.40.0 → 0.40.1

package/dist/plugins/github/dist/git-sync.d.ts

@@ -1,46 +0,0 @@
-/**
- * Git sync module: all git/gh CLI interactions for GitHub docs backup.
- * Lifted from packages/openwriter/server/git-sync.ts into the github plugin.
- *
- * Uses child_process.execFile with an argv array and NO shell (MCP-1): values
- * are passed to git/gh as literal arguments, never interpreted by a shell.
- * The GitHub PAT is supplied to authenticated pushes out-of-band via an
- * inline credential helper reading from an env var (MCP-3) — it is never
- * embedded in the remote URL, written to .git/config, or placed in argv.
- * Server-internal modules (state, helpers, ws) accessed via getServerModules().
- */
-export type SyncState = 'unconfigured' | 'synced' | 'pending' | 'syncing' | 'error';
-export interface SyncStatus {
-    state: SyncState;
-    lastSyncTime?: string;
-    pendingFiles?: number;
-    error?: string;
-}
-export interface SyncCapabilities {
-    gitInstalled: boolean;
-    ghInstalled: boolean;
-    ghAuthenticated: boolean;
-    existingRepo: boolean;
-    remoteUrl?: string;
-}
-/**
- * Strip any embedded credentials (PAT / user:pass) from a git remote URL so a
- * credential-bearing URL is never returned to a client or logged. SSH scp-style
- * remotes (git@github.com:owner/repo.git) carry no secret and are left as-is.
- */
-export declare function sanitizeRemoteUrl(url: string): string;
-export declare function isGitInstalled(): Promise<boolean>;
-export declare function isGhInstalled(): Promise<boolean>;
-export declare function isGhAuthenticated(): Promise<boolean>;
-export declare function isGitRepo(): Promise<boolean>;
-export interface PendingFile {
-    status: 'added' | 'modified' | 'deleted' | 'renamed';
-    file: string;
-}
-export declare function getPendingFiles(): Promise<PendingFile[]>;
-export declare function getSyncStatus(): Promise<SyncStatus>;
-export declare function getCapabilities(): Promise<SyncCapabilities>;
-export declare function setupWithGh(repoName: string, isPrivate: boolean): Promise<void>;
-export declare function setupWithPat(pat: string, repoName: string, isPrivate: boolean): Promise<void>;
-export declare function connectExisting(remoteUrl: string, pat?: string): Promise<void>;
-export declare function pushSync(onStatus: (status: SyncStatus) => void): Promise<SyncStatus>;

package/dist/plugins/github/dist/git-sync.js

@@ -1,335 +0,0 @@
-/**
- * Git sync module: all git/gh CLI interactions for GitHub docs backup.
- * Lifted from packages/openwriter/server/git-sync.ts into the github plugin.
- *
- * Uses child_process.execFile with an argv array and NO shell (MCP-1): values
- * are passed to git/gh as literal arguments, never interpreted by a shell.
- * The GitHub PAT is supplied to authenticated pushes out-of-band via an
- * inline credential helper reading from an env var (MCP-3) — it is never
- * embedded in the remote URL, written to .git/config, or placed in argv.
- * Server-internal modules (state, helpers, ws) accessed via getServerModules().
- */
-import { execFile } from 'child_process';
-import { existsSync, writeFileSync } from 'fs';
-import { join } from 'path';
-import { getServerModules } from './helpers.js';
-const GITIGNORE_CONTENT = `config.json\n.versions/\n`;
-const NETWORK_TIMEOUT = 30000;
-let currentSyncState = 'unconfigured';
-let lastError;
-// SECURITY (MCP-1): no shell. Arguments are passed to git/gh as an argv array,
-// so each element is a single literal argument with no shell interpretation.
-// The optional `env` is merged over the parent process env for that one call.
-function exec(cmd, args, cwd, timeout = 10000, env) {
-    return new Promise((resolve, reject) => {
-        execFile(cmd, args, { cwd, timeout, env: env ? { ...process.env, ...env } : process.env }, (err, stdout, stderr) => {
-            if (err)
-                reject(new Error(stderr?.trim() || err.message));
-            else
-                resolve(stdout.trim());
-        });
-    });
-}
-// ── Credential handling (MCP-3) ─────────────────────────────────────────────
-// The PAT is supplied to authenticated git pushes WITHOUT ever touching the
-// remote URL, .git/config, or argv. An inline credential helper (run by git
-// through its own sh) reads the token from the OW_GIT_PAT env var at call time;
-// only the variable *name* appears in arguments, never the secret itself.
-const PAT_CRED_HELPER = '!f() { test "$1" = get && printf "username=x-access-token\\npassword=%s\\n" "$OW_GIT_PAT"; }; f';
-/**
- * Run a git command that needs the PAT for network auth (push/fetch against a
- * private remote). The `-c credential.helper=` first resets any inherited
- * helper so only ours answers; the token is passed via env, not argv. The
- * remote URL stays credential-free.
- */
-function execGitWithPat(args, cwd, pat, timeout = NETWORK_TIMEOUT) {
-    const authArgs = ['-c', 'credential.helper=', '-c', `credential.helper=${PAT_CRED_HELPER}`];
-    return exec('git', [...authArgs, ...args], cwd, timeout, { OW_GIT_PAT: pat });
-}
-/**
- * Strip any embedded credentials (PAT / user:pass) from a git remote URL so a
- * credential-bearing URL is never returned to a client or logged. SSH scp-style
- * remotes (git@github.com:owner/repo.git) carry no secret and are left as-is.
- */
-export function sanitizeRemoteUrl(url) {
-    try {
-        const u = new URL(url);
-        if (u.username || u.password) {
-            u.username = '';
-            u.password = '';
-        }
-        return u.toString();
-    }
-    catch {
-        // Not a parseable URL (e.g. ssh scp-like form) — defensively drop any
-        // userinfo that precedes an @ in a scheme://… authority.
-        return url.replace(/^([a-z][a-z0-9+.-]*:\/\/)[^/@]*@/i, '$1');
-    }
-}
-async function dataDir() {
-    return (await getServerModules()).getDataDir();
-}
-export async function isGitInstalled() {
-    try {
-        await exec('git', ['--version'], await dataDir());
-        return true;
-    }
-    catch {
-        return false;
-    }
-}
-export async function isGhInstalled() {
-    try {
-        await exec('gh', ['--version'], await dataDir());
-        return true;
-    }
-    catch {
-        return false;
-    }
-}
-export async function isGhAuthenticated() {
-    try {
-        await exec('gh', ['auth', 'status'], await dataDir());
-        return true;
-    }
-    catch {
-        return false;
-    }
-}
-export async function isGitRepo() {
-    return existsSync(join(await dataDir(), '.git'));
-}
-async function ensureGitignore() {
-    const gitignorePath = join(await dataDir(), '.gitignore');
-    if (!existsSync(gitignorePath)) {
-        writeFileSync(gitignorePath, GITIGNORE_CONTENT, 'utf-8');
-    }
-}
-async function countPendingFiles() {
-    if (!(await isGitRepo()))
-        return 0;
-    try {
-        const status = await exec('git', ['status', '--porcelain'], await dataDir());
-        if (!status)
-            return 0;
-        return status.split('\n').filter(Boolean).length;
-    }
-    catch {
-        return 0;
-    }
-}
-export async function getPendingFiles() {
-    if (!(await isGitRepo()))
-        return [];
-    try {
-        const output = await exec('git', ['status', '--porcelain'], await dataDir());
-        if (!output)
-            return [];
-        return output.split('\n').filter(Boolean).map(line => {
-            const code = line.substring(0, 2);
-            const file = line.substring(3);
-            let status = 'modified';
-            if (code.includes('?') || code.includes('A'))
-                status = 'added';
-            else if (code.includes('D'))
-                status = 'deleted';
-            else if (code.includes('R'))
-                status = 'renamed';
-            return { status, file };
-        });
-    }
-    catch {
-        return [];
-    }
-}
-export async function getSyncStatus() {
-    const srv = await getServerModules();
-    const config = srv.readConfig();
-    if (!config.gitConfigured || !(await isGitRepo())) {
-        return { state: 'unconfigured' };
-    }
-    if (currentSyncState === 'syncing') {
-        return { state: 'syncing' };
-    }
-    if (currentSyncState === 'error' && lastError) {
-        return { state: 'error', error: lastError, lastSyncTime: config.lastSyncTime };
-    }
-    const pending = await countPendingFiles();
-    return {
-        state: pending > 0 ? 'pending' : 'synced',
-        pendingFiles: pending,
-        lastSyncTime: config.lastSyncTime,
-    };
-}
-export async function getCapabilities() {
-    const [git, gh] = await Promise.all([isGitInstalled(), isGhInstalled()]);
-    let ghAuth = false;
-    if (gh)
-        ghAuth = await isGhAuthenticated();
-    let remoteUrl;
-    if (await isGitRepo()) {
-        try {
-            // MCP-3: never expose embedded credentials. Even though the remote is
-            // now stored credential-free, strip defensively so a legacy URL written
-            // by an older build (PAT-in-URL) can't leak through this route.
-            remoteUrl = sanitizeRemoteUrl(await exec('git', ['remote', 'get-url', 'origin'], await dataDir()));
-        }
-        catch { /* no remote */ }
-    }
-    return {
-        gitInstalled: git,
-        ghInstalled: gh,
-        ghAuthenticated: ghAuth,
-        existingRepo: await isGitRepo(),
-        remoteUrl,
-    };
-}
-async function initRepo() {
-    const dir = await dataDir();
-    if (!(await isGitRepo())) {
-        await exec('git', ['init'], dir);
-    }
-    await ensureGitignore();
-    try {
-        await exec('git', ['config', 'user.name'], dir);
-    }
-    catch {
-        await exec('git', ['config', 'user.name', 'OpenWriter'], dir);
-    }
-    try {
-        await exec('git', ['config', 'user.email'], dir);
-    }
-    catch {
-        await exec('git', ['config', 'user.email', 'openwriter@local'], dir);
-    }
-}
-async function initialCommit() {
-    const dir = await dataDir();
-    await exec('git', ['add', '-A'], dir);
-    const status = await exec('git', ['status', '--porcelain'], dir);
-    if (!status)
-        return;
-    await exec('git', ['commit', '-m', 'Initial sync from OpenWriter'], dir);
-    await exec('git', ['branch', '-M', 'main'], dir);
-}
-export async function setupWithGh(repoName, isPrivate) {
-    const srv = await getServerModules();
-    const dir = await dataDir();
-    await initRepo();
-    await initialCommit();
-    const visibility = isPrivate ? '--private' : '--public';
-    await exec('gh', ['repo', 'create', repoName, visibility, '--source=.', '--remote=origin'], dir, NETWORK_TIMEOUT);
-    await exec('git', ['push', '-u', 'origin', 'main'], dir, NETWORK_TIMEOUT);
-    srv.saveConfig({
-        gitConfigured: true,
-        repoName,
-        lastSyncTime: new Date().toISOString(),
-    });
-    currentSyncState = 'synced';
-}
-export async function setupWithPat(pat, repoName, isPrivate) {
-    const srv = await getServerModules();
-    const dir = await dataDir();
-    const res = await fetch('https://api.github.com/user/repos', {
-        method: 'POST',
-        headers: {
-            Authorization: `Bearer ${pat}`,
-            'Content-Type': 'application/json',
-            Accept: 'application/vnd.github+json',
-        },
-        body: JSON.stringify({ name: repoName, private: isPrivate, auto_init: false }),
-    });
-    if (!res.ok) {
-        const body = await res.json().catch(() => ({}));
-        throw new Error(body.message || `GitHub API error: ${res.status}`);
-    }
-    const repo = await res.json();
-    // MCP-3: store a credential-free remote. The PAT is supplied per-push via
-    // the credential helper (execGitWithPat), never embedded in the URL.
-    const remoteUrl = `https://github.com/${repo.full_name}.git`;
-    await initRepo();
-    await initialCommit();
-    try {
-        await exec('git', ['remote', 'remove', 'origin'], dir);
-    }
-    catch { /* no remote */ }
-    await exec('git', ['remote', 'add', 'origin', remoteUrl], dir);
-    await execGitWithPat(['push', '-u', 'origin', 'main'], dir, pat, NETWORK_TIMEOUT);
-    srv.saveConfig({
-        gitConfigured: true,
-        gitPat: pat,
-        repoName,
-        gitRemote: repo.html_url,
-        lastSyncTime: new Date().toISOString(),
-    });
-    currentSyncState = 'synced';
-}
-export async function connectExisting(remoteUrl, pat) {
-    const srv = await getServerModules();
-    const dir = await dataDir();
-    await initRepo();
-    await initialCommit();
-    // MCP-3: keep the remote credential-free; never splice the PAT into the URL.
-    // Strip any credentials the caller may have included before storing/using it.
-    const finalUrl = sanitizeRemoteUrl(remoteUrl);
-    try {
-        await exec('git', ['remote', 'remove', 'origin'], dir);
-    }
-    catch { /* no remote */ }
-    await exec('git', ['remote', 'add', 'origin', finalUrl], dir);
-    if (pat) {
-        await execGitWithPat(['push', '-u', 'origin', 'main'], dir, pat, NETWORK_TIMEOUT);
-    }
-    else {
-        await exec('git', ['push', '-u', 'origin', 'main'], dir, NETWORK_TIMEOUT);
-    }
-    srv.saveConfig({
-        gitConfigured: true,
-        gitPat: pat,
-        gitRemote: finalUrl,
-        lastSyncTime: new Date().toISOString(),
-    });
-    currentSyncState = 'synced';
-}
-export async function pushSync(onStatus) {
-    const srv = await getServerModules();
-    const dir = await dataDir();
-    currentSyncState = 'syncing';
-    lastError = undefined;
-    onStatus({ state: 'syncing' });
-    try {
-        srv.cancelDebouncedSave();
-        srv.save();
-        await ensureGitignore();
-        await exec('git', ['add', '-A'], dir);
-        const status = await exec('git', ['status', '--porcelain'], dir);
-        if (status) {
-            const timestamp = new Date().toLocaleString('en-US', {
-                month: 'short', day: 'numeric', hour: 'numeric', minute: '2-digit',
-            });
-            await exec('git', ['commit', '-m', `Sync: ${timestamp}`], dir);
-        }
-        // MCP-3: the remote is credential-free. When configured via PAT, supply
-        // the token out-of-band per-push; gh-based / SSH remotes auth on their own.
-        const pat = srv.readConfig()?.gitPat;
-        if (pat) {
-            await execGitWithPat(['push'], dir, pat, NETWORK_TIMEOUT);
-        }
-        else {
-            await exec('git', ['push'], dir, NETWORK_TIMEOUT);
-        }
-        const now = new Date().toISOString();
-        srv.saveConfig({ lastSyncTime: now });
-        currentSyncState = 'synced';
-        const result = { state: 'synced', lastSyncTime: now, pendingFiles: 0 };
-        onStatus(result);
-        return result;
-    }
-    catch (err) {
-        currentSyncState = 'error';
-        lastError = err.message;
-        const result = { state: 'error', error: err.message };
-        onStatus(result);
-        return result;
-    }
-}

package/dist/plugins/github/dist/helpers.d.ts

@@ -1,127 +0,0 @@
-/**
- * Local helpers for the github plugin — server-module bridge.
- * Mirrors the lazy-import pattern from plugins/publish/src/helpers.ts.
- */
-export interface ServerModules {
-    getDataDir: () => string;
-    readConfig: () => any;
-    saveConfig: (patch: Record<string, any>) => void;
-    save: () => void;
-    cancelDebouncedSave: () => void;
-    getDocument: () => any;
-    getTitle: () => string;
-    getMetadata: () => Record<string, any>;
-    getDocId: () => string;
-    setMetadata: (updates: Record<string, any>) => void;
-    bumpDocVersion: () => number;
-    broadcastSyncStatus: (status: any) => void;
-    broadcastMetadataChanged: (metadata: Record<string, any>) => void;
-    broadcastDocumentsChanged: () => void;
-    broadcastToast: (message: string, kind?: 'info' | 'error', durationMs?: number) => void;
-    tiptapToMarkdown: (doc: any, title: string, metadata?: Record<string, any>) => string;
-    validateBlogFrontmatter: (opts: {
-        repoRoot: string;
-        contentDir: string;
-        frontmatter: string;
-    }) => Promise<BlogFrontmatterValidation>;
-}
-/** Result of the pre-commit schema gate. Mirrors server/blog-schema-gate.ts. */
-export interface BlogFrontmatterValidation {
-    ok: boolean;
-    skipped?: boolean;
-    reason?: string;
-    configPath?: string;
-    collection?: string;
-    issues?: Array<{
-        field: string;
-        code: string;
-        message: string;
-    }>;
-    summary?: string;
-}
-export declare function getServerModules(): Promise<ServerModules>;
-export interface PluginConfigField {
-    type: 'string' | 'number' | 'boolean';
-    required?: boolean;
-    env?: string;
-    description?: string;
-}
-export interface PluginRouteContext {
-    app: import('express').Router;
-    config: Record<string, string>;
-    dataDir: string;
-}
-export interface PluginMcpTool {
-    name: string;
-    description: string;
-    inputSchema: Record<string, unknown>;
-    handler: (params: Record<string, unknown>) => Promise<unknown>;
-}
-export interface OpenWriterPlugin {
-    name: string;
-    version: string;
-    description?: string;
-    category?: 'writing' | 'social-media' | 'image-generation' | 'publishing' | 'productivity' | 'analytics';
-    configSchema?: Record<string, PluginConfigField>;
-    registerRoutes?(ctx: PluginRouteContext): void | Promise<void>;
-    mcpTools?(config: Record<string, string>): PluginMcpTool[];
-}
-export interface BlogSite {
-    id: string;
-    label: string;
-    owner: string;
-    repo: string;
-    branch: string;
-    content_dir: string;
-    image_dir: string;
-    image_public_prefix: string;
-    framework: 'astro' | 'next' | 'jekyll' | 'hugo' | 'unknown';
-    /** Constant frontmatter fields applied to every post (e.g. layout, author, prerender). */
-    frontmatter_defaults?: Record<string, any>;
-    /**
-     * Map openwriter blogContext key → site frontmatter key.
-     * e.g. { date: "publishedDate" } for sites that use a non-standard date field.
-     */
-    frontmatter_field_map?: Record<string, string>;
-    /**
-     * Schema of frontmatter fields the site's posts use (from inspection).
-     * Surfaced in the panel so users can see what the site expects.
-     * Not used as a filter — only the defaults + blogContext determine output.
-     */
-    frontmatter_schema?: string[];
-    /**
-     * Public base URL of the site (e.g. "https://example.com"). Used by
-     * post_to_blog to construct the live URL stamped on `blogContext.lastPublish.publishedUrl`
-     * so the file-tree right-click menu can surface "View Post" after a publish.
-     * inspect_blog_repo proposes this from `CNAME` / `public/CNAME` when present.
-     */
-    site_url?: string;
-    /**
-     * URL path pattern for a blog post, with `{slug}` as the placeholder.
-     * Default: `/blog/{slug}/`. Used together with `site_url` to build the live URL.
-     */
-    blog_url_pattern?: string;
-    /**
-     * How image paths are written into frontmatter + body:
-     *   "relative" — no leading slash (`images/og/x.png`); the site's template
-     *                prepends the slash (e.g. Astro `<img src={`/${image}`}>`).
-     *   "absolute" — leading slash (`/images/og/x.png`); value used verbatim.
-     * Inferred by inspect_blog_repo from existing posts' image values. Absent ⇒
-     * "absolute" — the legacy behavior the plugin always had before this field.
-     * adr: adr/blog-image-contract.md
-     */
-    image_path_style?: 'relative' | 'absolute';
-    /**
-     * Filename template the published COVER image is copied under. Placeholders:
-     *   `{slug}` — the post slug
-     *   `{ext}`  — the source file's extension, no dot (preserved from the
-     *              `/_images/` original)
-     * Default `og-{slug}.{ext}`. Deterministic: same doc + same slug ⇒ same
-     * cover filename on every republish (idempotent overwrite, no orphaned
-     * cover files). Inferred by inspect_blog_repo from existing posts.
-     * adr: adr/blog-image-contract.md
-     */
-    image_naming?: string;
-}
-export declare function listBlogSites(): Promise<BlogSite[]>;
-export declare function writeBlogSites(sites: BlogSite[]): Promise<void>;

package/dist/plugins/github/dist/helpers.js

@@ -1,67 +0,0 @@
-/**
- * Local helpers for the github plugin — server-module bridge.
- * Mirrors the lazy-import pattern from plugins/publish/src/helpers.ts.
- */
-// npm package:  dist/plugins/github/dist/helpers.js → ../../../server/
-// Monorepo dev: plugins/github/dist/helpers.js     → ../../../packages/openwriter/dist/server/
-const npmBase = new URL('../../../server/', import.meta.url).href;
-const monoBase = new URL('../../../packages/openwriter/dist/server/', import.meta.url).href;
-let _cached = null;
-async function tryImport(base) {
-    const [helpers, state, ws, markdown, schemaGate] = await Promise.all([
-        import(base + 'helpers.js'),
-        import(base + 'state.js'),
-        import(base + 'ws.js'),
-        import(base + 'markdown.js'),
-        import(base + 'blog-schema-gate.js'),
-    ]);
-    return { helpers, state, ws, markdown, schemaGate };
-}
-export async function getServerModules() {
-    if (_cached)
-        return _cached;
-    let helpers, state, ws, markdown, schemaGate;
-    try {
-        ({ helpers, state, ws, markdown, schemaGate } = await tryImport(npmBase));
-    }
-    catch {
-        ({ helpers, state, ws, markdown, schemaGate } = await tryImport(monoBase));
-    }
-    _cached = {
-        getDataDir: helpers.getDataDir,
-        readConfig: helpers.readConfig,
-        saveConfig: helpers.saveConfig,
-        save: state.save,
-        cancelDebouncedSave: state.cancelDebouncedSave,
-        getDocument: state.getDocument,
-        getTitle: state.getTitle,
-        getMetadata: state.getMetadata,
-        getDocId: state.getDocId,
-        setMetadata: state.setMetadata,
-        bumpDocVersion: state.bumpDocVersion,
-        broadcastSyncStatus: ws.broadcastSyncStatus,
-        broadcastMetadataChanged: ws.broadcastMetadataChanged,
-        broadcastDocumentsChanged: ws.broadcastDocumentsChanged,
-        broadcastToast: ws.broadcastToast,
-        tiptapToMarkdown: markdown.tiptapToMarkdown,
-        validateBlogFrontmatter: schemaGate.validateBlogFrontmatter,
-    };
-    return _cached;
-}
-const PLUGIN_NAME = '@openwriter/plugin-github';
-export async function listBlogSites() {
-    const srv = await getServerModules();
-    const cfg = srv.readConfig() || {};
-    const slot = cfg.plugins?.[PLUGIN_NAME];
-    return slot?.blogSites || [];
-}
-// adr: adr/plugin-slot-nested-data.md
-export async function writeBlogSites(sites) {
-    const srv = await getServerModules();
-    const cfg = srv.readConfig() || {};
-    const plugins = { ...(cfg.plugins || {}) };
-    const slot = { ...(plugins[PLUGIN_NAME] || { enabled: true, config: {} }) };
-    slot.blogSites = sites;
-    plugins[PLUGIN_NAME] = slot;
-    srv.saveConfig({ plugins });
-}

package/dist/plugins/github/dist/index.d.ts

@@ -1,12 +0,0 @@
-/**
- * GitHub Plugin for OpenWriter.
- * Provides two capabilities:
- *   1. Docs backup sync — lifted from core. Auth: existing `gh auth`.
- *   2. Blog sites (Phase 3+) — list of blog repos, post via local git ops.
- *
- * This phase ships capability 1 only. Routes match the previous core mount
- * points exactly so SyncButton + SyncSetupModal continue to work unchanged.
- */
-import type { OpenWriterPlugin } from './helpers.js';
-declare const plugin: OpenWriterPlugin;
-export default plugin;