@confidencesystemsinc/sdk 1.5.4 → 1.5.5

package/dist/SelfShadowComponent.d.ts

@@ -1,4 +1,4 @@
-import { ConfidencePlaybook } from './components/playbook/confidence-playbook';
+import { ConfidencePlaybook } from './components/playbook/ConfidencePlaybook';
 export declare const SelfShadowComponent: {
     (props: React.ComponentProps<typeof ConfidencePlaybook>): import('react').ReactPortal;
     AutoInstantiated: (props: React.ComponentProps<typeof ConfidencePlaybook.AutoInstantiated>) => import('react').ReactPortal;

package/dist/components/comments/CommentBoxRoot.d.ts

@@ -0,0 +1 @@
+export declare const commentBoxRoot: HTMLElement;

package/dist/components/comments/CommentContainer.d.ts

@@ -0,0 +1,13 @@
+import { TaskAsset, CommentType } from '../../types/comments.types';
+export declare const CommentContainer: ({ commentType, author, username, comment, createdDate, onDelete, onEdit, hasAssets, taskAssets, taskVerified, }: {
+    author: string;
+    username: string;
+    comment: string;
+    commentType: CommentType;
+    createdDate?: string;
+    hasAssets: boolean;
+    taskAssets?: TaskAsset[];
+    onDelete: () => void;
+    onEdit: (value: string, commentType: CommentType) => void;
+    taskVerified: boolean;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/components/comments/CommentContextMenu.d.ts

@@ -0,0 +1,9 @@
+import { CommentType } from '../../types/comments.types';
+export declare const CommentContextMenu: ({ commentType, onEdit, onSaveCommentType, onDelete, taskVerified, isUsernameAuthor, }: {
+    commentType: CommentType;
+    onEdit: () => void;
+    onSaveCommentType: (type: CommentType) => void;
+    onDelete: () => void;
+    taskVerified: boolean;
+    isUsernameAuthor: boolean;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/components/comments/CommentEditor/CommentEditor.d.ts

@@ -0,0 +1,18 @@
+import { Asset, CommentType } from '../../../types/comments.types';
+export interface CommentEditorProps {
+    clearKey?: number;
+    inputFieldClassName?: string;
+    containerClassName?: string;
+    initialValue?: string;
+    onChange: (value: string) => void;
+    commentType: CommentType;
+    onCommentTypeChange?: (type: CommentType) => void;
+    isCommentTypeEditable?: boolean;
+    actions?: React.ReactNode;
+    onAddAttachments?: (files: FileList) => void;
+    onRemoveAttachment?: (file: File) => void;
+    attachments?: Asset[];
+    onSubmit?: () => void;
+    isOpen?: boolean;
+}
+export declare function CommentEditor({ attachments, clearKey, inputFieldClassName, containerClassName, initialValue, onChange, commentType, onCommentTypeChange, isCommentTypeEditable, actions, onAddAttachments, onRemoveAttachment, onSubmit, isOpen, }: CommentEditorProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/comments/CommentEditor/CommentFileThumbnail.d.ts

@@ -0,0 +1,7 @@
+interface CommentFileThumbnailProps {
+    onRemoveFile: () => void;
+    type: string;
+    label: string;
+}
+declare const CommentFileThumbnail: ({ onRemoveFile, type, label, }: CommentFileThumbnailProps) => import("react/jsx-runtime").JSX.Element;
+export default CommentFileThumbnail;

package/dist/components/comments/CommentEditor/CommentImageThumbnail.d.ts

@@ -0,0 +1,5 @@
+declare const CommentImageThumbnail: ({ url, onDelete, }: {
+    url: string;
+    onDelete: () => void;
+}) => import("react/jsx-runtime").JSX.Element;
+export default CommentImageThumbnail;

package/dist/components/comments/CommentEditor/CommentToolbar.d.ts

@@ -0,0 +1,9 @@
+import { CommentType } from '../../../types/comments.types';
+export declare function CommentToolbar({ commentType, onCommentTypeChange, isCommentTypeEditable, actions, setIsLinkEditMode, onAddAttachments, }: {
+    commentType: CommentType;
+    onCommentTypeChange?: (type: CommentType) => void;
+    isCommentTypeEditable?: boolean;
+    actions?: React.ReactNode;
+    setIsLinkEditMode: (isLinkEditMode: boolean) => void;
+    onAddAttachments?: (files: FileList) => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/comments/CommentEditor/FloatingLinkEditorPlugin.d.ts

@@ -0,0 +1,6 @@
+import { Dispatch } from 'react';
+export default function FloatingLinkEditorPlugin({ anchorElem, isLinkEditMode, setIsLinkEditMode, }: {
+    anchorElem?: HTMLElement;
+    isLinkEditMode: boolean;
+    setIsLinkEditMode: Dispatch<boolean>;
+}): JSX.Element | null;

package/dist/components/comments/CommentEditor/theme.d.ts

@@ -0,0 +1,15 @@
+export declare const commentEditorTheme: {
+    paragraph: string;
+    list: {
+        ol: string;
+        ul: string;
+    };
+    text: {
+        bold: string;
+        italic: string;
+        underline: string;
+        strikethrough: string;
+        code: string;
+    };
+    link: string;
+};

package/dist/components/comments/CommentFilePreview.d.ts

@@ -0,0 +1,4 @@
+import { TaskAsset } from '../../types/comments.types';
+export declare const CommentFilePreview: ({ asset }: {
+    asset: TaskAsset;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/components/comments/CommentImagePreview.d.ts

@@ -0,0 +1,6 @@
+import { Dispatch, SetStateAction } from 'react';
+import { TaskAsset } from '../../types/comments.types';
+export declare const CommentImagePreview: ({ asset, onSetActiveSrc, }: {
+    asset: TaskAsset;
+    onSetActiveSrc: Dispatch<SetStateAction<string>>;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/components/comments/ConfidenceCommentBox.d.ts

@@ -0,0 +1,49 @@
+import { ConfidenceComment, CommentType } from '../../types/comments.types';
+import { IconDefinition } from '@fortawesome/free-solid-svg-icons';
+export declare const COMMENT_TYPE_STYLE_MAP: {
+    Info: {
+        icon: IconDefinition;
+        bg: string;
+        border: string;
+        iconColor: string;
+        fontColor: string;
+    };
+    Warning: {
+        icon: IconDefinition;
+        bg: string;
+        border: string;
+        iconColor: string;
+        fontColor: string;
+    };
+    Danger: {
+        icon: IconDefinition;
+        bg: string;
+        border: string;
+        iconColor: string;
+        fontColor: string;
+    };
+    Success: {
+        icon: IconDefinition;
+        bg: string;
+        border: string;
+        iconColor: string;
+        fontColor: string;
+    };
+};
+export declare const COMMENT_TYPE_BUTTONS: {
+    type: CommentType;
+    icon: IconDefinition;
+    color: string;
+    title: string;
+}[];
+export interface ConfidenceCommentBoxProps {
+    comments: ConfidenceComment[];
+    onClose: () => void;
+    isOpen: boolean;
+    taskName: string;
+    taskInstanceId: number | null;
+    isLoading: boolean;
+    playbookInstanceId: string | number;
+    taskVerification: boolean;
+}
+export declare const ConfidenceCommentBox: ({ comments, onClose, isOpen, taskName, taskInstanceId, isLoading, playbookInstanceId, taskVerification, }: ConfidenceCommentBoxProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/playbook/{playbook-header.d.ts → PlaybookHeader.d.ts}

@@ -1,4 +1,4 @@
-import { ConfidencePlaybookStyleConfiguration } from './confidence-playbook';
+import { ConfidencePlaybookStyleConfiguration } from './ConfidencePlaybook';
 export declare const PlaybookHeader: import('react').ForwardRefExoticComponent<Omit<import('react').ClassAttributes<HTMLDivElement> & import('react').HTMLAttributes<HTMLDivElement> & {
     title: string;
     playbookStyle?: ConfidencePlaybookStyleConfiguration;

package/dist/components/task/CommentButton.d.ts

@@ -0,0 +1,7 @@
+import { CommentType } from '../../types/comments.types';
+export declare const CommentButton: ({ onMouseOver, onClick, commentsCount, commentType, }: {
+    onMouseOver: () => void;
+    onClick: () => void;
+    commentsCount: number;
+    commentType: CommentType;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/components/task/{confidence-task.d.ts → ConfidenceTask.d.ts}

@@ -1,9 +1,11 @@
 import { TaskButton } from '../../hooks/useTaskButtons';
 import { PlaybookType } from '../../types/playbook.types';
 import { Task } from '../../types/task.types';
-declare const TASK_VERIFICATION_TYPE: {
+export declare const TASK_VERIFICATION_TYPE: {
     readonly PHOTO: "photo";
     readonly SCREENSHOT: "screenshot";
+    readonly COMMENT: "comment";
+    readonly NO_VERIFICATION: null;
 };
 export type TaskVerificationType = (typeof TASK_VERIFICATION_TYPE)[keyof typeof TASK_VERIFICATION_TYPE];
 export declare const ConfidenceTask: ({ task, step, playbookType, onButtonClick, viewMode, canStart, isExpanded, toggleExpanded, playbookId, taskStyle, listStickyTopBase, }: {
@@ -21,4 +23,3 @@ export declare const ConfidenceTask: ({ task, step, playbookType, onButtonClick,
     };
     listStickyTopBase?: number;
 }) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/components/task/{task-dropdown-badge.d.ts → TaskDropdownBadge.d.ts}

@@ -1,3 +1,4 @@
+import { TaskVerificationType } from './ConfidenceTask';
 declare const TASK_DROPDOWN_BADGE_VARIANTS: {
     readonly default: "text-secondary-600 border-secondary-600";
     readonly primary: "text-primary-600 border-primary-600";
@@ -8,11 +9,13 @@ interface TaskDropdownBadgeProps {
     variant?: keyof typeof TASK_DROPDOWN_BADGE_VARIANTS;
     transitions: {
         id: string;
-        color: "primary" | "success";
+        color: "primary" | "success" | "danger";
         action: string;
         to: string;
     }[];
     onClick?: (action: string) => void;
+    verificationType: TaskVerificationType;
+    taskVerified: boolean;
 }
-export declare const TaskDropdownBadge: ({ title, variant, transitions, onClick, }: TaskDropdownBadgeProps) => import("react/jsx-runtime").JSX.Element;
+export declare const TaskDropdownBadge: ({ title, variant, transitions, verificationType, taskVerified, onClick, }: TaskDropdownBadgeProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/ui/avatar.d.ts

@@ -0,0 +1,5 @@
+export declare const Avatar: ({ src, alt, size, }: {
+    src?: string;
+    alt?: string;
+    size?: number;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/components/ui/context-menu.d.ts

@@ -0,0 +1,10 @@
+import { Placement } from '@floating-ui/react';
+import { ReactElement } from 'react';
+export declare const ContextMenu: ({ placement, children, trigger, title, minWidth, }: {
+    placement?: Placement;
+    children: React.ReactNode;
+    trigger: ReactElement;
+    title?: string;
+    minWidth?: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export default ContextMenu;

package/dist/components/ui/input.d.ts

@@ -3,8 +3,9 @@ interface InputProps extends React.InputHTMLAttributes<HTMLInputElement> {
     label?: string;
     description?: string;
     error?: boolean;
+    containerClassName?: string;
 }
-export declare const InputField: ({ type, className, label, description, error, ...props }: InputProps & {
+export declare const InputField: ({ type, className, label, description, error, containerClassName, ...props }: InputProps & {
     className?: string;
 }) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/ui/modal.d.ts

@@ -1,11 +1,11 @@
-import { default as React } from 'react';
+import { ReactNode } from 'react';
 /** Since this modal is used on external websites it needs to be displayed inside a shadow root */
 export declare const Modal: ({ isOpen, close, title, dismissOptions, confirmOptions, children, className, }: {
     className?: string;
     isOpen: boolean;
     close: () => void;
     title?: string;
-    children: React.ReactNode;
+    children: ReactNode;
     dismissOptions?: {
         label: string;
         onClick: () => void;

package/dist/context/comment-context.d.ts

@@ -0,0 +1,18 @@
+import { ConfidenceComment } from '../types/comments.types';
+export declare const useCommentContext: () => {
+    comments: ConfidenceComment[];
+    openTaskDetails: {
+        taskInstanceId: number | null;
+        taskName: string;
+    } | null;
+    prefetchQuery: (taskInstanceId: number) => void;
+    setOpenTaskDetails: (openTaskDetails: {
+        taskInstanceId: number | null;
+        taskName: string;
+        taskVerification: boolean;
+    } | null) => void;
+};
+export declare const CommentProvider: ({ playbookInstanceId, children, }: {
+    children: React.ReactNode;
+    playbookInstanceId: string | number;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/context/confidence-context.d.ts

@@ -1,9 +1,13 @@
 import { QueryClient } from '@tanstack/react-query';
 export declare const ConfidenceProvider: import('react').Provider<{
     queryClient: QueryClient;
-} | null>;
+    username: string;
+    setUsername: (username: string) => void;
+}>;
 export declare const useConfidenceContext: () => {
     queryClient: QueryClient;
+    username: string;
+    setUsername: (username: string) => void;
 };
 export declare const ConfidenceContext: ({ children, }: {
     children: React.ReactNode;

package/dist/hooks/comments/useComments.d.ts

@@ -0,0 +1,178 @@
+export declare const useComments: ({ taskInstanceId, enabled, }: {
+    taskInstanceId: number;
+    enabled: boolean;
+}) => {
+    isLoading: boolean;
+    prefetchQuery: (prefetchTaskInstanceId: number) => void;
+    data: any;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<any, Error>>;
+    fetchStatus: import('@tanstack/react-query').FetchStatus;
+    promise: Promise<any>;
+    comments: any;
+} | {
+    isLoading: boolean;
+    prefetchQuery: (prefetchTaskInstanceId: number) => void;
+    data: any;
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<any, Error>>;
+    fetchStatus: import('@tanstack/react-query').FetchStatus;
+    promise: Promise<any>;
+    comments: any;
+} | {
+    isLoading: boolean;
+    prefetchQuery: (prefetchTaskInstanceId: number) => void;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<any, Error>>;
+    fetchStatus: import('@tanstack/react-query').FetchStatus;
+    promise: Promise<any>;
+    comments: any;
+} | {
+    isLoading: boolean;
+    prefetchQuery: (prefetchTaskInstanceId: number) => void;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<any, Error>>;
+    fetchStatus: import('@tanstack/react-query').FetchStatus;
+    promise: Promise<any>;
+    comments: any;
+} | {
+    isLoading: boolean;
+    prefetchQuery: (prefetchTaskInstanceId: number) => void;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<any, Error>>;
+    fetchStatus: import('@tanstack/react-query').FetchStatus;
+    promise: Promise<any>;
+    comments: any;
+} | {
+    isLoading: boolean;
+    prefetchQuery: (prefetchTaskInstanceId: number) => void;
+    data: any;
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<any, Error>>;
+    fetchStatus: import('@tanstack/react-query').FetchStatus;
+    promise: Promise<any>;
+    comments: any;
+};