-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
shares.ts
47 lines (43 loc) · 1.47 KB
/
shares.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 { DirectusShare } from '../../../schema/share.js';
import type { ApplyQueryFields, Query } from '../../../types/index.js';
import { throwIfEmpty } from '../../utils/index.js';
import type { RestCommand } from '../../types.js';
export type ReadShareOutput<
Schema extends object,
TQuery extends Query<Schema, Item>,
Item extends object = DirectusShare<Schema>,
> = ApplyQueryFields<Schema, Item, TQuery['fields']>;
/**
* List all Shares that exist in Directus.
* @param query The query parameters
* @returns An array of up to limit Share objects. If no items are available, data will be an empty array.
*/
export const readShares =
<Schema extends object, const TQuery extends Query<Schema, DirectusShare<Schema>>>(
query?: TQuery,
): RestCommand<ReadShareOutput<Schema, TQuery>[], Schema> =>
() => ({
path: `/shares`,
params: query ?? {},
method: 'GET',
});
/**
* List an existing Share by primary key.
* @param key The primary key of the dashboard
* @param query The query parameters
* @returns Returns a Share object if a valid primary key was provided.
* @throws Will throw if key is empty
*/
export const readShare =
<Schema extends object, TQuery extends Query<Schema, DirectusShare<Schema>>>(
key: DirectusShare<Schema>['id'],
query?: TQuery,
): RestCommand<ReadShareOutput<Schema, TQuery>, Schema> =>
() => {
throwIfEmpty(String(key), 'Key cannot be empty');
return {
path: `/shares/${key}`,
params: query ?? {},
method: 'GET',
};
};