@driftime/sanity-plugin-handbook 0.4.1 → 0.5.0

package/dist/index.d.ts

@@ -132,8 +132,8 @@ declare const guideTypeName = "handbook.guide";
 interface SanityHandbookGuideGroup {
   /** Group title in the sidebar. */
   title: string;
-  /** Guides in the group, in order. */
-  guides: SanityKeyedArray<SanityHandbookGuide>;
+  /** Guides in the group, in order, or undefined when none have been added. */
+  guides?: SanityKeyedArray<SanityHandbookGuide>;
 }
 /**
  * The Handbook document, listing the guide groups in sidebar order.
@@ -142,8 +142,8 @@ interface SanityHandbookGuideGroup {
  */
 type SanityHandbook = Strict<SanityDocument> & {
   _type: typeof handbookTypeName;
-  /** Guide groups, in order. */
-  groups: SanityKeyedArray<SanityHandbookGuideGroup>;
+  /** Guide groups, in order, or undefined when none have been added. */
+  groups?: SanityKeyedArray<SanityHandbookGuideGroup>;
 };
 /** Schema type name of the Handbook document. */
 declare const handbookTypeName = "handbook.handbook";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":["ComponentType","DocumentDefinition","PortableTextObject","SchemaTypeDefinition","_0","SanityHandbookMetadata","sideEffect","SanityHandbookDocumentRole","SanityHandbookBlockDefinition","SanityHandbookConfig","handbookPlugin","CurrentUser","StructureBuilder","handbookStructure","useIsHandbookEditor","KeyedSegment","PortableTextBlock","PortableTextObject","PortableTextSpan","PortableTextTextBlock","SanityDocument","Strict","T","K","SanityKeyedArray","SanityHandbookGuide","guideTypeName","SanityHandbookGuideGroup","SanityHandbook","handbookTypeName","SanityHandbookImage","imageTypeName","SanityHandbookVideo","videoTypeName","SanityHandbookCode","codeTypeName","SanityHandbookCalloutVariant","SanityHandbookCallout","calloutTypeName","SanityHandbookHorizontalRule","horizontalRuleTypeName","SanityHandbookLink"],"sources":["../src/plugin.ts","../src/lib/structure.ts","../src/hooks/use-is-handbook-editor.ts","../src/types.ts"],"mappings":";;;;YAoBY;;IAER,WAAWK;;YAIH;;IAER,WAAWA;;;;;;;;UASEA;;EAEf;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;;;;;;UAQeE;;EAEf;;EAEA;;EAEA,WAAWN;;;;;;;UAQIO;;EAEf,QAAQL;;EAER,WAAWH;IAAgB,OAAOE;;;;;;;;UAQnBO;;EAEf;;EAEA;;EAEA,OAAOF;;EAEP,SAASC;;EAET;;EAEA;;;;;;;;;;qBAWWE,iCAAc,OAAAD;;;;;;;;;;wBCxFXI,kBACd,kBAAkBD,kBAClB;EAAW,aAAaD;GACxB,gDAAkB;;;;;;;;wBCVJG,oBAAoB;;KCDxBO,OAAO,QAAQ,WAAWC,oBAAoBC,2BAA2BA,YAAYA,IAAID,EAAEC;;KAG3FC,iBAAiB,MAAMT,eAAeO;;;;;;KAOtCG,sBAAsBJ,OAAOD;EACvC,cAAcM;;EAEd;;EAEA;;EAEA,SAASF,iBAAiBR;;;cAIfU;;;;;;UAOIC;;EAEf;;EAEA,QAAQH,iBAAiBC;;;;;;;KAQfG,iBAAiBP,OAAOD;EAClC,cAAcS;;EAEd,QAAQL,iBAAiBG;;;cAIdE;;;;;;KAODC,sBAAsBT,OAAOJ;EACvC,cAAcc;;EAEd;IAAU;;;EAEV;;EAEA;;;cAIWA;;;;;;KAODC,sBAAsBX,OAAOJ;EACvC,cAAcgB;;EAEd;IAAU;;;EAEV;;;cAIWA;;;;;;KAODC,qBAAqBb,OAAOJ;EACtC,cAAckB;;EAEd;;EAEA;;;cAIWA;;;;;;KAODC;;;;;;KAOAC,wBAAwBhB,OAAOJ;EACzC,cAAcqB;;EAEd,SAASF;;EAET,MAAMZ,iBAAiBL,sBAAsBD;;;cAIlCoB;;;;;;KAODC,+BAA+BlB,OAAOJ;EAChD,cAAcuB;;;cAIHA;;;;;;KAODC,qBAAqBpB,OAAOJ;EACtC;;EAEA"}
+{"version":3,"file":"index.d.ts","names":["ComponentType","DocumentDefinition","PortableTextObject","SchemaTypeDefinition","_0","SanityHandbookMetadata","sideEffect","SanityHandbookDocumentRole","SanityHandbookBlockDefinition","SanityHandbookConfig","handbookPlugin","CurrentUser","StructureBuilder","handbookStructure","useIsHandbookEditor","KeyedSegment","PortableTextBlock","PortableTextObject","PortableTextSpan","PortableTextTextBlock","SanityDocument","Strict","T","K","SanityKeyedArray","SanityHandbookGuide","guideTypeName","SanityHandbookGuideGroup","SanityHandbook","handbookTypeName","SanityHandbookImage","imageTypeName","SanityHandbookVideo","videoTypeName","SanityHandbookCode","codeTypeName","SanityHandbookCalloutVariant","SanityHandbookCallout","calloutTypeName","SanityHandbookHorizontalRule","horizontalRuleTypeName","SanityHandbookLink"],"sources":["../src/plugin.ts","../src/lib/structure.ts","../src/hooks/use-is-handbook-editor.ts","../src/types.ts"],"mappings":";;;;YAoBY;;IAER,WAAWK;;YAIH;;IAER,WAAWA;;;;;;;;UASEA;;EAEf;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;;;;;;UAQeE;;EAEf;;EAEA;;EAEA,WAAWN;;;;;;;UAQIO;;EAEf,QAAQL;;EAER,WAAWH;IAAgB,OAAOE;;;;;;;;UAQnBO;;EAEf;;EAEA;;EAEA,OAAOF;;EAEP,SAASC;;EAET;;EAEA;;;;;;;;;;qBAWWE,iCAAc,OAAAD;;;;;;;;;;wBCxFXI,kBACd,kBAAkBD,kBAClB;EAAW,aAAaD;GACxB,gDAAkB;;;;;;;;wBCVJG,oBAAoB;;KCDxBO,OAAO,QAAQ,WAAWC,oBAAoBC,2BAA2BA,YAAYA,IAAID,EAAEC;;KAG3FC,iBAAiB,MAAMT,eAAeO;;;;;;KAOtCG,sBAAsBJ,OAAOD;EACvC,cAAcM;;EAEd;;EAEA;;EAEA,SAASF,iBAAiBR;;;cAIfU;;;;;;UAOIC;;EAEf;;EAEA,SAASH,iBAAiBC;;;;;;;KAQhBG,iBAAiBP,OAAOD;EAClC,cAAcS;;EAEd,SAASL,iBAAiBG;;;cAIfE;;;;;;KAODC,sBAAsBT,OAAOJ;EACvC,cAAcc;;EAEd;IAAU;;;EAEV;;EAEA;;;cAIWA;;;;;;KAODC,sBAAsBX,OAAOJ;EACvC,cAAcgB;;EAEd;IAAU;;;EAEV;;;cAIWA;;;;;;KAODC,qBAAqBb,OAAOJ;EACtC,cAAckB;;EAEd;;EAEA;;;cAIWA;;;;;;KAODC;;;;;;KAOAC,wBAAwBhB,OAAOJ;EACzC,cAAcqB;;EAEd,SAASF;;EAET,MAAMZ,iBAAiBL,sBAAsBD;;;cAIlCoB;;;;;;KAODC,+BAA+BlB,OAAOJ;EAChD,cAAcuB;;;cAIHA;;;;;;KAODC,qBAAqBpB,OAAOJ;EACtC;;EAEA"}

package/dist/index.js

@@ -1,5 +1,5 @@
 import { createContext, createElement, useContext, useEffect, useRef, useState } from "react";
-import { CommandList, PreviewCard, SanityDefaultPreview, defineArrayMember, defineField, definePlugin, defineType, useClient, useCurrentUser, useSchema } from "sanity";
+import { CommandList, PreviewCard, SanityDefaultPreview, defineArrayMember, defineField, definePlugin, defineType, useCurrentUser, useDocumentStore, useSchema } from "sanity";
 import { c } from "react/compiler-runtime";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import { Box, Button, Card, Flex, Heading, Layer, LayerProvider, Stack, Text, useClickOutsideEvent, useElementSize, useTheme_v2 } from "@sanity/ui";
@@ -177,71 +177,46 @@ const contentSpacing = {
 	list: 32,
 	nestedList: 12,
 	rule: 40
-}, assetUrlFragment = "\"asset\": { \"url\": asset.asset->url }", guideFragment = `...@-> {
-  ...,
-  content[] { ..., ${`
-  _type == "${imageTypeName}" => { ..., ${assetUrlFragment} },
-  _type == "${videoTypeName}" => { ..., ${assetUrlFragment} }
-`} }
-}`;
-/**
-* Defines a GROQ query typed with its result, so fetches infer the result type.
-*
-* @param query - The GROQ query.
-* @returns The query, typed with its result.
-*/
-function defineTypedQuery(query) {
-	return query;
-}
-/**
-* Runs a typed query, returning undefined instead of null when nothing matches.
-*
-* @param client - The Sanity client.
-* @param query - The typed query.
-* @returns The result, or undefined when nothing matches.
-*/
-async function fetchQuery(client, query) {
-	return await client.fetch(query) ?? void 0;
-}
-/** Handbook document with its guide references expanded. */
-const handbookQuery = defineTypedQuery(`
+}, assetUrlFragment = "\"asset\": { \"url\": asset.asset->url }", handbookQuery = `
   *[_type == "${handbookTypeName}"][0] {
     ...,
     groups[] {
       ...,
       guides[] {
         ...,
-        ${guideFragment}
+        ${`...@-> {
+  ...,
+  content[] { ..., ${`
+  _type == "${imageTypeName}" => { ..., ${assetUrlFragment} },
+  _type == "${videoTypeName}" => { ..., ${assetUrlFragment} }
+`} }
+}`}
       }
     }
   }
-`), handbookDocumentsQuery = defineTypedQuery(`*[_type == "${handbookTypeName}" || _type == "${guideTypeName}"]`);
+`, handbookDocumentsQuery = `*[_type == "${handbookTypeName}" || _type == "${guideTypeName}"]`;
 /**
-* Fetches the Handbook document with its guides expanded, refetching when any Handbook document changes.
+* Reads the published Handbook document with its guides expanded, updating when any Handbook document is published.
 *
-* @returns The Handbook document, and whether it's still loading.
+* @returns The Handbook document, or undefined while it loads or when there isn't one.
 */
 function useHandbookDocument() {
-	let $ = c(7), t0;
-	$[0] === Symbol.for("react.memo_cache_sentinel") ? (t0 = { apiVersion: "2026-01-01" }, $[0] = t0) : t0 = $[0];
-	let client = useClient(t0), [handbook, setHandbook] = useState(void 0), [loading, setLoading] = useState(!0), t1, t2;
-	$[1] === client ? (t1 = $[2], t2 = $[3]) : (t1 = () => {
-		let fetchHandbook = async function fetchHandbook() {
-			setHandbook(await fetchQuery(client, handbookQuery)), setLoading(!1);
-		};
-		fetchHandbook();
-		let subscription = client.listen(handbookDocumentsQuery).subscribe(() => {
-			fetchHandbook();
+	let $ = c(3), documentStore = useDocumentStore(), [handbook, setHandbook] = useState(), t0, t1;
+	return $[0] === documentStore ? (t0 = $[1], t1 = $[2]) : (t0 = () => {
+		let subscription = documentStore.listenQuery({
+			fetch: handbookQuery,
+			listen: handbookDocumentsQuery
+		}, {}, {
+			apiVersion: "2026-01-01",
+			perspective: "published",
+			throttleTime: 1e3
+		}).subscribe((result) => {
+			setHandbook(result ?? void 0);
 		});
 		return () => {
 			subscription.unsubscribe();
 		};
-	}, t2 = [client], $[1] = client, $[2] = t1, $[3] = t2), useEffect(t1, t2);
-	let t3;
-	return $[4] !== handbook || $[5] !== loading ? (t3 = {
-		handbook,
-		loading
-	}, $[4] = handbook, $[5] = loading, $[6] = t3) : t3 = $[6], t3;
+	}, t1 = [documentStore], $[0] = documentStore, $[1] = t0, $[2] = t1), useEffect(t0, t1), handbook;
 }
 const HandbookContext = createContext(void 0);
 /**
@@ -262,24 +237,23 @@ function useHandbookContext() {
 * @returns The provider.
 */
 function HandbookProvider(t0) {
-	let $ = c(12), { sidebarTitle, roles, blocks, undocumentedFieldMessage, children } = t0, [activeTab, setActiveTab] = useState(void 0), [sidebarExpanded, setSidebarExpanded] = useState(!0), { handbook, loading } = useHandbookDocument(), t1;
-	$[0] !== activeTab || $[1] !== blocks || $[2] !== handbook || $[3] !== loading || $[4] !== roles || $[5] !== sidebarExpanded || $[6] !== sidebarTitle || $[7] !== undocumentedFieldMessage ? (t1 = {
+	let $ = c(11), { sidebarTitle, roles, blocks, undocumentedFieldMessage, children } = t0, [activeTab, setActiveTab] = useState(void 0), [sidebarExpanded, setSidebarExpanded] = useState(!0), handbook = useHandbookDocument(), t1;
+	$[0] !== activeTab || $[1] !== blocks || $[2] !== handbook || $[3] !== roles || $[4] !== sidebarExpanded || $[5] !== sidebarTitle || $[6] !== undocumentedFieldMessage ? (t1 = {
 		sidebarTitle,
 		roles,
 		blocks,
 		undocumentedFieldMessage,
 		activeTab,
 		sidebarExpanded,
-		loading,
 		handbook,
 		setActiveTab,
 		setSidebarExpanded
-	}, $[0] = activeTab, $[1] = blocks, $[2] = handbook, $[3] = loading, $[4] = roles, $[5] = sidebarExpanded, $[6] = sidebarTitle, $[7] = undocumentedFieldMessage, $[8] = t1) : t1 = $[8];
+	}, $[0] = activeTab, $[1] = blocks, $[2] = handbook, $[3] = roles, $[4] = sidebarExpanded, $[5] = sidebarTitle, $[6] = undocumentedFieldMessage, $[7] = t1) : t1 = $[7];
 	let t2;
-	return $[9] !== children || $[10] !== t1 ? (t2 = /* @__PURE__ */ jsx(HandbookContext, {
+	return $[8] !== children || $[9] !== t1 ? (t2 = /* @__PURE__ */ jsx(HandbookContext, {
 		value: t1,
 		children
-	}), $[9] = children, $[10] = t1, $[11] = t2) : t2 = $[11], t2;
+	}), $[8] = children, $[9] = t1, $[10] = t2) : t2 = $[10], t2;
 }
 function PaneHeader(t0) {
 	let $ = c(46), backButton, props, style, title;
@@ -756,7 +730,7 @@ function normalizeField(field, visited = /* @__PURE__ */ new Set()) {
 			type: typeName,
 			title: field.title ?? field.type.title,
 			description: field.description ?? field.type.description,
-			handbook: field.handbook
+			handbook: field.handbook ?? field.type.handbook
 		};
 		if (!visited.has(typeName)) {
 			let next = !opaqueTypes.has(typeName) && typeName !== "object" && typeName !== "array" ? /* @__PURE__ */ new Set([...visited, typeName]) : visited, fieldSource = hasFieldsArray(field) ? field : field.type, ofSource = hasOfArray(field) ? field : field.type;
@@ -1853,12 +1827,12 @@ function BookOpenTextIcon(props) {
 * Builds a sidebar section for each guide group.
 *
 * @param handbook - The Handbook document.
-* @returns One section per group, with an entry per guide.
+* @returns One section per group, with an entry per published guide.
 */
 function guidesSections(handbook) {
-	return handbook.groups.map(({ title, guides }) => ({
+	return (handbook.groups ?? []).map(({ title, guides }) => ({
 		title,
-		entries: guides.map((guide) => ({
+		entries: (guides ?? []).filter((guide) => isDefined(guide.title)).map((guide) => ({
 			id: guide._key,
 			title: guide.title,
 			description: guide.description,
@@ -1873,12 +1847,12 @@ function guidesSections(handbook) {
 * @returns The built-in pages, the configured document roles, and the guide groups, as sections.
 */
 function useSections() {
-	let $ = c(4), { roles, handbook, loading } = useHandbookContext(), t0;
-	return $[0] !== handbook || $[1] !== loading || $[2] !== roles ? (t0 = [
+	let $ = c(3), { roles, handbook } = useHandbookContext(), t0;
+	return $[0] !== handbook || $[1] !== roles ? (t0 = [
 		...gettingStartedSections(),
 		...documentTypesSections(roles),
-		...loading || !isDefined(handbook) ? [] : guidesSections(handbook)
-	], $[0] = handbook, $[1] = loading, $[2] = roles, $[3] = t0) : t0 = $[3], t0;
+		...isDefined(handbook) ? guidesSections(handbook) : []
+	], $[0] = handbook, $[1] = roles, $[2] = t0) : t0 = $[2], t0;
 }
 function Content(props) {
 	let $ = c(18), { activeTab } = useHandbookContext(), sections = useSections(), T0, t0, t1, t2, t3, t4;
@@ -2684,19 +2658,10 @@ function createGuideType(customBlocks = []) {
 		title: "Handbook Guide",
 		description: "Handbook page written in rich text.",
 		icon: createSanityIcon(BookOpenTextIcon),
-		preview: {
-			select: {
-				title: "title",
-				description: "description"
-			},
-			prepare(selection) {
-				let { title, description } = selection;
-				return {
-					title: title ?? "Untitled",
-					subtitle: description
-				};
-			}
-		},
+		preview: { select: {
+			title: "title",
+			subtitle: "description"
+		} },
 		fields: [
 			defineField({
 				name: "title",
@@ -2775,16 +2740,17 @@ const handbookType = defineType({
 					title: "title",
 					guide0: "guides.0.title",
 					guide1: "guides.1.title",
-					guide2: "guides.2.title"
+					guide2: "guides.2.title",
+					guide3: "guides.3.title"
 				},
 				prepare(selection) {
-					let { title, guide0, guide1, guide2 } = selection, shown = [
+					let { title, guide0, guide1, guide2, guide3 } = selection, shown = [
 						guide0,
 						guide1,
 						guide2
-					].filter((guide) => isDefined(guide)).slice(0, 2), hasMore = isDefined(guide2);
+					].filter((guide) => isDefined(guide));
 					function formatSubtitle() {
-						return isDefined(shown) ? hasMore ? `${shown.join(", ")}, and others` : shown.join(" and ") : "No guides selected";
+						return isDefined(shown) ? isDefined(guide3) ? `${shown.slice(0, 2).join(", ")}, and others` : new Intl.ListFormat("en-US").format(shown) : "No guides selected";
 					}
 					return {
 						title: title ?? "Group",