sanity-plugin-taxonomy-manager 4.5.0 → 4.7.0

package/lib/index.d.ts

@@ -17,7 +17,11 @@ import type {useClient} from 'sanity'
  * plugin `schemeFilter` or `branchFilter` options.
  *
  */
-export declare function ArrayHierarchyInput(props: ArrayFieldProps): JSX.Element
+export declare function ArrayHierarchyInput(props: ArrayHierarchyInputProps): JSX.Element
+
+declare type ArrayHierarchyInputProps = ArrayFieldProps & {
+  embeddingsIndex?: EmbeddingsIndexConfig
+}
 
 /**
  * #### Reference Field Scheme & Branch Filter
@@ -103,10 +107,34 @@ declare interface ConceptSchemeDocument extends SanityDocument {
   }
 }
 
+declare interface EmbeddingsIndexConfig {
+  indexName: string
+  fieldReferences: string[]
+  maxResults?: number
+}
+
+declare interface EmbeddingsResult {
+  score: number
+  value: {
+    documentId: string
+    type: string
+  }
+}
+
+declare type HierarchyInput = ObjectFieldProps<Reference> & {
+  embeddingsIndex?: EmbeddingsIndexConfig
+}
+
 declare interface Options {
   baseUri?: string
   customConceptFields?: FieldDefinition[]
   customSchemeFields?: FieldDefinition[]
+  ident?: {
+    pattern?: string
+    length?: number
+    prefix?: string
+    regenUi?: boolean
+  }
 }
 
 /**
@@ -118,7 +146,7 @@ declare interface Options {
  * Hierarchy view must be used in conjunction with the Taxonomy Manager
  * plugin `schemeFilter` or `branchFilter` options.
  */
-export declare function ReferenceHierarchyInput(props: ObjectFieldProps<Reference>): JSX.Element
+export declare function ReferenceHierarchyInput(props: HierarchyInput): JSX.Element
 
 /**
  * #### Reference Field Scheme Filter
@@ -181,12 +209,17 @@ declare type SchemeOptions = {
 }
 
 /**
- * #### Defines a Sanity plugin for managing taxonomies
- * BaseURI should follow an IANA http/s scheme and should terminate with either a / or #.
- * @param options - Optional configuration options for the plugin.
- * @param options.baseUri - The base URI to use for SKOS concepts and concept schemes.
- * @param options.customConceptFields - An array of additional fields to add to the skosConcept type.
- * @param options.customSchemeFields - An array of additional fields to add to the skosConceptScheme type.
+ * #### Sanity Taxonomy Manager
+ * Defines a Sanity plugin for managing SKOS compliant taxonomies in Sanity Studio.
+ * #### Options
+ * @param 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 #.
+ * @param customConceptFields - An array of additional fields to add to the skosConcept type.
+ * @param customSchemeFields - An array of additional fields to add to the skosConceptScheme type.
+ * #### Identifier Configuration
+ * @param ident.pattern - The character set to use for identifiers (default: '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz').
+ * @param ident.length - The length of the generated identifier (default: 6).
+ * @param ident.prefix - A prefix to prepend to generated identifiers, for example to use Wikidata style IDs like "Q27521" (default: '').
+ * @param ident.regenUi - Whether to display the "Create Unique Identifier" button in the UI by default.
  * @returns A Sanity plugin object.
  */
 export declare const taxonomyManager: Plugin_2<Options | undefined>
@@ -207,14 +240,18 @@ export declare const TreeView: ({
   inputComponent,
   selectConcept,
   expanded,
+  conceptRecs,
+  recsError,
 }: TreeViewProps) => JSX.Element
 
 declare interface TreeViewProps {
   document?: ConceptSchemeDocument
-  branchId: string
+  branchId?: string | null
   selectConcept?: (conceptId: {_ref: string; _type: 'reference'; _originalId?: string}) => void
   inputComponent?: boolean
   expanded?: boolean
+  conceptRecs?: EmbeddingsResult[]
+  recsError?: string | null
 }
 
 export {}

package/lib/index.esm.d.mts

@@ -17,7 +17,11 @@ import type {useClient} from 'sanity'
  * plugin `schemeFilter` or `branchFilter` options.
  *
  */
-export declare function ArrayHierarchyInput(props: ArrayFieldProps): JSX.Element
+export declare function ArrayHierarchyInput(props: ArrayHierarchyInputProps): JSX.Element
+
+declare type ArrayHierarchyInputProps = ArrayFieldProps & {
+  embeddingsIndex?: EmbeddingsIndexConfig
+}
 
 /**
  * #### Reference Field Scheme & Branch Filter
@@ -103,10 +107,34 @@ declare interface ConceptSchemeDocument extends SanityDocument {
   }
 }
 
+declare interface EmbeddingsIndexConfig {
+  indexName: string
+  fieldReferences: string[]
+  maxResults?: number
+}
+
+declare interface EmbeddingsResult {
+  score: number
+  value: {
+    documentId: string
+    type: string
+  }
+}
+
+declare type HierarchyInput = ObjectFieldProps<Reference> & {
+  embeddingsIndex?: EmbeddingsIndexConfig
+}
+
 declare interface Options {
   baseUri?: string
   customConceptFields?: FieldDefinition[]
   customSchemeFields?: FieldDefinition[]
+  ident?: {
+    pattern?: string
+    length?: number
+    prefix?: string
+    regenUi?: boolean
+  }
 }
 
 /**
@@ -118,7 +146,7 @@ declare interface Options {
  * Hierarchy view must be used in conjunction with the Taxonomy Manager
  * plugin `schemeFilter` or `branchFilter` options.
  */
-export declare function ReferenceHierarchyInput(props: ObjectFieldProps<Reference>): JSX.Element
+export declare function ReferenceHierarchyInput(props: HierarchyInput): JSX.Element
 
 /**
  * #### Reference Field Scheme Filter
@@ -181,12 +209,17 @@ declare type SchemeOptions = {
 }
 
 /**
- * #### Defines a Sanity plugin for managing taxonomies
- * BaseURI should follow an IANA http/s scheme and should terminate with either a / or #.
- * @param options - Optional configuration options for the plugin.
- * @param options.baseUri - The base URI to use for SKOS concepts and concept schemes.
- * @param options.customConceptFields - An array of additional fields to add to the skosConcept type.
- * @param options.customSchemeFields - An array of additional fields to add to the skosConceptScheme type.
+ * #### Sanity Taxonomy Manager
+ * Defines a Sanity plugin for managing SKOS compliant taxonomies in Sanity Studio.
+ * #### Options
+ * @param 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 #.
+ * @param customConceptFields - An array of additional fields to add to the skosConcept type.
+ * @param customSchemeFields - An array of additional fields to add to the skosConceptScheme type.
+ * #### Identifier Configuration
+ * @param ident.pattern - The character set to use for identifiers (default: '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz').
+ * @param ident.length - The length of the generated identifier (default: 6).
+ * @param ident.prefix - A prefix to prepend to generated identifiers, for example to use Wikidata style IDs like "Q27521" (default: '').
+ * @param ident.regenUi - Whether to display the "Create Unique Identifier" button in the UI by default.
  * @returns A Sanity plugin object.
  */
 export declare const taxonomyManager: Plugin_2<Options | undefined>
@@ -207,14 +240,18 @@ export declare const TreeView: ({
   inputComponent,
   selectConcept,
   expanded,
+  conceptRecs,
+  recsError,
 }: TreeViewProps) => JSX.Element
 
 declare interface TreeViewProps {
   document?: ConceptSchemeDocument
-  branchId: string
+  branchId?: string | null
   selectConcept?: (conceptId: {_ref: string; _type: 'reference'; _originalId?: string}) => void
   inputComponent?: boolean
   expanded?: boolean
+  conceptRecs?: EmbeddingsResult[]
+  recsError?: string | null
 }
 
 export {}