@confidencesystemsinc/sdk 1.5.3 → 1.5.5

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

@@ -0,0 +1,408 @@
+import { Asset, CommentType } from '../../types/comments.types';
+export declare const useManageComment: ({ playbookInstanceId, }: {
+    playbookInstanceId: string | number;
+}) => {
+    data: undefined;
+    variables: undefined;
+    error: null;
+    isError: false;
+    isIdle: true;
+    isPending: false;
+    isSuccess: false;
+    status: "idle";
+    mutate: import('@tanstack/react-query').UseMutateFunction<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }, Error, {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    }, {
+        previousComments: unknown;
+        taskInstanceId: number;
+    }>;
+    reset: () => void;
+    context: {
+        previousComments: unknown;
+        taskInstanceId: number;
+    } | undefined;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+    mutateAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }, Error, {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    }, {
+        previousComments: unknown;
+        taskInstanceId: number;
+    }>;
+    manageComment: (payload: Parameters<import('@tanstack/react-query').UseMutateAsyncFunction<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }, Error, {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    }, {
+        previousComments: unknown;
+        taskInstanceId: number;
+    }>>[0]) => Promise<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }>;
+} | {
+    data: undefined;
+    variables: {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    };
+    error: null;
+    isError: false;
+    isIdle: false;
+    isPending: true;
+    isSuccess: false;
+    status: "pending";
+    mutate: import('@tanstack/react-query').UseMutateFunction<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }, Error, {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    }, {
+        previousComments: unknown;
+        taskInstanceId: number;
+    }>;
+    reset: () => void;
+    context: {
+        previousComments: unknown;
+        taskInstanceId: number;
+    } | undefined;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+    mutateAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }, Error, {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    }, {
+        previousComments: unknown;
+        taskInstanceId: number;
+    }>;
+    manageComment: (payload: Parameters<import('@tanstack/react-query').UseMutateAsyncFunction<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }, Error, {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    }, {
+        previousComments: unknown;
+        taskInstanceId: number;
+    }>>[0]) => Promise<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }>;
+} | {
+    data: undefined;
+    error: Error;
+    variables: {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    };
+    isError: true;
+    isIdle: false;
+    isPending: false;
+    isSuccess: false;
+    status: "error";
+    mutate: import('@tanstack/react-query').UseMutateFunction<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }, Error, {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    }, {
+        previousComments: unknown;
+        taskInstanceId: number;
+    }>;
+    reset: () => void;
+    context: {
+        previousComments: unknown;
+        taskInstanceId: number;
+    } | undefined;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+    mutateAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }, Error, {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    }, {
+        previousComments: unknown;
+        taskInstanceId: number;
+    }>;
+    manageComment: (payload: Parameters<import('@tanstack/react-query').UseMutateAsyncFunction<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }, Error, {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    }, {
+        previousComments: unknown;
+        taskInstanceId: number;
+    }>>[0]) => Promise<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }>;
+} | {
+    data: {
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    };
+    error: null;
+    variables: {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    };
+    isError: false;
+    isIdle: false;
+    isPending: false;
+    isSuccess: true;
+    status: "success";
+    mutate: import('@tanstack/react-query').UseMutateFunction<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }, Error, {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    }, {
+        previousComments: unknown;
+        taskInstanceId: number;
+    }>;
+    reset: () => void;
+    context: {
+        previousComments: unknown;
+        taskInstanceId: number;
+    } | undefined;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+    mutateAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }, Error, {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    }, {
+        previousComments: unknown;
+        taskInstanceId: number;
+    }>;
+    manageComment: (payload: Parameters<import('@tanstack/react-query').UseMutateAsyncFunction<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }, Error, {
+        username: string;
+        taskVerified: boolean;
+        action?: "delete" | "add" | "edit";
+        taskInstanceId: number;
+        timezone?: string;
+        commentId?: number | string;
+        comment?: string;
+        commentType?: CommentType;
+        hasAssets?: boolean;
+        attachments?: Asset[];
+    }, {
+        previousComments: unknown;
+        taskInstanceId: number;
+    }>>[0]) => Promise<{
+        commentId: number;
+        commentType: CommentType;
+        user: string;
+        comment: string;
+        hasAssets: boolean;
+        createdDate?: string;
+    }>;
+};

package/dist/hooks/task/useTaskDetails.d.ts

@@ -25,6 +25,7 @@ export declare const useTaskDetails: ({ taskId, playbookId, enabled, }: {
     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>;
@@ -53,6 +54,7 @@ export declare const useTaskDetails: ({ taskId, playbookId, enabled, }: {
     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>;
@@ -81,6 +83,7 @@ export declare const useTaskDetails: ({ taskId, playbookId, enabled, }: {
     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>;
@@ -109,6 +112,7 @@ export declare const useTaskDetails: ({ taskId, playbookId, enabled, }: {
     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>;
@@ -137,6 +141,7 @@ export declare const useTaskDetails: ({ taskId, playbookId, enabled, }: {
     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>;
@@ -165,6 +170,7 @@ export declare const useTaskDetails: ({ taskId, playbookId, enabled, }: {
     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>;

package/dist/hooks/useTaskButtons.d.ts

@@ -5,6 +5,7 @@ export declare const TASK_BUTTONS: {
     readonly RESUME: "RESUME";
     readonly COMPLETE: "COMPLETE";
     readonly EXPAND: "EXPAND";
+    readonly ADD_COMMENT: "ADD_COMMENT";
 };
 export declare const TASK_BUTTONS_DISPLAY_TEXT: {
     [key in TaskButton]?: string;