@elliemae/ds-legacy-props-helpers 1.0.0-rc.1

package/dist/types/propTypes/types.d.ts

@@ -0,0 +1,118 @@
+import type { any, array, bool, func, number, object, string, node, element, symbol, elementType, instanceOf, oneOf, oneOfType, arrayOf, objectOf, shape, exact, ValidationMap } from 'prop-types';
+import type React from 'react';
+export interface ReactDescObjT {
+    [key: string]: unknown;
+    required?: boolean;
+    deprecated?: Record<string, string>;
+    description?: string;
+    defaultValue?: unknown;
+    format?: string;
+    signature?: string;
+    warned?: boolean;
+    isRequiredIf?: (props: any) => boolean;
+    group?: Record<string, unknown>;
+}
+export type InstanceOfT = typeof instanceOf;
+export type OneOfT = typeof oneOf;
+export type ObjectOfT = typeof objectOf;
+export type ExactT = typeof exact;
+export type OneOfTypeT = typeof oneOfType;
+export type ArrayOfT = typeof arrayOf;
+export type ShapeT = typeof shape;
+export type AnyT = typeof any;
+export type ArrayT = typeof array;
+export type BoolT = typeof bool;
+export type FuncT = typeof func;
+export type NumberT = typeof number;
+export type ObjectT = typeof object;
+export type StringT = typeof string;
+export type NodeT = typeof node;
+export type ElementT = typeof element;
+export type SymbolT = typeof symbol;
+export type ElementTypeT = typeof elementType;
+export type ParametizedPropTypes = InstanceOfT | OneOfT | ObjectOfT | ExactT | OneOfTypeT | ArrayOfT | ShapeT;
+export type AllPropTypes = AnyT | ArrayT | BoolT | FuncT | NumberT | ObjectT | StringT | NodeT | ElementT | SymbolT | ElementTypeT | ParametizedPropTypes;
+export 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;
+    signature: (this: ReactDescT, format: string) => ReactDescT;
+    hidden: (this: ReactDescT) => ReactDescT;
+    dataTestId: (this: ReactDescT) => ReactDescT;
+    global: (this: ReactDescT) => ReactDescT;
+    xstyled: (this: ReactDescT) => ReactDescT;
+    omitValidation: (this: ReactDescT) => ReactDescT;
+    isRequired: ReactDescT;
+    isRequiredIf: (this: ReactDescT, isRequiredIf: (props: any) => boolean) => 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?: string;
+    details?: unknown;
+    deprecated?: unknown;
+    usage?: unknown;
+    intrinsicElement?: unknown;
+    toTypescript?: unknown;
+}
+export interface TypescriptDocumentation extends Partial<ComponentDocumentation> {
+    name: string;
+    description: string;
+    properties: {
+        name: string;
+        required?: boolean | undefined;
+        deprecated?: Record<string, string> | undefined;
+        description?: string;
+        format?: string;
+        signature?: string;
+        warned?: boolean;
+        defaultValue?: unknown;
+        isRequiredIf?: (props: any) => boolean;
+        omitValidation?: boolean;
+    }[];
+}
+export type DocumentedReactComponent<T> = React.ComponentType<T> & {
+    availableAt: unknown;
+    description: (descr: string) => DocumentedReactComponent<T>;
+    details: unknown;
+    deprecated: unknown;
+    usage: unknown;
+    intrinsicElement: unknown;
+    toTypescript: () => TypescriptDocumentation;
+    propTypesValue: ValidationMap<Record<string, unknown>>;
+};
+export type Hook<T = unknown, S = unknown> = ((props: T) => S) & {
+    displayName?: string;
+    name?: string;
+};
+export type DocumentedPropType = ReactDescT;
+export 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;
+};
+export type DSPropTypesSchema<T> = Required<{
+    [key in keyof T]: ReactDescT;
+}>;

package/dist/types/propsPerDataTestId/getPropsPerDatatestIdPropTypes.d.ts

@@ -0,0 +1,39 @@
+import type { ReactDescT } from '../propTypes/types.js';
+type DataTestId = {
+    [key: string]: string | DataTestId;
+};
+type PropsPerDataTestIdPropTypes = {
+    [key: string]: ReactDescT['shape'];
+};
+/**
+ * @param {object} dataTestIdObj - object in which the values rapresent the keys of the output object
+ * @returns {object} output - an object in which for each leaf value of the input object there is a key with aria-* and data-* props.shape definition
+ * @example
+ * const dataTestIdObj = {
+ *   WHATEVER: 'data-testid',
+ *   NESTED:{
+ *     WHATEVER2: 'data-testid-2',
+ *     WHATEVER3: 'data-testid-3',
+ *   }
+ * }
+ *
+ * const propsPerDataTestIdPropTypes = getPropsPerDatatestIdPropTypes(dataTestIdObj);
+ * // propsPerDataTestIdPropTypes will be
+ * {
+ *   'data-testid': PropTypes.shape({
+ *      'aria-*': PropTypes.string,
+ *      'data-*': PropTypes.string,
+ *   }),
+ *   'data-testid-2': PropTypes.shape({
+ *      'aria-*': PropTypes.string,
+ *      'data-*': PropTypes.string,
+ *   })
+ *   'data-testid-3': PropTypes.shape({
+ *      'aria-*': PropTypes.string,
+ *      'data-*': PropTypes.string,
+ *   })
+ * }
+ * @fires getLeafValues
+ */
+export declare const getPropsPerDatatestIdPropTypes: (dataTestIdObj: DataTestId) => PropsPerDataTestIdPropTypes;
+export {};

package/dist/types/propsPerDataTestId/getPropsPerDatatestid.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Returns the props for a given dataTestId.
+ * props are going to be filtered so only aria related and data-* props are going to be returned.
+ * @param {Record<string, string> | (() => Record<string, string>)} userProps - The props passed by the user.
+ * @returns The props for the given dataTestId.
+ * @example
+ * const userProps = {
+ *  'ds-controlled-date-time-picker-month-input': {
+ *    'aria-label': 'month-input-aria-label',
+ *    'data-test': 'month-input-data-test',
+ *    somethingElse: 'this will not be returned',
+ *  },
+ *  'ds-controlled-date-time-picker-day-input': {
+ *   'aria-label': 'day-aria-label',
+ *   'data-test': 'day-data-test',
+ *  },
+ * };
+ * const dataTestIdProps = getDataTestIdProps(userProps['ds-controlled-date-time-picker-day-input']);
+ * // dataTestIdProps = {
+ * //   'aria-label': 'day-aria-label',
+ * //   'data-test': 'day-data-test',
+ * // }
+ * @example
+ * const userProps = {
+ *   'ds-controlled-date-time-picker-month-input': {
+ *     'aria-label': 'month-input-aria-label',
+ *     'data-test': 'month-input-data-test',
+ *   },
+ *   'ds-controlled-date-time-picker-day-input': (props) => ({ // notice that this is a function that returns an object
+ *     'aria-label': 'day-aria-label',
+ *     'data-test': 'day-data-test',
+ *     somethingElse: 'this will not be returned',
+ *   }),
+ * };
+ * const dataTestIdProps = getDataTestIdProps(userProps['ds-controlled-date-time-picker-day-input']);
+ * // dataTestIdProps = {
+ * //   'aria-label': 'day-aria-label',
+ * //   'data-test': 'day-data-test',
+ * // }
+ * @fires getAriaOrDataProps
+ */
+declare const getPropsPerDatatestid: (userProps: AriaAndDataPropsOrPropsGetter | undefined) => AriaAndDataProps;
+export { getPropsPerDatatestid };

package/dist/types/propsPerDataTestId/index.d.ts

@@ -0,0 +1,2 @@
+export { getPropsPerDatatestid } from './getPropsPerDatatestid.js';
+export { getPropsPerDatatestIdPropTypes } from './getPropsPerDatatestIdPropTypes.js';

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

@@ -0,0 +1 @@
+export function TestComponent(props: any): import("react/jsx-runtime").JSX.Element;

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

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

package/dist/types/tests/propsPerDataTestId/getPropsPerDatatestIdPropTypes.test.d.ts

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

package/dist/types/tests/propsPerDataTestId/getPropsPerDatatestid.test.d.ts

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

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

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

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

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

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

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

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

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

package/dist/types/tests/validation/isRequiredIf.validation.test.d.ts

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

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

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

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

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

package/dist/types/tests/validation/objectOf.validation.test.d.ts

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

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

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

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

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

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

@@ -0,0 +1 @@
+export const TypescriptSchema: import("../../propTypes/types.js").TypescriptDocumentation;

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

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

package/dist/types/tests/xstyledProps/TestComponent.d.ts

@@ -0,0 +1 @@
+export function TestComponent(props: any): import("react/jsx-runtime").JSX.Element;

package/dist/types/tests/xstyledProps/xstyledProps.test.d.ts

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

package/dist/types/useDeprecateComponent/index.d.ts

@@ -0,0 +1,6 @@
+interface Props {
+    componentName: string;
+    version: string;
+}
+export declare const useDeprecateComponent: ({ componentName, version }: Props) => void;
+export {};

package/dist/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/dist/types/validation/index.d.ts

@@ -0,0 +1,2 @@
+export { throwTypeError, throwRequiredError } from './errorTemplates.js';
+export { validateTypescriptPropTypesImplementation, useValidateTypescriptPropTypes } from './typescriptValidator.js';

package/dist/types/validation/typescriptGuards.d.ts

@@ -0,0 +1,13 @@
+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 isObjectOf: GuardFn;
+export declare const isObject: GuardFn;
+export declare const isFunction: GuardFn;
+export declare const isJSXorNode: GuardFn;
+export declare const isSomethingWithParenthesis: GuardFn;
+export {};

package/dist/types/validation/typescriptParsers.d.ts

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

package/dist/types/validation/typescriptValidator.d.ts

@@ -0,0 +1,4 @@
+import type { PropsWithChildren, WeakValidationMap } from 'react';
+import type { TypescriptDocumentation } from '../propTypes/types.js';
+export declare const validateTypescriptPropTypesImplementation: (props: PropsWithChildren<Record<string, unknown>>, schema: TypescriptDocumentation, validationsMemo?: Record<string, string>, nextValidationsMemo?: Record<string, string>) => void;
+export declare const useValidateTypescriptPropTypes: <T = Record<string, any>>(props: PropsWithChildren<T>, propTypes: WeakValidationMap<unknown>, componentDisplayName: string) => void;

package/dist/types/xstyledProps/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const layoutKeys: string[];
+export declare const borderKeys: string[];
+export declare const backgroundKeys: string[];
+export declare const colorKeys: string[];
+export declare const boxShadowKeys: string[];
+export declare const typographyKeys: string[];
+export declare const xstyledKeys: Record<string, true>;

package/dist/types/xstyledProps/index.d.ts

@@ -0,0 +1,2 @@
+export { type XstyledProps, useGetXstyledProps } from './useGetXstyledProps.js';
+export { xstyledPropTypes } from './xstyledPropTypes.js';

package/dist/types/xstyledProps/useGetXstyledProps.d.ts

@@ -0,0 +1,6 @@
+import type { SizingProps, SpaceProps, LayoutProps, BoxShadowProps, BorderProps, BackgroundProps } from '@elliemae/ds-legacy-system';
+export interface XstyledProps extends SpaceProps, SizingProps, LayoutProps, BoxShadowProps, BorderProps, BackgroundProps {
+}
+type PropsWithXstyled<T> = T & XstyledProps;
+export declare const useGetXstyledProps: <T>(props: PropsWithXstyled<T>) => XstyledProps;
+export {};

package/dist/types/xstyledProps/xstyledPropTypes.d.ts

@@ -0,0 +1,84 @@
+export declare const xstyledPropTypes: {
+    margin: import("../propTypes/types.js").ReactDescT;
+    m: import("../propTypes/types.js").ReactDescT;
+    marginTop: import("../propTypes/types.js").ReactDescT;
+    mt: import("../propTypes/types.js").ReactDescT;
+    marginRight: import("../propTypes/types.js").ReactDescT;
+    mr: import("../propTypes/types.js").ReactDescT;
+    marginBottom: import("../propTypes/types.js").ReactDescT;
+    mb: import("../propTypes/types.js").ReactDescT;
+    marginLeft: import("../propTypes/types.js").ReactDescT;
+    ml: import("../propTypes/types.js").ReactDescT;
+    mx: import("../propTypes/types.js").ReactDescT;
+    my: import("../propTypes/types.js").ReactDescT;
+    padding: import("../propTypes/types.js").ReactDescT;
+    p: import("../propTypes/types.js").ReactDescT;
+    paddingTop: import("../propTypes/types.js").ReactDescT;
+    pt: import("../propTypes/types.js").ReactDescT;
+    paddingRight: import("../propTypes/types.js").ReactDescT;
+    pr: import("../propTypes/types.js").ReactDescT;
+    paddingBottom: import("../propTypes/types.js").ReactDescT;
+    pb: import("../propTypes/types.js").ReactDescT;
+    paddingLeft: import("../propTypes/types.js").ReactDescT;
+    pl: import("../propTypes/types.js").ReactDescT;
+    px: import("../propTypes/types.js").ReactDescT;
+    py: import("../propTypes/types.js").ReactDescT;
+    spaceY: import("../propTypes/types.js").ReactDescT;
+    spaceX: import("../propTypes/types.js").ReactDescT;
+    spaceXReverse: import("../propTypes/types.js").ReactDescT;
+    spaceYReverse: import("../propTypes/types.js").ReactDescT;
+    w: import("../propTypes/types.js").ReactDescT;
+    width: import("../propTypes/types.js").ReactDescT;
+    maxWidth: import("../propTypes/types.js").ReactDescT;
+    maxW: import("../propTypes/types.js").ReactDescT;
+    minWidth: import("../propTypes/types.js").ReactDescT;
+    minW: import("../propTypes/types.js").ReactDescT;
+    h: import("../propTypes/types.js").ReactDescT;
+    height: import("../propTypes/types.js").ReactDescT;
+    maxHeight: import("../propTypes/types.js").ReactDescT;
+    maxH: import("../propTypes/types.js").ReactDescT;
+    minHeight: import("../propTypes/types.js").ReactDescT;
+    minH: import("../propTypes/types.js").ReactDescT;
+    maskSize: import("../propTypes/types.js").ReactDescT;
+    display: import("../propTypes/types.js").ReactDescT;
+    float: import("../propTypes/types.js").ReactDescT;
+    boxSizing: import("../propTypes/types.js").ReactDescT;
+    container: import("../propTypes/types.js").ReactDescT;
+    overflow: import("../propTypes/types.js").ReactDescT;
+    overflowX: import("../propTypes/types.js").ReactDescT;
+    overflowY: import("../propTypes/types.js").ReactDescT;
+    zIndex: import("../propTypes/types.js").ReactDescT;
+    position: import("../propTypes/types.js").ReactDescT;
+    top: import("../propTypes/types.js").ReactDescT;
+    right: import("../propTypes/types.js").ReactDescT;
+    bottom: import("../propTypes/types.js").ReactDescT;
+    left: import("../propTypes/types.js").ReactDescT;
+    visibility: import("../propTypes/types.js").ReactDescT;
+    overscrollBehavior: import("../propTypes/types.js").ReactDescT;
+    objectFit: import("../propTypes/types.js").ReactDescT;
+    color: import("../propTypes/types.js").ReactDescT;
+    bg: import("../propTypes/types.js").ReactDescT;
+    backgroundColor: import("../propTypes/types.js").ReactDescT;
+    border: import("../propTypes/types.js").ReactDescT;
+    borderTop: import("../propTypes/types.js").ReactDescT;
+    borderBottom: import("../propTypes/types.js").ReactDescT;
+    borderRight: import("../propTypes/types.js").ReactDescT;
+    borderLeft: import("../propTypes/types.js").ReactDescT;
+    borderColor: import("../propTypes/types.js").ReactDescT;
+    borderTopColor: import("../propTypes/types.js").ReactDescT;
+    borderBottomColor: import("../propTypes/types.js").ReactDescT;
+    borderRightColor: import("../propTypes/types.js").ReactDescT;
+    borderLeftColor: import("../propTypes/types.js").ReactDescT;
+    borderStyle: import("../propTypes/types.js").ReactDescT;
+    borderTopStyle: import("../propTypes/types.js").ReactDescT;
+    borderBottomStyle: import("../propTypes/types.js").ReactDescT;
+    borderRightStyle: import("../propTypes/types.js").ReactDescT;
+    borderLeftStyle: import("../propTypes/types.js").ReactDescT;
+    borderWidth: import("../propTypes/types.js").ReactDescT;
+    borderTopWidth: import("../propTypes/types.js").ReactDescT;
+    borderBottomWidth: import("../propTypes/types.js").ReactDescT;
+    borderRightWidth: import("../propTypes/types.js").ReactDescT;
+    borderLeftWidth: import("../propTypes/types.js").ReactDescT;
+    borderRadius: import("../propTypes/types.js").ReactDescT;
+    boxShadow: import("../propTypes/types.js").ReactDescT;
+};

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@elliemae/ds-legacy-props-helpers",
+  "version": "1.0.0-rc.1",
+  "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",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "sideEffects": [],
+  "repository": {
+    "type": "git",
+    "url": "https://git.elliemae.io/platform-ui/dimsum-legacy.git"
+  },
+  "engines": {
+    "pnpm": ">=6",
+    "node": ">=16"
+  },
+  "author": "ICE MT",
+  "jestSonar": {
+    "sonar56x": true,
+    "reportPath": "reports",
+    "reportFile": "tests.xml",
+    "indent": 4
+  },
+  "dependencies": {
+    "fast-deep-equal": "~3.1.3",
+    "prop-types": "~15.8.1",
+    "@elliemae/ds-legacy-system": "1.0.0-rc.1"
+  },
+  "devDependencies": {
+    "@elliemae/pui-cli": "~9.0.0-next.31",
+    "@elliemae/ds-legacy-monorepo-devops": "1.0.0-rc.1"
+  },
+  "peerDependencies": {
+    "lodash": "^4.17.21",
+    "react": "~17.0.2",
+    "react-dom": "^17.0.2"
+  },
+  "publishConfig": {
+    "access": "public",
+    "typeSafety": true
+  },
+  "scripts": {
+    "dev": "cross-env NODE_ENV=development node ../../../scripts/build/build.mjs --watch",
+    "test": "pui-cli test --passWithNoTests",
+    "lint": "node ../../../scripts/lint.mjs --fix",
+    "eslint:fix": "eslint --ext='.js,.jsx,.test.js,.ts,.tsx' --fix --config='../../../.eslintrc.js' src/",
+    "dts": "node ../../../scripts/dts.mjs",
+    "dts:withdeps": "pnpm --filter {.}... dts",
+    "build": "cross-env NODE_ENV=production node ../../../scripts/build/build.mjs",
+    "dev:build": "pnpm --filter {.}... build",
+    "dev:install": "pnpm --filter {.}... i --no-lockfile && pnpm run dev:build",
+    "checkDeps": "npm exec ../../util/ds-codemods -- check-missing-packages --projectFolderPath=\"./\" --ignorePackagesGlobPattern=\"\" --ignoreFilesGlobPattern=\"**/test-ables/*,**/tests/*\""
+  }
+}