@sanity/hierarchical-document-list 2.1.0 → 2.1.2

package/dist/index.d.mts

@@ -0,0 +1,240 @@
+import {ArraySchemaType} from 'sanity'
+import type {ConfigContext} from 'sanity'
+import {DocumentDefinition} from 'sanity'
+import {Plugin as Plugin_2} from 'sanity'
+import {PreviewConfig} from 'sanity'
+import * as React_2 from 'react'
+import {StructureBuilder} from 'sanity/desk'
+
+export declare function createDeskHierarchy(props: TreeProps): any
+
+export declare function createHierarchicalSchemas(options: SchemaOptions): (
+  | {
+      name: string
+      title: string
+      type: string
+      fields: (
+        | {
+            name: string
+            type: string
+          }
+        | {
+            name: string
+            type: string
+            title: string
+            fields: (
+              | {
+                  name: string
+                  type: string
+                  weak?: undefined
+                  to?: undefined
+                  options?: undefined
+                }
+              | {
+                  name: string
+                  type: string
+                  weak: boolean
+                  to: {
+                    type: string
+                  }[]
+                  options:
+                    | {
+                        filter?: string | undefined
+                        filterParams?: Record<string, unknown> | undefined
+                      }
+                    | undefined
+                }
+            )[]
+          }
+      )[]
+    }
+  | {
+      name: string
+      title: string
+      type: string
+      of: (
+        | {
+            name: string
+            title: string
+            type: string
+            fields: (
+              | {
+                  name: string
+                  type: string
+                }
+              | {
+                  name: string
+                  type: string
+                  title: string
+                  fields: (
+                    | {
+                        name: string
+                        type: string
+                        weak?: undefined
+                        to?: undefined
+                        options?: undefined
+                      }
+                    | {
+                        name: string
+                        type: string
+                        weak: boolean
+                        to: {
+                          type: string
+                        }[]
+                        options:
+                          | {
+                              filter?: string | undefined
+                              filterParams?: Record<string, unknown> | undefined
+                            }
+                          | undefined
+                      }
+                  )[]
+                }
+            )[]
+          }
+        | {
+            type: string
+          }
+      )[]
+    }
+  | {
+      name: string | undefined
+      title: string
+      type: string
+      liveEdit: boolean
+      fields: (Omit<ArraySchemaType<unknown>, 'type' | 'of' | 'jsonType'> & {
+        type: string
+        inputComponent: React_2.FC<any>
+        of?: any[] | undefined
+      })[]
+      preview: {
+        select: {
+          id: string
+          tree: string
+        }
+        prepare({id, tree}: {id: string; tree: unknown[]}): Record<string, string>
+      }
+    }
+)[]
+
+export declare function flatDataToTree(data: StoredTreeItem[]): TreeItemWithChildren[]
+
+/**
+ * Usage in `sanity.config.ts` (or .js)
+ *
+ * ```ts
+ * import {defineConfig} from 'sanity'
+ * import {hierarchicalDocumentList} from '@sanity/hierarchical-document-list'
+ *
+ * export default defineConfig({
+ *   // ...
+ *   plugins: [hierarchicalDocumentList()],
+ * })
+ * ```
+ */
+export declare const hierarchicalDocumentList: Plugin_2<void>
+
+export declare const hierarchyTree: {
+  type: 'document'
+  name: 'hierarchy.tree'
+} & Omit<DocumentDefinition, 'preview'> & {
+    preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+  }
+
+declare const INTERNAL_NODE_TYPE: string
+
+declare const INTERNAL_NODE_VALUE_TYPE: string
+
+declare interface SanityReference {
+  _type: 'reference'
+  _ref: string
+  _weak?: boolean
+}
+
+declare type SchemaOptions = Omit<TreeDeskStructureProps, 'documentId' | 'maxDepth'>
+
+/**
+ * Objects saved to tree documents in Sanity's Content Lake
+ */
+declare interface StoredTreeItem {
+  _key: string
+  _type: typeof INTERNAL_NODE_TYPE | string
+  value?: {
+    _type: typeof INTERNAL_NODE_VALUE_TYPE | string
+    reference?: SanityReference
+    docType?: string
+  }
+  /**
+   * _key of parent node
+   */
+  parent?: string | null
+}
+
+declare interface TreeDeskStructureProps extends TreeInputOptions {
+  /**
+   * _id of the document that will hold the tree data.
+   */
+  documentId: string
+  /**
+   * (Optional)
+   * Key for the field representing the hierarchical tree inside the document.
+   * `tree` by default.
+   */
+  fieldKeyInDocument?: string
+}
+
+declare interface TreeInputOptions {
+  /**
+   * What document types this hierarchy can refer to.
+   * Similar to the `to` property of the [reference field](https://www.sanity.io/docs/reference-type).
+   */
+  referenceTo: string[]
+  /**
+   * Used to provide fine-grained filtering for documents.
+   */
+  referenceOptions?: {
+    /**
+     * Static filter to apply to tree document queries.
+     */
+    filter?: string
+    /**
+     * Parameters / variables to pass to the GROQ query ran to fetch documents.
+     */
+    filterParams?: Record<string, unknown>
+  }
+  /**
+   * How deep should editors be allowed to nest items.
+   */
+  maxDepth?: number
+  /**
+   * Schema type for your hierarchical documents.
+   * Refer to documentation on how to provide these schemas in your studio.
+   *
+   * Defautlt: 'hierarchy.tree' - this schema is bundled with the plugin
+   */
+  documentType?: string
+}
+
+declare interface TreeItemWithChildren extends StoredTreeItem {
+  children?: TreeItemWithChildren[]
+}
+
+export declare interface TreeProps extends TreeDeskStructureProps {
+  /**
+   * Visible title above the tree.
+   * Also used as the label in the desk list item.
+   */
+  title: string
+  /**
+   * Optional icon for rendering the item in the desk structure.
+   */
+  icon?: any
+  context?: ConfigContext | any
+  S?: StructureBuilder | any
+  /**
+   * Restrict document types that can be created.
+   */
+  creatableTypes?: string[]
+}
+
+export {}