sanity-plugin-taxonomy-manager 2.2.2 → 2.3.1

package/README.md

@@ -8,6 +8,20 @@
 > This is a **Sanity Studio v3** plugin.
 > For the v2 version, please refer to the [v2-branch](https://github.com/andybywire/sanity-plugin-taxonomy-manager/tree/studio-v2).
 
+> 🚨 **Breaking Changes for Concept Fields**
+>
+> Version 2.3.1 of Sanity Taxonomy Manager is the last version to support the `baseUri` and `skosConceptScheme` fields that were part of version 1 and early (patch) versions of v2. 
+>
+> If you are upgrading to Taxonomy Manager version 3 with concepts created in one of these early versions, install this version first. v2.3.1 includes field utilities to help you:
+>
+> - convert `baseUri` to the new schema
+> - generate unique `concept` and `conceptScheme` identifiers
+> - remove deprecated `skosConceptScheme` references in Concepts
+>
+> In Sanity Taxonomy Manager 3.0, both these utilities and the fields that support the deprecated schemes will be removed. Concept tags and queries will still work, but may lead to warnings in the Studio about scheme/data mismatches.
+>
+> Please feel free to reach out on [GitHub Discussions](https://github.com/andybywire/sanity-plugin-taxonomy-manager/discussions) with any questions. 
+
 Taxonomies are crucial tools for organization and interoperability between and across data sets. Taxonomy Manager provides a way for content authors to create, use, and maintain standards compliant taxonomies in Sanity Studio.
 
 The Taxonomy Manager document schema is based on the [World Wide Web Consortium](https://www.w3.org/) (W3C) [Simple Knowledge Organization Scheme](https://www.w3.org/TR/skos-reference/) (SKOS) recommendation. Concept and concept scheme editor tools include standard SKOS properties, hints for creating consistent concepts and vocabularies, and validation functions for preventing consistency errors.
@@ -23,10 +37,16 @@ The Taxonomy Manager document schema is based on the [World Wide Web Consortium]
 
 ## Installation
 
-Install using the [Sanity CLI](https://www.sanity.io/docs/cli).
+In your Sanity project folder, run
 
 ```bash
-$ npm i sanity-plugin-taxonomy-manager
+npm i sanity-plugin-taxonomy-manager
+```
+
+or
+
+```bash
+yarn add sanity-plugin-taxonomy-manager
 ```
 
 ## Configuration
@@ -152,32 +172,6 @@ export const structure = (S) =>
       ```
 1. Tag resources with concepts and then integrate into search indexing, filtering, navigation, and semantic web services.
 
-### Semantic Relationships
-
-The concept editor includes filtering and validation to help you create consistent SKOS vocabularies:
-
-**SKOS Broader and Related Concepts**  
-Adding the same concept to Broader and Related fields is not allowed, and the editor validates disjunction of Related concepts with Broader Transitive up to five hierarchical levels in either direction.
-
-**Preferred, Alternative, and Hidden Labels**  
-Preferred Labels are validated for uniqueness across concepts, and Preferred, Alternative, and Hidden are validated to prevent duplicates and overlap.
-
-**Scope Notes, Definition, and Examples**  
-Standard optional SKOS documentation fields are included by default.
-
-**Support for Single or Multiple Taxonomy Schemes (or none)**  
-For cases where more than one taxonomy is needed, multiple [SKOS Concept Schemes](https://www.w3.org/TR/skos-reference/#schemes) are supported. Schemes can be used to configure filtered views of concepts in Sanity Structure Builder and can be used to scope values for reference arrays.
-
-  <!-- Concept Scheme views show a hierarchical list (Tree View) of the concepts included in a given scheme. This list allows for easy visualization of Top Concepts, polyhierarchy (concepts that appear in more than one place in the hierarchy), and "Orphan" terms (top level concepts not denoted as a "Top Concept"). -->
-
-## SKOS Overview
-
-> The [Simple Knowledge Organization System (SKOS)](https://www.w3.org/TR/skos-reference/) is a common data model for sharing and linking knowledge organization systems via the Web.
->
-> Many knowledge organization systems, such as thesauri, taxonomies, classification schemes and subject heading systems, share a similar structure, and are used in similar applications. SKOS captures much of this similarity and makes it explicit, to enable data and technology sharing across diverse applications.
->
-> The SKOS data model provides a standard, low-cost migration path for porting existing knowledge organization systems to the Semantic Web. SKOS also provides a lightweight, intuitive language for developing and sharing new knowledge organization systems. It may be used on its own, or in combination with formal knowledge representation languages such as the Web Ontology language (OWL).
-
 ## License
 
 MIT © Andy Fitzgerald

package/lib/index.d.ts

@@ -2,41 +2,47 @@
 
 import {Plugin as Plugin_2} from 'sanity'
 
-export declare function branchFilter(options: Options_2): branchFilterResult
+export declare function branchFilter(options: BranchOptions): BranchFilterResult
 
-/**
- * Pluggable Function for Filtering to a Top Concept Branch within a SKOS Concept Scheme
- */
-declare type branchFilterResult = {
+declare type BranchFilterResult = {
   filter: string
-  params: {
-    schemeId: string
-    branchId: string
-  }
+  params: BranchOptions
 }
 
-declare type Options = {
+/**
+ * Pluggable Function for Filtering to a Top Concept Branch within a SKOS Concept Scheme
+ */
+declare type BranchOptions = {
   schemeId: string
+  branchId: string
 }
 
-declare type Options_2 = {
-  schemeId: string
-  branchId: string
+declare interface Options {
+  baseUri?: string
 }
 
-export declare function schemeFilter(options: Options): SchemeFilterResult
+export declare function schemeFilter(options: SchemeOptions): SchemeFilterResult
+
+declare type SchemeFilterResult = {
+  filter: string
+  params: SchemeOptions
+}
 
 /**
  * Pluggable Function for Filtering to a Single SKOS Concept Scheme
  */
-declare type SchemeFilterResult = {
-  filter: string
-  params: {
-    schemeId: string
-  }
+declare type SchemeOptions = {
+  schemeId: string
 }
 
-export declare const taxonomyManager: Plugin_2<any>
+/**
+ * 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