-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
flows.ts
47 lines (43 loc) · 1.44 KB
/
flows.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
import type { DirectusFlow } from '../../../schema/flow.js';
import type { ApplyQueryFields, Query } from '../../../types/index.js';
import { throwIfEmpty } from '../../utils/index.js';
import type { RestCommand } from '../../types.js';
export type ReadFlowOutput<
Schema extends object,
TQuery extends Query<Schema, Item>,
Item extends object = DirectusFlow<Schema>,
> = ApplyQueryFields<Schema, Item, TQuery['fields']>;
/**
* List all flows that exist in Directus.
* @param query The query parameters
* @returns An array of up to limit flow objects. If no items are available, data will be an empty array.
*/
export const readFlows =
<Schema extends object, const TQuery extends Query<Schema, DirectusFlow<Schema>>>(
query?: TQuery,
): RestCommand<ReadFlowOutput<Schema, TQuery>[], Schema> =>
() => ({
path: `/flows`,
params: query ?? {},
method: 'GET',
});
/**
* List an existing flow by primary key.
* @param key The primary key of the dashboard
* @param query The query parameters
* @returns Returns the requested flow object.
* @throws Will throw if key is empty
*/
export const readFlow =
<Schema extends object, const TQuery extends Query<Schema, DirectusFlow<Schema>>>(
key: DirectusFlow<Schema>['id'],
query?: TQuery,
): RestCommand<ReadFlowOutput<Schema, TQuery>, Schema> =>
() => {
throwIfEmpty(String(key), 'Key cannot be empty');
return {
path: `/flows/${key}`,
params: query ?? {},
method: 'GET',
};
};