@opencxh/domain 1.278.0 → 1.280.0

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

@@ -3,6 +3,7 @@ export * from './catalog';
 export * from './descriptor';
 export * from './preview';
 export * from './resolve';
+export * from './resource-activity';
 export * from './seen';
 export * from './timestamp';
 export * from './types';

package/dist/entities/activity/resource-activity.d.ts

@@ -0,0 +1,33 @@
+import { ReactionSummary } from '../reaction/types';
+/**
+ * A feed row that hangs on something other than an interaction — a work item, a contact.
+ *
+ * Comms' `Activity` requires `interactionId` everywhere, so every other feed mirrors it minus the
+ * interaction fields. This is that mirror once, as a type only: each app keeps its own entity.
+ * The shape is what `wakesAssignment` and `buildTriggerVars` read structurally.
+ */
+export interface ResourceActivity<TType extends string, TPayload> {
+    id: string;
+    organizationId: string;
+    type: TType;
+    author: {
+        type: "user" | "system" | "app";
+        id?: string;
+        name: string;
+    };
+    /**
+     * Always `"internal"`. Never `"inbound"`: rule 1 of `wakesAssignment` treats inbound as
+     * "the customer answered" and would wake every waiting assignment on the row's subject.
+     */
+    direction: "internal";
+    /** The activity this one answers — same one-level thread as comms' `BaseActivity.parentId`. */
+    parentId?: string;
+    payload: TPayload;
+    /**
+     * The emoji on this row, as the list route projects them. Read-only and never stored on the
+     * row — see `BaseActivity.reactions` and the generic store in the communication app.
+     */
+    reactions?: ReactionSummary[];
+    createdAt?: number;
+    updatedAt?: number;
+}

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

@@ -5,7 +5,7 @@ import { ReactionSummary } from '../reaction/types';
 export type CallStatus = "new" | "connecting" | "ringing" | "connected" | "held" | "ended" | "failed";
 export type CallDirection = "inbound" | "outbound";
 export type CallType = "audio" | "video" | "data" | "screen-share";
-export type ActivityType = "VOICE_CALL_STARTED" | "VOICE_CALL_ANSWERED" | "VOICE_CALL_HOLD" | "VOICE_CALL_UNHOLD" | "VOICE_CALL_ENDED" | "VOICE_CALL_MISSED" | "VOICE_CALL_VOICEMAIL" | "VIDEO_CALL_STARTED" | "VIDEO_CALL_ANSWERED" | "VIDEO_CALL_HOLD" | "VIDEO_CALL_UNHOLD" | "VIDEO_CALL_ENDED" | "VIDEO_CALL_MISSED" | "EMAIL_RECEIVED" | "EMAIL_SENT" | "CHAT_MESSAGE_SENT" | "CHAT_MESSAGE_RECEIVED" | "CHAT_MEMBER_JOINED" | "CHAT_MEMBER_LEFT" | "CHAT_RENAMED" | "CHAT_CALL_STARTED" | "CHAT_CALL_ENDED" | "CHAT_EVENT" | "AI_MESSAGE_ADDED" | "AI_ACTION_PROPOSED" | "PLAYBOOK_STARTED" | "PLAYBOOK_COMPLETED" | "PLAYBOOK_ESCALATED" | "AGENT_DELEGATED" | "AGENT_ANSWERED" | "MEETING_SCHEDULED" | "MEETING_STARTED" | "MEETING_ENDED" | "MEETING_PARTICIPANT_JOINED" | "MEETING_PARTICIPANT_LEFT" | "COMMENT_ADDED" | "FILE_UPLOADED" | "INTERACTION_CREATED" | "INTERACTION_STATUS_CHANGED" | "INTERACTION_ASSIGNED" | "SLA_BREACHED" | "VOICE_CALL_FAILED" | "VIDEO_CALL_FAILED" | "TRANSCRIPT_ADDED" | "WORK_COMMENT_ADDED" | "WORK_ITEM_ASSIGNED" | "WORK_ITEM_STATUS_CHANGED";
+export type ActivityType = "VOICE_CALL_STARTED" | "VOICE_CALL_ANSWERED" | "VOICE_CALL_HOLD" | "VOICE_CALL_UNHOLD" | "VOICE_CALL_ENDED" | "VOICE_CALL_MISSED" | "VOICE_CALL_VOICEMAIL" | "VIDEO_CALL_STARTED" | "VIDEO_CALL_ANSWERED" | "VIDEO_CALL_HOLD" | "VIDEO_CALL_UNHOLD" | "VIDEO_CALL_ENDED" | "VIDEO_CALL_MISSED" | "EMAIL_RECEIVED" | "EMAIL_SENT" | "CHAT_MESSAGE_SENT" | "CHAT_MESSAGE_RECEIVED" | "CHAT_MEMBER_JOINED" | "CHAT_MEMBER_LEFT" | "CHAT_RENAMED" | "CHAT_CALL_STARTED" | "CHAT_CALL_ENDED" | "CHAT_EVENT" | "AI_MESSAGE_ADDED" | "AI_ACTION_PROPOSED" | "PLAYBOOK_STARTED" | "PLAYBOOK_COMPLETED" | "PLAYBOOK_ESCALATED" | "AGENT_DELEGATED" | "AGENT_ANSWERED" | "MEETING_SCHEDULED" | "MEETING_STARTED" | "MEETING_ENDED" | "MEETING_PARTICIPANT_JOINED" | "MEETING_PARTICIPANT_LEFT" | "COMMENT_ADDED" | "FILE_UPLOADED" | "INTERACTION_CREATED" | "INTERACTION_STATUS_CHANGED" | "INTERACTION_ASSIGNED" | "SLA_BREACHED" | "VOICE_CALL_FAILED" | "VIDEO_CALL_FAILED" | "TRANSCRIPT_ADDED" | "WORK_COMMENT_ADDED" | "WORK_ITEM_ASSIGNED" | "WORK_ITEM_STATUS_CHANGED" | "CRM_NOTE_ADDED" | "CRM_CALL_LOGGED" | "CRM_STAGE_CHANGED";
 export interface Attachment {
     id: string;
     filename: string;

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

@@ -39,6 +39,11 @@ export interface Product {
     ledgerCategoryKey?: string;
     /** References to this product elsewhere (`moneybird:412`). A reference, never a copy. */
     externalIds?: string[];
+    /**
+     * Hours booked on this `WorkType.key` are invoiced as this product. Here and not on the work
+     * type: time must not know sales, and several products may share one type (junior/senior).
+     */
+    workTypeKey?: string;
     /** See {@link FIXED_UNITS}. Drives the form and the word after the quantity. */
     unitKey: string;
     /** Key into the organisation's VAT table, never the percentage itself. */

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

@@ -1,4 +1,5 @@
 import { PostalAddress } from '../organization/types';
+import { LifecycleStage } from '../contact/lifecycle';
 import { OwnerScope } from '../scope/types';
 /** Same meaning as {@link ContactOrigin}: `shadow` is a lazily cached hit, a landed row is `own`. */
 export type CompanyOrigin = "own" | "shadow";
@@ -43,6 +44,8 @@ export interface Company {
     ownerScope: OwnerScope;
     source: CompanySource;
     origin?: CompanyOrigin;
+    /** Where the organisation stands with us; independent of its contacts' own stages. */
+    lifecycleStage?: LifecycleStage;
     /** The group this company belongs to. One level up per row; a cycle is refused on write. */
     parentCompanyId?: string;
     /**

package/dist/entities/crm-activity/index.d.ts

@@ -0,0 +1,43 @@
+import { ResourceActivity } from '../activity/resource-activity';
+import { LifecycleStage } from '../contact/lifecycle';
+/**
+ * The feed under a contact or a company: notes, logged calls, stage changes.
+ *
+ * The work-activity pattern (`entities/work/activity.ts`), keyed on the record's scope key
+ * (`contact:<id>`, `company:<id>`) instead of an item id. The type names are crm's own — reusing
+ * comms' `COMMENT_ADDED` would fire every comms playbook trigger on a crm note.
+ */
+export declare const CRM_NOTE_ADDED = "CRM_NOTE_ADDED";
+/** The scope kind of one feed row, `crm_activity:<id>` — what the reaction store asks about. */
+export declare const CRM_ACTIVITY_SCOPE_KIND = "crm_activity";
+/** A call or meeting that happened outside the system, written down afterwards. */
+export declare const CRM_CALL_LOGGED = "CRM_CALL_LOGGED";
+/** History, not content: written by the update routes, never editable. */
+export declare const CRM_STAGE_CHANGED = "CRM_STAGE_CHANGED";
+export type CrmActivityType = typeof CRM_NOTE_ADDED | typeof CRM_CALL_LOGGED | typeof CRM_STAGE_CHANGED;
+export declare const CRM_CALL_CHANNELS: readonly ["phone", "meeting", "video"];
+export type CrmCallChannel = (typeof CRM_CALL_CHANNELS)[number];
+export declare const CRM_CALL_OUTCOMES: readonly ["callback", "interested", "no_answer", "not_interested"];
+export type CrmCallOutcome = (typeof CRM_CALL_OUTCOMES)[number];
+export interface CrmCall {
+    channel: CrmCallChannel;
+    /** When the call happened, not when it was logged. The timeline sorts on this. */
+    at: number;
+    durationMin?: number;
+    outcome?: CrmCallOutcome;
+}
+export interface CrmActivity extends ResourceActivity<CrmActivityType, {
+    text?: string;
+    html?: string;
+    mentions?: string[];
+    call?: CrmCall;
+    fromStage?: LifecycleStage;
+    toStage?: LifecycleStage;
+}> {
+    /** `contact:<id>` or `company:<id>`. */
+    record: string;
+}
+/** Rows a person wrote, and may therefore edit or delete. A stage row is history. */
+export declare const isAuthoredCrmActivity: (type: string) => boolean;
+/** Where the timeline puts the row: a call at the moment it happened, the rest when written. */
+export declare const crmActivityAt: (activity: CrmActivity) => number;

package/dist/entities/time-entry/billing.d.ts

@@ -0,0 +1,20 @@
+import { TimeEntry } from './types';
+/** Booked hours that become one invoice line: one work type on one subject. */
+export interface BillableTimeGroup {
+    /** `WorkType.key`; absent = booked without a type, which no product can carry. */
+    workType?: string;
+    scopeKey?: string;
+    scopeLabel?: string;
+    seconds: number;
+    /** Hours, two decimals — what goes on the line as `quantity`. */
+    hours: number;
+    entryIds: string[];
+    /** Epoch ms of the first and last entry, for the line's description. */
+    from: number;
+    to: number;
+}
+/**
+ * Group billable entries per work type × subject, in the order they were first booked.
+ * `durationSeconds` is the booked duration, so rounding has already been applied per entry.
+ */
+export declare function billableTimeGroups(entries: readonly TimeEntry[]): BillableTimeGroup[];

package/dist/entities/time-entry/billing.test.d.ts

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

package/dist/entities/time-entry/index.d.ts

@@ -1,3 +1,4 @@
+export * from './billing';
 export * from './duration';
 export * from './types';
 export * from './work-type';

package/dist/entities/time-entry/types.d.ts

@@ -69,6 +69,11 @@ export interface TimeEntry {
     workType?: string;
     note?: string;
     source: TimeEntrySource;
+    /**
+     * The invoice (a sales transaction id) this entry is on, draft included. Set by sales only;
+     * while set, the entry cannot be edited or deleted — that is what stops billing it twice.
+     */
+    invoicedTransactionId?: string;
     createdAt?: number;
     updatedAt?: number;
 }

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

@@ -177,6 +177,11 @@ export interface TransactionLine {
      * booked against, not what the customer reads.
      */
     dealItemId?: string;
+    /**
+     * The time entries this line bills. Sales stamps exactly this set onto them on every save, so
+     * the line — not the entry — is the source of truth. Never copied to a new document.
+     */
+    timeEntryIds?: string[];
     /**
      * An option: priced and shown, but **not** in the total.
      *

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

@@ -1,4 +1,4 @@
-import { ReactionSummary } from '../reaction/types';
+import { ResourceActivity } from '../activity/resource-activity';
 import { WorkStatusCategory } from './types';
 /**
  * The activity feed under a work item.
@@ -22,39 +22,15 @@ export declare const WORK_ITEM_ASSIGNED = "WORK_ITEM_ASSIGNED";
  */
 export declare const WORK_ITEM_STATUS_CHANGED = "WORK_ITEM_STATUS_CHANGED";
 export type WorkActivityType = typeof WORK_COMMENT_ADDED | typeof WORK_ITEM_ASSIGNED | typeof WORK_ITEM_STATUS_CHANGED;
-export interface WorkActivity {
-    id: string;
-    organizationId: string;
-    itemId: string;
-    type: WorkActivityType;
-    author: {
-        type: "user" | "system" | "app";
-        id?: string;
-        name: string;
-    };
-    /**
-     * Always `"internal"`. Never `"inbound"`: rule 1 of `wakesAssignment` treats inbound as
-     * "the customer answered" and would wake every waiting assignment on the item.
-     */
-    direction: "internal";
-    /** The activity this one answers — same one-level thread as comms' `BaseActivity.parentId`. */
-    parentId?: string;
+export interface WorkActivity extends ResourceActivity<WorkActivityType, {
     /** `html` is the composer's markup for a comment; `text` stays the plain reading of it. */
-    payload: {
-        text?: string;
-        html?: string;
-        mentions?: string[];
-        assigneeId?: string;
-        fromStatus?: string;
-        toStatus?: string;
-        toCategory?: WorkStatusCategory;
-    };
-    /**
-     * The emoji on this comment, as the list route projects them. Read-only and never stored
-     * on the row — see `BaseActivity.reactions`, which this mirrors, and the generic store in
-     * the communication app that both read from.
-     */
-    reactions?: ReactionSummary[];
-    createdAt?: number;
-    updatedAt?: number;
+    text?: string;
+    html?: string;
+    mentions?: string[];
+    assigneeId?: string;
+    fromStatus?: string;
+    toStatus?: string;
+    toCategory?: WorkStatusCategory;
+}> {
+    itemId: string;
 }