sanity-plugin-recursive-hierarchy 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,336 @@
+import {BooleanDefinition} from 'sanity'
+import type {ComponentType} from 'react'
+import type {CurrentUser} from 'sanity'
+import type {FieldDefinition} from 'sanity'
+import {FieldDefinitionBase} from 'sanity'
+import {ListItemBuilder} from 'sanity/structure'
+import {ObjectDefinition} from 'sanity'
+import type {ObjectInputProps} from 'sanity'
+import {Plugin as Plugin_2} from 'sanity'
+import {PreviewConfig} from 'sanity'
+import {ReactNode} from 'react'
+import type {SanityDocument} from 'sanity'
+import type {Slug} from 'sanity'
+import {StringDefinition} from 'sanity'
+import {StructureBuilder} from 'sanity/structure'
+import {StructureResolverContext} from 'sanity/structure'
+import type {Template} from 'sanity'
+import {WidenInitialValue} from 'sanity'
+import {WidenValidation} from 'sanity'
+
+/** @public */
+export declare const ACTION_GROUP_ADD: 'ADD'
+
+/** @public */
+export declare const ACTION_GROUP_DELETE: 'DELETE'
+
+/** @public */
+export declare const ACTION_GROUP_EDIT: 'EDIT'
+
+declare type BaseRecursiveStructureParentOptions = {
+  S: StructureBuilder
+  context: StructureResolverContext
+  treeId: string
+  locale: Locale
+  parentNodeDocumentType: string
+  parentNodeIcon: ComponentType
+  parentNodeTemplate: string
+  topLevelNodeListTitle: string
+  descendentNodeTemplate: string
+  descendentListTitleSuffix: string
+  leafMenuSortByParentsItemTitle: string
+  descendentAdditionalParamsFromParent: {
+    key: string
+    default: unknown
+  }[]
+  parentMenuCreateItemLabel: string
+}
+
+/** @public */
+export declare type CreateDraftParams = {
+  timestamp: number
+  type: string
+  template: string
+  parentId: string
+  parentSummary: SanityDocumentWithDraftInfo | undefined
+  parentPaneId: string
+  additionalAttributes?: {
+    title?: string
+    language?: string
+    filters?: string[]
+    topLevelNode?: boolean
+  }
+}
+
+/** @public */
+export declare function createTreeTemplates(trees: TreeConfig[]): Template[]
+
+/** @public */
+export declare const DEFAULT_LOCALE_KEY = 'default'
+
+/** @public */
+export declare interface FilterBuilder {
+  type: (type: string) => FilterBuilder
+  language: (lang: string, langFieldName?: string) => FilterBuilder
+  userScope: (user: CurrentUser | null) => FilterBuilder
+  excludeSingletons: (ids: string[]) => FilterBuilder
+  custom: (filter: string) => FilterBuilder
+  build: () => string
+  getParams: () => Record<string, unknown>
+}
+
+/** @public */
+export declare const generateLanguageField: (params: {languageFieldName: string}) => FieldDefinition
+
+/** @public */
+export declare const generateLeafParentNodesField: (params: {
+  nodeType: string
+  title?: string
+  description?: string
+  languageFieldName?: string
+}) => FieldDefinition
+
+/** @public */
+export declare const generateNodeParentField: (params: {
+  nodeType: string
+  title?: string
+  description?: string
+  languageFieldName?: string
+}) => FieldDefinition
+
+/** @public */
+export declare const generateSlugField: (params: {
+  treeId: string
+  basePath?: string
+  languageFieldName?: string
+}) => FieldDefinition
+
+/** @public */
+export declare function getAllTrees(): TreeConfig[]
+
+/** @public */
+export declare function getPluginOptions(): PluginOptions
+
+/** @public */
+export declare function getStructureApiVersion(): string
+
+/** @public */
+export declare function getTreeConfig(treeId: string): TreeConfig
+
+/** @public */
+export declare function getTreeForDocumentType(docType: string): TreeConfig | undefined
+
+/** @public */
+export declare function getTreeTemplateIds(tree: TreeConfig): TreeTemplateIds
+
+/** @public */
+export declare const leafParentTitlesField: {
+  type: 'string'
+  name: 'parentTitles'
+} & Omit<StringDefinition, 'preview'> &
+  FieldDefinitionBase &
+  WidenValidation &
+  WidenInitialValue
+
+/** @public */
+export declare type Locale = {
+  fallbackLocale?: null | string
+  flag: string
+  id: string
+  releaseId?: string
+  status?: 'draft' | 'in_release' | 'published'
+  title: string
+}
+
+/** @public */
+export declare type LocaleOption = {
+  id: string
+  title: string
+  flag?: string
+}
+
+/** @public */
+export declare type MapUpdatePayload = {
+  timestamp: number
+  treeId: string
+  documentType: string
+  nodeDocumentType: string
+  leafDocumentType: string
+  documentId: string
+  oldParentIds: Array<string>
+  newParentIds: Array<string>
+  language: string
+  suppressRouting: boolean
+  rebuildFromRoot: boolean
+  patchFields?: {
+    title?: string
+    slug?: {
+      current?: string
+      fullUrl?: string
+    }
+  }
+  actionGroup: typeof ACTION_GROUP_ADD | typeof ACTION_GROUP_DELETE | typeof ACTION_GROUP_EDIT | ''
+}
+
+/**
+ * WARNING: Must be rendered as a React component (`<MapUpdater {...props} />`)
+ * and NOT called as a function (`MapUpdater(props)`). Calling it as a function
+ * breaks React's hook lifecycle — hooks inside will be associated with the
+ * parent component's fiber instead of their own, causing stale state, skipped
+ * effects, and unpredictable behavior.
+ *
+ * @public
+ */
+export declare function MapUpdater(
+  props: {
+    treeId: string
+    documentType: string
+    nodeOrLeaf: 'leaf' | 'node'
+  } & ObjectInputProps,
+): ReactNode
+
+declare type MultiLocaleRecursiveNestedStructureOptions = Omit<
+  BaseRecursiveStructureParentOptions,
+  'locale'
+> & {
+  mode: 'browse' | 'manage'
+  rootListRecursiveListItemTitle: string
+  rootListRecursiveListItemIcon: ComponentType | ReactNode
+  locales: Locale[]
+  noLocalesError: string
+  parentMenuCreateItemLabel: string
+  parentNodeIcon?: ComponentType
+  parentAdditionalParams: {
+    title?: string
+  }
+  leafDocumentType: string
+  leafTemplate: string
+  leafDocumentTypeLabel?: string
+}
+
+/**
+ * Outer key = treeId, inner key = localeKey
+ * @public
+ */
+export declare type NodeAndLeafMap = Record<string, Record<string, StructureMapAndNodesDict>>
+
+declare type NodeInfo = {
+  leaves: SanityDocumentWithDraftInfo[]
+  node: SanityDocumentWithDraftInfo | undefined
+}
+
+declare type NodesDictionary = Record<string, NodeInfo>
+
+/** @public */
+export declare type PluginOptions = {
+  trees: TreeConfig[]
+  t?: (key: string, language?: string, params?: Record<string, unknown>) => string
+  createStructureFilter?: () => FilterBuilder
+  icons?: {
+    plus?: ComponentType
+    folderTree?: ComponentType
+  }
+  apiVersion?: string
+}
+
+/**
+ * Sanity plugin for recursive nested list structure.
+ * Configure trees (each with documentTypes, languageFieldName, getLocales), t, createStructureFilter, and icons via options.
+ *
+ * @public
+ */
+export declare const recursiveListPlugin: Plugin_2<PluginOptions | undefined>
+
+/** @public */
+export declare const recursiveListSingleOrMultiLocale: (
+  options: MultiLocaleRecursiveNestedStructureOptions,
+) => ListItemBuilder
+
+/** @public */
+export declare type SanityDocumentWithDraftInfo = Omit<
+  SanityDocument,
+  '_rev' | 'createdAt' | 'updatedAt'
+> & {
+  _id: string
+  _type: string
+  _originalId: string
+  language?: string
+  title: string
+  slug: Slug & {
+    fullUrl?: string
+  }
+  parentIds?: Array<string>
+  topLevelNode?: boolean
+}
+
+/** @public */
+export declare function setPluginOptions(options: PluginOptions): void
+
+declare type StructureMap = Record<
+  string,
+  {
+    children: Array<SanityDocumentWithDraftInfo>
+    title: string
+  }
+>
+
+/** @public */
+export declare type StructureMapAndNodesDict = {
+  nodesDictionary: NodesDictionary
+  structureMap: StructureMap
+}
+
+/** @public */
+export declare const titleField: {
+  type: 'string'
+  name: 'title'
+} & Omit<StringDefinition, 'preview'> &
+  FieldDefinitionBase &
+  WidenValidation &
+  WidenInitialValue
+
+/** @public */
+export declare const topLevelNodeField: {
+  type: 'boolean'
+  name: 'topLevelNode'
+} & Omit<BooleanDefinition, 'preview'> &
+  FieldDefinitionBase &
+  WidenValidation &
+  WidenInitialValue
+
+/** @public */
+export declare type TreeConfig = {
+  id: string
+  documentTypes: {
+    node: string
+    leaf: string
+  }
+  languageFieldName?: string
+  getLocales?: (client: unknown) => LocaleOption[]
+  leafParentReferenceField?: string
+}
+
+/** @public */
+export declare type TreeTemplateIds = {
+  parentNode: string
+  descendentNode: string
+  leaf: string
+}
+
+/** @public */
+export declare const urlSlugObject: {
+  type: 'object'
+  name: 'urlSlug'
+} & Omit<ObjectDefinition, 'preview'> & {
+    preview?:
+      | PreviewConfig<
+          {
+            current: string
+            fullUrl: string
+          },
+          Record<'current' | 'fullUrl', any>
+        >
+      | undefined
+  }
+
+export {}

package/dist/index.d.ts

@@ -0,0 +1,336 @@
+import {BooleanDefinition} from 'sanity'
+import type {ComponentType} from 'react'
+import type {CurrentUser} from 'sanity'
+import type {FieldDefinition} from 'sanity'
+import {FieldDefinitionBase} from 'sanity'
+import {ListItemBuilder} from 'sanity/structure'
+import {ObjectDefinition} from 'sanity'
+import type {ObjectInputProps} from 'sanity'
+import {Plugin as Plugin_2} from 'sanity'
+import {PreviewConfig} from 'sanity'
+import {ReactNode} from 'react'
+import type {SanityDocument} from 'sanity'
+import type {Slug} from 'sanity'
+import {StringDefinition} from 'sanity'
+import {StructureBuilder} from 'sanity/structure'
+import {StructureResolverContext} from 'sanity/structure'
+import type {Template} from 'sanity'
+import {WidenInitialValue} from 'sanity'
+import {WidenValidation} from 'sanity'
+
+/** @public */
+export declare const ACTION_GROUP_ADD: 'ADD'
+
+/** @public */
+export declare const ACTION_GROUP_DELETE: 'DELETE'
+
+/** @public */
+export declare const ACTION_GROUP_EDIT: 'EDIT'
+
+declare type BaseRecursiveStructureParentOptions = {
+  S: StructureBuilder
+  context: StructureResolverContext
+  treeId: string
+  locale: Locale
+  parentNodeDocumentType: string
+  parentNodeIcon: ComponentType
+  parentNodeTemplate: string
+  topLevelNodeListTitle: string
+  descendentNodeTemplate: string
+  descendentListTitleSuffix: string
+  leafMenuSortByParentsItemTitle: string
+  descendentAdditionalParamsFromParent: {
+    key: string
+    default: unknown
+  }[]
+  parentMenuCreateItemLabel: string
+}
+
+/** @public */
+export declare type CreateDraftParams = {
+  timestamp: number
+  type: string
+  template: string
+  parentId: string
+  parentSummary: SanityDocumentWithDraftInfo | undefined
+  parentPaneId: string
+  additionalAttributes?: {
+    title?: string
+    language?: string
+    filters?: string[]
+    topLevelNode?: boolean
+  }
+}
+
+/** @public */
+export declare function createTreeTemplates(trees: TreeConfig[]): Template[]
+
+/** @public */
+export declare const DEFAULT_LOCALE_KEY = 'default'
+
+/** @public */
+export declare interface FilterBuilder {
+  type: (type: string) => FilterBuilder
+  language: (lang: string, langFieldName?: string) => FilterBuilder
+  userScope: (user: CurrentUser | null) => FilterBuilder
+  excludeSingletons: (ids: string[]) => FilterBuilder
+  custom: (filter: string) => FilterBuilder
+  build: () => string
+  getParams: () => Record<string, unknown>
+}
+
+/** @public */
+export declare const generateLanguageField: (params: {languageFieldName: string}) => FieldDefinition
+
+/** @public */
+export declare const generateLeafParentNodesField: (params: {
+  nodeType: string
+  title?: string
+  description?: string
+  languageFieldName?: string
+}) => FieldDefinition
+
+/** @public */
+export declare const generateNodeParentField: (params: {
+  nodeType: string
+  title?: string
+  description?: string
+  languageFieldName?: string
+}) => FieldDefinition
+
+/** @public */
+export declare const generateSlugField: (params: {
+  treeId: string
+  basePath?: string
+  languageFieldName?: string
+}) => FieldDefinition
+
+/** @public */
+export declare function getAllTrees(): TreeConfig[]
+
+/** @public */
+export declare function getPluginOptions(): PluginOptions
+
+/** @public */
+export declare function getStructureApiVersion(): string
+
+/** @public */
+export declare function getTreeConfig(treeId: string): TreeConfig
+
+/** @public */
+export declare function getTreeForDocumentType(docType: string): TreeConfig | undefined
+
+/** @public */
+export declare function getTreeTemplateIds(tree: TreeConfig): TreeTemplateIds
+
+/** @public */
+export declare const leafParentTitlesField: {
+  type: 'string'
+  name: 'parentTitles'
+} & Omit<StringDefinition, 'preview'> &
+  FieldDefinitionBase &
+  WidenValidation &
+  WidenInitialValue
+
+/** @public */
+export declare type Locale = {
+  fallbackLocale?: null | string
+  flag: string
+  id: string
+  releaseId?: string
+  status?: 'draft' | 'in_release' | 'published'
+  title: string
+}
+
+/** @public */
+export declare type LocaleOption = {
+  id: string
+  title: string
+  flag?: string
+}
+
+/** @public */
+export declare type MapUpdatePayload = {
+  timestamp: number
+  treeId: string
+  documentType: string
+  nodeDocumentType: string
+  leafDocumentType: string
+  documentId: string
+  oldParentIds: Array<string>
+  newParentIds: Array<string>
+  language: string
+  suppressRouting: boolean
+  rebuildFromRoot: boolean
+  patchFields?: {
+    title?: string
+    slug?: {
+      current?: string
+      fullUrl?: string
+    }
+  }
+  actionGroup: typeof ACTION_GROUP_ADD | typeof ACTION_GROUP_DELETE | typeof ACTION_GROUP_EDIT | ''
+}
+
+/**
+ * WARNING: Must be rendered as a React component (`<MapUpdater {...props} />`)
+ * and NOT called as a function (`MapUpdater(props)`). Calling it as a function
+ * breaks React's hook lifecycle — hooks inside will be associated with the
+ * parent component's fiber instead of their own, causing stale state, skipped
+ * effects, and unpredictable behavior.
+ *
+ * @public
+ */
+export declare function MapUpdater(
+  props: {
+    treeId: string
+    documentType: string
+    nodeOrLeaf: 'leaf' | 'node'
+  } & ObjectInputProps,
+): ReactNode
+
+declare type MultiLocaleRecursiveNestedStructureOptions = Omit<
+  BaseRecursiveStructureParentOptions,
+  'locale'
+> & {
+  mode: 'browse' | 'manage'
+  rootListRecursiveListItemTitle: string
+  rootListRecursiveListItemIcon: ComponentType | ReactNode
+  locales: Locale[]
+  noLocalesError: string
+  parentMenuCreateItemLabel: string
+  parentNodeIcon?: ComponentType
+  parentAdditionalParams: {
+    title?: string
+  }
+  leafDocumentType: string
+  leafTemplate: string
+  leafDocumentTypeLabel?: string
+}
+
+/**
+ * Outer key = treeId, inner key = localeKey
+ * @public
+ */
+export declare type NodeAndLeafMap = Record<string, Record<string, StructureMapAndNodesDict>>
+
+declare type NodeInfo = {
+  leaves: SanityDocumentWithDraftInfo[]
+  node: SanityDocumentWithDraftInfo | undefined
+}
+
+declare type NodesDictionary = Record<string, NodeInfo>
+
+/** @public */
+export declare type PluginOptions = {
+  trees: TreeConfig[]
+  t?: (key: string, language?: string, params?: Record<string, unknown>) => string
+  createStructureFilter?: () => FilterBuilder
+  icons?: {
+    plus?: ComponentType
+    folderTree?: ComponentType
+  }
+  apiVersion?: string
+}
+
+/**
+ * Sanity plugin for recursive nested list structure.
+ * Configure trees (each with documentTypes, languageFieldName, getLocales), t, createStructureFilter, and icons via options.
+ *
+ * @public
+ */
+export declare const recursiveListPlugin: Plugin_2<PluginOptions | undefined>
+
+/** @public */
+export declare const recursiveListSingleOrMultiLocale: (
+  options: MultiLocaleRecursiveNestedStructureOptions,
+) => ListItemBuilder
+
+/** @public */
+export declare type SanityDocumentWithDraftInfo = Omit<
+  SanityDocument,
+  '_rev' | 'createdAt' | 'updatedAt'
+> & {
+  _id: string
+  _type: string
+  _originalId: string
+  language?: string
+  title: string
+  slug: Slug & {
+    fullUrl?: string
+  }
+  parentIds?: Array<string>
+  topLevelNode?: boolean
+}
+
+/** @public */
+export declare function setPluginOptions(options: PluginOptions): void
+
+declare type StructureMap = Record<
+  string,
+  {
+    children: Array<SanityDocumentWithDraftInfo>
+    title: string
+  }
+>
+
+/** @public */
+export declare type StructureMapAndNodesDict = {
+  nodesDictionary: NodesDictionary
+  structureMap: StructureMap
+}
+
+/** @public */
+export declare const titleField: {
+  type: 'string'
+  name: 'title'
+} & Omit<StringDefinition, 'preview'> &
+  FieldDefinitionBase &
+  WidenValidation &
+  WidenInitialValue
+
+/** @public */
+export declare const topLevelNodeField: {
+  type: 'boolean'
+  name: 'topLevelNode'
+} & Omit<BooleanDefinition, 'preview'> &
+  FieldDefinitionBase &
+  WidenValidation &
+  WidenInitialValue
+
+/** @public */
+export declare type TreeConfig = {
+  id: string
+  documentTypes: {
+    node: string
+    leaf: string
+  }
+  languageFieldName?: string
+  getLocales?: (client: unknown) => LocaleOption[]
+  leafParentReferenceField?: string
+}
+
+/** @public */
+export declare type TreeTemplateIds = {
+  parentNode: string
+  descendentNode: string
+  leaf: string
+}
+
+/** @public */
+export declare const urlSlugObject: {
+  type: 'object'
+  name: 'urlSlug'
+} & Omit<ObjectDefinition, 'preview'> & {
+    preview?:
+      | PreviewConfig<
+          {
+            current: string
+            fullUrl: string
+          },
+          Record<'current' | 'fullUrl', any>
+        >
+      | undefined
+  }
+
+export {}