@razorpay/blade 8.12.1 → 8.14.0

package/build/utils/index.native.d.ts

@@ -1,84 +1,5 @@
-export { default as cloneDeep } from 'lodash/cloneDeep';
-export { default as getIn } from 'lodash/get';
-export { default as isEmpty } from 'lodash/isEmpty';
-export { default as isEqual } from 'lodash/isEqual';
-import React, { MutableRefObject } from 'react';
-import { AccessibilityRole, Platform as Platform$2 } from 'react-native';
-import { EasingFunctionFactory } from 'react-native-reanimated';
-export { default as merge } from 'lodash/merge';
-
-declare const metaAttribute: ({ testID, name, }: {
-    name?: string | undefined;
-    testID?: string | undefined;
-}) => Record<string, string>;
-
-declare const MetaConstants: {
-    readonly Accordion: "accordion";
-    readonly AccordionButton: "accordion-button";
-    readonly AccordionItem: "accordion-item";
-    readonly ActionList: "action-list";
-    readonly ActionListFooter: "action-list-footer";
-    readonly ActionListHeader: "action-list-header";
-    readonly ActionListItem: "action-list-item";
-    readonly ActionListSection: "action-list-section";
-    readonly Alert: "alert";
-    readonly Amount: "amount";
-    readonly Badge: "badge";
-    readonly Box: "box";
-    readonly BaseBox: "base-box";
-    readonly BaseText: "base-text";
-    readonly Button: "button";
-    readonly Checkbox: "checkbox";
-    readonly CheckboxGroup: "checkbox-group";
-    readonly CheckboxLabel: "checkbox-label";
-    readonly Code: "code";
-    readonly Component: "blade-component";
-    readonly Counter: "counter";
-    readonly DropdownOverlay: "dropdown-overlay";
-    readonly Icon: "icon";
-    readonly IconButton: "icon-button";
-    readonly Indicator: "indicator";
-    readonly Link: "link";
-    readonly List: "list";
-    readonly ListItem: "list-item";
-    readonly OTPInput: "otp-input";
-    readonly PasswordInput: "password-input";
-    readonly TextArea: "textarea";
-    readonly TextInput: "textinput";
-    readonly ProgressBar: "progress-bar";
-    readonly Radio: "radio";
-    readonly RadioGroup: "radio-group";
-    readonly RadioLabel: "radio-label";
-    readonly SkipNav: "skipnav";
-    readonly Spinner: "spinner";
-    readonly SelectInput: "select-input";
-    readonly Tooltip: "tooltip";
-    readonly TooltipInteractiveWrapper: "tooltip-interactive-wrapper";
-    readonly BottomSheet: "bottom-sheet";
-    readonly BottomSheetBody: "bottom-sheet-body";
-    readonly BottomSheetHeader: "bottom-sheet-header";
-    readonly BottomSheetFooter: "bottom-sheet-footer";
-    readonly BottomSheetGrabHandle: "bottomsheet-grab-handle";
-    readonly Card: "card";
-    readonly CardBody: "card-body";
-    readonly CardHeader: "card-header";
-    readonly CardFooter: "card-footer";
-    readonly Collapsible: "collapsible";
-    readonly CollapsibleBody: "collapsible-body";
-    readonly CollapsibleButton: "collapsible-button";
-    readonly CollapsibleLink: "collapsible-link";
-    readonly Modal: "modal";
-    readonly ModalBody: "modal-body";
-    readonly ModalHeader: "modal-header";
-    readonly ModalFooter: "modal-footer";
-    readonly ModalBackdrop: "modal-backdrop";
-    readonly ModalScrollOverlay: "modal-scroll-overlay";
-    readonly VisuallyHidden: "visually-hidden";
-    readonly FormLabel: "form-label";
-    readonly Switch: "switch";
-    readonly SwitchLabel: "switch-label";
-    readonly StyledBaseInput: "styled-base-input";
-};
+import { Platform as Platform$2 } from 'react-native';
+import { MutableRefObject } from 'react';
 
 type Breakpoints = Readonly<{
   /**
@@ -199,277 +120,6 @@ declare const getMediaQuery: ({ min, max }: {
 declare type PlatformTypes = 'browser' | 'node' | 'react-native' | 'unknown';
 declare const getPlatformType: () => PlatformTypes;
 
-/**
- * Gets the `componentId` prop of React component if it exists.
- */
-declare const getComponentId: (component: React.ReactNode) => string | null;
-/**
- * Checks if the `component` matches the `componentId`
- */
-declare const isValidAllowedChildren: (component: React.ReactNode, id: string) => boolean;
-
-declare type DeepPartial<T> = {
-    [P in keyof T]?: T[P] extends Record<number | string, unknown> ? DeepPartial<T[P]> : T[P];
-};
-declare const isPartialMatchObjectKeys: <ActualObject>({ objectToMatch, objectToInspect, }: {
-    objectToMatch: DeepPartial<ActualObject>;
-    objectToInspect: ActualObject;
-}) => boolean;
-
-declare type AriaRoles = Exclude<AccessibilityRole, 'header' | 'adjustable' | 'image' | 'none' | 'summary'> | 'alert' | 'alertdialog' | 'application' | 'article' | 'banner' | 'button' | 'cell' | 'checkbox' | 'columnheader' | 'combobox' | 'complementary' | 'contentinfo' | 'definition' | 'dialog' | 'directory' | 'document' | 'feed' | 'figure' | 'form' | 'grid' | 'gridcell' | 'group' | 'heading' | 'img' | 'link' | 'list' | 'listbox' | 'listitem' | 'log' | 'main' | 'marquee' | 'math' | 'menu' | 'menubar' | 'menuitem' | 'menuitemcheckbox' | 'menuitemradio' | 'meter' | 'navigation' | 'none' | 'note' | 'option' | 'presentation' | 'progressbar' | 'radio' | 'radiogroup' | 'region' | 'row' | 'rowgroup' | 'rowheader' | 'scrollbar' | 'search' | 'searchbox' | 'separator' | 'slider' | 'spinbutton' | 'status' | 'switch' | 'tab' | 'table' | 'tablist' | 'tabpanel' | 'term' | 'textbox' | 'timer' | 'toolbar' | 'tooltip' | 'tree' | 'treegrid' | 'treeitem';
-declare type AccessibilityKeys = keyof AriaAttributes;
-declare type AccessibilityProps = AriaAttributes;
-declare type AccessibilityMap = Record<AccessibilityKeys, string>;
-declare type AriaAttributes = {
-    role: AriaRoles;
-    /**
-     * Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
-     */
-    activeDescendant?: string;
-    /**
-     * Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
-     */
-    atomic?: boolean;
-    /**
-     * Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
-     */
-    autoComplete?: 'none' | 'inline' | 'list' | 'both';
-    /**
-     * Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
-     */
-    busy?: boolean;
-    /**
-     * Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
-     * @see aria-pressed @see aria-selected.
-     */
-    checked?: boolean | 'mixed';
-    /**
-     * Defines the total number of columns in a table, grid, or treegrid.
-     * @see aria-colindex.
-     */
-    colCount?: number;
-    /**
-     * Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
-     * @see aria-colcount @see aria-colspan.
-     */
-    colIndex?: number;
-    /**
-     * Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
-     * @see aria-colindex @see aria-rowspan.
-     */
-    colSpan?: number;
-    /**
-     * Identifies the element (or elements) whose contents or presence are controlled by the current element.
-     * @see aria-owns.
-     */
-    controls?: string;
-    /**
-     * Indicates the element that represents the current item within a container or set of related elements.
-     */
-    current?: boolean | 'page' | 'step' | 'location' | 'date' | 'time';
-    /**
-     * Identifies the element (or elements) that describes the object.
-     * @see aria-labelledby
-     */
-    describedBy?: string;
-    /**
-     * Identifies the element that provides a detailed, extended description for the object.
-     * @see aria-describedby.
-     */
-    details?: string;
-    /**
-     * Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
-     * @see aria-hidden @see aria-readonly.
-     */
-    disabled?: boolean;
-    /**
-     * Indicates what functions can be performed when a dragged object is released on the drop target.
-     * @deprecated in ARIA 1.1
-     */
-    dropEffect?: 'none' | 'copy' | 'execute' | 'link' | 'move' | 'popup';
-    /**
-     * Identifies the element that provides an error message for the object.
-     * @see aria-invalid @see aria-describedby.
-     */
-    errorMessage?: string;
-    /**
-     * Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
-     */
-    expanded?: boolean;
-    /**
-     * Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
-     * allows assistive technology to override the general default of reading in document source order.
-     */
-    flowTo?: string;
-    /**
-     * Indicates an element's "grabbed" state in a drag-and-drop operation.
-     * @deprecated in ARIA 1.1
-     */
-    grabbed?: boolean;
-    /**
-     * Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
-     */
-    hasPopup?: boolean | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog';
-    /**
-     * Indicates whether the element is exposed to an accessibility API.
-     * @see aria-disabled.
-     */
-    hidden?: boolean;
-    /**
-     * Indicates the entered value does not conform to the format expected by the application.
-     * @see aria-errormessage.
-     */
-    invalid?: boolean | 'grammar' | 'spelling';
-    /**
-     * Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
-     */
-    keyShortcuts?: string;
-    /**
-     * Defines a string value that labels the current element.
-     * @see aria-labelledby.
-     */
-    label?: string;
-    /**
-     * Identifies the element (or elements) that labels the current element.
-     * @see aria-describedby.
-     */
-    labelledBy?: string;
-    /**
-     * Defines the hierarchical level of an element within a structure.
-     */
-    level?: number;
-    /**
-     * Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
-     */
-    liveRegion?: 'off' | 'assertive' | 'polite';
-    /**
-     * Indicates whether an element is modal when displayed.
-     */
-    modal?: boolean;
-    /**
-     * Indicates whether a text box accepts multiple lines of input or only a single line.
-     */
-    multiline?: boolean;
-    /**
-     * Indicates that the user may select more than one item from the current selectable descendants.
-     */
-    multiSelectable?: boolean;
-    /**
-     * Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
-     */
-    orientation?: 'horizontal' | 'vertical';
-    /**
-     * Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
-     * between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
-     * @see aria-controls.
-     */
-    owns?: string;
-    /**
-     * Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
-     * A hint could be a sample value or a brief description of the expected format.
-     */
-    placeholder?: string;
-    /**
-     * Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
-     * @see aria-setsize.
-     */
-    posInSet?: number;
-    /**
-     * Indicates the current "pressed" state of toggle buttons.
-     * @see aria-checked @see aria-selected.
-     */
-    pressed?: boolean | 'mixed';
-    /**
-     * Indicates that the element is not editable, but is otherwise operable.
-     * @see aria-disabled.
-     */
-    readOnly?: boolean;
-    /**
-     * Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
-     * @see aria-atomic.
-     */
-    relevant?: 'additions' | 'additions removals' | 'additions text' | 'all' | 'removals' | 'removals additions' | 'removals text' | 'text' | 'text additions' | 'text removals';
-    /**
-     * Indicates that user input is required on the element before a form may be submitted.
-     */
-    required?: boolean;
-    /**
-     * Defines a human-readable, author-localized description for the role of an element.
-     */
-    roleDescription?: string;
-    /**
-     * Defines the total number of rows in a table, grid, or treegrid.
-     * @see aria-rowindex.
-     */
-    rowCount?: number;
-    /**
-     * Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
-     * @see aria-rowcount @see aria-rowspan.
-     */
-    rowIndex?: number;
-    /**
-     * Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
-     * @see aria-rowindex @see aria-colspan.
-     */
-    rowSpan?: number;
-    /**
-     * Indicates the current "selected" state of various widgets.
-     * @see aria-checked @see aria-pressed.
-     */
-    selected?: boolean;
-    /**
-     * Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
-     * @see aria-posinset.
-     */
-    setSize?: number;
-    /**
-     * Indicates if items in a table or grid are sorted in ascending or descending order.
-     */
-    sort?: 'none' | 'ascending' | 'descending' | 'other';
-    /**
-     * Defines the maximum allowed value for a range widget.
-     */
-    valueMax?: number;
-    /**
-     * Defines the minimum allowed value for a range widget.
-     */
-    valueMin?: number;
-    /**
-     * Defines the current value for a range widget.
-     * @see aria-valuetext.
-     */
-    valueNow?: number;
-    /**
-     * Defines the human readable text alternative of aria-valuenow for a range widget.
-     */
-    valueText?: string;
-};
-
-declare const makeAccessible: (props: Partial<AccessibilityProps>) => Record<string, unknown>;
-
-declare const makeBezier: (x1: number, y1: number, x2: number, y2: number) => EasingFunctionFactory;
-
-declare function makeBorderSize<T extends number>(size: T): `${T}px`;
-declare function makeBorderSize<T extends string>(size: T): T;
-
-declare type MakeMotionTime<Value extends number> = Platform$1.Select<{
-    native: number;
-    web: `${Value}ms`;
-}>;
-
-declare const makeMotionTime: <T extends number>(time: T) => MakeMotionTime<T>;
-
-declare type MakeSize<T extends number> = `${T}px`;
-declare const makeSize: <T extends number>(size: T) => `${T}px`;
-
-declare const makeSpace: <T extends number>(size: T) => `${T}px`;
-
-declare const makeTypographySize: <T extends number>(size: T) => `${T}px`;
-
-declare const setupMatchMediaMock: (customArgs?: {}) => void;
-
-declare const toTitleCase: (inputString: string) => string;
-
 declare const deviceType: {
     readonly desktop: "desktop";
     readonly mobile: "mobile";
@@ -490,12 +140,6 @@ declare type UseColorScheme = {
 };
 declare const useColorScheme: (initialColorScheme?: ColorSchemeNamesInput) => UseColorScheme;
 
-/**
- * a type-safe version of the `usePrevious` hook described here:
- * @see {@link https://reactjs.org/docs/hooks-faq.html#how-to-get-the-previous-props-or-state}
- */
-declare function usePrevious<T>(value: T): MutableRefObject<T | undefined>['current'];
-
 declare const isReactNative: () => boolean;
 
 declare const getOS: () => typeof Platform$2.OS;
@@ -564,44 +208,33 @@ declare const castNativeType: <T>(value: T) => Extract<T, {
     __brand__?: "platform-native" | "platform-all" | undefined;
 }>;
 
+declare function makeBorderSize<T extends number>(size: T): `${T}px`;
+declare function makeBorderSize<T extends string>(size: T): T;
+
+declare type MakeMotionTime<Value extends number> = Platform$1.Select<{
+    native: number;
+    web: `${Value}ms`;
+}>;
+
+declare const makeMotionTime: <T extends number>(time: T) => MakeMotionTime<T>;
+
+declare const makeSpace: <T extends number>(size: T) => `${T}px`;
+
+declare const makeTypographySize: <T extends number>(size: T) => `${T}px`;
+
+declare type MakeSize<T extends number> = `${T}px`;
+declare const makeSize: <T extends number>(size: T) => `${T}px`;
+
 /**
- * Do you want to define `displayName` or `componentId` on your component? Use this instead to make sure treeshaking doesn't break.
- *
- * ## Usage
- *
- * ### ❌ Incorrect Code (Breaks treeshaking)
- *
- * ```ts
- * const _MyComponent = () => {};
- * const MyComponent = React.forwardRef(_MyComponent);
- * const MyComponent.displayName = 'MyComponent'; // this breaks treeshaking
- *
- * export { MyComponent }
- * ```
- *
- * ### ✅ Correct Code (No Side-Effects. Treeshaking continues to work)
- *
- * ```ts
- * const _MyComponent = () => {};
- * const MyComponentWithRef = React.forwardRef(_MyComponent);
- * const MyComponent = assignWithoutSideEffects(
- *  MyComponentWithRef,
- *  { displayName: 'MyComponent' }
- * );
- *
- * export { MyComponent }
- * ```
- *
- * Checkout other components like [Button.tsx](../../components/Button/Button/Button.tsx), [SelectInput.tsx](../../components/Input/SelectInput/SelectInput.tsx) for example.
- *
- * _Note: You don't have to add PURE comment to this function as it is added during build-time by our `manualPureFunctions` babel plugin_
+ * @deprecated This utility will be deprecated in subsequent version.
  */
-declare const assignWithoutSideEffects: <T extends {}>(component: T, sourceObj: {
-    displayName?: string;
-    componentId?: string;
-}) => T;
+declare const toTitleCase: (inputString: string) => string;
 
-declare type shouldForwardProp = <O extends object>(prop: keyof O, defaultValidatorFn: (prop: keyof O) => boolean) => boolean;
-declare const omitPropsFromHTML: shouldForwardProp;
+/**
+ * a type-safe version of the `usePrevious` hook described here:
+ * @see {@link https://reactjs.org/docs/hooks-faq.html#how-to-get-the-previous-props-or-state}
+ * @deprecated This utility will be deprecated in subsequent version.
+ */
+declare function usePrevious<T>(value: T): MutableRefObject<T | undefined>['current'];
 
-export { AccessibilityKeys, AccessibilityMap, AccessibilityProps, AriaAttributes, AriaRoles, DeepPartial, MakeSize, MetaConstants, Platform, PlatformTypes, UseColorScheme, assignWithoutSideEffects, castNativeType, castWebType, getColorScheme, getComponentId, getMediaQuery, getOS, getPlatformType, isAndroid, isPartialMatchObjectKeys, isReactNative, isValidAllowedChildren, makeAccessible, makeBezier, makeBorderSize, makeMotionTime, makeSize, makeSpace, makeTypographySize, metaAttribute, omitPropsFromHTML, setupMatchMediaMock, toTitleCase, useBreakpoint, useColorScheme, usePrevious };
+export { MakeSize, Platform, PlatformTypes, UseColorScheme, castNativeType, castWebType, getColorScheme, getMediaQuery, getOS, getPlatformType, isAndroid, isReactNative, makeBorderSize, makeMotionTime, makeSize, makeSpace, makeTypographySize, toTitleCase, useBreakpoint, useColorScheme, usePrevious };