@ambuj.bhaskar/react-component-library 0.30.15 → 0.31.0

package/dist/index.d.ts

@@ -2,270 +2,59 @@ import { ComponentProps } from 'react';
 import { default as default_2 } from 'react';
 import { Dispatch } from 'react';
 import { DropdownProps as DropdownProps_2 } from 'antd';
+import { ForwardRefExoticComponent } from 'react';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { MenuProps as MenuProps_2 } from 'antd';
 import { PopoverProps as PopoverProps_2 } from 'antd';
 import { RangePickerProps } from 'antd/es/date-picker';
 import * as React_2 from 'react';
 import { ReactNode } from 'react';
+import { RefAttributes } from 'react';
 import { RefObject } from 'react';
 import { Resolver } from 'react-hook-form';
 import { SetStateAction } from 'react';
 import { TableProps as TableProps_2 } from 'antd';
 import { TimeRangePickerProps } from 'antd';
 
-export declare interface Annotation {
-    awi_id: string;
-    awi_request_id: number;
-    awi_content_key: string;
-    awi_status: AnnotationStatus;
-    awi_coords: Array<{
-        x: number;
-        y: number;
-    }>;
-    awi_outline_type: AnnotationType;
-    awi_outline_status: AnnotationStatus;
-    awi_classes: MiniData | {
-        awi_color: string;
-    }[];
-    awi_attributes: AnnotationAttributes;
-    sam_status: string;
-    awi_last_updation: Date;
-    awi_added_by: any;
-}
-
-export declare type AnnotationAttributes = {
-    awi_id: number;
-    awi_values: string[];
-    awi_corrected_values: string[];
-    awi_status: AnnotationStatus;
-    awi_added_by?: {
-        awi_id: number;
-        awi_level: "awi_annotator" | "awi_verifier" | "awi_supervisor";
-    };
-}[];
-
-export declare const AnnotationComponentLibrary: React.FC<AnnotationComponentLibraryProps>;
-
-declare type AnnotationComponentLibraryProps = {
-    imageUrl?: string;
-    showAnnotations?: boolean;
-    createAnnotation?: (coords: {
-        x: number;
-        y: number;
-    }[], classId: any, isSam: any, cb?: () => void) => void;
-    handleMultipleAnnotations?: (payload: any, cb?: () => void) => void;
-    handleUpdateAnnotationCoordinates?: (coords: {
-        x: number;
-        y: number;
-    }[], annotation_id: string, cb?: () => void) => void;
-    className?: string;
-    content_id?: string;
-    request_id?: number;
-    isEditing?: boolean;
-    handleSelectTool?: (tool: "edit" | "annotate") => void;
-    selectIndex?: string;
-    handleSelectAnnotationIndex?: (index: string, changeMode?: boolean) => void;
-    showAnnotationType?: ShowAnnotationStatus;
-    loggedUser?: any;
-    isCarousel?: boolean;
-    classColorMap?: any;
-    disableAnnotation?: boolean;
-    SAMToggle?: string;
-    handleSAMToggle?: (tool: "SAM" | "Normal") => void;
-    imageNumber?: number;
-    togglePagination?: (callback: (prev: boolean) => boolean) => void;
-    unSelectedAnnotationIDsSet?: Set<string>;
-    setMousePosition?: ({ x, y }: {
-        x: any;
-        y: any;
-    }) => void;
-    allowedToCopyPreview?: boolean;
-    copyCallBackHandler?: any;
-    annotationSession?: any;
-    SAMToggleValue?: any;
-    selectedSAMTool?: any;
-    handleCopyAnnotations?: (annotations: any, copyAll: any) => void;
-    setOpenRequestDetails?: (a: any) => void;
-    openRequestDetails?: any;
-    handleNextPage?: () => void;
-    handlePreviousPage?: () => void;
-    handleGoToPage?: (index: number) => void;
-    currentPage?: any;
-    handleUpdateImageIndex?: (index: number) => void;
-    requestId?: any;
-    showPagination?: any;
-    isAnnotationCreating?: any;
-    contentInfo?: any;
-    content_key?: any;
-    isAnnotationUpdating?: any;
-    isDeleteAnnotationMutationLoading?: any;
-    showGuidelinesFirst?: any;
-    currentImage?: number;
-    selectedContent?: any;
-    switchToEditMode?: () => void;
-    switchToCreateMode?: () => void;
-    goToNextImage?: () => void;
-    goToPreviousImage?: () => void;
-    handleGoToPendingAnnotations?: () => void;
-    handlePasteAnnotationsByControlV?: () => void;
-    annotationsResponse?: any;
-    isAnnotationFetching?: boolean;
-    fetchAnnotationsKey?: any;
-    request?: any;
-    parentReqData?: any;
-    clearAnnotationCache?: any;
-    RequestInfoModal?: any;
-    getAnnotationFromSAM?: (a: any) => any;
-    getAnnotationsFromSAMPrompt?: (a: any) => any;
-    fetchAnnotations?: any;
-    pageCount?: number;
-    annotationViewType?: string;
-    AnnotationPagination?: any;
-    REACT_APP_SAM_ENABLED?: string;
-    ImageGenerationHelper: any;
-    fallbackImageUrl?: string;
-    activeColor?: any;
-    Carousel?: any;
-    showTool?: boolean;
-};
-
-export declare type AnnotationLibraryComponentProps = {
-    title?: string;
-};
+declare function areAllValuesEmpty(obj: any): boolean;
 
-export declare type AnnotationStatus = "approved" | "rejected" | "pending" | "corrected";
+export declare const AwiCanvas: ForwardRefExoticComponent<AwiCanvasProps & RefAttributes<AwiCanvasRef>>;
 
-export declare type AnnotationType = "rectangle" | "circle" | "polygon" | "dot";
+declare interface AwiCanvasDimensions {
+    width?: number | string;
+    height?: number | string;
+}
 
-declare function areAllValuesEmpty(obj: any): boolean;
+declare interface AwiCanvasInteractionHandlers {
+    handleMouseDown?: (event: default_2.MouseEvent) => void;
+    handleMouseUp?: (event: default_2.MouseEvent) => void;
+    handleMouseMove?: (event: default_2.MouseEvent) => void;
+    handleMouseMoveOut?: (event: default_2.MouseEvent) => void;
+    handleOnMouseLeave?: (event: default_2.MouseEvent) => void;
+    handleWheel?: (event: default_2.WheelEvent) => void;
+    handleTouchStart?: (event: default_2.TouchEvent) => void;
+    handleTouchMove?: (event: default_2.TouchEvent) => void;
+    handleTouchEnd?: (event: default_2.TouchEvent) => void;
+    handleTouchCancel?: (event: default_2.TouchEvent) => void;
+}
 
-export declare const AwiAnnotationHotkeys: default_2.FC<AwiAnnotationHotkeysProps>;
+export declare interface AwiCanvasProps extends AwiCanvasInteractionHandlers {
+    imageUrl?: string | null;
+    dimensions?: AwiCanvasDimensions;
+    backgroundColor?: string;
+    showCrosshair?: boolean;
+    loader?: default_2.ReactNode;
+    rendering?: boolean;
+    zoomConfig?: CanvasZoomConfig;
+    panConfig?: CanvasPanConfig;
+    onZoomChange?: (state: ZoomPanState) => void;
+    onPanChange?: (pan: Pick<ZoomPanState, "x" | "y">) => void;
+}
 
-export declare type AwiAnnotationHotkeysProps = {
-    title?: string;
-    toggleSelectAnnotation: (direction: "forward" | "backward" | "last_update") => void;
-    handleLeftKeyDown: () => void;
-    handleRightKeyDown: () => void;
-    handleUpKeyDown: () => void;
-    handleDownKeyDown: () => void;
-    handleZoomInClick: () => void;
-    handleZoomOutClick: () => void;
-    handleCompleteAnnotation: () => void;
-    undoAnnotationPoint: () => void;
-    reLoadAndReDrawAnnotations: () => void;
-    togglePagination: React.Dispatch<React.SetStateAction<boolean>>;
-    toggleFullscreen: () => void;
-    switchToAutoAnnotations: () => void;
-    openShortCutRequestDetails: () => void;
-    handleRecentAnnotatedVerifiedImages: () => void;
-    handleSendToSamFunctionPrompt: () => void;
-    samAPIactive: boolean;
-    request?: any;
-    switchToEditMode?: () => void;
-    switchToCreateMode?: () => void;
-    goToNextImage?: () => void;
-    goToPreviousImage?: () => void;
-    loggedUser: LoggedUser;
-    handleGoToPendingAnnotations?: () => void;
-    handleCopyByCtrlC?: () => void;
-    handlePasteAnnotationsByControlV?: () => void;
-    openShortCutKeyModal: any;
-    setOpenShortCutKeyModal: (boolean: any) => void;
-    setIsAltViaToolPressHandle: () => void;
-    isCarousel: boolean;
-    selectedTool: string;
-    setCrossHairHandle: () => void;
-    controlPlusHotkey?: () => void;
-    controlMinusHotkey?: () => void;
-};
-
-export declare const AwiAnnotationTools: React.FC<AwiAnnotationToolsProps>;
-
-export declare type AwiAnnotationToolsProps = {
-    handleSelectTool?: (tool: "edit" | "annotate") => void;
-    handleSAMToggle?: (tool: "SAM" | "Normal") => void;
-    isEditing: boolean;
-    loggedUser: LoggedUser;
-    annotator_name: string;
-    hasAnnotation: boolean;
-    SAMToggleValue: boolean;
-    currentSelectedSAMTool: any;
-    handleCopyAnnotations: any;
-    setOpenRequestDetails?: (a: any) => void;
-    openRequestDetails: boolean;
-    show_guidelines_first: boolean;
-    handleZoomInClick: () => void;
-    zoomProperties: any;
-    handleReset: () => void;
-    handleZoomOutClick: () => void;
-    handleCompleteAnnotation: () => void;
-    toggleFullscreen: () => void;
-    selectAnnotationId?: any;
-    selectedAnnotationInfo?: any;
-    undoLastStateAnnotation: () => void;
-    usingSamFunction: boolean;
-    samAPIactive: boolean;
-    handleSendToSamFunction: () => void;
-    coordinates: any;
-    handleSendToSamFunctionPrompt: () => void;
-    reLoadAndReDrawAnnotations: () => void;
-    showGuidelinesFirst: boolean;
-    isMobile?: boolean;
-    toggleSelectAnnotation: () => void;
-    handleLeftKeyDown: () => void;
-    handleRightKeyDown: () => void;
-    handleUpKeyDown: () => void;
-    handleDownKeyDown: () => void;
-    undoAnnotationPoint: () => void;
-    togglePagination: () => void;
-    switchToEditMode?: () => void;
-    switchToCreateMode?: () => void;
-    goToNextImage?: () => void;
-    goToPreviousImage?: () => void;
-    handleGoToPendingAnnotations?: () => void;
-    handleCopyByCtrlC?: () => void;
-    handlePasteAnnotationsByControlV?: () => void;
-    showPagination?: boolean;
-    isControlViaToolPress: boolean;
-    isAltViaToolPress: boolean;
-    setIsControlViaToolPress: (boolean: any) => void;
-    setIsAltViaToolPress: (boolean: any) => void;
-    isCarousel: boolean;
-    allowedToCopyPreview: boolean;
-    classColorMapToSend?: any;
-    request: any;
-    parentReqData: any;
-    RequestInfoModal: any;
-    setCrossHair: (boolean: any) => void;
-    isCrossHair: boolean;
-    annotationViewType?: string;
-    REACT_APP_SAM_ENABLED?: string;
-    controlMinusHotkey?: () => void;
-    controlPlusHotkey?: () => void;
-    Carousel?: any;
-};
-
-export declare const AwiCanvasContainer: React.FC<AwiCanvasContainerProps>;
-
-export declare type AwiCanvasContainerProps = {
-    title?: string;
-    canvasDimensions: any;
-    zoomProperties: any;
-    isEditing: any;
-    canvasRef: any;
-    bgCanvasRef: any;
-    overlayCanvasRef: any;
-    handleMouseDown: any;
-    handleMouseUp: any;
-    handleMouseMove: any;
-    handleMouseMoveOut: any;
-    handleOnMouseLeave: any;
-    handleWheel: any;
-    handleTouchStart: any;
-    handleTouchMove: any;
-    handleTouchEnd: any;
-    handleTouchCancel: any;
+export declare type AwiCanvasRef = MultiLayerCanvasRef & {
+    zoomState: ZoomPanState;
+    setZoomState: (next: ZoomPanState | ((prev: ZoomPanState) => ZoomPanState)) => void;
+    resetView: () => void;
 };
 
 export declare const AwiCustomConfirmation: default_2.FC<AwiCustomConfirmationProps>;
@@ -449,17 +238,6 @@ export declare const AwiSafeLocalStorage: {
     removeLogout: () => void;
 };
 
-export declare const AwiSamModal: React.FC<AwiSamModalProps>;
-
-export declare type AwiSamModalProps = {
-    closeSAMPromptModal: () => void;
-    onSubmit: any;
-    directPrompt: any;
-    isLoading: boolean;
-    requestInfo: any;
-    title?: string;
-};
-
 export declare const AwiScrollableTableCellList: React.FC<AwiListProps>;
 
 export declare const AwiSlider: React.FC<AwiSliderProps>;
@@ -658,6 +436,30 @@ export declare type ButtonProps = HTMLButtonProps & {
 
 declare type ButtonVariant = "primary" | "secondary" | "tertiary" | "nav";
 
+declare interface CanvasPanBounds {
+    x?: {
+        min?: number;
+        max?: number;
+    };
+    y?: {
+        min?: number;
+        max?: number;
+    };
+}
+
+declare interface CanvasPanConfig {
+    enabled?: boolean;
+    bounds?: CanvasPanBounds;
+}
+
+declare interface CanvasZoomConfig {
+    enabled?: boolean;
+    min?: number;
+    max?: number;
+    initialScale?: number;
+    step?: number;
+}
+
 declare function capitalizeFirstChar(str: any): any;
 
 export declare const Chart: React.FC<ChartProps>;
@@ -755,19 +557,6 @@ export declare type ContactInputProps = {
     dsabledColor?: Color;
 };
 
-export declare type Content = {
-    url: string;
-    contentKey: string;
-    directPrompt: string;
-};
-
-export declare type Coordinate = {
-    x: number;
-    y: number;
-};
-
-export declare type CorrectedAnnotationType = "created" | "not-created" | "";
-
 declare type CSSstring = string;
 
 declare type CustomOption = {
@@ -1152,23 +941,6 @@ export declare type LiveDotProps = {
 
 declare type LiveDotSize = "s" | "m" | "l";
 
-export declare interface LoggedInUser {
-    awi_email: string;
-    awi_id: number;
-    awi_level: userLevel;
-    awi_personal_info: {
-        awi_firstname: string;
-        awi_lastname: string;
-        awi_avatar?: string;
-    };
-    awi_verification_status?: string;
-}
-
-export declare interface LoggedUser {
-    token: string;
-    userObj: LoggedInUser;
-}
-
 export declare const LoginPage: <TFormValues extends Record<string, any> = any>({ width, height, elementSize, className, bannerImage, showAwirosLogo, title, description, headerImage, headerImageMargin, formConfig, formSchema, formSubmitDisclaimer, formSubmitButtonText, formSubmitLoading, onSubmit, footerItems, footerImage, footerImageMargin, }: LoginPageProps<TFormValues>) => JSX_2.Element;
 
 export declare type LoginPageProps<TFormValues extends Record<string, any> = any> = {
@@ -1259,13 +1031,6 @@ export declare interface MenuProps extends Omit<MenuProps_2, "style" | "classNam
     style?: React.CSSProperties;
 }
 
-export declare interface MiniData {
-    awi_id: number;
-    awi_label: string;
-    awi_image_assignable_request?: boolean;
-    awi_creation?: Date;
-}
-
 export declare const Modal: default_2.FC<ModalProps>;
 
 export declare interface ModalButtonProps {
@@ -1299,6 +1064,13 @@ export declare type MonthPickerProps = {
     popupClassName?: string;
 };
 
+declare type MultiLayerCanvasRef = {
+    container: RefObject<HTMLDivElement>;
+    previewCanvas: RefObject<HTMLCanvasElement>;
+    annotationCanvas: RefObject<HTMLCanvasElement>;
+    imageCanvas: RefObject<HTMLCanvasElement>;
+};
+
 export declare const Multiselect: default_2.FC<MultiselectProps>;
 
 export declare type MultiselectProps = {
@@ -1366,20 +1138,6 @@ export declare type PopoverProps = PopoverProps_2 & {
     backgroundColor?: Color;
 };
 
-export declare type PostRequestBody = {
-    img_url: string;
-    coords: Coordinate[];
-    coordinates?: any;
-};
-
-export declare type PostRequestPromptBody = {
-    requestId: number;
-    contents: Content[];
-    confidence: number;
-    modelName: string;
-    modelMaxResults: number;
-};
-
 export declare const Refresh: default_2.FC<RefreshProps>;
 
 export declare type RefreshIntervalOption = {
@@ -1430,8 +1188,6 @@ export declare type SelectProps = {
     textOverflow?: "ellipsis" | "clip";
 };
 
-export declare type ShowAnnotationStatus = "approved" | "rejected" | "pending" | "corrected" | "all";
-
 export declare const showToast: ({ type, title, body, }: ShowToastType) => void;
 
 declare type ShowToastType = {
@@ -1633,8 +1389,6 @@ export declare const useResize: () => {
     containerRef: RefObject<HTMLDivElement>;
 };
 
-export declare type userLevel = "awi_root" | "awi_admin" | "awi_manager" | "awi_developer" | "awi_supervisor" | "awi_verifier" | "awi_annotator";
-
 export declare const useTheme: () => Record<string, string>;
 
 export declare const useToast: () => {
@@ -1656,4 +1410,10 @@ export declare type WeekPickerProps = {
     popupClassName?: string;
 };
 
+declare interface ZoomPanState {
+    scale: number;
+    x: number;
+    y: number;
+}
+
 export { }