@driftime/sanity-plugin-handbook 0.3.0 → 0.3.2

package/README.md

@@ -2,9 +2,10 @@
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/icon-dark.svg" />
     <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/icon-light.svg" />
-    <img src="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/icon-light.svg" alt="Handbook icon" width="48" />
+    <img src="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/icon-light.svg" alt="Handbook plugin logo" width="48" />
   </picture>
-  <h1>Handbook — A Sanity Plugin</h1>
+  <h1>Handbook</h1>
+  <p><strong>A Sanity Studio plugin by Driftime®</strong></p>
   <p>Schema-driven documentation and editorial guides, built right into Sanity Studio.</p>
 </div>
 
@@ -35,6 +36,8 @@ Handbook is built for Sanity Studio 6 and React 19, and declares both as peer de
 bun add -E @driftime/sanity-plugin-handbook
 ```
 
+<br />
+
 ## Basic Setup
 
 Add the plugin to your Sanity configuration and pass in the document types you want to document, grouped by the role they play in your content model. Each role appears as a labelled section in the sidebar.
@@ -137,6 +140,8 @@ If no `handbook` property is provided, the tool falls back to the field's `title
 
 Fields with nested structure display a collapsible section that editors can expand to explore subfields. Custom types extending built-in types like `image` or `file` show only the fields you add. Inherited fields are excluded automatically. Circular type references are detected and labelled rather than rendering infinitely.
 
+<br />
+
 ## Guide Content
 
 Handbook includes a guide authoring system powered by Portable Text. The plugin automatically registers a `handbook.handbook` singleton and a `handbook.guide` document type. No additional schema setup is required.
@@ -211,6 +216,8 @@ export default defineConfig({
 });
 ```
 
+<br />
+
 ## Editor Permissions
 
 Restrict who can create and edit Handbook documents by providing a list of email addresses.
@@ -234,6 +241,8 @@ import { useIsHandbookEditor } from "@driftime/sanity-plugin-handbook";
 const isEditor = useIsHandbookEditor();
 ```
 
+<br />
+
 ## Structure Integration
 
 The Handbook tool displays guides, but you author them in the Structure tool. Nothing appears there until you add it. Use the `handbookStructure` helper to add a Handbook singleton editor and a Handbook Guides list, both restricted to the same editors you gave the plugin.
@@ -307,6 +316,8 @@ Only `roles` is required, since it tells the plugin which document types to cove
 | `editors`                  | `string[]`                        | `undefined`                                                                             | Email addresses permitted to edit Handbook documents. Unrestricted when omitted. |
 | `undocumentedFieldMessage` | `string`                          | `"This field has not been documented yet. Contact your development team for guidance."` | Fallback message shown when a field has no description.                          |
 
+<br />
+
 ## Exported Types
 
 These types are exported for typing your own configuration and for querying Handbook content outside the Studio.
@@ -334,6 +345,8 @@ Content the dataset stores:
 | `SanityHandbookVideo`          | A video block, with its asset and caption.                                |
 | `SanityHandbookLink`           | A link annotation, with the web address it points to.                     |
 
+<br />
+
 ## Acknowledgements
 
 The icons in `src/icons` are derived from [Lucide](https://lucide.dev) and redrawn as standalone components, so the plugin ships its own icons without depending on the Lucide package. Icons for controls the Studio already draws, such as disclosure arrows, come from `@sanity/icons` so they match their surroundings. Lucide is distributed under the [ISC License](https://github.com/lucide-icons/lucide/blob/main/LICENSE).
@@ -342,7 +355,15 @@ The icons in `src/icons` are derived from [Lucide](https://lucide.dev) and redra
 <br />
 
 <div align="center">
-  <a href="https://driftime.com" target="_blank">
+  <p><strong>Built alongside <a href="https://cairn.driftime.com">Cairn</a>, a starting point for responsible web experiences.</strong></p>
+  <p>Part of a suite of Sanity Studio plugins by Driftime®</p>
+  <p><a href="https://github.com/driftime/sanity-plugin-handbook">Handbook</a> · <a href="https://github.com/driftime/sanity-plugin-icon">Icon</a></p>
+</div>
+
+<br />
+
+<div align="center">
+  <a href="https://driftime.com">
     <picture>
       <source media="(prefers-color-scheme: dark)" srcset="https://driftime.com/driftime-github-logo-dark.svg" />
       <source media="(prefers-color-scheme: light)" srcset="https://driftime.com/driftime-github-logo.svg" />

package/dist/index.d.ts

@@ -82,7 +82,7 @@ interface SanityHandbookConfig {
  * @returns Sanity plugin definition.
  * @public
  */
-declare const handbookPlugin: import("sanity").Plugin<SanityHandbookConfig>;
+export declare const handbookPlugin: import("sanity").Plugin<SanityHandbookConfig>;
 /**
  * Creates the Structure tool items for Handbook documents, yielding nothing when the current user is
  * not permitted to edit them.
@@ -93,7 +93,7 @@ declare const handbookPlugin: import("sanity").Plugin<SanityHandbookConfig>;
  * @returns The list items for the Handbook singleton and the guides list.
  * @public
  */
-declare function handbookStructure(structureBuilder: StructureBuilder, context: {
+export declare function handbookStructure(structureBuilder: StructureBuilder, context: {
   currentUser: CurrentUser | null;
 }, editors?: string[]): import("sanity/structure").ListItemBuilder[];
 /**
@@ -104,7 +104,7 @@ declare function handbookStructure(structureBuilder: StructureBuilder, context:
  * @returns Whether the current user can edit Handbook documents.
  * @public
  */
-declare function useIsHandbookEditor(editors?: string[]): boolean;
+export declare function useIsHandbookEditor(editors?: string[]): boolean;
 /** Drops a type's catch-all index signature, so a mistyped field name is an error rather than an unknown value. */
 type Strict<T> = { [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K]; };
 /** Array of objects each carrying the key Sanity assigns to array items, keeping members identifiable. */
@@ -232,5 +232,5 @@ type SanityHandbookLink = Strict<PortableTextObject> & {
   /** Web address the link points to. */
   href?: string;
 };
-export { type SanityHandbook, type SanityHandbookBlockDefinition, type SanityHandbookCallout, type SanityHandbookCode, type SanityHandbookConfig, type SanityHandbookDocumentRole, type SanityHandbookGuide, type SanityHandbookGuideGroup, type SanityHandbookHorizontalRule, type SanityHandbookImage, type SanityHandbookLink, type SanityHandbookMetadata, type SanityHandbookVideo, handbookPlugin, handbookStructure, useIsHandbookEditor };
+export type { SanityHandbook, SanityHandbookBlockDefinition, SanityHandbookCallout, SanityHandbookCode, SanityHandbookConfig, SanityHandbookDocumentRole, SanityHandbookGuide, SanityHandbookGuideGroup, SanityHandbookHorizontalRule, SanityHandbookImage, SanityHandbookLink, SanityHandbookMetadata, SanityHandbookVideo };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/plugin.ts","../src/lib/structure.ts","../src/hooks/use-is-handbook-editor.ts","../src/types.ts","../src/schemas/types/guide.ts","../src/schemas/types/handbook.ts","../src/blocks/callout/content.tsx","../src/schemas/blocks/callout.ts","../src/schemas/blocks/code.ts","../src/schemas/blocks/horizontal-rule.ts","../src/schemas/blocks/image.ts","../src/schemas/blocks/video.ts","../src/schemas/annotations/link.ts"],"mappings":";;;;;YAoBY;IACR,WAAW;;YAIH;IACR,WAAW;;;;;;;;UASE;;EAEf;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;;;;;;UAQe;;EAEf;;EAEA;;EAEA,WAAW;;;;;;;UAQI;;EAEf,QAAQ;;EAER,WAAW;IAAgB,OAAO;;;;;;;;UAQnB;;EAEf;;EAEA;;EAEA,OAAO;;EAEP,SAAS;;EAET;;EAEA;;;;;;;;;;cAWW,iCAAc,OAAA;;;;;;;;;;;iBCpFX,kBACd,kBAAkB,kBAClB;EAAW,aAAa;GACxB,gDAAkB;;;;;;;;;iBCXJ,oBAAoB;;KCNxB,OAAO,QAAQ,WAAW,oBAAoB,2BAA2B,YAAY,IAAI,EAAE;;KAG3F,iBAAiB,MAAM,eAAe;;;;;;KCMtC,sBAAsB,OAAO;EACvC,cAAc;;EAEd;;EAEA;;EAEA,SAAS,iBAAiB;;;cAIf;;;;;;UCVI;;EAEf;;EAEA,QAAQ,iBAAiB;;;;;;;KAQf,iBAAiB,OAAO;EAClC,cAAc;;EAEd,QAAQ,iBAAiB;;;cAId;;KCzBD;;;;;;KCOA,wBAAwB,OAAO;EACzC,cAAc;;EAEd,SAAS;;EAET,MAAM,iBAAiB,sBAAsB;;;cAIlC;;;;;;KCbD,qBAAqB,OAAO;EACtC,cAAc;;EAEd;;EAEA;;;cAIW;;;;;;KCTD,+BAA+B,OAAO;EAChD,cAAc;;;cAIH;;;;;;KCLD,sBAAsB,OAAO;EACvC,cAAc;;EAEd;IAAU;;;EAEV;;EAEA;;;cAIW;;;;;;KCXD,sBAAsB,OAAO;EACvC,cAAc;;EAEd;IAAU;;;EAEV;;;cAIW;;;;;;KCZD,qBAAqB,OAAO;EACtC;;EAEA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/plugin.ts","../src/lib/structure.ts","../src/hooks/use-is-handbook-editor.ts","../src/types.ts","../src/schemas/types/guide.ts","../src/schemas/types/handbook.ts","../src/blocks/callout/content.tsx","../src/schemas/blocks/callout.ts","../src/schemas/blocks/code.ts","../src/schemas/blocks/horizontal-rule.ts","../src/schemas/blocks/image.ts","../src/schemas/blocks/video.ts","../src/schemas/annotations/link.ts"],"mappings":";;;;;YAoBY;IACR,WAAW;;YAIH;IACR,WAAW;;;;;;;;UASE;;EAEf;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;;;;;;UAQe;;EAEf;;EAEA;;EAEA,WAAW;;;;;;;UAQI;;EAEf,QAAQ;;EAER,WAAW;IAAgB,OAAO;;;;;;;;UAQnB;;EAEf;;EAEA;;EAEA,OAAO;;EAEP,SAAS;;EAET;;EAEA;;;;;;;;;;qBAWW,iCAAc,OAAA;;;;;;;;;;;wBCpFX,kBACd,kBAAkB,kBAClB;EAAW,aAAa;GACxB,gDAAkB;;;;;;;;;wBCXJ,oBAAoB;;KCNxB,OAAO,QAAQ,WAAW,oBAAoB,2BAA2B,YAAY,IAAI,EAAE;;KAG3F,iBAAiB,MAAM,eAAe;;;;;;KCMtC,sBAAsB,OAAO;EACvC,cAAc;;EAEd;;EAEA;;EAEA,SAAS,iBAAiB;;;cAIf;;;;;;UCVI;;EAEf;;EAEA,QAAQ,iBAAiB;;;;;;;KAQf,iBAAiB,OAAO;EAClC,cAAc;;EAEd,QAAQ,iBAAiB;;;cAId;;KCzBD;;;;;;KCOA,wBAAwB,OAAO;EACzC,cAAc;;EAEd,SAAS;;EAET,MAAM,iBAAiB,sBAAsB;;;cAIlC;;;;;;KCbD,qBAAqB,OAAO;EACtC,cAAc;;EAEd;;EAEA;;;cAIW;;;;;;KCTD,+BAA+B,OAAO;EAChD,cAAc;;;cAIH;;;;;;KCLD,sBAAsB,OAAO;EACvC,cAAc;;EAEd;IAAU;;;EAEV;;EAEA;;;cAIW;;;;;;KCXD,sBAAsB,OAAO;EACvC,cAAc;;EAEd;IAAU;;;EAEV;;;cAIW;;;;;;KCZD,qBAAqB,OAAO;EACtC;;EAEA"}

package/dist/index.js

@@ -1604,7 +1604,7 @@ function hasOfArray(value) {
 * @returns The type name, or undefined when the value declares none.
 */
 function getTypeName(value) {
-	if (!(typeof value != "object" || !value || !("type" in value))) return typeof value.type == "string" ? value.type : void 0;
+	if (typeof value == "object" && value && "type" in value) return typeof value.type == "string" ? value.type : void 0;
 }
 /**
 * Extracts the parent type name from a compiled schema type, if present.
@@ -1613,7 +1613,7 @@ function getTypeName(value) {
 * @returns The parent type name, or undefined when the type extends none.
 */
 function getParentTypeName(resolvedType) {
-	if (!(typeof resolvedType != "object" || !resolvedType || !("type" in resolvedType)) && !(typeof resolvedType.type != "object" || resolvedType.type === null || !("name" in resolvedType.type))) return String(resolvedType.type.name);
+	if (typeof resolvedType == "object" && resolvedType && "type" in resolvedType && typeof resolvedType.type == "object" && resolvedType.type !== null && "name" in resolvedType.type) return String(resolvedType.type.name);
 }
 /**
 * Normalises a compiled schema field into the shape the Handbook renders. Type names already seen are