@orhancodestudio/ocsm-core 0.1.0-alpha.2 → 0.1.0-alpha.3

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog — @orhancodestudio/ocsm-core
 
+## 0.1.0-alpha.3
+
+### Added
+
+- `ocsm.public` — a filesystem-only reader (`listDocuments`, `getDocument`,
+  `getLayout`, `getTheme`) for the public site. Decouples the production build
+  from GitHub: public pages read the committed checkout instead of the API
+  (faster, no rate limits, build never depends on GitHub availability). The live
+  GitHub backend still powers the editor's reads, writes, and media serving.
+
 ## 0.1.0-alpha.2
 
 ### Added

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orhancodestudio/ocsm-core",
-  "version": "0.1.0-alpha.2",
+  "version": "0.1.0-alpha.3",
   "description": "OCS Management — the git-based CMS core for Next.js. Built by Orhan Code Studio.",
   "license": "MIT",
   "author": "Orhan Code Studio (https://orhancodestudio.com)",

package/src/server/create-ocsm.ts

@@ -1,3 +1,4 @@
+import type { Block } from "../blocks/block.types";
 import type { OcsmConfig, ResolvedOcsmConfig } from "../config/config.types";
 import { resolveOcsmConfig } from "../config/resolve-config";
 import type { ContentStore } from "../content/content-store.interface";
@@ -6,41 +7,63 @@ import type {
   ContentDocumentMeta,
 } from "../content/content.types";
 import { createContentStore } from "../content/create-content-store";
-import { LayoutStore } from "../layout/layout-store";
+import { type LayoutRegion, LayoutStore } from "../layout/layout-store";
 import { MediaStore } from "../media/media-store";
 import { RoleStore } from "../roles/role-store";
 import { createFileBackend } from "../storage/create-file-backend";
+import { FsFileBackend } from "../storage/fs-file-backend";
 import { JsonStore } from "../storage/json-store";
 import { ThemeStore } from "../theme/theme-store";
+import type { OcsmTheme } from "../theme/theme.types";
 import { UserStore } from "../users/user-store";
 
+/**
+ * Read-only content access that always reads from the **local filesystem** (the
+ * repository checkout), regardless of the GitHub env. Use this for the public
+ * site so the production build/render never depends on the GitHub API — content
+ * is baked from the committed files and refreshed on each rebuild.
+ */
+export interface PublicReader {
+  listDocuments(collection: string): Promise<ContentDocumentMeta[]>;
+  getDocument(collection: string, slug: string): Promise<ContentDocument | null>;
+  getLayout(region: LayoutRegion): Promise<Block[]>;
+  getTheme(): Promise<OcsmTheme>;
+}
+
 /** A configured OCS Management instance, bound to a config and storage backend. */
 export interface Ocsm {
   /** The fully-resolved configuration. */
   readonly config: ResolvedOcsmConfig;
-  /** Content access (collections of MDX documents). */
+  /** Live content access (GitHub in production) — for the editor and writes. */
   readonly store: ContentStore;
   /** User management. */
   readonly users: UserStore;
   /** Role & permission management. */
   readonly roles: RoleStore;
-  /** Public-site theme. */
+  /** Public-site theme (live backend). */
   readonly theme: ThemeStore;
-  /** Global header/footer sections shared across every page. */
+  /** Global header/footer sections shared across every page (live backend). */
   readonly layout: LayoutStore;
-  /** Uploaded media (images) storage. */
+  /** Uploaded media (images) storage (live backend). */
   readonly media: MediaStore;
-  /** Lists documents in a collection. */
+  /**
+   * Filesystem-only reader for the public site. Decouples the build from GitHub:
+   * public pages read the checked-out files, not the API.
+   */
+  readonly public: PublicReader;
+  /** Lists documents in a collection (live backend). */
   listDocuments(collection: string): Promise<ContentDocumentMeta[]>;
-  /** Reads a single document, or `null` if it does not exist. */
+  /** Reads a single document, or `null` if it does not exist (live backend). */
   getDocument(collection: string, slug: string): Promise<ContentDocument | null>;
 }
 
 /**
  * Creates an {@link Ocsm} instance from an author-supplied config. Call once in a
- * server-only module and reuse the returned instance across the app. Content,
- * users, and theme all share a single storage backend (filesystem in dev,
- * GitHub in production).
+ * server-only module and reuse the returned instance across the app.
+ *
+ * The **live backend** (filesystem in dev, GitHub in production) powers the
+ * editor's live reads and all writes. A separate **filesystem reader**
+ * ({@link Ocsm.public}) serves the public site so the build never calls GitHub.
  *
  * @example
  * ```ts
@@ -53,10 +76,19 @@ export interface Ocsm {
  */
 export function createOcsm(config: OcsmConfig): Ocsm {
   const resolved = resolveOcsmConfig(config);
+
+  // Live backend: GitHub in production, filesystem in dev.
   const backend = createFileBackend();
   const store = createContentStore(resolved, backend);
   const json = new JsonStore(backend);
 
+  // Public reader: always the local filesystem (the repo checkout).
+  const fsBackend = new FsFileBackend();
+  const publicStore = createContentStore(resolved, fsBackend);
+  const publicJson = new JsonStore(fsBackend);
+  const publicLayout = new LayoutStore(publicJson);
+  const publicTheme = new ThemeStore(publicJson);
+
   return {
     config: resolved,
     store,
@@ -65,6 +97,12 @@ export function createOcsm(config: OcsmConfig): Ocsm {
     theme: new ThemeStore(json),
     layout: new LayoutStore(json),
     media: new MediaStore(backend),
+    public: {
+      listDocuments: (collection) => publicStore.list(collection),
+      getDocument: (collection, slug) => publicStore.read(collection, slug),
+      getLayout: (region) => publicLayout.get(region),
+      getTheme: () => publicTheme.get(),
+    },
     listDocuments: (collection) => store.list(collection),
     getDocument: (collection, slug) => store.read(collection, slug),
   };

package/src/server/index.ts

@@ -1,4 +1,4 @@
-export { createOcsm, type Ocsm } from "./create-ocsm";
+export { createOcsm, type Ocsm, type PublicReader } from "./create-ocsm";
 export { deleteDocument, writeDocument } from "./documents";
 export { handleMediaRequest } from "./media-route";
 export { OcsmContent, type OcsmContentProps } from "./render-mdx";

package/src/version.ts

@@ -5,7 +5,7 @@
  * update checker ({@link ./update/check-for-updates}) and the admin "update available"
  * notice.
  */
-export const OCSM_VERSION = "0.1.0-alpha.2";
+export const OCSM_VERSION = "0.1.0-alpha.3";
 
 /** The published npm package name for the OCS Management core. */
 export const OCSM_PACKAGE_NAME = "@orhancodestudio/ocsm-core";