@baack-software/baack-ts-crm 0.0.0-stage → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +74 -2
- package/dist/account.d.ts +36 -0
- package/dist/account.d.ts.map +1 -0
- package/dist/account.js +48 -0
- package/dist/account.js.map +1 -0
- package/dist/backend.d.ts +104 -0
- package/dist/backend.d.ts.map +1 -0
- package/dist/backend.js +328 -0
- package/dist/backend.js.map +1 -0
- package/dist/crm-client.d.ts +164 -0
- package/dist/crm-client.d.ts.map +1 -0
- package/dist/crm-client.js +252 -0
- package/dist/crm-client.js.map +1 -0
- package/dist/deal-order.d.ts +42 -0
- package/dist/deal-order.d.ts.map +1 -0
- package/dist/deal-order.js +80 -0
- package/dist/deal-order.js.map +1 -0
- package/dist/errors.d.ts +21 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +33 -0
- package/dist/errors.js.map +1 -0
- package/dist/index.d.ts +14 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +14 -0
- package/dist/index.js.map +1 -0
- package/dist/invoices.d.ts +53 -0
- package/dist/invoices.d.ts.map +1 -0
- package/dist/invoices.js +155 -0
- package/dist/invoices.js.map +1 -0
- package/dist/leads.d.ts +29 -0
- package/dist/leads.d.ts.map +1 -0
- package/dist/leads.js +56 -0
- package/dist/leads.js.map +1 -0
- package/dist/mock/index.d.ts +43 -0
- package/dist/mock/index.d.ts.map +1 -0
- package/dist/mock/index.js +303 -0
- package/dist/mock/index.js.map +1 -0
- package/dist/money.d.ts +29 -0
- package/dist/money.d.ts.map +1 -0
- package/dist/money.js +82 -0
- package/dist/money.js.map +1 -0
- package/dist/period.d.ts +30 -0
- package/dist/period.d.ts.map +1 -0
- package/dist/period.js +49 -0
- package/dist/period.js.map +1 -0
- package/dist/pipeline.d.ts +36 -0
- package/dist/pipeline.d.ts.map +1 -0
- package/dist/pipeline.js +58 -0
- package/dist/pipeline.js.map +1 -0
- package/dist/react/Charts.d.ts +19 -0
- package/dist/react/Charts.d.ts.map +1 -0
- package/dist/react/Charts.js +38 -0
- package/dist/react/Charts.js.map +1 -0
- package/dist/react/ChoiceCombobox.d.ts +36 -0
- package/dist/react/ChoiceCombobox.d.ts.map +1 -0
- package/dist/react/ChoiceCombobox.js +105 -0
- package/dist/react/ChoiceCombobox.js.map +1 -0
- package/dist/react/CompanyAccountView.d.ts +21 -0
- package/dist/react/CompanyAccountView.d.ts.map +1 -0
- package/dist/react/CompanyAccountView.js +27 -0
- package/dist/react/CompanyAccountView.js.map +1 -0
- package/dist/react/DashboardCards.d.ts +32 -0
- package/dist/react/DashboardCards.d.ts.map +1 -0
- package/dist/react/DashboardCards.js +38 -0
- package/dist/react/DashboardCards.js.map +1 -0
- package/dist/react/DealsBoard.d.ts +49 -0
- package/dist/react/DealsBoard.d.ts.map +1 -0
- package/dist/react/DealsBoard.js +82 -0
- package/dist/react/DealsBoard.js.map +1 -0
- package/dist/react/Details.d.ts +85 -0
- package/dist/react/Details.d.ts.map +1 -0
- package/dist/react/Details.js +268 -0
- package/dist/react/Details.js.map +1 -0
- package/dist/react/Forms.d.ts +190 -0
- package/dist/react/Forms.d.ts.map +1 -0
- package/dist/react/Forms.js +494 -0
- package/dist/react/Forms.js.map +1 -0
- package/dist/react/LeadsTable.d.ts +22 -0
- package/dist/react/LeadsTable.d.ts.map +1 -0
- package/dist/react/LeadsTable.js +79 -0
- package/dist/react/LeadsTable.js.map +1 -0
- package/dist/react/Sales.d.ts +68 -0
- package/dist/react/Sales.d.ts.map +1 -0
- package/dist/react/Sales.js +270 -0
- package/dist/react/Sales.js.map +1 -0
- package/dist/react/SidePanel.d.ts +31 -0
- package/dist/react/SidePanel.d.ts.map +1 -0
- package/dist/react/SidePanel.js +49 -0
- package/dist/react/SidePanel.js.map +1 -0
- package/dist/react/format.d.ts +28 -0
- package/dist/react/format.d.ts.map +1 -0
- package/dist/react/format.js +30 -0
- package/dist/react/format.js.map +1 -0
- package/dist/react/index.d.ts +15 -0
- package/dist/react/index.d.ts.map +1 -0
- package/dist/react/index.js +15 -0
- package/dist/react/index.js.map +1 -0
- package/dist/react/parts.d.ts +55 -0
- package/dist/react/parts.d.ts.map +1 -0
- package/dist/react/parts.js +82 -0
- package/dist/react/parts.js.map +1 -0
- package/dist/react/pipeline-choice.d.ts +19 -0
- package/dist/react/pipeline-choice.d.ts.map +1 -0
- package/dist/react/pipeline-choice.js +39 -0
- package/dist/react/pipeline-choice.js.map +1 -0
- package/dist/react/text.d.ts +232 -0
- package/dist/react/text.d.ts.map +1 -0
- package/dist/react/text.js +229 -0
- package/dist/react/text.js.map +1 -0
- package/dist/react/ui/alert.d.ts +11 -0
- package/dist/react/ui/alert.d.ts.map +1 -0
- package/dist/react/ui/alert.js +29 -0
- package/dist/react/ui/alert.js.map +1 -0
- package/dist/react/ui/badge.d.ts +10 -0
- package/dist/react/ui/badge.d.ts.map +1 -0
- package/dist/react/ui/badge.js +26 -0
- package/dist/react/ui/badge.js.map +1 -0
- package/dist/react/ui/button.d.ts +11 -0
- package/dist/react/ui/button.d.ts.map +1 -0
- package/dist/react/ui/button.js +37 -0
- package/dist/react/ui/button.js.map +1 -0
- package/dist/react/ui/card.d.ts +12 -0
- package/dist/react/ui/card.d.ts.map +1 -0
- package/dist/react/ui/card.js +26 -0
- package/dist/react/ui/card.js.map +1 -0
- package/dist/react/ui/chart.d.ts +45 -0
- package/dist/react/ui/chart.d.ts.map +1 -0
- package/dist/react/ui/chart.js +116 -0
- package/dist/react/ui/chart.js.map +1 -0
- package/dist/react/ui/input.d.ts +4 -0
- package/dist/react/ui/input.d.ts.map +1 -0
- package/dist/react/ui/input.js +8 -0
- package/dist/react/ui/input.js.map +1 -0
- package/dist/react/ui/label.d.ts +5 -0
- package/dist/react/ui/label.d.ts.map +1 -0
- package/dist/react/ui/label.js +10 -0
- package/dist/react/ui/label.js.map +1 -0
- package/dist/react/ui/progress.d.ts +5 -0
- package/dist/react/ui/progress.d.ts.map +1 -0
- package/dist/react/ui/progress.js +10 -0
- package/dist/react/ui/progress.js.map +1 -0
- package/dist/react/ui/select.d.ts +16 -0
- package/dist/react/ui/select.d.ts.map +1 -0
- package/dist/react/ui/select.js +37 -0
- package/dist/react/ui/select.js.map +1 -0
- package/dist/react/ui/separator.d.ts +5 -0
- package/dist/react/ui/separator.d.ts.map +1 -0
- package/dist/react/ui/separator.js +10 -0
- package/dist/react/ui/separator.js.map +1 -0
- package/dist/react/ui/sheet.d.ts +15 -0
- package/dist/react/ui/sheet.d.ts.map +1 -0
- package/dist/react/ui/sheet.js +38 -0
- package/dist/react/ui/sheet.js.map +1 -0
- package/dist/react/ui/skeleton.d.ts +3 -0
- package/dist/react/ui/skeleton.d.ts.map +1 -0
- package/dist/react/ui/skeleton.js +7 -0
- package/dist/react/ui/skeleton.js.map +1 -0
- package/dist/react/ui/table.d.ts +11 -0
- package/dist/react/ui/table.d.ts.map +1 -0
- package/dist/react/ui/table.js +29 -0
- package/dist/react/ui/table.js.map +1 -0
- package/dist/react/ui/tabs.d.ts +12 -0
- package/dist/react/ui/tabs.d.ts.map +1 -0
- package/dist/react/ui/tabs.js +31 -0
- package/dist/react/ui/tabs.js.map +1 -0
- package/dist/react/views.d.ts +82 -0
- package/dist/react/views.d.ts.map +1 -0
- package/dist/react/views.js +241 -0
- package/dist/react/views.js.map +1 -0
- package/dist/sales.d.ts +82 -0
- package/dist/sales.d.ts.map +1 -0
- package/dist/sales.js +87 -0
- package/dist/sales.js.map +1 -0
- package/dist/store.d.ts +159 -0
- package/dist/store.d.ts.map +1 -0
- package/dist/store.js +305 -0
- package/dist/store.js.map +1 -0
- package/dist/target.d.ts +22 -0
- package/dist/target.d.ts.map +1 -0
- package/dist/target.js +40 -0
- package/dist/target.js.map +1 -0
- package/dist/types.d.ts +204 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -0
- package/package.json +100 -4
- package/src/account.ts +79 -0
- package/src/backend.ts +501 -0
- package/src/crm-client.ts +393 -0
- package/src/deal-order.ts +116 -0
- package/src/errors.ts +34 -0
- package/src/index.ts +13 -0
- package/src/invoices.ts +177 -0
- package/src/leads.ts +78 -0
- package/src/mock/index.ts +398 -0
- package/src/money.ts +104 -0
- package/src/period.ts +71 -0
- package/src/pipeline.ts +82 -0
- package/src/react/Charts.tsx +143 -0
- package/src/react/ChoiceCombobox.tsx +227 -0
- package/src/react/CompanyAccountView.tsx +198 -0
- package/src/react/DashboardCards.tsx +171 -0
- package/src/react/DealsBoard.tsx +344 -0
- package/src/react/Details.tsx +870 -0
- package/src/react/Forms.tsx +1486 -0
- package/src/react/LeadsTable.tsx +234 -0
- package/src/react/Sales.tsx +827 -0
- package/src/react/SidePanel.tsx +104 -0
- package/src/react/format.ts +53 -0
- package/src/react/index.ts +14 -0
- package/src/react/parts.tsx +183 -0
- package/src/react/pipeline-choice.ts +54 -0
- package/src/react/text.ts +232 -0
- package/src/react/ui/README.md +6 -0
- package/src/react/ui/alert.tsx +75 -0
- package/src/react/ui/badge.tsx +48 -0
- package/src/react/ui/button.tsx +66 -0
- package/src/react/ui/card.tsx +102 -0
- package/src/react/ui/chart.tsx +304 -0
- package/src/react/ui/input.tsx +18 -0
- package/src/react/ui/label.tsx +23 -0
- package/src/react/ui/progress.tsx +30 -0
- package/src/react/ui/select.tsx +189 -0
- package/src/react/ui/separator.tsx +27 -0
- package/src/react/ui/sheet.tsx +145 -0
- package/src/react/ui/skeleton.tsx +13 -0
- package/src/react/ui/table.tsx +113 -0
- package/src/react/ui/tabs.tsx +89 -0
- package/src/react/views.tsx +633 -0
- package/src/sales.ts +167 -0
- package/src/store.ts +528 -0
- package/src/target.ts +54 -0
- package/src/types.ts +230 -0
package/dist/store.d.ts
ADDED
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
import type { Company } from '@baack-software/baack-ts-client';
|
|
2
|
+
import { type RefLike } from '@baack-software/baack-ts-tasks';
|
|
3
|
+
import { type CompanyAccount } from './account.ts';
|
|
4
|
+
import type { DealInput, InvoiceInput, LeadInput, RemittanceInput } from './backend.ts';
|
|
5
|
+
import type { ConvertOptions, CrmClient, InvoicePartyOptions, NewInvoiceOptions, NewLeadOptions } from './crm-client.ts';
|
|
6
|
+
import { type SourceCount } from './leads.ts';
|
|
7
|
+
import { type MoneyTotals } from './money.ts';
|
|
8
|
+
import { type DateRange } from './period.ts';
|
|
9
|
+
import { type StageSummary } from './pipeline.ts';
|
|
10
|
+
import { type SalesSummary } from './sales.ts';
|
|
11
|
+
import { type SalesTarget } from './target.ts';
|
|
12
|
+
import { type ContactDetails, type CrmConcept, type CrmPerson, type Deal, type DealOutcome, type Invoice, type Lead, type LeadOutcome, type NewContact, type Pipeline, type PipelineStage, type Remittance } from './types.ts';
|
|
13
|
+
export interface CrmStoreOptions {
|
|
14
|
+
/** The company whose CRM the store holds. */
|
|
15
|
+
owner: RefLike;
|
|
16
|
+
}
|
|
17
|
+
export type LoadStatus = 'idle' | 'loading' | 'ready' | 'error';
|
|
18
|
+
/** How one concept loaded. `unavailable`: the API doesn't have it yet and it isn't served from sample data. */
|
|
19
|
+
export interface ConceptState {
|
|
20
|
+
status: LoadStatus | 'unavailable';
|
|
21
|
+
error?: unknown;
|
|
22
|
+
}
|
|
23
|
+
/** A snapshot of the store. Each change replaces it, so it can be compared by reference. */
|
|
24
|
+
export interface CrmStoreState {
|
|
25
|
+
/** `ready` once every concept has loaded or been found unavailable; `error` if any failed otherwise. */
|
|
26
|
+
status: LoadStatus;
|
|
27
|
+
concepts: Readonly<Record<CrmConcept, ConceptState>>;
|
|
28
|
+
leads: readonly Lead[];
|
|
29
|
+
deals: readonly Deal[];
|
|
30
|
+
pipelines: readonly Pipeline[];
|
|
31
|
+
invoices: readonly Invoice[];
|
|
32
|
+
remittances: readonly Remittance[];
|
|
33
|
+
/** Client companies made while the store was open, such as a converted lead's prospect, with their names. */
|
|
34
|
+
companies: readonly Company[];
|
|
35
|
+
/** People made while the store was open, such as a lead's new contact, with their names. */
|
|
36
|
+
people: readonly CrmPerson[];
|
|
37
|
+
/** URNs of records with a write in flight. */
|
|
38
|
+
saving: ReadonlySet<string>;
|
|
39
|
+
/** The last write the server refused, until the next write. */
|
|
40
|
+
writeError?: unknown;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Holds a company's CRM records for a UI: loads every concept, applies changes straight away and rolls them back if
|
|
44
|
+
* the server refuses, and notifies subscribers. `subscribe` and `getState` fit React's `useSyncExternalStore`.
|
|
45
|
+
*
|
|
46
|
+
* ```ts
|
|
47
|
+
* const store = new CrmStore(crm, { owner });
|
|
48
|
+
* store.subscribe(() => render(selectDashboard(store.getState(), lastDays(28))));
|
|
49
|
+
* await store.load();
|
|
50
|
+
* await store.moveDeal(dealUrn, stage);
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
export declare class CrmStore {
|
|
54
|
+
#private;
|
|
55
|
+
readonly client: CrmClient;
|
|
56
|
+
readonly options: CrmStoreOptions;
|
|
57
|
+
constructor(client: CrmClient, options: CrmStoreOptions);
|
|
58
|
+
getState: () => CrmStoreState;
|
|
59
|
+
subscribe: (listener: () => void) => (() => void);
|
|
60
|
+
/** Drops subscribers; answers still arriving are ignored. */
|
|
61
|
+
dispose(): void;
|
|
62
|
+
/** Loads (or reloads) every concept at once. A concept that fails doesn't stop the others. */
|
|
63
|
+
load(): Promise<void>;
|
|
64
|
+
/**
|
|
65
|
+
* Creates a lead, shown at the top straight away. With `companyName` or `contact`, the prospect's company or contact
|
|
66
|
+
* is made first and linked (see `CrmClient.createLead`).
|
|
67
|
+
*/
|
|
68
|
+
createLead(input: LeadInput, options?: NewLeadOptions): Promise<Lead>;
|
|
69
|
+
/**
|
|
70
|
+
* Changes a lead, shown at once. With `companyName` or `contact`, its new company or contact is made first, as for
|
|
71
|
+
* a new lead (see `CrmClient.updateLead`).
|
|
72
|
+
*/
|
|
73
|
+
updateLead(lead: RefLike, changes: Partial<LeadInput>, options?: NewLeadOptions): Promise<Lead>;
|
|
74
|
+
/** A person's email and telephone, read when asked for: they aren't held in the store's state. */
|
|
75
|
+
contactDetails(identity: RefLike): Promise<ContactDetails>;
|
|
76
|
+
/** Sets a person's email and telephone; fields left out are kept. */
|
|
77
|
+
setContactDetails(identity: RefLike, details: Partial<ContactDetails>): Promise<ContactDetails>;
|
|
78
|
+
/** Makes a person owned by the store's company: a customer's person when `company` is given. */
|
|
79
|
+
createContact(contact: NewContact, company?: RefLike | null): Promise<CrmPerson>;
|
|
80
|
+
/** Qualifies a lead into a deal (see `CrmClient.convertLead`). Shown once the server has made the deal. */
|
|
81
|
+
convertLead(lead: RefLike, options: ConvertOptions): Promise<{
|
|
82
|
+
lead: Lead;
|
|
83
|
+
deal: Deal;
|
|
84
|
+
company?: Company;
|
|
85
|
+
}>;
|
|
86
|
+
/** Moves a deal to a stage, shown at once (see `CrmClient.moveDeal`). */
|
|
87
|
+
moveDeal(deal: RefLike, stage: PipelineStage): Promise<Deal>;
|
|
88
|
+
/** Changes a deal's fields, shown at once. Moving it between stages is `moveDeal`; its outcome, `setOutcome`. */
|
|
89
|
+
updateDeal(deal: RefLike, changes: Partial<DealInput>): Promise<Deal>;
|
|
90
|
+
/**
|
|
91
|
+
* Changes an invoice's own fields (status, parties, dates), shown at once, making a party's new company and person
|
|
92
|
+
* first when `options` asks (see `CrmClient.updateInvoice`). Its lines and payments aren't changed by an update, so
|
|
93
|
+
* they're kept as they were when the server's answer leaves them out or has none.
|
|
94
|
+
*/
|
|
95
|
+
updateInvoice(invoice: RefLike, changes: Partial<InvoiceInput>, options?: InvoicePartyOptions): Promise<Invoice>;
|
|
96
|
+
/** Wins, loses or reopens a deal, shown at once (see `CrmClient.setOutcome`). */
|
|
97
|
+
setOutcome(deal: RefLike, outcome: DealOutcome, options?: {
|
|
98
|
+
lostReason?: string;
|
|
99
|
+
}): Promise<Deal>;
|
|
100
|
+
/** Closes a lead as unqualified or reopens it, shown at once (see `CrmClient.setLeadOutcome`). */
|
|
101
|
+
setLeadOutcome(lead: RefLike, outcome: Exclude<LeadOutcome, 'CONVERTED'>, options?: {
|
|
102
|
+
closedReason?: string;
|
|
103
|
+
}): Promise<Lead>;
|
|
104
|
+
/** Creates a deal, shown on the board straight away. */
|
|
105
|
+
createDeal(input: DealInput): Promise<Deal>;
|
|
106
|
+
/**
|
|
107
|
+
* Creates an invoice with its lines, linked to `deal` when given (see `CrmClient.createInvoice`). Shown once the
|
|
108
|
+
* server has made it, as its lines are made one by one.
|
|
109
|
+
*/
|
|
110
|
+
createInvoice(input: InvoiceInput, lines?: Parameters<CrmClient['createInvoice']>[1], options?: NewInvoiceOptions): Promise<Invoice>;
|
|
111
|
+
/** Records a payment or refund against an invoice. */
|
|
112
|
+
recordPayment(input: RemittanceInput): Promise<Remittance>;
|
|
113
|
+
}
|
|
114
|
+
/** A number now and in the period before, with the change between them (undefined with nothing before). */
|
|
115
|
+
export interface Compared<T> {
|
|
116
|
+
current: T;
|
|
117
|
+
previous: T;
|
|
118
|
+
change: number | undefined;
|
|
119
|
+
}
|
|
120
|
+
export interface Dashboard {
|
|
121
|
+
range: DateRange;
|
|
122
|
+
/** Companies with a won deal; compared: companies whose first won deal closed in each period. */
|
|
123
|
+
customers: {
|
|
124
|
+
total: number;
|
|
125
|
+
added: Compared<number>;
|
|
126
|
+
};
|
|
127
|
+
/** Open deals and their value; compared: deals created in each period. */
|
|
128
|
+
openDeals: {
|
|
129
|
+
count: number;
|
|
130
|
+
value: MoneyTotals;
|
|
131
|
+
created: Compared<number>;
|
|
132
|
+
};
|
|
133
|
+
/** Payments received less refunds, in each period. */
|
|
134
|
+
revenue: Compared<MoneyTotals> & {
|
|
135
|
+
currencyCode: string | undefined;
|
|
136
|
+
};
|
|
137
|
+
/** Payments received less refunds on each day of the period. */
|
|
138
|
+
revenueByDay: {
|
|
139
|
+
day: string;
|
|
140
|
+
totals: MoneyTotals;
|
|
141
|
+
}[];
|
|
142
|
+
/** Leads created in each period. */
|
|
143
|
+
newLeads: Compared<number>;
|
|
144
|
+
target: SalesTarget;
|
|
145
|
+
leadsBySource: SourceCount[];
|
|
146
|
+
/** The first pipeline's stages. */
|
|
147
|
+
pipeline: StageSummary[];
|
|
148
|
+
}
|
|
149
|
+
/** The largest currency in a set of totals. */
|
|
150
|
+
export declare const mainCurrency: (totals: MoneyTotals) => string | undefined;
|
|
151
|
+
/** Everything a CRM dashboard shows for a period, compared with the period before. */
|
|
152
|
+
export declare function selectDashboard(state: CrmStoreState, range: DateRange, own?: ReadonlySet<string>,
|
|
153
|
+
/** The user's chosen pipeline, for the pipeline card (see `defaultPipeline`). */
|
|
154
|
+
chosenPipeline?: string): Dashboard;
|
|
155
|
+
/** One customer company's account from the store's records. */
|
|
156
|
+
export declare function selectAccount(state: CrmStoreState, company: RefLike, now?: Date): CompanyAccount;
|
|
157
|
+
/** Sales for a period from the store's invoices and payments, costs apart (see `salesSummary`). */
|
|
158
|
+
export declare function selectSales(state: CrmStoreState, range: DateRange, now?: Date, own?: ReadonlySet<string>): SalesSummary;
|
|
159
|
+
//# sourceMappingURL=store.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../src/store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAS,KAAK,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAkB,KAAK,cAAc,EAAE,MAAM,cAAc,CAAC;AACnE,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACxF,OAAO,KAAK,EACV,cAAc,EACd,SAAS,EACT,mBAAmB,EAEnB,iBAAiB,EACjB,cAAc,EACf,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAiB,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,EAAY,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAwC,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AACnF,OAAO,EAA8D,KAAK,YAAY,EAAE,MAAM,eAAe,CAAC;AAE9G,OAAO,EAAkC,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAC/E,OAAO,EAAe,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,EAEL,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,IAAI,EACT,KAAK,WAAW,EAChB,KAAK,OAAO,EACZ,KAAK,IAAI,EACT,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,QAAQ,EACb,KAAK,aAAa,EAClB,KAAK,UAAU,EAChB,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,eAAe;IAC9B,6CAA6C;IAC7C,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC;AAEhE,+GAA+G;AAC/G,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,UAAU,GAAG,aAAa,CAAC;IACnC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,4FAA4F;AAC5F,MAAM,WAAW,aAAa;IAC5B,wGAAwG;IACxG,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC;IACrD,KAAK,EAAE,SAAS,IAAI,EAAE,CAAC;IACvB,KAAK,EAAE,SAAS,IAAI,EAAE,CAAC;IACvB,SAAS,EAAE,SAAS,QAAQ,EAAE,CAAC;IAC/B,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAC;IAC7B,WAAW,EAAE,SAAS,UAAU,EAAE,CAAC;IACnC,6GAA6G;IAC7G,SAAS,EAAE,SAAS,OAAO,EAAE,CAAC;IAC9B,4FAA4F;IAC5F,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;IAC7B,8CAA8C;IAC9C,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC5B,+DAA+D;IAC/D,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAuCD;;;;;;;;;;GAUG;AACH,qBAAa,QAAQ;;IAMjB,QAAQ,CAAC,MAAM,EAAE,SAAS;IAC1B,QAAQ,CAAC,OAAO,EAAE,eAAe;gBADxB,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,eAAe;IAGnC,QAAQ,QAAO,aAAa,CAAgB;IAE5C,SAAS,GAAI,UAAU,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAAC,CAG9C;IAEF,6DAA6D;IAC7D,OAAO,IAAI,IAAI;IAef,8FAA8F;IACxF,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAmD3B;;;OAGG;IACG,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAe/E;;;OAGG;IACG,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAazG,kGAAkG;IAClG,cAAc,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC;IAI1D,qEAAqE;IACrE,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;IAI/F,gGAAgG;IAChG,aAAa,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC;IAShF,2GAA2G;IACrG,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,IAAI,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IAgBjH,yEAAyE;IACzE,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5D,iHAAiH;IACjH,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAUrE;;;;OAIG;IACG,aAAa,CACjB,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,EAC9B,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,OAAO,CAAC;IAoBnB,iFAAiF;IACjF,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAUrG,kGAAkG;IAClG,cAAc,CACZ,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,OAAO,CAAC,WAAW,EAAE,WAAW,CAAC,EAC1C,OAAO,GAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAA;KAAO,GACtC,OAAO,CAAC,IAAI,CAAC;IAUhB,wDAAwD;IACxD,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAW3C;;;OAGG;IACG,aAAa,CACjB,KAAK,EAAE,YAAY,EACnB,KAAK,GAAE,UAAU,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAM,EACrD,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,OAAO,CAAC;IAcnB,sDAAsD;IACtD,aAAa,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC;CAW3D;AAUD,2GAA2G;AAC3G,MAAM,WAAW,QAAQ,CAAC,CAAC;IACzB,OAAO,EAAE,CAAC,CAAC;IACX,QAAQ,EAAE,CAAC,CAAC;IACZ,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,SAAS,CAAC;IACjB,iGAAiG;IACjG,SAAS,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC;IACtD,0EAA0E;IAC1E,SAAS,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,WAAW,CAAC;QAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC;IAC5E,sDAAsD;IACtD,OAAO,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG;QAAE,YAAY,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAC;IACtE,gEAAgE;IAChE,YAAY,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,WAAW,CAAA;KAAE,EAAE,CAAC;IACrD,oCAAoC;IACpC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3B,MAAM,EAAE,WAAW,CAAC;IACpB,aAAa,EAAE,WAAW,EAAE,CAAC;IAC7B,mCAAmC;IACnC,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAQD,+CAA+C;AAC/C,eAAO,MAAM,YAAY,GAAI,QAAQ,WAAW,KAAG,MAAM,GAAG,SACE,CAAC;AAE/D,sFAAsF;AACtF,wBAAgB,eAAe,CAC7B,KAAK,EAAE,aAAa,EACpB,KAAK,EAAE,SAAS,EAChB,GAAG,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC;AACzB,iFAAiF;AACjF,cAAc,CAAC,EAAE,MAAM,GACtB,SAAS,CA8DX;AAED,+DAA+D;AAC/D,wBAAgB,aAAa,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,OAAa,GAAG,cAAc,CAEtG;AAED,mGAAmG;AACnG,wBAAgB,WAAW,CACzB,KAAK,EAAE,aAAa,EACpB,KAAK,EAAE,SAAS,EAChB,GAAG,OAAa,EAChB,GAAG,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,GACxB,YAAY,CAEd"}
|
package/dist/store.js
ADDED
|
@@ -0,0 +1,305 @@
|
|
|
1
|
+
import { urnOf } from '@baack-software/baack-ts-tasks';
|
|
2
|
+
import { companyAccount } from "./account.js";
|
|
3
|
+
import { CrmUnavailableError } from "./errors.js";
|
|
4
|
+
import { leadsBySource } from "./leads.js";
|
|
5
|
+
import { addMoney } from "./money.js";
|
|
6
|
+
import { inRange, periodChange, previousRange } from "./period.js";
|
|
7
|
+
import { dealCompany, dealOutcome, defaultPipeline, pipelineByStage } from "./pipeline.js";
|
|
8
|
+
import { paymentsByDay, paymentsReceived } from "./invoices.js";
|
|
9
|
+
import { salesRemittances, salesSummary } from "./sales.js";
|
|
10
|
+
import { salesTarget } from "./target.js";
|
|
11
|
+
import { CRM_CONCEPTS, } from "./types.js";
|
|
12
|
+
const idle = Object.fromEntries(CRM_CONCEPTS.map((concept) => [concept, { status: 'idle' }]));
|
|
13
|
+
const EMPTY = {
|
|
14
|
+
status: 'idle',
|
|
15
|
+
concepts: idle,
|
|
16
|
+
leads: [],
|
|
17
|
+
deals: [],
|
|
18
|
+
pipelines: [],
|
|
19
|
+
invoices: [],
|
|
20
|
+
remittances: [],
|
|
21
|
+
companies: [],
|
|
22
|
+
people: [],
|
|
23
|
+
saving: new Set(),
|
|
24
|
+
};
|
|
25
|
+
let pendingCount = 0;
|
|
26
|
+
/** The companies and people saving an invoice made, added to those held. */
|
|
27
|
+
const madeForInvoice = ({ companies, people }, result) => ({
|
|
28
|
+
...(result.companies.length ? { companies: [...companies, ...result.companies] } : {}),
|
|
29
|
+
...(result.people.length ? { people: [...people, ...result.people] } : {}),
|
|
30
|
+
});
|
|
31
|
+
/** The company and person a lead's save made, added to those the store holds. */
|
|
32
|
+
const made = ({ companies, people }, result) => ({
|
|
33
|
+
...(result.company ? { companies: [...companies, result.company] } : {}),
|
|
34
|
+
...(result.person ? { people: [...people, result.person] } : {}),
|
|
35
|
+
});
|
|
36
|
+
/**
|
|
37
|
+
* Holds a company's CRM records for a UI: loads every concept, applies changes straight away and rolls them back if
|
|
38
|
+
* the server refuses, and notifies subscribers. `subscribe` and `getState` fit React's `useSyncExternalStore`.
|
|
39
|
+
*
|
|
40
|
+
* ```ts
|
|
41
|
+
* const store = new CrmStore(crm, { owner });
|
|
42
|
+
* store.subscribe(() => render(selectDashboard(store.getState(), lastDays(28))));
|
|
43
|
+
* await store.load();
|
|
44
|
+
* await store.moveDeal(dealUrn, stage);
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
export class CrmStore {
|
|
48
|
+
client;
|
|
49
|
+
options;
|
|
50
|
+
#state = EMPTY;
|
|
51
|
+
#listeners = new Set();
|
|
52
|
+
#disposed = false;
|
|
53
|
+
constructor(client, options) {
|
|
54
|
+
this.client = client;
|
|
55
|
+
this.options = options;
|
|
56
|
+
}
|
|
57
|
+
getState = () => this.#state;
|
|
58
|
+
subscribe = (listener) => {
|
|
59
|
+
this.#listeners.add(listener);
|
|
60
|
+
return () => this.#listeners.delete(listener);
|
|
61
|
+
};
|
|
62
|
+
/** Drops subscribers; answers still arriving are ignored. */
|
|
63
|
+
dispose() {
|
|
64
|
+
this.#disposed = true;
|
|
65
|
+
this.#listeners.clear();
|
|
66
|
+
}
|
|
67
|
+
#set(next) {
|
|
68
|
+
if (this.#disposed)
|
|
69
|
+
return;
|
|
70
|
+
this.#state = { ...this.#state, ...next };
|
|
71
|
+
for (const listener of this.#listeners)
|
|
72
|
+
listener();
|
|
73
|
+
}
|
|
74
|
+
// ==========================================
|
|
75
|
+
// LOADING
|
|
76
|
+
// ==========================================
|
|
77
|
+
/** Loads (or reloads) every concept at once. A concept that fails doesn't stop the others. */
|
|
78
|
+
async load() {
|
|
79
|
+
const owner = urnOf(this.options.owner);
|
|
80
|
+
const loading = Object.fromEntries(CRM_CONCEPTS.map((concept) => [concept, { status: 'loading' }]));
|
|
81
|
+
this.#set({ status: 'loading', concepts: loading });
|
|
82
|
+
await Promise.all(CRM_CONCEPTS.map(async (concept) => {
|
|
83
|
+
try {
|
|
84
|
+
const records = await this.client[concept].list(owner);
|
|
85
|
+
this.#set({ [concept]: records, concepts: { ...this.#state.concepts, [concept]: { status: 'ready' } } });
|
|
86
|
+
}
|
|
87
|
+
catch (error) {
|
|
88
|
+
const status = error instanceof CrmUnavailableError ? 'unavailable' : 'error';
|
|
89
|
+
this.#set({ concepts: { ...this.#state.concepts, [concept]: { status, error } } });
|
|
90
|
+
}
|
|
91
|
+
}));
|
|
92
|
+
const failed = Object.values(this.#state.concepts).some((state) => state.status === 'error');
|
|
93
|
+
this.#set({ status: failed ? 'error' : 'ready' });
|
|
94
|
+
}
|
|
95
|
+
// ==========================================
|
|
96
|
+
// WRITES
|
|
97
|
+
// ==========================================
|
|
98
|
+
/** Shows `optimistic` at once, runs `write`, then shows what the server stored, or rolls back if it refuses. */
|
|
99
|
+
async #write(urns, optimistic, write, stored) {
|
|
100
|
+
const before = this.#records();
|
|
101
|
+
this.#set({ ...optimistic(before), saving: new Set([...this.#state.saving, ...urns]), writeError: undefined });
|
|
102
|
+
const saved = () => new Set([...this.#state.saving].filter((urn) => !urns.includes(urn)));
|
|
103
|
+
try {
|
|
104
|
+
const result = await write();
|
|
105
|
+
this.#set({ ...stored(this.#records(), result), saving: saved() });
|
|
106
|
+
return result;
|
|
107
|
+
}
|
|
108
|
+
catch (error) {
|
|
109
|
+
this.#set({ ...before, saving: saved(), writeError: error });
|
|
110
|
+
throw error;
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
#records() {
|
|
114
|
+
const { leads, deals, pipelines, invoices, remittances, companies, people } = this.#state;
|
|
115
|
+
return { leads, deals, pipelines, invoices, remittances, companies, people };
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Creates a lead, shown at the top straight away. With `companyName` or `contact`, the prospect's company or contact
|
|
119
|
+
* is made first and linked (see `CrmClient.createLead`).
|
|
120
|
+
*/
|
|
121
|
+
async createLead(input, options = {}) {
|
|
122
|
+
const temporary = `pending-${++pendingCount}`;
|
|
123
|
+
const placeholder = { ...input, urn: temporary, createdTimestamp: '' };
|
|
124
|
+
const { lead } = await this.#write([temporary], ({ leads }) => ({ leads: [placeholder, ...leads] }), () => this.client.createLead(input, options), (records, result) => ({
|
|
125
|
+
leads: records.leads.map((candidate) => (candidate.urn === temporary ? result.lead : candidate)),
|
|
126
|
+
...made(records, result),
|
|
127
|
+
}));
|
|
128
|
+
return lead;
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Changes a lead, shown at once. With `companyName` or `contact`, its new company or contact is made first, as for
|
|
132
|
+
* a new lead (see `CrmClient.updateLead`).
|
|
133
|
+
*/
|
|
134
|
+
async updateLead(lead, changes, options = {}) {
|
|
135
|
+
const urn = urnOf(lead);
|
|
136
|
+
const current = this.#state.leads.find((candidate) => candidate.urn === urn);
|
|
137
|
+
if (!current)
|
|
138
|
+
throw new Error(`No lead ${urn} in the store`);
|
|
139
|
+
const result = await this.#write([urn], ({ leads }) => ({ leads: replace(leads, urn, (shown) => ({ ...shown, ...changes })) }), () => this.client.updateLead(current, changes, options), (records, saved) => ({ leads: replace(records.leads, urn, () => saved.lead), ...made(records, saved) }));
|
|
140
|
+
return result.lead;
|
|
141
|
+
}
|
|
142
|
+
/** A person's email and telephone, read when asked for: they aren't held in the store's state. */
|
|
143
|
+
contactDetails(identity) {
|
|
144
|
+
return this.client.contactDetails(identity);
|
|
145
|
+
}
|
|
146
|
+
/** Sets a person's email and telephone; fields left out are kept. */
|
|
147
|
+
setContactDetails(identity, details) {
|
|
148
|
+
return this.client.setContactDetails(identity, details);
|
|
149
|
+
}
|
|
150
|
+
/** Makes a person owned by the store's company: a customer's person when `company` is given. */
|
|
151
|
+
createContact(contact, company) {
|
|
152
|
+
return this.#write([], () => ({}), () => this.client.createContact(this.options.owner, contact, company), ({ people }, person) => ({ people: [...people, person] }));
|
|
153
|
+
}
|
|
154
|
+
/** Qualifies a lead into a deal (see `CrmClient.convertLead`). Shown once the server has made the deal. */
|
|
155
|
+
async convertLead(lead, options) {
|
|
156
|
+
const urn = urnOf(lead);
|
|
157
|
+
const current = this.#state.leads.find((candidate) => candidate.urn === urn);
|
|
158
|
+
if (!current)
|
|
159
|
+
throw new Error(`No lead ${urn} in the store`);
|
|
160
|
+
return this.#write([urn], () => ({}), () => this.client.convertLead(current, options), ({ leads, deals, companies }, result) => ({
|
|
161
|
+
leads: replace(leads, urn, () => result.lead),
|
|
162
|
+
deals: [result.deal, ...deals],
|
|
163
|
+
...(result.company ? { companies: [...companies, result.company] } : {}),
|
|
164
|
+
}));
|
|
165
|
+
}
|
|
166
|
+
/** Moves a deal to a stage, shown at once (see `CrmClient.moveDeal`). */
|
|
167
|
+
moveDeal(deal, stage) {
|
|
168
|
+
const urn = urnOf(deal);
|
|
169
|
+
return this.#write([urn], ({ deals }) => ({ deals: replace(deals, urn, (current) => ({ ...current, workflowStage: { urn: stage.urn } })) }), () => this.client.moveDeal(urn, stage), ({ deals }, moved) => ({ deals: replace(deals, urn, () => moved) }));
|
|
170
|
+
}
|
|
171
|
+
/** Changes a deal's fields, shown at once. Moving it between stages is `moveDeal`; its outcome, `setOutcome`. */
|
|
172
|
+
updateDeal(deal, changes) {
|
|
173
|
+
const urn = urnOf(deal);
|
|
174
|
+
return this.#write([urn], ({ deals }) => ({ deals: replace(deals, urn, (current) => ({ ...current, ...changes })) }), () => this.client.deals.update(urn, changes), ({ deals }, stored) => ({ deals: replace(deals, urn, () => stored) }));
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* Changes an invoice's own fields (status, parties, dates), shown at once, making a party's new company and person
|
|
178
|
+
* first when `options` asks (see `CrmClient.updateInvoice`). Its lines and payments aren't changed by an update, so
|
|
179
|
+
* they're kept as they were when the server's answer leaves them out or has none.
|
|
180
|
+
*/
|
|
181
|
+
async updateInvoice(invoice, changes, options = {}) {
|
|
182
|
+
const urn = urnOf(invoice);
|
|
183
|
+
const current = this.#state.invoices.find((candidate) => candidate.urn === urn);
|
|
184
|
+
if (!current)
|
|
185
|
+
throw new Error(`No invoice ${urn} in the store`);
|
|
186
|
+
const result = await this.#write([urn], ({ invoices }) => ({ invoices: replace(invoices, urn, (shown) => ({ ...shown, ...changes })) }), () => this.client.updateInvoice(current, changes, options), (records, saved) => ({
|
|
187
|
+
invoices: replace(records.invoices, urn, (shown) => {
|
|
188
|
+
const lines = saved.invoice.lines?.length ? saved.invoice.lines : shown.lines;
|
|
189
|
+
const remittances = saved.invoice.remittances?.length ? saved.invoice.remittances : shown.remittances;
|
|
190
|
+
return { ...saved.invoice, ...(lines ? { lines } : {}), ...(remittances ? { remittances } : {}) };
|
|
191
|
+
}),
|
|
192
|
+
...madeForInvoice(records, saved),
|
|
193
|
+
}));
|
|
194
|
+
return result.invoice;
|
|
195
|
+
}
|
|
196
|
+
/** Wins, loses or reopens a deal, shown at once (see `CrmClient.setOutcome`). */
|
|
197
|
+
setOutcome(deal, outcome, options = {}) {
|
|
198
|
+
const urn = urnOf(deal);
|
|
199
|
+
return this.#write([urn], ({ deals }) => ({ deals: replace(deals, urn, (current) => ({ ...current, outcome })) }), () => this.client.setOutcome(urn, outcome, options), ({ deals }, stored) => ({ deals: replace(deals, urn, () => stored) }));
|
|
200
|
+
}
|
|
201
|
+
/** Closes a lead as unqualified or reopens it, shown at once (see `CrmClient.setLeadOutcome`). */
|
|
202
|
+
setLeadOutcome(lead, outcome, options = {}) {
|
|
203
|
+
const urn = urnOf(lead);
|
|
204
|
+
return this.#write([urn], ({ leads }) => ({ leads: replace(leads, urn, (current) => ({ ...current, outcome })) }), () => this.client.setLeadOutcome(urn, outcome, options), ({ leads }, stored) => ({ leads: replace(leads, urn, () => stored) }));
|
|
205
|
+
}
|
|
206
|
+
/** Creates a deal, shown on the board straight away. */
|
|
207
|
+
createDeal(input) {
|
|
208
|
+
const temporary = `pending-${++pendingCount}`;
|
|
209
|
+
const placeholder = { ...input, urn: temporary, createdTimestamp: '' };
|
|
210
|
+
return this.#write([temporary], ({ deals }) => ({ deals: [placeholder, ...deals] }), () => this.client.createDeal(input), ({ deals }, made) => ({ deals: deals.map((candidate) => (candidate.urn === temporary ? made : candidate)) }));
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Creates an invoice with its lines, linked to `deal` when given (see `CrmClient.createInvoice`). Shown once the
|
|
214
|
+
* server has made it, as its lines are made one by one.
|
|
215
|
+
*/
|
|
216
|
+
async createInvoice(input, lines = [], options = {}) {
|
|
217
|
+
const { invoice } = await this.#write(options.deal ? [options.deal.urn] : [], () => ({}), () => this.client.createInvoice(input, lines, options), (records, result) => ({
|
|
218
|
+
invoices: [result.invoice, ...records.invoices],
|
|
219
|
+
...(result.deal ? { deals: replace(records.deals, result.deal.urn, () => result.deal) } : {}),
|
|
220
|
+
...madeForInvoice(records, result),
|
|
221
|
+
}));
|
|
222
|
+
return invoice;
|
|
223
|
+
}
|
|
224
|
+
/** Records a payment or refund against an invoice. */
|
|
225
|
+
recordPayment(input) {
|
|
226
|
+
const temporary = `pending-${++pendingCount}`;
|
|
227
|
+
return this.#write([temporary], ({ remittances }) => ({ remittances: [{ ...input, urn: temporary }, ...remittances] }), () => this.client.recordPayment(input), ({ remittances }, made) => ({
|
|
228
|
+
remittances: remittances.map((candidate) => (candidate.urn === temporary ? made : candidate)),
|
|
229
|
+
}));
|
|
230
|
+
}
|
|
231
|
+
}
|
|
232
|
+
function replace(records, urn, change) {
|
|
233
|
+
return records.map((record) => (record.urn === urn ? change(record) : record));
|
|
234
|
+
}
|
|
235
|
+
const compare = (current, previous) => ({
|
|
236
|
+
current,
|
|
237
|
+
previous,
|
|
238
|
+
change: periodChange(current, previous),
|
|
239
|
+
});
|
|
240
|
+
/** The largest currency in a set of totals. */
|
|
241
|
+
export const mainCurrency = (totals) => Object.entries(totals).sort(([, a], [, b]) => b - a)[0]?.[0];
|
|
242
|
+
/** Everything a CRM dashboard shows for a period, compared with the period before. */
|
|
243
|
+
export function selectDashboard(state, range, own,
|
|
244
|
+
/** The user's chosen pipeline, for the pipeline card (see `defaultPipeline`). */
|
|
245
|
+
chosenPipeline) {
|
|
246
|
+
const before = previousRange(range);
|
|
247
|
+
const { leads, deals, pipelines } = state;
|
|
248
|
+
const shownPipeline = defaultPipeline(pipelines, deals, chosenPipeline);
|
|
249
|
+
// Revenue is what customers paid: payments the business made on its costs aren't counted.
|
|
250
|
+
const remittances = salesRemittances(state, own);
|
|
251
|
+
const firstWins = new Map();
|
|
252
|
+
let openValue = {};
|
|
253
|
+
let openCount = 0;
|
|
254
|
+
for (const deal of deals) {
|
|
255
|
+
const outcome = dealOutcome(deal);
|
|
256
|
+
if (outcome === 'OPEN') {
|
|
257
|
+
openCount += 1;
|
|
258
|
+
openValue = addMoney(openValue, deal.targetValue);
|
|
259
|
+
}
|
|
260
|
+
const company = dealCompany(deal)?.urn;
|
|
261
|
+
if (outcome === 'WON' && company) {
|
|
262
|
+
const closed = deal.closeTimestamp ?? deal.updatedTimestamp ?? deal.createdTimestamp;
|
|
263
|
+
const known = firstWins.get(company);
|
|
264
|
+
if (!known || closed < known)
|
|
265
|
+
firstWins.set(company, closed);
|
|
266
|
+
}
|
|
267
|
+
}
|
|
268
|
+
const count = (records, when, period) => [...records].filter((record) => inRange(when(record), period)).length;
|
|
269
|
+
const wins = [...firstWins.values()];
|
|
270
|
+
const current = paymentsReceived(remittances, range);
|
|
271
|
+
const previous = paymentsReceived(remittances, before);
|
|
272
|
+
const revenueCurrency = mainCurrency(current) ?? mainCurrency(previous);
|
|
273
|
+
return {
|
|
274
|
+
range,
|
|
275
|
+
customers: {
|
|
276
|
+
total: firstWins.size,
|
|
277
|
+
added: compare(count(wins, (when) => when, range), count(wins, (when) => when, before)),
|
|
278
|
+
},
|
|
279
|
+
openDeals: {
|
|
280
|
+
count: openCount,
|
|
281
|
+
value: openValue,
|
|
282
|
+
created: compare(count(deals, (deal) => deal.createdTimestamp, range), count(deals, (deal) => deal.createdTimestamp, before)),
|
|
283
|
+
},
|
|
284
|
+
revenue: {
|
|
285
|
+
current,
|
|
286
|
+
previous,
|
|
287
|
+
currencyCode: revenueCurrency,
|
|
288
|
+
change: revenueCurrency ? periodChange(current[revenueCurrency] ?? 0, previous[revenueCurrency] ?? 0) : undefined,
|
|
289
|
+
},
|
|
290
|
+
revenueByDay: paymentsByDay(remittances, range),
|
|
291
|
+
newLeads: compare(count(leads, (lead) => lead.createdTimestamp, range), count(leads, (lead) => lead.createdTimestamp, before)),
|
|
292
|
+
target: salesTarget(leads, deals, remittances),
|
|
293
|
+
leadsBySource: leadsBySource(leads),
|
|
294
|
+
pipeline: shownPipeline ? pipelineByStage(deals, shownPipeline) : [],
|
|
295
|
+
};
|
|
296
|
+
}
|
|
297
|
+
/** One customer company's account from the store's records. */
|
|
298
|
+
export function selectAccount(state, company, now = new Date()) {
|
|
299
|
+
return companyAccount(urnOf(company), state, now);
|
|
300
|
+
}
|
|
301
|
+
/** Sales for a period from the store's invoices and payments, costs apart (see `salesSummary`). */
|
|
302
|
+
export function selectSales(state, range, now = new Date(), own) {
|
|
303
|
+
return salesSummary(state, range, now, own);
|
|
304
|
+
}
|
|
305
|
+
//# sourceMappingURL=store.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"store.js","sourceRoot":"","sources":["../src/store.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAgB,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,cAAc,EAAuB,MAAM,cAAc,CAAC;AAUnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,aAAa,EAAoB,MAAM,YAAY,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAoB,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAkB,MAAM,aAAa,CAAC;AACnF,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,eAAe,EAAE,eAAe,EAAqB,MAAM,eAAe,CAAC;AAC9G,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAqB,MAAM,YAAY,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAoB,MAAM,aAAa,CAAC;AAC5D,OAAO,EACL,YAAY,GAab,MAAM,YAAY,CAAC;AAqCpB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAG3F,CAAC;AAEF,MAAM,KAAK,GAAkB;IAC3B,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,EAAE;IACT,SAAS,EAAE,EAAE;IACb,QAAQ,EAAE,EAAE;IACZ,WAAW,EAAE,EAAE;IACf,SAAS,EAAE,EAAE;IACb,MAAM,EAAE,EAAE;IACV,MAAM,EAAE,IAAI,GAAG,EAAE;CAClB,CAAC;AAEF,IAAI,YAAY,GAAG,CAAC,CAAC;AAErB,4EAA4E;AAC5E,MAAM,cAAc,GAAG,CAAC,EAAE,SAAS,EAAE,MAAM,EAAW,EAAE,MAAqC,EAAoB,EAAE,CAAC,CAAC;IACnH,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,SAAS,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACtF,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;CAC3E,CAAC,CAAC;AAEH,iFAAiF;AACjF,MAAM,IAAI,GAAG,CACX,EAAE,SAAS,EAAE,MAAM,EAAW,EAC9B,MAAyE,EACvD,EAAE,CAAC,CAAC;IACtB,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;CACjE,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,OAAO,QAAQ;IAMR;IACA;IANX,MAAM,GAAkB,KAAK,CAAC;IACrB,UAAU,GAAG,IAAI,GAAG,EAAc,CAAC;IAC5C,SAAS,GAAG,KAAK,CAAC;IAElB,YACW,MAAiB,EACjB,OAAwB;QADxB,WAAM,GAAN,MAAM,CAAW;QACjB,YAAO,GAAP,OAAO,CAAiB;IAChC,CAAC;IAEJ,QAAQ,GAAG,GAAkB,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;IAE5C,SAAS,GAAG,CAAC,QAAoB,EAAgB,EAAE;QACjD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC,CAAC;IAEF,6DAA6D;IAC7D,OAAO;QACL,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;IAED,IAAI,CAAC,IAA4B;QAC/B,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAC3B,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC;QAC1C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU;YAAE,QAAQ,EAAE,CAAC;IACrD,CAAC;IAED,6CAA6C;IAC7C,UAAU;IACV,6CAA6C;IAE7C,8FAA8F;IAC9F,KAAK,CAAC,IAAI;QACR,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,CAGjG,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QACpD,MAAM,OAAO,CAAC,GAAG,CACf,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjC,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACvD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;YAC3G,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,MAAM,GAAG,KAAK,YAAY,mBAAmB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC;gBAC9E,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;YACrF,CAAC;QACH,CAAC,CAAC,CACH,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC;QAC7F,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,6CAA6C;IAC7C,SAAS;IACT,6CAA6C;IAE7C,gHAAgH;IAChH,KAAK,CAAC,MAAM,CACV,IAAc,EACd,UAAkD,EAClD,KAAuB,EACvB,MAAyD;QAEzD,MAAM,MAAM,GAAY,IAAI,CAAC,QAAQ,EAAE,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;QAC/G,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1F,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,KAAK,EAAE,CAAC;YAC7B,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YACnE,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;YAC7D,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,QAAQ;QACN,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1F,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,KAAgB,EAAE,UAA0B,EAAE;QAC7D,MAAM,SAAS,GAAG,WAAW,EAAE,YAAY,EAAE,CAAC;QAC9C,MAAM,WAAW,GAAS,EAAE,GAAG,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,gBAAgB,EAAE,EAAE,EAAE,CAAC;QAC7E,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,CAAC,SAAS,CAAC,EACX,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,EACnD,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,EAC5C,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;YACpB,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YAChG,GAAG,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC;SACzB,CAAC,CACH,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,IAAa,EAAE,OAA2B,EAAE,UAA0B,EAAE;QACvF,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QAC7E,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,WAAW,GAAG,eAAe,CAAC,CAAC;QAC7D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAC9B,CAAC,GAAG,CAAC,EACL,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EACtF,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EACvD,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,CACxG,CAAC;QACF,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IAED,kGAAkG;IAClG,cAAc,CAAC,QAAiB;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED,qEAAqE;IACrE,iBAAiB,CAAC,QAAiB,EAAE,OAAgC;QACnE,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,gGAAgG;IAChG,aAAa,CAAC,OAAmB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,MAAM,CAChB,EAAE,EACF,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EACV,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EACrE,CAAC,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAC1D,CAAC;IACJ,CAAC;IAED,2GAA2G;IAC3G,KAAK,CAAC,WAAW,CAAC,IAAa,EAAE,OAAuB;QACtD,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QAC7E,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,WAAW,GAAG,eAAe,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,MAAM,CAChB,CAAC,GAAG,CAAC,EACL,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EACV,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,EAC/C,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;YACxC,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;YAC7C,KAAK,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC;YAC9B,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACzE,CAAC,CACH,CAAC;IACJ,CAAC;IAED,yEAAyE;IACzE,QAAQ,CAAC,IAAa,EAAE,KAAoB;QAC1C,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,MAAM,CAChB,CAAC,GAAG,CAAC,EACL,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,aAAa,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EACjH,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,EACtC,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CACpE,CAAC;IACJ,CAAC;IAED,iHAAiH;IACjH,UAAU,CAAC,IAAa,EAAE,OAA2B;QACnD,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,MAAM,CAChB,CAAC,GAAG,CAAC,EACL,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAC1F,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,EAC5C,CAAC,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CACtE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CACjB,OAAgB,EAChB,OAA8B,EAC9B,UAA+B,EAAE;QAEjC,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QAChF,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,cAAc,GAAG,eAAe,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAC9B,CAAC,GAAG,CAAC,EACL,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAC/F,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAC1D,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YACnB,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE;gBACjD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC;gBAC9E,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC;gBACtG,OAAO,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;YACpG,CAAC,CAAC;YACF,GAAG,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC;SAClC,CAAC,CACH,CAAC;QACF,OAAO,MAAM,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,iFAAiF;IACjF,UAAU,CAAC,IAAa,EAAE,OAAoB,EAAE,UAAmC,EAAE;QACnF,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,MAAM,CAChB,CAAC,GAAG,CAAC,EACL,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EACvF,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,EACnD,CAAC,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CACtE,CAAC;IACJ,CAAC;IAED,kGAAkG;IAClG,cAAc,CACZ,IAAa,EACb,OAA0C,EAC1C,UAAqC,EAAE;QAEvC,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,MAAM,CAChB,CAAC,GAAG,CAAC,EACL,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EACvF,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,EACvD,CAAC,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CACtE,CAAC;IACJ,CAAC;IAED,wDAAwD;IACxD,UAAU,CAAC,KAAgB;QACzB,MAAM,SAAS,GAAG,WAAW,EAAE,YAAY,EAAE,CAAC;QAC9C,MAAM,WAAW,GAAS,EAAE,GAAG,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,gBAAgB,EAAE,EAAE,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,MAAM,CAChB,CAAC,SAAS,CAAC,EACX,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,EACnD,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EACnC,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAC7G,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CACjB,KAAmB,EACnB,QAAmD,EAAE,EACrD,UAA6B,EAAE;QAE/B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,EACtC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EACV,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EACtD,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;YACpB,QAAQ,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;YAC/C,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9F,GAAG,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC;SACnC,CAAC,CACH,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,sDAAsD;IACtD,aAAa,CAAC,KAAsB;QAClC,MAAM,SAAS,GAAG,WAAW,EAAE,YAAY,EAAE,CAAC;QAC9C,OAAO,IAAI,CAAC,MAAM,CAChB,CAAC,SAAS,CAAC,EACX,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,GAAG,WAAW,CAAC,EAAE,CAAC,EACtF,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,EACtC,CAAC,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YAC1B,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;SAC9F,CAAC,CACH,CAAC;IACJ,CAAC;CACF;AAED,SAAS,OAAO,CAA4B,OAAqB,EAAE,GAAW,EAAE,MAAwB;IACtG,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AACjF,CAAC;AA+BD,MAAM,OAAO,GAAG,CAAC,OAAe,EAAE,QAAgB,EAAoB,EAAE,CAAC,CAAC;IACxE,OAAO;IACP,QAAQ;IACR,MAAM,EAAE,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC;CACxC,CAAC,CAAC;AAEH,+CAA+C;AAC/C,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAmB,EAAsB,EAAE,CACtE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAE/D,sFAAsF;AACtF,MAAM,UAAU,eAAe,CAC7B,KAAoB,EACpB,KAAgB,EAChB,GAAyB;AACzB,iFAAiF;AACjF,cAAuB;IAEvB,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IACpC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC;IAC1C,MAAM,aAAa,GAAG,eAAe,CAAC,SAAS,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;IACxE,0FAA0F;IAC1F,MAAM,WAAW,GAAG,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAEjD,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC5C,IAAI,SAAS,GAAgB,EAAE,CAAC;IAChC,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;YACvB,SAAS,IAAI,CAAC,CAAC;YACf,SAAS,GAAG,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACpD,CAAC;QACD,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;QACvC,IAAI,OAAO,KAAK,KAAK,IAAI,OAAO,EAAE,CAAC;YACjC,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,gBAAgB,CAAC;YACrF,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACrC,IAAI,CAAC,KAAK,IAAI,MAAM,GAAG,KAAK;gBAAE,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAG,CAAI,OAAoB,EAAE,IAA8C,EAAE,MAAiB,EAAE,EAAE,CAC3G,CAAC,GAAG,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;IACxE,MAAM,IAAI,GAAG,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;IACrC,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACrD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACvD,MAAM,eAAe,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC;IAExE,OAAO;QACL,KAAK;QACL,SAAS,EAAE;YACT,KAAK,EAAE,SAAS,CAAC,IAAI;YACrB,KAAK,EAAE,OAAO,CACZ,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,EAClC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CACpC;SACF;QACD,SAAS,EAAE;YACT,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,SAAS;YAChB,OAAO,EAAE,OAAO,CACd,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,EACpD,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CACtD;SACF;QACD,OAAO,EAAE;YACP,OAAO;YACP,QAAQ;YACR,YAAY,EAAE,eAAe;YAC7B,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;SAClH;QACD,YAAY,EAAE,aAAa,CAAC,WAAW,EAAE,KAAK,CAAC;QAC/C,QAAQ,EAAE,OAAO,CACf,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,EACpD,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CACtD;QACD,MAAM,EAAE,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,WAAW,CAAC;QAC9C,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC;QACnC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE;KACrE,CAAC;AACJ,CAAC;AAED,+DAA+D;AAC/D,MAAM,UAAU,aAAa,CAAC,KAAoB,EAAE,OAAgB,EAAE,GAAG,GAAG,IAAI,IAAI,EAAE;IACpF,OAAO,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;AACpD,CAAC;AAED,mGAAmG;AACnG,MAAM,UAAU,WAAW,CACzB,KAAoB,EACpB,KAAgB,EAChB,GAAG,GAAG,IAAI,IAAI,EAAE,EAChB,GAAyB;IAEzB,OAAO,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAC9C,CAAC"}
|
package/dist/target.d.ts
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { type MoneyTotals } from './money.ts';
|
|
2
|
+
import type { Deal, Lead, Remittance } from './types.ts';
|
|
3
|
+
export interface SalesTarget {
|
|
4
|
+
/** The target per currency: leads' target values, each qualified lead's replaced by its deal's. */
|
|
5
|
+
target: MoneyTotals;
|
|
6
|
+
/** Won deals' target values per currency. */
|
|
7
|
+
won: MoneyTotals;
|
|
8
|
+
/** Payments received less refunds on the deals' invoices, per currency. */
|
|
9
|
+
received: MoneyTotals;
|
|
10
|
+
/** Received against target per currency, 0 to 1 (more than 1 past the target). */
|
|
11
|
+
progress: Readonly<Record<string, number>>;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* The sales target and progress towards it. The target is the sum of the leads' target values, using the deal's target
|
|
15
|
+
* value instead once a lead is qualified into a deal. Deals created without a lead count too, as they're qualified
|
|
16
|
+
* already; unqualified leads don't, and neither do lost deals or the leads they came from (decided 27 Oct 2026, in
|
|
17
|
+
* place of keeping lost deals in): the target is what's still open or won.
|
|
18
|
+
* Progress is the payments received against the target (decided 24 Oct 2026): money in on the invoices raised for the
|
|
19
|
+
* deals (`Deal.invoices`), refunds taken off. Payments on invoices without a deal, such as repeat orders, don't count.
|
|
20
|
+
*/
|
|
21
|
+
export declare function salesTarget(leads: readonly Lead[], deals: readonly Deal[], remittances: readonly Remittance[]): SalesTarget;
|
|
22
|
+
//# sourceMappingURL=target.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"target.d.ts","sourceRoot":"","sources":["../src/target.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAIxD,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEzD,MAAM,WAAW,WAAW;IAC1B,mGAAmG;IACnG,MAAM,EAAE,WAAW,CAAC;IACpB,6CAA6C;IAC7C,GAAG,EAAE,WAAW,CAAC;IACjB,2EAA2E;IAC3E,QAAQ,EAAE,WAAW,CAAC;IACtB,kFAAkF;IAClF,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC5C;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CACzB,KAAK,EAAE,SAAS,IAAI,EAAE,EACtB,KAAK,EAAE,SAAS,IAAI,EAAE,EACtB,WAAW,EAAE,SAAS,UAAU,EAAE,GACjC,WAAW,CAwBb"}
|
package/dist/target.js
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { addMoney } from "./money.js";
|
|
2
|
+
import { paymentsReceived } from "./invoices.js";
|
|
3
|
+
import { leadOutcome } from "./leads.js";
|
|
4
|
+
import { dealOutcome } from "./pipeline.js";
|
|
5
|
+
/**
|
|
6
|
+
* The sales target and progress towards it. The target is the sum of the leads' target values, using the deal's target
|
|
7
|
+
* value instead once a lead is qualified into a deal. Deals created without a lead count too, as they're qualified
|
|
8
|
+
* already; unqualified leads don't, and neither do lost deals or the leads they came from (decided 27 Oct 2026, in
|
|
9
|
+
* place of keeping lost deals in): the target is what's still open or won.
|
|
10
|
+
* Progress is the payments received against the target (decided 24 Oct 2026): money in on the invoices raised for the
|
|
11
|
+
* deals (`Deal.invoices`), refunds taken off. Payments on invoices without a deal, such as repeat orders, don't count.
|
|
12
|
+
*/
|
|
13
|
+
export function salesTarget(leads, deals, remittances) {
|
|
14
|
+
const fromLeads = new Set(deals.flatMap((deal) => (deal.leadSource ? [deal.leadSource.urn] : [])));
|
|
15
|
+
let target = {};
|
|
16
|
+
let won = {};
|
|
17
|
+
for (const deal of deals) {
|
|
18
|
+
const outcome = dealOutcome(deal);
|
|
19
|
+
if (outcome === 'LOST')
|
|
20
|
+
continue;
|
|
21
|
+
target = addMoney(target, deal.targetValue);
|
|
22
|
+
if (outcome === 'WON')
|
|
23
|
+
won = addMoney(won, deal.targetValue);
|
|
24
|
+
}
|
|
25
|
+
for (const lead of leads) {
|
|
26
|
+
if (leadOutcome(lead) === 'CLOSED')
|
|
27
|
+
continue;
|
|
28
|
+
// A lead that became one of these deals (its leadSource) is counted by its deal's value above.
|
|
29
|
+
if (fromLeads.has(lead.urn))
|
|
30
|
+
continue;
|
|
31
|
+
target = addMoney(target, lead.targetValue);
|
|
32
|
+
}
|
|
33
|
+
const invoiced = new Set(deals.flatMap((deal) => deal.invoices.map((invoice) => invoice.urn)));
|
|
34
|
+
const received = paymentsReceived(remittances.filter((remittance) => invoiced.has(remittance.paymentInvoice.urn)));
|
|
35
|
+
const progress = Object.fromEntries(Object.entries(target)
|
|
36
|
+
.filter(([, minor]) => minor > 0)
|
|
37
|
+
.map(([currency, minor]) => [currency, (received[currency] ?? 0) / minor]));
|
|
38
|
+
return { target, won, received, progress };
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=target.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"target.js","sourceRoot":"","sources":["../src/target.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAoB,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAc5C;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CACzB,KAAsB,EACtB,KAAsB,EACtB,WAAkC;IAElC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACnG,IAAI,MAAM,GAAgB,EAAE,CAAC;IAC7B,IAAI,GAAG,GAAgB,EAAE,CAAC;IAC1B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,OAAO,KAAK,MAAM;YAAE,SAAS;QACjC,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5C,IAAI,OAAO,KAAK,KAAK;YAAE,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/D,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,QAAQ;YAAE,SAAS;QAC7C,+FAA+F;QAC/F,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,SAAS;QACtC,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC/F,MAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACnH,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CACjC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;SACnB,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC;SAChC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAC7E,CAAC;IACF,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;AAC7C,CAAC"}
|