@ciridae/ui 1.0.2 → 1.0.3

package/dist/feedback/operator-contract.d.ts

@@ -1,17 +1,17 @@
 import { z } from "zod";
 declare const feedbackTriageStatusSchema: z.ZodEnum<{
-    in_progress: "in_progress";
-    completed: "completed";
     received: "received";
+    in_progress: "in_progress";
     discussion_required: "discussion_required";
+    completed: "completed";
     no_action: "no_action";
 }>;
 declare const operatorFeedbackSummarySchema: z.ZodObject<{
     status: z.ZodEnum<{
-        in_progress: "in_progress";
-        completed: "completed";
         received: "received";
+        in_progress: "in_progress";
         discussion_required: "discussion_required";
+        completed: "completed";
         no_action: "no_action";
         withdrawn: "withdrawn";
     }>;
@@ -22,21 +22,21 @@ declare const operatorFeedbackSummarySchema: z.ZodObject<{
     }>;
     description: z.ZodString;
     id: z.ZodUUID;
-    createdAt: z.ZodISODateTime;
     subject: z.ZodString;
     urgency: z.ZodEnum<{
         normal: "normal";
         emergency: "emergency";
     }>;
+    createdAt: z.ZodISODateTime;
     updatedAt: z.ZodISODateTime;
     reporterEmail: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
 declare const operatorFeedbackItemSchema: z.ZodObject<{
     status: z.ZodEnum<{
-        in_progress: "in_progress";
-        completed: "completed";
         received: "received";
+        in_progress: "in_progress";
         discussion_required: "discussion_required";
+        completed: "completed";
         no_action: "no_action";
         withdrawn: "withdrawn";
     }>;
@@ -47,12 +47,12 @@ declare const operatorFeedbackItemSchema: z.ZodObject<{
     }>;
     description: z.ZodString;
     id: z.ZodUUID;
-    createdAt: z.ZodISODateTime;
     subject: z.ZodString;
     urgency: z.ZodEnum<{
         normal: "normal";
         emergency: "emergency";
     }>;
+    createdAt: z.ZodISODateTime;
     updatedAt: z.ZodISODateTime;
     reporterEmail: z.ZodNullable<z.ZodString>;
     canReply: z.ZodBoolean;
@@ -81,10 +81,10 @@ declare const operatorFeedbackItemSchema: z.ZodObject<{
 declare const operatorFeedbackListResponseSchema: z.ZodObject<{
     items: z.ZodArray<z.ZodObject<{
         status: z.ZodEnum<{
-            in_progress: "in_progress";
-            completed: "completed";
             received: "received";
+            in_progress: "in_progress";
             discussion_required: "discussion_required";
+            completed: "completed";
             no_action: "no_action";
             withdrawn: "withdrawn";
         }>;
@@ -95,12 +95,12 @@ declare const operatorFeedbackListResponseSchema: z.ZodObject<{
         }>;
         description: z.ZodString;
         id: z.ZodUUID;
-        createdAt: z.ZodISODateTime;
         subject: z.ZodString;
         urgency: z.ZodEnum<{
             normal: "normal";
             emergency: "emergency";
         }>;
+        createdAt: z.ZodISODateTime;
         updatedAt: z.ZodISODateTime;
         reporterEmail: z.ZodNullable<z.ZodString>;
     }, z.core.$strip>>;

package/dist/feedback/operator-controller.d.ts

@@ -1,17 +1,25 @@
+import { type UseQueryResult } from "@tanstack/react-query";
 import { type FeedbackOperatorClientConfig } from "./operator-client.js";
+import type { FeedbackTriageStatus } from "./operator-contract.js";
+import type { FeedbackOperatorProps } from "../components/feedback-sheet.js";
 type FeedbackOperatorControllerConfig = FeedbackOperatorClientConfig & {
+    /** Keeps one operator's cached feedback apart from another's, such as their user id. */
     cacheScope: string;
 };
-declare function useFeedbackOperatorController(config: FeedbackOperatorControllerConfig, selectedFeedbackId: string | undefined): {
+/**
+ * The operator's feedback queries: every reporter's items while `active`, the open one with its
+ * conversation, and the status change and reply, each resolving once both are refetched.
+ */
+declare function useFeedbackOperatorController(config: FeedbackOperatorControllerConfig, openFeedbackId: string | undefined, active?: boolean): {
     getAttachmentUrl: (feedbackId: string, attachmentId: string) => Promise<string>;
-    itemQuery: import("@tanstack/react-query/build/legacy").UseQueryResult<NoInfer<{
-        status: "in_progress" | "completed" | "received" | "discussion_required" | "no_action" | "withdrawn";
+    itemQuery: UseQueryResult<NoInfer<{
+        status: "received" | "in_progress" | "discussion_required" | "completed" | "no_action" | "withdrawn";
         type: "general" | "bug" | "feature";
         description: string;
         id: string;
-        createdAt: string;
         subject: string;
         urgency: "normal" | "emergency";
+        createdAt: string;
         updatedAt: string;
         reporterEmail: string | null;
         canReply: boolean;
@@ -34,26 +42,29 @@ declare function useFeedbackOperatorController(config: FeedbackOperatorControlle
             editedAt_epoch_milliseconds: number | null;
         }[];
     }>, Error>;
-    itemsQuery: import("@tanstack/react-query/build/legacy").UseQueryResult<NoInfer<{
-        status: "in_progress" | "completed" | "received" | "discussion_required" | "no_action" | "withdrawn";
+    itemsQuery: UseQueryResult<NoInfer<{
+        status: "received" | "in_progress" | "discussion_required" | "completed" | "no_action" | "withdrawn";
         type: "general" | "bug" | "feature";
         description: string;
         id: string;
-        createdAt: string;
         subject: string;
         urgency: "normal" | "emergency";
+        createdAt: string;
         updatedAt: string;
         reporterEmail: string | null;
     }[]>, Error>;
-    messageMutation: import("@tanstack/react-query/build/legacy").UseMutationResult<import("./contract.js").FeedbackMessage, Error, string, unknown>;
-    statusMutation: import("@tanstack/react-query/build/legacy").UseMutationResult<{
-        status: "in_progress" | "completed" | "received" | "discussion_required" | "no_action" | "withdrawn";
+    messageMutation: import("@tanstack/react-query").UseMutationResult<import("./contract.js").FeedbackMessage, Error, {
+        feedbackId: string;
+        body: string;
+    }, unknown>;
+    statusMutation: import("@tanstack/react-query").UseMutationResult<{
+        status: "received" | "in_progress" | "discussion_required" | "completed" | "no_action" | "withdrawn";
         type: "general" | "bug" | "feature";
         description: string;
         id: string;
-        createdAt: string;
         subject: string;
         urgency: "normal" | "emergency";
+        createdAt: string;
         updatedAt: string;
         reporterEmail: string | null;
         canReply: boolean;
@@ -75,6 +86,14 @@ declare function useFeedbackOperatorController(config: FeedbackOperatorControlle
             createdAt_epoch_milliseconds: number;
             editedAt_epoch_milliseconds: number | null;
         }[];
-    }, Error, "in_progress" | "completed" | "received" | "discussion_required" | "no_action", unknown>;
+    }, Error, {
+        feedbackId: string;
+        status: FeedbackTriageStatus;
+    }, unknown>;
 };
-export { type FeedbackOperatorControllerConfig, useFeedbackOperatorController };
+/**
+ * The feedback sheet's `operator` tab, run against the API: pass it while the viewer answers
+ * feedback, with `active` while the sheet is open.
+ */
+declare function useFeedbackOperatorSheet(config: FeedbackOperatorControllerConfig, active: boolean): FeedbackOperatorProps;
+export { type FeedbackOperatorControllerConfig, useFeedbackOperatorController, useFeedbackOperatorSheet, };

package/dist/feedback/operator-controller.js

@@ -2,7 +2,11 @@ import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
 import * as React from "react";
 import { createFeedbackOperatorClient } from "./operator-client.js";
 import { requireConfig } from "./require-config.js";
-function useFeedbackOperatorController(config, selectedFeedbackId) {
+/**
+ * The operator's feedback queries: every reporter's items while `active`, the open one with its
+ * conversation, and the status change and reply, each resolving once both are refetched.
+ */
+function useFeedbackOperatorController(config, openFeedbackId, active = true) {
     const { baseUrl, cacheScope: configuredCacheScope, getBearerToken } = config;
     const client = React.useMemo(() => createFeedbackOperatorClient({ baseUrl, getBearerToken }), [baseUrl, getBearerToken]);
     const cacheScope = requireConfig(configuredCacheScope, "cacheScope");
@@ -11,21 +15,23 @@ function useFeedbackOperatorController(config, selectedFeedbackId) {
     const itemsQuery = useQuery({
         queryKey: [...queryRoot, "items"],
         queryFn: ({ signal }) => client.list({ signal }),
+        enabled: active,
         retry: false,
     });
     const itemQuery = useQuery({
-        queryKey: [...queryRoot, "item", selectedFeedbackId],
-        queryFn: ({ signal }) => client.get(requireSelectedFeedbackId(selectedFeedbackId), { signal }),
-        enabled: selectedFeedbackId !== undefined,
+        queryKey: [...queryRoot, "item", openFeedbackId],
+        queryFn: ({ signal }) => client.get(requireOpenFeedbackId(openFeedbackId), { signal }),
+        enabled: active && openFeedbackId !== undefined,
         retry: false,
     });
+    const refresh = () => queryClient.invalidateQueries({ queryKey: queryRoot });
     const statusMutation = useMutation({
-        mutationFn: (status) => client.updateStatus(requireSelectedFeedbackId(selectedFeedbackId), status),
-        onSuccess: async () => queryClient.invalidateQueries({ queryKey: queryRoot }),
+        mutationFn: ({ feedbackId, status }) => client.updateStatus(feedbackId, status),
+        onSuccess: refresh,
     });
     const messageMutation = useMutation({
-        mutationFn: (body) => client.createMessage(requireSelectedFeedbackId(selectedFeedbackId), body),
-        onSuccess: async () => queryClient.invalidateQueries({ queryKey: queryRoot }),
+        mutationFn: ({ feedbackId, body }) => client.createMessage(feedbackId, body),
+        onSuccess: refresh,
     });
     return {
         getAttachmentUrl: (feedbackId, attachmentId) => client.getAttachmentUrl(feedbackId, attachmentId),
@@ -35,9 +41,36 @@ function useFeedbackOperatorController(config, selectedFeedbackId) {
         statusMutation,
     };
 }
-function requireSelectedFeedbackId(feedbackId) {
+/**
+ * The feedback sheet's `operator` tab, run against the API: pass it while the viewer answers
+ * feedback, with `active` while the sheet is open.
+ */
+function useFeedbackOperatorSheet(config, active) {
+    const [openFeedbackId, setOpenFeedbackId] = React.useState();
+    const { itemsQuery, itemQuery, messageMutation, statusMutation } = useFeedbackOperatorController(config, openFeedbackId, active);
+    return {
+        items: toLoadState(itemsQuery),
+        onOpenItem: setOpenFeedbackId,
+        item: openFeedbackId === undefined ? undefined : toLoadState(itemQuery),
+        onReply: async (feedbackId, body) => {
+            await messageMutation.mutateAsync({ feedbackId, body });
+        },
+        onStatusChange: async (feedbackId, status) => {
+            await statusMutation.mutateAsync({ feedbackId, status });
+        },
+    };
+}
+/** A query as the sheet reads it: loading until its first answer, then its data or failure. */
+function toLoadState(query) {
+    if (query.isPending)
+        return { status: "loading" };
+    if (query.isError)
+        return { status: "error", error: query.error, retry: () => void query.refetch() };
+    return { status: "loaded", data: query.data };
+}
+function requireOpenFeedbackId(feedbackId) {
     if (feedbackId === undefined)
-        throw new Error("Select feedback before changing it.");
+        throw new Error("Open feedback before loading it.");
     return feedbackId;
 }
-export { useFeedbackOperatorController };
+export { useFeedbackOperatorController, useFeedbackOperatorSheet, };