@opencxh/domain 1.286.2 → 1.287.0

package/dist/entities/activity/types.d.ts

@@ -239,6 +239,10 @@ export type InteractionStatus = "open" | "closed" | "snoozed";
 export type InteractionStatusChangedPayload = {
     fromStatus: InteractionStatus;
     toStatus: InteractionStatus;
+    /** Set on a close with a reason: the key, and its label and outcome as they were at that moment. */
+    resolution?: string;
+    resolutionLabel?: string;
+    resolutionPositive?: boolean;
 };
 /**
  * A service target that ran out. Written by the app that owns the clocks, not by comms.

package/dist/entities/inbox/types.d.ts

@@ -1,3 +1,4 @@
+import { InteractionResolution } from '../interaction/resolution';
 export interface Inbox {
     id: string;
     organizationId: string;
@@ -23,4 +24,6 @@ export interface Inbox {
      * priority itself is rarely set.
      */
     slaHours?: number;
+    /** This inbox's own resolutions, next to `SYSTEM_RESOLUTIONS`. Read through `resolutionsFor`. */
+    resolutions?: InteractionResolution[];
 }

package/dist/entities/interaction/index.d.ts

@@ -1,4 +1,5 @@
 export * from './attention';
 export * from './logic';
+export * from './resolution';
 export * from './seen';
 export * from './types';

package/dist/entities/interaction/resolution.d.ts

@@ -0,0 +1,29 @@
+import { Inbox } from '../inbox/types';
+/**
+ * *How* a conversation ended, apart from its status. `closed` already behaves like a servicedesk's
+ * "solved" (an inbound reopens it), so what was missing was the reason, not a fourth status.
+ *
+ * Deliberately not `WorkResolution`: "deal won" and "spam" are different vocabularies, and one
+ * shared type would tie two apps that must change apart.
+ */
+export interface InteractionResolution {
+    key: string;
+    /** System: an i18n key in the communication app. Custom: what the admin typed. */
+    label: string;
+    order: number;
+    /** `true` ended well, `false` ended badly, absent says neither. */
+    positive?: boolean;
+    system?: true;
+}
+/**
+ * The resolutions every inbox has. In code and not seeded, so `solved` means solved in every
+ * organisation: rules, analytics, AI tools and CSAT key on these, and a renamed or deleted row
+ * would silently break all of them. An inbox adds its own next to these; it cannot change them.
+ */
+export declare const SYSTEM_RESOLUTIONS: readonly InteractionResolution[];
+/** Closed with one of these, a conversation does not count as resolved: nothing was worked on. */
+export declare const UNWORKED_RESOLUTIONS: readonly string[];
+/** Custom keys carry this prefix, so they can never collide with a later system key. */
+export declare const CUSTOM_RESOLUTION_PREFIX = "c_";
+/** System first, then the inbox's own in their order. The one list every reader uses. */
+export declare function resolutionsFor(inbox?: Pick<Inbox, "resolutions"> | null): InteractionResolution[];

package/dist/entities/interaction/resolution.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/entities/interaction/types.d.ts

@@ -133,4 +133,11 @@ export interface Interaction {
      * = not snoozed.
      */
     snoozedTill?: number | null;
+    /**
+     * {@link InteractionResolution.key}, set when closing; cleared (`""`) on any move away from
+     * `closed`. `resolutionLabel` is the label at that moment, so renaming or deleting a custom
+     * resolution later does not rewrite history.
+     */
+    resolution?: string;
+    resolutionLabel?: string;
 }