@devtron-labs/devtron-fe-common-lib 0.0.63-beta-1 → 0.0.63-beta-4

package/dist/Common/Policy.Types.d.ts

@@ -1,56 +1,56 @@
-import { VariableType } from './CIPipeline.Types';
-import { ResponseType } from './Types';
-export declare enum ApplyPolicyToStage {
-    PRE_CI = "PRE_CI",
-    POST_CI = "POST_CI",
-    PRE_OR_POST_CI = "PRE_OR_POST_CI"
-}
-export declare enum PluginRequiredStage {
-    PRE_CI = "preBuildStage",
-    POST_CI = "postBuildStage",
-    PRE_OR_POST_CI = "PRE_OR_POST_CI"
-}
-export interface DefinitionSourceType {
-    projectName: string;
-    isDueToProductionEnvironment: boolean;
-    isDueToLinkedPipeline: boolean;
-    policyName: string;
-    appName?: string;
-    clusterName?: string;
-    environmentName?: string;
-    branchNames?: string[];
-    ciPipelineName?: string;
-}
-export interface MandatoryPluginDetailType {
-    id: number;
-    icon: string;
-    name: string;
-    description?: string;
-    requiredIn: PluginRequiredStage;
-    applied?: boolean;
-    inputVariables?: VariableType[];
-    outputVariables?: VariableType[];
-    definitionSources?: DefinitionSourceType[];
-}
-export interface MandatoryPluginDataType {
-    pluginData: MandatoryPluginDetailType[];
-    isValidPre: boolean;
-    isValidPost: boolean;
-}
-export declare enum ConsequenceAction {
-    BLOCK = "BLOCK",
-    ALLOW_UNTIL_TIME = "ALLOW_UNTIL_TIME",
-    ALLOW_FOREVER = "ALLOW_FOREVER"
-}
-export interface ConsequenceType {
-    action: ConsequenceAction;
-    metadataField: string;
-}
-export interface BlockedStateData {
-    isOffendingMandatoryPlugin: boolean;
-    isCITriggerBlocked: boolean;
-    ciBlockState: ConsequenceType;
-}
-export interface GetBlockedStateResponse extends ResponseType {
-    result?: BlockedStateData;
-}
+import { VariableType } from "./CIPipeline.Types";
+import { ResponseType } from "./Types";
+export declare enum ApplyPolicyToStage {
+    PRE_CI = "PRE_CI",
+    POST_CI = "POST_CI",
+    PRE_OR_POST_CI = "PRE_OR_POST_CI"
+}
+export declare enum PluginRequiredStage {
+    PRE_CI = "preBuildStage",
+    POST_CI = "postBuildStage",
+    PRE_OR_POST_CI = "PRE_OR_POST_CI"
+}
+export interface DefinitionSourceType {
+    projectName: string;
+    isDueToProductionEnvironment: boolean;
+    isDueToLinkedPipeline: boolean;
+    policyName: string;
+    appName?: string;
+    clusterName?: string;
+    environmentName?: string;
+    branchNames?: string[];
+    ciPipelineName?: string;
+}
+export interface MandatoryPluginDetailType {
+    id: number;
+    icon: string;
+    name: string;
+    description?: string;
+    requiredIn: PluginRequiredStage;
+    applied?: boolean;
+    inputVariables?: VariableType[];
+    outputVariables?: VariableType[];
+    definitionSources?: DefinitionSourceType[];
+}
+export interface MandatoryPluginDataType {
+    pluginData: MandatoryPluginDetailType[];
+    isValidPre: boolean;
+    isValidPost: boolean;
+}
+export declare enum ConsequenceAction {
+    BLOCK = "BLOCK",
+    ALLOW_UNTIL_TIME = "ALLOW_UNTIL_TIME",
+    ALLOW_FOREVER = "ALLOW_FOREVER"
+}
+export interface ConsequenceType {
+    action: ConsequenceAction;
+    metadataField: string;
+}
+export interface BlockedStateData {
+    isOffendingMandatoryPlugin: boolean;
+    isCITriggerBlocked: boolean;
+    ciBlockState: ConsequenceType;
+}
+export interface GetBlockedStateResponse extends ResponseType {
+    result?: BlockedStateData;
+}

package/dist/Common/PopupMenu.d.ts

@@ -1,7 +1,8 @@
-import { PopupMenuBodyType, PopupMenuButtonType, PopupMenuType } from './Types';
-declare const PopupMenu: {
-    ({ children, onToggleCallback, autoClose, autoPosition, }: PopupMenuType): any;
-    Button: ({ children, disabled, rootClassName, tabIndex, onHover, isKebab, dataTestId, }: PopupMenuButtonType) => JSX.Element;
-    Body: ({ children, rootClassName, style, autoWidth, preventWheelDisable, noBackDrop, }: PopupMenuBodyType) => JSX.Element;
-};
-export default PopupMenu;
+/// <reference types="react" />
+import { PopupMenuBodyType, PopupMenuButtonType, PopupMenuType } from './Types';
+declare function PopupMenu({ children, onToggleCallback, autoClose, autoPosition, }: PopupMenuType): any;
+declare namespace PopupMenu {
+    var Button: ({ children, disabled, rootClassName, tabIndex, onHover, isKebab, dataTestId, }: PopupMenuButtonType) => JSX.Element;
+    var Body: ({ children, rootClassName, style, autoWidth, preventWheelDisable, noBackDrop, }: PopupMenuBodyType) => JSX.Element;
+}
+export default PopupMenu;

package/dist/Common/Progressing.d.ts

@@ -1,3 +1,4 @@
-import { ProgressingProps } from './Types';
-export declare const Progressing: ({ pageLoader, size, theme, styles, fillColor }: ProgressingProps) => JSX.Element;
-export declare const DetailsProgressing: ({ loadingText, size, fullHeight, styles, fillColor, children, }: ProgressingProps) => JSX.Element;
+/// <reference types="react" />
+import { ProgressingProps } from './Types';
+export declare function Progressing({ pageLoader, size, theme, styles, fillColor }: ProgressingProps): JSX.Element;
+export declare function DetailsProgressing({ loadingText, size, fullHeight, styles, fillColor, children, }: ProgressingProps): JSX.Element;

package/dist/Common/RJSF/Form.d.ts

@@ -1,2 +1,4 @@
-import { FormProps } from './types';
-export declare const RJSFForm: (props: FormProps) => JSX.Element;
+/// <reference types="react" />
+import { FormProps } from './types';
+import './rjsfForm.scss';
+export declare const RJSFForm: (props: FormProps) => JSX.Element;

package/dist/Common/RJSF/common/FieldRow.d.ts

@@ -1,5 +1,6 @@
-import { FieldRowProps } from './types';
-import { DO_NOT_SHOW_LABEL } from '../constants';
-export declare const FieldRowWithLabel: ({ showLabel, label, required, children, id, shouldAlignCenter, }: Omit<FieldRowProps, "label"> & {
-    label: FieldRowProps['label'] | typeof DO_NOT_SHOW_LABEL;
-}) => JSX.Element;
+/// <reference types="react" />
+import { FieldRowProps } from './types';
+import { DO_NOT_SHOW_LABEL } from '../constants';
+export declare const FieldRowWithLabel: ({ showLabel, label, required, children, id, shouldAlignCenter, }: Omit<FieldRowProps, "label"> & {
+    label: FieldRowProps['label'] | typeof DO_NOT_SHOW_LABEL;
+}) => JSX.Element;

package/dist/Common/RJSF/common/types.d.ts

@@ -1,8 +1,8 @@
-import { FieldTemplateProps } from '@rjsf/utils';
-export interface FieldRowProps extends Pick<FieldTemplateProps, 'children' | 'label' | 'required' | 'id'> {
-    showLabel?: boolean;
-    /**
-     * @default true
-     */
-    shouldAlignCenter?: boolean;
-}
+import { FieldTemplateProps } from '@rjsf/utils';
+export interface FieldRowProps extends Pick<FieldTemplateProps, 'children' | 'label' | 'required' | 'id'> {
+    showLabel?: boolean;
+    /**
+     * @default true
+     */
+    shouldAlignCenter?: boolean;
+}

package/dist/Common/RJSF/config.d.ts

@@ -1,4 +1,4 @@
-import { RegistryWidgetsType } from '@rjsf/utils';
-import { FormProps } from './types';
-export declare const widgets: RegistryWidgetsType;
-export declare const templates: FormProps['templates'];
+import { RegistryWidgetsType } from '@rjsf/utils';
+import { FormProps } from './types';
+export declare const widgets: RegistryWidgetsType;
+export declare const templates: FormProps['templates'];

package/dist/Common/RJSF/constants.d.ts

@@ -1,7 +1,7 @@
-export declare const PLACEHOLDERS: {
-    SELECT: string;
-    INPUT: string;
-    OBJECT_KEY: string;
-};
-export declare const DEFAULT_FIELD_TITLE = "Key not available";
-export declare const DO_NOT_SHOW_LABEL: unique symbol;
+export declare const PLACEHOLDERS: {
+    SELECT: string;
+    INPUT: string;
+    OBJECT_KEY: string;
+};
+export declare const DEFAULT_FIELD_TITLE = "Key not available";
+export declare const DO_NOT_SHOW_LABEL: unique symbol;

package/dist/Common/RJSF/index.d.ts

@@ -1,3 +1,3 @@
-export { RJSFForm } from './Form';
-export * from './types';
-export { getInferredTypeFromValueType, getRedirectionProps } from './utils';
+export { RJSFForm } from './Form';
+export * from './types';
+export { getInferredTypeFromValueType, getRedirectionProps } from './utils';

package/dist/Common/RJSF/templates/ArrayFieldItemTemplate.d.ts

@@ -1,2 +1,3 @@
-import { ArrayFieldTemplateItemType } from '@rjsf/utils';
-export declare const ArrayFieldItemTemplate: ({ children, className, disabled, hasToolbar, hasRemove, index, onDropIndexClick, readonly, registry, uiSchema, }: ArrayFieldTemplateItemType) => JSX.Element;
+/// <reference types="react" />
+import { ArrayFieldTemplateItemType } from '@rjsf/utils';
+export declare const ArrayFieldItemTemplate: ({ children, className, disabled, hasToolbar, hasRemove, index, onDropIndexClick, readonly, registry, uiSchema, }: ArrayFieldTemplateItemType) => JSX.Element;

package/dist/Common/RJSF/templates/ArrayFieldTemplate.d.ts

@@ -1,2 +1,3 @@
-import { ArrayFieldTemplateProps } from '@rjsf/utils';
-export declare const ArrayFieldTemplate: ({ canAdd, className, disabled, idSchema, uiSchema, items, onAddClick, readonly, registry, required, title, }: ArrayFieldTemplateProps) => JSX.Element;
+/// <reference types="react" />
+import { ArrayFieldTemplateProps } from '@rjsf/utils';
+export declare const ArrayFieldTemplate: ({ canAdd, className, disabled, idSchema, uiSchema, items, onAddClick, readonly, registry, required, title, }: ArrayFieldTemplateProps) => JSX.Element;

package/dist/Common/RJSF/templates/BaseInput.d.ts

@@ -1,2 +1,3 @@
-import { BaseInputTemplateProps } from '@rjsf/utils';
-export declare const BaseInput: ({ placeholder, ...props }: BaseInputTemplateProps) => JSX.Element;
+/// <reference types="react" />
+import { BaseInputTemplateProps } from '@rjsf/utils';
+export declare const BaseInput: ({ placeholder, ...props }: BaseInputTemplateProps) => JSX.Element;

package/dist/Common/RJSF/templates/ButtonTemplates/AddButton.d.ts

@@ -1,2 +1,3 @@
-import { IconButtonProps } from '@rjsf/utils';
-export declare const AddButton: ({ icon, iconType, registry, uiSchema, ...props }: IconButtonProps) => JSX.Element;
+/// <reference types="react" />
+import { IconButtonProps } from '@rjsf/utils';
+export declare const AddButton: ({ icon, iconType, registry, uiSchema, ...props }: IconButtonProps) => JSX.Element;

package/dist/Common/RJSF/templates/ButtonTemplates/RemoveButton.d.ts

@@ -1,2 +1,3 @@
-import { IconButtonProps } from '@rjsf/utils';
-export declare const RemoveButton: ({ icon, iconType, registry, uiSchema, ...props }: IconButtonProps) => JSX.Element;
+/// <reference types="react" />
+import { IconButtonProps } from '@rjsf/utils';
+export declare const RemoveButton: ({ icon, iconType, registry, uiSchema, ...props }: IconButtonProps) => JSX.Element;

package/dist/Common/RJSF/templates/ButtonTemplates/SubmitButton.d.ts

@@ -1,2 +1,3 @@
-import { SubmitButtonProps } from '@rjsf/utils';
-export declare const SubmitButton: ({ uiSchema }: SubmitButtonProps) => JSX.Element;
+/// <reference types="react" />
+import { SubmitButtonProps } from '@rjsf/utils';
+export declare const SubmitButton: ({ uiSchema }: SubmitButtonProps) => JSX.Element;

package/dist/Common/RJSF/templates/ButtonTemplates/index.d.ts

@@ -1,3 +1,3 @@
-export { AddButton } from './AddButton';
-export { RemoveButton } from './RemoveButton';
-export { SubmitButton } from './SubmitButton';
+export { AddButton } from './AddButton';
+export { RemoveButton } from './RemoveButton';
+export { SubmitButton } from './SubmitButton';

package/dist/Common/RJSF/templates/Description.d.ts

@@ -1,2 +1,3 @@
-import { DescriptionFieldProps } from '@rjsf/utils';
-export declare const Description: ({ id, description }: DescriptionFieldProps) => JSX.Element;
+/// <reference types="react" />
+import { DescriptionFieldProps } from '@rjsf/utils';
+export declare const Description: ({ id, description }: DescriptionFieldProps) => JSX.Element;

package/dist/Common/RJSF/templates/Field.d.ts

@@ -1,2 +1,3 @@
-import { FieldTemplateProps } from '@rjsf/utils';
-export declare const Field: (props: FieldTemplateProps) => JSX.Element;
+/// <reference types="react" />
+import { FieldTemplateProps } from '@rjsf/utils';
+export declare const Field: (props: FieldTemplateProps) => JSX.Element;

package/dist/Common/RJSF/templates/FieldErrorTemplate.d.ts

@@ -1,2 +1,3 @@
-import { FieldErrorProps } from '@rjsf/utils';
-export declare const FieldErrorTemplate: ({ errors, idSchema }: FieldErrorProps) => JSX.Element;
+/// <reference types="react" />
+import { FieldErrorProps } from '@rjsf/utils';
+export declare const FieldErrorTemplate: ({ errors, idSchema }: FieldErrorProps) => JSX.Element;

package/dist/Common/RJSF/templates/ObjectFieldTemplate.d.ts

@@ -1,2 +1,3 @@
-import { ObjectFieldTemplateProps } from '@rjsf/utils';
-export declare const ObjectFieldTemplate: (props: ObjectFieldTemplateProps) => JSX.Element;
+/// <reference types="react" />
+import { ObjectFieldTemplateProps } from '@rjsf/utils';
+export declare const ObjectFieldTemplate: (props: ObjectFieldTemplateProps) => JSX.Element;

package/dist/Common/RJSF/templates/TitleField.d.ts

@@ -1,2 +1,3 @@
-import { TitleFieldProps } from '@rjsf/utils';
-export declare const TitleField: ({ id, title, required }: TitleFieldProps) => JSX.Element;
+/// <reference types="react" />
+import { TitleFieldProps } from '@rjsf/utils';
+export declare const TitleField: ({ id, title, required }: TitleFieldProps) => JSX.Element;

package/dist/Common/RJSF/templates/WrapIfAdditionalTemplate.d.ts

@@ -1,2 +1,3 @@
-import { WrapIfAdditionalTemplateProps } from '@rjsf/utils';
-export declare const WrapIfAdditionalTemplate: ({ id, disabled, label, onKeyChange, onDropPropertyClick, readonly, schema, children, uiSchema, registry, }: WrapIfAdditionalTemplateProps) => JSX.Element;
+/// <reference types="react" />
+import { WrapIfAdditionalTemplateProps } from '@rjsf/utils';
+export declare const WrapIfAdditionalTemplate: ({ id, disabled, label, onKeyChange, onDropPropertyClick, readonly, schema, children, uiSchema, registry, }: WrapIfAdditionalTemplateProps) => JSX.Element;

package/dist/Common/RJSF/templates/index.d.ts

@@ -1,10 +1,10 @@
-export { ArrayFieldTemplate } from './ArrayFieldTemplate';
-export { ArrayFieldItemTemplate } from './ArrayFieldItemTemplate';
-export { BaseInput as BaseInputTemplate } from './BaseInput';
-export * from './ButtonTemplates';
-export { Description as DescriptionFieldTemplate } from './Description';
-export { Field as FieldTemplate } from './Field';
-export { FieldErrorTemplate } from './FieldErrorTemplate';
-export { ObjectFieldTemplate } from './ObjectFieldTemplate';
-export { TitleField as TitleFieldTemplate } from './TitleField';
-export { WrapIfAdditionalTemplate } from './WrapIfAdditionalTemplate';
+export { ArrayFieldTemplate } from './ArrayFieldTemplate';
+export { ArrayFieldItemTemplate } from './ArrayFieldItemTemplate';
+export { BaseInput as BaseInputTemplate } from './BaseInput';
+export * from './ButtonTemplates';
+export { Description as DescriptionFieldTemplate } from './Description';
+export { Field as FieldTemplate } from './Field';
+export { FieldErrorTemplate } from './FieldErrorTemplate';
+export { ObjectFieldTemplate } from './ObjectFieldTemplate';
+export { TitleField as TitleFieldTemplate } from './TitleField';
+export { WrapIfAdditionalTemplate } from './WrapIfAdditionalTemplate';

package/dist/Common/RJSF/types.d.ts

@@ -1,3 +1,3 @@
-import { ComponentProps } from 'react';
-import RJSFForm from '@rjsf/core';
-export type FormProps = Omit<ComponentProps<typeof RJSFForm>, 'validator'>;
+import { ComponentProps } from 'react';
+import RJSFForm from '@rjsf/core';
+export type FormProps = Omit<ComponentProps<typeof RJSFForm>, 'validator'>;

package/dist/Common/RJSF/utils.d.ts

@@ -1,25 +1,26 @@
-import { TranslatableString } from '@rjsf/utils';
-/**
- * Override for the TranslatableString from RJSF
- */
-export declare const translateString: (stringToTranslate: TranslatableString, params?: string[]) => string;
-export declare const getCommonSelectStyle: (styleOverrides?: {}) => {
-    menuList: (base: any) => any;
-    control: (base: any, state: any) => any;
-    option: (base: any, state: any) => any;
-    dropdownIndicator: (base: any, state: any) => any;
-    valueContainer: (base: any, state: any) => any;
-    loadingMessage: (base: any) => any;
-    noOptionsMessage: (base: any) => any;
-    multiValue: (base: any, state: any) => any;
-};
-/**
- * Returns the redirection props for a url
- */
-export declare const getRedirectionProps: (url: string) => import("react").AnchorHTMLAttributes<HTMLAnchorElement> & {
-    url: string;
-};
-/**
- * Infers the type for json schema from value type
- */
-export declare const getInferredTypeFromValueType: (value: any) => "string" | "number" | "boolean" | "object" | "array" | "null";
+/// <reference types="react" />
+import { TranslatableString } from '@rjsf/utils';
+/**
+ * Override for the TranslatableString from RJSF
+ */
+export declare const translateString: (stringToTranslate: TranslatableString, params?: string[]) => string;
+export declare const getCommonSelectStyle: (styleOverrides?: {}) => {
+    menuList: (base: any) => any;
+    control: (base: any, state: any) => any;
+    option: (base: any, state: any) => any;
+    dropdownIndicator: (base: any, state: any) => any;
+    valueContainer: (base: any, state: any) => any;
+    loadingMessage: (base: any) => any;
+    noOptionsMessage: (base: any) => any;
+    multiValue: (base: any, state: any) => any;
+};
+/**
+ * Returns the redirection props for a url
+ */
+export declare const getRedirectionProps: (url: string) => import("react").AnchorHTMLAttributes<HTMLAnchorElement> & {
+    url: string;
+};
+/**
+ * Infers the type for json schema from value type
+ */
+export declare const getInferredTypeFromValueType: (value: any) => "string" | "number" | "boolean" | "object" | "array" | "null";

package/dist/Common/RJSF/widgets/Checkbox.d.ts

@@ -1,2 +1,3 @@
-import { WidgetProps } from '@rjsf/utils';
-export declare const Checkbox: ({ id, onChange, value, required, disabled, readonly, autofocus, onBlur, onFocus, }: WidgetProps) => JSX.Element;
+/// <reference types="react" />
+import { WidgetProps } from '@rjsf/utils';
+export declare const Checkbox: ({ id, onChange, value, required, disabled, readonly, autofocus, onBlur, onFocus, }: WidgetProps) => JSX.Element;

package/dist/Common/RJSF/widgets/Select.d.ts

@@ -1,2 +1,3 @@
-import { WidgetProps } from '@rjsf/utils';
-export declare const Select: (props: WidgetProps) => JSX.Element;
+/// <reference types="react" />
+import { WidgetProps } from '@rjsf/utils';
+export declare const Select: (props: WidgetProps) => JSX.Element;

package/dist/Common/RJSF/widgets/index.d.ts

@@ -1,2 +1,2 @@
-export { Checkbox as CheckboxWidget } from './Checkbox';
-export { Select as SelectWidget } from './Select';
+export { Checkbox as CheckboxWidget } from './Checkbox';
+export { Select as SelectWidget } from './Select';

package/dist/Common/RadioGroup/RadioGroup.d.ts

@@ -1,16 +1,17 @@
-import React from 'react';
-interface RadioGroupInterface {
-    name: string;
-    onChange: any;
-    className?: string;
-    initialTab: string;
-    disabled: boolean;
-    showTippy?: boolean;
-    tippyContent?: any;
-    dataTestId?: string;
-}
-interface RadioGroupComposition {
-    Radio?: React.FC<any>;
-}
-declare const RadioGroup: React.FC<RadioGroupInterface> & RadioGroupComposition;
-export default RadioGroup;
+import React from 'react';
+import './radioGroup.scss';
+interface RadioGroupInterface {
+    name: string;
+    onChange: any;
+    className?: string;
+    initialTab: string;
+    disabled: boolean;
+    showTippy?: boolean;
+    tippyContent?: any;
+    dataTestId?: string;
+}
+interface RadioGroupComposition {
+    Radio?: React.FC<any>;
+}
+declare const RadioGroup: React.FC<RadioGroupInterface> & RadioGroupComposition;
+export default RadioGroup;

package/dist/Common/RadioGroup.d.ts

@@ -1,8 +1,8 @@
-import { Component } from 'react';
-import { RadioGroupItemProps, RadioGroupProps } from './Types';
-export declare class RadioGroupItem extends Component<RadioGroupItemProps> {
-    render(): JSX.Element;
-}
-export declare class RadioGroup extends Component<RadioGroupProps> {
-    render(): JSX.Element;
-}
+import { Component } from 'react';
+import { RadioGroupItemProps, RadioGroupProps } from './Types';
+export declare class RadioGroupItem extends Component<RadioGroupItemProps> {
+    render(): JSX.Element;
+}
+export declare class RadioGroup extends Component<RadioGroupProps> {
+    render(): JSX.Element;
+}

package/dist/Common/Reload.d.ts

@@ -1,3 +1,3 @@
-/// <reference types="react" />
-import { ReloadType } from './Types';
-export default function Reload({ reload, className }: ReloadType): JSX.Element;
+/// <reference types="react" />
+import { ReloadType } from './Types';
+export default function Reload({ reload, className }: ReloadType): JSX.Element;

package/dist/Common/ResizableTextarea.d.ts

@@ -1,3 +1,3 @@
-import React from 'react';
-import { ResizableTextareaProps } from './Types';
-export declare const ResizableTextarea: React.FC<ResizableTextareaProps>;
+import React from 'react';
+import { ResizableTextareaProps } from './Types';
+export declare const ResizableTextarea: React.FC<ResizableTextareaProps>;

package/dist/Common/SearchBar/SearchBar.component.d.ts

@@ -1,37 +1,39 @@
-import { SearchBarProps } from './types';
-/**
- * Generic search input component with support for enter based and debounced search
- * Note: The component is uncontrolled
- *
- * @example Usage with default debounced search
- * ```tsx
- * <SearchBar handleSearchChange={triggerSearchApi} shouldDebounce />
- * ```
- *
- * @example Initial search text
- * ```tsx
- * <SearchBar initialSearchText="Keyword" />
- * ```
- *
- * @example Custom width
- * ```tsx
- * <SearchBar containerClassName="w-300" />
- * ```
- *
- * @example Trigger search on enter key press
- * ```tsx
- * <SearchBar handleEnter={triggerSearchApi} />
- * ```
- *
- * @example Custom timeout for debounced search
- * ```tsx
- * <SearchBar handleSearchChange={triggerSearchApi} shouldDebounce debounceTimeout={500} />
- * ```
- *
- * @example Placeholder for the search
- * ```tsx
- * <SearchBar inputProps={{ placeholder: 'Enter search text' }} />
- * ```
- */
-declare const SearchBar: ({ initialSearchText, handleSearchChange, handleEnter, inputProps, containerClassName, shouldDebounce, debounceTimeout, }: SearchBarProps) => JSX.Element;
-export default SearchBar;
+/// <reference types="react" />
+import { SearchBarProps } from './types';
+import './searchBar.scss';
+/**
+ * Generic search input component with support for enter based and debounced search
+ * Note: The component is uncontrolled
+ *
+ * @example Usage with default debounced search
+ * ```tsx
+ * <SearchBar handleSearchChange={triggerSearchApi} shouldDebounce />
+ * ```
+ *
+ * @example Initial search text
+ * ```tsx
+ * <SearchBar initialSearchText="Keyword" />
+ * ```
+ *
+ * @example Custom width
+ * ```tsx
+ * <SearchBar containerClassName="w-300" />
+ * ```
+ *
+ * @example Trigger search on enter key press
+ * ```tsx
+ * <SearchBar handleEnter={triggerSearchApi} />
+ * ```
+ *
+ * @example Custom timeout for debounced search
+ * ```tsx
+ * <SearchBar handleSearchChange={triggerSearchApi} shouldDebounce debounceTimeout={500} />
+ * ```
+ *
+ * @example Placeholder for the search
+ * ```tsx
+ * <SearchBar inputProps={{ placeholder: 'Enter search text' }} />
+ * ```
+ */
+declare const SearchBar: ({ initialSearchText, handleSearchChange, handleEnter, inputProps, containerClassName, shouldDebounce, debounceTimeout, }: SearchBarProps) => JSX.Element;
+export default SearchBar;

package/dist/Common/SearchBar/index.d.ts

@@ -1,2 +1,2 @@
-export { default as SearchBar } from './SearchBar.component';
-export type { SearchBarProps } from './types';
+export { default as SearchBar } from './SearchBar.component';
+export type { SearchBarProps } from './types';