@vx-oss/docs-sanity 1.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Fuma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/client.d.mts

@@ -0,0 +1,10 @@
+import { ReactNode } from "react";
+import { PortableTextBlock } from "@portabletext/react";
+import { TOCItemType } from "@vx-oss/docs-core/toc";
+//#region src/client.d.ts
+declare function renderToc(opts: {
+  toc: PortableTextBlock[];
+  render: (body: PortableTextBlock) => ReactNode;
+}): TOCItemType[];
+//#endregion
+export { renderToc };

package/dist/client.mjs

@@ -0,0 +1,14 @@
+//#region src/client.ts
+function renderToc(opts) {
+	const { render, toc } = opts;
+	return toc.map((item) => ({
+		depth: Number(item.level ?? 0),
+		title: render({
+			...item,
+			style: void 0
+		}),
+		url: `#${item._key}`
+	}));
+}
+//#endregion
+export { renderToc };

package/dist/index.d.mts

@@ -0,0 +1,53 @@
+import { ReactNode } from "react";
+import { PortableTextBlock } from "@portabletext/react";
+import { TOCItemType } from "@vx-oss/docs-core/toc";
+import { StructuredData } from "@vx-oss/docs-core/mdx-plugins/remark-structure";
+import { DynamicSource, MetaData } from "@vx-oss/docs-core/source";
+import { DefinedFetchType } from "next-sanity/live";
+import { SlugValue } from "@sanity/types";
+import { SanityClient } from "@sanity/client";
+//#region src/index.d.ts
+type SanityOptions<Doc extends BaseDoc = BaseDoc> = GenericSanityOptions<Doc> | NextSanityOptions<Doc>;
+interface BaseSanityOptions<Doc extends BaseDoc> {
+  /** document name for docs pages */
+  docType: string;
+  /** generate [virtual file path](https://fumadocs.dev/docs/headless/source-api/source#static-source) from document */
+  generatePath?: (doc: ShallowDoc<Doc>) => string;
+  /** base directory for the virutal file paths */
+  baseDir?: string;
+}
+interface GenericSanityOptions<Doc extends BaseDoc = BaseDoc> extends BaseSanityOptions<Doc> {
+  client: SanityClient;
+}
+interface NextSanityOptions<Doc extends BaseDoc = BaseDoc> extends BaseSanityOptions<Doc> {
+  client?: SanityClient;
+  /** the `sanityFetch` from `next-sanity/live` */
+  sanityFetch: DefinedFetchType;
+}
+/** your page document must align with this type */
+interface BaseDoc {
+  _id: string;
+  _type: string;
+  _updatedAt?: string;
+  title?: string;
+  description?: string;
+  slug?: SlugValue;
+}
+type ShallowDoc<Doc extends BaseDoc> = Pick<Doc, '_id' | '_type' | '_updatedAt' | 'title' | 'slug' | 'description'>;
+type DocToPage<Doc extends BaseDoc> = ShallowDoc<Doc> & {
+  title: string;
+  load: () => Promise<DocToPageLoaded<Doc>>;
+  structuredData: () => Promise<StructuredData>;
+};
+type DocToPageLoaded<Doc extends BaseDoc> = Doc & {
+  _toc: PortableTextBlock[];
+  renderToc: (opts: {
+    render: (body: PortableTextBlock) => ReactNode;
+  }) => TOCItemType[];
+};
+declare function createSanitySource<Doc extends BaseDoc>(options: SanityOptions<Doc>): DynamicSource<{
+  pageData: DocToPage<Doc>;
+  metaData: MetaData;
+}>;
+//#endregion
+export { BaseDoc, DocToPage, DocToPageLoaded, GenericSanityOptions, NextSanityOptions, SanityOptions, createSanitySource };

package/dist/index.mjs

@@ -0,0 +1,122 @@
+import { renderToc } from "./client.mjs";
+import { cache } from "react";
+import path from "node:path";
+//#region src/index.ts
+function createSanitySource(options) {
+	const { docType, baseDir, generatePath } = options;
+	let sanityFetch;
+	const useNextCache = "sanityFetch" in options;
+	let fileCache = /* @__PURE__ */ new Map();
+	if ("sanityFetch" in options) {
+		const fn = options.sanityFetch;
+		sanityFetch = async (query, params) => {
+			return (await fn({
+				query,
+				params
+			})).data;
+		};
+	} else {
+		const client = options.client;
+		sanityFetch = client.fetch.bind(client);
+	}
+	function toVirtualFile(file) {
+		const slugs = file.slug?.current?.split("/").filter((v) => v.length > 0) ?? [];
+		let filePath = generatePath ? generatePath(file) : slugs.length === 0 ? "index.mdx" : `${slugs.join("/")}.mdx`;
+		if (baseDir) filePath = path.join(baseDir, filePath);
+		return {
+			type: "page",
+			data: {
+				...file,
+				title: file.title ?? file._id,
+				load: cache(async () => {
+					const data = await sanityFetch(`*[_type == $docType && _id == $id][0]{
+              ...,
+              "_toc": body[style in ["h1", "h2", "h3", "h4", "h5", "h6"]]
+            }`, {
+						id: file._id,
+						docType
+					});
+					return {
+						...data,
+						_toc: data._toc ?? [],
+						renderToc(opts) {
+							if (!data._toc) return [];
+							return renderToc({
+								toc: data._toc,
+								...opts
+							});
+						}
+					};
+				}),
+				structuredData: cache(async () => {
+					return getStructuredData((await sanityFetch(`*[_type == $docType && _id == $id][0]{
+              "structuredBody": body[]{
+                ...,
+                _type == "block" => {
+                  "heading": select(
+                    style == "h1" => "h1",
+                    style == "h2" => "h2",
+                    style == "h3" => "h3",
+                    style == "h4" => "h4",
+                    style == "h5" => "h5",
+                    style == "h6" => "h6",
+                    null
+                  ),
+                  "content": pt::text(@)
+                }
+              }
+            }`, {
+						docType,
+						id: file._id
+					}))?.structuredBody ?? []);
+				})
+			},
+			slugs,
+			path: filePath
+		};
+	}
+	return {
+		cache: useNextCache ? "custom" : "memory",
+		async files() {
+			const data = await sanityFetch(`*[_type == $docType]{ _id, _type, _updatedAt, title, slug, description }`, { docType });
+			const next = /* @__PURE__ */ new Map();
+			const files = data.map((doc) => {
+				const key = `${doc._id}:${doc._updatedAt ?? JSON.stringify(doc)}`;
+				const file = fileCache.get(key) ?? toVirtualFile(doc);
+				next.set(key, file);
+				return file;
+			});
+			fileCache = next;
+			return files;
+		},
+		invalidate() {
+			fileCache.clear();
+		}
+	};
+}
+function getStructuredData(blocks = []) {
+	const structuredData = {
+		headings: [],
+		contents: []
+	};
+	let lastHeading;
+	for (const block of blocks) {
+		const content = block.content?.trim();
+		if (!content) continue;
+		if (block.heading && block._key) {
+			structuredData.headings.push({
+				id: block._key,
+				content
+			});
+			lastHeading = block._key;
+			continue;
+		}
+		structuredData.contents.push({
+			heading: lastHeading,
+			content
+		});
+	}
+	return structuredData;
+}
+//#endregion
+export { createSanitySource };

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@vx-oss/docs-sanity",
+  "version": "1.0.3",
+  "description": "The official Sanity integration for Fumadocs",
+  "keywords": [
+    "Docs",
+    "Fumadocs"
+  ],
+  "homepage": "https://vezham.com",
+  "license": "MIT",
+  "author": "Fuma Nama",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vezham/fumadocs",
+    "directory": "packages/sanity"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./client": "./dist/client.mjs",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@portabletext/react": "^8.0.1"
+  },
+  "devDependencies": {
+    "@sanity/client": "^8.3.0",
+    "@sanity/types": "^6.11.0",
+    "@types/node": "26.3.0",
+    "@types/react": "^19.2.18",
+    "fuma-cli": "^0.1.1",
+    "next-sanity": "^13.3.3",
+    "react": "^19.2.8",
+    "sanity": "^6.11.0",
+    "tsdown": "0.22.14",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.11",
+    "@vx-oss/docs-core": "1.0.3",
+    "tsconfig": "0.0.1",
+    "@vx-oss/docs-react": "1.0.3"
+  },
+  "peerDependencies": {
+    "@sanity/client": "^7.22.0 || ^8.0.0",
+    "@sanity/types": "*",
+    "@types/react": "*",
+    "next-sanity": "^12.4.0 || ^13.0.0",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "@vx-oss/docs-core": "^1.0.1"
+  },
+  "peerDependenciesMeta": {
+    "@sanity/types": {
+      "optional": true
+    },
+    "@sanity/client": {
+      "optional": true
+    },
+    "next-sanity": {
+      "optional": true
+    },
+    "@types/react": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsdown",
+    "clean": "rimraf dist",
+    "dev": "tsdown --watch --clean false",
+    "lint": "oxlint .",
+    "types:check": "tsc --noEmit",
+    "test": "vitest run"
+  }
+}