@variantic/player 0.0.1

package/README.md

@@ -0,0 +1,30 @@
+# Player Type Definitions
+
+This package provides **TypeScript type definitions** for the **Variantic Player**.  
+⚠️ **Currently, this package ONLY includes type definitions.**  
+Future versions will introduce functionalities for controlling the embedded player.
+
+## 📦 Installation
+
+You can install this package via npm:
+
+```sh
+npm install @variantic/player
+```
+
+## 🚀 Usage
+
+Import the necessary types into your TypeScript project:
+
+```ts
+import { TSnapshotUrl } from '@variantic/player';
+
+const snapshotUrl: TSnapshotUrl = {
+	url: 'testUrl',
+	snapshotBlob: new Blob(),
+};
+```
+
+## 📜 License
+
+This package is licensed under the MIT License. See [LICENSE](./LICENSE) for details.

package/libs/packages/player/src/index.d.ts

@@ -0,0 +1,8 @@
+export * from "../../../schemas/web-component/api/player/viewer/src";
+export * from "../../../schemas/web-component/api/player/ar/src";
+export * from "../../../schemas/web-component/api/player/configuration/src";
+export * from "../../../schemas/web-component/api/player/documentation/src";
+export * from "../../../schemas/web-component/api/player/integration-connector/src";
+export * from "../../../schemas/web-component/api/player/layout/src";
+export * from "../../../schemas/web-component/api/player/snapshot/src";
+export * from "../../../schemas/web-component/api/player/player/src";

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

@@ -0,0 +1 @@
+export * from './lib/library-api';

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

@@ -0,0 +1,7 @@
+export interface ILibraryApi {
+    getAssetUrl(id: string): string;
+    getAssetThumbnailUrl(id: string): string;
+    getAssetById(id: string): Promise<Response | null>;
+    getAssemblyData(): Promise<unknown>;
+    getConfigurationData(): Promise<unknown>;
+}

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

@@ -0,0 +1 @@
+export * from './lib/ar';

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

@@ -0,0 +1,16 @@
+import type Emittery from 'emittery';
+import type { TWebComponentEvents } from "../../../events/src";
+/**
+ * @category Addons API
+ */
+export type TARApi = {
+    events: Emittery<TARApiEvents>;
+    generateAndUpload(): Promise<{
+        qrImage: string;
+        url: string;
+    }>;
+    generate(): Promise<Blob>;
+};
+export type TARApiEvents = TWebComponentEvents<{
+    generated: Blob;
+}>;

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

@@ -0,0 +1 @@
+export * from './lib/configuration';

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

@@ -0,0 +1,20 @@
+import type Emittery from 'emittery';
+import type { TWebComponentEvents } from "../../../events/src";
+/**
+ * @category Addons API
+ */
+export type TConfigurationApi = {
+    events: Emittery<TConfigurationApiEvents>;
+    generate(): TConfigurationContent;
+    generateAndUpload(): Promise<TConfigurationUrl>;
+};
+export type TConfigurationApiEvents = TWebComponentEvents<{
+    generated: TConfigurationContent;
+    uploaded: TConfigurationUrl;
+}>;
+export type TConfigurationUrl = {
+    id: string;
+    url: string;
+    configuration: TConfigurationContent;
+};
+export type TConfigurationContent = Record<string, unknown>;

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

@@ -0,0 +1 @@
+export * from './lib/documentation';

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

@@ -0,0 +1,17 @@
+import type Emittery from 'emittery';
+import type { TWebComponentEvents } from "../../../events/src";
+export type TPrimitive = bigint | boolean | null | number | string | symbol | undefined;
+/**
+ * @category Addons API
+ */
+export type TDocumentationApi = {
+    events: Emittery<TDocumentationApiEvents>;
+    getDocumentationAvailability(): boolean;
+    generate(sourceData?: Record<string, TPrimitive>): Promise<Blob>;
+    generateAndDownload(sourceData?: Record<string, TPrimitive>): Promise<void>;
+};
+export type TDocumentationApiEvents = TWebComponentEvents<{
+    availabilityChanged: boolean;
+    generated: Blob;
+    downloaded: Blob;
+}>;

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

@@ -0,0 +1 @@
+export * from './lib/events';

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

@@ -0,0 +1,19 @@
+export type TCommonWebComponentEvents = {
+    ready: TTimestampEventPayload;
+    scriptsLoaded: TTimestampEventPayload;
+};
+export type TWebComponentEvents<T extends Record<string, unknown> = TCommonWebComponentEvents> = TCommonWebComponentEvents & T;
+export type TTimestampEventPayload = {
+    timestamp: number;
+};
+export type TMouseClickedPayload = {
+    position: T2DPosition;
+    mouseButton: number;
+};
+export type TMouseMovedPayload = {
+    position: T2DPosition;
+};
+export type T2DPosition = {
+    x: number;
+    y: number;
+};

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

@@ -0,0 +1 @@
+export * from './lib/integration-connector';

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

@@ -0,0 +1,24 @@
+import type Emittery from 'emittery';
+import type { TWebComponentEvents } from "../../../events/src";
+/**
+ * @category Addons API
+ */
+export type TIntegrationConnectorApi = {
+    events: Emittery<TIntegrationConnectorApiEvents>;
+    execute: (params: TExecuteParams) => Promise<TExecutionResponse>;
+    hookFlowsByIds: (ids: string[]) => Promise<void>;
+};
+export type TIntegrationConnectorApiEvents = TWebComponentEvents<{
+    executed: TExecutionResponse & {
+        id: string;
+        name: string;
+    };
+}>;
+export type TExecuteParams = {
+    id: string;
+    inputData?: unknown;
+};
+export type TExecutionResponse = {
+    isSuccess: boolean;
+    data: unknown;
+};

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

@@ -0,0 +1 @@
+export * from './lib/layout';

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

@@ -0,0 +1,10 @@
+import type Emittery from 'emittery';
+import type { TWebComponentEvents } from "../../../events/src";
+/**
+ * @category Addons API
+ */
+export type TLayoutApi = {
+    events: Emittery<TLayoutApiEvents>;
+    toggleFullscreen: (state: boolean) => void;
+};
+export type TLayoutApiEvents = TWebComponentEvents;

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

@@ -0,0 +1 @@
+export * from './lib/player';

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

@@ -0,0 +1,28 @@
+import type Emittery from 'emittery';
+import type { TViewerApi } from "../../../viewer/src";
+import type { TARApi } from "../../../ar/src";
+import type { TConfigurationApi } from "../../../configuration/src";
+import type { TDocumentationApi } from "../../../documentation/src";
+import type { TIntegrationConnectorApi } from "../../../integration-connector/src";
+import type { TLayoutApi } from "../../../layout/src";
+import type { TSnapshotApi } from "../../../snapshot/src";
+import type { TWebComponentEvents } from "../../../events/src";
+import type { ILibraryApi } from "../../../../../../library-api/src";
+/**
+ * @category Addons API
+ */
+export type TPlayerApi = {
+    events: Emittery<TPlayerApiEvents>;
+    viewer: TViewerApi;
+    getSiteId: () => string;
+    getLibraryVersion: () => string;
+    libraryApi: ILibraryApi;
+} & Partial<{
+    ar: TARApi;
+    configuration: TConfigurationApi;
+    documentation: TDocumentationApi;
+    ic: TIntegrationConnectorApi;
+    layout: TLayoutApi;
+    snapshot: TSnapshotApi;
+}>;
+export type TPlayerApiEvents = TWebComponentEvents;

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

@@ -0,0 +1 @@
+export * from './lib/snapshot';

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

@@ -0,0 +1,20 @@
+import type Emittery from 'emittery';
+import type { TWebComponentEvents } from "../../../events/src";
+/**
+ * @category Addons API
+ */
+export type TSnapshotApi = {
+    events: Emittery<TSnapshotApiEvents>;
+    generate(): Promise<Blob>;
+    generateAndDownload(): Promise<void>;
+    generateAndUpload(): Promise<TSnapshotUrl>;
+};
+export type TSnapshotApiEvents = TWebComponentEvents<{
+    generated: Blob;
+    downloaded: Blob;
+    uploaded: TSnapshotUrl;
+}>;
+export type TSnapshotUrl = {
+    url: string;
+    snapshotBlob: Blob;
+};

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

@@ -0,0 +1 @@
+export * from './lib/viewer';

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

@@ -0,0 +1,284 @@
+import type Emittery from 'emittery';
+import type { TTimestampEventPayload, TWebComponentEvents, TMouseClickedPayload, TMouseMovedPayload } from "../../../events/src";
+/**
+ * @category Addons API
+ */
+export type TViewerApi = {
+    events: Emittery<TViewerApiEvents>;
+    getPlayerInstance(): any;
+    get isLoaded(): boolean;
+    getConfiguration(options?: TGetConfigurationParams): TConfiguration | null;
+    getPrice(): number;
+    getPriceWithCurrency(): string | undefined;
+    setPrice(value: number | string): void;
+    getScene(): any;
+    getModel3D(): any;
+    getModelContainer3D(): any;
+    getCanvas(): HTMLCanvasElement;
+    getMaterialGroups(): Promise<TMaterialGroup[]>;
+    getSelectedMaterialByGroup(): {
+        [key: number]: number;
+    };
+    getMaterialDataById(materialId: number): TMaterial;
+    getMaterialsList(filterId: number, groupingQueryId?: number): Promise<TMaterialsList>;
+    getLayoutSettings(): TLayoutSettings;
+    assignMaterial(groupId: number, materialId: number): Promise<void>;
+    changeCameraType(type: 'orthographic' | 'perspective'): void;
+    setCameraSettings(settings: TCameraSettings): void;
+    moveCamera(params: TMoveCameraParams): Promise<void>;
+    autoFitCamera(): Promise<void>;
+    generateBom({ templateId, filterId, }: {
+        templateId: number;
+        filterId: number;
+    }): Promise<TBom>;
+    getSetFloorSettings(): TFloorSettings;
+    getTargetUnit(): string;
+    getUnits(): TUnit[];
+    getDimensions(filter?: 'default' | 'defaultNotControlledByEvent'): any[];
+    changeUnit(unit: string): void;
+    convertFromMillimeters(value: number | string, baseUnit: string): number | string;
+    translate(key: string): string;
+    changeView(view: 'preview' | 'edit'): void;
+    changeParameter(code: string, value: string | number): void;
+    normalizeParameterValue(parameter: TParameter, value: string | number): {
+        value: string | number;
+        label: string;
+    };
+    enableAllLayers(): void;
+    disableAllLayers(): void;
+    enableLayer(id: number): void;
+    disableLayer(id: number): void;
+    toggleDimensions(state: boolean, dimensions?: number[] | 'default' | 'defaultNotControlledByEvent'): void;
+};
+export type TViewerApiEvents = TWebComponentEvents<{
+    loaded: TTimestampEventPayload;
+    reloaded: TTimestampEventPayload;
+    reloadedAfterLoad: TTimestampEventPayload;
+    configurationUpdating: TTimestampEventPayload;
+    sceneReloaded: TTimestampEventPayload;
+    configurationUpdated: TConfiguration;
+    priceChanged: {
+        price: number;
+        priceWithCurrency: string;
+    };
+    bomGenerated: {
+        templateId: number;
+        filterId: number;
+        bom: TBom;
+    };
+    materialAssigned: {
+        groupId: number;
+        materialId: number;
+    };
+    materialAssignedAfterLoad: {
+        groupId: number;
+        materialId: number;
+    };
+    mouseClicked: TMouseClickedPayload;
+    mouseMoved: TMouseMovedPayload;
+    dimensionToggled: {
+        state: boolean;
+    };
+}>;
+export type TGetConfigurationParams = {
+    includeHidden?: boolean;
+};
+export type TMoveCameraParams = {
+    angle?: TCameraAngle;
+    animation?: boolean;
+};
+export type TCameraAngle = 'default' | '-x+z' | '+x+z' | '-x-z' | '+x-z' | '+z' | '-z' | '+y' | '-y' | '+x' | '-x';
+export type TMaterial = {
+    id: number;
+    name: string;
+    code: string;
+    price: number;
+    group: string;
+    type: string;
+    mass: number;
+    mass_unit: string;
+    dim_x: number;
+    dim_y: number;
+    dim_z: number;
+    dim_unit: string;
+    data_1: string;
+    data_2: string;
+    data_3: string;
+    data_4: string;
+    url: string;
+    photo: string;
+    enabled: boolean;
+    grain: boolean;
+};
+export type TMeta = {
+    totalItems: number;
+    itemCount: number;
+    itemsPerPage: number;
+    totalPages: number;
+    currentPage: number;
+};
+export type TMaterialsList = {
+    items: TMaterial[];
+    meta: TMeta;
+};
+export type TLayoutSettings = {
+    colors: {
+        primaryColor: string;
+        secondaryColor: string;
+    };
+};
+export type TFilterGroupingQuery = {
+    name: string;
+    default: boolean;
+};
+export type TFilter = {
+    name: string;
+    id: number;
+    groupingQueries: TFilterGroupingQuery[];
+};
+export type TMaterialGroup = {
+    id: number;
+    name: string;
+    filterData: TFilter;
+    filters: TFilter[];
+    showType: string;
+};
+export type TBom = {
+    name: string;
+    head: string[];
+    body: string[][];
+};
+export type TCameraSettings = {
+    autoCameraFit?: boolean;
+    fitAngle?: TCameraAngle;
+    cameraFitToSelected?: boolean;
+    cameraSnapToAngle?: boolean;
+    cameraType?: 'orthographic' | 'perspective';
+    enablePan?: boolean;
+    enableRotate?: boolean;
+    blockRotationAxes?: {
+        x?: boolean;
+        y?: boolean;
+        z?: boolean;
+    };
+    blockMoveUnderFloor?: boolean;
+    zoomBoundaries?: {
+        max?: number;
+        min?: number;
+    };
+    rotateBoundaries?: {
+        x?: {
+            min?: number;
+            max?: number;
+        };
+        y?: {
+            min?: number;
+            max?: number;
+        };
+    };
+    enableCameraOptimization?: boolean;
+    enableAutoRotate?: boolean;
+    autoRotateActivationTime?: number;
+    autoRotateSpeed?: number;
+    infinityRotationAxes?: {
+        x?: boolean;
+        y?: boolean;
+    };
+    isCameraSet?: boolean;
+    defaultFar?: boolean;
+};
+export type TFloorSettings = {
+    activeFloor: boolean;
+    activeFloorShadow: boolean;
+    useFloorInAR: boolean;
+    floorSize: {
+        x: number;
+        y: number;
+    };
+    floorSizeType: 'infinity' | 'likeObject' | 'custom';
+    selectedMaterialGroup: number | null;
+    selectedDefaultMaterial: number | null;
+};
+export type TUnit = {
+    unit: string;
+    label: string;
+};
+export type TParameterTypes = 'number-range' | 'number-predefined' | 'number-constant' | 'text-constant' | 'list-options' | 'list-buttons' | 'list-image-options' | 'list-image-buttons' | 'list-images' | 'button';
+export type TParameterEvents = {
+    [K in keyof GlobalEventHandlersEventMap]?: (event: GlobalEventHandlersEventMap[K]) => void;
+};
+export type TParameterBase<TType extends TParameterTypes = TParameterTypes, TSettings = undefined> = {
+    code: string;
+    name: string;
+    type: TType;
+    unit: string;
+    unitLabel: string;
+    value: string;
+    valueLabel: string;
+    settings: TSettings;
+    events?: TParameterEvents;
+    isHidden?: boolean;
+};
+export type TParameterNumberRange = TParameterBase<'number-range', {
+    min: number;
+    minLabel: string;
+    max: number;
+    maxLabel: string;
+    preferred?: number[];
+}>;
+type TNumberPredefinedStyleSettings = {
+    align?: 'content' | 'responsive';
+};
+export type TParameterNumberPredefined = TParameterBase<'number-predefined', {
+    options: string[];
+    optionLabels: string[];
+    styleSettings?: TNumberPredefinedStyleSettings;
+}>;
+export type TParameterNumberConstant = TParameterBase<'number-constant'>;
+type TListStyleSettings = {
+    size?: 'sm' | 'md' | 'lg';
+    shape?: 'square' | 'portrait' | 'landscape';
+    align?: 'content' | 'responsive';
+};
+export type TParameterListOptions = TParameterBase<'list-options', {
+    defaultValue: string;
+    options: Record<string, string>;
+    styleSettings?: TListStyleSettings;
+}>;
+export type TParameterListButtons = TParameterBase<'list-buttons', {
+    defaultValue: string;
+    options: Record<string, string>;
+    styleSettings?: TListStyleSettings;
+}>;
+export type TParameterListImageOptions = TParameterBase<'list-image-options', {
+    defaultValue: string;
+    options: Record<string, string>;
+    optionsImages: Record<string, string>;
+    styleSettings?: TListStyleSettings;
+}>;
+export type TParameterListImageButtons = TParameterBase<'list-image-buttons', {
+    defaultValue: string;
+    options: Record<string, string>;
+    optionsImages: Record<string, string>;
+    styleSettings?: TListStyleSettings;
+}>;
+export type TParameterListImages = TParameterBase<'list-images', {
+    defaultValue: string | null;
+    options: Record<string, {
+        image: string | null;
+        label: string;
+    }>;
+}>;
+export type TParameterText = TParameterBase<'text-constant'>;
+export type TParameterButton = TParameterBase<'button'>;
+export type TParameter = TParameterNumberRange | TParameterNumberPredefined | TParameterNumberConstant | TParameterListOptions | TParameterListButtons | TParameterListImageOptions | TParameterListImageButtons | TParameterListImages | TParameterText | TParameterButton;
+export type TCategory = {
+    id: number;
+    name: string;
+    parameters: TParameter[];
+    isHidden?: boolean;
+};
+export type TConfiguration = {
+    categories: TCategory[];
+};
+export {};

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@variantic/player",
+  "version": "0.0.1",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "devDependencies": {
+    "emittery": "^1.0.2"
+  },
+  "type": "commonjs",
+  "typings": "./libs/packages/player/src/index.d.ts",
+  "types": "./libs/packages/player/src/index.d.ts",
+  "main": "./libs/packages/player/src/index.js"
+}