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

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

@@ -0,0 +1 @@
+export * from './useMemoMergePropsWithDefault';

package/dist/types/defaultProps/useMemoMergePropsWithDefault.d.ts

@@ -0,0 +1 @@
+export declare const useMemoMergePropsWithDefault: <T = Record<string, any>>(props: Partial<T>, defaultProps: Partial<T>, compare?: (a: any, b: any) => boolean) => T;

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

@@ -0,0 +1,2 @@
+export declare const getAriaProps: (props: Record<string, unknown>) => Record<string, unknown>;
+export declare const getDataProps: (props: Record<string, unknown>) => Record<string, unknown>;

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

@@ -0,0 +1,3 @@
+import { AriaAttributes, DOMAttributes, HTMLAttributes } from 'react';
+export declare type GlobalAttributes<T = true> = Record<keyof (AriaAttributes & DOMAttributes<Element> & HTMLAttributes<Element>), T>;
+export declare const globalAttributes: GlobalAttributes<true>;

package/dist/types/globalProps/globalAttributesPropTypes.d.ts

@@ -0,0 +1,363 @@
+export declare const globalAttributesPropTypes: {
+    'aria-*': any;
+    'on-*': any;
+    'data-*': any;
+    'all HTML attributes': any;
+    about: any;
+    accept: any;
+    acceptCharset: any;
+    accessKey: any;
+    action: any;
+    allowFullScreen: any;
+    allowTransparency: any;
+    alt: any;
+    'aria-activedescendant': any;
+    'aria-atomic': any;
+    'aria-autocomplete': any;
+    'aria-busy': any;
+    'aria-checked': any;
+    'aria-colcount': any;
+    'aria-colindex': any;
+    'aria-colspan': any;
+    'aria-controls': any;
+    'aria-current': any;
+    'aria-describedby': any;
+    'aria-details': any;
+    'aria-disabled': any;
+    'aria-dropeffect': any;
+    'aria-errormessage': any;
+    'aria-expanded': any;
+    'aria-flowto': any;
+    'aria-grabbed': any;
+    'aria-haspopup': any;
+    'aria-hidden': any;
+    'aria-invalid': any;
+    'aria-keyshortcuts': any;
+    'aria-label': any;
+    'aria-labelledby': any;
+    'aria-level': any;
+    'aria-live': any;
+    'aria-modal': any;
+    'aria-multiline': any;
+    'aria-multiselectable': any;
+    'aria-orientation': any;
+    'aria-owns': any;
+    'aria-placeholder': any;
+    'aria-posinset': any;
+    'aria-pressed': any;
+    'aria-readonly': any;
+    'aria-relevant': any;
+    'aria-required': any;
+    'aria-roledescription': any;
+    'aria-rowcount': any;
+    'aria-rowindex': any;
+    'aria-rowspan': any;
+    'aria-selected': any;
+    'aria-setsize': any;
+    'aria-sort': any;
+    'aria-valuemax': any;
+    'aria-valuemin': any;
+    'aria-valuenow': any;
+    'aria-valuetext': any;
+    as: any;
+    async: any;
+    autoCapitalize: any;
+    autoComplete: any;
+    autoCorrect: any;
+    autoFocus: any;
+    autoPlay: any;
+    autoSave: any;
+    capture: any;
+    cellPadding: any;
+    cellSpacing: any;
+    challenge: any;
+    charSet: any;
+    checked: any;
+    cite: any;
+    classID: any;
+    className: any;
+    color: any;
+    cols: any;
+    colSpan: any;
+    content: any;
+    contentEditable: any;
+    contextMenu: any;
+    controls: any;
+    coords: any;
+    crossOrigin: any;
+    data: any;
+    datatype: any;
+    dateTime: any;
+    default: any;
+    defaultChecked: any;
+    defaultValue: any;
+    defer: any;
+    dir: any;
+    disabled: any;
+    download: any;
+    draggable: any;
+    encType: any;
+    form: any;
+    formAction: any;
+    formEncType: any;
+    formMethod: any;
+    formNoValidate: any;
+    formTarget: any;
+    frameBorder: any;
+    headers: any;
+    height: any;
+    hidden: any;
+    high: any;
+    href: any;
+    hrefLang: any;
+    htmlFor: any;
+    httpEquiv: any;
+    id: any;
+    inlist: any;
+    inputMode: any;
+    integrity: any;
+    is: any;
+    itemID: any;
+    itemProp: any;
+    itemRef: any;
+    itemScope: any;
+    itemType: any;
+    keyParams: any;
+    keyType: any;
+    kind: any;
+    label: any;
+    lang: any;
+    list: any;
+    loop: any;
+    low: any;
+    manifest: any;
+    marginHeight: any;
+    marginWidth: any;
+    max: any;
+    maxLength: any;
+    media: any;
+    mediaGroup: any;
+    method: any;
+    min: any;
+    minLength: any;
+    multiple: any;
+    muted: any;
+    name: any;
+    nonce: any;
+    noValidate: any;
+    onAbort: any;
+    onAbortCapture: any;
+    onAnimationEnd: any;
+    onAnimationEndCapture: any;
+    onAnimationIteration: any;
+    onAnimationIterationCapture: any;
+    onAnimationStart: any;
+    onAnimationStartCapture: any;
+    onAuxClick: any;
+    onAuxClickCapture: any;
+    onBeforeInput: any;
+    onBeforeInputCapture: any;
+    onBlur: any;
+    onBlurCapture: any;
+    onCanPlay: any;
+    onCanPlayCapture: any;
+    onCanPlayThrough: any;
+    onCanPlayThroughCapture: any;
+    onChange: any;
+    onChangeCapture: any;
+    onClick: any;
+    onClickCapture: any;
+    onCompositionEnd: any;
+    onCompositionEndCapture: any;
+    onCompositionStart: any;
+    onCompositionStartCapture: any;
+    onCompositionUpdate: any;
+    onCompositionUpdateCapture: any;
+    onContextMenu: any;
+    onContextMenuCapture: any;
+    onCopy: any;
+    onCopyCapture: any;
+    onCut: any;
+    onCutCapture: any;
+    onDoubleClick: any;
+    onDoubleClickCapture: any;
+    onDrag: any;
+    onDragCapture: any;
+    onDragEnd: any;
+    onDragEndCapture: any;
+    onDragEnter: any;
+    onDragEnterCapture: any;
+    onDragExit: any;
+    onDragExitCapture: any;
+    onDragLeave: any;
+    onDragLeaveCapture: any;
+    onDragOver: any;
+    onDragOverCapture: any;
+    onDragStart: any;
+    onDragStartCapture: any;
+    onDrop: any;
+    onDropCapture: any;
+    onDurationChange: any;
+    onDurationChangeCapture: any;
+    onEmptied: any;
+    onEmptiedCapture: any;
+    onEncrypted: any;
+    onEncryptedCapture: any;
+    onEnded: any;
+    onEndedCapture: any;
+    onError: any;
+    onErrorCapture: any;
+    onFocus: any;
+    onFocusCapture: any;
+    onGotPointerCapture: any;
+    onGotPointerCaptureCapture: any;
+    onInput: any;
+    onInputCapture: any;
+    onInvalid: any;
+    onInvalidCapture: any;
+    onKeyDown: any;
+    onKeyDownCapture: any;
+    onKeyPress: any;
+    onKeyPressCapture: any;
+    onKeyUp: any;
+    onKeyUpCapture: any;
+    onLoad: any;
+    onLoadCapture: any;
+    onLoadedData: any;
+    onLoadedDataCapture: any;
+    onLoadedMetadata: any;
+    onLoadedMetadataCapture: any;
+    onLoadStart: any;
+    onLoadStartCapture: any;
+    onLostPointerCapture: any;
+    onLostPointerCaptureCapture: any;
+    onMouseDown: any;
+    onMouseDownCapture: any;
+    onMouseEnter: any;
+    onMouseLeave: any;
+    onMouseMove: any;
+    onMouseMoveCapture: any;
+    onMouseOut: any;
+    onMouseOutCapture: any;
+    onMouseOver: any;
+    onMouseOverCapture: any;
+    onMouseUp: any;
+    onMouseUpCapture: any;
+    onPaste: any;
+    onPasteCapture: any;
+    onPause: any;
+    onPauseCapture: any;
+    onPlay: any;
+    onPlayCapture: any;
+    onPlaying: any;
+    onPlayingCapture: any;
+    onPointerCancel: any;
+    onPointerCancelCapture: any;
+    onPointerDown: any;
+    onPointerDownCapture: any;
+    onPointerEnter: any;
+    onPointerEnterCapture: any;
+    onPointerLeave: any;
+    onPointerLeaveCapture: any;
+    onPointerMove: any;
+    onPointerMoveCapture: any;
+    onPointerOut: any;
+    onPointerOutCapture: any;
+    onPointerOver: any;
+    onPointerOverCapture: any;
+    onPointerUp: any;
+    onPointerUpCapture: any;
+    onProgress: any;
+    onProgressCapture: any;
+    onRateChange: any;
+    onRateChangeCapture: any;
+    onReset: any;
+    onResetCapture: any;
+    onScroll: any;
+    onScrollCapture: any;
+    onSeeked: any;
+    onSeekedCapture: any;
+    onSeeking: any;
+    onSeekingCapture: any;
+    onSelect: any;
+    onSelectCapture: any;
+    onStalled: any;
+    onStalledCapture: any;
+    onSubmit: any;
+    onSubmitCapture: any;
+    onSuspend: any;
+    onSuspendCapture: any;
+    onTimeUpdate: any;
+    onTimeUpdateCapture: any;
+    onTouchCancel: any;
+    onTouchCancelCapture: any;
+    onTouchEnd: any;
+    onTouchEndCapture: any;
+    onTouchMove: any;
+    onTouchMoveCapture: any;
+    onTouchStart: any;
+    onTouchStartCapture: any;
+    onTransitionEnd: any;
+    onTransitionEndCapture: any;
+    onVolumeChange: any;
+    onVolumeChangeCapture: any;
+    onWaiting: any;
+    onWaitingCapture: any;
+    onWheel: any;
+    onWheelCapture: any;
+    open: any;
+    optimum: any;
+    pattern: any;
+    placeholder: any;
+    playsInline: any;
+    poster: any;
+    prefix: any;
+    preload: any;
+    property: any;
+    radioGroup: any;
+    readOnly: any;
+    rel: any;
+    required: any;
+    resource: any;
+    results: any;
+    reversed: any;
+    role: any;
+    rows: any;
+    rowSpan: any;
+    sandbox: any;
+    scope: any;
+    scoped: any;
+    scrolling: any;
+    seamless: any;
+    security: any;
+    selected: any;
+    shape: any;
+    size: any;
+    sizes: any;
+    slot: any;
+    span: any;
+    spellCheck: any;
+    src: any;
+    srcDoc: any;
+    srcLang: any;
+    srcSet: any;
+    start: any;
+    step: any;
+    style: any;
+    summary: any;
+    suppressContentEditableWarning: any;
+    suppressHydrationWarning: any;
+    tabIndex: any;
+    target: any;
+    title: any;
+    translate: any;
+    type: any;
+    typeof: any;
+    unselectable: any;
+    useMap: any;
+    value: any;
+    vocab: any;
+    width: any;
+    wmode: any;
+    wrap: any;
+};

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

@@ -0,0 +1,2 @@
+export * from './useGetGlobalAttributes';
+export * from './globalAttributesPropTypes';

package/dist/types/globalProps/useGetGlobalAttributes.d.ts

@@ -0,0 +1,5 @@
+import { AriaAttributes, DOMAttributes, HTMLAttributes } from 'react';
+import { GlobalAttributes } from './constants';
+declare type PropsWithAttributes<T extends Record<string, unknown>> = T & AriaAttributes & DOMAttributes<Element> & HTMLAttributes<Element>;
+export declare const useGetGlobalAttributes: <T extends Record<string, unknown>>(props: PropsWithAttributes<T>, overrides: GlobalAttributes<(...args: unknown[]) => unknown>) => AriaAttributes & DOMAttributes<Element> & HTMLAttributes<Element>;
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from './defaultProps';
+export * from './validation';
+export * from './getProps';
+export * from './globalProps';
+export * from './propTypes';

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

@@ -0,0 +1,3 @@
+import { PropTypesObj } from './types';
+declare const PropTypes: PropTypesObj;
+export default PropTypes;

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

@@ -0,0 +1,2 @@
+import { Validator } from 'prop-types';
+export declare const tupleValidator: (tupleShape: Validator<unknown>[]) => Validator<unknown>;

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

@@ -0,0 +1,3 @@
+import React from 'react';
+import { DocumentedReactComponent } from './types';
+export default function describe<C>(ComponentInstance: React.ComponentType<C>): DocumentedReactComponent<C>;

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

@@ -0,0 +1,3 @@
+import { Requireable } from 'prop-types';
+import { ReactDescT } from './types';
+export declare const convertPropType: (propType: ReactDescT) => Requireable<unknown>;

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

@@ -0,0 +1,9 @@
+import { AllPropTypes, ParametizedPropTypes, ReactDescT } from './types';
+export declare const hasArguments: (propType: ReactDescT, realPropType: AllPropTypes) => realPropType is ParametizedPropTypes;
+export declare const isOneOfType: (propType: ReactDescT, realPropType: AllPropTypes) => realPropType is typeof import("prop-types").oneOfType;
+export declare const isArrayOf: (propType: ReactDescT, realPropType: AllPropTypes) => realPropType is typeof import("prop-types").arrayOf;
+export declare const isShape: (propType: ReactDescT, realPropType: AllPropTypes) => realPropType is typeof import("prop-types").shape;
+export declare const isInstanceOf: (propType: ReactDescT, realPropType: AllPropTypes) => realPropType is typeof import("prop-types").instanceOf;
+export declare const isOneOf: (propType: ReactDescT, realPropType: AllPropTypes) => realPropType is typeof import("prop-types").oneOf;
+export declare const isObjectOf: (propType: ReactDescT, realPropType: AllPropTypes) => realPropType is typeof import("prop-types").objectOf;
+export declare const isExact: (propType: ReactDescT, realPropType: AllPropTypes) => realPropType is typeof import("prop-types").exact;

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

@@ -0,0 +1,3 @@
+import PropTypes from './PropTypes';
+import describe from './describe';
+export { describe, PropTypes };

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

@@ -0,0 +1,3 @@
+import React from 'react';
+import { ComponentDocumentation, TypescriptDocumentation } from './types';
+export default function descToTypescript<C>(component: React.ComponentType<C>, reactDesc: ComponentDocumentation): TypescriptDocumentation;

package/dist/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: unknown;
+    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/dist/types/tests/globalProps/TestComponent.d.ts

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

package/dist/types/tests/globalProps/globalAttributes.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/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/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: any;

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

@@ -0,0 +1 @@
+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,3 @@
+export * from './validator';
+export * from './errorTemplates';
+export * from './typescriptValidator';

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-props-helpers",
-  "version": "2.3.0-alpha.8",
+  "version": "2.3.0-alpha.9",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Props Helpers",
   "files": [