@elliemae/ds-tree-model 3.32.0-rc.4 → 3.32.0-rc.6

package/dist/cjs/adapters/arraish-tree/react-desc-prop-types.js

@@ -0,0 +1,74 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var react_desc_prop_types_exports = {};
+__export(react_desc_prop_types_exports, {
+  UseArraishAsDSTreePropTypes: () => UseArraishAsDSTreePropTypes,
+  UseArraishAsDSTreeReturnType: () => UseArraishAsDSTreeReturnType
+});
+module.exports = __toCommonJS(react_desc_prop_types_exports);
+var React = __toESM(require("react"));
+var import_ds_props_helpers = require("@elliemae/ds-props-helpers");
+const itemShape = {
+  id: import_ds_props_helpers.PropTypes.oneOfType([import_ds_props_helpers.PropTypes.string, import_ds_props_helpers.PropTypes.number]).description("Id of the root item."),
+  idPart1: import_ds_props_helpers.PropTypes.oneOfType([import_ds_props_helpers.PropTypes.string, import_ds_props_helpers.PropTypes.number]).description("Part 1 of the item's compound id."),
+  idPart2: import_ds_props_helpers.PropTypes.oneOfType([import_ds_props_helpers.PropTypes.string, import_ds_props_helpers.PropTypes.number]).description("Part 2 of the item's compund id."),
+  name: import_ds_props_helpers.PropTypes.string.description("Item name."),
+  isGroup: import_ds_props_helpers.PropTypes.bool.description("Whether the item is a group or not")
+};
+const UseArraishAsDSTreePropTypes = {
+  treeData: import_ds_props_helpers.PropTypes.shape({
+    ...itemShape,
+    children_key: import_ds_props_helpers.PropTypes.arrayOf(import_ds_props_helpers.PropTypes.shape(itemShape)).description(
+      "Custom key of the subitems. Must start with the prefix 'children'."
+    )
+  }).description("First parameter.").isRequired,
+  opts: import_ds_props_helpers.PropTypes.shape({
+    getUniqueId: import_ds_props_helpers.PropTypes.func.signature("(node: FirstParameter) => string").description("Callback to get the id of each item.").isRequired,
+    getChildrenKey: import_ds_props_helpers.PropTypes.func.signature("(node: FirstParameter) => keyof FirstParameter").description("Callback to get the item's children key.").isRequired
+  }).description("Second parameter.").isRequired
+};
+const UseArraishAsDSTreeReturnType = {
+  hash: import_ds_props_helpers.PropTypes.number.description("Tree hash value."),
+  tree: import_ds_props_helpers.PropTypes.object.description("Returns the tree"),
+  getRoot: import_ds_props_helpers.PropTypes.func.signature("() => FirstParameter").description("Callback to get the root item."),
+  getNode: import_ds_props_helpers.PropTypes.func.signature("(id: string | number) => FirstParameter").description("Callback to get an item by id."),
+  walk: import_ds_props_helpers.PropTypes.func.signature("(callback: (node: FirstParameter) => boolean) => void").description("Callback applied to each item to determine whether to continue walking or not."),
+  walkParents: import_ds_props_helpers.PropTypes.func.signature("(callback: (node: FirstParameter) => boolean) => void").description("Callback applied to each item to determine whether to continue walking the item's parents or not."),
+  findNode: import_ds_props_helpers.PropTypes.func.signature("(callback: (node: FirstParameter) => boolean) => FirstParameter | null").description("Callback to find an item that matches the condition."),
+  findAllNodes: import_ds_props_helpers.PropTypes.func.signature("(callback: (node: FirstParameter) => boolean) => FirstParameter[]").description("Callback to find all the items that matches the condition."),
+  flatten: import_ds_props_helpers.PropTypes.func.signature("() => FirstParameter[]").description("Returns an array of hte tree items."),
+  addNode: import_ds_props_helpers.PropTypes.func.signature("(item: FirstParameter, options?: AddOptions<FirstParameter>) => FirstParameter").description("Adds an item to the tree."),
+  removeNode: import_ds_props_helpers.PropTypes.func.signature("(id: string, options?: RemoveOptions<FirstParameter>) => FirstParameter").description("Removes an item from the tree."),
+  moveNode: import_ds_props_helpers.PropTypes.func.signature("(id: string, options?: MoveOptions<FirstParameter>) => FirstParameter").description("Move an item within the tree."),
+  replaceNode: import_ds_props_helpers.PropTypes.func.signature("(id: string, item: FirstParameter, options?: MutateOptions<FirstParameter>").description("Replace a noe within the tree."),
+  getPath: import_ds_props_helpers.PropTypes.func.signature("(id: string | number) => FirstParameter[]").description("Get the path to an item given the item's id."),
+  getPathIds: import_ds_props_helpers.PropTypes.func.signature("(id: string | number) => (string | number)[]").description("Get the path ids to an item given the item's id."),
+  getRestoredTree: import_ds_props_helpers.PropTypes.func.signature("() => FirstParameter[]").description("Returns the restored tree.")
+};
+//# sourceMappingURL=react-desc-prop-types.js.map

package/dist/cjs/adapters/arraish-tree/react-desc-prop-types.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/adapters/arraish-tree/react-desc-prop-types.ts", "../../../../../../../scripts/build/transpile/react-shim.js"],
+  "sourcesContent": ["import type { AddOptions, MoveOptions, MutateOptions, OverloadedItem, RemoveOptions } from '../../types.js';\nimport type { Node } from '../../Node.js';\nimport type { DSTree } from '../../DSTree.js';\nimport type { WeakValidationMap } from 'react';\nimport { PropTypes } from '@elliemae/ds-props-helpers';\n\nexport declare namespace UseArraishAsDSTreeT {\n  // First Parameter\n  export interface FirstParameterRequired {}\n  export interface FirstParameterDefault {\n    id: string | number;\n    idPart1: string | number;\n    idPart2: string | number;\n    name: string;\n    [children_key: `children${string}`]: FirstParameter[];\n  }\n  export interface FirstParameterOptional {\n    isGroup?: boolean;\n  }\n  export interface FirstParameter\n    extends Partial<FirstParameterDefault>,\n      FirstParameterOptional,\n      FirstParameterRequired {}\n  export interface FirstParameterInternals\n    extends FirstParameterDefault,\n      FirstParameterOptional,\n      FirstParameterRequired {}\n\n  // Second Parameter\n  export interface SecondParameterRequired {\n    getUniqueId: (node: FirstParameter) => string;\n    getChildrenKey: (node: FirstParameter) => keyof FirstParameter;\n  }\n  export interface SecondParameterDefault {}\n  export interface SecondParameterOptional {}\n  export interface SecondParameter\n    extends Partial<SecondParameterDefault>,\n      SecondParameterOptional,\n      SecondParameterRequired {}\n  export interface SecondParameterInternals\n    extends SecondParameterDefault,\n      SecondParameterOptional,\n      SecondParameterRequired {}\n\n  export interface OutputT {\n    hash: number;\n    tree: DSTree<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>;\n    getRoot: () => Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>;\n    getNode: (id: string | number) => Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>;\n    walk: (callback: (node: Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>) => boolean) => void;\n    walkParents: (callback: (node: Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>) => boolean) => void;\n    findNode: (\n      callback: (node: Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>) => boolean,\n    ) => Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>> | null;\n    findAllNodes: (\n      callback: (node: Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>) => boolean,\n    ) => Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>[];\n    flatten: () => Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>[];\n    addNode: (\n      item: OverloadedItem<UseArraishAsDSTreeT.FirstParameter>,\n      options?: AddOptions<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>,\n    ) => Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>;\n    removeNode: (\n      id: string,\n      options?: RemoveOptions<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>,\n    ) => Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>;\n    moveNode: (\n      id: string,\n      options?: MoveOptions<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>,\n    ) => Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>;\n    replaceNode: (\n      id: string,\n      item: OverloadedItem<UseArraishAsDSTreeT.FirstParameter>,\n      options?: MutateOptions<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>,\n    ) => Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>;\n    getPath: (id: string | number) => Node<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>[];\n    getPathIds: (id: string | number) => (string | number)[];\n    getRestoredTree: () => UseArraishAsDSTreeT.FirstParameter[];\n  }\n}\n\nconst itemShape = {\n  id: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).description('Id of the root item.'),\n  idPart1: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).description(\"Part 1 of the item's compound id.\"),\n  idPart2: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).description(\"Part 2 of the item's compund id.\"),\n  name: PropTypes.string.description('Item name.'),\n  isGroup: PropTypes.bool.description('Whether the item is a group or not'),\n};\n\nexport const UseArraishAsDSTreePropTypes = {\n  treeData: PropTypes.shape({\n    ...itemShape,\n    children_key: PropTypes.arrayOf(PropTypes.shape(itemShape)).description(\n      \"Custom key of the subitems. Must start with the prefix 'children'.\",\n    ),\n  }).description('First parameter.').isRequired,\n  opts: PropTypes.shape({\n    getUniqueId: PropTypes.func\n      .signature('(node: FirstParameter) => string')\n      .description('Callback to get the id of each item.').isRequired,\n    getChildrenKey: PropTypes.func\n      .signature('(node: FirstParameter) => keyof FirstParameter')\n      .description(\"Callback to get the item's children key.\").isRequired,\n  }).description('Second parameter.').isRequired,\n} as unknown as WeakValidationMap<Array<UseArraishAsDSTreeT.FirstParameter>>;\n\nexport const UseArraishAsDSTreeReturnType = {\n  hash: PropTypes.number.description('Tree hash value.'),\n  tree: PropTypes.object.description('Returns the tree'),\n  getRoot: PropTypes.func.signature('() => FirstParameter').description('Callback to get the root item.'),\n  getNode: PropTypes.func\n    .signature('(id: string | number) => FirstParameter')\n    .description('Callback to get an item by id.'),\n  walk: PropTypes.func\n    .signature('(callback: (node: FirstParameter) => boolean) => void')\n    .description('Callback applied to each item to determine whether to continue walking or not.'),\n  walkParents: PropTypes.func\n    .signature('(callback: (node: FirstParameter) => boolean) => void')\n    .description(\"Callback applied to each item to determine whether to continue walking the item's parents or not.\"),\n  findNode: PropTypes.func\n    .signature('(callback: (node: FirstParameter) => boolean) => FirstParameter | null')\n    .description('Callback to find an item that matches the condition.'),\n  findAllNodes: PropTypes.func\n    .signature('(callback: (node: FirstParameter) => boolean) => FirstParameter[]')\n    .description('Callback to find all the items that matches the condition.'),\n  flatten: PropTypes.func.signature('() => FirstParameter[]').description('Returns an array of hte tree items.'),\n  addNode: PropTypes.func\n    .signature('(item: FirstParameter, options?: AddOptions<FirstParameter>) => FirstParameter')\n    .description('Adds an item to the tree.'),\n  removeNode: PropTypes.func\n    .signature('(id: string, options?: RemoveOptions<FirstParameter>) => FirstParameter')\n    .description('Removes an item from the tree.'),\n  moveNode: PropTypes.func\n    .signature('(id: string, options?: MoveOptions<FirstParameter>) => FirstParameter')\n    .description('Move an item within the tree.'),\n  replaceNode: PropTypes.func\n    .signature('(id: string, item: FirstParameter, options?: MutateOptions<FirstParameter>')\n    .description('Replace a noe within the tree.'),\n  getPath: PropTypes.func\n    .signature('(id: string | number) => FirstParameter[]')\n    .description(\"Get the path to an item given the item's id.\"),\n  getPathIds: PropTypes.func\n    .signature('(id: string | number) => (string | number)[]')\n    .description(\"Get the path ids to an item given the item's id.\"),\n  getRestoredTree: PropTypes.func.signature('() => FirstParameter[]').description('Returns the restored tree.'),\n} as WeakValidationMap<unknown>;\n", "import * as React from 'react';\nexport { React };\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADIvB,8BAA0B;AA6E1B,MAAM,YAAY;AAAA,EAChB,IAAI,kCAAU,UAAU,CAAC,kCAAU,QAAQ,kCAAU,MAAM,CAAC,EAAE,YAAY,sBAAsB;AAAA,EAChG,SAAS,kCAAU,UAAU,CAAC,kCAAU,QAAQ,kCAAU,MAAM,CAAC,EAAE,YAAY,mCAAmC;AAAA,EAClH,SAAS,kCAAU,UAAU,CAAC,kCAAU,QAAQ,kCAAU,MAAM,CAAC,EAAE,YAAY,kCAAkC;AAAA,EACjH,MAAM,kCAAU,OAAO,YAAY,YAAY;AAAA,EAC/C,SAAS,kCAAU,KAAK,YAAY,oCAAoC;AAC1E;AAEO,MAAM,8BAA8B;AAAA,EACzC,UAAU,kCAAU,MAAM;AAAA,IACxB,GAAG;AAAA,IACH,cAAc,kCAAU,QAAQ,kCAAU,MAAM,SAAS,CAAC,EAAE;AAAA,MAC1D;AAAA,IACF;AAAA,EACF,CAAC,EAAE,YAAY,kBAAkB,EAAE;AAAA,EACnC,MAAM,kCAAU,MAAM;AAAA,IACpB,aAAa,kCAAU,KACpB,UAAU,kCAAkC,EAC5C,YAAY,sCAAsC,EAAE;AAAA,IACvD,gBAAgB,kCAAU,KACvB,UAAU,gDAAgD,EAC1D,YAAY,0CAA0C,EAAE;AAAA,EAC7D,CAAC,EAAE,YAAY,mBAAmB,EAAE;AACtC;AAEO,MAAM,+BAA+B;AAAA,EAC1C,MAAM,kCAAU,OAAO,YAAY,kBAAkB;AAAA,EACrD,MAAM,kCAAU,OAAO,YAAY,kBAAkB;AAAA,EACrD,SAAS,kCAAU,KAAK,UAAU,sBAAsB,EAAE,YAAY,gCAAgC;AAAA,EACtG,SAAS,kCAAU,KAChB,UAAU,yCAAyC,EACnD,YAAY,gCAAgC;AAAA,EAC/C,MAAM,kCAAU,KACb,UAAU,uDAAuD,EACjE,YAAY,gFAAgF;AAAA,EAC/F,aAAa,kCAAU,KACpB,UAAU,uDAAuD,EACjE,YAAY,mGAAmG;AAAA,EAClH,UAAU,kCAAU,KACjB,UAAU,wEAAwE,EAClF,YAAY,sDAAsD;AAAA,EACrE,cAAc,kCAAU,KACrB,UAAU,mEAAmE,EAC7E,YAAY,4DAA4D;AAAA,EAC3E,SAAS,kCAAU,KAAK,UAAU,wBAAwB,EAAE,YAAY,qCAAqC;AAAA,EAC7G,SAAS,kCAAU,KAChB,UAAU,gFAAgF,EAC1F,YAAY,2BAA2B;AAAA,EAC1C,YAAY,kCAAU,KACnB,UAAU,yEAAyE,EACnF,YAAY,gCAAgC;AAAA,EAC/C,UAAU,kCAAU,KACjB,UAAU,uEAAuE,EACjF,YAAY,+BAA+B;AAAA,EAC9C,aAAa,kCAAU,KACpB,UAAU,4EAA4E,EACtF,YAAY,gCAAgC;AAAA,EAC/C,SAAS,kCAAU,KAChB,UAAU,2CAA2C,EACrD,YAAY,8CAA8C;AAAA,EAC7D,YAAY,kCAAU,KACnB,UAAU,8CAA8C,EACxD,YAAY,kDAAkD;AAAA,EACjE,iBAAiB,kCAAU,KAAK,UAAU,wBAAwB,EAAE,YAAY,4BAA4B;AAC9G;",
+  "names": []
+}

package/dist/cjs/adapters/arraish-tree/useArraishAsDSTree.js

@@ -28,6 +28,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var useArraishAsDSTree_exports = {};
 __export(useArraishAsDSTree_exports, {
+  UseArraishAsDSTreeWithSchema: () => UseArraishAsDSTreeWithSchema,
   useArraishAsDSTree: () => useArraishAsDSTree
 });
 module.exports = __toCommonJS(useArraishAsDSTree_exports);
@@ -35,6 +36,8 @@ var React = __toESM(require("react"));
 var import_react = require("react");
 var import_fromDSTreeToTreeishArray = require("./fromDSTreeToTreeishArray.js");
 var import_fromTreeishArrayToDSTree = require("./fromTreeishArrayToDSTree.js");
+var import_react_desc_prop_types = require("./react-desc-prop-types.js");
+var import_ds_props_helpers = require("@elliemae/ds-props-helpers");
 const useArraishAsDSTree = (treeData, opts) => {
   const tree = (0, import_react.useMemo)(
     () => (0, import_fromTreeishArrayToDSTree.fromTreeishArrayToDSTree)({
@@ -113,4 +116,8 @@ const useArraishAsDSTree = (treeData, opts) => {
     [addNode, getRestoredTree, hash, moveNode, removeNode, replaceNode, tree]
   );
 };
+useArraishAsDSTree.displayName = "useArraishAsDSTree";
+const UseArraishAsDSTreeWithSchema = (0, import_ds_props_helpers.describe)(useArraishAsDSTree);
+UseArraishAsDSTreeWithSchema.propTypes = import_react_desc_prop_types.UseArraishAsDSTreePropTypes;
+UseArraishAsDSTreeWithSchema.returnType = import_react_desc_prop_types.UseArraishAsDSTreeReturnType;
 //# sourceMappingURL=useArraishAsDSTree.js.map

package/dist/cjs/adapters/arraish-tree/useArraishAsDSTree.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../../src/adapters/arraish-tree/useArraishAsDSTree.ts", "../../../../../../../scripts/build/transpile/react-shim.js"],
-  "sourcesContent": ["import { useCallback, useMemo, useState } from 'react';\nimport { fromDSTreeToTreeishArray } from './fromDSTreeToTreeishArray.js';\nimport { fromTreeishArrayToDSTree } from './fromTreeishArrayToDSTree.js';\nimport type { AddOptions, MoveOptions, MutateOptions, RemoveOptions, OverloadedItem } from '../../types.js';\n\nexport const useArraishAsDSTree = <T extends object = object>(\n  treeData: T[],\n  opts: {\n    getChildrenKey: (node: T) => keyof T;\n    getUniqueId: (node: T) => string;\n  },\n) => {\n  const tree = useMemo(\n    () =>\n      fromTreeishArrayToDSTree<T>({\n        treeish: treeData,\n        opts,\n      }),\n    [opts, treeData],\n  );\n  const [hash, setHash] = useState(tree.hash);\n\n  const addNode = useCallback(\n    (item: OverloadedItem<T>, options?: AddOptions<OverloadedItem<T>>) => {\n      const cb: AddOptions<OverloadedItem<T>>['callback'] = (node, treecb) => {\n        options?.callback?.(node, treecb);\n        setHash(treecb.hash);\n      };\n      return tree.addNode(item, { ...options, callback: cb });\n    },\n    [tree],\n  );\n\n  const removeNode = useCallback(\n    (id: string, options?: RemoveOptions<OverloadedItem<T>>) => {\n      const cb: RemoveOptions<OverloadedItem<T>>['callback'] = (node, treecb) => {\n        options?.callback?.(node, treecb);\n        setHash(treecb.hash);\n      };\n      return tree.removeNode(id, { ...options, callback: cb });\n    },\n    [tree],\n  );\n\n  const moveNode = useCallback(\n    (id: string, options?: MoveOptions<OverloadedItem<T>>) => {\n      const cb: MoveOptions<OverloadedItem<T>>['callback'] = (node, treecb) => {\n        options?.callback?.(node, treecb);\n        setHash(treecb.hash);\n      };\n      return tree.moveNode(id, { ...options, callback: cb });\n    },\n    [tree],\n  );\n\n  const replaceNode = useCallback(\n    (id: string, item: OverloadedItem<T>, options?: MutateOptions<OverloadedItem<T>>) => {\n      const cb: MutateOptions<OverloadedItem<T>>['callback'] = (node, treecb) => {\n        options?.callback?.(node, treecb);\n        setHash(treecb.hash);\n      };\n      return tree.replaceNode(id, item, { ...options, callback: cb });\n    },\n    [tree],\n  );\n\n  const getRestoredTree = useCallback(\n    () =>\n      fromDSTreeToTreeishArray({\n        tree,\n        opts,\n      }),\n    [opts, tree],\n  );\n\n  return useMemo(\n    () => ({\n      hash,\n      tree,\n      getRoot: tree.getRoot,\n      getNode: tree.getNode,\n      walk: tree.walk,\n      walkParents: tree.walkParents,\n      findNode: tree.findNode,\n      findAllNodes: tree.findAllNodes,\n      flatten: tree.flatten,\n      addNode,\n      removeNode,\n      moveNode,\n      replaceNode,\n      getPath: tree.getPath,\n      getPathIds: tree.getPathIds,\n      getRestoredTree,\n    }),\n    [addNode, getRestoredTree, hash, moveNode, removeNode, replaceNode, tree],\n  );\n};\n", "import * as React from 'react';\nexport { React };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADAvB,mBAA+C;AAC/C,sCAAyC;AACzC,sCAAyC;AAGlC,MAAM,qBAAqB,CAChC,UACA,SAIG;AACH,QAAM,WAAO;AAAA,IACX,UACE,0DAA4B;AAAA,MAC1B,SAAS;AAAA,MACT;AAAA,IACF,CAAC;AAAA,IACH,CAAC,MAAM,QAAQ;AAAA,EACjB;AACA,QAAM,CAAC,MAAM,OAAO,QAAI,uBAAS,KAAK,IAAI;AAE1C,QAAM,cAAU;AAAA,IACd,CAAC,MAAyB,YAA4C;AACpE,YAAM,KAAgD,CAAC,MAAM,WAAW;AACtE,iBAAS,WAAW,MAAM,MAAM;AAChC,gBAAQ,OAAO,IAAI;AAAA,MACrB;AACA,aAAO,KAAK,QAAQ,MAAM,EAAE,GAAG,SAAS,UAAU,GAAG,CAAC;AAAA,IACxD;AAAA,IACA,CAAC,IAAI;AAAA,EACP;AAEA,QAAM,iBAAa;AAAA,IACjB,CAAC,IAAY,YAA+C;AAC1D,YAAM,KAAmD,CAAC,MAAM,WAAW;AACzE,iBAAS,WAAW,MAAM,MAAM;AAChC,gBAAQ,OAAO,IAAI;AAAA,MACrB;AACA,aAAO,KAAK,WAAW,IAAI,EAAE,GAAG,SAAS,UAAU,GAAG,CAAC;AAAA,IACzD;AAAA,IACA,CAAC,IAAI;AAAA,EACP;AAEA,QAAM,eAAW;AAAA,IACf,CAAC,IAAY,YAA6C;AACxD,YAAM,KAAiD,CAAC,MAAM,WAAW;AACvE,iBAAS,WAAW,MAAM,MAAM;AAChC,gBAAQ,OAAO,IAAI;AAAA,MACrB;AACA,aAAO,KAAK,SAAS,IAAI,EAAE,GAAG,SAAS,UAAU,GAAG,CAAC;AAAA,IACvD;AAAA,IACA,CAAC,IAAI;AAAA,EACP;AAEA,QAAM,kBAAc;AAAA,IAClB,CAAC,IAAY,MAAyB,YAA+C;AACnF,YAAM,KAAmD,CAAC,MAAM,WAAW;AACzE,iBAAS,WAAW,MAAM,MAAM;AAChC,gBAAQ,OAAO,IAAI;AAAA,MACrB;AACA,aAAO,KAAK,YAAY,IAAI,MAAM,EAAE,GAAG,SAAS,UAAU,GAAG,CAAC;AAAA,IAChE;AAAA,IACA,CAAC,IAAI;AAAA,EACP;AAEA,QAAM,sBAAkB;AAAA,IACtB,UACE,0DAAyB;AAAA,MACvB;AAAA,MACA;AAAA,IACF,CAAC;AAAA,IACH,CAAC,MAAM,IAAI;AAAA,EACb;AAEA,aAAO;AAAA,IACL,OAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,SAAS,KAAK;AAAA,MACd,SAAS,KAAK;AAAA,MACd,MAAM,KAAK;AAAA,MACX,aAAa,KAAK;AAAA,MAClB,UAAU,KAAK;AAAA,MACf,cAAc,KAAK;AAAA,MACnB,SAAS,KAAK;AAAA,MACd;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS,KAAK;AAAA,MACd,YAAY,KAAK;AAAA,MACjB;AAAA,IACF;AAAA,IACA,CAAC,SAAS,iBAAiB,MAAM,UAAU,YAAY,aAAa,IAAI;AAAA,EAC1E;AACF;",
+  "sourcesContent": ["import { useCallback, useMemo, useState } from 'react';\nimport { fromDSTreeToTreeishArray } from './fromDSTreeToTreeishArray.js';\nimport { fromTreeishArrayToDSTree } from './fromTreeishArrayToDSTree.js';\nimport type { AddOptions, MoveOptions, MutateOptions, RemoveOptions, OverloadedItem } from '../../types.js';\nimport {\n  UseArraishAsDSTreePropTypes,\n  UseArraishAsDSTreeReturnType,\n  type UseArraishAsDSTreeT,\n} from './react-desc-prop-types.js';\nimport { describe } from '@elliemae/ds-props-helpers';\n\nexport const useArraishAsDSTree: ((\n  treeData: UseArraishAsDSTreeT.FirstParameter[],\n  opts: UseArraishAsDSTreeT.SecondParameter,\n) => UseArraishAsDSTreeT.OutputT) & { displayName: string } = (treeData, opts) => {\n  const tree = useMemo(\n    () =>\n      fromTreeishArrayToDSTree<UseArraishAsDSTreeT.FirstParameter>({\n        treeish: treeData,\n        opts,\n      }),\n    [opts, treeData],\n  );\n  const [hash, setHash] = useState(tree.hash);\n\n  const addNode = useCallback(\n    (\n      item: OverloadedItem<UseArraishAsDSTreeT.FirstParameter>,\n      options?: AddOptions<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>,\n    ) => {\n      const cb: AddOptions<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>['callback'] = (node, treecb) => {\n        options?.callback?.(node, treecb);\n        setHash(treecb.hash);\n      };\n      return tree.addNode(item, { ...options, callback: cb });\n    },\n    [tree],\n  );\n\n  const removeNode = useCallback(\n    (id: string, options?: RemoveOptions<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>) => {\n      const cb: RemoveOptions<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>['callback'] = (node, treecb) => {\n        options?.callback?.(node, treecb);\n        setHash(treecb.hash);\n      };\n      return tree.removeNode(id, { ...options, callback: cb });\n    },\n    [tree],\n  );\n\n  const moveNode = useCallback(\n    (id: string, options?: MoveOptions<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>) => {\n      const cb: MoveOptions<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>['callback'] = (node, treecb) => {\n        options?.callback?.(node, treecb);\n        setHash(treecb.hash);\n      };\n      return tree.moveNode(id, { ...options, callback: cb });\n    },\n    [tree],\n  );\n\n  const replaceNode = useCallback(\n    (\n      id: string,\n      item: OverloadedItem<UseArraishAsDSTreeT.FirstParameter>,\n      options?: MutateOptions<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>,\n    ) => {\n      const cb: MutateOptions<OverloadedItem<UseArraishAsDSTreeT.FirstParameter>>['callback'] = (node, treecb) => {\n        options?.callback?.(node, treecb);\n        setHash(treecb.hash);\n      };\n      return tree.replaceNode(id, item, { ...options, callback: cb });\n    },\n    [tree],\n  );\n\n  const getRestoredTree = useCallback(\n    () =>\n      fromDSTreeToTreeishArray({\n        tree,\n        opts,\n      }),\n    [opts, tree],\n  );\n\n  return useMemo(\n    () => ({\n      hash,\n      tree,\n      getRoot: tree.getRoot,\n      getNode: tree.getNode,\n      walk: tree.walk,\n      walkParents: tree.walkParents,\n      findNode: tree.findNode,\n      findAllNodes: tree.findAllNodes,\n      flatten: tree.flatten,\n      addNode,\n      removeNode,\n      moveNode,\n      replaceNode,\n      getPath: tree.getPath,\n      getPathIds: tree.getPathIds,\n      getRestoredTree,\n    }),\n    [addNode, getRestoredTree, hash, moveNode, removeNode, replaceNode, tree],\n  );\n};\n\nuseArraishAsDSTree.displayName = 'useArraishAsDSTree';\nexport const UseArraishAsDSTreeWithSchema = describe(useArraishAsDSTree);\nUseArraishAsDSTreeWithSchema.propTypes = UseArraishAsDSTreePropTypes;\nUseArraishAsDSTreeWithSchema.returnType = UseArraishAsDSTreeReturnType;\n", "import * as React from 'react';\nexport { React };\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADAvB,mBAA+C;AAC/C,sCAAyC;AACzC,sCAAyC;AAEzC,mCAIO;AACP,8BAAyB;AAElB,MAAM,qBAGiD,CAAC,UAAU,SAAS;AAChF,QAAM,WAAO;AAAA,IACX,UACE,0DAA6D;AAAA,MAC3D,SAAS;AAAA,MACT;AAAA,IACF,CAAC;AAAA,IACH,CAAC,MAAM,QAAQ;AAAA,EACjB;AACA,QAAM,CAAC,MAAM,OAAO,QAAI,uBAAS,KAAK,IAAI;AAE1C,QAAM,cAAU;AAAA,IACd,CACE,MACA,YACG;AACH,YAAM,KAAiF,CAAC,MAAM,WAAW;AACvG,iBAAS,WAAW,MAAM,MAAM;AAChC,gBAAQ,OAAO,IAAI;AAAA,MACrB;AACA,aAAO,KAAK,QAAQ,MAAM,EAAE,GAAG,SAAS,UAAU,GAAG,CAAC;AAAA,IACxD;AAAA,IACA,CAAC,IAAI;AAAA,EACP;AAEA,QAAM,iBAAa;AAAA,IACjB,CAAC,IAAY,YAAgF;AAC3F,YAAM,KAAoF,CAAC,MAAM,WAAW;AAC1G,iBAAS,WAAW,MAAM,MAAM;AAChC,gBAAQ,OAAO,IAAI;AAAA,MACrB;AACA,aAAO,KAAK,WAAW,IAAI,EAAE,GAAG,SAAS,UAAU,GAAG,CAAC;AAAA,IACzD;AAAA,IACA,CAAC,IAAI;AAAA,EACP;AAEA,QAAM,eAAW;AAAA,IACf,CAAC,IAAY,YAA8E;AACzF,YAAM,KAAkF,CAAC,MAAM,WAAW;AACxG,iBAAS,WAAW,MAAM,MAAM;AAChC,gBAAQ,OAAO,IAAI;AAAA,MACrB;AACA,aAAO,KAAK,SAAS,IAAI,EAAE,GAAG,SAAS,UAAU,GAAG,CAAC;AAAA,IACvD;AAAA,IACA,CAAC,IAAI;AAAA,EACP;AAEA,QAAM,kBAAc;AAAA,IAClB,CACE,IACA,MACA,YACG;AACH,YAAM,KAAoF,CAAC,MAAM,WAAW;AAC1G,iBAAS,WAAW,MAAM,MAAM;AAChC,gBAAQ,OAAO,IAAI;AAAA,MACrB;AACA,aAAO,KAAK,YAAY,IAAI,MAAM,EAAE,GAAG,SAAS,UAAU,GAAG,CAAC;AAAA,IAChE;AAAA,IACA,CAAC,IAAI;AAAA,EACP;AAEA,QAAM,sBAAkB;AAAA,IACtB,UACE,0DAAyB;AAAA,MACvB;AAAA,MACA;AAAA,IACF,CAAC;AAAA,IACH,CAAC,MAAM,IAAI;AAAA,EACb;AAEA,aAAO;AAAA,IACL,OAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,SAAS,KAAK;AAAA,MACd,SAAS,KAAK;AAAA,MACd,MAAM,KAAK;AAAA,MACX,aAAa,KAAK;AAAA,MAClB,UAAU,KAAK;AAAA,MACf,cAAc,KAAK;AAAA,MACnB,SAAS,KAAK;AAAA,MACd;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS,KAAK;AAAA,MACd,YAAY,KAAK;AAAA,MACjB;AAAA,IACF;AAAA,IACA,CAAC,SAAS,iBAAiB,MAAM,UAAU,YAAY,aAAa,IAAI;AAAA,EAC1E;AACF;AAEA,mBAAmB,cAAc;AAC1B,MAAM,mCAA+B,kCAAS,kBAAkB;AACvE,6BAA6B,YAAY;AACzC,6BAA6B,aAAa;",
   "names": []
 }

package/dist/cjs/adapters/treeview/useTreeviewAsDSTree.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../../src/adapters/treeview/useTreeviewAsDSTree.ts", "../../../../../../../scripts/build/transpile/react-shim.js"],
-  "sourcesContent": ["import { useMemo } from 'react';\nimport { useArraishAsDSTree } from '../arraish-tree/useArraishAsDSTree.js';\n\ntype TreeviewItem<T extends object = object> = T & {\n  id: string | number;\n  children?: TreeviewItem[];\n};\n\nexport const useTreeviewAsDSTree = <T extends TreeviewItem<object> = TreeviewItem<object>>(treeData: T[]) => {\n  const opts = useMemo(\n    () => ({\n      getChildrenKey: () => 'children',\n      getUniqueId: (node: T) => `${node.id}`,\n    }),\n    [],\n  );\n  return useArraishAsDSTree(treeData, opts);\n};\n", "import * as React from 'react';\nexport { React };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADAvB,mBAAwB;AACxB,gCAAmC;AAO5B,MAAM,sBAAsB,CAAwD,aAAkB;AAC3G,QAAM,WAAO;AAAA,IACX,OAAO;AAAA,MACL,gBAAgB,MAAM;AAAA,MACtB,aAAa,CAAC,SAAY,GAAG,KAAK;AAAA,IACpC;AAAA,IACA,CAAC;AAAA,EACH;AACA,aAAO,8CAAmB,UAAU,IAAI;AAC1C;",
+  "sourcesContent": ["import { useMemo } from 'react';\nimport { useArraishAsDSTree } from '../arraish-tree/useArraishAsDSTree.js';\nimport type { UseArraishAsDSTreeT } from '../arraish-tree/react-desc-prop-types.js';\n\ntype TreeviewItem<T extends object = object> = T & {\n  id: string | number;\n  children?: TreeviewItem[];\n};\n\nexport const useTreeviewAsDSTree = <\n  T extends TreeviewItem<UseArraishAsDSTreeT.FirstParameter> = TreeviewItem<UseArraishAsDSTreeT.FirstParameter>,\n>(\n  treeData: T[],\n) => {\n  const opts = useMemo(\n    () => ({\n      getChildrenKey: () => 'children',\n      getUniqueId: (node: UseArraishAsDSTreeT.FirstParameter) => `${node.id}`,\n    }),\n    [],\n  );\n  return useArraishAsDSTree(treeData, opts);\n};\n", "import * as React from 'react';\nexport { React };\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADAvB,mBAAwB;AACxB,gCAAmC;AAQ5B,MAAM,sBAAsB,CAGjC,aACG;AACH,QAAM,WAAO;AAAA,IACX,OAAO;AAAA,MACL,gBAAgB,MAAM;AAAA,MACtB,aAAa,CAAC,SAA6C,GAAG,KAAK;AAAA,IACrE;AAAA,IACA,CAAC;AAAA,EACH;AACA,aAAO,8CAAmB,UAAU,IAAI;AAC1C;",
   "names": []
 }

package/dist/cjs/index.js

@@ -29,6 +29,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   DSTree: () => import_DSTree.DSTree,
+  UseArraishAsDSTreeWithSchema: () => import_useArraishAsDSTree.UseArraishAsDSTreeWithSchema,
+  UseDSTreeWithSchema: () => import_useDSTree.UseDSTreeWithSchema,
   fromDSTreeToTreeishArray: () => import_fromDSTreeToTreeishArray.fromDSTreeToTreeishArray,
   fromTreeishArrayToDSTree: () => import_fromTreeishArrayToDSTree.fromTreeishArrayToDSTree,
   useArraishAsDSTree: () => import_useArraishAsDSTree.useArraishAsDSTree,

package/dist/cjs/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/index.ts", "../../../../../scripts/build/transpile/react-shim.js"],
-  "sourcesContent": ["export type { Item } from './types.js';\nexport type { Node } from './Node.js';\nexport { DSTree } from './DSTree.js';\nexport { useDSTree } from './useDSTree.js';\nexport { fromTreeishArrayToDSTree } from './adapters/arraish-tree/fromTreeishArrayToDSTree.js';\nexport { fromDSTreeToTreeishArray } from './adapters/arraish-tree/fromDSTreeToTreeishArray.js';\nexport { useArraishAsDSTree } from './adapters/arraish-tree/useArraishAsDSTree.js';\nexport { useTreeviewAsDSTree } from './adapters/treeview/useTreeviewAsDSTree.js';\n", "import * as React from 'react';\nexport { React };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADEvB,oBAAuB;AACvB,uBAA0B;AAC1B,sCAAyC;AACzC,sCAAyC;AACzC,gCAAmC;AACnC,iCAAoC;",
+  "sourcesContent": ["export type { Item } from './types.js';\nexport type { Node } from './Node.js';\nexport { DSTree } from './DSTree.js';\nexport { useDSTree, UseDSTreeWithSchema } from './useDSTree.js';\nexport type { UseDSTreeT } from './react-desc-prop-types.js';\nexport { fromTreeishArrayToDSTree } from './adapters/arraish-tree/fromTreeishArrayToDSTree.js';\nexport { fromDSTreeToTreeishArray } from './adapters/arraish-tree/fromDSTreeToTreeishArray.js';\nexport { useArraishAsDSTree, UseArraishAsDSTreeWithSchema } from './adapters/arraish-tree/useArraishAsDSTree.js';\nexport type { UseArraishAsDSTreeT } from './adapters/arraish-tree/react-desc-prop-types.js';\nexport { useTreeviewAsDSTree } from './adapters/treeview/useTreeviewAsDSTree.js';\n", "import * as React from 'react';\nexport { React };\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADEvB,oBAAuB;AACvB,uBAA+C;AAE/C,sCAAyC;AACzC,sCAAyC;AACzC,gCAAiE;AAEjE,iCAAoC;",
   "names": []
 }

package/dist/cjs/react-desc-prop-types.js

@@ -0,0 +1,71 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var react_desc_prop_types_exports = {};
+__export(react_desc_prop_types_exports, {
+  UseDSTreePropTypes: () => UseDSTreePropTypes,
+  UseDSTreeReturnType: () => UseDSTreeReturnType
+});
+module.exports = __toCommonJS(react_desc_prop_types_exports);
+var React = __toESM(require("react"));
+var import_ds_props_helpers = require("@elliemae/ds-props-helpers");
+const itemShape = {
+  dsId: import_ds_props_helpers.PropTypes.oneOfType([import_ds_props_helpers.PropTypes.string, import_ds_props_helpers.PropTypes.number]).description("Id of the root item."),
+  label: import_ds_props_helpers.PropTypes.string.description("Item label."),
+  "[key]": import_ds_props_helpers.PropTypes.string.description("Any custom key you want to add to the item.")
+};
+const UseDSTreePropTypes = {
+  rootItem: import_ds_props_helpers.PropTypes.shape({
+    ...itemShape,
+    subitems: import_ds_props_helpers.PropTypes.arrayOf(import_ds_props_helpers.PropTypes.shape(itemShape)).description(
+      "Array of subitems. Each subitem can also have subitems."
+    )
+  }).description("First parameter.").isRequired,
+  opts: import_ds_props_helpers.PropTypes.shape({
+    getUniqueId: import_ds_props_helpers.PropTypes.func.signature("(item) => string | number").description("Callback to get the id of each item.").isRequired
+  }).description("Second parameter.").isRequired
+};
+const UseDSTreeReturnType = {
+  hash: import_ds_props_helpers.PropTypes.number.description("Tree hash value."),
+  getRoot: import_ds_props_helpers.PropTypes.func.signature("() => rootItem").description("Callback to get the root item."),
+  getNode: import_ds_props_helpers.PropTypes.func.signature("(id: string | number) => item").description("Callback to get an item by id."),
+  walk: import_ds_props_helpers.PropTypes.func.signature("(callback: (item: FirstParameter) => boolean) => void").description("Callback applied to each item to determine whether to continue walking or not."),
+  walkParents: import_ds_props_helpers.PropTypes.func.signature("(callback: (item: FirstParameter) => boolean) => void").description("Callback applied to each item to determine whether to continue walking the item's parents or not."),
+  findNode: import_ds_props_helpers.PropTypes.func.signature("(callback: (item: FirstParameter) => boolean) => FirstParameter | null").description("Callback to find an item that matches the condition."),
+  findAllNodes: import_ds_props_helpers.PropTypes.func.signature("(callback: (item: FirstParameter) => boolean) => FirstParameter[]").description("Callback to find all the items that matches the condition."),
+  flatten: import_ds_props_helpers.PropTypes.func.signature("() => item[]").description("Returns an array of hte tree items."),
+  addNode: import_ds_props_helpers.PropTypes.func.signature("(item: FirstParameter, options?: AddOptions<FirstParameter> | undefined) => FirstParameter").description("Adds an item to the tree."),
+  removeNode: import_ds_props_helpers.PropTypes.func.signature("(id: string, options?: RemoveOptions<FirstParameter> | undefined) => FirstParameter").description("Removes an item from the tree."),
+  moveNode: import_ds_props_helpers.PropTypes.func.signature("(id: string, options?: MoveOptions<FirstParameter> | undefined) => FirstParameter").description("Move an item within the tree."),
+  replaceNode: import_ds_props_helpers.PropTypes.func.signature(
+    "id: string, item: FirstParameter, options?: MutateOptions<FirstParameter> | undefined) => FirstParameter"
+  ).description("Replace a noe within the tree."),
+  getPath: import_ds_props_helpers.PropTypes.func.signature("(id: string | number) => FirstParameter[]").description("Get the path to an item given the item's id."),
+  getPathIds: import_ds_props_helpers.PropTypes.func.signature("(id: string | number) => (string | number)[]").description("Get the path ids to an item given the item's id.")
+};
+//# sourceMappingURL=react-desc-prop-types.js.map

package/dist/cjs/react-desc-prop-types.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/react-desc-prop-types.ts", "../../../../../scripts/build/transpile/react-shim.js"],
+  "sourcesContent": ["import type { AddOptions, MoveOptions, MutateOptions, RemoveOptions } from './types.js';\nimport type { Node } from './Node.js';\nimport type { WeakValidationMap } from 'react';\nimport { PropTypes } from '@elliemae/ds-props-helpers';\n\nexport declare namespace UseDSTreeT {\n  // First Parameter\n  export interface FirstParameterRequired {\n    dsId: string | number;\n  }\n  export interface FirstParameterDefault {\n    label: string;\n    [key: string]: unknown;\n  }\n  export interface FirstParameterOptional {\n    subitems?: FirstParameter[];\n  }\n  export interface FirstParameter\n    extends Partial<FirstParameterDefault>,\n      FirstParameterOptional,\n      FirstParameterRequired {}\n  export interface FirstParameterInternals\n    extends FirstParameterDefault,\n      FirstParameterOptional,\n      FirstParameterRequired {}\n\n  // Second Parameter\n  export interface SecondParameterRequired {\n    getUniqueId: (item: FirstParameter) => string | number;\n  }\n  export interface SecondParameterDefault {}\n  export interface SecondParameterOptional {}\n  export interface SecondParameter\n    extends Partial<SecondParameterDefault>,\n      SecondParameterOptional,\n      SecondParameterRequired {}\n  export interface SecondParameterInternals\n    extends SecondParameterDefault,\n      SecondParameterOptional,\n      SecondParameterRequired {}\n\n  export interface OutputT {\n    hash: number;\n    getRoot: () => Node<FirstParameter>;\n    getNode: (id: string | number) => Node<FirstParameter>;\n    walk: (callback: (node: Node<FirstParameter>) => boolean) => void;\n    walkParents: (callback: (node: Node<FirstParameter>) => boolean) => void;\n    findNode: (callback: (node: Node<FirstParameter>) => boolean) => Node<FirstParameter> | null;\n    findAllNodes: (callback: (node: Node<FirstParameter>) => boolean) => Node<FirstParameter>[];\n    flatten: () => Node<FirstParameter>[];\n    addNode: (item: FirstParameter, options?: AddOptions<FirstParameter> | undefined) => Node<FirstParameter>;\n    removeNode: (id: string, options?: RemoveOptions<FirstParameter> | undefined) => Node<FirstParameter>;\n    moveNode: (id: string, options?: MoveOptions<FirstParameter> | undefined) => Node<FirstParameter>;\n    replaceNode: (\n      id: string,\n      item: FirstParameter,\n      options?: MutateOptions<FirstParameter> | undefined,\n    ) => Node<FirstParameter>;\n    getPath: (id: string | number) => Node<FirstParameter>[];\n    getPathIds: (id: string | number) => (string | number)[];\n  }\n}\n\nconst itemShape = {\n  dsId: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).description('Id of the root item.'),\n  label: PropTypes.string.description('Item label.'),\n  '[key]': PropTypes.string.description('Any custom key you want to add to the item.'),\n};\n\nexport const UseDSTreePropTypes = {\n  rootItem: PropTypes.shape({\n    ...itemShape,\n    subitems: PropTypes.arrayOf(PropTypes.shape(itemShape)).description(\n      'Array of subitems. Each subitem can also have subitems.',\n    ),\n  }).description('First parameter.').isRequired,\n  opts: PropTypes.shape({\n    getUniqueId: PropTypes.func\n      .signature('(item) => string | number')\n      .description('Callback to get the id of each item.').isRequired,\n  }).description('Second parameter.').isRequired,\n} as WeakValidationMap<unknown>;\n\nexport const UseDSTreeReturnType = {\n  hash: PropTypes.number.description('Tree hash value.'),\n  getRoot: PropTypes.func.signature('() => rootItem').description('Callback to get the root item.'),\n  getNode: PropTypes.func.signature('(id: string | number) => item').description('Callback to get an item by id.'),\n  walk: PropTypes.func\n    .signature('(callback: (item: FirstParameter) => boolean) => void')\n    .description('Callback applied to each item to determine whether to continue walking or not.'),\n  walkParents: PropTypes.func\n    .signature('(callback: (item: FirstParameter) => boolean) => void')\n    .description(\"Callback applied to each item to determine whether to continue walking the item's parents or not.\"),\n  findNode: PropTypes.func\n    .signature('(callback: (item: FirstParameter) => boolean) => FirstParameter | null')\n    .description('Callback to find an item that matches the condition.'),\n  findAllNodes: PropTypes.func\n    .signature('(callback: (item: FirstParameter) => boolean) => FirstParameter[]')\n    .description('Callback to find all the items that matches the condition.'),\n  flatten: PropTypes.func.signature('() => item[]').description('Returns an array of hte tree items.'),\n  addNode: PropTypes.func\n    .signature('(item: FirstParameter, options?: AddOptions<FirstParameter> | undefined) => FirstParameter')\n    .description('Adds an item to the tree.'),\n  removeNode: PropTypes.func\n    .signature('(id: string, options?: RemoveOptions<FirstParameter> | undefined) => FirstParameter')\n    .description('Removes an item from the tree.'),\n  moveNode: PropTypes.func\n    .signature('(id: string, options?: MoveOptions<FirstParameter> | undefined) => FirstParameter')\n    .description('Move an item within the tree.'),\n  replaceNode: PropTypes.func\n    .signature(\n      'id: string, item: FirstParameter, options?: MutateOptions<FirstParameter> | undefined) => FirstParameter',\n    )\n    .description('Replace a noe within the tree.'),\n  getPath: PropTypes.func\n    .signature('(id: string | number) => FirstParameter[]')\n    .description(\"Get the path to an item given the item's id.\"),\n  getPathIds: PropTypes.func\n    .signature('(id: string | number) => (string | number)[]')\n    .description(\"Get the path ids to an item given the item's id.\"),\n} as WeakValidationMap<unknown>;\n", "import * as React from 'react';\nexport { React };\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADGvB,8BAA0B;AA4D1B,MAAM,YAAY;AAAA,EAChB,MAAM,kCAAU,UAAU,CAAC,kCAAU,QAAQ,kCAAU,MAAM,CAAC,EAAE,YAAY,sBAAsB;AAAA,EAClG,OAAO,kCAAU,OAAO,YAAY,aAAa;AAAA,EACjD,SAAS,kCAAU,OAAO,YAAY,6CAA6C;AACrF;AAEO,MAAM,qBAAqB;AAAA,EAChC,UAAU,kCAAU,MAAM;AAAA,IACxB,GAAG;AAAA,IACH,UAAU,kCAAU,QAAQ,kCAAU,MAAM,SAAS,CAAC,EAAE;AAAA,MACtD;AAAA,IACF;AAAA,EACF,CAAC,EAAE,YAAY,kBAAkB,EAAE;AAAA,EACnC,MAAM,kCAAU,MAAM;AAAA,IACpB,aAAa,kCAAU,KACpB,UAAU,2BAA2B,EACrC,YAAY,sCAAsC,EAAE;AAAA,EACzD,CAAC,EAAE,YAAY,mBAAmB,EAAE;AACtC;AAEO,MAAM,sBAAsB;AAAA,EACjC,MAAM,kCAAU,OAAO,YAAY,kBAAkB;AAAA,EACrD,SAAS,kCAAU,KAAK,UAAU,gBAAgB,EAAE,YAAY,gCAAgC;AAAA,EAChG,SAAS,kCAAU,KAAK,UAAU,+BAA+B,EAAE,YAAY,gCAAgC;AAAA,EAC/G,MAAM,kCAAU,KACb,UAAU,uDAAuD,EACjE,YAAY,gFAAgF;AAAA,EAC/F,aAAa,kCAAU,KACpB,UAAU,uDAAuD,EACjE,YAAY,mGAAmG;AAAA,EAClH,UAAU,kCAAU,KACjB,UAAU,wEAAwE,EAClF,YAAY,sDAAsD;AAAA,EACrE,cAAc,kCAAU,KACrB,UAAU,mEAAmE,EAC7E,YAAY,4DAA4D;AAAA,EAC3E,SAAS,kCAAU,KAAK,UAAU,cAAc,EAAE,YAAY,qCAAqC;AAAA,EACnG,SAAS,kCAAU,KAChB,UAAU,4FAA4F,EACtG,YAAY,2BAA2B;AAAA,EAC1C,YAAY,kCAAU,KACnB,UAAU,qFAAqF,EAC/F,YAAY,gCAAgC;AAAA,EAC/C,UAAU,kCAAU,KACjB,UAAU,mFAAmF,EAC7F,YAAY,+BAA+B;AAAA,EAC9C,aAAa,kCAAU,KACpB;AAAA,IACC;AAAA,EACF,EACC,YAAY,gCAAgC;AAAA,EAC/C,SAAS,kCAAU,KAChB,UAAU,2CAA2C,EACrD,YAAY,8CAA8C;AAAA,EAC7D,YAAY,kCAAU,KACnB,UAAU,8CAA8C,EACxD,YAAY,kDAAkD;AACnE;",
+  "names": []
+}

package/dist/cjs/typescript-testing/typescript-use-arraish-as-ds-tree-valid.js

@@ -0,0 +1,144 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var React = __toESM(require("react"));
+var import_jsx_runtime = require("react/jsx-runtime");
+var import_useArraishAsDSTree = require("../adapters/arraish-tree/useArraishAsDSTree.js");
+const testRequiredPropsFirstParameter = {};
+const testRequiredPropsSecondParameter = {
+  getUniqueId: (item) => item.id,
+  getChildrenKey: (item) => `children${item.id}`
+};
+const testOptionalPropsFirstParameter = {
+  isGroup: true
+};
+const testOptionalPropsSecondParameter = {};
+const testPartialDefaultsFirstParameter = {
+  idPart1: "aa",
+  idPart2: "bb"
+};
+const testPropsFirstParameter = {
+  ...testRequiredPropsFirstParameter,
+  ...testOptionalPropsFirstParameter,
+  ...testPartialDefaultsFirstParameter
+};
+const testPropsAsSyntaxFirstParameter = {
+  ...testRequiredPropsFirstParameter,
+  ...testOptionalPropsFirstParameter,
+  ...testPartialDefaultsFirstParameter
+};
+const testPartialDefaultsSecondParameter = {};
+const testPropsSecondParameter = {
+  ...testRequiredPropsSecondParameter,
+  ...testOptionalPropsSecondParameter,
+  ...testPartialDefaultsSecondParameter
+};
+const testPropsAsSyntaxSecondParameter = {
+  ...testRequiredPropsSecondParameter,
+  ...testOptionalPropsSecondParameter,
+  ...testPartialDefaultsSecondParameter
+};
+const testCompleteDefaultsFirstParameter = {
+  id: "root",
+  idPart1: "root_1",
+  idPart2: "root_2",
+  name: ""
+};
+const testInternalPropsFirstParameter = {
+  ...testRequiredPropsFirstParameter,
+  ...testOptionalPropsFirstParameter,
+  ...testCompleteDefaultsFirstParameter
+};
+const testInternalPropsAsSyntaxFirstParameter = {
+  ...testRequiredPropsFirstParameter,
+  ...testOptionalPropsFirstParameter,
+  ...testCompleteDefaultsFirstParameter
+};
+const testCompleteDefaultsSecondParameter = {};
+const testInternalPropsSecondParameter = {
+  ...testRequiredPropsSecondParameter,
+  ...testOptionalPropsSecondParameter,
+  ...testCompleteDefaultsSecondParameter
+};
+const testInternalPropsAsSyntaxSecondParameter = {
+  ...testRequiredPropsSecondParameter,
+  ...testOptionalPropsSecondParameter,
+  ...testCompleteDefaultsSecondParameter
+};
+const testExplicitDefinitionFirstParameter = {
+  id: "root",
+  idPart1: "root_1",
+  idPart2: "root_2",
+  name: "",
+  isGroup: false
+};
+const testExplicitDefinitionSecondParameter = {
+  getUniqueId: (item) => item.id,
+  getChildrenKey: (item) => `children${item.id}`
+};
+const testInferedTypeCompatibilityFirstParameter = {
+  id: "root",
+  idPart1: "root_1",
+  idPart2: "root_2",
+  name: "",
+  isGroup: false
+};
+const testInferedTypeCompatibilitySecondParameter = {
+  getUniqueId: (item) => item.id,
+  getChildrenKey: (item) => `children${item.id}`
+};
+const testDefinitionAsConstFirstParameter = {
+  id: "root",
+  idPart1: "root_1",
+  idPart2: "root_2",
+  name: "",
+  isGroup: false
+};
+const testDefinitionAsConstSecondParameter = {
+  getUniqueId: (item) => item.id,
+  getChildrenKey: (item) => `children${item.id}`
+};
+const ExampleUsageComponent = () => {
+  const {
+    addNode,
+    findAllNodes,
+    findNode,
+    flatten,
+    getNode,
+    getPath,
+    getPathIds,
+    getRoot,
+    hash,
+    moveNode,
+    removeNode,
+    replaceNode,
+    walk,
+    walkParents
+  } = (0, import_useArraishAsDSTree.useArraishAsDSTree)([testExplicitDefinitionFirstParameter], testExplicitDefinitionSecondParameter);
+  const output2 = (0, import_useArraishAsDSTree.useArraishAsDSTree)(
+    [testInferedTypeCompatibilityFirstParameter],
+    testInferedTypeCompatibilitySecondParameter
+  );
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_jsx_runtime.Fragment, {});
+};
+//# sourceMappingURL=typescript-use-arraish-as-ds-tree-valid.js.map

package/dist/cjs/typescript-testing/typescript-use-arraish-as-ds-tree-valid.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../../scripts/build/transpile/react-shim.js", "../../../src/typescript-testing/typescript-use-arraish-as-ds-tree-valid.tsx"],
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "/* eslint-disable @typescript-eslint/no-unused-vars, no-unused-vars */\nimport { useArraishAsDSTree } from '../adapters/arraish-tree/useArraishAsDSTree.js';\nimport type { UseArraishAsDSTreeT } from '../adapters/arraish-tree/react-desc-prop-types.js';\n\n// test we expose the namespace and the namespace follows our deliverable conventions\ntype FirstParameterForApp = UseArraishAsDSTreeT.FirstParameter;\ntype FirstParameterInternals = UseArraishAsDSTreeT.FirstParameterInternals;\ntype FirstParameterDefaultProps = UseArraishAsDSTreeT.FirstParameterDefault;\ntype FirstParameterOptionalProps = UseArraishAsDSTreeT.FirstParameterOptional;\ntype FirstParameterRequiredProps = UseArraishAsDSTreeT.FirstParameterRequired;\n\ntype SecondParameterForApp = UseArraishAsDSTreeT.SecondParameter;\ntype SecondParameterInternals = UseArraishAsDSTreeT.SecondParameterInternals;\ntype SecondParameterDefaultProps = UseArraishAsDSTreeT.SecondParameterDefault;\ntype SecondParameterOptionalProps = UseArraishAsDSTreeT.SecondParameterOptional;\ntype SecondParameterRequiredProps = UseArraishAsDSTreeT.SecondParameterRequired;\n\nconst testRequiredPropsFirstParameter: FirstParameterRequiredProps = {};\n\nconst testRequiredPropsSecondParameter: SecondParameterRequiredProps = {\n  getUniqueId: (item) => item.id as string,\n  getChildrenKey: (item) => `children${item.id}`,\n};\n\nconst testOptionalPropsFirstParameter: FirstParameterOptionalProps = {\n  isGroup: true,\n};\n\nconst testOptionalPropsSecondParameter: SecondParameterOptionalProps = {};\n\n// difference Props and InternalProps is that InternalProps has all the default props filled in\n// Props allows for partial defaults\nconst testPartialDefaultsFirstParameter: Partial<FirstParameterDefaultProps> = {\n  idPart1: 'aa',\n  idPart2: 'bb',\n};\n\nconst testPropsFirstParameter: FirstParameterForApp = {\n  ...testRequiredPropsFirstParameter,\n  ...testOptionalPropsFirstParameter,\n  ...testPartialDefaultsFirstParameter,\n};\n\nconst testPropsAsSyntaxFirstParameter = {\n  ...testRequiredPropsFirstParameter,\n  ...testOptionalPropsFirstParameter,\n  ...testPartialDefaultsFirstParameter,\n} as FirstParameterForApp;\n\nconst testPartialDefaultsSecondParameter: Partial<SecondParameterDefaultProps> = {};\n\nconst testPropsSecondParameter: SecondParameterForApp = {\n  ...testRequiredPropsSecondParameter,\n  ...testOptionalPropsSecondParameter,\n  ...testPartialDefaultsSecondParameter,\n};\n\nconst testPropsAsSyntaxSecondParameter = {\n  ...testRequiredPropsSecondParameter,\n  ...testOptionalPropsSecondParameter,\n  ...testPartialDefaultsSecondParameter,\n} as SecondParameterForApp;\n\n// InternalProps requires all defaults to be filled in\nconst testCompleteDefaultsFirstParameter: Required<FirstParameterDefaultProps> = {\n  id: 'root',\n  idPart1: 'root_1',\n  idPart2: 'root_2',\n  name: '',\n};\n\nconst testInternalPropsFirstParameter: FirstParameterInternals = {\n  ...testRequiredPropsFirstParameter,\n  ...testOptionalPropsFirstParameter,\n  ...testCompleteDefaultsFirstParameter,\n};\n\nconst testInternalPropsAsSyntaxFirstParameter = {\n  ...testRequiredPropsFirstParameter,\n  ...testOptionalPropsFirstParameter,\n  ...testCompleteDefaultsFirstParameter,\n} as FirstParameterInternals;\n\nconst testCompleteDefaultsSecondParameter: Required<SecondParameterDefaultProps> = {};\n\nconst testInternalPropsSecondParameter: SecondParameterInternals = {\n  ...testRequiredPropsSecondParameter,\n  ...testOptionalPropsSecondParameter,\n  ...testCompleteDefaultsSecondParameter,\n};\n\nconst testInternalPropsAsSyntaxSecondParameter = {\n  ...testRequiredPropsSecondParameter,\n  ...testOptionalPropsSecondParameter,\n  ...testCompleteDefaultsSecondParameter,\n} as SecondParameterInternals;\n\n// using the explicit type definition, if there is an error, it will be marked on the key that is wrong\nconst testExplicitDefinitionFirstParameter: FirstParameterForApp = {\n  id: 'root',\n  idPart1: 'root_1',\n  idPart2: 'root_2',\n  name: '',\n  isGroup: false,\n};\n\nconst testExplicitDefinitionSecondParameter: SecondParameterForApp = {\n  getUniqueId: (item) => item.id as string,\n  getChildrenKey: (item) => `children${item.id}`,\n};\n\n// using the \"as\" syntax, if there is an error, it will be marking the whole object as wrong because it is not compatible with the type\nconst testInferedTypeCompatibilityFirstParameter = {\n  id: 'root',\n  idPart1: 'root_1',\n  idPart2: 'root_2',\n  name: '',\n  isGroup: false,\n} as FirstParameterForApp;\n\nconst testInferedTypeCompatibilitySecondParameter = {\n  getUniqueId: (item) => item.id as string,\n  getChildrenKey: (item) => `children${item.id}`,\n} as SecondParameterForApp;\n\nconst testDefinitionAsConstFirstParameter = {\n  id: 'root',\n  idPart1: 'root_1',\n  idPart2: 'root_2',\n  name: '',\n  isGroup: false,\n} as const;\n\nconst testDefinitionAsConstSecondParameter = {\n  getUniqueId: (item: UseArraishAsDSTreeT.FirstParameter) => item.id as string,\n  getChildrenKey: (item: UseArraishAsDSTreeT.FirstParameter) => `children${item.id}`,\n} as const;\n\nconst ExampleUsageComponent = () => {\n  const {\n    addNode,\n    findAllNodes,\n    findNode,\n    flatten,\n    getNode,\n    getPath,\n    getPathIds,\n    getRoot,\n    hash,\n    moveNode,\n    removeNode,\n    replaceNode,\n    walk,\n    walkParents,\n  } = useArraishAsDSTree([testExplicitDefinitionFirstParameter], testExplicitDefinitionSecondParameter);\n\n  const output2 = useArraishAsDSTree(\n    [testInferedTypeCompatibilityFirstParameter],\n    testInferedTypeCompatibilitySecondParameter,\n  );\n\n  return <></>;\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAAA,YAAuB;ACiKd;AAhKT,gCAAmC;AAgBnC,MAAM,kCAA+D,CAAC;AAEtE,MAAM,mCAAiE;AAAA,EACrE,aAAa,CAAC,SAAS,KAAK;AAAA,EAC5B,gBAAgB,CAAC,SAAS,WAAW,KAAK;AAC5C;AAEA,MAAM,kCAA+D;AAAA,EACnE,SAAS;AACX;AAEA,MAAM,mCAAiE,CAAC;AAIxE,MAAM,oCAAyE;AAAA,EAC7E,SAAS;AAAA,EACT,SAAS;AACX;AAEA,MAAM,0BAAgD;AAAA,EACpD,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAEA,MAAM,kCAAkC;AAAA,EACtC,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAEA,MAAM,qCAA2E,CAAC;AAElF,MAAM,2BAAkD;AAAA,EACtD,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAEA,MAAM,mCAAmC;AAAA,EACvC,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAGA,MAAM,qCAA2E;AAAA,EAC/E,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,SAAS;AAAA,EACT,MAAM;AACR;AAEA,MAAM,kCAA2D;AAAA,EAC/D,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAEA,MAAM,0CAA0C;AAAA,EAC9C,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAEA,MAAM,sCAA6E,CAAC;AAEpF,MAAM,mCAA6D;AAAA,EACjE,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAEA,MAAM,2CAA2C;AAAA,EAC/C,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAGA,MAAM,uCAA6D;AAAA,EACjE,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,SAAS;AAAA,EACT,MAAM;AAAA,EACN,SAAS;AACX;AAEA,MAAM,wCAA+D;AAAA,EACnE,aAAa,CAAC,SAAS,KAAK;AAAA,EAC5B,gBAAgB,CAAC,SAAS,WAAW,KAAK;AAC5C;AAGA,MAAM,6CAA6C;AAAA,EACjD,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,SAAS;AAAA,EACT,MAAM;AAAA,EACN,SAAS;AACX;AAEA,MAAM,8CAA8C;AAAA,EAClD,aAAa,CAAC,SAAS,KAAK;AAAA,EAC5B,gBAAgB,CAAC,SAAS,WAAW,KAAK;AAC5C;AAEA,MAAM,sCAAsC;AAAA,EAC1C,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,SAAS;AAAA,EACT,MAAM;AAAA,EACN,SAAS;AACX;AAEA,MAAM,uCAAuC;AAAA,EAC3C,aAAa,CAAC,SAA6C,KAAK;AAAA,EAChE,gBAAgB,CAAC,SAA6C,WAAW,KAAK;AAChF;AAEA,MAAM,wBAAwB,MAAM;AAClC,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,QAAI,8CAAmB,CAAC,oCAAoC,GAAG,qCAAqC;AAEpG,QAAM,cAAU;AAAA,IACd,CAAC,0CAA0C;AAAA,IAC3C;AAAA,EACF;AAEA,SAAO,2EAAE;AACX;",
+  "names": []
+}

package/dist/cjs/typescript-testing/typescript-use-ds-tree-valid.js

@@ -0,0 +1,129 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var React = __toESM(require("react"));
+var import_jsx_runtime = require("react/jsx-runtime");
+var import__ = require("../index.js");
+const testRequiredPropsFirstParameter = {
+  dsId: ""
+};
+const testRequiredPropsSecondParameter = {
+  getUniqueId: (item) => item.dsId
+};
+const testOptionalPropsFirstParameter = {
+  subitems: [{ dsId: "_root", label: "root", subitems: [] }]
+};
+const testOptionalPropsSecondParameter = {};
+const testPartialDefaultsFirstParameter = {
+  label: "root"
+};
+const testPropsFirstParameter = {
+  ...testRequiredPropsFirstParameter,
+  ...testOptionalPropsFirstParameter,
+  ...testPartialDefaultsFirstParameter
+};
+const testPropsAsSyntaxFirstParameter = {
+  ...testRequiredPropsFirstParameter,
+  ...testOptionalPropsFirstParameter,
+  ...testPartialDefaultsFirstParameter
+};
+const testPartialDefaultsSecondParameter = {};
+const testPropsSecondParameter = {
+  ...testRequiredPropsSecondParameter,
+  ...testOptionalPropsSecondParameter,
+  ...testPartialDefaultsSecondParameter
+};
+const testPropsAsSyntaxSecondParameter = {
+  ...testRequiredPropsSecondParameter,
+  ...testOptionalPropsSecondParameter,
+  ...testPartialDefaultsSecondParameter
+};
+const testCompleteDefaultsFirstParameter = {
+  label: "root"
+};
+const testInternalPropsFirstParameter = {
+  ...testRequiredPropsFirstParameter,
+  ...testOptionalPropsFirstParameter,
+  ...testCompleteDefaultsFirstParameter
+};
+const testInternalPropsAsSyntaxFirstParameter = {
+  ...testRequiredPropsFirstParameter,
+  ...testOptionalPropsFirstParameter,
+  ...testCompleteDefaultsFirstParameter
+};
+const testCompleteDefaultsSecondParameter = {};
+const testInternalPropsSecondParameter = {
+  ...testRequiredPropsSecondParameter,
+  ...testOptionalPropsSecondParameter,
+  ...testCompleteDefaultsSecondParameter
+};
+const testInternalPropsAsSyntaxSecondParameter = {
+  ...testRequiredPropsSecondParameter,
+  ...testOptionalPropsSecondParameter,
+  ...testCompleteDefaultsSecondParameter
+};
+const testExplicitDefinitionFirstParameter = {
+  dsId: "_root",
+  label: "root",
+  subitems: [{ dsId: "sub_item_id1", label: "sub_item_1" }]
+};
+const testExplicitDefinitionSecondParameter = {
+  getUniqueId: (item) => item.dsId
+};
+const testInferedTypeCompatibilityFirstParameter = {
+  dsId: "_root",
+  label: "root",
+  subitems: [{ dsId: "sub_item_id1", label: "sub_item_1" }]
+};
+const testInferedTypeCompatibilitySecondParameter = {
+  getUniqueId: (item) => item.dsId
+};
+const testDefinitionAsConstFirstParameter = {
+  dsId: "_root",
+  label: "root"
+};
+const testDefinitionAsConstSecondParameter = {
+  getUniqueId: (item) => item.dsId
+};
+const ExampleUsageComponent = () => {
+  const {
+    addNode,
+    findAllNodes,
+    findNode,
+    flatten,
+    getNode,
+    getPath,
+    getPathIds,
+    getRoot,
+    hash,
+    moveNode,
+    removeNode,
+    replaceNode,
+    walk,
+    walkParents
+  } = (0, import__.useDSTree)(testExplicitDefinitionFirstParameter, testExplicitDefinitionSecondParameter);
+  const output2 = (0, import__.useDSTree)(testInferedTypeCompatibilityFirstParameter, testInferedTypeCompatibilitySecondParameter);
+  const output3 = (0, import__.useDSTree)(testDefinitionAsConstFirstParameter, testDefinitionAsConstSecondParameter);
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_jsx_runtime.Fragment, {});
+};
+//# sourceMappingURL=typescript-use-ds-tree-valid.js.map

package/dist/cjs/typescript-testing/typescript-use-ds-tree-valid.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../../scripts/build/transpile/react-shim.js", "../../../src/typescript-testing/typescript-use-ds-tree-valid.tsx"],
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "/* eslint-disable @typescript-eslint/no-unused-vars, no-unused-vars */\nimport { useDSTree } from '../index.js';\nimport type { UseDSTreeT } from '../index.js';\n\n// test we expose the namespace and the namespace follows our deliverable conventions\ntype FirstParameterForApp = UseDSTreeT.FirstParameter;\ntype FirstParameterInternals = UseDSTreeT.FirstParameterInternals;\ntype FirstParameterDefaultProps = UseDSTreeT.FirstParameterDefault;\ntype FirstParameterOptionalProps = UseDSTreeT.FirstParameterOptional;\ntype FirstParameterRequiredProps = UseDSTreeT.FirstParameterRequired;\n\ntype SecondParameterForApp = UseDSTreeT.SecondParameter;\ntype SecondParameterInternals = UseDSTreeT.SecondParameterInternals;\ntype SecondParameterDefaultProps = UseDSTreeT.SecondParameterDefault;\ntype SecondParameterOptionalProps = UseDSTreeT.SecondParameterOptional;\ntype SecondParameterRequiredProps = UseDSTreeT.SecondParameterRequired;\n\nconst testRequiredPropsFirstParameter: FirstParameterRequiredProps = {\n  dsId: '',\n};\n\nconst testRequiredPropsSecondParameter: SecondParameterRequiredProps = {\n  getUniqueId: (item) => item.dsId,\n};\n\nconst testOptionalPropsFirstParameter: FirstParameterOptionalProps = {\n  subitems: [{ dsId: '_root', label: 'root', subitems: [] }],\n};\n\nconst testOptionalPropsSecondParameter: SecondParameterOptionalProps = {};\n\n// difference Props and InternalProps is that InternalProps has all the default props filled in\n// Props allows for partial defaults\nconst testPartialDefaultsFirstParameter: Partial<FirstParameterDefaultProps> = {\n  label: 'root',\n};\n\nconst testPropsFirstParameter: FirstParameterForApp = {\n  ...testRequiredPropsFirstParameter,\n  ...testOptionalPropsFirstParameter,\n  ...testPartialDefaultsFirstParameter,\n};\n\nconst testPropsAsSyntaxFirstParameter = {\n  ...testRequiredPropsFirstParameter,\n  ...testOptionalPropsFirstParameter,\n  ...testPartialDefaultsFirstParameter,\n} as FirstParameterForApp;\n\nconst testPartialDefaultsSecondParameter: Partial<SecondParameterDefaultProps> = {};\n\nconst testPropsSecondParameter: SecondParameterForApp = {\n  ...testRequiredPropsSecondParameter,\n  ...testOptionalPropsSecondParameter,\n  ...testPartialDefaultsSecondParameter,\n};\n\nconst testPropsAsSyntaxSecondParameter = {\n  ...testRequiredPropsSecondParameter,\n  ...testOptionalPropsSecondParameter,\n  ...testPartialDefaultsSecondParameter,\n} as SecondParameterForApp;\n\n// InternalProps requires all defaults to be filled in\nconst testCompleteDefaultsFirstParameter: Required<FirstParameterDefaultProps> = {\n  label: 'root',\n};\n\nconst testInternalPropsFirstParameter: FirstParameterInternals = {\n  ...testRequiredPropsFirstParameter,\n  ...testOptionalPropsFirstParameter,\n  ...testCompleteDefaultsFirstParameter,\n};\n\nconst testInternalPropsAsSyntaxFirstParameter = {\n  ...testRequiredPropsFirstParameter,\n  ...testOptionalPropsFirstParameter,\n  ...testCompleteDefaultsFirstParameter,\n} as FirstParameterInternals;\n\nconst testCompleteDefaultsSecondParameter: Required<SecondParameterDefaultProps> = {};\n\nconst testInternalPropsSecondParameter: SecondParameterInternals = {\n  ...testRequiredPropsSecondParameter,\n  ...testOptionalPropsSecondParameter,\n  ...testCompleteDefaultsSecondParameter,\n};\n\nconst testInternalPropsAsSyntaxSecondParameter = {\n  ...testRequiredPropsSecondParameter,\n  ...testOptionalPropsSecondParameter,\n  ...testCompleteDefaultsSecondParameter,\n} as SecondParameterInternals;\n\n// using the explicit type definition, if there is an error, it will be marked on the key that is wrong\nconst testExplicitDefinitionFirstParameter: FirstParameterForApp = {\n  dsId: '_root',\n  label: 'root',\n  subitems: [{ dsId: 'sub_item_id1', label: 'sub_item_1' }],\n};\n\nconst testExplicitDefinitionSecondParameter: SecondParameterForApp = {\n  getUniqueId: (item) => item.dsId,\n};\n\n// using the \"as\" syntax, if there is an error, it will be marking the whole object as wrong because it is not compatible with the type\nconst testInferedTypeCompatibilityFirstParameter = {\n  dsId: '_root',\n  label: 'root',\n  subitems: [{ dsId: 'sub_item_id1', label: 'sub_item_1' }],\n} as FirstParameterForApp;\n\nconst testInferedTypeCompatibilitySecondParameter = {\n  getUniqueId: (item) => item.dsId,\n} as SecondParameterForApp;\n\nconst testDefinitionAsConstFirstParameter = {\n  dsId: '_root',\n  label: 'root',\n} as const;\n\nconst testDefinitionAsConstSecondParameter = {\n  getUniqueId: (item: FirstParameterForApp) => item.dsId,\n} as const;\n\nconst ExampleUsageComponent = () => {\n  const {\n    addNode,\n    findAllNodes,\n    findNode,\n    flatten,\n    getNode,\n    getPath,\n    getPathIds,\n    getRoot,\n    hash,\n    moveNode,\n    removeNode,\n    replaceNode,\n    walk,\n    walkParents,\n  } = useDSTree(testExplicitDefinitionFirstParameter, testExplicitDefinitionSecondParameter);\n\n  const output2 = useDSTree(testInferedTypeCompatibilityFirstParameter, testInferedTypeCompatibilitySecondParameter);\n\n  const output3 = useDSTree(testDefinitionAsConstFirstParameter, testDefinitionAsConstSecondParameter);\n\n  return <></>;\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAAA,YAAuB;ACmJd;AAlJT,eAA0B;AAgB1B,MAAM,kCAA+D;AAAA,EACnE,MAAM;AACR;AAEA,MAAM,mCAAiE;AAAA,EACrE,aAAa,CAAC,SAAS,KAAK;AAC9B;AAEA,MAAM,kCAA+D;AAAA,EACnE,UAAU,CAAC,EAAE,MAAM,SAAS,OAAO,QAAQ,UAAU,CAAC,EAAE,CAAC;AAC3D;AAEA,MAAM,mCAAiE,CAAC;AAIxE,MAAM,oCAAyE;AAAA,EAC7E,OAAO;AACT;AAEA,MAAM,0BAAgD;AAAA,EACpD,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAEA,MAAM,kCAAkC;AAAA,EACtC,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAEA,MAAM,qCAA2E,CAAC;AAElF,MAAM,2BAAkD;AAAA,EACtD,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAEA,MAAM,mCAAmC;AAAA,EACvC,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAGA,MAAM,qCAA2E;AAAA,EAC/E,OAAO;AACT;AAEA,MAAM,kCAA2D;AAAA,EAC/D,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAEA,MAAM,0CAA0C;AAAA,EAC9C,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAEA,MAAM,sCAA6E,CAAC;AAEpF,MAAM,mCAA6D;AAAA,EACjE,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAEA,MAAM,2CAA2C;AAAA,EAC/C,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAGA,MAAM,uCAA6D;AAAA,EACjE,MAAM;AAAA,EACN,OAAO;AAAA,EACP,UAAU,CAAC,EAAE,MAAM,gBAAgB,OAAO,aAAa,CAAC;AAC1D;AAEA,MAAM,wCAA+D;AAAA,EACnE,aAAa,CAAC,SAAS,KAAK;AAC9B;AAGA,MAAM,6CAA6C;AAAA,EACjD,MAAM;AAAA,EACN,OAAO;AAAA,EACP,UAAU,CAAC,EAAE,MAAM,gBAAgB,OAAO,aAAa,CAAC;AAC1D;AAEA,MAAM,8CAA8C;AAAA,EAClD,aAAa,CAAC,SAAS,KAAK;AAC9B;AAEA,MAAM,sCAAsC;AAAA,EAC1C,MAAM;AAAA,EACN,OAAO;AACT;AAEA,MAAM,uCAAuC;AAAA,EAC3C,aAAa,CAAC,SAA+B,KAAK;AACpD;AAEA,MAAM,wBAAwB,MAAM;AAClC,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,QAAI,oBAAU,sCAAsC,qCAAqC;AAEzF,QAAM,cAAU,oBAAU,4CAA4C,2CAA2C;AAEjH,QAAM,cAAU,oBAAU,qCAAqC,oCAAoC;AAEnG,SAAO,2EAAE;AACX;",
+  "names": []
+}