@driftime/sanity-plugin-handbook 0.3.2 → 0.4.0

package/dist/index.d.ts

@@ -1,6 +1,5 @@
-import { CurrentUser, DocumentDefinition, KeyedSegment, PortableTextBlock, PortableTextObject, PortableTextSpan, PortableTextTextBlock, SanityDocument, SchemaTypeDefinition } from "sanity";
 import { ComponentType } from "react";
-import "@sanity/ui";
+import { CurrentUser, DocumentDefinition, KeyedSegment, PortableTextBlock, PortableTextObject, PortableTextSpan, PortableTextTextBlock, SanityDocument, SchemaTypeDefinition } from "sanity";
 import { StructureBuilder } from "sanity/structure";
 declare module "@sanity/types" {
   interface FieldDefinitionBase {
@@ -61,17 +60,17 @@ interface SanityHandbookBlockDefinition {
  * @public
  */
 interface SanityHandbookConfig {
-  /** Title shown in the Studio tool navigation. */
+  /** Title shown in the Studio tool navigation. `"Handbook"` when omitted. */
   title?: string;
-  /** Heading displayed at the top of the sidebar. */
+  /** Heading displayed at the top of the sidebar. `"Handbook"` when omitted. */
   sidebarTitle?: string;
   /** Document roles, each shown as a labelled section in the sidebar. */
   roles: SanityHandbookDocumentRole[];
-  /** Custom Portable Text block definitions for guide content. */
+  /** Custom Portable Text block definitions for guide content. None when omitted. */
   blocks?: SanityHandbookBlockDefinition[];
-  /** Email addresses permitted to edit Handbook documents. */
+  /** Email addresses permitted to edit Handbook documents. Everyone when omitted. */
   editors?: string[];
-  /** Fallback message shown when a field has no description. */
+  /** Fallback message shown when a field has no description. A prompt to ask the development team when omitted. */
   undocumentedFieldMessage?: string;
 }
 /**
@@ -105,9 +104,16 @@ export declare function handbookStructure(structureBuilder: StructureBuilder, co
  * @public
  */
 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. */
+/**
+ * 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. */
+/**
+ * Array of objects each carrying the key Sanity assigns to array items, keeping members identifiable.
+ *
+ */
 type SanityKeyedArray<T> = (KeyedSegment & T)[];
 /**
  * A single Handbook page, authored as rich text and rendered in the tool.
@@ -148,46 +154,6 @@ type SanityHandbook = Strict<SanityDocument> & {
 };
 /** Document type name of the Handbook singleton. */
 declare const handbookTypeName = "handbook.handbook";
-/** The intent a callout is drawn with, choosing its icon and tone. */
-type CalloutVariant = "tip" | "info" | "warning";
-/**
- * A highlighted message set apart from the surrounding guide text.
- *
- * @public
- */
-type SanityHandbookCallout = Strict<PortableTextObject> & {
-  _type: typeof calloutTypeName;
-  /** Visual style and intent of the callout. */
-  variant: CalloutVariant;
-  /** Portable Text content displayed inside the callout, which offers no inline objects. */
-  body: SanityKeyedArray<PortableTextTextBlock<PortableTextSpan>>;
-};
-/** Type name of the callout block. */
-declare const calloutTypeName = "handbook.callout";
-/**
- * A block of source code, rendered with syntax highlighting for its language.
- *
- * @public
- */
-type SanityHandbookCode = Strict<PortableTextObject> & {
-  _type: typeof codeTypeName;
-  /** Source code to display. */
-  code?: string;
-  /** Programming language used for syntax highlighting. */
-  language?: string;
-};
-/** Type name of the code block. */
-declare const codeTypeName = "handbook.code";
-/**
- * A divider between sections of a guide, carrying no authored content of its own.
- *
- * @public
- */
-type SanityHandbookHorizontalRule = Strict<PortableTextObject> & {
-  _type: typeof horizontalRuleTypeName;
-};
-/** Type name of the horizontal rule block. */
-declare const horizontalRuleTypeName = "handbook.horizontalRule";
 /**
  * An image placed in a guide, with the caption and alternative text shown alongside it.
  *
@@ -222,6 +188,50 @@ type SanityHandbookVideo = Strict<PortableTextObject> & {
 };
 /** Type name of the video block. */
 declare const videoTypeName = "handbook.video";
+/**
+ * A block of source code, rendered with syntax highlighting for its language.
+ *
+ * @public
+ */
+type SanityHandbookCode = Strict<PortableTextObject> & {
+  _type: typeof codeTypeName;
+  /** Source code to display. */
+  code?: string;
+  /** Programming language used for syntax highlighting. */
+  language?: string;
+};
+/** Type name of the code block. */
+declare const codeTypeName = "handbook.code";
+/**
+ * The intent a callout is drawn with, choosing its icon and tone.
+ *
+ * @public
+ */
+type SanityHandbookCalloutVariant = "tip" | "info" | "warning";
+/**
+ * A highlighted message set apart from the surrounding guide text.
+ *
+ * @public
+ */
+type SanityHandbookCallout = Strict<PortableTextObject> & {
+  _type: typeof calloutTypeName;
+  /** Visual style and intent of the callout. */
+  variant: SanityHandbookCalloutVariant;
+  /** Portable Text content displayed inside the callout, which offers no inline objects. */
+  body: SanityKeyedArray<PortableTextTextBlock<PortableTextSpan>>;
+};
+/** Type name of the callout block. */
+declare const calloutTypeName = "handbook.callout";
+/**
+ * A divider between sections of a guide, carrying no authored content of its own.
+ *
+ * @public
+ */
+type SanityHandbookHorizontalRule = Strict<PortableTextObject> & {
+  _type: typeof horizontalRuleTypeName;
+};
+/** Type name of the horizontal rule block. */
+declare const horizontalRuleTypeName = "handbook.horizontalRule";
 /**
  * A web address applied to a run of guide text.
  *
@@ -232,5 +242,5 @@ type SanityHandbookLink = Strict<PortableTextObject> & {
   /** Web address the link points to. */
   href?: string;
 };
-export type { SanityHandbook, SanityHandbookBlockDefinition, SanityHandbookCallout, SanityHandbookCode, SanityHandbookConfig, SanityHandbookDocumentRole, SanityHandbookGuide, SanityHandbookGuideGroup, SanityHandbookHorizontalRule, SanityHandbookImage, SanityHandbookLink, SanityHandbookMetadata, SanityHandbookVideo };
+export type { SanityHandbook, SanityHandbookBlockDefinition, SanityHandbookCallout, SanityHandbookCalloutVariant, 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;;;;;;;;;;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"}
+{"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"],"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;;;;;;;;;;;wBCrFX,kBACd,kBAAkB,kBAClB;EAAW,aAAa;GACxB,gDAAkB;;;;;;;;;wBCVJ,oBAAoB;;;;;;KCExB,OAAO,QAAQ,WAAW,oBAAoB,2BAA2B,YAAY,IAAI,EAAE;;;;;KAM3F,iBAAiB,MAAM,eAAe;;;;;;KAOtC,sBAAsB,OAAO;EACvC,cAAc;;EAEd;;EAEA;;EAEA,SAAS,iBAAiB;;;cAIf;;;;;;UAOI;;EAEf;;EAEA,QAAQ,iBAAiB;;;;;;;KAQf,iBAAiB,OAAO;EAClC,cAAc;;EAEd,QAAQ,iBAAiB;;;cAId;;;;;;KAOD,sBAAsB,OAAO;EACvC,cAAc;;EAEd;IAAU;;;EAEV;;EAEA;;;cAIW;;;;;;KAOD,sBAAsB,OAAO;EACvC,cAAc;;EAEd;IAAU;;;EAEV;;;cAIW;;;;;;KAOD,qBAAqB,OAAO;EACtC,cAAc;;EAEd;;EAEA;;;cAIW;;;;;;KAOD;;;;;;KAOA,wBAAwB,OAAO;EACzC,cAAc;;EAEd,SAAS;;EAET,MAAM,iBAAiB,sBAAsB;;;cAIlC;;;;;;KAOD,+BAA+B,OAAO;EAChD,cAAc;;;cAIH;;;;;;KAOD,qBAAqB,OAAO;EACtC;;EAEA"}