@devtron-labs/devtron-fe-common-lib 0.0.53 → 0.0.54

package/dist/Common/Common.service.d.ts

@@ -12,9 +12,9 @@ export declare const SourceTypeMap: {
     BranchRegex: string;
 };
 export declare function getUserRole(appName?: string): Promise<UserRole>;
-export declare function setImageTags(request: any, pipelineId: number, artifactId: number): Promise<ResponseType>;
+export declare function setImageTags(request: any, pipelineId: number, artifactId: number): Promise<ResponseType<any>>;
 export declare const genericCDMaterialsService: (serviceType: CDMaterialServiceEnum, cdMaterialID: number, stage: DeploymentNodeType, signal: AbortSignal, queryParams?: CDMaterialServiceQueryParams) => Promise<CDMaterialResponseType>;
 export declare function extractImage(image: string): string;
 export declare function createGitCommitUrl(url: string, revision: string): string;
-export declare function fetchChartTemplateVersions(): Promise<ResponseType>;
+export declare function fetchChartTemplateVersions(): Promise<ResponseType<any>>;
 export {};

package/dist/Common/DebouncedSearch/DebouncedSearch.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="react" />
 import { DebouncedSearchProps } from './Types';
 /**
+ * @deprecated Use `SearchBar` component instead.
+ *
  * @param onSearch - Callback function to be called on search
  * @param Icon - (Optional) Icon to be shown before the input
  * @param iconClass - (Optional) Class for the icon

package/dist/Common/Helper.d.ts

@@ -57,4 +57,8 @@ export declare const customStyles: {
 export declare const getFilteredChartVersions: (charts: any, selectedChartType: any) => any;
 export declare function getUnlockedJSON(json: any, jsonPathArray: any): any;
 export declare function getLockedJSON(json: any, jsonPathArray: string[]): any;
+/**
+ * Returns a debounced variant of the function
+ */
+export declare const debounce: (func: any, timeout?: number) => (this: any, ...args: any[]) => void;
 export {};

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

@@ -0,0 +1,39 @@
+/// <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

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

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

@@ -0,0 +1,35 @@
+import { InputHTMLAttributes } from 'react';
+export interface SearchBarProps {
+    /**
+     * Initial search text
+     *
+     * @default ''
+     */
+    initialSearchText?: string;
+    /**
+     * Search handler for the search input
+     */
+    handleSearchChange?: (searchText: string) => void;
+    /**
+     * Enter event handler for the search input
+     */
+    handleEnter?: (searchText: string) => void;
+    /**
+     * Input props for the search input
+     */
+    inputProps?: InputHTMLAttributes<HTMLInputElement>;
+    /**
+     * Class name for the container; can be used for handling width
+     */
+    containerClassName?: string;
+    /**
+     * If true, the change handler would be triggered with debounce
+     *
+     * @default false
+     */
+    shouldDebounce?: boolean;
+    /**
+     * Timeout for the debounce handler to be triggered
+     */
+    debounceTimeout?: number;
+}

package/dist/Common/Types.d.ts

@@ -2,10 +2,23 @@ import React, { ReactNode, CSSProperties } from 'react';
 import { Placement } from 'tippy.js';
 import { ImageComment, ReleaseTag } from './ImageTags.Types';
 import { DockerConfigOverrideType, TaskErrorObj } from '.';
-export interface ResponseType {
+/**
+ * Generic response type object with support for overriding the result type
+ *
+ * @example Default usage:
+ * ```ts
+ * interface UserResponse extends ResponseType {}
+ * ```
+ *
+ * @example Override the response type:
+ * ```ts
+ * interface UserResponse extends ResponseType<Record<string, string>> {}
+ * ```
+ */
+export interface ResponseType<T = any> {
     code: number;
     status: string;
-    result?: any;
+    result?: T;
     errors?: any;
 }
 export interface APIOptions {

package/dist/Common/index.d.ts

@@ -26,6 +26,7 @@ export * from './Common.service';
 export * from './Checkbox';
 export { default as EmptyState } from './EmptyState/EmptyState';
 export { default as GenericEmptyState } from './EmptyState/GenericEmptyState';
+export * from './SearchBar';
 export { default as Toggle } from './Toggle/Toggle';
 export { default as ScanVulnerabilitiesTable } from './Security/ScanVulnerabilitiesTable';
 export { default as StyledRadioGroup } from './RadioGroup/RadioGroup';