@uidu/client 3.19.0 → 3.20.0
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/CHANGELOG.md +6 -0
- package/dist/declarations/src/contracts.d.ts +496 -1
- package/dist/declarations/src/expenses.d.ts +5 -0
- package/dist/declarations/src/generated/index.d.ts +1101 -13
- package/dist/declarations/src/index.d.ts +1 -1
- package/dist/uidu-client.cjs.dev.js +69 -2
- package/dist/uidu-client.cjs.prod.js +69 -2
- package/dist/uidu-client.esm.js +63 -3
- package/package.json +1 -1
- package/src/contracts.test.ts +97 -0
- package/src/contracts.ts +96 -1
- package/src/generated/index.ts +461 -35
- package/src/index.ts +11 -1
- package/src/queries/contracts/ContractMutations.graphql +108 -0
- package/src/queries/contracts/ContractQueries.graphql +17 -0
- package/src/queries/expenses/ListAnalyticAccounts.graphql +4 -0
package/package.json
CHANGED
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
|
2
|
+
|
|
3
|
+
const request = vi.fn();
|
|
4
|
+
|
|
5
|
+
vi.mock('graphql-request', () => ({
|
|
6
|
+
GraphQLClient: class {
|
|
7
|
+
request = request;
|
|
8
|
+
},
|
|
9
|
+
ClientError: class extends Error {},
|
|
10
|
+
}));
|
|
11
|
+
|
|
12
|
+
const { createClient } = await import('./client');
|
|
13
|
+
const contracts = await import('./contracts');
|
|
14
|
+
|
|
15
|
+
const client = createClient({
|
|
16
|
+
endpoint: 'https://acme.uidu.org/graphql',
|
|
17
|
+
apiKey: 'key',
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
beforeEach(() => request.mockReset());
|
|
21
|
+
|
|
22
|
+
describe('writes', () => {
|
|
23
|
+
it('createContract sends its attributes, custom values included, and returns the payload', async () => {
|
|
24
|
+
const payload = { contract: { node: { id: 'c1' } }, errors: [] };
|
|
25
|
+
request.mockResolvedValue({ createContract: payload });
|
|
26
|
+
const input = {
|
|
27
|
+
attributes: {
|
|
28
|
+
workspaceId: 'w1',
|
|
29
|
+
name: 'JET HR',
|
|
30
|
+
startsOn: '2027-01-01',
|
|
31
|
+
counterpartId: 'o1',
|
|
32
|
+
fieldValues: { f1: 1.21 },
|
|
33
|
+
},
|
|
34
|
+
};
|
|
35
|
+
|
|
36
|
+
await expect(contracts.createContract(client, { input })).resolves.toEqual(
|
|
37
|
+
payload,
|
|
38
|
+
);
|
|
39
|
+
expect(JSON.stringify(request.mock.calls[0][0])).toContain(
|
|
40
|
+
'createContract',
|
|
41
|
+
);
|
|
42
|
+
expect(request.mock.calls[0][1]).toEqual({ input });
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
it('activateContract signs it', async () => {
|
|
46
|
+
request.mockResolvedValue({
|
|
47
|
+
activateContract: {
|
|
48
|
+
contract: { id: 'c1', aasmState: 'active' },
|
|
49
|
+
errors: [],
|
|
50
|
+
},
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
const result = await contracts.activateContract(client, {
|
|
54
|
+
input: { id: 'c1' },
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
expect(result?.contract?.aasmState).toBe('active');
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
it('discardContract goes through the trash', async () => {
|
|
61
|
+
request.mockResolvedValue({
|
|
62
|
+
discardableDiscard: { discardable: { id: 'c1' }, errors: [] },
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
await contracts.discardContract(client, { input: { id: 'c1' } });
|
|
66
|
+
|
|
67
|
+
expect(JSON.stringify(request.mock.calls[0][0])).toContain(
|
|
68
|
+
'discardableDiscard',
|
|
69
|
+
);
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
it('createContractItem adds a line in cents', async () => {
|
|
73
|
+
const payload = {
|
|
74
|
+
contractItem: { node: { id: 'i1', unitAmount: 9_050_000 } },
|
|
75
|
+
errors: [],
|
|
76
|
+
};
|
|
77
|
+
request.mockResolvedValue({ createContractItem: payload });
|
|
78
|
+
const input = {
|
|
79
|
+
attributes: { contractId: 'c1', unitAmount: 9_050_000, quantity: 1 },
|
|
80
|
+
};
|
|
81
|
+
|
|
82
|
+
await expect(
|
|
83
|
+
contracts.createContractItem(client, { input }),
|
|
84
|
+
).resolves.toEqual(payload);
|
|
85
|
+
expect(request.mock.calls[0][1]).toEqual({ input });
|
|
86
|
+
});
|
|
87
|
+
|
|
88
|
+
it('returns null when the mutation has no payload', async () => {
|
|
89
|
+
request.mockResolvedValue({ updateContract: null });
|
|
90
|
+
|
|
91
|
+
await expect(
|
|
92
|
+
contracts.updateContract(client, {
|
|
93
|
+
input: { id: 'c1', attributes: { name: 'x' } },
|
|
94
|
+
}),
|
|
95
|
+
).resolves.toBeNull();
|
|
96
|
+
});
|
|
97
|
+
});
|
package/src/contracts.ts
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
import type { UiduClient } from './client';
|
|
2
2
|
import {
|
|
3
|
+
ActivateContractDocument,
|
|
4
|
+
type ActivateContractMutationVariables,
|
|
5
|
+
CreateContractDocument,
|
|
6
|
+
CreateContractItemDocument,
|
|
7
|
+
type CreateContractItemMutationVariables,
|
|
8
|
+
type CreateContractMutationVariables,
|
|
9
|
+
DeleteContractItemDocument,
|
|
10
|
+
type DeleteContractItemMutationVariables,
|
|
11
|
+
DiscardContractDocument,
|
|
12
|
+
type DiscardContractMutationVariables,
|
|
13
|
+
UpdateContractDocument,
|
|
14
|
+
UpdateContractItemDocument,
|
|
15
|
+
type UpdateContractItemMutationVariables,
|
|
16
|
+
type UpdateContractMutationVariables,
|
|
3
17
|
GetContractDocument,
|
|
4
18
|
type GetContractQuery,
|
|
5
19
|
type GetContractQueryVariables,
|
|
@@ -12,7 +26,11 @@ import { nodes } from './utils/relay';
|
|
|
12
26
|
// Contracts: an agreement with a counterpart (a Contact or an Organization),
|
|
13
27
|
// booked on an analytic account. Like deals, a contract carries the custom
|
|
14
28
|
// fields the workspace added to it: read them as `fieldValuesByShortname`
|
|
15
|
-
// (`{ shortname: value }`) or `fieldValues
|
|
29
|
+
// (`{ shortname: value }`) or `fieldValues`, write them as `fieldValues`
|
|
30
|
+
// (`{ fieldGlobalId: value }`) on create and update. A contract is a draft
|
|
31
|
+
// until `activateContract` signs it; its money is in `contractItems`, one line
|
|
32
|
+
// each with an amount in cents and its own dates. The sector a contract
|
|
33
|
+
// belongs to is `analyticAccount.effectiveResponsibleCircle`.
|
|
16
34
|
|
|
17
35
|
export type Contract = NonNullable<
|
|
18
36
|
NonNullable<
|
|
@@ -42,3 +60,80 @@ export async function getContract(
|
|
|
42
60
|
const result = await client.query(GetContractDocument, variables);
|
|
43
61
|
return result.currentWorkspace?.contract ?? null;
|
|
44
62
|
}
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Create a contract: `{ input: { attributes: { workspaceId, name, startsOn,
|
|
66
|
+
* endsOn, counterpartId, analyticAccountId, fieldValues } } }`. `counterpartId`
|
|
67
|
+
* is an Organization or Contact (see `createOrganization` for a new client).
|
|
68
|
+
* The new contract starts as a draft. Returns the payload (with `errors`) or
|
|
69
|
+
* null; the contract is at `contract.node`.
|
|
70
|
+
*/
|
|
71
|
+
export async function createContract(
|
|
72
|
+
client: UiduClient,
|
|
73
|
+
variables: CreateContractMutationVariables,
|
|
74
|
+
) {
|
|
75
|
+
const result = await client.mutate(CreateContractDocument, variables);
|
|
76
|
+
return result.createContract ?? null;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* Update a contract's terms, client, analytic account or custom `fieldValues`:
|
|
81
|
+
* `{ input: { id, attributes } }`. Returns the payload (with `errors`) or null.
|
|
82
|
+
*/
|
|
83
|
+
export async function updateContract(
|
|
84
|
+
client: UiduClient,
|
|
85
|
+
variables: UpdateContractMutationVariables,
|
|
86
|
+
) {
|
|
87
|
+
const result = await client.mutate(UpdateContractDocument, variables);
|
|
88
|
+
return result.updateContract ?? null;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/** Sign a draft contract (draft → active): `{ input: { id } }`. Returns the payload or null. */
|
|
92
|
+
export async function activateContract(
|
|
93
|
+
client: UiduClient,
|
|
94
|
+
variables: ActivateContractMutationVariables,
|
|
95
|
+
) {
|
|
96
|
+
const result = await client.mutate(ActivateContractDocument, variables);
|
|
97
|
+
return result.activateContract ?? null;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/** Move a contract to the trash (restorable for 30 days): `{ input: { id } }`. Returns the payload or null. */
|
|
101
|
+
export async function discardContract(
|
|
102
|
+
client: UiduClient,
|
|
103
|
+
variables: DiscardContractMutationVariables,
|
|
104
|
+
) {
|
|
105
|
+
const result = await client.mutate(DiscardContractDocument, variables);
|
|
106
|
+
return result.discardableDiscard ?? null;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Add an economic line to a contract: `{ input: { attributes: { contractId,
|
|
111
|
+
* description, quantity, unitAmount, startsAt, endsAt } } }`, with
|
|
112
|
+
* `unitAmount` in cents. Returns the payload (with `errors`) or null; the line
|
|
113
|
+
* is at `contractItem.node`.
|
|
114
|
+
*/
|
|
115
|
+
export async function createContractItem(
|
|
116
|
+
client: UiduClient,
|
|
117
|
+
variables: CreateContractItemMutationVariables,
|
|
118
|
+
) {
|
|
119
|
+
const result = await client.mutate(CreateContractItemDocument, variables);
|
|
120
|
+
return result.createContractItem ?? null;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
/** Update a contract line: `{ input: { id, attributes } }`. Returns the payload (with `errors`) or null. */
|
|
124
|
+
export async function updateContractItem(
|
|
125
|
+
client: UiduClient,
|
|
126
|
+
variables: UpdateContractItemMutationVariables,
|
|
127
|
+
) {
|
|
128
|
+
const result = await client.mutate(UpdateContractItemDocument, variables);
|
|
129
|
+
return result.updateContractItem ?? null;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/** Remove a contract line: `{ input: { id } }`. Returns the payload or null. */
|
|
133
|
+
export async function deleteContractItem(
|
|
134
|
+
client: UiduClient,
|
|
135
|
+
variables: DeleteContractItemMutationVariables,
|
|
136
|
+
) {
|
|
137
|
+
const result = await client.mutate(DeleteContractItemDocument, variables);
|
|
138
|
+
return result.deleteContractItem ?? null;
|
|
139
|
+
}
|