@opencxh/domain 1.286.3 → 1.288.0

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;
 }

package/dist/entities/transaction/keys.d.ts

@@ -9,6 +9,8 @@
  */
 export declare const TRANSACTION_SCOPE_KINDS: readonly string[];
 export declare const PRODUCT_SCOPE_KIND = "product";
+/** An agreement: what a customer takes every period. Puts it in the customer file. */
+export declare const AGREEMENT_SCOPE_KIND = "agreement";
 /** `invoice:412`. The kind of a transaction *is* its kind key — no mapping table. */
 export declare function transactionScopeKey(kindKey: string, id: string): string;
 export declare function productScopeKey(id: string): string;
@@ -27,6 +29,11 @@ export declare function productHref(row: {
     id: string;
     businessEntityId?: string;
 }, fallbackEntityId?: string): string | undefined;
+export declare function agreementScopeKey(id: string): string;
+export declare function agreementHref(row: {
+    id: string;
+    businessEntityId?: string;
+}, fallbackEntityId?: string): string | undefined;
 /** Is this scopeKey one of ours, and which id does it point at? */
 export declare function transactionIdFromScope(scopeKey: string): string | undefined;
 /**

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

@@ -1,4 +1,5 @@
 import { DocumentBlock } from '../../platform/document-blocks';
+import { LineUsage } from '../agreement/types';
 import { DocumentSender } from '../document-template/types';
 import { Cents } from '../money/money';
 import { TaxRateKind } from '../money/tax';
@@ -182,6 +183,19 @@ export interface TransactionLine {
      * the line — not the entry — is the source of truth. Never copied to a new document.
      */
     timeEntryIds?: string[];
+    /** How a usage line was counted: from a meter or entered per period. Never re-priced. */
+    usage?: LineUsage;
+    /**
+     * The agreement line this bills, and the days it covers. Together with `correction` these are
+     * the whole "what was billed" state of an agreement — see `dueCharges`.
+     */
+    agreementLineId?: string;
+    servicePeriod?: {
+        from: number;
+        to: number;
+    };
+    /** Settles days of a window billed earlier, at the price it was billed at. */
+    correction?: boolean;
     /**
      * An option: priced and shown, but **not** in the total.
      *