uncial-cms 0.0.0

package/dist/sveltekit/index.js

@@ -0,0 +1,98 @@
+/**
+ * `uncial-cms/sveltekit` — route factories for prerendered SvelteKit sites.
+ * `@sveltejs/kit` and `svelte` are peers of this subpath ONLY; the runtime
+ * root must not import them. This module runs at build time (prerender) and
+ * reads the local content directory with node:fs — do not import it from
+ * client-side code (the pure mapping lives in `./mapping.js` for that).
+ */
+import { readdirSync, readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { normalizeDocument } from 'uncial/core';
+import { defaultMapPathToSource, defaultMapSourceToPath } from '../paths/index.js';
+export { defaultMapPathToSource, defaultMapSourceToPath } from '../paths/index.js';
+function resolveSite(opts) {
+    if (opts.site) {
+        return {
+            config: opts.site.config,
+            localContentDir: opts.site.localContentDir,
+            localOnly: opts.site.localOnly
+        };
+    }
+    return { config: opts.config, localContentDir: opts.localContentDir, localOnly: false };
+}
+function listContentSources(localContentDir, prefix = '') {
+    const sources = [];
+    for (const entry of readdirSync(join(localContentDir, prefix), { withFileTypes: true })) {
+        const rel = prefix === '' ? entry.name : `${prefix}/${entry.name}`;
+        if (entry.isDirectory())
+            sources.push(...listContentSources(localContentDir, rel));
+        else if (entry.isFile() && entry.name.endsWith('.json'))
+            sources.push(rel);
+    }
+    return sources.sort();
+}
+function createEntries(opts, site) {
+    return () => listContentSources(site.localContentDir)
+        .map((rel) => {
+        const source = `${site.config.contentDir}/${rel}`;
+        return { path: defaultMapSourceToPath(source, site.config.contentDir), source };
+    })
+        .filter((entry) => !opts.exclude?.(entry))
+        .map(({ path }) => ({ path }));
+}
+/** The source for a site path, refusing one the site's `exclude` rules out. */
+function resolveSource(opts, site, sitePath) {
+    const map = opts.mapPathToSource ?? ((path) => defaultMapPathToSource(path, site.config.contentDir));
+    const source = map(sitePath);
+    if (opts.exclude?.({ path: sitePath, source })) {
+        throw new Error(`Content path "${sitePath}" is excluded from this site's routes.`);
+    }
+    return source;
+}
+function schemaFor(opts, path) {
+    return typeof opts.schema === 'function' ? opts.schema(path) : opts.schema;
+}
+/** Repo-root-relative source → path relative to the content dir (for local FS reads). */
+function contentDirRelative(source, contentDir) {
+    const prefix = `${contentDir}/`;
+    if (!source.startsWith(prefix)) {
+        throw new Error(`Source "${source}" is outside the content dir "${contentDir}".`);
+    }
+    return source.slice(prefix.length);
+}
+export function createContentHandlers(opts) {
+    const site = resolveSite(opts);
+    return {
+        entries: createEntries(opts, site),
+        load: async ({ params }) => {
+            const source = resolveSource(opts, site, params.path);
+            const rel = contentDirRelative(source, site.config.contentDir);
+            const raw = readFileSync(join(site.localContentDir, rel), 'utf-8');
+            const document = normalizeDocument(JSON.parse(raw), opts.blocks, schemaFor(opts, params.path));
+            return { document, meta: document.meta ?? {}, path: params.path };
+        }
+    };
+}
+export function createEditorHandlers(opts) {
+    const site = resolveSite(opts);
+    // A local-only site has no forge to commit to outside development, so its
+    // editor variants are development-only without anyone saying so.
+    const devOnly = opts.devOnly ?? site.localOnly;
+    const entries = createEntries(opts, site);
+    return {
+        // Prerendering a dynamic route walks `entries`: an empty list emits no editor pages.
+        // These routes are unlinked, so strict builds do not encounter them, while development
+        // servers still serve them on demand.
+        entries: () => (devOnly && !import.meta.env.DEV ? [] : entries()),
+        load: async ({ params }) => ({
+            sourcePath: resolveSource(opts, site, params.path),
+            pagePath: params.path
+        })
+    };
+}
+export function createIndexHandlers(opts) {
+    const config = opts.site ? opts.site.config : opts.config;
+    return {
+        load: async () => ({ config })
+    };
+}

package/dist/sveltekit/mapping.d.ts

@@ -0,0 +1 @@
+export { defaultMapPathToSource, defaultMapSourceToPath } from '../paths/index.js';

package/dist/sveltekit/mapping.js

@@ -0,0 +1 @@
+export { defaultMapPathToSource, defaultMapSourceToPath } from '../paths/index.js';

package/dist/types.d.ts

@@ -0,0 +1,53 @@
+export interface GitHubSiteConfig {
+    forge: 'github';
+    repo: string;
+    branch: string;
+    contentDir: string;
+    authWorkerUrl: string;
+    appSlug: string;
+    mediaDir?: string;
+}
+export interface LocalSiteConfig {
+    forge: 'local';
+    contentDir: string;
+    mediaDir?: string;
+}
+export type UncialCmsSiteConfig = GitHubSiteConfig | LocalSiteConfig;
+export interface ForgeSession {
+    token: string;
+    expiresAt: number | null;
+    repo: string;
+    user: {
+        login: string;
+        name: string;
+        email: string;
+    };
+}
+export type SessionProvider = (config: UncialCmsSiteConfig) => Promise<ForgeSession>;
+export interface ForgeAdapter {
+    authenticate(config: UncialCmsSiteConfig, provider: SessionProvider): Promise<ForgeSession>;
+    readFile(path: string): Promise<{
+        content: string;
+        sha: string;
+    }>;
+    writeFile(path: string, content: string | Uint8Array, opts: {
+        message: string;
+        sha?: string;
+        author: {
+            name: string;
+            email: string;
+        };
+    }): Promise<{
+        sha: string;
+        commitSha: string;
+    }>;
+    deleteFile(path: string, opts: {
+        message: string;
+        sha: string;
+    }): Promise<void>;
+    listDir(path: string): Promise<Array<{
+        path: string;
+        type: 'file' | 'dir';
+    }>>;
+    commitStatus(commitSha: string): Promise<'pending' | 'success' | 'failure' | 'unknown'>;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/upload-context.d.ts

@@ -0,0 +1,24 @@
+/**
+ * The active editor's forge, exposed so a block's in-editor UI (e.g. the Image
+ * block's Upload affordance) can reach the same authenticated adapter + author
+ * `mountEditorPage` uses — without threading them through the editor web
+ * component and every block's props.
+ *
+ * It is a single last-writer-wins slot: one page hosts one editor at a time.
+ * `createEditorController` sets it once the session is established;
+ * `mountEditorPage` clears it on teardown. A block reads it through
+ * {@link uploadImageAsset}, never directly.
+ */
+import type { ForgeAdapter, UncialCmsSiteConfig } from './types.js';
+export interface ActiveForge {
+    adapter: ForgeAdapter;
+    author: {
+        name: string;
+        email: string;
+    };
+    /** The session's site config, so an upload can default its `mediaDir`. */
+    config: UncialCmsSiteConfig;
+}
+export declare function setActiveForge(forge: ActiveForge): void;
+export declare function clearActiveForge(): void;
+export declare function getActiveForge(): ActiveForge | null;

package/dist/upload-context.js

@@ -0,0 +1,10 @@
+let active = null;
+export function setActiveForge(forge) {
+    active = forge;
+}
+export function clearActiveForge() {
+    active = null;
+}
+export function getActiveForge() {
+    return active;
+}

package/dist/vite/index.d.ts

@@ -0,0 +1,9 @@
+import type { Plugin } from 'vite';
+import type { SiteOptions } from '../define-site.js';
+/**
+ * The forge the build targets, as a string literal in the bundle. An editor
+ * page gates on it statically so a local-only production build drops the whole
+ * editor stack rather than merely leaving it unrouted.
+ */
+export declare const FORGE_DEFINE_KEY = "import.meta.env.UNCIAL_CMS_FORGE";
+export declare function uncialCms(options: SiteOptions): Plugin[];

package/dist/vite/index.js

@@ -0,0 +1,49 @@
+/**
+ * `uncial-cms/vite` — the plugins a site installs from its Vite config. Node
+ * only: it resolves paths on disk and imports Vite's own types.
+ */
+import { resolve } from 'node:path';
+import { createLocalVitePlugin } from '../local/vite.js';
+/**
+ * The forge the build targets, as a string literal in the bundle. An editor
+ * page gates on it statically so a local-only production build drops the whole
+ * editor stack rather than merely leaving it unrouted.
+ */
+export const FORGE_DEFINE_KEY = 'import.meta.env.UNCIAL_CMS_FORGE';
+/**
+ * The repository root the forge's paths are relative to. A site already declares
+ * the one pair of facts that fixes it: `contentDir` names the content directory
+ * from the repository root, `localContentDir` names the same directory on disk,
+ * so stripping the former's segments off the latter leaves the root above both.
+ */
+function repositoryRoot(options) {
+    const contentDir = trimSlashes(options.contentDir);
+    const local = resolve(options.localContentDir ?? options.contentDir);
+    const depth = contentDir === '' ? 0 : contentDir.split('/').length;
+    const root = resolve(local, ...Array.from({ length: depth }, () => '..'));
+    if (resolve(root, contentDir) !== local) {
+        throw new Error(`localContentDir must be where contentDir sits on disk: "${local}" does not end with "${contentDir}".`);
+    }
+    return root;
+}
+function trimSlashes(path) {
+    return path.replace(/^\/+|\/+$/g, '');
+}
+export function uncialCms(options) {
+    return [
+        createLocalVitePlugin({
+            root: repositoryRoot(options),
+            permittedRoots: [
+                trimSlashes(options.contentDir),
+                ...(options.mediaDir ? [trimSlashes(options.mediaDir)] : [])
+            ]
+        }),
+        {
+            name: 'uncial-cms:forge',
+            config(_config, env) {
+                const forge = env.command === 'serve' ? 'local' : options.github !== undefined ? 'github' : 'none';
+                return { define: { [FORGE_DEFINE_KEY]: JSON.stringify(forge) } };
+            }
+        }
+    ];
+}

package/package.json

@@ -0,0 +1,110 @@
+{
+	"name": "uncial-cms",
+	"version": "0.0.0",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/d-flood/uncial.git"
+	},
+	"bugs": {
+		"url": "https://github.com/d-flood/uncial/issues"
+	},
+	"homepage": "https://d-flood.github.io/uncial/",
+	"scripts": {
+		"dev": "vite dev",
+		"build": "vite build",
+		"preview": "vite preview",
+		"prepare": "pnpm exec svelte-kit sync || true",
+		"package": "PACKAGE=1 svelte-kit sync && PACKAGE=1 svelte-package --input src/lib --output dist",
+		"prepack": "pnpm run package && pnpm exec publint",
+		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+		"assert:clean-pages": "node dist/cli/bin.js assert-clean-pages",
+		"test:unit": "vitest --project server",
+		"test": "pnpm run test:unit -- --run && pnpm run test:browser -- --run && pnpm run test:e2e",
+		"test:e2e": "playwright test",
+		"test:cli": "node scripts/test-local-only-cli.mjs",
+		"test:browser": "vitest --project client"
+	},
+	"bin": {
+		"uncial-cms": "./dist/cli/bin.js"
+	},
+	"publishConfig": {
+		"access": "public",
+		"provenance": true
+	},
+	"files": [
+		"dist",
+		"!dist/**/*.test.*",
+		"!dist/**/*.spec.*"
+	],
+	"type": "module",
+	"sideEffects": false,
+	"types": "./dist/index.d.ts",
+	"exports": {
+		"./package.json": "./package.json",
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js"
+		},
+		"./session": {
+			"types": "./dist/editor-session.d.ts",
+			"default": "./dist/editor-session.js"
+		},
+		"./svelte": {
+			"types": "./dist/svelte/index.d.ts",
+			"svelte": "./dist/svelte/index.js",
+			"default": "./dist/svelte/index.js"
+		},
+		"./github": {
+			"types": "./dist/github/index.d.ts",
+			"default": "./dist/github/index.js"
+		},
+		"./local": {
+			"types": "./dist/local/index.d.ts",
+			"default": "./dist/local/index.js"
+		},
+		"./paths": {
+			"types": "./dist/paths/index.d.ts",
+			"default": "./dist/paths/index.js"
+		},
+		"./vite": {
+			"types": "./dist/vite/index.d.ts",
+			"default": "./dist/vite/index.js"
+		},
+		"./sveltekit": {
+			"types": "./dist/sveltekit/index.d.ts",
+			"default": "./dist/sveltekit/index.js"
+		}
+	},
+	"peerDependencies": {
+		"@sveltejs/kit": "^2.0.0",
+		"svelte": "^5.0.0",
+		"uncial": "workspace:^"
+	},
+	"peerDependenciesMeta": {
+		"@sveltejs/kit": {
+			"optional": true
+		}
+	},
+	"devDependencies": {
+		"@playwright/test": "^1.58.2",
+		"@sveltejs/adapter-static": "^3.0.10",
+		"@sveltejs/kit": "^2.50.2",
+		"@sveltejs/package": "^2.5.7",
+		"@sveltejs/vite-plugin-svelte": "^6.2.4",
+		"@vitest/browser-playwright": "^4.0.18",
+		"playwright": "^1.58.2",
+		"publint": "^0.3.17",
+		"svelte": "^5.56.10",
+		"svelte-check": "^4.4.2",
+		"typescript": "^5.9.3",
+		"vite": "^7.3.1",
+		"vitest": "^4.0.18",
+		"vitest-browser-svelte": "^2.0.2"
+	},
+	"keywords": [
+		"svelte",
+		"cms",
+		"github"
+	]
+}