@inneropen/marvin-sdk 2.0.0-next.23 → 2.0.0-next.24
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.cjs +24 -126
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +1 -1
- package/dist/{marvin-ixVRMtIS.d.cts → marvin-CwB9ybc8.d.cts} +32 -101
- package/dist/{marvin-B6kWCfmU.d.ts → marvin-KVTEthgH.d.ts} +32 -101
- package/dist/platform.cjs +1 -14
- package/dist/platform.d.cts +27 -189
- package/dist/platform.d.ts +27 -189
- 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 +58 -65
- package/dist/types/index.d.ts +58 -65
- package/package.json +1 -1
package/dist/types/index.d.ts
CHANGED
|
@@ -4,18 +4,23 @@
|
|
|
4
4
|
* TypeScript types for the Marvin publishing API responses.
|
|
5
5
|
*/
|
|
6
6
|
interface MarvinSite {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
7
|
+
workspace: {
|
|
8
|
+
slug: string;
|
|
9
|
+
name: string;
|
|
10
|
+
};
|
|
11
|
+
site: {
|
|
12
|
+
title?: string | null;
|
|
13
|
+
tagline?: string | null;
|
|
14
|
+
description?: string | null;
|
|
15
|
+
canonicalUrl?: string | null;
|
|
16
|
+
logo?: string | null;
|
|
17
|
+
favicon?: string | null;
|
|
18
|
+
locale: string;
|
|
19
|
+
timezone: string;
|
|
20
|
+
contactEmail?: string | null;
|
|
21
|
+
social?: Record<string, unknown> | null;
|
|
22
|
+
metadataJson?: Record<string, unknown> | null;
|
|
23
|
+
};
|
|
19
24
|
}
|
|
20
25
|
interface MarvinEntryType {
|
|
21
26
|
id: string;
|
|
@@ -36,40 +41,17 @@ interface MarvinEntryType {
|
|
|
36
41
|
warnings?: string[] | null;
|
|
37
42
|
}
|
|
38
43
|
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
44
|
slug: string;
|
|
64
45
|
name: string;
|
|
65
46
|
mimeType: string;
|
|
66
47
|
assetType: string;
|
|
67
48
|
fileSize: number;
|
|
68
|
-
width?: number;
|
|
69
|
-
height?: number;
|
|
70
|
-
altText?: string;
|
|
71
|
-
description?: string;
|
|
49
|
+
width?: number | null;
|
|
50
|
+
height?: number | null;
|
|
51
|
+
altText?: string | null;
|
|
52
|
+
description?: string | null;
|
|
72
53
|
publicUrl: string;
|
|
54
|
+
metadataJson?: Record<string, unknown> | null;
|
|
73
55
|
}
|
|
74
56
|
interface AssetUploadRequest {
|
|
75
57
|
slug: string;
|
|
@@ -79,31 +61,24 @@ interface AssetUploadRequest {
|
|
|
79
61
|
metadata?: Record<string, unknown>;
|
|
80
62
|
}
|
|
81
63
|
interface MarvinCollection {
|
|
82
|
-
id: string;
|
|
83
|
-
name: string;
|
|
84
64
|
slug: string;
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
color?: string;
|
|
88
|
-
sortOrder: number;
|
|
65
|
+
name: string;
|
|
66
|
+
description?: string | null;
|
|
89
67
|
isSmart: boolean;
|
|
90
|
-
smartRules?: Record<string, unknown
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
entries?: MarvinEntry[];
|
|
68
|
+
smartRules?: Record<string, unknown> | null;
|
|
69
|
+
metadataJson?: Record<string, unknown> | null;
|
|
70
|
+
entryCount: number;
|
|
71
|
+
entries: MarvinEntryListItem[];
|
|
95
72
|
}
|
|
96
73
|
interface MarvinResource {
|
|
97
|
-
id: string;
|
|
98
|
-
name: string;
|
|
99
74
|
slug: string;
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
url?: string;
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
75
|
+
name: string;
|
|
76
|
+
resourceType: string;
|
|
77
|
+
description?: string | null;
|
|
78
|
+
url?: string | null;
|
|
79
|
+
externalId?: string | null;
|
|
80
|
+
metadataJson?: Record<string, unknown> | null;
|
|
81
|
+
entries: string[];
|
|
107
82
|
}
|
|
108
83
|
interface PublishedCollectionSummary {
|
|
109
84
|
slug: string;
|
|
@@ -137,6 +112,28 @@ interface PublishedAssetRead {
|
|
|
137
112
|
publicUrl: string;
|
|
138
113
|
metadataJson?: Record<string, unknown> | null;
|
|
139
114
|
}
|
|
115
|
+
interface MarvinEntryListItem {
|
|
116
|
+
slug: string;
|
|
117
|
+
title: string;
|
|
118
|
+
entryType: string;
|
|
119
|
+
entryTypeInfo?: {
|
|
120
|
+
slug: string;
|
|
121
|
+
renderer?: string | null;
|
|
122
|
+
package?: string | null;
|
|
123
|
+
version?: string | null;
|
|
124
|
+
config?: Record<string, unknown> | null;
|
|
125
|
+
publishable: boolean;
|
|
126
|
+
submittable: boolean;
|
|
127
|
+
routable: boolean;
|
|
128
|
+
} | null;
|
|
129
|
+
summary?: string | null;
|
|
130
|
+
publishedAt?: string | null;
|
|
131
|
+
status: string;
|
|
132
|
+
collections: string[];
|
|
133
|
+
assetSlugs: string[];
|
|
134
|
+
resourceSlugs: string[];
|
|
135
|
+
order?: number | null;
|
|
136
|
+
}
|
|
140
137
|
interface MarvinEntry {
|
|
141
138
|
slug: string;
|
|
142
139
|
title: string;
|
|
@@ -206,13 +203,9 @@ interface GetResourcesOptions {
|
|
|
206
203
|
limit?: number;
|
|
207
204
|
offset?: number;
|
|
208
205
|
}
|
|
209
|
-
/**
|
|
210
|
-
* Authentication token response
|
|
211
|
-
* Used by auth.login() and auth.refresh()
|
|
212
|
-
*/
|
|
213
206
|
interface AuthToken {
|
|
214
207
|
accessToken: string;
|
|
215
208
|
tokenType: string;
|
|
216
209
|
}
|
|
217
210
|
|
|
218
|
-
export type { AssetUploadRequest, AuthToken, GetAssetsOptions, GetEntriesOptions, GetResourcesOptions, MarvinAsset, MarvinClientConfig, MarvinCollection, MarvinEntry, MarvinEntryType, MarvinPublishResponse, MarvinResource, MarvinSite,
|
|
211
|
+
export type { AssetUploadRequest, AuthToken, GetAssetsOptions, GetEntriesOptions, GetResourcesOptions, MarvinAsset, MarvinClientConfig, MarvinCollection, MarvinEntry, MarvinEntryListItem, MarvinEntryType, MarvinPublishResponse, MarvinResource, MarvinSite, PublishedAssetRead, PublishedCollectionSummary, PublishedEntryType, PublishedResourceRead };
|