@flexbe/sdk 0.2.14 → 0.2.16
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.
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Page, GetPagesParams, PageListResponse, PageFolder, PageFolderListResponse, UpdateFolderParams, CreateFolderParams, UpdatePageParams, BulkUpdatePageItem, BulkUpdateResponse, BulkUpdateFolderItem, BulkUpdateFolderResponse,
|
|
1
|
+
import { Page, GetPagesParams, PageListResponse, PageFolder, PageFolderListResponse, UpdateFolderParams, CreateFolderParams, UpdatePageParams, BulkUpdatePageItem, BulkUpdateResponse, BulkUpdateFolderItem, BulkUpdateFolderResponse, BulkDeleteResponse, PageContent } from '../types/pages';
|
|
2
2
|
import { ApiClient } from './api-client';
|
|
3
3
|
export declare class Pages {
|
|
4
4
|
private readonly api;
|
|
@@ -168,7 +168,7 @@ export declare class Pages {
|
|
|
168
168
|
* @throws {ServerException} When the server encounters an error
|
|
169
169
|
* @throws {TimeoutException} When the request times out
|
|
170
170
|
*/
|
|
171
|
-
bulkDeletePages(ids: number[]): Promise<
|
|
171
|
+
bulkDeletePages(ids: number[]): Promise<BulkDeleteResponse>;
|
|
172
172
|
/**
|
|
173
173
|
* Get page content
|
|
174
174
|
* @param pageId - ID of the page to get content for
|
|
@@ -179,7 +179,7 @@ export declare class Pages {
|
|
|
179
179
|
* @throws {ServerException} When the server encounters an error
|
|
180
180
|
* @throws {TimeoutException} When the request times out
|
|
181
181
|
*/
|
|
182
|
-
getPageContent(pageId: number): Promise<
|
|
182
|
+
getPageContent(pageId: number): Promise<PageContent>;
|
|
183
183
|
/**
|
|
184
184
|
* Update page content
|
|
185
185
|
* @param pageId - ID of the page to update content for
|
|
@@ -192,5 +192,5 @@ export declare class Pages {
|
|
|
192
192
|
* @throws {ServerException} When the server encounters an error
|
|
193
193
|
* @throws {TimeoutException} When the request times out
|
|
194
194
|
*/
|
|
195
|
-
updatePageContent(pageId: number, content:
|
|
195
|
+
updatePageContent(pageId: number, content: Partial<PageContent>): Promise<PageContent>;
|
|
196
196
|
}
|
|
@@ -120,7 +120,7 @@ export interface BulkUpdateFolderResponse {
|
|
|
120
120
|
updated: PageFolder[];
|
|
121
121
|
errors: BulkUpdateFolderError[];
|
|
122
122
|
}
|
|
123
|
-
export interface
|
|
123
|
+
export interface BulkDeletePages {
|
|
124
124
|
pageIds: number[];
|
|
125
125
|
}
|
|
126
126
|
export interface BulkDeleteError {
|
|
@@ -128,23 +128,42 @@ export interface BulkDeleteError {
|
|
|
128
128
|
code: number;
|
|
129
129
|
message: string;
|
|
130
130
|
}
|
|
131
|
-
export interface
|
|
131
|
+
export interface BulkDeleteResponse {
|
|
132
132
|
deleted: number[];
|
|
133
133
|
errors: BulkDeleteError[];
|
|
134
134
|
}
|
|
135
|
+
type HexColor = `#${string}`;
|
|
136
|
+
type RGBColor = `rgb(${string})`;
|
|
137
|
+
type RGBAColor = `rgba(${string})`;
|
|
138
|
+
type HSLColor = `hsl(${string})`;
|
|
139
|
+
type HSLAColor = `hsla(${string})`;
|
|
140
|
+
type CSSLinearGradient = `linear-gradient(${string})`;
|
|
141
|
+
type CSSRadialGradient = `radial-gradient(${string})`;
|
|
142
|
+
type CSSColor = HexColor | RGBColor | RGBAColor | HSLColor | HSLAColor | string;
|
|
143
|
+
type ColorContrast = 'dark' | 'light';
|
|
144
|
+
export interface ImageObj {
|
|
145
|
+
id: number;
|
|
146
|
+
ext: string;
|
|
147
|
+
name?: string;
|
|
148
|
+
average?: string;
|
|
149
|
+
preview?: string;
|
|
150
|
+
width?: number;
|
|
151
|
+
height?: number;
|
|
152
|
+
proportion?: number;
|
|
153
|
+
border?: 'none' | 'transparent' | 'mixed' | string;
|
|
154
|
+
animated?: boolean;
|
|
155
|
+
transparent?: number;
|
|
156
|
+
}
|
|
157
|
+
export interface PageBackgroundStyles {
|
|
158
|
+
backgroundColor: CSSColor | CSSLinearGradient | CSSRadialGradient;
|
|
159
|
+
backgroundFixed: boolean;
|
|
160
|
+
backgroundRepeat: 'repeat' | 'repeat-x' | 'repeat-y' | 'no-repeat';
|
|
161
|
+
backgroundPosition: string;
|
|
162
|
+
backgroundSize: 'cover' | 'contain' | 'auto';
|
|
163
|
+
contrast: ColorContrast;
|
|
164
|
+
}
|
|
135
165
|
export interface PageBackground {
|
|
136
|
-
image:
|
|
137
|
-
id: number;
|
|
138
|
-
ext: string;
|
|
139
|
-
average: string;
|
|
140
|
-
preview: string;
|
|
141
|
-
width: number;
|
|
142
|
-
height: number;
|
|
143
|
-
proportion: number;
|
|
144
|
-
border: string;
|
|
145
|
-
animated: boolean;
|
|
146
|
-
transparent: number;
|
|
147
|
-
} | null;
|
|
166
|
+
image: ImageObj | null;
|
|
148
167
|
styles: {
|
|
149
168
|
backgroundRepeat: string;
|
|
150
169
|
backgroundPosition: string;
|
|
@@ -169,57 +188,50 @@ export interface PageGrid {
|
|
|
169
188
|
gap: string;
|
|
170
189
|
};
|
|
171
190
|
}
|
|
172
|
-
export interface
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
colors: {
|
|
217
|
-
light: string;
|
|
218
|
-
dark: string;
|
|
219
|
-
};
|
|
220
|
-
};
|
|
221
|
-
subsets: string[];
|
|
222
|
-
}>;
|
|
191
|
+
export interface TextStyleItem {
|
|
192
|
+
uid: string;
|
|
193
|
+
id: string;
|
|
194
|
+
title: string;
|
|
195
|
+
protected?: boolean;
|
|
196
|
+
source?: 'project' | 'page';
|
|
197
|
+
style: TextStyleProperties;
|
|
198
|
+
mobile?: Pick<TextStyleProperties, 'size' | 'weight' | 'line_height' | 'letter_spacing'>;
|
|
199
|
+
}
|
|
200
|
+
export interface TextStyleProperties {
|
|
201
|
+
fontId?: string;
|
|
202
|
+
family?: string;
|
|
203
|
+
size: 'inherit' | number | string;
|
|
204
|
+
weight: 'inherit' | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900;
|
|
205
|
+
line_height: 'inherit' | number;
|
|
206
|
+
letter_spacing: 'inherit' | number | string;
|
|
207
|
+
registry?: 'inherit' | 'none' | 'capitalize' | 'uppercase' | 'lowercase';
|
|
208
|
+
decoration_italic?: 'inherit' | 'italic' | 'normal' | false;
|
|
209
|
+
color?: 'auto' | CSSColor;
|
|
210
|
+
contrast?: 'light' | 'dark';
|
|
211
|
+
}
|
|
212
|
+
export interface FontFamilyItem {
|
|
213
|
+
id?: string;
|
|
214
|
+
name: string;
|
|
215
|
+
source: 'user' | 'google' | 'system';
|
|
216
|
+
subsets?: string[];
|
|
217
|
+
variants: FontVariant[];
|
|
218
|
+
}
|
|
219
|
+
export type UploadedFont = {
|
|
220
|
+
id: string;
|
|
221
|
+
name: string;
|
|
222
|
+
variants?: FontVariant[];
|
|
223
|
+
};
|
|
224
|
+
export interface FontVariant {
|
|
225
|
+
fileName?: string;
|
|
226
|
+
fileExt?: string;
|
|
227
|
+
format?: string;
|
|
228
|
+
weight: number;
|
|
229
|
+
style: 'normal' | 'italic';
|
|
230
|
+
}
|
|
231
|
+
export interface StylesDataRaw {
|
|
232
|
+
uploadedFonts?: UploadedFont[];
|
|
233
|
+
siteTextStyles: TextStyleItem[];
|
|
234
|
+
pageTextStyles?: TextStyleItem[];
|
|
223
235
|
}
|
|
224
236
|
export interface PageBlock {
|
|
225
237
|
update_time: number;
|
|
@@ -266,38 +278,21 @@ export interface PageModal {
|
|
|
266
278
|
template_id: string;
|
|
267
279
|
mod_id: string;
|
|
268
280
|
p_id: number;
|
|
269
|
-
screenshot:
|
|
270
|
-
id: number;
|
|
271
|
-
ext: string;
|
|
272
|
-
average: string;
|
|
273
|
-
preview: string;
|
|
274
|
-
width: number;
|
|
275
|
-
height: number;
|
|
276
|
-
proportion: number;
|
|
277
|
-
animated: boolean;
|
|
278
|
-
transparent: number;
|
|
279
|
-
};
|
|
281
|
+
screenshot: ImageObj | null;
|
|
280
282
|
}
|
|
281
|
-
export interface
|
|
283
|
+
export interface PageContent {
|
|
282
284
|
blocks: PageBlock[];
|
|
283
285
|
modals: PageModal[];
|
|
284
286
|
elements: PageElement[];
|
|
285
287
|
widgets: PageWidget[];
|
|
286
288
|
codes: string[];
|
|
287
289
|
background: PageBackground;
|
|
288
|
-
|
|
290
|
+
textStyles: TextStyleItem[];
|
|
289
291
|
abtests: PageABTest[];
|
|
290
292
|
responsive: string | boolean;
|
|
293
|
+
assets: {
|
|
294
|
+
images: number[];
|
|
295
|
+
files: string[];
|
|
296
|
+
};
|
|
291
297
|
}
|
|
292
|
-
export
|
|
293
|
-
id: number;
|
|
294
|
-
blocks?: PageBlock[];
|
|
295
|
-
modals?: PageModal[];
|
|
296
|
-
elements?: PageElement[];
|
|
297
|
-
widgets?: PageWidget[];
|
|
298
|
-
codes?: string[];
|
|
299
|
-
background?: PageBackground;
|
|
300
|
-
fonts?: PageFont;
|
|
301
|
-
abtests?: PageABTest[];
|
|
302
|
-
responsive?: string | boolean;
|
|
303
|
-
}
|
|
298
|
+
export {};
|