@3cr/viewer-browser 0.0.162 → 0.0.194

package/test/helper.ts

@@ -1,6 +1,8 @@
-import { mount, shallowMount } from "@vue/test-utils";
+import { mount, shallowMount, VueWrapper } from "@vue/test-utils";
 import { createVuetify } from "vuetify";
 import { expect } from "vitest";
+import { VDialog } from "vuetify/components";
+import { nextTick } from "vue";
 
 export function mountVuetify<T>(
   component: T,
@@ -33,3 +35,10 @@ export function checkComponentProps(
 ) {
   expect(component.props()[propKey] as any).toBe(equal);
 }
+
+export async function openAllModals<T>(wrapper: VueWrapper<T>) {
+  for (const modal of wrapper.findAllComponents(VDialog)) {
+    await modal.setValue(true);
+  }
+  await nextTick();
+}

package/test/setup.ts

@@ -1 +1,14 @@
+import {vi} from "vitest";
+
 global.ResizeObserver = require("resize-observer-polyfill");
+
+vi.mock("@3cr/sdk-browser", async (importOriginal) => {
+  const mod = (await importOriginal()) as object;
+  return {
+    ...mod,
+    registerVersion: vi.fn(),
+    createInstance: vi.fn(),
+    executePayload: vi.fn(),
+    registerOnPayloadHandler: vi.fn(),
+  };
+});

package/tsconfig.json

@@ -12,6 +12,7 @@
     "module": "ESNext",
     "moduleResolution": "node",
     "paths": {
+      "@3cr/types-ts": ["static/3cr-types-browser"],
       "@/*": ["src/*"],
       "~/*": ["test/*"]
     },

package/vite.config.mts

@@ -67,6 +67,7 @@ if (globalThis.Viewer3CR) {
   },
   resolve: {
     alias: {
+      '@3cr/types-ts': fileURLToPath(new URL('./static/3cr-types-browser', import.meta.url)),
       '@': fileURLToPath(new URL('./src', import.meta.url)),
       '~': fileURLToPath(new URL('./test', import.meta.url)),
     },

package/src/dataLayer/__tests__/payload-handler.spec.ts

@@ -1,214 +0,0 @@
-import { beforeEach, describe, expect, it, vi } from "vitest";
-import { emptyPayload, PayloadHandler } from "@/dataLayer/payloadHandler";
-import { Ref, unref, UnwrapRef } from "vue";
-import WebGL3DR from "@/components/WebGL3DR.vue";
-import { spyOn } from "@vitest/spy";
-import {
-  ColourPresetData,
-  FrontEndInterfaces,
-  LayoutActions,
-  PresetsActions,
-  ScanMovementActions,
-  ScanOrientationActions,
-  ScanView,
-  SlidersActions,
-} from "@3cr/types-ts";
-import { toNumber } from "@/helpers/utils";
-import {
-  currentColourPreset,
-  previousLayout,
-  transactionStarted,
-} from "@/dataLayer/scanState";
-
-const sendPayloadFunction = vi.fn();
-const mockWebglInstance = {
-  value: {
-    sendPayload: sendPayloadFunction,
-  },
-} as unknown as Ref<UnwrapRef<typeof WebGL3DR | null>>;
-
-describe("payloadHandler.ts", () => {
-  it("should create instance", () => {
-    expect(new PayloadHandler(mockWebglInstance)).toBeTruthy();
-  });
-
-  describe("payload functions", () => {
-    let instance: PayloadHandler;
-    beforeEach(() => {
-      transactionStarted.value = false;
-      previousLayout.value = LayoutActions.lo01;
-      currentColourPreset.value = {} as ColourPresetData;
-      vi.resetAllMocks();
-      instance = new PayloadHandler(mockWebglInstance);
-      console.log(instance);
-    });
-
-    it("should sendPayload", async () => {
-      expect(sendPayloadFunction).not.toHaveBeenCalled();
-
-      await instance.sendPayload("123", "123", {});
-
-      expect(sendPayloadFunction).toHaveBeenCalledWith(
-        JSON.stringify({
-          Version: "0.0.1",
-          Interface: "123",
-          Action: "123",
-          Message: JSON.stringify({}),
-        })
-      );
-    });
-
-    it("should rotateByDeg", async () => {
-      const view = ScanView.Coronal;
-      const deg = 100;
-      const spy = spyOn(instance, "sendPayload");
-      expect(spy).not.toHaveBeenCalled();
-
-      await instance.rotateByDeg(view, deg);
-
-      expect(spy).toHaveBeenCalledWith(
-        FrontEndInterfaces.scan_orientation,
-        ScanOrientationActions.so01,
-        {
-          Version: "0.0.1",
-          View: view,
-          Angle: deg,
-        }
-      );
-    });
-
-    it("should sliderHandler", async () => {
-      const action = SlidersActions.sl08;
-      const value = 100;
-      const spy = spyOn(instance, "sendPayload");
-      expect(spy).not.toHaveBeenCalled();
-
-      await instance.sliderHandler(action, value);
-
-      expect(spy).toHaveBeenCalledWith(FrontEndInterfaces.sliders, action, {
-        Version: "0.0.1",
-        Value: toNumber(value),
-      });
-    });
-
-    it("should not sliderHandler transactionStarted", async () => {
-      transactionStarted.value = true;
-      const action = SlidersActions.sl08;
-      const value = 100;
-      const spy = spyOn(instance, "sendPayload");
-      expect(spy).not.toHaveBeenCalled();
-
-      await instance.sliderHandler(action, value);
-
-      expect(spy).not.toHaveBeenCalledWith(FrontEndInterfaces.sliders, action, {
-        Version: "0.0.1",
-        Value: toNumber(value),
-      });
-    });
-
-    it("should scanMovementHandler", async () => {
-      const action = ScanMovementActions.sm05;
-      const value = 100;
-      const spy = spyOn(instance, "sendPayload");
-      expect(spy).not.toHaveBeenCalled();
-
-      await instance.scanMovementHandler(action, value);
-
-      expect(spy).toHaveBeenCalledWith(
-        FrontEndInterfaces.scan_movement,
-        action,
-        {
-          Version: "0.0.1",
-          Value: toNumber(value),
-        }
-      );
-    });
-
-    it("should not scanMovementHandler transactionStarted", async () => {
-      transactionStarted.value = true;
-      const action = ScanMovementActions.sm05;
-      const value = 100;
-      const spy = spyOn(instance, "sendPayload");
-      expect(spy).not.toHaveBeenCalled();
-
-      await instance.scanMovementHandler(action, value);
-
-      expect(spy).not.toHaveBeenCalledWith(
-        FrontEndInterfaces.scan_movement,
-        action,
-        {
-          Version: "0.0.1",
-          Value: toNumber(value),
-        }
-      );
-    });
-
-    it("should layouts", async () => {
-      const action = LayoutActions.lo01;
-      const spy = spyOn(instance, "sendPayload");
-      expect(spy).not.toHaveBeenCalled();
-
-      await instance.layouts(action);
-
-      expect(spy).toHaveBeenCalledWith(
-        FrontEndInterfaces.layout,
-        action,
-        emptyPayload
-      );
-    });
-
-    it("should set prevLayout", async () => {
-      const action = LayoutActions.lo02;
-      const spy = spyOn(instance, "sendPayload");
-      expect(spy).not.toHaveBeenCalled();
-      expect(unref(previousLayout)).not.toBe(LayoutActions.lo02);
-
-      await instance.layouts(action);
-
-      expect(unref(previousLayout)).toBe(LayoutActions.lo02);
-      expect(spy).toHaveBeenCalledWith(
-        FrontEndInterfaces.layout,
-        action,
-        emptyPayload
-      );
-    });
-
-    it("should set setPreset", async () => {
-      const action = PresetsActions.pr01;
-      const data = {
-        asd: "123",
-      };
-      const spy = spyOn(instance, "sendPayload");
-      expect(spy).not.toHaveBeenCalled();
-      expect(unref(currentColourPreset)).not.toBe(data);
-
-      await instance.setPreset(action, data);
-
-      expect(unref(currentColourPreset)).not.toBe(data);
-      expect(spy).toHaveBeenCalledWith(
-        FrontEndInterfaces.presets,
-        action,
-        data
-      );
-    });
-
-    it("should set setPreset change colour", async () => {
-      const action = PresetsActions.pr02;
-      const data = {
-        asd: "123",
-      };
-      const spy = spyOn(instance, "sendPayload");
-      expect(spy).not.toHaveBeenCalled();
-      expect(unref(currentColourPreset)).not.toBe(data);
-
-      await instance.setPreset(action, data);
-
-      expect(unref(currentColourPreset)).toStrictEqual(data);
-      expect(spy).toHaveBeenCalledWith(
-        FrontEndInterfaces.presets,
-        action,
-        data
-      );
-    });
-  });
-});

package/src/dataLayer/payloadHandler.ts

@@ -1,138 +0,0 @@
-import { Ref, unref, UnwrapRef } from "vue";
-import WebGL3DR from "@/components/WebGL3DR.vue";
-import {
-  FrontEndInterfaces,
-  InteractivityActions,
-  LayoutActions,
-  NavigationCubeActions,
-  PresetsActions,
-  ScanMovementActions,
-  ScanOrientationActions,
-  ScanView,
-  SlidersActions,
-  ViewSelectionActions,
-} from "@3cr/types-ts";
-import {
-  currentColourPreset,
-  previousLayout,
-  transactionStarted,
-} from "@/dataLayer/scanState";
-import { toNumber } from "@/helpers/utils";
-
-export const emptyPayload = { Version: "1.1.0" };
-
-export class PayloadHandler {
-  private readonly instance: Ref<UnwrapRef<typeof WebGL3DR | null>>;
-  constructor(protected webglInstance: Ref<UnwrapRef<typeof WebGL3DR | null>>) {
-    this.instance = webglInstance;
-  }
-
-  async sendPayload(interfaceType: string, actionType: string, message: any) {
-    await this.instance.value?.sendPayload(
-      JSON.stringify({
-        Version: "0.0.1",
-        Interface: interfaceType,
-        Action: actionType,
-        Message: JSON.stringify(message),
-      })
-    );
-  }
-  async rotateByDeg(view: ScanView, deg: number) {
-    await this.sendPayload(
-      FrontEndInterfaces.scan_orientation,
-      ScanOrientationActions.so01,
-      {
-        Version: "0.0.1",
-        View: view,
-        Angle: deg,
-      }
-    );
-  }
-  async viewSelection(action: ViewSelectionActions) {
-    await this.sendPayload(
-      FrontEndInterfaces.view_selection,
-      action,
-      emptyPayload
-    );
-  }
-
-  async sliderHandler(action: SlidersActions, value: number) {
-    if (unref(transactionStarted)) return;
-    await this.slider(action, value);
-  }
-
-  async scanMovementHandler(action: ScanMovementActions, value: number) {
-    if (unref(transactionStarted)) return;
-    await this.scanMovement(action, value);
-  }
-  async layouts(action: LayoutActions) {
-    if (action !== LayoutActions.lo01) previousLayout.value = action;
-    await this.sendPayload(FrontEndInterfaces.layout, action, emptyPayload);
-  }
-
-  async setPreset(action: PresetsActions, preset: any) {
-    await this.sendPayload(FrontEndInterfaces.presets, action, preset);
-    if (action === PresetsActions.pr02) {
-      currentColourPreset.value = preset;
-    }
-  }
-
-  async setNavCubeVisibility(visibility: any) {
-    await this.sendPayload(
-      FrontEndInterfaces.navigation_cube,
-      NavigationCubeActions.nc02,
-      {
-        Version: "0.0.1",
-        Value: visibility,
-      }
-    );
-  }
-
-  async hoverOverCanvas(isHovering: boolean) {
-    await this.sendPayload(
-      FrontEndInterfaces.interactivity,
-      InteractivityActions.in01,
-      {
-        Version: "0.0.1",
-        Value: isHovering,
-      }
-    );
-    await this.sendPayload(
-      FrontEndInterfaces.interactivity,
-      InteractivityActions.in02,
-      {
-        Version: "0.0.1",
-        Value: isHovering,
-      }
-    );
-  }
-
-  private async scanMovement(action: ScanMovementActions, value: number) {
-    await this.sendPayload(FrontEndInterfaces.scan_movement, action, {
-      Version: "0.0.1",
-      Value: toNumber(value),
-    });
-  }
-  private async slider(action: SlidersActions, value: number) {
-    await this.sendPayload(FrontEndInterfaces.sliders, action, {
-      Version: "0.0.1",
-      Value: toNumber(value),
-    });
-  }
-}
-
-export async function sendPayload(
-  instance: Ref<UnwrapRef<typeof WebGL3DR | null>>,
-  interfaceType: string,
-  actionType: string,
-  message: any
-) {
-  await unref(instance)?.sendPayload(
-    JSON.stringify({
-      Version: "0.0.1",
-      Interface: interfaceType,
-      Action: actionType,
-      Message: JSON.stringify(message),
-    })
-  );
-}