@esmx/router-vue/dist/index.test.mjs

Vue integration for @esmx/router - A universal router that works seamlessly with both Vue 2.7+ and Vue 3

import { describe, expect, it } from "vitest";
import * as RouterVueModule from "./index.mjs";
describe("index.ts - Package Entry Point", () => {
  describe("Composition API Exports", () => {
    it("should export useRouter function", () => {
      expect(RouterVueModule.useRouter).toBeDefined();
      expect(typeof RouterVueModule.useRouter).toBe("function");
    });
    it("should export useRoute function", () => {
      expect(RouterVueModule.useRoute).toBeDefined();
      expect(typeof RouterVueModule.useRoute).toBe("function");
    });
    it("should export useProvideRouter function", () => {
      expect(RouterVueModule.useProvideRouter).toBeDefined();
      expect(typeof RouterVueModule.useProvideRouter).toBe("function");
    });
    it("should export useLink function", () => {
      expect(RouterVueModule.useLink).toBeDefined();
      expect(typeof RouterVueModule.useLink).toBe("function");
    });
    it("should export useRouterViewDepth function", () => {
      expect(RouterVueModule.useRouterViewDepth).toBeDefined();
      expect(typeof RouterVueModule.useRouterViewDepth).toBe("function");
    });
    it("should export getRouterViewDepth function", () => {
      expect(RouterVueModule.getRouterViewDepth).toBeDefined();
      expect(typeof RouterVueModule.getRouterViewDepth).toBe("function");
    });
  });
  describe("Options API Exports", () => {
    it("should export getRouter function", () => {
      expect(RouterVueModule.getRouter).toBeDefined();
      expect(typeof RouterVueModule.getRouter).toBe("function");
    });
    it("should export getRoute function", () => {
      expect(RouterVueModule.getRoute).toBeDefined();
      expect(typeof RouterVueModule.getRoute).toBe("function");
    });
  });
  describe("Component Exports", () => {
    it("should export RouterLink component", () => {
      expect(RouterVueModule.RouterLink).toBeDefined();
      expect(typeof RouterVueModule.RouterLink).toBe("object");
      expect(RouterVueModule.RouterLink.name).toBe("RouterLink");
      expect(typeof RouterVueModule.RouterLink.setup).toBe("function");
    });
    it("should export RouterView component", () => {
      expect(RouterVueModule.RouterView).toBeDefined();
      expect(typeof RouterVueModule.RouterView).toBe("object");
      expect(RouterVueModule.RouterView.name).toBe("RouterView");
      expect(typeof RouterVueModule.RouterView.setup).toBe("function");
    });
  });
  describe("Plugin Exports", () => {
    it("should export RouterPlugin", () => {
      expect(RouterVueModule.RouterPlugin).toBeDefined();
      expect(typeof RouterVueModule.RouterPlugin).toBe("object");
      expect(typeof RouterVueModule.RouterPlugin.install).toBe(
        "function"
      );
    });
  });
  describe("Export Completeness", () => {
    it("should export all expected functions and components", () => {
      const expectedExports = [
        // Composition API
        "useRouter",
        "useRoute",
        "useProvideRouter",
        "useLink",
        "useRouterViewDepth",
        "getRouterViewDepth",
        // Options API
        "getRouter",
        "getRoute",
        // Components
        "RouterLink",
        "RouterView",
        // Plugin
        "RouterPlugin"
      ];
      expectedExports.forEach((exportName) => {
        expect(RouterVueModule).toHaveProperty(exportName);
        expect(
          RouterVueModule[exportName]
        ).toBeDefined();
      });
    });
    it("should not export unexpected items", () => {
      const actualExports = Object.keys(RouterVueModule);
      const expectedExports = [
        "useRouter",
        "useRoute",
        "useProvideRouter",
        "useLink",
        "useRouterViewDepth",
        "getRouterViewDepth",
        "getRouter",
        "getRoute",
        "RouterLink",
        "RouterView",
        "RouterPlugin"
      ];
      const unexpectedExports = actualExports.filter(
        (exportName) => !expectedExports.includes(exportName)
      );
      expect(unexpectedExports).toEqual([]);
    });
  });
  describe("Function Signatures", () => {
    it("should have correct function signatures for Composition API", () => {
      expect(() => {
        RouterVueModule.useRouter();
      }).toThrow(
        "[@esmx/router-vue] Must be used within setup() or other composition functions"
      );
      expect(() => {
        RouterVueModule.useRoute();
      }).toThrow(
        "[@esmx/router-vue] Must be used within setup() or other composition functions"
      );
      expect(() => {
        RouterVueModule.useLink({
          to: "/test",
          type: "push",
          exact: "include"
        });
      }).toThrow(
        "[@esmx/router-vue] Must be used within setup() or other composition functions"
      );
    });
    it("should have correct function signatures for Options API", () => {
      expect(() => {
        RouterVueModule.getRouter({});
      }).toThrow(
        "[@esmx/router-vue] Router context not found. Please ensure useProvideRouter() is called in a parent component."
      );
      expect(() => {
        RouterVueModule.getRoute({});
      }).toThrow(
        "[@esmx/router-vue] Router context not found. Please ensure useProvideRouter() is called in a parent component."
      );
    });
  });
  describe("Component Properties", () => {
    it("should have RouterLink with correct properties", () => {
      const { RouterLink } = RouterVueModule;
      expect(RouterLink.name).toBe("RouterLink");
      expect(RouterLink.props).toBeDefined();
      expect(RouterLink.setup).toBeDefined();
      expect(RouterLink.props.to).toBeDefined();
      expect(RouterLink.props.to.required).toBe(true);
      expect(RouterLink.props.type.default).toBe("push");
      expect(RouterLink.props.exact.default).toBe("include");
      expect(RouterLink.props.tag.default).toBe("a");
      expect(RouterLink.props.event.default).toBe("click");
    });
    it("should have RouterView with correct properties", () => {
      const { RouterView } = RouterVueModule;
      expect(RouterView.name).toBe("RouterView");
      expect(RouterView.setup).toBeDefined();
      expect(RouterView.props).toBeUndefined();
    });
  });
  describe("Plugin Interface", () => {
    it("should have RouterPlugin with install method", () => {
      const { RouterPlugin } = RouterVueModule;
      expect(RouterPlugin.install).toBeDefined();
      expect(typeof RouterPlugin.install).toBe("function");
      expect(() => {
        RouterPlugin.install(null);
      }).toThrow("[@esmx/router-vue] Invalid Vue app instance");
    });
  });
  describe("Module Structure", () => {
    it("should be a proper ES module", () => {
      expect(typeof RouterVueModule).toBe("object");
      expect(RouterVueModule).not.toBeNull();
      expect("default" in RouterVueModule).toBe(false);
    });
    it("should have consistent export naming", () => {
      const functionExports = [
        "useRouter",
        "useRoute",
        "useProvideRouter",
        "useLink",
        "useRouterViewDepth",
        "getRouterViewDepth",
        "getRouter",
        "getRoute"
      ];
      functionExports.forEach((exportName) => {
        expect(exportName).toMatch(/^[a-z][a-zA-Z]*$/);
      });
      const componentExports = [
        "RouterLink",
        "RouterView",
        "RouterPlugin"
      ];
      componentExports.forEach((exportName) => {
        expect(exportName).toMatch(/^[A-Z][a-zA-Z]*$/);
      });
    });
  });
  describe("TypeScript Integration", () => {
    it("should provide proper TypeScript types", () => {
      expect(typeof RouterVueModule.useRouter).toBe("function");
      expect(typeof RouterVueModule.useRoute).toBe("function");
      expect(typeof RouterVueModule.getRouter).toBe("function");
      expect(typeof RouterVueModule.getRoute).toBe("function");
      expect(RouterVueModule.RouterLink).toHaveProperty("name");
      expect(RouterVueModule.RouterLink).toHaveProperty("props");
      expect(RouterVueModule.RouterLink).toHaveProperty("setup");
      expect(RouterVueModule.RouterView).toHaveProperty("name");
      expect(RouterVueModule.RouterView).toHaveProperty("setup");
    });
  });
});