@sanity/hierarchical-document-list 1.0.0 → 1.1.0

package/lib/createHierarchicalSchemas.d.ts

@@ -1,78 +1,98 @@
-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 {};
+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;
+    })[];
+} | {
+    name: string | undefined;
+    title: string;
+    type: string;
+    liveEdit: boolean;
+    fields: (Omit<ArraySchemaType<unknown>, "type" | "of" | "jsonType"> & {
+        type: string;
+        inputComponent: React.FC<any>;
+        of?: any[] | undefined;
+    })[];
+    preview: {
+        select: {
+            id: string;
+            tree: string;
+        };
+        prepare({ id, tree }: {
+            id: string;
+            tree: unknown[];
+        }): Record<string, string>;
+    };
+})[];
+export {};

package/lib/createHierarchicalSchemas.js

@@ -1,138 +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;
+"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;

package/lib/hooks/useAllItems.d.ts

@@ -1,7 +1,7 @@
-import { AllItems, TreeInputOptions } from '../types';
-declare type Status = 'loading' | 'success' | 'error';
-export default function useAllItems(options: TreeInputOptions): {
-    status: Status;
-    allItems: AllItems;
-};
-export {};
+import { AllItems, TreeInputOptions } from '../types';
+declare type Status = 'loading' | 'success' | 'error';
+export default function useAllItems(options: TreeInputOptions): {
+    status: Status;
+    allItems: AllItems;
+};
+export {};