@sanity/hierarchical-document-list 0.1.0-next.3 → 1.0.0

package/lib/components/TreeNodeRenderer.js

@@ -1,22 +1,59 @@
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import React from 'react';
-import TreeNodeRendererScaffold from './TreeNodeRendererScaffold';
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var jsx_runtime_1 = require("react/jsx-runtime");
+var React = __importStar(require("react"));
+var TreeNodeRendererScaffold_1 = __importDefault(require("./TreeNodeRendererScaffold"));
 /**
  * To prevent expand buttons from overflowing on the left, we add a minimum left padding to all entries
  */
-const BASE_LEFT_PADDING = 10;
-const NESTING_PADDING = 14;
-const TreeNodeRenderer = (props) => {
-    const { children, lowerSiblingCounts, connectDropTarget, isOver, draggedNode, canDrop } = props;
+var BASE_LEFT_PADDING = 10;
+var NESTING_PADDING = 14;
+var TreeNodeRenderer = function (props) {
+    var children = props.children, lowerSiblingCounts = props.lowerSiblingCounts, connectDropTarget = props.connectDropTarget, isOver = props.isOver, draggedNode = props.draggedNode, canDrop = props.canDrop;
     // Construct the scaffold representing the structure of the tree
-    const scaffoldBlockCount = lowerSiblingCounts.length;
-    return connectDropTarget(_jsxs("div", { style: props.style, children: [_jsx("div", { style: {
+    var scaffoldBlockCount = lowerSiblingCounts.length;
+    return connectDropTarget((0, jsx_runtime_1.jsxs)("div", __assign({ style: props.style }, { children: [(0, jsx_runtime_1.jsx)("div", __assign({ style: {
                     // prettier-ignore
-                    paddingLeft: `${BASE_LEFT_PADDING + (NESTING_PADDING * scaffoldBlockCount)}px`
-                }, children: React.Children.map(children, (child) => React.cloneElement(child, {
-                    isOver,
-                    canDrop,
-                    draggedNode
-                })) }, void 0), _jsx(TreeNodeRendererScaffold, { ...props }, void 0)] }, void 0));
+                    paddingLeft: "".concat(BASE_LEFT_PADDING + (NESTING_PADDING * scaffoldBlockCount), "px")
+                } }, { children: React.Children.map(children, function (child) {
+                    return React.cloneElement(child, {
+                        isOver: isOver,
+                        canDrop: canDrop,
+                        draggedNode: draggedNode
+                    });
+                }) }), void 0), (0, jsx_runtime_1.jsx)(TreeNodeRendererScaffold_1.default, __assign({}, props), void 0)] }), void 0));
 };
-export default TreeNodeRenderer;
+exports.default = TreeNodeRenderer;

package/lib/components/TreeNodeRendererScaffold.d.ts

@@ -1,4 +1,4 @@
-import React from 'react';
+import * as React from 'react';
 import { TreeRendererProps } from 'react-sortable-tree';
 declare const TreeNodeRendererScaffold: React.FC<TreeRendererProps>;
 export default TreeNodeRendererScaffold;

package/lib/components/TreeNodeRendererScaffold.js

@@ -1,145 +1,24 @@
-import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
-import { blue } from '@sanity/color';
-import { createGlobalStyle } from 'styled-components';
+"use strict";
+var __makeTemplateObject = (this && this.__makeTemplateObject) || function (cooked, raw) {
+    if (Object.defineProperty) { Object.defineProperty(cooked, "raw", { value: raw }); } else { cooked.raw = raw; }
+    return cooked;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var jsx_runtime_1 = require("react/jsx-runtime");
+var color_1 = require("@sanity/color");
+var styled_components_1 = require("styled-components");
 // Adapted from react-sortable-tree/src/tree-node.js
-const ScaffoldStyles = createGlobalStyle `
-  .rst__lineBlock,
-  .rst__absoluteLineBlock {
-    height: 100%;
-    position: relative;
-    display: inline-block;
-    --stroke-width: 3px;
-  }
-
-  .rst__absoluteLineBlock {
-    position: absolute;
-    top: 0;
-  }
-
-  /* Highlight line for pointing to dragged row destination
-   ========================================================================== */
-  /**
- * +--+--+
- * |  |  |
- * |  |  |
- * |  |  |
- * +--+--+
- */
-  .rst__highlightLineVertical {
-    z-index: 3;
-  }
-  .rst__highlightLineVertical::before {
-    position: absolute;
-    content: '';
-    background-color: ${blue[400].hex};
-    width: calc(var(--stroke-width) * 2);
-    margin-left: calc(var(--stroke-width) * -1);
-    left: 50%;
-    top: 0;
-    height: 100%;
-  }
-
-  @keyframes arrow-pulse {
-    0% {
-      transform: translate(0, 0);
-      opacity: 0;
-    }
-    30% {
-      transform: translate(0, 300%);
-      opacity: 1;
-    }
-    70% {
-      transform: translate(0, 700%);
-      opacity: 1;
-    }
-    100% {
-      transform: translate(0, 1000%);
-      opacity: 0;
-    }
-  }
-  .rst__highlightLineVertical::after {
-    content: '';
-    position: absolute;
-    height: 0;
-    margin-left: calc(var(--stroke-width) * -1);
-    left: 50%;
-    top: 0;
-    border-left: var(--stroke-width) solid transparent;
-    border-right: var(--stroke-width) solid transparent;
-    border-top: var(--stroke-width) solid white;
-    animation: arrow-pulse 1s infinite linear both;
-  }
-
-  /**
- * +-----+
- * |     |
- * |  +--+
- * |  |  |
- * +--+--+
- */
-  .rst__highlightTopLeftCorner::before {
-    z-index: 3;
-    content: '';
-    position: absolute;
-    border-top: solid calc(var(--stroke-width) * 2) ${blue[400].hex};
-    border-left: solid calc(var(--stroke-width) * 2) ${blue[400].hex};
-    box-sizing: border-box;
-    height: calc(50% + var(--stroke-width));
-    top: 50%;
-    margin-top: calc(var(--stroke-width) * -1);
-    right: 0;
-    width: calc(50% + var(--stroke-width));
-  }
-
-  /**
- * +--+--+
- * |  |  |
- * |  |  |
- * |  +->|
- * +-----+
- */
-  .rst__highlightBottomLeftCorner {
-    z-index: 3;
-  }
-  .rst__highlightBottomLeftCorner::before {
-    content: '';
-    position: absolute;
-    border-bottom: solid calc(var(--stroke-width) * 2) ${blue[400].hex};
-    border-left: solid calc(var(--stroke-width) * 2) ${blue[400].hex};
-    box-sizing: border-box;
-    height: calc(100% + var(--stroke-width));
-    top: 0;
-    right: calc(var(--stroke-width) * 3);
-    width: calc(50% - calc(var(--stroke-width) * 2));
-  }
-
-  .rst__highlightBottomLeftCorner::after {
-    content: '';
-    position: absolute;
-    height: 0;
-    right: 0;
-    top: 100%;
-    margin-top: calc(var(--stroke-width) * -3);
-    border-top: calc(var(--stroke-width) * 3) solid transparent;
-    border-bottom: calc(var(--stroke-width) * 3) solid transparent;
-    border-left: calc(var(--stroke-width) * 3) solid ${blue[400].hex};
-  }
-
-  .rst__unclickable {
-    pointer-events: none;
-    margin-top: -calc(var(--stroke-width) * 3);
-  }
-`;
-const TreeNodeRendererScaffold = (props) => {
-    const { lowerSiblingCounts, scaffoldBlockPxWidth, listIndex, swapDepth, swapFrom, swapLength, treeIndex } = props;
+var ScaffoldStyles = (0, styled_components_1.createGlobalStyle)(templateObject_1 || (templateObject_1 = __makeTemplateObject(["\n  .rst__lineBlock,\n  .rst__absoluteLineBlock {\n    height: 100%;\n    position: relative;\n    display: inline-block;\n    --stroke-width: 3px;\n  }\n\n  .rst__absoluteLineBlock {\n    position: absolute;\n    top: 0;\n  }\n\n  /* Highlight line for pointing to dragged row destination\n   ========================================================================== */\n  /**\n * +--+--+\n * |  |  |\n * |  |  |\n * |  |  |\n * +--+--+\n */\n  .rst__highlightLineVertical {\n    z-index: 3;\n  }\n  .rst__highlightLineVertical::before {\n    position: absolute;\n    content: '';\n    background-color: ", ";\n    width: calc(var(--stroke-width) * 2);\n    margin-left: calc(var(--stroke-width) * -1);\n    left: 50%;\n    top: 0;\n    height: 100%;\n  }\n\n  @keyframes arrow-pulse {\n    0% {\n      transform: translate(0, 0);\n      opacity: 0;\n    }\n    30% {\n      transform: translate(0, 300%);\n      opacity: 1;\n    }\n    70% {\n      transform: translate(0, 700%);\n      opacity: 1;\n    }\n    100% {\n      transform: translate(0, 1000%);\n      opacity: 0;\n    }\n  }\n  .rst__highlightLineVertical::after {\n    content: '';\n    position: absolute;\n    height: 0;\n    margin-left: calc(var(--stroke-width) * -1);\n    left: 50%;\n    top: 0;\n    border-left: var(--stroke-width) solid transparent;\n    border-right: var(--stroke-width) solid transparent;\n    border-top: var(--stroke-width) solid white;\n    animation: arrow-pulse 1s infinite linear both;\n  }\n\n  /**\n * +-----+\n * |     |\n * |  +--+\n * |  |  |\n * +--+--+\n */\n  .rst__highlightTopLeftCorner::before {\n    z-index: 3;\n    content: '';\n    position: absolute;\n    border-top: solid calc(var(--stroke-width) * 2) ", ";\n    border-left: solid calc(var(--stroke-width) * 2) ", ";\n    box-sizing: border-box;\n    height: calc(50% + var(--stroke-width));\n    top: 50%;\n    margin-top: calc(var(--stroke-width) * -1);\n    right: 0;\n    width: calc(50% + var(--stroke-width));\n  }\n\n  /**\n * +--+--+\n * |  |  |\n * |  |  |\n * |  +->|\n * +-----+\n */\n  .rst__highlightBottomLeftCorner {\n    z-index: 3;\n  }\n  .rst__highlightBottomLeftCorner::before {\n    content: '';\n    position: absolute;\n    border-bottom: solid calc(var(--stroke-width) * 2) ", ";\n    border-left: solid calc(var(--stroke-width) * 2) ", ";\n    box-sizing: border-box;\n    height: calc(100% + var(--stroke-width));\n    top: 0;\n    right: calc(var(--stroke-width) * 3);\n    width: calc(50% - calc(var(--stroke-width) * 2));\n  }\n\n  .rst__highlightBottomLeftCorner::after {\n    content: '';\n    position: absolute;\n    height: 0;\n    right: 0;\n    top: 100%;\n    margin-top: calc(var(--stroke-width) * -3);\n    border-top: calc(var(--stroke-width) * 3) solid transparent;\n    border-bottom: calc(var(--stroke-width) * 3) solid transparent;\n    border-left: calc(var(--stroke-width) * 3) solid ", ";\n  }\n\n  .rst__unclickable {\n    pointer-events: none;\n    margin-top: -calc(var(--stroke-width) * 3);\n  }\n"], ["\n  .rst__lineBlock,\n  .rst__absoluteLineBlock {\n    height: 100%;\n    position: relative;\n    display: inline-block;\n    --stroke-width: 3px;\n  }\n\n  .rst__absoluteLineBlock {\n    position: absolute;\n    top: 0;\n  }\n\n  /* Highlight line for pointing to dragged row destination\n   ========================================================================== */\n  /**\n * +--+--+\n * |  |  |\n * |  |  |\n * |  |  |\n * +--+--+\n */\n  .rst__highlightLineVertical {\n    z-index: 3;\n  }\n  .rst__highlightLineVertical::before {\n    position: absolute;\n    content: '';\n    background-color: ", ";\n    width: calc(var(--stroke-width) * 2);\n    margin-left: calc(var(--stroke-width) * -1);\n    left: 50%;\n    top: 0;\n    height: 100%;\n  }\n\n  @keyframes arrow-pulse {\n    0% {\n      transform: translate(0, 0);\n      opacity: 0;\n    }\n    30% {\n      transform: translate(0, 300%);\n      opacity: 1;\n    }\n    70% {\n      transform: translate(0, 700%);\n      opacity: 1;\n    }\n    100% {\n      transform: translate(0, 1000%);\n      opacity: 0;\n    }\n  }\n  .rst__highlightLineVertical::after {\n    content: '';\n    position: absolute;\n    height: 0;\n    margin-left: calc(var(--stroke-width) * -1);\n    left: 50%;\n    top: 0;\n    border-left: var(--stroke-width) solid transparent;\n    border-right: var(--stroke-width) solid transparent;\n    border-top: var(--stroke-width) solid white;\n    animation: arrow-pulse 1s infinite linear both;\n  }\n\n  /**\n * +-----+\n * |     |\n * |  +--+\n * |  |  |\n * +--+--+\n */\n  .rst__highlightTopLeftCorner::before {\n    z-index: 3;\n    content: '';\n    position: absolute;\n    border-top: solid calc(var(--stroke-width) * 2) ", ";\n    border-left: solid calc(var(--stroke-width) * 2) ", ";\n    box-sizing: border-box;\n    height: calc(50% + var(--stroke-width));\n    top: 50%;\n    margin-top: calc(var(--stroke-width) * -1);\n    right: 0;\n    width: calc(50% + var(--stroke-width));\n  }\n\n  /**\n * +--+--+\n * |  |  |\n * |  |  |\n * |  +->|\n * +-----+\n */\n  .rst__highlightBottomLeftCorner {\n    z-index: 3;\n  }\n  .rst__highlightBottomLeftCorner::before {\n    content: '';\n    position: absolute;\n    border-bottom: solid calc(var(--stroke-width) * 2) ", ";\n    border-left: solid calc(var(--stroke-width) * 2) ", ";\n    box-sizing: border-box;\n    height: calc(100% + var(--stroke-width));\n    top: 0;\n    right: calc(var(--stroke-width) * 3);\n    width: calc(50% - calc(var(--stroke-width) * 2));\n  }\n\n  .rst__highlightBottomLeftCorner::after {\n    content: '';\n    position: absolute;\n    height: 0;\n    right: 0;\n    top: 100%;\n    margin-top: calc(var(--stroke-width) * -3);\n    border-top: calc(var(--stroke-width) * 3) solid transparent;\n    border-bottom: calc(var(--stroke-width) * 3) solid transparent;\n    border-left: calc(var(--stroke-width) * 3) solid ", ";\n  }\n\n  .rst__unclickable {\n    pointer-events: none;\n    margin-top: -calc(var(--stroke-width) * 3);\n  }\n"])), color_1.blue[400].hex, color_1.blue[400].hex, color_1.blue[400].hex, color_1.blue[400].hex, color_1.blue[400].hex, color_1.blue[400].hex);
+var TreeNodeRendererScaffold = function (props) {
+    var lowerSiblingCounts = props.lowerSiblingCounts, scaffoldBlockPxWidth = props.scaffoldBlockPxWidth, listIndex = props.listIndex, swapDepth = props.swapDepth, swapFrom = props.swapFrom, swapLength = props.swapLength, treeIndex = props.treeIndex;
     // Construct the scaffold representing the structure of the tree
-    const scaffold = lowerSiblingCounts.map((lowerSiblingCount, i) => {
+    var scaffold = lowerSiblingCounts.map(function (lowerSiblingCount, i) {
         if (lowerSiblingCount < 0 || treeIndex === listIndex || i !== swapDepth) {
             return null;
         }
         // This row has been shifted, and is at the depth of
         // the line pointing to the new destination
-        let highlightLineClass = '';
+        var highlightLineClass = '';
         if (listIndex === (swapFrom || 0) + (swapLength || 0) - 1) {
             // This block is on the bottom (target) line
             // This block points at the target block (where the row will go when released)
@@ -153,12 +32,13 @@ const TreeNodeRendererScaffold = (props) => {
             // This block is between the bottom and top
             highlightLineClass = 'rst__highlightLineVertical';
         }
-        const style = {
+        var style = {
             width: scaffoldBlockPxWidth,
             left: scaffoldBlockPxWidth * i
         };
-        return (_jsx("div", { style: style, className: `rst__unclickable rst__absoluteLineBlock ${highlightLineClass || ''}`, tabIndex: -1 }, i));
+        return ((0, jsx_runtime_1.jsx)("div", { style: style, className: "rst__unclickable rst__absoluteLineBlock ".concat(highlightLineClass || ''), tabIndex: -1 }, i));
     });
-    return (_jsxs(_Fragment, { children: [scaffold, _jsx(ScaffoldStyles, {}, void 0)] }, void 0));
+    return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [scaffold, (0, jsx_runtime_1.jsx)(ScaffoldStyles, {}, void 0)] }, void 0));
 };
-export default TreeNodeRendererScaffold;
+exports.default = TreeNodeRendererScaffold;
+var templateObject_1;

package/lib/createDeskHierarchy.js

@@ -1,47 +1,77 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-import S from '@sanity/desk-tool/structure-builder';
-import { AddIcon } from '@sanity/icons';
-import TreeDeskStructure from './TreeDeskStructure';
-const deskTreeValidator = (props) => {
-    const { documentId, referenceTo } = props;
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var jsx_runtime_1 = require("react/jsx-runtime");
+var structure_builder_1 = __importDefault(require("@sanity/desk-tool/structure-builder"));
+var icons_1 = require("@sanity/icons");
+var schema_1 = __importDefault(require("part:@sanity/base/schema"));
+var TreeDeskStructure_1 = __importDefault(require("./TreeDeskStructure"));
+var throwError_1 = __importDefault(require("./utils/throwError"));
+var deskTreeValidator = function (props) {
+    var documentId = props.documentId, referenceTo = props.referenceTo;
     if (typeof documentId !== 'string' && !documentId) {
-        throw new Error('[hierarchical input] Please add a documentId to your tree');
+        (0, throwError_1.default)('invalidDocumentId');
     }
     if (!Array.isArray(referenceTo)) {
-        throw new Error(`[hierarchical input] Missing valid 'referenceTo' in createDeskHierarchy (documentId "${documentId}")`);
+        (0, throwError_1.default)('invalidReferenceTo', "(documentId \"".concat(documentId, "\")"));
     }
-    return (deskProps) => _jsx(TreeDeskStructure, { ...deskProps, options: props }, void 0);
+    return function (deskProps) { return (0, jsx_runtime_1.jsx)(TreeDeskStructure_1.default, __assign({}, deskProps, { options: props }), void 0); };
 };
-export default function createDeskHierarchy(props) {
-    const { documentId, referenceTo, referenceOptions } = props;
-    let mainList = (referenceTo?.length === 1
-        ? S.documentTypeList(referenceTo[0]).schemaType(referenceTo[0])
-        : S.documentList().filter('_type in $types').params({ types: referenceTo }))
+function createDeskHierarchy(props) {
+    var documentId = props.documentId, referenceTo = props.referenceTo, referenceOptions = props.referenceOptions;
+    // @TODO: allow creating all types once upstream desk fix is shipped
+    /**
+     * Context: With multiple referenced document types we can’t set S.documentList().schemaType(),
+     * which only accepts one type. So the desk doesn’t have an expanded schemaType to access and
+     * try creating a new document without that, which breaks resolveEnabledActions (and probably more)
+     * in packages\@sanity\base\src\actions\utils\legacy_documentActionUtils.js
+     */
+    var safelyCreatableTypes = referenceTo.slice(0, 1);
+    var mainList = ((safelyCreatableTypes === null || safelyCreatableTypes === void 0 ? void 0 : safelyCreatableTypes.length) === 1
+        ? structure_builder_1.default.documentTypeList(safelyCreatableTypes[0]).schemaType(safelyCreatableTypes[0])
+        : structure_builder_1.default.documentList().filter('_type in $types').params({ types: safelyCreatableTypes }))
         .id(documentId)
-        .menuItems((referenceTo || []).map((schemaType) => S.menuItem()
-        .intent({
-        type: 'create',
-        params: { type: schemaType, template: schemaType }
-    })
-        // @TODO: get the title for each schema type
-        .title(schemaType)
-        .icon(AddIcon)))
-        .canHandleIntent((intent, context) => {
+        .menuItems((safelyCreatableTypes || []).map(function (schemaType) {
+        var _a, _b;
+        return structure_builder_1.default.menuItem()
+            .intent({
+            type: 'create',
+            params: { type: schemaType }
+        })
+            .title("Create ".concat((_a = schema_1.default.get(schemaType)) === null || _a === void 0 ? void 0 : _a.title))
+            .icon(((_b = schema_1.default.get(schemaType)) === null || _b === void 0 ? void 0 : _b.icon) || icons_1.AddIcon);
+    }))
+        .canHandleIntent(function (intent, context) {
+        // Can edit itself
         if (intent === 'edit' && context.id === props.documentId) {
             return true;
         }
-        if (intent === 'create' && referenceTo.includes(context.type)) {
+        // Can create & edit referenced document types
+        if (safelyCreatableTypes.includes(context.type)) {
             return true;
         }
         return false;
     });
-    if (referenceOptions?.filter) {
+    if (referenceOptions === null || referenceOptions === void 0 ? void 0 : referenceOptions.filter) {
         mainList = mainList.filter(referenceOptions.filter);
     }
-    if (referenceOptions?.filterParams) {
+    if (referenceOptions === null || referenceOptions === void 0 ? void 0 : referenceOptions.filterParams) {
         mainList = mainList.params(referenceOptions.filterParams);
     }
-    return S.listItem()
+    return structure_builder_1.default.listItem()
         .id(documentId)
         .title(props.title || documentId)
         .icon(props.icon)
@@ -52,3 +82,4 @@ export default function createDeskHierarchy(props) {
         __preserveInstance: true
     }, props.title ? { title: props.title } : {}));
 }
+exports.default = createDeskHierarchy;

package/lib/createHierarchicalSchemas.d.ts

@@ -0,0 +1,78 @@
+import { ArraySchemaType } from '@sanity/types';
+import * as React from 'react';
+import { TreeDeskStructureProps, TreeFieldSchema } from './types';
+declare type SchemaOptions = Omit<TreeDeskStructureProps, 'documentId' | 'maxDepth'>;
+export declare function createHierarchicalField({ name, title, options, ...rest }: TreeFieldSchema): Omit<ArraySchemaType, 'type' | 'jsonType' | 'of'> & {
+    type: string;
+    inputComponent: React.FC<any>;
+    of?: any[];
+};
+export default 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;
+    })[];
+})[];
+export {};

package/lib/createHierarchicalSchemas.js

@@ -0,0 +1,138 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHierarchicalField = void 0;
+var TreeDeskStructure_1 = require("./TreeDeskStructure");
+var TreeInputComponent_1 = __importDefault(require("./TreeInputComponent"));
+var injectNodeTypeInPatches_1 = require("./utils/injectNodeTypeInPatches");
+var throwError_1 = __importDefault(require("./utils/throwError"));
+function createHierarchicalNodeValueType(_a) {
+    var referenceTo = _a.referenceTo, referenceOptions = _a.referenceOptions, documentType = _a.documentType;
+    return {
+        // when used inside the field, name & type are overwritten by createHierarchicalNodeType
+        name: documentType ? (0, injectNodeTypeInPatches_1.getSchemaTypeName)(documentType, 'nodeValue') : injectNodeTypeInPatches_1.INTERNAL_NODE_VALUE_TYPE,
+        type: 'object',
+        title: "Hierarchical node value (".concat(documentType, ")"),
+        fields: [
+            { name: 'docType', type: 'string' },
+            {
+                name: 'reference',
+                type: 'reference',
+                weak: true,
+                to: referenceTo.map(function (type) { return ({ type: type }); }),
+                options: referenceOptions
+            }
+        ]
+    };
+}
+function createHierarchicalNodeType(options) {
+    return {
+        // name & type are overwritten by createHierarchicalField
+        name: options.documentType
+            ? (0, injectNodeTypeInPatches_1.getSchemaTypeName)(options.documentType, 'node')
+            : injectNodeTypeInPatches_1.INTERNAL_NODE_TYPE,
+        title: "Hierarchical node (".concat(options.documentType, ")"),
+        type: 'object',
+        fields: [
+            { name: 'parent', type: 'string' },
+            options.documentType
+                ? { name: 'value', type: (0, injectNodeTypeInPatches_1.getSchemaTypeName)(options.documentType, 'nodeValue') }
+                : // If no documentType is defined, use an anonymized inline object to avoid
+                 __assign(__assign({}, createHierarchicalNodeValueType(options)), { name: 'value', type: 'object' })
+        ]
+    };
+}
+function createHierarchicalArrayType(options) {
+    return {
+        // name & type are overwritten by createHierarchicalField
+        name: options.documentType
+            ? (0, injectNodeTypeInPatches_1.getSchemaTypeName)(options.documentType, 'array')
+            : injectNodeTypeInPatches_1.INTERNAL_NODE_ARRAY_TYPE,
+        title: "Hierarchical array of nodes (".concat(options.documentType, ")"),
+        type: 'array',
+        of: [
+            options.documentType
+                ? { type: (0, injectNodeTypeInPatches_1.getSchemaTypeName)(options.documentType, 'node') }
+                : createHierarchicalNodeType(options)
+        ]
+    };
+}
+function createHierarchicalField(_a) {
+    var name = _a.name, title = _a.title, options = _a.options, rest = __rest(_a, ["name", "title", "options"]);
+    if (!Array.isArray(options === null || options === void 0 ? void 0 : options.referenceTo)) {
+        (0, throwError_1.default)('invalidReferenceTo', "(field of name \"".concat(name, "\")"));
+    }
+    return __assign(__assign(__assign({}, rest), { name: name, title: title, inputComponent: TreeInputComponent_1.default, options: options }), (options.documentType
+        ? { type: (0, injectNodeTypeInPatches_1.getSchemaTypeName)(options.documentType, 'array') }
+        : __assign(__assign({}, createHierarchicalArrayType(options)), { name: name })));
+}
+exports.createHierarchicalField = createHierarchicalField;
+function createHierarchicalDocType(options) {
+    return {
+        name: options.documentType,
+        title: 'Hierarchical tree',
+        type: 'document',
+        // The plugin needs to define a `schemaType` with liveEdit enabled so that
+        // `useDocumentOperation` in TreeDeskStructure.tsx doesn't create drafts at every patch.
+        liveEdit: true,
+        fields: [
+            createHierarchicalField({
+                name: options.fieldKeyInDocument || TreeDeskStructure_1.DEFAULT_FIELD_KEY,
+                title: 'Hierarchical Tree',
+                options: options
+            })
+        ],
+        preview: {
+            select: {
+                id: '_id',
+                tree: 'tree'
+            },
+            prepare: function (_a) {
+                var id = _a.id, tree = _a.tree;
+                return {
+                    title: "Hierarchical documents (ID: ".concat(id, ")"),
+                    subtitle: "".concat((tree === null || tree === void 0 ? void 0 : tree.length) || 0, " document(s) in its list.")
+                };
+            }
+        }
+    };
+}
+function createHierarchicalSchemas(options) {
+    if (!Array.isArray(options.referenceTo) || options.referenceTo.length <= 0) {
+        (0, throwError_1.default)('invalidReferenceTo');
+    }
+    if (!options.documentType) {
+        (0, throwError_1.default)('invalidDocumentType');
+    }
+    return [
+        createHierarchicalDocType(options),
+        createHierarchicalArrayType(options),
+        createHierarchicalNodeType(options),
+        createHierarchicalNodeValueType(options)
+    ];
+}
+exports.default = createHierarchicalSchemas;