@variantic/player 0.0.8 → 0.0.10

package/libs/schemas/library-api/src/lib/library-api.d.ts

@@ -1,7 +1,22 @@
 export interface ILibraryApi {
+    /**
+     * Returns the URL for the asset with the given ID for current library version.
+     */
     getAssetUrl(id: string): string;
+    /**
+     * Returns the thumbnail URL for the asset with the given ID for current library version.
+     */
     getAssetThumbnailUrl(id: string): string;
+    /**
+     * Retrieves the asset content by ID for current library version, or null if not found.
+     */
     getAssetById(id: string): Promise<Response | null>;
+    /**
+     * Retrieves the assembly data for current library version.
+     */
     getAssemblyData(): Promise<unknown>;
+    /**
+     * Retrieves the configuration data for current library version.
+     */
     getConfigurationData(): Promise<unknown>;
 }

package/libs/schemas/web-component/api/player/ar/src/lib/ar.d.ts

@@ -5,10 +5,16 @@ import type { TWebComponentEvents } from "../../../events/src";
  */
 export type TARApi = {
     events: Emittery<TARApiEvents>;
+    /**
+     * Generates and uploads the current project for AR viewing, returning a QR image and URL.
+     */
     generateAndUpload(): Promise<{
         qrImage: string;
         url: string;
     }>;
+    /**
+     * Generates and returns the project data as a Blob for AR viewing.
+     */
     generate(): Promise<Blob>;
 };
 export type TARApiEvents = TWebComponentEvents<{

package/libs/schemas/web-component/api/player/configuration/src/lib/configuration.d.ts

@@ -5,7 +5,13 @@ import type { TWebComponentEvents } from "../../../events/src";
  */
 export type TConfigurationApi = {
     events: Emittery<TConfigurationApiEvents>;
+    /**
+     * Generates and returns the current configuration content
+     */
     generate(): TConfigurationContent;
+    /**
+     * Generates and uploads the current configuration, returning a URL for later use.
+     */
     generateAndUpload(): Promise<TConfigurationUrl>;
 };
 export type TConfigurationApiEvents = TWebComponentEvents<{

package/libs/schemas/web-component/api/player/documentation/src/lib/documentation.d.ts

@@ -6,8 +6,17 @@ export type TPrimitive = bigint | boolean | null | number | string | symbol | un
  */
 export type TDocumentationApi = {
     events: Emittery<TDocumentationApiEvents>;
+    /**
+     * Checks if documentation generation is available.
+     */
     getDocumentationAvailability(): boolean;
+    /**
+     * Generates the documentation PDF as a Blob using optional source data.
+     */
     generate(sourceData?: Record<string, TPrimitive>): Promise<Blob>;
+    /**
+     * Generates and triggers download of the documentation PDF using optional source data.
+     */
     generateAndDownload(sourceData?: Record<string, TPrimitive>): Promise<void>;
 };
 export type TDocumentationApiEvents = TWebComponentEvents<{

package/libs/schemas/web-component/api/player/integration-connector/src/lib/integration-connector.d.ts

@@ -5,7 +5,13 @@ import type { TWebComponentEvents } from "../../../events/src";
  */
 export type TIntegrationConnectorApi = {
     events: Emittery<TIntegrationConnectorApiEvents>;
+    /**
+     * Executes a flow immediately with the given parameters and returns the response.
+     */
     execute: (params: TExecuteParams) => Promise<TExecutionResponse>;
+    /**
+     * Hooks specified flows by their IDs to the current project.
+     */
     hookFlowsByIds: (ids: string[]) => Promise<void>;
 };
 export type TIntegrationConnectorApiEvents = TWebComponentEvents<{

package/libs/schemas/web-component/api/player/layout/src/lib/layout.d.ts

@@ -5,6 +5,9 @@ import type { TWebComponentEvents } from "../../../events/src";
  */
 export type TLayoutApi = {
     events: Emittery<TLayoutApiEvents>;
+    /**
+     * Enables or disables fullscreen mode based on the given state.
+     */
     toggleFullscreen: (state: boolean) => void;
 };
 export type TLayoutApiEvents = TWebComponentEvents;

package/libs/schemas/web-component/api/player/player/src/lib/player.d.ts

@@ -14,9 +14,21 @@ import type { ILibraryApi } from "../../../../../../library-api/src";
 export type TPlayerApi = {
     events: Emittery<TPlayerApiEvents>;
     viewer: TViewerApi;
+    /**
+     * Returns the current site identifier as a string.
+     */
     getSiteId: () => string;
+    /**
+     * Returns the current library version as a string.
+     */
     getLibraryVersion: () => string;
+    /**
+     * Returns the current configuration ID, or null if none is set.
+     */
     getCurrentConfigurationId: () => string | null;
+    /**
+     * Asynchronously loads a configuration by ID; returns success status and optional error code.
+     */
     loadConfiguration: (id: string | null) => Promise<{
         result: boolean;
         error?: 'INVALID_CONFIGURATION_ID_OR_URL' | 'INVALID_CONFIGURATION' | 'COMPONENT_ID_MISMATCH' | 'LIBRARY_VERSION_MISMATCH';

package/libs/schemas/web-component/api/player/snapshot/src/lib/snapshot.d.ts

@@ -5,8 +5,17 @@ import type { TWebComponentEvents } from "../../../events/src";
  */
 export type TSnapshotApi = {
     events: Emittery<TSnapshotApiEvents>;
+    /**
+     * Generates a snapshot of current view and returns it as a Blob.
+     */
     generate(): Promise<Blob>;
+    /**
+     * Generates and triggers download of a snapshot of current view.
+     */
     generateAndDownload(): Promise<void>;
+    /**
+     * Generates and uploads a snapshot of current view, returning its URL.
+     */
     generateAndUpload(): Promise<TSnapshotUrl>;
 };
 export type TSnapshotApiEvents = TWebComponentEvents<{

package/libs/schemas/web-component/api/player/viewer/src/lib/viewer.d.ts

@@ -7,47 +7,147 @@ export type TViewerApi = {
     events: Emittery<TViewerApiEvents>;
     getPlayerInstance(): any;
     get isLoaded(): boolean;
+    /**
+     * Returns the current configuration formatted for rendering.
+     */
     getConfiguration(options?: TGetConfigurationParams): TConfiguration | null;
+    /**
+     *  Returns the current price value.
+     */
     getPrice(): number;
+    /**
+     * Returns the current price formatted with the appropriate currency symbol.
+     */
     getPriceWithCurrency(): string | undefined;
+    /**
+     * Overrides the current price with the specified value.
+     *
+     * @param value value to replace price with
+     */
     setPrice(value: number | string): void;
+    /** @ignore */
     getScene(): any;
+    /** @ignore */
     getModel3D(): any;
+    /** @ignore */
     getModelContainer3D(): any;
+    /**
+     * Returns the WebGL canvas element.
+     */
     getCanvas(): HTMLCanvasElement;
+    /**
+     * Returns all available material groups.
+     */
     getMaterialGroups(): Promise<TMaterialGroup[]>;
+    /**
+     * Returns a mapping of group IDs to their selected material IDs.
+     */
     getSelectedMaterialByGroup(): {
         [key: number]: number;
     };
+    /**
+     * Returns the material definition for the specified material ID.
+     */
     getMaterialDataById(materialId: number): TMaterial;
+    /**
+     * Returns a list of materials matching the given filter ID, optionally grouped by the specified query ID.
+     */
     getMaterialsList(filterId: number, groupingQueryId?: number): Promise<TMaterialsList>;
+    /**
+     * Returns the current layout settings configuration.
+     */
     getLayoutSettings(): TLayoutSettings;
+    /**
+     * Assigns the specified material ID to the given group ID.
+     */
     assignMaterial(groupId: number, materialId: number): Promise<void>;
+    /**
+     * Changes the camera projection type to either orthographic or perspective.
+     */
     changeCameraType(type: 'orthographic' | 'perspective'): void;
+    /**
+     * Applies the specified camera settings.
+     */
     setCameraSettings(settings: TCameraSettings): void;
+    /**
+     * Moves the camera based on the provided parameters.
+     */
     moveCamera(params: TMoveCameraParams): Promise<void>;
+    /**
+     * Adjusts the camera to fit the current object within view.
+     */
     autoFitCamera(): Promise<void>;
+    /**
+     * Generates a bill of materials for the specified template ID and filter ID.
+     */
     generateBom({ templateId, filterId, }: {
         templateId: number;
         filterId: number;
     }): Promise<TBom>;
+    /**
+     * Returns the current floor settings.
+     */
     getSetFloorSettings(): TFloorSettings;
+    /**
+     * Returns the target unit for value transformation.
+     */
     getTargetUnit(): string;
+    /**
+     * Returns the list of available units.
+     */
     getUnits(): TUnit[];
+    /** @ignore */
     getDimensions(filter?: 'default' | 'defaultNotControlledByEvent'): any[];
+    /**
+     * Changes the current unit to the specified unit.
+     */
     changeUnit(unit: string): void;
+    /**
+     * Converts a value from millimeters to the current set target unit.
+     */
     convertFromMillimeters(value: number | string, baseUnit: string): number | string;
+    /**
+     * Converts a value from the current set target unit to millimeters.
+     */
+    convertToMillimeters(value: number | string, baseUnit: string): number | string;
+    /**
+     * Returns the localized string for the given key
+     */
     translate(key: string): string;
+    /**
+     * Switches the interface view to either preview or edit mode.
+     */
     changeView(view: 'preview' | 'edit'): void;
+    /**
+     * Updates the parameter identified by the code with the specified value.
+     */
     changeParameter(code: string, value: string | number): void;
+    /**
+     * Normalizes the given value for a parameter, returning the value and its corresponding label.
+     */
     normalizeParameterValue(parameter: TParameter, value: string | number): {
         value: string | number;
         label: string;
     };
+    /**
+     * Enables all layers in the current context.
+     */
     enableAllLayers(): void;
+    /**
+     * Disables all layers in the current context.
+     */
     disableAllLayers(): void;
+    /**
+     * Enables the layer with the specified ID.
+     */
     enableLayer(id: number): void;
+    /**
+     * Disables the layer with the specified ID.
+     */
     disableLayer(id: number): void;
+    /**
+     * Toggles dimension visibility based on the state and optional dimension IDs or presets.
+     */
     toggleDimensions(state: boolean, dimensions?: number[] | 'default' | 'defaultNotControlledByEvent'): void;
 };
 export type TViewerApiEvents = TWebComponentEvents<{
@@ -81,10 +181,22 @@ export type TViewerApiEvents = TWebComponentEvents<{
     };
 }>;
 export type TGetConfigurationParams = {
+    /**
+     * Specifies whether to include hidden items
+     * @defaultValue `true`
+     */
     includeHidden?: boolean;
 };
 export type TMoveCameraParams = {
+    /**
+     * Target camera angle
+     * @defaultValue `default`
+     */
     angle?: TCameraAngle;
+    /**
+     * Whether to move with animation
+     * @defaultValue `true`
+     */
     animation?: boolean;
 };
 export type TCameraAngle = 'default' | '-x+z' | '+x+z' | '-x-z' | '+x-z' | '+z' | '-z' | '+y' | '-y' | '+x' | '-x';
@@ -225,6 +337,7 @@ export type TParameterNumberRange = TParameterBase<'number-range', {
     max: number;
     maxLabel: string;
     preferred?: number[];
+    step: number;
 }>;
 type TNumberPredefinedStyleSettings = {
     align?: 'content' | 'responsive';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@variantic/player",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "license": "MIT",
   "publishConfig": {
     "access": "public"