@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/backend.js
ADDED
|
@@ -0,0 +1,328 @@
|
|
|
1
|
+
import { Endpoint, } from '@baack-software/baack-ts-client';
|
|
2
|
+
import { toTimestamp, urnOf } from '@baack-software/baack-ts-tasks';
|
|
3
|
+
import { CrmNotFoundError, CrmSearchTimeoutError } from "./errors.js";
|
|
4
|
+
/** A contact's name, as shown: given and family name. */
|
|
5
|
+
export const contactName = ({ givenName, familyName }) => [givenName.trim(), familyName?.trim()].filter(Boolean).join(' ');
|
|
6
|
+
/**
|
|
7
|
+
* A contact's identity label: their initials, such as "J.S.". A label isn't held securely, so it never carries a
|
|
8
|
+
* person's name, which goes in the person name instead.
|
|
9
|
+
*/
|
|
10
|
+
export const contactLabel = ({ givenName, familyName }) => [givenName, familyName ?? '']
|
|
11
|
+
.map((name) => name.trim().charAt(0).toUpperCase())
|
|
12
|
+
.filter(Boolean)
|
|
13
|
+
.map((initial) => `${initial}.`)
|
|
14
|
+
.join('');
|
|
15
|
+
// ==========================================
|
|
16
|
+
// THE BAACK API
|
|
17
|
+
// ==========================================
|
|
18
|
+
const wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
|
|
19
|
+
/** The URNs of everything a company owns in one search scope: created, read again until full, pages followed. */
|
|
20
|
+
async function searchUrns(client, owner, scope, timeoutMs = 15_000) {
|
|
21
|
+
let search = await client.search({ owner: { urn: owner, url: '' }, includeScopes: [scope], order: 'NAME' });
|
|
22
|
+
const urn = search.urn;
|
|
23
|
+
if (!urn)
|
|
24
|
+
throw new Error('The API created a search without a URN');
|
|
25
|
+
const started = Date.now();
|
|
26
|
+
for (let delay = 250; search.status !== 'FULL_RESULT'; delay = Math.min(delay * 1.5, 2000)) {
|
|
27
|
+
if (Date.now() - started > timeoutMs)
|
|
28
|
+
throw new CrmSearchTimeoutError();
|
|
29
|
+
await wait(delay);
|
|
30
|
+
search = await client.searchResult(urn);
|
|
31
|
+
}
|
|
32
|
+
const urns = (search.items ?? []).map((item) => item.urn);
|
|
33
|
+
for (let page = search; page.pagination?.isMorePages && page.pagination.after;) {
|
|
34
|
+
page = await client.searchResult(urn, page.pagination.after);
|
|
35
|
+
urns.push(...(page.items ?? []).map((item) => item.urn));
|
|
36
|
+
}
|
|
37
|
+
return urns;
|
|
38
|
+
}
|
|
39
|
+
/** The API is rate limited (10 requests a second): records found by search are read a few at a time. */
|
|
40
|
+
const READS_AT_ONCE = 4;
|
|
41
|
+
async function readEach(urns, read) {
|
|
42
|
+
const records = new Array(urns.length);
|
|
43
|
+
let next = 0;
|
|
44
|
+
const worker = async () => {
|
|
45
|
+
for (let index = next++; index < urns.length; index = next++)
|
|
46
|
+
records[index] = await read(urns[index]);
|
|
47
|
+
};
|
|
48
|
+
await Promise.all(Array.from({ length: Math.min(READS_AT_ONCE, urns.length) }, worker));
|
|
49
|
+
return records;
|
|
50
|
+
}
|
|
51
|
+
/** A link as a ref, or null when it's absent or empty (the API has answered a missing link as `{ urn: "" }`). */
|
|
52
|
+
const link = (value) => (value?.urn ? { urn: value.urn } : null);
|
|
53
|
+
const links = (values) => (values ?? []).flatMap((value) => (value?.urn ? [{ urn: value.urn }] : []));
|
|
54
|
+
const party = (value) => {
|
|
55
|
+
const company = link(value?.company);
|
|
56
|
+
const identity = link(value?.identity);
|
|
57
|
+
return company || identity ? { company, identity } : null;
|
|
58
|
+
};
|
|
59
|
+
/** An empty text as absent: the API answers an unset reason as "". */
|
|
60
|
+
const text = (value) => value || null;
|
|
61
|
+
// The API's representations as the package's: links as refs, lists always present.
|
|
62
|
+
const asLead = (raw) => ({
|
|
63
|
+
...raw,
|
|
64
|
+
owner: link(raw.owner),
|
|
65
|
+
contactIdentity: link(raw.contactIdentity),
|
|
66
|
+
contactCompany: link(raw.contactCompany),
|
|
67
|
+
assignee: link(raw.assignee),
|
|
68
|
+
entity: link(raw.entity),
|
|
69
|
+
closedReason: text(raw.closedReason),
|
|
70
|
+
});
|
|
71
|
+
const asDeal = (raw) => ({
|
|
72
|
+
...raw,
|
|
73
|
+
owner: link(raw.owner),
|
|
74
|
+
contactCompanies: links(raw.contactCompanies),
|
|
75
|
+
contactIdentities: links(raw.contactIdentities),
|
|
76
|
+
workflowStage: link(raw.workflowStage),
|
|
77
|
+
leadSource: link(raw.leadSource),
|
|
78
|
+
assignee: link(raw.assignee),
|
|
79
|
+
invoices: links(raw.invoices),
|
|
80
|
+
entity: link(raw.entity),
|
|
81
|
+
lostReason: text(raw.lostReason),
|
|
82
|
+
});
|
|
83
|
+
const asRemittance = (raw, invoice) => ({
|
|
84
|
+
...raw,
|
|
85
|
+
// On its invoice, a remittance's own link to the invoice can be absent: it's the invoice it's listed on.
|
|
86
|
+
paymentInvoice: link(raw.paymentInvoice) ?? { urn: invoice ?? '' },
|
|
87
|
+
remittingCompany: link(raw.remittingCompany),
|
|
88
|
+
remittingIdentity: link(raw.remittingIdentity),
|
|
89
|
+
});
|
|
90
|
+
const asInvoice = (raw) => ({
|
|
91
|
+
...raw,
|
|
92
|
+
owner: link(raw.owner),
|
|
93
|
+
remitter: party(raw.remitter),
|
|
94
|
+
recipient: party(raw.recipient),
|
|
95
|
+
lines: raw.lines ?? [],
|
|
96
|
+
remittances: (raw.remittances ?? []).map((remittance) => asRemittance(remittance, raw.urn)),
|
|
97
|
+
});
|
|
98
|
+
/**
|
|
99
|
+
* One concept on the API: listed by search in `scope` then read a few at a time, read by URN, created, updated (the
|
|
100
|
+
* record is read, the changes merged in, and the whole of it sent, as the API replaces on update; then read back) and
|
|
101
|
+
* deleted. `as` turns the API's representation into the package's.
|
|
102
|
+
*/
|
|
103
|
+
function onApi(client, endpoint, scope, as, omit = []) {
|
|
104
|
+
const read = async (urn) => as(await client.read(endpoint, urn));
|
|
105
|
+
const body = (record) => Object.fromEntries(Object.entries(record).filter(([field]) => !omit.includes(field)));
|
|
106
|
+
return {
|
|
107
|
+
list: async (owner) => readEach(await searchUrns(client, urnOf(owner), scope), read),
|
|
108
|
+
get: (record) => read(urnOf(record)),
|
|
109
|
+
create: async (input) => as(await client.create(endpoint, body(input))),
|
|
110
|
+
async update(record, changes) {
|
|
111
|
+
const urn = urnOf(record);
|
|
112
|
+
const current = await client.read(endpoint, urn);
|
|
113
|
+
await client.update(endpoint, urn, body({ ...current, ...changes }));
|
|
114
|
+
return read(urn);
|
|
115
|
+
},
|
|
116
|
+
delete: async (record) => {
|
|
117
|
+
await client.delete(endpoint, urnOf(record));
|
|
118
|
+
},
|
|
119
|
+
};
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Every CRM concept on the Baack API: leads, deals and payment invoices found by search; remittances, which have no
|
|
123
|
+
* owner, through their invoices; pipelines are the company's workflows.
|
|
124
|
+
*/
|
|
125
|
+
export function apiBackend(client) {
|
|
126
|
+
const invoices = onApi(client, Endpoint.PAYMENT_INVOICE, 'PAYMENT_INVOICE', asInvoice, [
|
|
127
|
+
// Ignored on update, and made on their own endpoints.
|
|
128
|
+
'lines',
|
|
129
|
+
'remittances',
|
|
130
|
+
]);
|
|
131
|
+
const remittance = async (urn) => asRemittance(await client.read(Endpoint.INVOICE_REMITTANCE, urn));
|
|
132
|
+
// An identity's emails and telephones, which the API returns with the identity.
|
|
133
|
+
const reachable = (urn) => client.read(Endpoint.IDENTITY, urn);
|
|
134
|
+
const detailsOf = (identity) => ({
|
|
135
|
+
email: identity.emails?.[0]?.email ?? '',
|
|
136
|
+
telephone: identity.telephones?.[0]?.number ?? '',
|
|
137
|
+
});
|
|
138
|
+
// An identity's first email or telephone set to `value`: changed (read, merged and sent whole, as other updates
|
|
139
|
+
// are), made when there's none, deleted when emptied, and left alone when `value` is undefined or unchanged.
|
|
140
|
+
const setFirst = async (endpoint, existing, field, value, identity) => {
|
|
141
|
+
if (value === undefined)
|
|
142
|
+
return;
|
|
143
|
+
const next = value.trim();
|
|
144
|
+
if (existing?.[field] === next)
|
|
145
|
+
return;
|
|
146
|
+
if (existing && !next)
|
|
147
|
+
return void (await client.delete(endpoint, existing.urn));
|
|
148
|
+
if (existing) {
|
|
149
|
+
const stored = await client.read(endpoint, existing.urn);
|
|
150
|
+
return void (await client.update(endpoint, existing.urn, { ...stored, [field]: next }));
|
|
151
|
+
}
|
|
152
|
+
if (next)
|
|
153
|
+
await client.create(endpoint, { identity: { urn: identity }, [field]: next });
|
|
154
|
+
};
|
|
155
|
+
return {
|
|
156
|
+
companies: {
|
|
157
|
+
create: ({ owner, name }) => client.create(Endpoint.COMPANY, { owner: { urn: urnOf(owner) }, name }),
|
|
158
|
+
},
|
|
159
|
+
people: {
|
|
160
|
+
// An identity, then its person, the person's name and the email, each on its own endpoint. If any of those is
|
|
161
|
+
// refused (an email the API doesn't accept, say), the identity is deleted, which takes what was made with it,
|
|
162
|
+
// so trying again doesn't leave a half-made contact behind.
|
|
163
|
+
async createContact({ owner, contact, company }) {
|
|
164
|
+
const identity = await client.create(Endpoint.IDENTITY, {
|
|
165
|
+
owner: { urn: urnOf(owner) },
|
|
166
|
+
label: contactLabel(contact),
|
|
167
|
+
companies: company ? [{ urn: urnOf(company) }] : [],
|
|
168
|
+
});
|
|
169
|
+
try {
|
|
170
|
+
const person = await client.create(Endpoint.PERSON, { identity: { urn: identity.urn } });
|
|
171
|
+
await client.create(Endpoint.PERSON_NAME, {
|
|
172
|
+
person: { urn: person.urn },
|
|
173
|
+
givenName: contact.givenName.trim(),
|
|
174
|
+
familyName: contact.familyName?.trim() || null,
|
|
175
|
+
});
|
|
176
|
+
const email = contact.email?.trim();
|
|
177
|
+
if (email)
|
|
178
|
+
await client.create(Endpoint.EMAIL, { identity: { urn: identity.urn }, email });
|
|
179
|
+
const number = contact.telephone?.trim();
|
|
180
|
+
if (number)
|
|
181
|
+
await client.create(Endpoint.TELEPHONE, { identity: { urn: identity.urn }, number });
|
|
182
|
+
}
|
|
183
|
+
catch (error) {
|
|
184
|
+
await client.delete(Endpoint.IDENTITY, identity.urn).catch(() => undefined);
|
|
185
|
+
throw error;
|
|
186
|
+
}
|
|
187
|
+
return { urn: identity.urn, name: contactName(contact), company: company ? { urn: urnOf(company) } : null };
|
|
188
|
+
},
|
|
189
|
+
contactDetails: async (identity) => detailsOf(await reachable(urnOf(identity))),
|
|
190
|
+
async setContactDetails(identity, details) {
|
|
191
|
+
const urn = urnOf(identity);
|
|
192
|
+
const current = await reachable(urn);
|
|
193
|
+
await setFirst(Endpoint.EMAIL, current.emails?.[0], 'email', details.email, urn);
|
|
194
|
+
await setFirst(Endpoint.TELEPHONE, current.telephones?.[0], 'number', details.telephone, urn);
|
|
195
|
+
return detailsOf(await reachable(urn));
|
|
196
|
+
},
|
|
197
|
+
},
|
|
198
|
+
leads: onApi(client, Endpoint.LEAD, 'LEAD', asLead),
|
|
199
|
+
deals: onApi(client, Endpoint.DEAL, 'DEAL', asDeal),
|
|
200
|
+
invoices,
|
|
201
|
+
invoiceLines: { create: (input) => client.create(Endpoint.INVOICE_LINE, input) },
|
|
202
|
+
remittances: {
|
|
203
|
+
list: async (owner) => (await invoices.list(owner)).flatMap((invoice) => invoice.remittances ?? []),
|
|
204
|
+
get: (record) => remittance(urnOf(record)),
|
|
205
|
+
create: async (input) => asRemittance(await client.create(Endpoint.INVOICE_REMITTANCE, input)),
|
|
206
|
+
async update(record, changes) {
|
|
207
|
+
const urn = urnOf(record);
|
|
208
|
+
const current = await client.read(Endpoint.INVOICE_REMITTANCE, urn);
|
|
209
|
+
await client.update(Endpoint.INVOICE_REMITTANCE, urn, { ...current, ...changes });
|
|
210
|
+
return remittance(urn);
|
|
211
|
+
},
|
|
212
|
+
delete: async (record) => {
|
|
213
|
+
await client.delete(Endpoint.INVOICE_REMITTANCE, urnOf(record));
|
|
214
|
+
},
|
|
215
|
+
},
|
|
216
|
+
pipelines: {
|
|
217
|
+
list: async (owner) => readEach(await searchUrns(client, urnOf(owner), 'WORKFLOW'), (urn) => client.read(Endpoint.WORKFLOW, urn)),
|
|
218
|
+
get: (record) => client.read(Endpoint.WORKFLOW, urnOf(record)),
|
|
219
|
+
},
|
|
220
|
+
};
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* Every CRM concept held in memory, starting from `data` (copied, so the caller's arrays aren't changed). Writes
|
|
224
|
+
* behave as the API's would: create stamps a URN and times, update merges the changes, delete removes.
|
|
225
|
+
*/
|
|
226
|
+
export function memoryBackend(data, options = {}) {
|
|
227
|
+
const { latencyMs = 0, newUrn = () => crypto.randomUUID(), now = () => new Date() } = options;
|
|
228
|
+
const answer = async (value) => {
|
|
229
|
+
if (latencyMs > 0)
|
|
230
|
+
await wait(latencyMs);
|
|
231
|
+
return structuredClone(value);
|
|
232
|
+
};
|
|
233
|
+
function collection(concept, records, url, stamped, ownerOf) {
|
|
234
|
+
const find = (record) => {
|
|
235
|
+
const index = records.findIndex((candidate) => candidate.urn === urnOf(record));
|
|
236
|
+
if (index < 0)
|
|
237
|
+
throw new CrmNotFoundError(concept, urnOf(record));
|
|
238
|
+
return index;
|
|
239
|
+
};
|
|
240
|
+
return {
|
|
241
|
+
list: async (owner) => answer(records.filter((record) => ownerOf(record) === urnOf(owner))),
|
|
242
|
+
get: async (record) => answer(records[find(record)]),
|
|
243
|
+
async create(input) {
|
|
244
|
+
const urn = newUrn();
|
|
245
|
+
const time = toTimestamp(now());
|
|
246
|
+
const created = {
|
|
247
|
+
...structuredClone(input),
|
|
248
|
+
urn,
|
|
249
|
+
url: `${url}${urn}`,
|
|
250
|
+
...(stamped ? { createdTimestamp: time, updatedTimestamp: time } : {}),
|
|
251
|
+
};
|
|
252
|
+
records.push(created);
|
|
253
|
+
return answer(created);
|
|
254
|
+
},
|
|
255
|
+
async update(record, changes) {
|
|
256
|
+
const index = find(record);
|
|
257
|
+
const updated = {
|
|
258
|
+
...records[index],
|
|
259
|
+
...structuredClone(changes),
|
|
260
|
+
...(stamped ? { updatedTimestamp: toTimestamp(now()) } : {}),
|
|
261
|
+
};
|
|
262
|
+
records[index] = updated;
|
|
263
|
+
return answer(updated);
|
|
264
|
+
},
|
|
265
|
+
async delete(record) {
|
|
266
|
+
records.splice(find(record), 1);
|
|
267
|
+
await answer(undefined);
|
|
268
|
+
},
|
|
269
|
+
};
|
|
270
|
+
}
|
|
271
|
+
const copy = structuredClone(data);
|
|
272
|
+
const owned = (record) => record.owner?.urn;
|
|
273
|
+
// A remittance has no owner: it's its invoice's owner's.
|
|
274
|
+
const invoiceOwner = (remittance) => copy.invoices.find((invoice) => invoice.urn === remittance.paymentInvoice.urn)?.owner.urn;
|
|
275
|
+
// Sample people's email and telephone, by identity URN; anyone else has none until they're set.
|
|
276
|
+
const details = new Map();
|
|
277
|
+
const detailsFor = (urn) => details.get(urn) ?? { email: '', telephone: '' };
|
|
278
|
+
return {
|
|
279
|
+
// Sample companies live only in memory: converting a sample lead never makes a real company.
|
|
280
|
+
companies: {
|
|
281
|
+
async create({ owner, name }) {
|
|
282
|
+
const urn = newUrn();
|
|
283
|
+
const company = {
|
|
284
|
+
urn,
|
|
285
|
+
url: `/n/v1/company/${urn}`,
|
|
286
|
+
name,
|
|
287
|
+
owner: { urn: urnOf(owner), url: `/n/v1/company/${urnOf(owner)}` },
|
|
288
|
+
};
|
|
289
|
+
return answer(company);
|
|
290
|
+
},
|
|
291
|
+
},
|
|
292
|
+
// Sample people too: a sample lead's contact is never a real identity.
|
|
293
|
+
people: {
|
|
294
|
+
async createContact({ contact, company }) {
|
|
295
|
+
const urn = newUrn();
|
|
296
|
+
details.set(urn, { email: contact.email?.trim() ?? '', telephone: contact.telephone?.trim() ?? '' });
|
|
297
|
+
return answer({ urn, name: contactName(contact), company: company ? { urn: urnOf(company) } : null });
|
|
298
|
+
},
|
|
299
|
+
contactDetails: async (identity) => answer({ ...detailsFor(urnOf(identity)) }),
|
|
300
|
+
async setContactDetails(identity, changes) {
|
|
301
|
+
const urn = urnOf(identity);
|
|
302
|
+
const next = { ...detailsFor(urn) };
|
|
303
|
+
if (changes.email !== undefined)
|
|
304
|
+
next.email = changes.email.trim();
|
|
305
|
+
if (changes.telephone !== undefined)
|
|
306
|
+
next.telephone = changes.telephone.trim();
|
|
307
|
+
details.set(urn, next);
|
|
308
|
+
return answer({ ...next });
|
|
309
|
+
},
|
|
310
|
+
},
|
|
311
|
+
leads: collection('leads', copy.leads, '/n/v1/lead/', true, owned),
|
|
312
|
+
deals: collection('deals', copy.deals, '/n/v1/deal/', true, owned),
|
|
313
|
+
invoiceLines: {
|
|
314
|
+
async create({ paymentInvoice, ...fields }) {
|
|
315
|
+
const invoice = copy.invoices.find((candidate) => candidate.urn === paymentInvoice.urn);
|
|
316
|
+
if (!invoice)
|
|
317
|
+
throw new CrmNotFoundError('invoices', paymentInvoice.urn);
|
|
318
|
+
const line = { ...structuredClone(fields), urn: newUrn() };
|
|
319
|
+
invoice.lines = [...(invoice.lines ?? []), line];
|
|
320
|
+
return answer(line);
|
|
321
|
+
},
|
|
322
|
+
},
|
|
323
|
+
remittances: collection('remittances', copy.remittances, '/n/v1/invoiceremittance/', false, invoiceOwner),
|
|
324
|
+
pipelines: collection('pipelines', copy.pipelines, '', false, owned),
|
|
325
|
+
invoices: collection('invoices', copy.invoices, '/n/v1/paymentinvoice/', false, owned),
|
|
326
|
+
};
|
|
327
|
+
}
|
|
328
|
+
//# sourceMappingURL=backend.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"backend.js","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,GAMT,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,KAAK,EAA0B,MAAM,gCAAgC,CAAC;AAC5F,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AA8DtE,yDAAyD;AACzD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,EAAE,SAAS,EAAE,UAAU,EAAc,EAAU,EAAE,CAC3E,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAEnE;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAAE,SAAS,EAAE,UAAU,EAAc,EAAU,EAAE,CAC5E,CAAC,SAAS,EAAE,UAAU,IAAI,EAAE,CAAC;KAC1B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;KAClD,MAAM,CAAC,OAAO,CAAC;KACf,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,OAAO,GAAG,CAAC;KAC/B,IAAI,CAAC,EAAE,CAAC,CAAC;AAiBd,6CAA6C;AAC7C,gBAAgB;AAChB,6CAA6C;AAE7C,MAAM,IAAI,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAE/E,iHAAiH;AACjH,KAAK,UAAU,UAAU,CACvB,MAAmB,EACnB,KAAa,EACb,KAAmB,EACnB,SAAS,GAAG,MAAM;IAElB,IAAI,MAAM,GAAW,MAAM,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,aAAa,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IACpH,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;IACvB,IAAI,CAAC,GAAG;QAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IACpE,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC3B,KAAK,IAAI,KAAK,GAAG,GAAG,EAAE,MAAM,CAAC,MAAM,KAAK,aAAa,EAAE,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;QAC3F,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,GAAG,SAAS;YAAE,MAAM,IAAI,qBAAqB,EAAE,CAAC;QACxE,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;QAClB,MAAM,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1D,KAAK,IAAI,IAAI,GAAG,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,WAAW,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,GAAG,CAAC;QAC/E,IAAI,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,wGAAwG;AACxG,MAAM,aAAa,GAAG,CAAC,CAAC;AAExB,KAAK,UAAU,QAAQ,CAAI,IAAuB,EAAE,IAAiC;IACnF,MAAM,OAAO,GAAQ,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5C,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE;QACxB,KAAK,IAAI,KAAK,GAAG,IAAI,EAAE,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,GAAG,IAAI,EAAE;YAAE,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAE,CAAC,CAAC;IAC1G,CAAC,CAAC;IACF,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;IACxF,OAAO,OAAO,CAAC;AACjB,CAAC;AAKD,iHAAiH;AACjH,MAAM,IAAI,GAAG,CAAC,KAAa,EAAc,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACrF,MAAM,KAAK,GAAG,CAAC,MAA4C,EAAS,EAAE,CACpE,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9E,MAAM,KAAK,GAAG,CAAC,KAAiE,EAAuB,EAAE;IACvG,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACvC,OAAO,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAC5D,CAAC,CAAC;AACF,sEAAsE;AACtE,MAAM,IAAI,GAAG,CAAC,KAAgC,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC;AA0BjE,mFAAmF;AAEnF,MAAM,MAAM,GAAG,CAAC,GAAQ,EAAQ,EAAE,CAChC,CAAC;IACC,GAAG,GAAG;IACN,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAE;IACvB,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC;IAC1C,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC;IACxC,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;IAC5B,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;IACxB,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC;CACrC,CAAoB,CAAC;AAExB,MAAM,MAAM,GAAG,CAAC,GAAQ,EAAQ,EAAE,CAChC,CAAC;IACC,GAAG,GAAG;IACN,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAE;IACvB,gBAAgB,EAAE,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC;IAC7C,iBAAiB,EAAE,KAAK,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAC/C,aAAa,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;IACtC,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC;IAChC,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;IAC5B,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC;IAC7B,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;IACxB,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC;CACjC,CAAoB,CAAC;AAExB,MAAM,YAAY,GAAG,CAAC,GAAQ,EAAE,OAAgB,EAAc,EAAE,CAC9D,CAAC;IACC,GAAG,GAAG;IACN,yGAAyG;IACzG,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,IAAI,EAAE,EAAE;IAClE,gBAAgB,EAAE,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC;IAC5C,iBAAiB,EAAE,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC;CAC/C,CAA0B,CAAC;AAE9B,MAAM,SAAS,GAAG,CAAC,GAAQ,EAAW,EAAE,CACtC,CAAC;IACC,GAAG,GAAG;IACN,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAE;IACvB,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC;IAC7B,SAAS,EAAE,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC;IAC/B,KAAK,EAAE,GAAG,CAAC,KAAK,IAAI,EAAE;IACtB,WAAW,EAAE,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;CAC5F,CAAuB,CAAC;AAE3B;;;;GAIG;AACH,SAAS,KAAK,CACZ,MAAmB,EACnB,QAAgB,EAChB,KAAmB,EACnB,EAAmB,EACnB,OAA0B,EAAE;IAE5B,MAAM,IAAI,GAAG,KAAK,EAAE,GAAW,EAAE,EAAE,CAAC,EAAE,CAAC,MAAM,MAAM,CAAC,IAAI,CAAM,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;IAC9E,MAAM,IAAI,GAAG,CAAC,MAAc,EAAE,EAAE,CAC9B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxF,OAAO;QACL,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC;QACpF,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,MAAM,MAAM,CAAC,MAAM,CAAM,QAAQ,EAAE,IAAI,CAAC,KAAe,CAAC,CAAC,CAAC;QACtF,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO;YAC1B,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;YAC1B,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,IAAI,CAAM,QAAQ,EAAE,GAAG,CAAC,CAAC;YACtD,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;YACrE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;QACD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;YACvB,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/C,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,MAAmB;IAC5C,MAAM,QAAQ,GAAG,KAAK,CAAwB,MAAM,EAAE,QAAQ,CAAC,eAAe,EAAE,iBAAiB,EAAE,SAAS,EAAE;QAC5G,sDAAsD;QACtD,OAAO;QACP,aAAa;KACd,CAAC,CAAC;IACH,MAAM,UAAU,GAAG,KAAK,EAAE,GAAW,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,MAAM,CAAC,IAAI,CAAM,QAAQ,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC,CAAC;IACjH,gFAAgF;IAChF,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,EAAE,CAChC,MAAM,CAAC,IAAI,CACT,QAAQ,CAAC,QAAQ,EACjB,GAAG,CACJ,CAAC;IACJ,MAAM,SAAS,GAAG,CAAC,QAA+C,EAAkB,EAAE,CAAC,CAAC;QACtF,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,EAAE;QACxC,SAAS,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,IAAI,EAAE;KAClD,CAAC,CAAC;IACH,gHAAgH;IAChH,6GAA6G;IAC7G,MAAM,QAAQ,GAAG,KAAK,EACpB,QAAgB,EAChB,QAAsE,EACtE,KAAyB,EACzB,KAAyB,EACzB,QAAgB,EAChB,EAAE;QACF,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO;QAChC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1B,IAAI,QAAQ,EAAE,CAAC,KAAK,CAAC,KAAK,IAAI;YAAE,OAAO;QACvC,IAAI,QAAQ,IAAI,CAAC,IAAI;YAAE,OAAO,KAAK,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QACjF,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAM,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC9D,OAAO,KAAK,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,IAAI;YAAE,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1F,CAAC,CAAC;IACF,OAAO;QACL,SAAS,EAAE;YACT,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAU,QAAQ,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC;SAC9G;QACD,MAAM,EAAE;YACN,8GAA8G;YAC9G,8GAA8G;YAC9G,4DAA4D;YAC5D,KAAK,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE;gBAC7C,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,MAAM,CAAkB,QAAQ,CAAC,QAAQ,EAAE;oBACvE,KAAK,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE;oBAC5B,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC;oBAC5B,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE;iBACpD,CAAC,CAAC;gBACH,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAkB,QAAQ,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;oBAC1G,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE;wBACxC,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE;wBAC3B,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE;wBACnC,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,IAAI;qBAC/C,CAAC,CAAC;oBACH,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC;oBACpC,IAAI,KAAK;wBAAE,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;oBAC3F,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC;oBACzC,IAAI,MAAM;wBAAE,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;gBACnG,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;oBAC5E,MAAM,KAAK,CAAC;gBACd,CAAC;gBACD,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAC9G,CAAC;YACD,cAAc,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC/E,KAAK,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO;gBACvC,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAC5B,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,CAAC;gBACrC,MAAM,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;gBACjF,MAAM,QAAQ,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;gBAC9F,OAAO,SAAS,CAAC,MAAM,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;YACzC,CAAC;SACF;QACD,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC;QACnD,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC;QACnD,QAAQ;QACR,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAc,QAAQ,CAAC,YAAY,EAAE,KAAK,CAAC,EAAE;QAC7F,WAAW,EAAE;YACX,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC;YACnG,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,MAAM,CAAC,MAAM,CAAM,QAAQ,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC;YACnG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO;gBAC1B,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;gBAC1B,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,IAAI,CAAM,QAAQ,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;gBACzE,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE,EAAE,GAAG,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;gBAClF,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC;YACzB,CAAC;YACD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;gBACvB,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YAClE,CAAC;SACF;QACD,SAAS,EAAE;YACT,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CACpB,QAAQ,CAAC,MAAM,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CACnE,MAAM,CAAC,IAAI,CAAW,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAC9C;YACH,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAW,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACzE;KACF,CAAC;AACJ,CAAC;AAyBD;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,IAAa,EAAE,UAAyB,EAAE;IACtE,MAAM,EAAE,SAAS,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,GAAG,GAAG,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC;IAC9F,MAAM,MAAM,GAAG,KAAK,EAAK,KAAQ,EAAc,EAAE;QAC/C,IAAI,SAAS,GAAG,CAAC;YAAE,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC,OAAO,eAAe,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC,CAAC;IAEF,SAAS,UAAU,CACjB,OAAmB,EACnB,OAAY,EACZ,GAAW,EACX,OAAgB,EAChB,OAA0C;QAE1C,MAAM,IAAI,GAAG,CAAC,MAAe,EAAE,EAAE;YAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YAChF,IAAI,KAAK,GAAG,CAAC;gBAAE,MAAM,IAAI,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YAClE,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QACF,OAAO;YACL,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAC3F,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAE,CAAC;YACrD,KAAK,CAAC,MAAM,CAAC,KAAK;gBAChB,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC;gBACrB,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC;gBAChC,MAAM,OAAO,GAAG;oBACd,GAAG,eAAe,CAAC,KAAK,CAAC;oBACzB,GAAG;oBACH,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,EAAE;oBACnB,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACvD,CAAC;gBAClB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACtB,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;YACzB,CAAC;YACD,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO;gBAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC3B,MAAM,OAAO,GAAG;oBACd,GAAG,OAAO,CAAC,KAAK,CAAE;oBAClB,GAAG,eAAe,CAAC,OAAO,CAAC;oBAC3B,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC7D,CAAC;gBACF,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC;gBACzB,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;YACzB,CAAC;YACD,KAAK,CAAC,MAAM,CAAC,MAAM;gBACjB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;gBAChC,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;YAC1B,CAAC;SACF,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,CAAC,MAA0C,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC;IAChF,yDAAyD;IACzD,MAAM,YAAY,GAAG,CAAC,UAAsB,EAAE,EAAE,CAC9C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,KAAK,UAAU,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC;IAC5F,gGAAgG;IAChG,MAAM,OAAO,GAAG,IAAI,GAAG,EAA0B,CAAC;IAClD,MAAM,UAAU,GAAG,CAAC,GAAW,EAAkB,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IACrG,OAAO;QACL,6FAA6F;QAC7F,SAAS,EAAE;YACT,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE;gBAC1B,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC;gBACrB,MAAM,OAAO,GAAY;oBACvB,GAAG;oBACH,GAAG,EAAE,iBAAiB,GAAG,EAAE;oBAC3B,IAAI;oBACJ,KAAK,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,iBAAiB,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE;iBACnE,CAAC;gBACF,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;YACzB,CAAC;SACF;QACD,uEAAuE;QACvE,MAAM,EAAE;YACN,KAAK,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;gBACtC,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC;gBACrB,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;gBACrG,OAAO,MAAM,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YACxG,CAAC;YACD,cAAc,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YAC9E,KAAK,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO;gBACvC,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAC5B,MAAM,IAAI,GAAG,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACpC,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS;oBAAE,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;gBACnE,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS;oBAAE,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;gBAC/E,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBACvB,OAAO,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;YAC7B,CAAC;SACF;QACD,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,CAAC;QAClE,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,CAAC;QAClE,YAAY,EAAE;YACZ,KAAK,CAAC,MAAM,CAAC,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE;gBACxC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,cAAc,CAAC,GAAG,CAAC,CAAC;gBACxF,IAAI,CAAC,OAAO;oBAAE,MAAM,IAAI,gBAAgB,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,CAAC,CAAC;gBACzE,MAAM,IAAI,GAAgB,EAAE,GAAG,eAAe,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC;gBACxE,OAAO,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACjD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;SACF;QACD,WAAW,EAAE,UAAU,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,EAAE,0BAA0B,EAAE,KAAK,EAAE,YAAY,CAAC;QACzG,SAAS,EAAE,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC;QACpE,QAAQ,EAAE,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,EAAE,uBAAuB,EAAE,KAAK,EAAE,KAAK,CAAC;KACvF,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
import type { BaackClient, 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 CrmBackend, type DealInput, type InvoiceInput, type InvoiceLineInput, type LeadInput, type RemittanceInput } from './backend.ts';
|
|
5
|
+
import { type ContactDetails, type CrmConcept, type CrmPerson, type Deal, type DealOutcome, type Invoice, type Lead, type LeadOutcome, type NewContact, type Pipeline, type PipelineStage } from './types.ts';
|
|
6
|
+
/** Where a concept's records come from: the Baack API, or sample data while the API doesn't have it. */
|
|
7
|
+
export type CrmSource = 'api' | 'sample';
|
|
8
|
+
export interface CrmClientOptions {
|
|
9
|
+
client: BaackClient;
|
|
10
|
+
/**
|
|
11
|
+
* Concepts served from sample data, with the backend holding it (usually `memoryBackend(sampleCrm(...))` from
|
|
12
|
+
* `@baack-software/baack-ts-crm/mock`). The rest come from the API.
|
|
13
|
+
*/
|
|
14
|
+
sample?: {
|
|
15
|
+
backend: CrmBackend;
|
|
16
|
+
concepts: readonly CrmConcept[] | 'all';
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
export interface ConvertOptions {
|
|
20
|
+
/** The new deal's pipeline. It starts at the first open stage. */
|
|
21
|
+
pipeline: Pipeline;
|
|
22
|
+
/** Defaults to the lead's title. */
|
|
23
|
+
title?: string;
|
|
24
|
+
/** Defaults to the lead's target value. */
|
|
25
|
+
targetValue?: Deal['targetValue'];
|
|
26
|
+
/**
|
|
27
|
+
* The client company's name when the lead has no contact company yet, as confirmed on qualifying: the company is
|
|
28
|
+
* made and linked to the lead and the deal. Empty or absent converts without a company, as for a consumer.
|
|
29
|
+
*/
|
|
30
|
+
companyName?: string;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* What an invoice's parties also need made: a company that isn't in Baack yet, by name, and a new person, made after
|
|
34
|
+
* that party's company (so they're its customer's person).
|
|
35
|
+
*/
|
|
36
|
+
export interface InvoicePartyOptions {
|
|
37
|
+
remitterCompanyName?: string | undefined;
|
|
38
|
+
recipientCompanyName?: string | undefined;
|
|
39
|
+
remitterContact?: NewContact | undefined;
|
|
40
|
+
recipientContact?: NewContact | undefined;
|
|
41
|
+
}
|
|
42
|
+
/** What a new invoice also needs: the deal it's for, and its parties' new companies and people. */
|
|
43
|
+
export interface NewInvoiceOptions extends InvoicePartyOptions {
|
|
44
|
+
deal?: Deal;
|
|
45
|
+
}
|
|
46
|
+
/** What saving an invoice made along the way: its parties' new companies and people. */
|
|
47
|
+
export interface InvoiceSaved {
|
|
48
|
+
invoice: Invoice;
|
|
49
|
+
companies: Company[];
|
|
50
|
+
people: CrmPerson[];
|
|
51
|
+
}
|
|
52
|
+
export interface NewLeadOptions {
|
|
53
|
+
/**
|
|
54
|
+
* The prospect's business name when it isn't a company in Baack yet: the company is made first, owned by the lead's
|
|
55
|
+
* owner, and linked as the lead's contact company, since a lead holds a business by its company.
|
|
56
|
+
*/
|
|
57
|
+
companyName?: string;
|
|
58
|
+
/**
|
|
59
|
+
* A new person to be the lead's contact: made after the company (so they're linked to it, as its customer's person),
|
|
60
|
+
* and linked as the lead's contact identity.
|
|
61
|
+
*/
|
|
62
|
+
contact?: NewContact;
|
|
63
|
+
}
|
|
64
|
+
/** What saving a lead made along the way: the prospect's company and the contact, when they were new. */
|
|
65
|
+
export interface LeadSaved {
|
|
66
|
+
lead: Lead;
|
|
67
|
+
company?: Company;
|
|
68
|
+
person?: CrmPerson;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* CRM records for a company, each concept from the API or from sample data (see `CrmClientOptions.sample`), so views
|
|
72
|
+
* can be built and reviewed before the API has every concept. Moving a concept to the API changes the options, not
|
|
73
|
+
* the code using this client.
|
|
74
|
+
*
|
|
75
|
+
* ```ts
|
|
76
|
+
* const crm = createCrmClient({ client, sample: { backend: memoryBackend(sampleCrm({ owner })), concepts: 'all' } });
|
|
77
|
+
* const leads = await crm.leads.list(owner);
|
|
78
|
+
* ```
|
|
79
|
+
*/
|
|
80
|
+
export declare class CrmClient {
|
|
81
|
+
#private;
|
|
82
|
+
/** Where each concept comes from, so views can mark sample data. */
|
|
83
|
+
readonly sources: Readonly<Record<CrmConcept, CrmSource>>;
|
|
84
|
+
readonly companies: CrmBackend['companies'];
|
|
85
|
+
readonly people: CrmBackend['people'];
|
|
86
|
+
readonly leads: CrmBackend['leads'];
|
|
87
|
+
readonly deals: CrmBackend['deals'];
|
|
88
|
+
readonly pipelines: CrmBackend['pipelines'];
|
|
89
|
+
readonly invoices: CrmBackend['invoices'];
|
|
90
|
+
readonly invoiceLines: CrmBackend['invoiceLines'];
|
|
91
|
+
readonly remittances: CrmBackend['remittances'];
|
|
92
|
+
constructor(backend: CrmBackend,
|
|
93
|
+
/** Where each concept comes from, so views can mark sample data. */
|
|
94
|
+
sources: Readonly<Record<CrmConcept, CrmSource>>);
|
|
95
|
+
/** Whether any of these concepts come from sample data. */
|
|
96
|
+
isSample(...concepts: CrmConcept[]): boolean;
|
|
97
|
+
/**
|
|
98
|
+
* Qualifies a lead into a deal: creates the deal (open, with the lead's company, contact and target value, at the
|
|
99
|
+
* pipeline's first stage, with the lead as its `leadSource`), then marks the lead converted. A lead without a contact
|
|
100
|
+
* company gets one first when `companyName` is given, owned by the lead's owner and linked to the lead too, so the
|
|
101
|
+
* deal shows on the customer's page. A consumer's lead (a person, no business) converts without a company.
|
|
102
|
+
*/
|
|
103
|
+
convertLead(lead: Lead, options: ConvertOptions): Promise<{
|
|
104
|
+
lead: Lead;
|
|
105
|
+
deal: Deal;
|
|
106
|
+
company?: Company;
|
|
107
|
+
}>;
|
|
108
|
+
/** Moves a deal to a stage of its pipeline. Stages are only progress: winning or losing is `setOutcome`. */
|
|
109
|
+
moveDeal(deal: RefLike, stage: PipelineStage): Promise<Deal>;
|
|
110
|
+
/**
|
|
111
|
+
* Wins, loses or reopens a deal. Won or lost closes it now (`closeTimestamp`); reopening clears the close time and
|
|
112
|
+
* reason. `lostReason` is kept only when the deal is lost.
|
|
113
|
+
*/
|
|
114
|
+
setOutcome(deal: RefLike, outcome: DealOutcome, options?: {
|
|
115
|
+
lostReason?: string;
|
|
116
|
+
now?: Date;
|
|
117
|
+
}): Promise<Deal>;
|
|
118
|
+
/**
|
|
119
|
+
* Closes a lead as unqualified (with why), or reopens it, as `setOutcome` does for deals. Converting is
|
|
120
|
+
* `convertLead`, which also makes the deal. A lead has no close time of its own: its `updatedTimestamp` says when.
|
|
121
|
+
*/
|
|
122
|
+
setLeadOutcome(lead: RefLike, outcome: Exclude<LeadOutcome, 'CONVERTED'>, options?: {
|
|
123
|
+
closedReason?: string;
|
|
124
|
+
}): Promise<Lead>;
|
|
125
|
+
/** Creates a deal, for example one that didn't start as a lead. */
|
|
126
|
+
createDeal(input: DealInput): Promise<Deal>;
|
|
127
|
+
/**
|
|
128
|
+
* Creates an invoice, then its lines (numbered in order), then links it to `deal` when given, as deals hold their
|
|
129
|
+
* invoices. A party's new company (`remitterCompanyName`, `recipientCompanyName`) is made first, owned by the
|
|
130
|
+
* invoice's owner, then its new person (`remitterContact`, `recipientContact`). The invoice's amounts are as given:
|
|
131
|
+
* the API doesn't add them up from the lines. Returns it read back, with its lines, the deal as updated and the
|
|
132
|
+
* companies and people made.
|
|
133
|
+
*/
|
|
134
|
+
createInvoice(input: InvoiceInput, lines?: readonly Omit<InvoiceLineInput, 'paymentInvoice' | 'lineNumber'>[], options?: NewInvoiceOptions): Promise<InvoiceSaved & {
|
|
135
|
+
deal?: Deal;
|
|
136
|
+
}>;
|
|
137
|
+
/**
|
|
138
|
+
* Changes an invoice's own fields (status, parties, dates), making a party's new company and person first, as for a
|
|
139
|
+
* new invoice. Its lines aren't changed.
|
|
140
|
+
*/
|
|
141
|
+
updateInvoice(invoice: Invoice, changes: Partial<InvoiceInput>, options?: InvoicePartyOptions): Promise<InvoiceSaved>;
|
|
142
|
+
/** Records a payment (or refund) received against an invoice. */
|
|
143
|
+
recordPayment(input: RemittanceInput): Promise<import("./types.ts").Remittance>;
|
|
144
|
+
/** A person's email and telephone (see `PeopleApi.contactDetails`). */
|
|
145
|
+
contactDetails(identity: RefLike): Promise<ContactDetails>;
|
|
146
|
+
/** Sets a person's email and telephone; fields left out are kept (see `PeopleApi.setContactDetails`). */
|
|
147
|
+
setContactDetails(identity: RefLike, details: Partial<ContactDetails>): Promise<ContactDetails>;
|
|
148
|
+
/** Makes a person owned by `owner`: a customer's person when `company` is given (see `PeopleApi`). */
|
|
149
|
+
createContact(owner: RefLike, contact: NewContact, company?: RefLike | null): Promise<CrmPerson>;
|
|
150
|
+
/**
|
|
151
|
+
* Creates a lead. With `companyName` and no contact company, the prospect's company is made first and linked; with
|
|
152
|
+
* `contact`, so is the contact. Both are returned with the lead.
|
|
153
|
+
*/
|
|
154
|
+
createLead(input: LeadInput, options?: NewLeadOptions): Promise<LeadSaved>;
|
|
155
|
+
/** Changes a lead, making its new company or contact first as `createLead` does. */
|
|
156
|
+
updateLead(lead: Lead, changes: Partial<LeadInput>, options?: NewLeadOptions): Promise<LeadSaved>;
|
|
157
|
+
/** Everything the CRM holds about one customer company of `owner`. */
|
|
158
|
+
companyAccount(owner: RefLike, company: RefLike, now?: Date): Promise<CompanyAccount>;
|
|
159
|
+
/** The pipeline a deal is in, among the owner's. */
|
|
160
|
+
pipelineFor(deal: Deal): Promise<Pipeline | undefined>;
|
|
161
|
+
}
|
|
162
|
+
/** A CrmClient over the Baack API, with the concepts named in `sample` served from sample data instead. */
|
|
163
|
+
export declare function createCrmClient({ client, sample }: CrmClientOptions): CrmClient;
|
|
164
|
+
//# sourceMappingURL=crm-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"crm-client.d.ts","sourceRoot":"","sources":["../src/crm-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAC5E,OAAO,EAA2B,KAAK,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACvF,OAAO,EAAkB,KAAK,cAAc,EAAE,MAAM,cAAc,CAAC;AACnE,OAAO,EAEL,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,SAAS,EACd,KAAK,eAAe,EACrB,MAAM,cAAc,CAAC;AAEtB,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,EACnB,MAAM,YAAY,CAAC;AAEpB,wGAAwG;AACxG,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEzC,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,WAAW,CAAC;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE;QAAE,OAAO,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE,SAAS,UAAU,EAAE,GAAG,KAAK,CAAA;KAAE,CAAC;CAC3E;AAED,MAAM,WAAW,cAAc;IAC7B,kEAAkE;IAClE,QAAQ,EAAE,QAAQ,CAAC;IACnB,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IAClC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,oBAAoB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,eAAe,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IACzC,gBAAgB,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CAC3C;AAED,mGAAmG;AACnG,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,wFAAwF;AACxF,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,EAAE,CAAC;IACrB,MAAM,EAAE,SAAS,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AAED,yGAAyG;AACzG,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB;AAED;;;;;;;;;GASG;AACH,qBAAa,SAAS;;IAYlB,oEAAoE;IACpE,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IAZ3D,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IAC5C,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;IACtC,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IAC5C,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;IAC1C,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC;gBAG9C,OAAO,EAAE,UAAU;IACnB,oEAAoE;IAC3D,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IAY3D,2DAA2D;IAC3D,QAAQ,CAAC,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,OAAO;IAI5C;;;;;OAKG;IACG,WAAW,CAAC,IAAI,EAAE,IAAI,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;IA2B9G,4GAA4G;IAC5G,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5D;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IASjH;;;OAGG;IACH,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;IAKhB,mEAAmE;IACnE,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3C;;;;;;OAMG;IACG,aAAa,CACjB,KAAK,EAAE,YAAY,EACnB,KAAK,GAAE,SAAS,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,YAAY,CAAC,EAAO,EAC9E,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,YAAY,GAAG;QAAE,IAAI,CAAC,EAAE,IAAI,CAAA;KAAE,CAAC;IAa1C;;;OAGG;IACG,aAAa,CACjB,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,EAC9B,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,YAAY,CAAC;IAiDxB,iEAAiE;IACjE,aAAa,CAAC,KAAK,EAAE,eAAe;IAIpC,uEAAuE;IACvE,cAAc,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC;IAI1D,yGAAyG;IACzG,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;IAI/F,sGAAsG;IACtG,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC;IA2BhG;;;OAGG;IACG,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,SAAS,CAAC;IAMpF,oFAAoF;IAC9E,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,SAAS,CAAC;IAO3G,sEAAsE;IAChE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,OAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAWjG,oDAAoD;IAC9C,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;CAG7D;AAED,2GAA2G;AAC3G,wBAAgB,eAAe,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,gBAAgB,GAAG,SAAS,CAyB/E"}
|