@opencxh/domain 1.277.0 → 1.279.0

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,5 +1,8 @@
 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";
 /** Where a company row came from. `local` is a row somebody created by hand. */
 export interface CompanySource {
     providerId: string;
@@ -40,6 +43,11 @@ export interface Company {
     externalIds: string[];
     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;
     /**
      * Where the company sits. Needed by anything that puts this company on paper — a quote's
      * recipient block is the first, and the issue gate refuses a document with a hole in it.

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

@@ -1,3 +1,6 @@
 export * from './endpoints';
+export * from './lifecycle';
+export * from './name';
 export * from './provider';
+export * from './segment';
 export * from './types';

package/dist/entities/contact/lifecycle.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Where a person stands with us. `lead` has not been qualified yet; qualifying (a deal is made)
+ * moves it to `opportunity`. `customer` and `former` are set by hand or by a rule.
+ */
+export declare const LIFECYCLE_STAGES: readonly ["lead", "opportunity", "customer", "former"];
+export type LifecycleStage = (typeof LIFECYCLE_STAGES)[number];
+/** How far a lead is worked; only meaningful while the stage is `lead`. */
+export declare const LEAD_STATUSES: readonly ["new", "working", "unqualified"];
+export type LeadStatus = (typeof LEAD_STATUSES)[number];

package/dist/entities/contact/name.d.ts

@@ -0,0 +1,3 @@
+import { Contact } from './types';
+/** "First Last", trimmed; empty when the row has neither. */
+export declare function contactName(contact: Pick<Contact, "firstName" | "lastName">): string;

package/dist/entities/contact/segment.d.ts

@@ -0,0 +1,32 @@
+import { SavedView, SavedViewSort } from '../saved-view/types';
+/**
+ * A crm segment: a {@link SavedView} over contacts or companies. It stores the question, never
+ * the rows — whoever matches later is in it. One filter shape for both lists; `SEGMENT_FILTER_KEYS`
+ * says which keys a kind reads, and the server drops the rest.
+ */
+export type SegmentKind = "contact" | "company";
+/** Multi-value filters: empty or absent = no filter on that axis. */
+export declare const SEGMENT_LIST_FILTERS: readonly ["stages", "leadStatuses", "sources", "scopes", "cities", "parentCompanyIds"];
+export type SegmentListFilter = (typeof SEGMENT_LIST_FILTERS)[number];
+/** Yes/no filters that need another store to answer: open deals in work, people at a company. */
+export declare const SEGMENT_PRESENCE_FILTERS: readonly ["openDeal", "hasContacts"];
+export type SegmentPresenceFilter = (typeof SEGMENT_PRESENCE_FILTERS)[number];
+export type SegmentFilters = {
+    search?: string;
+    /** Created in the last N days; relative, so a saved segment stays current. */
+    createdWithinDays?: number;
+    /** Select custom fields: field key → accepted values. */
+    fields?: Record<string, string[]>;
+} & Partial<Record<SegmentListFilter, string[]>> & Partial<Record<SegmentPresenceFilter, "yes" | "no">>;
+/** Which filters each list offers. `sources` holds provider ids (`local`, `hubspot`). */
+export declare const SEGMENT_FILTER_KEYS: Record<SegmentKind, readonly string[]>;
+export declare const SEGMENT_SORT_FIELDS: readonly ["updatedAt", "createdAt", "name"];
+export type SegmentSortField = (typeof SEGMENT_SORT_FIELDS)[number];
+export type SegmentSort = SavedViewSort<SegmentSortField>;
+export declare const SEGMENT_LAYOUTS: readonly ["list"];
+export type SegmentLayout = (typeof SEGMENT_LAYOUTS)[number];
+export type CrmSegment = SavedView<SegmentFilters, SegmentLayout, SegmentSortField> & {
+    kind: SegmentKind;
+};
+/** True when a filter narrows anything; an empty segment is the plain list. */
+export declare function segmentIsEmpty(filters: SegmentFilters): boolean;

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

@@ -1,5 +1,6 @@
 import { CommunicationScheme } from '../../platform/communication';
 import { OwnerScope } from '../scope/types';
+import { LeadStatus, LifecycleStage } from './lifecycle';
 export interface ContactEndpoint {
     scheme: CommunicationScheme;
     resource: string;
@@ -69,6 +70,11 @@ export interface Contact {
      */
     locale?: string;
     origin?: ContactOrigin;
+    jobTitle?: string;
+    lifecycleStage?: LifecycleStage;
+    leadStatus?: LeadStatus;
+    /** When a deal was first made for this person (`POST /contact/:id/qualify`). */
+    qualifiedAt?: number;
     /** When a shadow row last saw its source. There is no refresh job; touching refreshes. */
     syncedAt?: 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.
      *