npm - next-content-overlay - Versions diffs - 1.0.0 → 1.1.0 - Mend

next-content-overlay 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/README.md CHANGED Viewed

@@ -1,232 +1,310 @@
-# next-content-overlay
-**Plug-and-play inline CMS for Next.js — click text on the page, edit it, publish. No database.**
-`next-content-overlay` gives any Next.js App Router project a Squarespace-style inline editor in three files. Your content lives in a plain JSON file in your repo. Version control handles history. There is no CMS platform, no vendor lock-in, no config hell.
-It started as a CLI-only tool in v0.1 (`init → scan → edit → publish`). As of **v1.0** the primary interface is a React component + server bundle that you drop into a layout — and the CLI is still there as a secondary workflow when you'd rather edit copy from the terminal.
-> **From v0.1 → v1.0:** the CLI still ships and still works. The big upgrade is that you can now edit text visually, on the page, with drafts and version history, without leaving the browser. See [CHANGELOG.md](CHANGELOG.md) for the full migration guide.
-## Install
-```bash
-npm i -D next-content-overlay
-```
-## Quickstart (visual editor — 3 files)
-### 1. Wrap your root layout
-```tsx
-// app/layout.tsx
-import { ContentOverlayProvider, EditModeToggle } from "next-content-overlay";
-import { getContent } from "next-content-overlay/server";
-export default async function RootLayout({ children }: { children: React.ReactNode }) {
-  const content = await getContent();
-  return (
-    <html>
-      <body>
-        <ContentOverlayProvider initialContent={content}>
-          {children}
-          <EditModeToggle />
-        </ContentOverlayProvider>
-      </body>
-    </html>
-  );
-}
-```
-### 2. Wrap any text in `<Editable>`
-```tsx
-// app/page.tsx
-import { Editable } from "next-content-overlay";
-export default function Page() {
-  return (
-    <main>
-      <Editable k="hero.title" as="h1">Welcome to my site</Editable>
-      <Editable k="hero.subtitle" as="p" multiline>
-        Build something amazing with zero config.
-      </Editable>
-    </main>
-  );
-}
-```
-### 3. Mount the API handler
-```ts
-// app/api/content-overlay/[...action]/route.ts
-import { createContentAPI } from "next-content-overlay/server";
-const handler = createContentAPI();
-export const GET = handler;
-export const POST = handler;
-```
-Or scaffold it with one command:
-```bash
-npx content-overlay setup
-```
-**That's it.** Press `Ctrl+Shift+E`, click any `<Editable>` text, edit it, save. Click **Publish Drafts** when you're ready to ship.
-## How it works
-```
-┌───────────────────────┐      ┌──────────────────────┐      ┌──────────────────────────┐
-│ <Editable> component  │ ───▶ │ createContentAPI()   │ ───▶ │ content/site.json        │
-│ (click-to-edit UI)    │      │ (Next.js route)      │      │ .overlay-content/*.json  │
-└───────────────────────┘      └──────────────────────┘      └──────────────────────────┘
-```
-- **`content/site.json`** — your published content, committed to git.
-- **`.overlay-content/draft.json`** — working drafts (per-key versioned).
-- **`.overlay-content/history.json`** — per-key version history for restore.
-All JSON. All in your repo. No database, no external service.
-## Components API
-### `<ContentOverlayProvider>`
-| Prop             | Type                          | Default                   | Description |
-|------------------|-------------------------------|---------------------------|-------------|
-| `initialContent` | `Record<string, string>`      | `{}`                      | Published content map from `getContent()` for SSR hydration. |
-| `basePath`       | `string`                      | `"/api/content-overlay"`  | Mount path for the API route. |
-| `shortcut`       | `string`                      | `"ctrl+shift+e"`          | Keyboard shortcut to toggle edit mode. |
-### `<Editable>`
-| Prop        | Type                 | Default     | Description |
-|-------------|----------------------|-------------|-------------|
-| `k`         | `string`             | *(required)* | Stable content key (e.g. `"hero.title"`). |
-| `as`        | `keyof JSX.IntrinsicElements` | `"span"` | Element to render in view mode. |
-| `children`  | `ReactNode`          | —           | Default text used until a published value exists. |
-| `multiline` | `boolean`            | `false`     | Allow newlines; uses textarea instead of single-line input. |
-| `maxLength` | `number`             | `5000`      | Soft character limit. |
-| `deletable` | `boolean`            | `false`     | Show a Delete button in the editor. |
-| `className` | `string`             | —           | Passed through to the rendered element. |
-### `<EditModeToggle>`
-| Prop       | Type                                             | Default         |
-|------------|--------------------------------------------------|-----------------|
-| `position` | `"bottom-left" \| "bottom-right" \| "top-left" \| "top-right"` | `"bottom-left"` |
-| `className`| `string`                                         | —               |
-### `useContentOverlay()`
-Hook for reading edit-mode state (`isAdmin`, `isEditMode`, `pendingCount`, etc.) from custom components.
-## Server API
-| Export             | From                           | Description |
-|--------------------|--------------------------------|-------------|
-| `createContentAPI` | `next-content-overlay/server`  | Factory returning a catch-all route handler. |
-| `getContent`       | `next-content-overlay/server`  | Reads `content/site.json` for SSR. |
-| `ContentStorage`   | `next-content-overlay/server`  | Class wrapping the file-backed store. Useful for scripts. |
-| `defaultAdminCheck`| `next-content-overlay/server`  | The built-in admin check (dev-mode + secret cookie). |
-### `createContentAPI(options?)`
-```ts
-createContentAPI({
-  isAdmin: (request) => boolean | Promise<boolean>, // Custom admin check
-  contentDir: process.cwd(),                         // Where to read/write files
-  revalidatePaths: ["/"],                            // Next.js paths to revalidate on publish
-});
-```
-Sub-routes mounted under `[...action]`:
-| Method | Path                        | Purpose |
-|--------|-----------------------------|---------|
-| GET    | `/me`                       | Admin check + unpublished count |
-| GET    | `/content?keys=a,b&includeDraft=1` | Fetch published or draft values |
-| POST   | `/save`                     | Upsert a draft (increments version, logs history) |
-| POST   | `/publish`                  | Promote drafts to `content/site.json` |
-| GET    | `/history?key=hero.title`   | List version history for a key |
-| POST   | `/restore`                  | Restore a historical version as a new draft |
-| POST   | `/login`                    | Validate the shared secret and set a cookie |
-## Auth & admin access
-Three layered defaults, pick whichever fits:
-1. **No config** — you're automatically admin in `NODE_ENV === "development"`.
-2. **`CONTENT_OVERLAY_SECRET`** env var — in production, users hit `Ctrl+Shift+E`, type the
-   secret once in a modal, and an httpOnly cookie keeps them signed in.
-3. **Custom callback** — `createContentAPI({ isAdmin: (req) => myAuthCheck(req) })` to
-   integrate with your existing session / Supabase / Auth.js setup.
-## CLI commands (secondary workflow)
-The v0.1 CLI still ships and shares storage with the visual editor — so a change
-made in one shows up in the other.
-```bash
-content-overlay init [--force]     # Create config + content files
-content-overlay scan               # Scan JSX for text strings
-content-overlay edit <key> <val>   # Update a draft value
-content-overlay publish            # Promote drafts to published content
-content-overlay setup [--force]    # Scaffold the visual-editor API route
-content-overlay --help
-content-overlay --version
-```
-Generated files:
-| File | Purpose |
-|------|---------|
-| `content-overlay.config.json` | Scan dirs, extensions, file paths |
-| `content/site.json` | Published content (your app reads this) |
-| `.overlay-content/content-map.json` | Auto-generated key → source mapping |
-| `.overlay-content/draft.json` | Working drafts (versioned `DraftEntry` objects) |
-| `.overlay-content/history.json` | Per-key version history |
-| `.overlay-content/last-publish.json` | Publish metadata |
-## 5-minute demo
-A runnable Next.js demo app is included:
-```bash
-cd examples/next-demo
-npm install
-npm run dev
-```
-Open `http://localhost:3000`, press `Ctrl+Shift+E`, click the headline, edit it, save,
-then click **Publish Drafts**. Refresh — the new text is in `content/site.json`.
-## Migrating from v0.1
-See [CHANGELOG.md](CHANGELOG.md#100---plug-and-play-inline-cms) for the full migration
-guide. The short version: the CLI keeps working, `content/site.json` is unchanged, and
-the draft file format auto-migrates on first read (with a backup).
-## Local development
-```bash
-npm install
-npm run check
-```
-`npm run check` runs typecheck, tests, build, and license check.
-## Show your setup
-If you're using `next-content-overlay` in a project, we'd love to see it in action.
-Share a short screen capture in [Show & Tell Discussions](../../discussions/categories/show-and-tell).
-## Contributing
-See [CONTRIBUTING.md](CONTRIBUTING.md).
-## License
-MIT — see [LICENSE](LICENSE).
+# next-content-overlay
+**Plug-and-play inline CMS for Next.js — click text on the page, edit it, publish. No database.**
+`next-content-overlay` gives any Next.js App Router project a Squarespace-style inline editor in three files. Your content lives in a plain JSON file in your repo (by default — v1.1 lets you plug in any backend). Version control handles history. There is no CMS platform, no vendor lock-in, no config hell.
+It started as a CLI-only tool in v0.1 (`init → scan → edit → publish`). As of **v1.0** the primary interface is a React component + server bundle that you drop into a layout — and the CLI is still there as a secondary workflow when you'd rather edit copy from the terminal.
+> **From v0.1 → v1.0:** the CLI still ships and still works. The big upgrade is that you can now edit text visually, on the page, with drafts and version history, without leaving the browser. See [CHANGELOG.md](CHANGELOG.md) for the full migration guide.
+## Install
+```bash
+npm i -D next-content-overlay
+```
+## Quickstart (visual editor — 3 files)
+### 1. Wrap your root layout
+```tsx
+// app/layout.tsx
+import { ContentOverlayProvider, EditModeToggle } from "next-content-overlay";
+import { getContent } from "next-content-overlay/server";
+export default async function RootLayout({ children }: { children: React.ReactNode }) {
+  const content = await getContent();
+  return (
+    <html>
+      <body>
+        <ContentOverlayProvider initialContent={content}>
+          {children}
+          <EditModeToggle />
+        </ContentOverlayProvider>
+      </body>
+    </html>
+  );
+}
+```
+### 2. Wrap any text in `<Editable>`
+```tsx
+// app/page.tsx
+import { Editable } from "next-content-overlay";
+export default function Page() {
+  return (
+    <main>
+      <Editable k="hero.title" as="h1">Welcome to my site</Editable>
+      <Editable k="hero.subtitle" as="p" multiline>
+        Build something amazing with zero config.
+      </Editable>
+    </main>
+  );
+}
+```
+### 3. Mount the API handler
+```ts
+// app/api/content-overlay/[...action]/route.ts
+import { createContentAPI } from "next-content-overlay/server";
+const handler = createContentAPI();
+export const GET = handler;
+export const POST = handler;
+```
+Or scaffold it with one command:
+```bash
+npx content-overlay setup
+```
+**That's it.** Press `Ctrl+Shift+E`, click any `<Editable>` text, edit it, save. Click **Publish Drafts** when you're ready to ship.
+## How it works
+```
+┌───────────────────────┐      ┌──────────────────────┐      ┌──────────────────────────┐
+│ <Editable> component  │ ───▶ │ createContentAPI()   │ ───▶ │ content/site.json        │
+│ (click-to-edit UI)    │      │ (Next.js route)      │      │ .overlay-content/*.json  │
+└───────────────────────┘      └──────────────────────┘      └──────────────────────────┘
+```
+- **`content/site.json`** — your published content, committed to git.
+- **`.overlay-content/draft.json`** — working drafts (per-key versioned).
+- **`.overlay-content/history.json`** — per-key version history for restore.
+All JSON. All in your repo. No database, no external service.
+## Components API
+### `<ContentOverlayProvider>`
+| Prop             | Type                          | Default                   | Description |
+|------------------|-------------------------------|---------------------------|-------------|
+| `initialContent` | `Record<string, string>`      | `{}`                      | Published content map from `getContent()` for SSR hydration. |
+| `basePath`       | `string`                      | `"/api/content-overlay"`  | Mount path for the API route. |
+| `shortcut`       | `string`                      | `"ctrl+shift+e"`          | Keyboard shortcut to toggle edit mode. |
+### `<Editable>`
+| Prop        | Type                 | Default     | Description |
+|-------------|----------------------|-------------|-------------|
+| `k`         | `string`             | *(required)* | Stable content key (e.g. `"hero.title"`). |
+| `as`        | `keyof JSX.IntrinsicElements` | `"span"` | Element to render in view mode. |
+| `children`  | `ReactNode`          | —           | Default text used until a published value exists. |
+| `multiline` | `boolean`            | `false`     | Allow newlines; uses textarea instead of single-line input. |
+| `maxLength` | `number`             | `5000`      | Soft character limit. |
+| `deletable` | `boolean`            | `false`     | Show a Delete button in the editor. |
+| `className` | `string`             | —           | Passed through to the rendered element. |
+### `<EditModeToggle>`
+| Prop       | Type                                             | Default         |
+|------------|--------------------------------------------------|-----------------|
+| `position` | `"bottom-left" \| "bottom-right" \| "top-left" \| "top-right"` | `"bottom-left"` |
+| `className`| `string`                                         | —               |
+### `useContentOverlay()`
+Hook for reading edit-mode state (`isAdmin`, `isEditMode`, `pendingCount`, etc.) from custom components.
+## Server API
+| Export             | From                           | Description |
+|--------------------|--------------------------------|-------------|
+| `createContentAPI` | `next-content-overlay/server`  | Factory returning a catch-all route handler. |
+| `getContent`       | `next-content-overlay/server`  | Reads `content/site.json` for SSR. |
+| `ContentStorage`   | `next-content-overlay/server`  | Class wrapping the file-backed store. Useful for scripts. |
+| `defaultAdminCheck`| `next-content-overlay/server`  | The built-in admin check (dev-mode + secret cookie). |
+### `createContentAPI(options?)`
+```ts
+createContentAPI({
+  isAdmin: (request) => boolean | Promise<boolean>, // Custom admin check
+  contentDir: process.cwd(),                         // Where to read/write files
+  revalidatePaths: ["/"],                            // Next.js paths to revalidate on publish
+});
+```
+Sub-routes mounted under `[...action]`:
+| Method | Path                        | Purpose |
+|--------|-----------------------------|---------|
+| GET    | `/me`                       | Admin check + unpublished count |
+| GET    | `/content?keys=a,b&includeDraft=1` | Fetch published or draft values |
+| POST   | `/save`                     | Upsert a draft (increments version, logs history) |
+| POST   | `/publish`                  | Promote drafts to `content/site.json` |
+| GET    | `/history?key=hero.title`   | List version history for a key |
+| POST   | `/restore`                  | Restore a historical version as a new draft |
+| POST   | `/login`                    | Validate the shared secret and set a cookie |
+## Making edits persist
+Where you run the editor determines how your changes stick around. The
+default storage backend is **file-based** — drafts and published content live
+in JSON files in your repo:
+- **Local dev (`npm run dev`)** — edits write to `content/site.json` and
+  `.overlay-content/*` on your disk. Commit those files to git to ship them.
+  This is the intended workflow with the default backend: edit visually, then
+  `git add content/ && git commit && git push`.
+- **Deployed host (Vercel, Netlify, Cloudflare, etc.)** — the filesystem is
+  ephemeral, so any "publish" made against the live site with the default
+  backend is **lost on the next deploy**. Treat the deployed editor as a
+  preview only, or plug in a durable storage adapter (see below).
+- **Want edits from the live site to persist?** Implement a `StorageAdapter`
+  backed by your own database, blob store, or the GitHub API. The seam is
+  built in as of v1.1 — see the next section.
+**TL;DR:** for local-only or solo workflows, edit → publish → commit → push.
+For team / production editing, plug in a custom storage adapter.
+## Pluggable storage (v1.1+)
+The default `ContentStorage` writes to JSON files. If you want edits to persist
+somewhere durable — Postgres, Supabase, Redis, S3, GitHub via the API, your own
+internal service — implement the `StorageAdapter` interface and pass an
+instance into `createContentAPI` and `getContent`.
+```ts
+import type { StorageAdapter } from "next-content-overlay/server";
+export class PostgresAdapter implements StorageAdapter {
+  constructor(private db: MyDbClient) {}
+  async getPublished()                       { /* SELECT key, value FROM content_published */ }
+  async getContent(keys, includeDraft)       { /* fetch by keys, overlay drafts if admin */ }
+  async saveDraft(key, value, baseValue)     { /* INSERT ... RETURNING version */ }
+  async publish(keys)                        { /* copy drafts → published in a tx */ }
+  async getHistory(key, limit)               { /* SELECT ... ORDER BY version DESC */ }
+  async restoreVersion(key, version)         { /* clone old row as new draft */ }
+  async getUnpublishedCount()                { /* SELECT count(*) WHERE draft <> published */ }
+}
+```
+Wire it into the route handler and your SSR helper:
+```ts
+// app/api/content-overlay/[...action]/route.ts
+import { createContentAPI } from "next-content-overlay/server";
+import { PostgresAdapter } from "@/lib/content-adapter";
+const storage = new PostgresAdapter(db);
+const handler = createContentAPI({ storage });
+export const GET = handler;
+export const POST = handler;
+```
+```ts
+// app/layout.tsx
+import { getContent } from "next-content-overlay/server";
+import { storage } from "@/lib/content-adapter";
+const content = await getContent({ storage });
+```
+That's the whole integration. Once your adapter is wired in, edits made from
+the live deployed site survive deploys, and your non-technical teammates can
+edit copy without a git commit.
+The `StorageAdapter` interface is intentionally tiny (7 methods, all
+key/value + versioning). The file-backed `ContentStorage` is the reference
+implementation — read [`src/server/storage.ts`](src/server/storage.ts) when
+building your own.
+> **No official DB drivers ship in this package.** That's deliberate — picking
+> Postgres vs. Supabase vs. Mongo vs. GitHub is your call, not the library's.
+> Community adapters welcome via PR.
+## Auth & admin access
+Three layered defaults, pick whichever fits:
+1. **No config** — you're automatically admin in `NODE_ENV === "development"`.
+2. **`CONTENT_OVERLAY_SECRET`** env var — in production, users hit `Ctrl+Shift+E`, type the
+   secret once in a modal, and an httpOnly cookie keeps them signed in.
+3. **Custom callback** — `createContentAPI({ isAdmin: (req) => myAuthCheck(req) })` to
+   integrate with your existing session / Supabase / Auth.js setup.
+## CLI commands (secondary workflow)
+The v0.1 CLI still ships and shares storage with the visual editor — so a change
+made in one shows up in the other.
+```bash
+content-overlay init [--force]     # Create config + content files
+content-overlay scan               # Scan JSX for text strings
+content-overlay edit <key> <val>   # Update a draft value
+content-overlay publish            # Promote drafts to published content
+content-overlay setup [--force]    # Scaffold the visual-editor API route
+content-overlay --help
+content-overlay --version
+```
+Generated files:
+| File | Purpose |
+|------|---------|
+| `content-overlay.config.json` | Scan dirs, extensions, file paths |
+| `content/site.json` | Published content (your app reads this) |
+| `.overlay-content/content-map.json` | Auto-generated key → source mapping |
+| `.overlay-content/draft.json` | Working drafts (versioned `DraftEntry` objects) |
+| `.overlay-content/history.json` | Per-key version history |
+| `.overlay-content/last-publish.json` | Publish metadata |
+## 5-minute demo
+A runnable Next.js demo app is included:
+```bash
+cd examples/next-demo
+npm install
+npm run dev
+```
+Open `http://localhost:3000`, press `Ctrl+Shift+E`, click the headline, edit it, save,
+then click **Publish Drafts**. Refresh — the new text is in `content/site.json`.
+## Migrating from v0.1
+See [CHANGELOG.md](CHANGELOG.md#100---plug-and-play-inline-cms) for the full migration
+guide. The short version: the CLI keeps working, `content/site.json` is unchanged, and
+the draft file format auto-migrates on first read (with a backup).
+## Local development
+```bash
+npm install
+npm run check
+```
+`npm run check` runs typecheck, tests, build, and license check.
+## Show your setup
+If you're using `next-content-overlay` in a project, we'd love to see it in action.
+Share a short screen capture in [Show & Tell Discussions](../../discussions/categories/show-and-tell).
+## Contributing
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+## License
+MIT — see [LICENSE](LICENSE).

package/dist/server/index.d.ts CHANGED Viewed

@@ -9,13 +9,53 @@ type HistoryEntry = {
     changeType: "save_draft" | "publish" | "restore";
     changedAt: string;
 };
+/**
+ * Pluggable storage backend. The default is file-backed (`ContentStorage`),
+ * but you can supply your own — e.g. Postgres, Supabase, Redis, GitHub API —
+ * to make edits persist across deploys on hosts with ephemeral filesystems.
+ *
+ * Pass an instance to `createContentAPI({ storage })` and to `getContent({ storage })`.
+ */
+interface StorageAdapter {
+    /** Flat map of all published key→value pairs. Used by SSR and the API. */
+    getPublished(): Promise<Record<string, string>>;
+    /** Resolve a set of keys, optionally overlaying drafts for admins. */
+    getContent(keys: string[], includeDraft: boolean): Promise<{
+        content: Record<string, string>;
+        versions: Record<string, number>;
+    }>;
+    /** Upsert a draft value for a key, returning the new draft version. */
+    saveDraft(key: string, value: string, baseValue?: string): Promise<{
+        version: number;
+    }>;
+    /** Promote drafts to published. If keys are omitted, publish all changed drafts. */
+    publish(keys?: string[]): Promise<{
+        publishedCount: number;
+        changedKeys: string[];
+    }>;
+    /** Newest-first version history for a key. */
+    getHistory(key: string, limit?: number): Promise<HistoryEntry[]>;
+    /** Restore a historical version as a new draft. */
+    restoreVersion(key: string, version: number): Promise<{
+        value: string;
+        version: number;
+    }>;
+    /** Count of keys whose draft differs from published. */
+    getUnpublishedCount(): Promise<number>;
+}
 type ContentAPIOptions = {
     /** Custom admin check. Defaults to env var / dev-mode check. */
     isAdmin?: (request: Request) => Promise<boolean> | boolean;
-    /** Project root directory. Default: process.cwd() */
+    /** Project root directory. Default: process.cwd(). Ignored if `storage` is provided. */
     contentDir?: string;
     /** Paths to revalidate after publish (Next.js revalidatePath). */
     revalidatePaths?: string[];
+    /**
+     * Custom storage backend. Defaults to the file-backed `ContentStorage`
+     * rooted at `contentDir`. Supply your own adapter to persist edits to a
+     * database or remote service.
+     */
+    storage?: StorageAdapter;
 };
 type RouteContext = {
@@ -38,7 +78,7 @@ type RouteContext = {
 declare function createContentAPI(options?: ContentAPIOptions): (request: Request, context: RouteContext) => Promise<Response>;
 type DraftStore = Record<string, DraftEntry>;
-declare class ContentStorage {
+declare class ContentStorage implements StorageAdapter {
     private contentPath;
     private draftPath;
     private historyPath;
@@ -83,14 +123,20 @@ declare class ContentStorage {
     private withLock;
 }
+type GetContentOptions = {
+    /** Project root directory. Default: process.cwd(). Ignored if `storage` is provided. */
+    rootDir?: string;
+    /** Custom storage adapter. If provided, reads published content from it. */
+    storage?: StorageAdapter;
+};
 /**
- * Read published content from content/site.json.
- * Use this in server components to pass initialContent to ContentOverlayProvider.
+ * Read published content for SSR. Defaults to reading `content/site.json`
+ * from disk, but accepts a custom `StorageAdapter` so database-backed setups
+ * can hydrate the provider the same way.
  *
- * @param rootDir - Project root directory. Default: process.cwd()
- * @returns Record<string, string> of published content
+ * Backward compatible: `getContent()` and `getContent("/my/root")` still work.
  */
-declare function getContent(rootDir?: string): Promise<Record<string, string>>;
+declare function getContent(optionsOrRootDir?: string | GetContentOptions): Promise<Record<string, string>>;
 /**
  * Default admin check for content-overlay API routes.
@@ -101,4 +147,4 @@ declare function getContent(rootDir?: string): Promise<Record<string, string>>;
  */
 declare function defaultAdminCheck(request: Request): boolean;
-export { ContentStorage, createContentAPI, defaultAdminCheck, getContent };
+export { type ContentAPIOptions, ContentStorage, type DraftEntry, type HistoryEntry, type StorageAdapter, createContentAPI, defaultAdminCheck, getContent };

package/dist/server/index.js CHANGED Viewed

@@ -300,7 +300,7 @@ function buildTokenCookie(secret) {
 // src/server/createContentAPI.ts
 function createContentAPI(options = {}) {
-  const storage = new ContentStorage(options.contentDir ?? process.cwd());
+  const storage = options.storage ?? new ContentStorage(options.contentDir ?? process.cwd());
   const checkAdmin = options.isAdmin ?? defaultAdminCheck;
   return async function handler(request, context) {
     const { action } = await context.params;
@@ -427,8 +427,12 @@ function json(data, status = 200) {
 // src/server/content.ts
 import path3 from "path";
-async function getContent(rootDir) {
-  const contentPath = path3.join(rootDir ?? process.cwd(), "content", "site.json");
+async function getContent(optionsOrRootDir) {
+  const options = typeof optionsOrRootDir === "string" ? { rootDir: optionsOrRootDir } : optionsOrRootDir ?? {};
+  if (options.storage) {
+    return options.storage.getPublished();
+  }
+  const contentPath = path3.join(options.rootDir ?? process.cwd(), "content", "site.json");
   const raw = await readJsonFile(contentPath);
   if (!raw || typeof raw !== "object" || Array.isArray(raw)) return {};
   const result = {};

package/package.json CHANGED Viewed

@@ -1,56 +1,56 @@
-{
-  "name": "next-content-overlay",
-  "version": "1.0.0",
-  "description": "Plug-and-play inline CMS for Next.js App Router — edit text on the page, no database needed",
-  "license": "MIT",
-  "type": "module",
-  "bin": {
-    "content-overlay": "./dist/cli/index.js"
-  },
-  "exports": {
-    ".": {
-      "import": "./dist/react/index.js",
-      "types": "./dist/react/index.d.ts"
-    },
-    "./server": {
-      "import": "./dist/server/index.js",
-      "types": "./dist/server/index.d.ts"
-    }
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsx src/cli/index.ts",
-    "typecheck": "tsc --noEmit",
-    "test": "tsx --test tests/**/*.test.ts",
-    "license:check": "node scripts/license-check.mjs",
-    "check": "npm run typecheck && npm run test && npm run build && npm run license:check",
-    "prepack": "npm run check"
-  },
-  "peerDependencies": {
-    "next": ">=14.0.0",
-    "react": ">=18.0.0",
-    "react-dom": ">=18.0.0"
-  },
-  "peerDependenciesMeta": {
-    "react": { "optional": true },
-    "react-dom": { "optional": true }
-  },
-  "devDependencies": {
-    "@types/node": "^22.13.10",
-    "@types/react": "^19.0.0",
-    "next": "^15.0.0",
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0",
-    "tsup": "^8.4.0",
-    "tsx": "^4.19.3",
-    "typescript": "^5.8.2"
-  },
-  "engines": {
-    "node": ">=20.0.0"
-  }
-}
+{
+  "name": "next-content-overlay",
+  "version": "1.1.0",
+  "description": "Plug-and-play inline CMS for Next.js App Router — edit text on the page, no database needed",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "content-overlay": "./dist/cli/index.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/react/index.js",
+      "types": "./dist/react/index.d.ts"
+    },
+    "./server": {
+      "import": "./dist/server/index.js",
+      "types": "./dist/server/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsx src/cli/index.ts",
+    "typecheck": "tsc --noEmit",
+    "test": "tsx --test tests/**/*.test.ts",
+    "license:check": "node scripts/license-check.mjs",
+    "check": "npm run typecheck && npm run test && npm run build && npm run license:check",
+    "prepack": "npm run check"
+  },
+  "peerDependencies": {
+    "next": ">=14.0.0",
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": { "optional": true },
+    "react-dom": { "optional": true }
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.10",
+    "@types/react": "^19.0.0",
+    "next": "^15.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "tsup": "^8.4.0",
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.2"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}