@internetarchive/ia-item-navigator 1.1.1 → 2.0.0-alpha1

package/test/ia-item-navigator.test.ts

@@ -1,417 +0,0 @@
-/* eslint-disable camelcase */
-import { html, fixture, expect } from '@open-wc/testing';
-import Sinon from 'sinon';
-
-import { SharedResizeObserver } from '@internetarchive/shared-resize-observer';
-import { ModalManager } from '@internetarchive/modal-manager';
-import { ItemNavigator } from '../src/item-navigator';
-import '../src/item-navigator';
-
-import { ItemStub, menuProvider, shortcut } from '../test/ia-stub';
-import {
-  ManageFullscreenEvent,
-  ToggleSideMenuOpenEvent,
-  SetSideMenuContentsEvent,
-  SetSideMenuShortcutsEvent,
-  ToggleSidePanelOpenEvent,
-} from '../src/interfaces/event-interfaces';
-
-afterEach(() => {
-  Sinon.restore();
-});
-
-describe('ItemNavigator', () => {
-  describe('Theaters', () => {
-    it('shows <ia-no-theater-available> if told', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator .item=${new ItemStub()}></ia-item-navigator>`,
-      );
-      el.viewAvailable = false;
-      await el.updateComplete;
-      expect(el.viewAvailable).to.be.false;
-      expect(el.shadowRoot?.querySelector('ia-no-theater-available')).to.exist;
-    });
-    it('opens main slot by default', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator .item=${new ItemStub()}></ia-item-navigator>`,
-      );
-
-      expect(el.viewAvailable).to.be.true;
-      expect(el.shadowRoot?.querySelector('ia-no-theater-available')).to.be
-        .null;
-      expect(el.shadowRoot?.querySelector('slot[name="main"]')).to.exist;
-    });
-  });
-  describe('`el.loaded`', () => {
-    it('toggles the spinning loader', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator></ia-item-navigator>`,
-      );
-      expect(el.loaded).to.be.null; // initial load
-      expect(el.shadowRoot?.querySelector('ia-itemnav-loader')).to.exist;
-    });
-    it('hides reader section if `!loaded`', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator></ia-item-navigator>`,
-      );
-
-      expect(
-        el.shadowRoot?.querySelector('#reader')?.getAttribute('class'),
-      ).to.contain('hidden');
-    });
-    it('shows reader when `loaded` ', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator .item=${new ItemStub()}></ia-item-navigator>`,
-      );
-
-      el.loaded = true;
-      await el.updateComplete;
-      const mainTheaterSection = el.shadowRoot?.querySelector('#reader');
-      expect(mainTheaterSection?.classList.contains('hide')).to.be.false;
-      expect(el.loaded).to.be.true;
-      // `loaded` property is reflected as DOM attribute
-      expect(el.hasAttribute('loaded')).to.equal(true);
-      expect(el.shadowRoot?.querySelector('slot[name="main"]')).to.exist;
-    });
-    it('listens to `@loadingStateUpdated` to update `loaded` for <no-theater-available>', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator></ia-item-navigator>`,
-      );
-
-      await el.updateComplete;
-      const spy = Sinon.spy();
-      el.loadingStateUpdated = spy;
-      el.loaded = null;
-      el.viewAvailable = false;
-      await el.updateComplete;
-      // check base properties
-      expect(el.loaded).to.equal(null);
-      expect(el.item).to.be.undefined;
-
-      // spy fires
-      expect(spy.called).to.equal(true);
-      expect(spy.callCount).to.equal(1);
-    });
-  });
-
-  describe('`el.sharedObserver`', () => {
-    it('uses one', async () => {
-      const sharedObserver = new SharedResizeObserver();
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator
-          .sharedObserver=${sharedObserver}
-        ></ia-item-navigator>`,
-      );
-
-      expect(el.sharedObserver).to.equal(sharedObserver);
-      expect(typeof el.handleResize).to.equal('function');
-    });
-    it('freshly registers handlers', async () => {
-      const sharedObserver = new SharedResizeObserver();
-      const addObserverSpy = Sinon.spy(sharedObserver, 'addObserver');
-
-      await fixture<ItemNavigator>(
-        html`<ia-item-navigator
-          .sharedObserver=${sharedObserver}
-        ></ia-item-navigator>`,
-      );
-
-      expect(addObserverSpy.callCount).to.equal(2);
-    });
-    it('removes handler when component disconnects', async () => {
-      const sharedObserver = new SharedResizeObserver();
-      const removeObserverSpy = Sinon.spy(sharedObserver, 'removeObserver');
-
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator
-          .sharedObserver=${sharedObserver}
-        ></ia-item-navigator>`,
-      );
-
-      el.disconnectedCallback();
-      await el.updateComplete;
-
-      expect(removeObserverSpy.callCount).to.equal(1);
-    });
-    it('sets menu to overlay if container width is <= 600px', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator></ia-item-navigator>`,
-      );
-
-      expect(el.openMenuState).to.equal('shift'); // as starting point
-
-      const overlaySize = {
-        contentRect: { width: 600 },
-      } as ResizeObserverEntry;
-      el.handleResize(overlaySize);
-      await el.updateComplete;
-
-      expect(el.openMenuState).to.equal('overlay'); // changes open menu display to an overlay
-
-      const shiftSize = {
-        contentRect: { width: 601 },
-      } as ResizeObserverEntry;
-      el.handleResize(shiftSize);
-      await el.updateComplete;
-
-      expect(el.openMenuState).to.equal('shift');
-    });
-  });
-
-  describe('`el.modal`', () => {
-    it('uses one', async () => {
-      const modal = new ModalManager();
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator .modal=${modal}></ia-item-navigator>`,
-      );
-      expect(el.modal).to.equal(modal);
-    });
-  });
-
-  describe('full browser window immersion "fullscreen"', () => {
-    it('creates reflected attribute `viewportinfullscreen`', async () => {
-      /** to help with external styling adjustmnents */
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator></ia-item-navigator>`,
-      );
-      expect(el.getAttribute('viewportinfullscreen')).to.be.null;
-
-      el.viewportInFullscreen = true;
-      await el.updateComplete;
-
-      expect(el.getAttribute('viewportinfullscreen')).to.exist;
-    });
-    it('@ViewportInFullScreen', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator></ia-item-navigator>`,
-      );
-      expect(el.viewportInFullscreen).to.be.null;
-
-      const yesFullscreenEvent = {
-        detail: {
-          isFullScreen: true,
-        },
-      } as ManageFullscreenEvent;
-      el.manageViewportFullscreen(yesFullscreenEvent);
-      await el.updateComplete;
-      expect(el.viewportInFullscreen).to.be.true;
-
-      const noFullscreenEvent = {
-        detail: {
-          isFullScreen: false,
-        },
-      } as ManageFullscreenEvent;
-      el.manageViewportFullscreen(noFullscreenEvent);
-      await el.updateComplete;
-      expect(el.viewportInFullscreen).to.be.null;
-    });
-  });
-
-  /* Side menu & shortcuts tests */
-  describe('el.menuOpened', () => {
-    it('toggles side menu open', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator .item=${new ItemStub()}></ia-item-navigator>`,
-      );
-
-      el.menuContents = [menuProvider];
-      await el.updateComplete;
-
-      const nav = el.shadowRoot?.querySelector('nav');
-
-      expect(nav?.querySelector('#menu')).to.exist;
-      // side menu starts closed
-      expect(el.menuOpened).to.be.false;
-      expect(nav?.querySelector('#menu')?.getAttribute('class')).to.contain(
-        'hidden',
-      );
-
-      // let's open menu
-      el.toggleMenu();
-      await el.updateComplete;
-
-      expect(el.menuOpened).to.be.true;
-      expect(nav?.querySelector('#menu')?.getAttribute('class')).to.not.contain(
-        'hidden',
-      );
-    });
-
-    it('opens menu shortcut with `@manageSideMenuEvents`', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator .item=${new ItemStub()}></ia-item-navigator>`,
-      );
-      const detail = {
-        menuId: 'fullscreen',
-        action: 'open',
-      };
-
-      el.menuContents = [menuProvider];
-      await el.updateComplete;
-      const frame = el.shadowRoot?.querySelector('#frame');
-      // default menu open behavior is to side menu open, not overlay
-      expect(frame?.getAttribute('class')).to.contain('shift');
-
-      expect(el.menuOpened).to.be.false;
-      expect(el.openMenu).to.be.undefined;
-      expect(frame?.getAttribute('class')).to.not.contain('open');
-
-      const event = new CustomEvent('updateSideMenu', {
-        detail,
-      }) as ToggleSideMenuOpenEvent;
-      el.manageSideMenuEvents(event);
-      await el.updateComplete;
-
-      expect(el.shouldRenderMenu).to.be.true;
-      expect(el.menuOpened).to.be.true;
-      expect(el.openMenu).to.equal(detail.menuId);
-
-      expect(frame?.getAttribute('class')).to.contain('open');
-
-      // no menu provided
-      const openShortcutSpy = Sinon.spy(el, 'openShortcut');
-      const toggleMenuSpy = Sinon.spy(el, 'toggleMenu');
-
-      const noMenuProvidedEvent = new CustomEvent('updateSideMenu', {
-        detail: {},
-      }) as any;
-      el.manageSideMenuEvents(noMenuProvidedEvent);
-      await el.updateComplete;
-
-      expect(openShortcutSpy.called).to.be.false;
-      expect(toggleMenuSpy.called).to.be.false;
-
-      // toggle menu
-      const toggleMenuEvent = new CustomEvent('updateSideMenu', {
-        detail: { action: 'toggle', menuId: 'fullscreen' },
-      }) as any;
-      el.manageSideMenuEvents(toggleMenuEvent);
-      await el.updateComplete;
-
-      expect(toggleMenuSpy.callCount).to.equal(1);
-
-      // open menu
-      const openMenuEvent = new CustomEvent('updateSideMenu', {
-        detail: { action: 'open', menuId: 'fullscreen' },
-      }) as any;
-      el.manageSideMenuEvents(openMenuEvent);
-      await el.updateComplete;
-
-      expect(openShortcutSpy.callCount).to.equal(1);
-    });
-  });
-
-  describe('el.menuContents', () => {
-    it('draws side menu when populated', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator .item=${new ItemStub()}></ia-item-navigator>`,
-      );
-
-      el.menuContents = [menuProvider];
-      await el.updateComplete;
-      expect(el.menuContents.length).to.exist;
-      expect(el.shouldRenderMenu).to.be.true;
-
-      const nav = el.shadowRoot?.querySelector('nav');
-      expect(nav).to.exist;
-
-      const menuSlider = nav?.querySelector('ia-menu-slider');
-      expect(menuSlider).to.exist;
-      expect(menuSlider?.getAttribute('manuallyhandleclose')).to.exist;
-      expect(menuSlider?.getAttribute('open')).to.exist;
-    });
-  });
-
-  describe('`el.menuShortcuts`', () => {
-    it('displays shortcut & toggle side menu button', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator .item=${new ItemStub()}></ia-item-navigator>`,
-      );
-
-      const anotherShortcut = {
-        id: 'foo',
-        icon: html`<i class="foo-shortcut"></i>`,
-      };
-      el.menuContents = [menuProvider];
-      el.menuShortcuts = [shortcut, anotherShortcut];
-      await el.updateComplete;
-
-      const nav = el.shadowRoot?.querySelector('nav');
-
-      const shortcutsContainer = nav?.querySelector('.shortcuts');
-      expect(el.menuShortcuts.length).to.exist;
-      expect(nav).to.exist;
-      expect(shortcutsContainer).to.exist;
-      expect(shortcutsContainer?.querySelector('i.fullscreen-test')).to.exist;
-      expect(shortcutsContainer?.querySelector('button.shortcut.foo')).to.exist;
-      expect(nav?.querySelector('.toggle-menu')).to.exist;
-    });
-  });
-
-  describe('Menu events', () => {
-    it('`el.setMenuShortcuts`', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator .item=${new ItemStub()}></ia-item-navigator>`,
-      );
-      expect(el.menuShortcuts.length).to.equal(0);
-
-      const menuShortcuts = [shortcut];
-
-      el.setMenuShortcuts({
-        detail: menuShortcuts,
-      } as SetSideMenuShortcutsEvent);
-      await el.updateComplete;
-
-      expect(el.menuShortcuts.length).to.equal(1);
-    });
-    it('`el.setMenuContents`', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator .item=${new ItemStub()}></ia-item-navigator>`,
-      );
-      expect(el.menuContents.length).to.equal(0);
-
-      el.setMenuShortcuts({
-        detail: [menuProvider],
-      } as SetSideMenuContentsEvent);
-      await el.updateComplete;
-
-      expect(el.menuShortcuts.length).to.equal(1);
-    });
-    it('`el.setOpenMenu`', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator .item=${new ItemStub()}></ia-item-navigator>`,
-      );
-
-      el.setOpenMenu({
-        detail: { id: 'foo' },
-      } as ToggleSidePanelOpenEvent);
-      await el.updateComplete;
-
-      expect(el.openMenu).to.equal('foo');
-      expect(el.selectedMenuId).to.equal('foo');
-
-      // toggles it off
-      el.setOpenMenu({
-        detail: { id: 'foo' },
-      } as ToggleSidePanelOpenEvent);
-      await el.updateComplete;
-
-      expect(el.openMenu).to.be.undefined;
-      expect(el.selectedMenuId).to.equal('');
-    });
-    it('`el.closeMenu`', async () => {
-      const el = await fixture<ItemNavigator>(
-        html`<ia-item-navigator .item=${new ItemStub()}></ia-item-navigator>`,
-      );
-
-      el.menuOpened = true;
-      await el.updateComplete;
-
-      expect(el.menuOpened).to.be.true;
-
-      el.closeMenu();
-      await el.updateComplete;
-
-      expect(el.menuOpened).to.be.false;
-    });
-  });
-});