sanity-plugin-taxonomy-manager 3.0.2 → 3.1.0-beta.0

package/lib/index.d.ts

@@ -6,8 +6,8 @@ import {Plugin as Plugin_2} from 'sanity'
  * Document Branch Filter
  *
  * A pluggable Function for Filtering to a Top Concept Branch within a SKOS Concept Scheme
- * @param options.schemeId The unique six character concept identifier for the Concept Scheme to which you wish to filter.
- * @param options.branchId The unique six character concept identifier of a branch. Child concepts will be returned.
+ * @param schemeId - The unique six character concept identifier for the Concept Scheme to which you wish to filter.
+ * @param branchId - The unique six character concept identifier of a branch. Child concepts will be returned.
  * @returns A reference type filter for the child concepts of the designated branch in the selected Concept Scheme
  */
 export declare function branchFilter(options: BranchOptions): BranchFilterResult
@@ -22,6 +22,8 @@ declare type BranchOptions = {
   branchId: string
 }
 
+export declare function HierarchyInput(props: any): JSX.Element
+
 declare interface Options {
   baseUri?: string
 }
@@ -30,7 +32,7 @@ declare interface Options {
  * Document Scheme Filter
  *
  * Pluggable Function for Filtering to a Single SKOS Concept Scheme
- * @param options.schemeId The unique six character concept identifier for the Concept Scheme to which you wish to filter.
+ * @param schemeId - The unique six character concept identifier for the Concept Scheme to which you wish to filter.
  * @returns A reference type filter for Concepts and Top Concepts in the selected Concept Scheme
  */
 export declare function schemeFilter(options: SchemeOptions): SchemeFilterResult
@@ -46,13 +48,30 @@ declare type SchemeOptions = {
 
 /**
  * Defines a Sanity plugin for managing taxonomies.
- * @param options - Optional configuration options for the plugin.
- * @param options.baseUri - The base URI to use for SKOS concepts and concept schemes.
  * baseURI should follow an IANA http/s scheme and should terminate with either a / or #.
  * @returns A Sanity plugin object.
  */
 export declare const taxonomyManager: Plugin_2<Options | undefined>
 
-export declare const TreeView: ({document}: {document: any}) => JSX.Element
+/**
+ * Tree View Component Wrapper
+ * This is the view component for the hierarchy tree. It is the
+ * top level of concept scheme views and is passed into Desk
+ * structure to render the primary view for taxonomy documents.
+ * TODO: Extend SanityDocument type to include display properties.
+ *       What is the type of the document object returned by the Desk
+ *       structure?
+ */
+export declare const TreeView: ({
+  document,
+  branchId,
+  selectConcept,
+  inputComponent,
+}: {
+  document: any
+  branchId: string
+  selectConcept: any
+  inputComponent?: boolean | undefined
+}) => JSX.Element
 
 export {}