@scribe-atp/next 0.1.0

package/README.md

@@ -0,0 +1,151 @@
+# @scribe-atp/next
+
+[![npm](https://img.shields.io/npm/v/@scribe-atp/next)](https://www.npmjs.com/package/@scribe-atp/next)
+[![license](https://img.shields.io/badge/license-MIT-blue)](https://github.com/ACregan/scribe-atp-sdk/blob/main/LICENSE)
+
+Next.js App Router adapter for reading [Scribe CMS](https://scribe-cms.app) content from the AT Protocol. Requires Next.js 13 or later.
+
+Wraps [`@scribe-atp/core`](https://www.npmjs.com/package/@scribe-atp/core) with Next.js-idiomatic factories for `generateStaticParams` and `generateMetadata`.
+
+> **App Router only.** For Pages Router support, use [`@scribe-atp/core`](https://www.npmjs.com/package/@scribe-atp/core) directly — see [Pages Router](#pages-router) below.
+
+## Installation
+
+```bash
+npm install @scribe-atp/next
+```
+
+## Usage
+
+Create a factory once and export its functions from your route files:
+
+```ts
+// lib/scribe.ts
+import { createScribeSite } from "@scribe-atp/next";
+
+export const scribe = createScribeSite("alice.bsky.social", "alice-bsky-social");
+```
+
+### Group index route — `/blog/[groupSlug]`
+
+```ts
+// app/blog/[groupSlug]/page.tsx
+import { scribe } from "@/lib/scribe";
+
+export const generateStaticParams = scribe.generateGroupParams;
+// → [{ groupSlug: "tech" }, { groupSlug: "life" }]
+
+export const generateMetadata = ({ params }: { params: { groupSlug: string } }) =>
+  scribe.generateGroupMetadata(params.groupSlug);
+
+export default function GroupPage({ params }: { params: { groupSlug: string } }) {
+  // ...
+}
+```
+
+### Article route — `/blog/[groupSlug]/[articleSlug]`
+
+```ts
+// app/blog/[groupSlug]/[articleSlug]/page.tsx
+import { scribe } from "@/lib/scribe";
+
+export const generateStaticParams = scribe.generateGroupArticleParams;
+// → [{ groupSlug: "tech", articleSlug: "hello" }, ...]
+
+export const generateMetadata = ({ params }: { params: { articleSlug: string } }) =>
+  scribe.generateArticleMetadata(params.articleSlug);
+
+export default function ArticlePage({ params }: { params: { groupSlug: string; articleSlug: string } }) {
+  // ...
+}
+```
+
+### Flat article route — `/blog/[articleSlug]`
+
+```ts
+// app/blog/[articleSlug]/page.tsx
+import { scribe } from "@/lib/scribe";
+
+export const generateStaticParams = scribe.generateArticleParams;
+// → [{ articleSlug: "hello" }, { articleSlug: "second" }, ...]
+```
+
+### Site index metadata
+
+```ts
+// app/blog/page.tsx
+import { scribe } from "@/lib/scribe";
+
+export const generateMetadata = scribe.generateSiteMetadata;
+```
+
+## Metadata
+
+The metadata generators are opinionated by design. They produce complete, ready-to-use `Metadata` objects including OpenGraph tags — you don't need to wire these up manually.
+
+| Generator | `title` | `description` | OpenGraph |
+| --------- | ------- | ------------- | --------- |
+| `generateSiteMetadata` | `site.title` | `site.description` | title, description, splash image |
+| `generateGroupMetadata` | `"Group — Site"` | — | title |
+| `generateArticleMetadata` | `"Article — Site"` | `article.synopsis` | title, description, splash image |
+
+Article metadata uses the cached `ArticleRef` snapshot already present in the site record — no extra network request per article at build time.
+
+**Need custom metadata?** Call `fetchSite` or `fetchArticle` from `@scribe-atp/core` directly and compose your own `Metadata` object:
+
+```ts
+import { fetchSite } from "@scribe-atp/core";
+import type { Metadata } from "next";
+
+export async function generateMetadata(): Promise<Metadata> {
+  const site = await fetchSite("alice.bsky.social", "alice-bsky-social");
+  return {
+    title: `${site.title} | My Platform`,
+    // custom fields...
+  };
+}
+```
+
+## ISR (Incremental Static Regeneration)
+
+The SDK does not configure Next.js fetch caching. Use Next.js [route segment config](https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config) to control revalidation:
+
+```ts
+// app/blog/[groupSlug]/[articleSlug]/page.tsx
+export const revalidate = 3600; // revalidate every hour
+```
+
+## Pages Router
+
+`@scribe-atp/next` targets the App Router only. For Pages Router, use `@scribe-atp/core` directly:
+
+```ts
+// pages/blog/[slug].tsx
+import type { GetStaticPaths, GetStaticProps } from "next";
+import { fetchSite, fetchArticle, toSlug } from "@scribe-atp/core";
+
+export const getStaticPaths: GetStaticPaths = async () => {
+  const site = await fetchSite("alice.bsky.social", toSlug("alice.bsky.social"));
+  const paths = site.groups.flatMap((group) =>
+    group.articles.map((article) => ({ params: { slug: article.url ?? "" } }))
+  );
+  return { paths, fallback: false };
+};
+
+export const getStaticProps: GetStaticProps = async ({ params }) => {
+  const article = await fetchArticle("alice.bsky.social", params!.slug as string);
+  return { props: { article } };
+};
+```
+
+## TypeScript types
+
+All types from `@scribe-atp/core` are re-exported:
+
+```ts
+import type { Site, Article, ArticleRef, SiteGroup } from "@scribe-atp/next";
+```
+
+## License
+
+[MIT](https://github.com/ACregan/scribe-atp-sdk/blob/main/LICENSE)

package/dist/index.cjs

@@ -0,0 +1,85 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createScribeSite: () => createScribeSite
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/create-scribe-site.ts
+var import_core = require("@scribe-atp/core");
+function createScribeSite(author, siteSlug) {
+  return {
+    generateGroupParams: async () => {
+      const site = await (0, import_core.fetchSite)(author, siteSlug);
+      return site.groups.map((g) => ({ groupSlug: g.slug }));
+    },
+    generateArticleParams: async () => {
+      const site = await (0, import_core.fetchSite)(author, siteSlug);
+      return site.groups.flatMap((g) => g.articles).filter((a) => !!a.url).map((a) => ({ articleSlug: a.url }));
+    },
+    generateGroupArticleParams: async () => {
+      const site = await (0, import_core.fetchSite)(author, siteSlug);
+      return site.groups.flatMap(
+        (g) => g.articles.filter((a) => !!a.url).map((a) => ({ groupSlug: g.slug, articleSlug: a.url }))
+      );
+    },
+    generateSiteMetadata: async () => {
+      const site = await (0, import_core.fetchSite)(author, siteSlug);
+      return {
+        title: site.title,
+        description: site.description ?? void 0,
+        openGraph: {
+          title: site.title,
+          description: site.description ?? void 0,
+          ...site.splashImageUrl ? { images: [site.splashImageUrl] } : {}
+        }
+      };
+    },
+    generateGroupMetadata: async (groupSlug) => {
+      const site = await (0, import_core.fetchSite)(author, siteSlug);
+      const group = site.groups.find((g) => g.slug === groupSlug);
+      const title = group ? `${group.title} \u2014 ${site.title}` : site.title;
+      return {
+        title,
+        openGraph: { title }
+      };
+    },
+    generateArticleMetadata: async (articleSlug) => {
+      const site = await (0, import_core.fetchSite)(author, siteSlug);
+      const article = site.groups.flatMap((g) => g.articles).find((a) => a.url === articleSlug);
+      const title = article ? `${article.title} \u2014 ${site.title}` : site.title;
+      return {
+        title,
+        description: article?.synopsis ?? void 0,
+        openGraph: {
+          title,
+          description: article?.synopsis ?? void 0,
+          ...article?.splashImageUrl ? { images: [article.splashImageUrl] } : {}
+        }
+      };
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createScribeSite
+});

package/dist/index.d.cts

@@ -0,0 +1,20 @@
+import { Metadata } from 'next';
+export { Article, ArticleRef, Site, SiteGroup } from '@scribe-atp/core';
+
+declare function createScribeSite(author: string, siteSlug: string): {
+    generateGroupParams: () => Promise<{
+        groupSlug: string;
+    }[]>;
+    generateArticleParams: () => Promise<{
+        articleSlug: string;
+    }[]>;
+    generateGroupArticleParams: () => Promise<{
+        groupSlug: string;
+        articleSlug: string;
+    }[]>;
+    generateSiteMetadata: () => Promise<Metadata>;
+    generateGroupMetadata: (groupSlug: string) => Promise<Metadata>;
+    generateArticleMetadata: (articleSlug: string) => Promise<Metadata>;
+};
+
+export { createScribeSite };

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import { Metadata } from 'next';
+export { Article, ArticleRef, Site, SiteGroup } from '@scribe-atp/core';
+
+declare function createScribeSite(author: string, siteSlug: string): {
+    generateGroupParams: () => Promise<{
+        groupSlug: string;
+    }[]>;
+    generateArticleParams: () => Promise<{
+        articleSlug: string;
+    }[]>;
+    generateGroupArticleParams: () => Promise<{
+        groupSlug: string;
+        articleSlug: string;
+    }[]>;
+    generateSiteMetadata: () => Promise<Metadata>;
+    generateGroupMetadata: (groupSlug: string) => Promise<Metadata>;
+    generateArticleMetadata: (articleSlug: string) => Promise<Metadata>;
+};
+
+export { createScribeSite };

package/dist/index.js

@@ -0,0 +1,58 @@
+// src/create-scribe-site.ts
+import { fetchSite } from "@scribe-atp/core";
+function createScribeSite(author, siteSlug) {
+  return {
+    generateGroupParams: async () => {
+      const site = await fetchSite(author, siteSlug);
+      return site.groups.map((g) => ({ groupSlug: g.slug }));
+    },
+    generateArticleParams: async () => {
+      const site = await fetchSite(author, siteSlug);
+      return site.groups.flatMap((g) => g.articles).filter((a) => !!a.url).map((a) => ({ articleSlug: a.url }));
+    },
+    generateGroupArticleParams: async () => {
+      const site = await fetchSite(author, siteSlug);
+      return site.groups.flatMap(
+        (g) => g.articles.filter((a) => !!a.url).map((a) => ({ groupSlug: g.slug, articleSlug: a.url }))
+      );
+    },
+    generateSiteMetadata: async () => {
+      const site = await fetchSite(author, siteSlug);
+      return {
+        title: site.title,
+        description: site.description ?? void 0,
+        openGraph: {
+          title: site.title,
+          description: site.description ?? void 0,
+          ...site.splashImageUrl ? { images: [site.splashImageUrl] } : {}
+        }
+      };
+    },
+    generateGroupMetadata: async (groupSlug) => {
+      const site = await fetchSite(author, siteSlug);
+      const group = site.groups.find((g) => g.slug === groupSlug);
+      const title = group ? `${group.title} \u2014 ${site.title}` : site.title;
+      return {
+        title,
+        openGraph: { title }
+      };
+    },
+    generateArticleMetadata: async (articleSlug) => {
+      const site = await fetchSite(author, siteSlug);
+      const article = site.groups.flatMap((g) => g.articles).find((a) => a.url === articleSlug);
+      const title = article ? `${article.title} \u2014 ${site.title}` : site.title;
+      return {
+        title,
+        description: article?.synopsis ?? void 0,
+        openGraph: {
+          title,
+          description: article?.synopsis ?? void 0,
+          ...article?.splashImageUrl ? { images: [article.splashImageUrl] } : {}
+        }
+      };
+    }
+  };
+}
+export {
+  createScribeSite
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@scribe-atp/next",
+  "version": "0.1.0",
+  "description": "Next.js App Router adapter for reading Scribe CMS content from the AT Protocol.",
+  "license": "MIT",
+  "engines": {
+    "node": ">=22"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@scribe-atp/core": "*"
+  },
+  "peerDependencies": {
+    "next": ">=13.0.0"
+  },
+  "devDependencies": {
+    "next": "^15.0.0"
+  },
+  "keywords": [
+    "scribe",
+    "atproto",
+    "at-protocol",
+    "bluesky",
+    "next",
+    "nextjs",
+    "cms",
+    "blog"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ACregan/scribe-atp-sdk.git"
+  }
+}