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

package/types/propTypes/types.d.ts

@@ -0,0 +1,96 @@
+import { any, array, bool, func, number, object, string, node, element, symbol, elementType, instanceOf, oneOf, oneOfType, arrayOf, objectOf, shape, exact, ValidationMap } from 'prop-types';
+import React from 'react';
+export interface ReactDescObjT {
+    [key: string]: unknown;
+    required?: boolean;
+    deprecated?: Record<string, string>;
+    description?: string;
+    defaultValue?: unknown;
+    format?: string;
+    warned?: boolean;
+}
+export declare type InstanceOfT = typeof instanceOf;
+export declare type OneOfT = typeof oneOf;
+export declare type ObjectOfT = typeof objectOf;
+export declare type ExactT = typeof exact;
+export declare type OneOfTypeT = typeof oneOfType;
+export declare type ArrayOfT = typeof arrayOf;
+export declare type ShapeT = typeof shape;
+export declare type AnyT = typeof any;
+export declare type ArrayT = typeof array;
+export declare type BoolT = typeof bool;
+export declare type FuncT = typeof func;
+export declare type NumberT = typeof number;
+export declare type ObjectT = typeof object;
+export declare type StringT = typeof string;
+export declare type NodeT = typeof node;
+export declare type ElementT = typeof element;
+export declare type SymbolT = typeof symbol;
+export declare type ElementTypeT = typeof elementType;
+export declare type ParametizedPropTypes = InstanceOfT | OneOfT | ObjectOfT | ExactT | OneOfTypeT | ArrayOfT | ShapeT;
+export declare type AllPropTypes = AnyT | ArrayT | BoolT | FuncT | NumberT | ObjectT | StringT | NodeT | ElementT | SymbolT | ElementTypeT | ParametizedPropTypes;
+export declare type PropTypesTypes = 'any' | 'array' | 'bool' | 'func' | 'number' | 'object' | 'string' | 'node' | 'element' | 'symbol' | 'elementType' | 'instanceOf' | 'oneOf' | 'oneOfType' | 'arrayOf' | 'objectOf' | 'shape' | 'exact' | 'tuple';
+export interface ReactDescT {
+    [key: string]: unknown;
+    type: PropTypesTypes;
+    defaultValue: (this: ReactDescT, dfault: unknown) => ReactDescT;
+    deprecated: (this: ReactDescT, info: Record<string, string>) => ReactDescT;
+    description: (this: ReactDescT, descr: string) => ReactDescT;
+    format: (this: ReactDescT, format: string) => ReactDescT;
+    isRequired: ReactDescT;
+    reactDesc: ReactDescObjT;
+    args?: ReactDescT | ReactDescT[] | Record<string, ReactDescT> | unknown[] | Parameters<InstanceOfT>[0] | Parameters<OneOfT>[0] | Parameters<ObjectOfT>[0] | Parameters<ExactT>[0];
+}
+export interface ComponentDocumentation {
+    propTypes: Record<string, ReactDescT>;
+    availableAt?: unknown;
+    description?: unknown;
+    details?: unknown;
+    deprecated?: unknown;
+    usage?: unknown;
+    intrinsicElement?: unknown;
+    toTypescript?: unknown;
+}
+export interface TypescriptDocumentation extends Partial<ComponentDocumentation> {
+    name: string;
+    properties?: {
+        name: string;
+        required?: boolean | undefined;
+        deprecated?: Record<string, string> | undefined;
+        description?: string | undefined;
+        format?: string | undefined;
+        warned?: boolean | undefined;
+    }[];
+}
+export declare type DocumentedReactComponent<T> = React.ComponentType<T> & {
+    availableAt: unknown;
+    description: (descr: string) => DocumentedReactComponent<T>;
+    details: unknown;
+    deprecated: unknown;
+    usage: unknown;
+    intrinsicElement: unknown;
+    toTypescript: unknown;
+    propTypesValue: ValidationMap<Record<string, unknown>>;
+};
+export declare type DocumentedPropType = ReactDescT;
+export declare type PropTypesObj = {
+    any: DocumentedPropType;
+    array: DocumentedPropType;
+    bool: DocumentedPropType;
+    func: DocumentedPropType;
+    number: DocumentedPropType;
+    object: DocumentedPropType;
+    string: DocumentedPropType;
+    node: DocumentedPropType;
+    element: DocumentedPropType;
+    symbol: DocumentedPropType;
+    elementType: DocumentedPropType;
+    instanceOf: (cls: unknown) => DocumentedPropType;
+    oneOf: (arr: unknown[]) => DocumentedPropType;
+    oneOfType: (arr: DocumentedPropType[]) => DocumentedPropType;
+    arrayOf: (smth: DocumentedPropType) => DocumentedPropType;
+    objectOf: (smth: DocumentedPropType) => DocumentedPropType;
+    shape: (obj: Record<string, DocumentedPropType>) => DocumentedPropType;
+    exact: (obj: Record<string, DocumentedPropType>) => DocumentedPropType;
+    tuple: (arr: DocumentedPropType[]) => DocumentedPropType;
+};

package/types/tests/globalProps/TestComponent.d.ts

@@ -0,0 +1 @@
+export function TestComponent(props: any): JSX.Element;

package/types/tests/globalProps/globalAttributes.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/tests/validation/any.validation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/tests/validation/array.validation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/tests/validation/boolean.validation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/tests/validation/function.validation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/tests/validation/number.validation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/tests/validation/object.validation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/tests/validation/schema.validation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/tests/validation/string.validation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/tests/validation/test.schema.d.ts

@@ -0,0 +1 @@
+export const TypescriptSchema: any;

package/types/tests/validation/union.validation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/validation/errorTemplates.d.ts

@@ -0,0 +1,2 @@
+export declare const throwTypeError: (componentName: string, validPropKey: string, invalidProp: unknown, validFormat: string) => void;
+export declare const throwRequiredError: (componentName: string, validPropKey: string) => void;

package/types/validation/index.d.ts

@@ -0,0 +1,3 @@
+export * from './validator';
+export * from './errorTemplates';
+export * from './typescriptValidator';

package/types/validation/typescriptGuards.d.ts

@@ -0,0 +1,12 @@
+declare type GuardFn = (format: string) => boolean;
+export declare const isPrimitiveType: GuardFn;
+export declare const isUndefined: GuardFn;
+export declare const isNull: GuardFn;
+export declare const isUnion: GuardFn;
+export declare const isString: GuardFn;
+export declare const isArray: GuardFn;
+export declare const isObject: GuardFn;
+export declare const isFunction: GuardFn;
+export declare const isJSXorNode: GuardFn;
+export declare const isSomethingWithParenthesis: GuardFn;
+export {};

package/types/validation/typescriptParsers.d.ts

@@ -0,0 +1 @@
+export declare const typescriptObjectParser: (format: string) => [string, string][];

package/types/validation/typescriptValidator.d.ts

@@ -0,0 +1,15 @@
+import React, { PropsWithChildren } from 'react';
+interface TypescriptSchema {
+    description: string;
+    name: string;
+    properties: {
+        name: string;
+        description: string;
+        defaultValue?: unknown;
+        format: string;
+        required?: boolean;
+    }[];
+}
+export declare const validateTypescriptPropTypesImplementation: (props: PropsWithChildren<Record<string, unknown>>, schema: TypescriptSchema, validationsMemo?: Record<string, string>, nextValidationsMemo?: Record<string, string>) => void;
+export declare const useValidateTypescriptPropTypes: <T = Record<string, any>>(props: React.PropsWithChildren<T>, propTypes: any) => void;
+export {};

package/types/validation/validator.d.ts

@@ -0,0 +1 @@
+export declare const useValidatePropTypes: (props: Record<string, unknown>, schema: any) => void;

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": []
-}