@variantic/player 0.0.11 → 0.0.13
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/libs/schemas/file-types/export-configuration/src/index.d.ts +1 -0
- package/libs/schemas/file-types/export-configuration/src/lib/export-configuration.d.ts +10 -0
- package/libs/schemas/library-api/src/lib/library-api.d.ts +5 -0
- package/libs/schemas/web-component/api/player/viewer/src/lib/viewer.d.ts +24 -1
- package/package.json +1 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './lib/export-configuration';
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { type Static } from '@sinclair/typebox';
|
|
2
|
+
export declare const exportConfigurationSchema: import("@sinclair/typebox").TObject<{
|
|
3
|
+
exports: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
|
|
4
|
+
name: import("@sinclair/typebox").TString;
|
|
5
|
+
bomTemplateId: import("@sinclair/typebox").TNumber;
|
|
6
|
+
bomFilterId: import("@sinclair/typebox").TNumber;
|
|
7
|
+
}>>;
|
|
8
|
+
v: import("@sinclair/typebox").TLiteral<1>;
|
|
9
|
+
}>;
|
|
10
|
+
export type TExportConfigurationFile = Static<typeof exportConfigurationSchema>;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { TExportConfigurationFile } from "../../../file-types/export-configuration/src";
|
|
1
2
|
export interface ILibraryApi {
|
|
2
3
|
/**
|
|
3
4
|
* Returns the URL for the asset with the given ID for current library version.
|
|
@@ -19,4 +20,8 @@ export interface ILibraryApi {
|
|
|
19
20
|
* Retrieves the configuration data for current library version.
|
|
20
21
|
*/
|
|
21
22
|
getConfigurationData(): Promise<unknown>;
|
|
23
|
+
/**
|
|
24
|
+
* Retrieves the export configuration data for current library version.
|
|
25
|
+
*/
|
|
26
|
+
getExportConfiguration(): Promise<TExportConfigurationFile>;
|
|
22
27
|
}
|
|
@@ -52,7 +52,7 @@ export type TViewerApi = {
|
|
|
52
52
|
/**
|
|
53
53
|
* Returns a list of materials matching the given filter ID, optionally grouped by the specified query ID.
|
|
54
54
|
*/
|
|
55
|
-
getMaterialsList(filterId
|
|
55
|
+
getMaterialsList({ filterId, groupingQueryId, page, perPage, }: TGetMaterialsListParams): Promise<TMaterialsList>;
|
|
56
56
|
/**
|
|
57
57
|
* Returns the current layout settings configuration.
|
|
58
58
|
*/
|
|
@@ -180,6 +180,12 @@ export type TViewerApiEvents = TWebComponentEvents<{
|
|
|
180
180
|
state: boolean;
|
|
181
181
|
};
|
|
182
182
|
}>;
|
|
183
|
+
export type TGetMaterialsListParams = {
|
|
184
|
+
filterId: number;
|
|
185
|
+
groupingQueryId?: number;
|
|
186
|
+
page?: number;
|
|
187
|
+
perPage?: number;
|
|
188
|
+
};
|
|
183
189
|
export type TGetConfigurationParams = {
|
|
184
190
|
/**
|
|
185
191
|
* Specifies whether to include hidden items
|
|
@@ -238,6 +244,7 @@ export type TLayoutSettings = {
|
|
|
238
244
|
primaryColor: string;
|
|
239
245
|
secondaryColor: string;
|
|
240
246
|
};
|
|
247
|
+
defaultConfigurationMode: 'configuration' | 'materials';
|
|
241
248
|
};
|
|
242
249
|
export type TFilterGroupingQuery = {
|
|
243
250
|
name: string;
|
|
@@ -356,22 +363,38 @@ type TListStyleSettings = {
|
|
|
356
363
|
export type TParameterListOptions = TParameterBase<'list-options', {
|
|
357
364
|
defaultValue: string;
|
|
358
365
|
options: Record<string, string>;
|
|
366
|
+
optionsOrdered: {
|
|
367
|
+
key: string;
|
|
368
|
+
value: string;
|
|
369
|
+
}[];
|
|
359
370
|
styleSettings?: TListStyleSettings;
|
|
360
371
|
}>;
|
|
361
372
|
export type TParameterListButtons = TParameterBase<'list-buttons', {
|
|
362
373
|
defaultValue: string;
|
|
363
374
|
options: Record<string, string>;
|
|
375
|
+
optionsOrdered: {
|
|
376
|
+
key: string;
|
|
377
|
+
value: string;
|
|
378
|
+
}[];
|
|
364
379
|
styleSettings?: TListStyleSettings;
|
|
365
380
|
}>;
|
|
366
381
|
export type TParameterListImageOptions = TParameterBase<'list-image-options', {
|
|
367
382
|
defaultValue: string;
|
|
368
383
|
options: Record<string, string>;
|
|
384
|
+
optionsOrdered: {
|
|
385
|
+
key: string;
|
|
386
|
+
value: string;
|
|
387
|
+
}[];
|
|
369
388
|
optionsImages: Record<string, string>;
|
|
370
389
|
styleSettings?: TListStyleSettings;
|
|
371
390
|
}>;
|
|
372
391
|
export type TParameterListImageButtons = TParameterBase<'list-image-buttons', {
|
|
373
392
|
defaultValue: string;
|
|
374
393
|
options: Record<string, string>;
|
|
394
|
+
optionsOrdered: {
|
|
395
|
+
key: string;
|
|
396
|
+
value: string;
|
|
397
|
+
}[];
|
|
375
398
|
optionsImages: Record<string, string>;
|
|
376
399
|
styleSettings?: TListStyleSettings;
|
|
377
400
|
}>;
|