@elliemae/ds-props-helpers 2.3.0-alpha.9 → 2.3.0-next.0

package/package.json

@@ -1,110 +1,107 @@
 {
   "name": "@elliemae/ds-props-helpers",
-  "version": "2.3.0-alpha.9",
+  "version": "2.3.0-next.0",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Props Helpers",
-  "files": [
-    "dist"
-  ],
-  "module": "./dist/esm/index.js",
-  "main": "./dist/cjs/index.js",
-  "types": "./dist/types/index.d.ts",
+  "module": "./esm/index.js",
+  "main": "./cjs/index.js",
+  "types": "./types/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js"
+      "import": "./esm/index.js",
+      "require": "./cjs/index.js"
     },
     "./validation/validator": {
-      "import": "./dist/esm/validation/validator.js",
-      "require": "./dist/cjs/validation/validator.js"
+      "import": "./esm/validation/validator.js",
+      "require": "./cjs/validation/validator.js"
     },
     "./validation/typescriptValidator": {
-      "import": "./dist/esm/validation/typescriptValidator.js",
-      "require": "./dist/cjs/validation/typescriptValidator.js"
+      "import": "./esm/validation/typescriptValidator.js",
+      "require": "./cjs/validation/typescriptValidator.js"
     },
     "./validation/typescriptParsers": {
-      "import": "./dist/esm/validation/typescriptParsers.js",
-      "require": "./dist/cjs/validation/typescriptParsers.js"
+      "import": "./esm/validation/typescriptParsers.js",
+      "require": "./cjs/validation/typescriptParsers.js"
     },
     "./validation/typescriptGuards": {
-      "import": "./dist/esm/validation/typescriptGuards.js",
-      "require": "./dist/cjs/validation/typescriptGuards.js"
+      "import": "./esm/validation/typescriptGuards.js",
+      "require": "./cjs/validation/typescriptGuards.js"
     },
     "./validation": {
-      "import": "./dist/esm/validation/index.js",
-      "require": "./dist/cjs/validation/index.js"
+      "import": "./esm/validation/index.js",
+      "require": "./cjs/validation/index.js"
     },
     "./validation/errorTemplates": {
-      "import": "./dist/esm/validation/errorTemplates.js",
-      "require": "./dist/cjs/validation/errorTemplates.js"
+      "import": "./esm/validation/errorTemplates.js",
+      "require": "./cjs/validation/errorTemplates.js"
     },
     "./tests/validation/test.schema": {
-      "import": "./dist/esm/tests/validation/test.schema.js",
-      "require": "./dist/cjs/tests/validation/test.schema.js"
+      "import": "./esm/tests/validation/test.schema.js",
+      "require": "./cjs/tests/validation/test.schema.js"
     },
     "./tests/globalProps/TestComponent": {
-      "import": "./dist/esm/tests/globalProps/TestComponent.js",
-      "require": "./dist/cjs/tests/globalProps/TestComponent.js"
+      "import": "./esm/tests/globalProps/TestComponent.js",
+      "require": "./cjs/tests/globalProps/TestComponent.js"
     },
     "./propTypes/types": {
-      "import": "./dist/esm/propTypes/types.js",
-      "require": "./dist/cjs/propTypes/types.js"
+      "import": "./esm/propTypes/types.js",
+      "require": "./cjs/propTypes/types.js"
     },
     "./propTypes/toTypescript": {
-      "import": "./dist/esm/propTypes/toTypescript.js",
-      "require": "./dist/cjs/propTypes/toTypescript.js"
+      "import": "./esm/propTypes/toTypescript.js",
+      "require": "./cjs/propTypes/toTypescript.js"
     },
     "./propTypes/PropTypes": {
-      "import": "./dist/esm/propTypes/PropTypes.js",
-      "require": "./dist/cjs/propTypes/PropTypes.js"
+      "import": "./esm/propTypes/PropTypes.js",
+      "require": "./cjs/propTypes/PropTypes.js"
     },
     "./propTypes": {
-      "import": "./dist/esm/propTypes/index.js",
-      "require": "./dist/cjs/propTypes/index.js"
+      "import": "./esm/propTypes/index.js",
+      "require": "./cjs/propTypes/index.js"
     },
     "./propTypes/describeGuards": {
-      "import": "./dist/esm/propTypes/describeGuards.js",
-      "require": "./dist/cjs/propTypes/describeGuards.js"
+      "import": "./esm/propTypes/describeGuards.js",
+      "require": "./cjs/propTypes/describeGuards.js"
     },
     "./propTypes/describeConversions": {
-      "import": "./dist/esm/propTypes/describeConversions.js",
-      "require": "./dist/cjs/propTypes/describeConversions.js"
+      "import": "./esm/propTypes/describeConversions.js",
+      "require": "./cjs/propTypes/describeConversions.js"
     },
     "./propTypes/describe": {
-      "import": "./dist/esm/propTypes/describe.js",
-      "require": "./dist/cjs/propTypes/describe.js"
+      "import": "./esm/propTypes/describe.js",
+      "require": "./cjs/propTypes/describe.js"
     },
     "./propTypes/customPropTypes": {
-      "import": "./dist/esm/propTypes/customPropTypes.js",
-      "require": "./dist/cjs/propTypes/customPropTypes.js"
+      "import": "./esm/propTypes/customPropTypes.js",
+      "require": "./cjs/propTypes/customPropTypes.js"
     },
     "./globalProps/useGetGlobalAttributes": {
-      "import": "./dist/esm/globalProps/useGetGlobalAttributes.js",
-      "require": "./dist/cjs/globalProps/useGetGlobalAttributes.js"
+      "import": "./esm/globalProps/useGetGlobalAttributes.js",
+      "require": "./cjs/globalProps/useGetGlobalAttributes.js"
     },
     "./globalProps": {
-      "import": "./dist/esm/globalProps/index.js",
-      "require": "./dist/cjs/globalProps/index.js"
+      "import": "./esm/globalProps/index.js",
+      "require": "./cjs/globalProps/index.js"
     },
     "./globalProps/globalAttributesPropTypes": {
-      "import": "./dist/esm/globalProps/globalAttributesPropTypes.js",
-      "require": "./dist/cjs/globalProps/globalAttributesPropTypes.js"
+      "import": "./esm/globalProps/globalAttributesPropTypes.js",
+      "require": "./cjs/globalProps/globalAttributesPropTypes.js"
     },
     "./globalProps/constants": {
-      "import": "./dist/esm/globalProps/constants.js",
-      "require": "./dist/cjs/globalProps/constants.js"
+      "import": "./esm/globalProps/constants.js",
+      "require": "./cjs/globalProps/constants.js"
     },
     "./getProps": {
-      "import": "./dist/esm/getProps/index.js",
-      "require": "./dist/cjs/getProps/index.js"
+      "import": "./esm/getProps/index.js",
+      "require": "./cjs/getProps/index.js"
     },
     "./defaultProps/useMemoMergePropsWithDefault": {
-      "import": "./dist/esm/defaultProps/useMemoMergePropsWithDefault.js",
-      "require": "./dist/cjs/defaultProps/useMemoMergePropsWithDefault.js"
+      "import": "./esm/defaultProps/useMemoMergePropsWithDefault.js",
+      "require": "./cjs/defaultProps/useMemoMergePropsWithDefault.js"
     },
     "./defaultProps": {
-      "import": "./dist/esm/defaultProps/index.js",
-      "require": "./dist/cjs/defaultProps/index.js"
+      "import": "./esm/defaultProps/index.js",
+      "require": "./cjs/defaultProps/index.js"
     }
   },
   "sideEffects": [
@@ -116,15 +113,21 @@
     "url": "https://git.elliemae.io/platform-ui/dimsum.git"
   },
   "engines": {
-    "pnpm": ">=6",
-    "node": ">=16"
+    "npm": ">=7",
+    "node": ">=14"
+  },
+  "scripts": {
+    "dev": "cross-env NODE_ENV=development && node ../../scripts/build/build.js -w",
+    "prebuild": "exit 0",
+    "predev": "exit 0",
+    "build": "node ../../scripts/build/build.js"
   },
   "dependencies": {
     "fast-deep-equal": "~3.1.3",
     "react-desc": "^4.1.3"
   },
   "devDependencies": {
-    "@testing-library/jest-dom": "~5.15.1"
+    "@testing-library/jest-dom": "~5.15.0"
   },
   "peerDependencies": {
     "react": "~17.0.2",
@@ -132,12 +135,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "typeSafety": false
-  },
-  "scripts": {
-    "dev": "cross-env NODE_ENV=development && node ../../scripts/build/build.js -w",
-    "prebuild": "exit 0",
-    "predev": "exit 0",
-    "build": "node ../../scripts/build/build.js"
+    "directory": "dist",
+    "generateSubmodules": true
   }
 }

package/{dist/types → types}/propTypes/types.d.ts

@@ -64,7 +64,7 @@ export interface TypescriptDocumentation extends Partial<ComponentDocumentation>
 }
 export declare type DocumentedReactComponent<T> = React.ComponentType<T> & {
     availableAt: unknown;
-    description: unknown;
+    description: (descr: string) => DocumentedReactComponent<T>;
     details: unknown;
     deprecated: unknown;
     usage: unknown;

package/dist/cjs/defaultProps/index.js

@@ -1,28 +0,0 @@
-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 __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
-var __reExport = (target, module2, copyDefault, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && (copyDefault || key !== "default"))
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
-  }
-  return target;
-};
-var __toESM = (module2, isNodeMode) => {
-  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", !isNodeMode && module2 && module2.__esModule ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
-};
-var __toCommonJS = /* @__PURE__ */ ((cache) => {
-  return (module2, temp) => {
-    return cache && cache.get(module2) || (temp = __reExport(__markAsModule({}), module2, 1), cache && cache.set(module2, temp), temp);
-  };
-})(typeof WeakMap !== "undefined" ? /* @__PURE__ */ new WeakMap() : 0);
-var defaultProps_exports = {};
-var React = __toESM(require("react"));
-__reExport(defaultProps_exports, require("./useMemoMergePropsWithDefault"));
-module.exports = __toCommonJS(defaultProps_exports);
-//# sourceMappingURL=index.js.map

package/dist/cjs/defaultProps/index.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/defaultProps/index.ts", "../../../../../scripts/build/transpile/react-shim.js"],
-  "sourcesContent": ["export * from './useMemoMergePropsWithDefault';\n", "import * as React from 'react';\nexport { React };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAAA;ACAA,YAAuB;ADAvB,iCAAc;",
-  "names": []
-}

package/dist/cjs/defaultProps/useMemoMergePropsWithDefault.js

@@ -1,48 +0,0 @@
-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 __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __reExport = (target, module2, copyDefault, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && (copyDefault || key !== "default"))
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
-  }
-  return target;
-};
-var __toESM = (module2, isNodeMode) => {
-  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", !isNodeMode && module2 && module2.__esModule ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
-};
-var __toCommonJS = /* @__PURE__ */ ((cache) => {
-  return (module2, temp) => {
-    return cache && cache.get(module2) || (temp = __reExport(__markAsModule({}), module2, 1), cache && cache.set(module2, temp), temp);
-  };
-})(typeof WeakMap !== "undefined" ? /* @__PURE__ */ new WeakMap() : 0);
-var useMemoMergePropsWithDefault_exports = {};
-__export(useMemoMergePropsWithDefault_exports, {
-  useMemoMergePropsWithDefault: () => useMemoMergePropsWithDefault
-});
-var React = __toESM(require("react"));
-var import_react = require("react");
-var import_react2 = __toESM(require("fast-deep-equal/react"));
-const useMemoCompare = (next, compare) => {
-  const previousRef = (0, import_react.useRef)(next);
-  const previous = previousRef.current;
-  const isEqual = compare(previous, next);
-  if (!isEqual)
-    previousRef.current = next;
-  return isEqual ? previous : next;
-};
-const useMemoMergePropsWithDefault = (props, defaultProps, compare = import_react2.default) => {
-  const mergedProps = { ...defaultProps, ...props };
-  return useMemoCompare(mergedProps, compare);
-};
-module.exports = __toCommonJS(useMemoMergePropsWithDefault_exports);
-//# sourceMappingURL=useMemoMergePropsWithDefault.js.map

package/dist/cjs/defaultProps/useMemoMergePropsWithDefault.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/defaultProps/useMemoMergePropsWithDefault.ts", "../../../../../scripts/build/transpile/react-shim.js"],
-  "sourcesContent": ["import { useRef } from 'react';\nimport deepequal from 'fast-deep-equal/react';\n\n// Hook\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nconst useMemoCompare = <T = any>(next: T, compare: (prevToCompare: T, nextToCompare: T) => boolean): T => {\n  // Ref for storing previous value\n  const previousRef = useRef(next);\n  const previous = previousRef.current;\n  // Pass previous and next value to compare function\n  // to determine whether to consider them equal.\n  const isEqual = compare(previous, next);\n  // If not equal update previousRef to next value.\n  // We only update if not equal so that this hook continues to return\n  // the same old value if compare keeps returning true.\n  if (!isEqual) previousRef.current = next;\n  // Finally, if equal then return the previous value\n  return isEqual ? previous : next;\n};\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport const useMemoMergePropsWithDefault = <T = Record<string, any>>(\n  props: Partial<T>,\n  defaultProps: Partial<T>,\n  compare = deepequal,\n): T => {\n  const mergedProps = { ...defaultProps, ...props } as T;\n\n  return useMemoCompare<T>(mergedProps, compare);\n};\n", "import * as React from 'react';\nexport { React };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADAvB,mBAAuB;AACvB,oBAAsB;AAItB,MAAM,iBAAiB,CAAU,MAAS,YAAgE;AAExG,QAAM,cAAc,yBAAO;AAC3B,QAAM,WAAW,YAAY;AAG7B,QAAM,UAAU,QAAQ,UAAU;AAIlC,MAAI,CAAC;AAAS,gBAAY,UAAU;AAEpC,SAAO,UAAU,WAAW;AAAA;AAIvB,MAAM,+BAA+B,CAC1C,OACA,cACA,UAAU,0BACJ;AACN,QAAM,cAAc,KAAK,iBAAiB;AAE1C,SAAO,eAAkB,aAAa;AAAA;",
-  "names": []
-}

package/dist/cjs/getProps/index.js

@@ -1,37 +0,0 @@
-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 __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __reExport = (target, module2, copyDefault, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && (copyDefault || key !== "default"))
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
-  }
-  return target;
-};
-var __toESM = (module2, isNodeMode) => {
-  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", !isNodeMode && module2 && module2.__esModule ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
-};
-var __toCommonJS = /* @__PURE__ */ ((cache) => {
-  return (module2, temp) => {
-    return cache && cache.get(module2) || (temp = __reExport(__markAsModule({}), module2, 1), cache && cache.set(module2, temp), temp);
-  };
-})(typeof WeakMap !== "undefined" ? /* @__PURE__ */ new WeakMap() : 0);
-var getProps_exports = {};
-__export(getProps_exports, {
-  getAriaProps: () => getAriaProps,
-  getDataProps: () => getDataProps
-});
-var React = __toESM(require("react"));
-const getAriaProps = (props) => Object.fromEntries(Object.entries(props).filter(([key]) => key.includes("aria-")));
-const getDataProps = (props) => Object.fromEntries(Object.entries(props).filter(([key]) => key.includes("data-")));
-module.exports = __toCommonJS(getProps_exports);
-//# sourceMappingURL=index.js.map

package/dist/cjs/getProps/index.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/getProps/index.ts", "../../../../../scripts/build/transpile/react-shim.js"],
-  "sourcesContent": ["export const getAriaProps = (props: Record<string, unknown>): Record<string, unknown> =>\n  Object.fromEntries(Object.entries(props).filter(([key]) => key.includes('aria-')));\n\nexport const getDataProps = (props: Record<string, unknown>): Record<string, unknown> =>\n  Object.fromEntries(Object.entries(props).filter(([key]) => key.includes('data-')));\n", "import * as React from 'react';\nexport { React };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADAhB,MAAM,eAAe,CAAC,UAC3B,OAAO,YAAY,OAAO,QAAQ,OAAO,OAAO,CAAC,CAAC,SAAS,IAAI,SAAS;AAEnE,MAAM,eAAe,CAAC,UAC3B,OAAO,YAAY,OAAO,QAAQ,OAAO,OAAO,CAAC,CAAC,SAAS,IAAI,SAAS;",
-  "names": []
-}