-
Notifications
You must be signed in to change notification settings - Fork 198
/
sync.ts
104 lines (95 loc) · 2.03 KB
/
sync.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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
import { Asset } from './asset'
import { Entry } from './entry'
import { EntitySys } from './sys'
import { EntrySkeletonType } from './query'
import { LocaleCode } from './locale'
import { ChainModifiers } from './client'
/**
* @category Sync
*/
export type SyncOptions = {
/**
* @defaultValue true
*/
paginate?: boolean
}
/**
* @category Sync
*/
export type SyncQuery = {
initial?: true
limit?: number
nextSyncToken?: string
nextPageToken?: string
} & (
| { type: 'Entry'; content_type: string }
| { type?: 'Asset' | 'Entry' | 'Deletion' | 'DeletedAsset' | 'DeletedEntry' }
)
/**
* @category Sync
*/
export type SyncPageQuery = SyncQuery & { sync_token?: string }
/**
* @category Sync
*/
export type SyncResponse = {
nextPageUrl?: string
nextSyncUrl?: string
items: SyncEntities[]
}
/**
* @category Sync
*/
export type SyncPageResponse = {
nextPageToken?: string
nextSyncToken?: string
items: SyncEntities[]
}
/**
* System managed metadata for deleted entries
* @category Sync
*/
export type DeletedEntry = {
sys: EntitySys & { type: 'DeletedEntry' }
}
/**
* System managed metadata for deleted assets
* @category Sync
*/
export type DeletedAsset = {
sys: EntitySys & { type: 'DeletedAsset' }
}
/**
* @category Sync
*/
export type SyncEntities = Entry<EntrySkeletonType> | Asset | DeletedEntry | DeletedAsset
/**
* @category Sync
*/
export interface SyncCollection<
EntrySkeleton extends EntrySkeletonType,
Modifiers extends ChainModifiers = ChainModifiers,
Locales extends LocaleCode = LocaleCode,
> {
entries: Array<
Entry<
EntrySkeleton,
ChainModifiers extends Modifiers
? ChainModifiers
: Exclude<Modifiers, undefined> | 'WITH_ALL_LOCALES',
Locales
>
>
assets: Array<
Asset<
ChainModifiers extends Modifiers
? ChainModifiers
: Exclude<Modifiers, undefined> | 'WITH_ALL_LOCALES',
Locales
>
>
deletedEntries: Array<DeletedEntry>
deletedAssets: Array<DeletedAsset>
nextSyncToken?: string
nextPageToken?: string
}