@inneropen/marvin-sdk 2.0.0-next.23 → 2.0.0-next.25
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/dist/{chunk-CIFRKLJS.js → chunk-DCTX4NSF.js} +24 -126
- package/dist/index-D5zkKa4N.d.cts +3394 -0
- package/dist/index-D5zkKa4N.d.ts +3394 -0
- package/dist/index.cjs +24 -126
- package/dist/index.d.cts +4 -4
- package/dist/index.d.ts +4 -4
- package/dist/index.js +1 -1
- package/dist/{marvin-B6kWCfmU.d.ts → marvin-DDpwJbmj.d.ts} +83 -104
- package/dist/{marvin-ixVRMtIS.d.cts → marvin-DcQimSKv.d.cts} +83 -104
- package/dist/platform.cjs +1 -14
- package/dist/platform.d.cts +28 -3521
- package/dist/platform.d.ts +28 -3521
- package/dist/platform.js +1 -14
- package/dist/publish.cjs +24 -126
- package/dist/publish.d.cts +3 -3
- package/dist/publish.d.ts +3 -3
- package/dist/publish.js +1 -1
- package/dist/types/index.d.cts +1 -218
- package/dist/types/index.d.ts +1 -218
- package/package.json +1 -1
package/dist/types/index.d.ts
CHANGED
|
@@ -1,218 +1 @@
|
|
|
1
|
-
|
|
2
|
-
* Marvin Publishing Client Types
|
|
3
|
-
*
|
|
4
|
-
* TypeScript types for the Marvin publishing API responses.
|
|
5
|
-
*/
|
|
6
|
-
interface MarvinSite {
|
|
7
|
-
id: string;
|
|
8
|
-
name: string;
|
|
9
|
-
slug: string;
|
|
10
|
-
title?: string;
|
|
11
|
-
tagline?: string;
|
|
12
|
-
description?: string;
|
|
13
|
-
canonicalUrl?: string;
|
|
14
|
-
logo?: string;
|
|
15
|
-
favicon?: string;
|
|
16
|
-
locale?: string;
|
|
17
|
-
timezone?: string;
|
|
18
|
-
metadata?: Record<string, unknown>;
|
|
19
|
-
}
|
|
20
|
-
interface MarvinEntryType {
|
|
21
|
-
id: string;
|
|
22
|
-
groupId: string | null;
|
|
23
|
-
name: string;
|
|
24
|
-
slug: string;
|
|
25
|
-
icon?: string | null;
|
|
26
|
-
color?: string | null;
|
|
27
|
-
description?: string | null;
|
|
28
|
-
sortOrder: number;
|
|
29
|
-
isSystem: boolean;
|
|
30
|
-
isRendered: boolean;
|
|
31
|
-
schemaJson?: Record<string, unknown> | null;
|
|
32
|
-
renderingJson?: Record<string, unknown> | null;
|
|
33
|
-
capabilitiesJson?: Record<string, unknown> | null;
|
|
34
|
-
createdAt?: string | null;
|
|
35
|
-
updateAt?: string | null;
|
|
36
|
-
warnings?: string[] | null;
|
|
37
|
-
}
|
|
38
|
-
interface MarvinAsset {
|
|
39
|
-
id: string;
|
|
40
|
-
slug: string;
|
|
41
|
-
name: string;
|
|
42
|
-
originalFilename: string;
|
|
43
|
-
filename: string;
|
|
44
|
-
extension: string;
|
|
45
|
-
mimeType: string;
|
|
46
|
-
assetType: 'image' | 'document' | 'video' | 'audio' | 'archive' | 'svg' | 'other';
|
|
47
|
-
fileSize: number;
|
|
48
|
-
checksum: string;
|
|
49
|
-
width?: number;
|
|
50
|
-
height?: number;
|
|
51
|
-
orientation?: number;
|
|
52
|
-
storageProvider: string;
|
|
53
|
-
storageKey: string;
|
|
54
|
-
publicUrl?: string;
|
|
55
|
-
altText?: string;
|
|
56
|
-
description?: string;
|
|
57
|
-
metadata?: Record<string, unknown>;
|
|
58
|
-
uploadedBy: string;
|
|
59
|
-
createdAt: string;
|
|
60
|
-
updatedAt: string;
|
|
61
|
-
}
|
|
62
|
-
interface PublishedAsset {
|
|
63
|
-
slug: string;
|
|
64
|
-
name: string;
|
|
65
|
-
mimeType: string;
|
|
66
|
-
assetType: string;
|
|
67
|
-
fileSize: number;
|
|
68
|
-
width?: number;
|
|
69
|
-
height?: number;
|
|
70
|
-
altText?: string;
|
|
71
|
-
description?: string;
|
|
72
|
-
publicUrl: string;
|
|
73
|
-
}
|
|
74
|
-
interface AssetUploadRequest {
|
|
75
|
-
slug: string;
|
|
76
|
-
name: string;
|
|
77
|
-
altText?: string;
|
|
78
|
-
description?: string;
|
|
79
|
-
metadata?: Record<string, unknown>;
|
|
80
|
-
}
|
|
81
|
-
interface MarvinCollection {
|
|
82
|
-
id: string;
|
|
83
|
-
name: string;
|
|
84
|
-
slug: string;
|
|
85
|
-
description?: string;
|
|
86
|
-
icon?: string;
|
|
87
|
-
color?: string;
|
|
88
|
-
sortOrder: number;
|
|
89
|
-
isSmart: boolean;
|
|
90
|
-
smartRules?: Record<string, unknown>;
|
|
91
|
-
createdAt: string;
|
|
92
|
-
updatedAt: string;
|
|
93
|
-
entryCount?: number;
|
|
94
|
-
entries?: MarvinEntry[];
|
|
95
|
-
}
|
|
96
|
-
interface MarvinResource {
|
|
97
|
-
id: string;
|
|
98
|
-
name: string;
|
|
99
|
-
slug: string;
|
|
100
|
-
resourceType?: string;
|
|
101
|
-
description?: string;
|
|
102
|
-
externalId?: string;
|
|
103
|
-
url?: string;
|
|
104
|
-
metadata?: Record<string, unknown>;
|
|
105
|
-
createdAt: string;
|
|
106
|
-
updatedAt: string;
|
|
107
|
-
}
|
|
108
|
-
interface PublishedCollectionSummary {
|
|
109
|
-
slug: string;
|
|
110
|
-
name: string;
|
|
111
|
-
metadataJson?: Record<string, unknown> | null;
|
|
112
|
-
sortOrder: number;
|
|
113
|
-
}
|
|
114
|
-
interface PublishedResourceRead {
|
|
115
|
-
slug: string;
|
|
116
|
-
name: string;
|
|
117
|
-
resourceType: string;
|
|
118
|
-
description?: string | null;
|
|
119
|
-
url?: string | null;
|
|
120
|
-
externalId?: string | null;
|
|
121
|
-
metadataJson?: Record<string, unknown> | null;
|
|
122
|
-
role?: string | null;
|
|
123
|
-
quantity?: string | null;
|
|
124
|
-
unit?: string | null;
|
|
125
|
-
position: number;
|
|
126
|
-
}
|
|
127
|
-
interface PublishedAssetRead {
|
|
128
|
-
slug: string;
|
|
129
|
-
name: string;
|
|
130
|
-
mimeType: string;
|
|
131
|
-
assetType: string;
|
|
132
|
-
fileSize: number;
|
|
133
|
-
width?: number | null;
|
|
134
|
-
height?: number | null;
|
|
135
|
-
altText?: string | null;
|
|
136
|
-
description?: string | null;
|
|
137
|
-
publicUrl: string;
|
|
138
|
-
metadataJson?: Record<string, unknown> | null;
|
|
139
|
-
}
|
|
140
|
-
interface MarvinEntry {
|
|
141
|
-
slug: string;
|
|
142
|
-
title: string;
|
|
143
|
-
entryType: string;
|
|
144
|
-
entryTypeInfo?: {
|
|
145
|
-
slug: string;
|
|
146
|
-
renderer?: string | null;
|
|
147
|
-
package?: string | null;
|
|
148
|
-
version?: string | null;
|
|
149
|
-
config?: Record<string, unknown> | null;
|
|
150
|
-
publishable: boolean;
|
|
151
|
-
submittable: boolean;
|
|
152
|
-
routable: boolean;
|
|
153
|
-
} | null;
|
|
154
|
-
summary?: string | null;
|
|
155
|
-
data: Record<string, unknown>;
|
|
156
|
-
publishedAt?: string | null;
|
|
157
|
-
metadataJson?: Record<string, unknown> | null;
|
|
158
|
-
collections: PublishedCollectionSummary[];
|
|
159
|
-
resources: PublishedResourceRead[];
|
|
160
|
-
assets: PublishedAssetRead[];
|
|
161
|
-
order?: number | null;
|
|
162
|
-
}
|
|
163
|
-
interface MarvinPublishResponse<T> {
|
|
164
|
-
data: T;
|
|
165
|
-
meta?: {
|
|
166
|
-
total?: number;
|
|
167
|
-
page?: number;
|
|
168
|
-
limit?: number;
|
|
169
|
-
};
|
|
170
|
-
}
|
|
171
|
-
interface MarvinClientConfig {
|
|
172
|
-
apiUrl: string;
|
|
173
|
-
siteClientToken: string;
|
|
174
|
-
workspaceSlug: string;
|
|
175
|
-
}
|
|
176
|
-
interface GetEntriesOptions {
|
|
177
|
-
entryType?: string;
|
|
178
|
-
collection?: string;
|
|
179
|
-
limit?: number;
|
|
180
|
-
offset?: number;
|
|
181
|
-
status?: string;
|
|
182
|
-
}
|
|
183
|
-
interface GetAssetsOptions {
|
|
184
|
-
type?: string;
|
|
185
|
-
limit?: number;
|
|
186
|
-
offset?: number;
|
|
187
|
-
}
|
|
188
|
-
interface PublishedEntryType {
|
|
189
|
-
slug: string;
|
|
190
|
-
name: string;
|
|
191
|
-
isRendered: boolean;
|
|
192
|
-
rendering?: {
|
|
193
|
-
renderer?: string;
|
|
194
|
-
package?: string;
|
|
195
|
-
version?: string;
|
|
196
|
-
config?: Record<string, unknown>;
|
|
197
|
-
};
|
|
198
|
-
capabilities?: {
|
|
199
|
-
publishable: boolean;
|
|
200
|
-
submittable: boolean;
|
|
201
|
-
routable: boolean;
|
|
202
|
-
} | null;
|
|
203
|
-
}
|
|
204
|
-
interface GetResourcesOptions {
|
|
205
|
-
resourceType?: string;
|
|
206
|
-
limit?: number;
|
|
207
|
-
offset?: number;
|
|
208
|
-
}
|
|
209
|
-
/**
|
|
210
|
-
* Authentication token response
|
|
211
|
-
* Used by auth.login() and auth.refresh()
|
|
212
|
-
*/
|
|
213
|
-
interface AuthToken {
|
|
214
|
-
accessToken: string;
|
|
215
|
-
tokenType: string;
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
export type { AssetUploadRequest, AuthToken, GetAssetsOptions, GetEntriesOptions, GetResourcesOptions, MarvinAsset, MarvinClientConfig, MarvinCollection, MarvinEntry, MarvinEntryType, MarvinPublishResponse, MarvinResource, MarvinSite, PublishedAsset, PublishedAssetRead, PublishedCollectionSummary, PublishedEntryType, PublishedResourceRead };
|
|
1
|
+
export { n as AssetUploadRequest, A as AuthToken, G as GetAssetsOptions, a as GetEntriesOptions, b as GetResourcesOptions, M as MarvinAsset, o as MarvinClientConfig, c as MarvinCollection, d as MarvinEntry, e as MarvinEntryListItem, f as MarvinEntryType, g as MarvinPublishResponse, h as MarvinResource, i as MarvinSite, P as PublishedAssetRead, j as PublishedCollectionSummary, k as PublishedEntryType, l as PublishedResourceRead, S as SiteConfiguration, W as WorkspaceInfo } from '../index-D5zkKa4N.js';
|