@sanity/hierarchical-document-list 0.1.0 → 1.1.0

package/lib/utils/getAdjescentNodes.js

@@ -1,16 +1,19 @@
-/**
- * Gets adjescent non-children nodes of a given treeIndex.
- */
-export default function getAdjescentNodes(_a) {
-    var flatTree = _a.flatTree, node = _a.node, treeIndex = _a.treeIndex;
-    var leadingNode = flatTree
-        .slice(0, treeIndex)
-        .reverse()
-        // Disregard children nodes - these include the current node's key in their `path` array
-        .find(function (item) { return !item.path.includes(node._key); });
-    var followingNode = flatTree.slice(treeIndex + 1).find(function (item) { return !item.path.includes(node._key); });
-    return {
-        leadingNode: leadingNode,
-        followingNode: followingNode
-    };
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Gets adjescent non-children nodes of a given treeIndex.
+ */
+function getAdjescentNodes(_a) {
+    var flatTree = _a.flatTree, node = _a.node, treeIndex = _a.treeIndex;
+    var leadingNode = flatTree
+        .slice(0, treeIndex)
+        .reverse()
+        // Disregard children nodes - these include the current node's key in their `path` array
+        .find(function (item) { return !item.path.includes(node._key); });
+    var followingNode = flatTree.slice(treeIndex + 1).find(function (item) { return !item.path.includes(node._key); });
+    return {
+        leadingNode: leadingNode,
+        followingNode: followingNode
+    };
+}
+exports.default = getAdjescentNodes;

package/lib/utils/getCommonTreeProps.d.ts

@@ -1,7 +1,7 @@
-import { ReactSortableTreeProps } from 'react-sortable-tree';
-export default function getCommonTreeProps({ placeholder }: {
-    placeholder: {
-        title: string;
-        subtitle?: string;
-    };
-}): Partial<ReactSortableTreeProps>;
+import { ReactSortableTreeProps } from 'react-sortable-tree';
+export default function getCommonTreeProps({ placeholder }: {
+    placeholder: {
+        title: string;
+        subtitle?: string;
+    };
+}): Partial<ReactSortableTreeProps>;

package/lib/utils/getCommonTreeProps.js

@@ -1,27 +1,33 @@
-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);
-};
-import { jsx as _jsx } from "react/jsx-runtime";
-import NodeContentRenderer from '../components/NodeContentRenderer';
-import PlaceholderDropzone from '../components/PlaceholderDropzone';
-import TreeNodeRenderer from '../components/TreeNodeRenderer';
-import { ROW_HEIGHT } from './getTreeHeight';
-export default function getCommonTreeProps(_a) {
-    var placeholder = _a.placeholder;
-    return {
-        theme: {
-            nodeContentRenderer: NodeContentRenderer,
-            placeholderRenderer: function (props) { return _jsx(PlaceholderDropzone, __assign({}, placeholder, props), void 0); },
-            treeNodeRenderer: TreeNodeRenderer,
-            rowHeight: ROW_HEIGHT
-        }
-    };
-}
+"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 NodeContentRenderer_1 = __importDefault(require("../components/NodeContentRenderer"));
+var PlaceholderDropzone_1 = __importDefault(require("../components/PlaceholderDropzone"));
+var TreeNodeRenderer_1 = __importDefault(require("../components/TreeNodeRenderer"));
+var getTreeHeight_1 = require("./getTreeHeight");
+function getCommonTreeProps(_a) {
+    var placeholder = _a.placeholder;
+    return {
+        theme: {
+            nodeContentRenderer: NodeContentRenderer_1.default,
+            placeholderRenderer: function (props) { return (0, jsx_runtime_1.jsx)(PlaceholderDropzone_1.default, __assign({}, placeholder, props), void 0); },
+            treeNodeRenderer: TreeNodeRenderer_1.default,
+            rowHeight: getTreeHeight_1.ROW_HEIGHT
+        }
+    };
+}
+exports.default = getCommonTreeProps;

package/lib/utils/getTreeHeight.d.ts

@@ -1,3 +1,3 @@
-import { TreeItem } from 'react-sortable-tree';
-export declare const ROW_HEIGHT = 51;
-export default function getTreeHeight(treeData: TreeItem[]): string;
+import { TreeItem } from 'react-sortable-tree';
+export declare const ROW_HEIGHT = 51;
+export default function getTreeHeight(treeData: TreeItem[]): string;

package/lib/utils/getTreeHeight.js

@@ -1,7 +1,11 @@
-import { getVisibleNodeCount } from 'react-sortable-tree';
-export var ROW_HEIGHT = 51;
-export default function getTreeHeight(treeData) {
-    var visibleNodeCount = getVisibleNodeCount({ treeData: treeData });
-    // prettier-ignore
-    return "".concat(50 + (ROW_HEIGHT * visibleNodeCount), "px");
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROW_HEIGHT = void 0;
+var react_sortable_tree_1 = require("react-sortable-tree");
+exports.ROW_HEIGHT = 51;
+function getTreeHeight(treeData) {
+    var visibleNodeCount = (0, react_sortable_tree_1.getVisibleNodeCount)({ treeData: treeData });
+    // prettier-ignore
+    return "".concat(50 + (exports.ROW_HEIGHT * visibleNodeCount), "px");
+}
+exports.default = getTreeHeight;

package/lib/utils/gradientPatchAdapter.d.ts

@@ -1,4 +1,4 @@
-declare type Patch = Record<string, any>;
-declare type GradientPatch = Record<string, any>;
-export declare function toGradient(patches: Patch[]): GradientPatch[];
-export {};
+declare type Patch = Record<string, any>;
+declare type GradientPatch = Record<string, any>;
+export declare function toGradient(patches: Patch[]): GradientPatch[];
+export {};

package/lib/utils/gradientPatchAdapter.js

@@ -1,35 +1,40 @@
-// Adapted from @sanity/form-builder/src/sanity/utils/gradientPatchAdapter.ts
-import assert from 'assert';
-import { arrayToJSONMatchPath } from '@sanity/mutator';
-export function toGradient(patches) {
-    return patches.map(toGradientPatch);
-}
-function toGradientPatch(patch) {
-    var _a, _b, _c, _d;
-    var matchPath = arrayToJSONMatchPath(patch.path || []);
-    if (patch.type === 'insert') {
-        var position = patch.position, items = patch.items;
-        return {
-            insert: (_a = {},
-                _a[position] = matchPath,
-                _a.items = items,
-                _a)
-        };
-    }
-    if (patch.type === 'unset') {
-        return {
-            unset: [matchPath]
-        };
-    }
-    assert(patch.type, "Missing patch type in patch ".concat(JSON.stringify(patch)));
-    if (matchPath) {
-        return _b = {},
-            _b[patch.type] = (_c = {},
-                _c[matchPath] = patch.value,
-                _c),
-            _b;
-    }
-    return _d = {},
-        _d[patch.type] = patch.value,
-        _d;
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toGradient = void 0;
+// Adapted from @sanity/form-builder/src/sanity/utils/gradientPatchAdapter.ts
+var mutator_1 = require("@sanity/mutator");
+function toGradient(patches) {
+    return patches.map(toGradientPatch);
+}
+exports.toGradient = toGradient;
+function toGradientPatch(patch) {
+    var _a, _b, _c, _d;
+    var matchPath = (0, mutator_1.arrayToJSONMatchPath)(patch.path || []);
+    if (patch.type === 'insert') {
+        var position = patch.position, items = patch.items;
+        return {
+            insert: (_a = {},
+                _a[position] = matchPath,
+                _a.items = items,
+                _a)
+        };
+    }
+    if (patch.type === 'unset') {
+        return {
+            unset: [matchPath]
+        };
+    }
+    if (!patch.type) {
+        throw new Error("Missing patch type in patch ".concat(JSON.stringify(patch)));
+    }
+    if (matchPath) {
+        return _b = {},
+            _b[patch.type] = (_c = {},
+                _c[matchPath] = patch.value,
+                _c),
+            _b;
+    }
+    return _d = {},
+        _d[patch.type] = patch.value,
+        _d;
+}

package/lib/utils/idUtils.d.ts

@@ -1,2 +1,2 @@
-export declare function unprefixId(_id?: string): string;
-export declare function isDraft(_id?: string): boolean;
+export declare function unprefixId(_id?: string): string;
+export declare function isDraft(_id?: string): boolean;

package/lib/utils/idUtils.js

@@ -1,8 +1,13 @@
-export function unprefixId(_id) {
-    if (_id === void 0) { _id = ''; }
-    return _id.replace('drafts.', '');
-}
-export function isDraft(_id) {
-    if (_id === void 0) { _id = ''; }
-    return _id.startsWith('drafts.');
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDraft = exports.unprefixId = void 0;
+function unprefixId(_id) {
+    if (_id === void 0) { _id = ''; }
+    return _id.replace('drafts.', '');
+}
+exports.unprefixId = unprefixId;
+function isDraft(_id) {
+    if (_id === void 0) { _id = ''; }
+    return _id.startsWith('drafts.');
+}
+exports.isDraft = isDraft;

package/lib/utils/injectNodeTypeInPatches.d.ts

@@ -0,0 +1,12 @@
+export declare function getSchemaTypeName(documentType: string, type: 'document' | 'node' | 'nodeValue' | 'array'): string;
+/**
+ * Temporary value of nodes' `_type` before they are normalized and persisted as the user-defined choice.
+ */
+export declare const DEFAULT_DOC_TYPE = "hierarchy.tree";
+export declare const INTERNAL_NODE_TYPE: string;
+export declare const INTERNAL_NODE_VALUE_TYPE: string;
+export declare const INTERNAL_NODE_ARRAY_TYPE: string;
+/**
+ * Barebones recursive utility to inject the desired nodeObjectType in patches generated in deeply nested components and utilities.
+ */
+export default function injectNodeTypeInPatches(patchData: any, documentType: string): any;

package/lib/utils/injectNodeTypeInPatches.js

@@ -0,0 +1,59 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.INTERNAL_NODE_ARRAY_TYPE = exports.INTERNAL_NODE_VALUE_TYPE = exports.INTERNAL_NODE_TYPE = exports.DEFAULT_DOC_TYPE = exports.getSchemaTypeName = void 0;
+function getSchemaTypeName(documentType, type) {
+    switch (type) {
+        case 'document':
+            return documentType;
+        case 'array':
+            return "".concat(documentType, ".array");
+        case 'node':
+            return "".concat(documentType, ".node");
+        case 'nodeValue':
+            return "".concat(documentType, ".nodeValue");
+        default:
+            return documentType;
+    }
+}
+exports.getSchemaTypeName = getSchemaTypeName;
+/**
+ * Temporary value of nodes' `_type` before they are normalized and persisted as the user-defined choice.
+ */
+exports.DEFAULT_DOC_TYPE = 'hierarchy.tree';
+exports.INTERNAL_NODE_TYPE = getSchemaTypeName(exports.DEFAULT_DOC_TYPE, 'node');
+exports.INTERNAL_NODE_VALUE_TYPE = getSchemaTypeName(exports.DEFAULT_DOC_TYPE, 'nodeValue');
+exports.INTERNAL_NODE_ARRAY_TYPE = getSchemaTypeName(exports.DEFAULT_DOC_TYPE, 'array');
+/**
+ * Barebones recursive utility to inject the desired nodeObjectType in patches generated in deeply nested components and utilities.
+ */
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+function injectNodeTypeInPatches(patchData, documentType) {
+    if (Array.isArray(patchData)) {
+        return patchData.map(function (child) { return injectNodeTypeInPatches(child, documentType); });
+    }
+    if (typeof patchData === 'object' && patchData !== null) {
+        return Object.keys(patchData).reduce(function (newObject, key) {
+            var _a, _b;
+            var value = patchData[key];
+            if (key === '_type' &&
+                typeof value === 'string' &&
+                [exports.INTERNAL_NODE_TYPE, exports.INTERNAL_NODE_VALUE_TYPE].includes(value)) {
+                return __assign(__assign({}, newObject), (_a = {}, _a[key] = getSchemaTypeName(documentType, value === exports.INTERNAL_NODE_TYPE ? 'node' : 'nodeValue'), _a));
+            }
+            return __assign(__assign({}, newObject), (_b = {}, _b[key] = injectNodeTypeInPatches(value, documentType), _b));
+        }, {});
+    }
+    return patchData;
+}
+exports.default = injectNodeTypeInPatches;

package/lib/utils/moveItemInArray.d.ts

@@ -1,5 +1,5 @@
-export default function moveItemInArray<ItemType = unknown>({ array, fromIndex, toIndex }: {
-    array: ItemType[];
-    fromIndex: number;
-    toIndex: number;
-}): ItemType[];
+export default function moveItemInArray<ItemType = unknown>({ array, fromIndex, toIndex }: {
+    array: ItemType[];
+    fromIndex: number;
+    toIndex: number;
+}): ItemType[];

package/lib/utils/moveItemInArray.js

@@ -1,23 +1,26 @@
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
-export default function moveItemInArray(_a) {
-    var array = _a.array, fromIndex = _a.fromIndex, toIndex = _a.toIndex;
-    if (fromIndex === toIndex) {
-        return array;
-    }
-    var newArray = __spreadArray([], array, true);
-    var target = newArray[fromIndex];
-    var inc = toIndex < fromIndex ? -1 : 1;
-    for (var i = fromIndex; i !== toIndex; i += inc) {
-        newArray[i] = newArray[i + inc];
-    }
-    newArray[toIndex] = target;
-    return newArray;
-}
+"use strict";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+function moveItemInArray(_a) {
+    var array = _a.array, fromIndex = _a.fromIndex, toIndex = _a.toIndex;
+    if (fromIndex === toIndex) {
+        return array;
+    }
+    var newArray = __spreadArray([], array, true);
+    var target = newArray[fromIndex];
+    var inc = toIndex < fromIndex ? -1 : 1;
+    for (var i = fromIndex; i !== toIndex; i += inc) {
+        newArray[i] = newArray[i + inc];
+    }
+    newArray[toIndex] = target;
+    return newArray;
+}
+exports.default = moveItemInArray;

package/lib/utils/throwError.d.ts

@@ -0,0 +1,7 @@
+declare const ERROR_MESSAGES: {
+    invalidDocumentId: string;
+    invalidDocumentType: string;
+    invalidReferenceTo: string;
+};
+export default function throwError(message: keyof typeof ERROR_MESSAGES, extraContext?: string): void;
+export {};

package/lib/utils/throwError.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var ERROR_MESSAGES = {
+    invalidDocumentId: 'Please add a documentId to your tree',
+    invalidDocumentType: 'Please add a valid documentType to createHierarchicalSchemas',
+    invalidReferenceTo: "Missing valid 'referenceTo' value"
+};
+function throwError(message, extraContext) {
+    if (extraContext === void 0) { extraContext = ''; }
+    throw new Error("[hierarchical input] ".concat(ERROR_MESSAGES[message], " ").concat(extraContext));
+}
+exports.default = throwError;

package/lib/utils/treeData.d.ts

@@ -1,18 +1,18 @@
-import { SanityDocument } from '@sanity/client';
-import { TreeItem } from 'react-sortable-tree';
-import { AllItems, EnhancedTreeItem, LocalTreeItem, StoredTreeItem, VisibilityMap } from '../types';
-export declare const dataToEditorTree: ({ tree, allItems, visibilityMap }: {
-    tree: StoredTreeItem[];
-    allItems: AllItems;
-    visibilityMap: VisibilityMap;
-}) => LocalTreeItem[];
-export declare const flatTree: (tree: TreeItem[]) => TreeItem[];
-export interface FetchData {
-    mainTree?: LocalTreeItem[];
-    allItems?: SanityDocument[];
-}
-export declare const getUnaddedItems: (data: {
-    allItems: AllItems;
-    tree: StoredTreeItem[];
-}) => EnhancedTreeItem[];
-export declare function normalizeNodeForStorage(item: LocalTreeItem): StoredTreeItem;
+import { SanityDocument } from '@sanity/client';
+import { TreeItem } from 'react-sortable-tree';
+import { AllItems, EnhancedTreeItem, LocalTreeItem, StoredTreeItem, VisibilityMap } from '../types';
+export declare const dataToEditorTree: ({ tree, allItems, visibilityMap }: {
+    tree: StoredTreeItem[];
+    allItems: AllItems;
+    visibilityMap: VisibilityMap;
+}) => LocalTreeItem[];
+export declare const flatTree: (tree: TreeItem[]) => TreeItem[];
+export interface FetchData {
+    mainTree?: LocalTreeItem[];
+    allItems?: SanityDocument[];
+}
+export declare const getUnaddedItems: (data: {
+    allItems: AllItems;
+    tree: StoredTreeItem[];
+}) => EnhancedTreeItem[];
+export declare function normalizeNodeForStorage(item: LocalTreeItem): StoredTreeItem;