@internetarchive/ia-topnav 1.4.0 → 1.4.1-alpha-webdev8259.0

package/test/primary-nav.test.ts

@@ -1,94 +1,163 @@
-import {
-  html,
-  fixture,
-  expect,
-  fixtureCleanup,
-  elementUpdated,
-} from '@open-wc/testing';
-
-import '../src/primary-nav';
-import { IATopNavConfig, IATopNavSecondIdentitySlotMode } from '../src/models';
-import { PrimaryNav } from '../src/primary-nav';
-
-const component = ({
-  baseHost = 'archive.org',
-  username = '',
-  screenName = '',
-  hideSearch = false,
-  config = {},
-  secondIdentitySlotMode = 'allow',
-}: {
-  baseHost?: string;
-  username?: string;
-  screenName?: string;
-  hideSearch?: boolean;
-  config?: IATopNavConfig;
-  secondIdentitySlotMode?: IATopNavSecondIdentitySlotMode;
-}) =>
-  html` <primary-nav
-    .baseHost=${baseHost}
-    .username=${username}
-    .screenName=${screenName}
-    ?hideSearch=${hideSearch}
-    .config=${config}
-    .secondIdentitySlotMode=${secondIdentitySlotMode}
-  ></primary-nav>`;
-
-afterEach(() => {
-  fixtureCleanup();
-});
-
-describe('<primary-nav>', () => {
-  it('renders the login link when no username present', async () => {
-    const el = await fixture<PrimaryNav>(
-      component({
-        baseHost: 'archive.org',
-        username: '',
-      }),
-    );
-
-    expect(el.shadowRoot?.querySelector('login-button')).to.not.be.undefined;
-  });
-
-  it('does not render search menu toggle and search form if hideSearch true', async () => {
-    const el = await fixture<PrimaryNav>(
-      component({
-        baseHost: 'archive.org',
-        username: 'shaneriley',
-        screenName: 'shaneriley',
-        hideSearch: true,
-      }),
-    );
-
-    expect(el.shadowRoot?.querySelector('.search-trigger')).to.equal(null);
-    expect(el.shadowRoot?.querySelector('nav-search')).to.equal(null);
-  });
-
-  it('opens a slot with `secondIdentitySlotMode`', async () => {
-    const el = await fixture<PrimaryNav>(
-      component({
-        baseHost: 'archive.org',
-        username: 'boop',
-        screenName: 'somesuperlongscreenname',
-        secondIdentitySlotMode: 'allow',
-      }),
-    );
-
-    const brandingBlock = el.shadowRoot?.querySelector('div.branding');
-    expect(brandingBlock?.getAttribute('class')).to.contain(
-      'branding second-logo',
-    );
-
-    const slot = brandingBlock?.querySelector('slot');
-    expect(slot).to.exist;
-    expect(slot?.getAttribute('name')).to.equal('opt-sec-logo');
-
-    el.secondIdentitySlotMode = '';
-    await elementUpdated(el);
-    const noSlotBrandingBlock = el.shadowRoot?.querySelector('div.branding');
-    expect(noSlotBrandingBlock?.getAttribute('class')).to.contain('branding');
-
-    const noSlot = noSlotBrandingBlock?.querySelector('slot');
-    expect(noSlot).to.not.exist;
-  });
-});
+import {
+  html,
+  fixture,
+  expect,
+  fixtureCleanup,
+  elementUpdated,
+} from '@open-wc/testing';
+
+import '../src/primary-nav';
+import {
+  IATopNavConfig,
+  IATopNavSearchSlotMode,
+  IATopNavSecondIdentitySlotMode,
+} from '../src/models';
+import { PrimaryNav } from '../src/primary-nav';
+
+const component = ({
+  baseHost = 'archive.org',
+  username = '',
+  screenName = '',
+  hideSearch = false,
+  config = {},
+  searchSlotMode = '',
+  secondIdentitySlotMode = 'allow',
+}: {
+  baseHost?: string;
+  username?: string;
+  screenName?: string;
+  hideSearch?: boolean;
+  config?: IATopNavConfig;
+  searchSlotMode?: IATopNavSearchSlotMode;
+  secondIdentitySlotMode?: IATopNavSecondIdentitySlotMode;
+}) =>
+  html` <primary-nav
+    .baseHost=${baseHost}
+    .username=${username}
+    .screenName=${screenName}
+    ?hideSearch=${hideSearch}
+    .config=${config}
+    .searchSlotMode=${searchSlotMode}
+    .secondIdentitySlotMode=${secondIdentitySlotMode}
+  ></primary-nav>`;
+
+afterEach(() => {
+  fixtureCleanup();
+});
+
+describe('<primary-nav>', () => {
+  it('renders the login link when no username present', async () => {
+    const el = await fixture<PrimaryNav>(
+      component({
+        baseHost: 'archive.org',
+        username: '',
+      }),
+    );
+
+    expect(el.shadowRoot?.querySelector('login-button')).to.not.be.undefined;
+  });
+
+  it('does not render search menu toggle and search form if hideSearch true', async () => {
+    const el = await fixture<PrimaryNav>(
+      component({
+        baseHost: 'archive.org',
+        username: 'shaneriley',
+        screenName: 'shaneriley',
+        hideSearch: true,
+      }),
+    );
+
+    expect(el.shadowRoot?.querySelector('.search-trigger')).to.equal(null);
+    expect(el.shadowRoot?.querySelector('nav-search')).to.equal(null);
+  });
+
+  it('renders nav-search by default', async () => {
+    const el = await fixture<PrimaryNav>(
+      component({
+        baseHost: 'archive.org',
+        username: 'testuser',
+        screenName: 'testuser',
+      }),
+    );
+
+    expect(el.shadowRoot?.querySelector('nav-search')).to.exist;
+    expect(el.shadowRoot?.querySelector('.custom-search-container')).to.not
+      .exist;
+  });
+
+  it('renders custom-search slot when searchSlotMode is "custom"', async () => {
+    const el = await fixture<PrimaryNav>(
+      component({
+        baseHost: 'archive.org',
+        username: 'testuser',
+        screenName: 'testuser',
+        searchSlotMode: 'custom',
+      }),
+    );
+
+    expect(el.shadowRoot?.querySelector('nav-search')).to.not.exist;
+    expect(el.shadowRoot?.querySelector('.custom-search-container')).to.exist;
+
+    const slot = el.shadowRoot?.querySelector<HTMLSlotElement>(
+      'slot[name="custom-search"]',
+    );
+    expect(slot).to.exist;
+  });
+
+  it('keeps search trigger button when searchSlotMode is "custom"', async () => {
+    const el = await fixture<PrimaryNav>(
+      component({
+        baseHost: 'archive.org',
+        username: 'testuser',
+        screenName: 'testuser',
+        searchSlotMode: 'custom',
+      }),
+    );
+
+    expect(el.shadowRoot?.querySelector('.search-trigger')).to.exist;
+  });
+
+  it('hides custom search when hideSearch is true', async () => {
+    const el = await fixture<PrimaryNav>(
+      component({
+        baseHost: 'archive.org',
+        username: 'testuser',
+        screenName: 'testuser',
+        searchSlotMode: 'custom',
+        hideSearch: true,
+      }),
+    );
+
+    expect(el.shadowRoot?.querySelector('.custom-search-container')).to.not
+      .exist;
+    expect(el.shadowRoot?.querySelector('.search-trigger')).to.not.exist;
+  });
+
+  it('opens a slot with `secondIdentitySlotMode`', async () => {
+    const el = await fixture<PrimaryNav>(
+      component({
+        baseHost: 'archive.org',
+        username: 'boop',
+        screenName: 'somesuperlongscreenname',
+        secondIdentitySlotMode: 'allow',
+      }),
+    );
+
+    const brandingBlock = el.shadowRoot?.querySelector('div.branding');
+    expect(brandingBlock?.getAttribute('class')).to.contain(
+      'branding second-logo',
+    );
+
+    const slot = brandingBlock?.querySelector('slot');
+    expect(slot).to.exist;
+    expect(slot?.getAttribute('name')).to.equal('opt-sec-logo');
+
+    el.secondIdentitySlotMode = '';
+    await elementUpdated(el);
+    const noSlotBrandingBlock = el.shadowRoot?.querySelector('div.branding');
+    expect(noSlotBrandingBlock?.getAttribute('class')).to.contain('branding');
+
+    const noSlot = noSlotBrandingBlock?.querySelector('slot');
+    expect(noSlot).to.not.exist;
+  });
+});

package/tsconfig.json

@@ -1,31 +1,31 @@
-{
-  "compilerOptions": {
-    "target": "es2018",
-    "module": "esnext",
-    "moduleResolution": "node",
-    "noEmitOnError": true,
-    "lib": ["es2017", "dom"],
-    "strict": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "importHelpers": true,
-    "outDir": "dist",
-    "sourceMap": true,
-    "inlineSources": true,
-    "rootDir": "./",
-    "declaration": true,
-    "plugins": [
-      {
-        "name": "ts-lit-plugin"
-      }
-    ],
-    "paths": {
-      // workaround for: https://github.com/vitest-dev/vitest/issues/4567
-      "rollup/parseAst": [
-        "./node_modules/rollup/dist/parseAst"
-    ]
-}
-  },
-  "include": ["**/*.ts"]
-}
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noEmitOnError": true,
+    "lib": ["es2017", "dom"],
+    "strict": true,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "inlineSources": true,
+    "rootDir": "./",
+    "declaration": true,
+    "plugins": [
+      {
+        "name": "ts-lit-plugin"
+      }
+    ],
+    "paths": {
+      // workaround for: https://github.com/vitest-dev/vitest/issues/4567
+      "rollup/parseAst": [
+        "./node_modules/rollup/dist/parseAst"
+    ]
+}
+  },
+  "include": ["**/*.ts"]
+}

package/web-dev-server.config.mjs

@@ -1,32 +1,32 @@
-// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
-
-/** Use Hot Module replacement by adding --hmr to the start command */
-const hmr = process.argv.includes('--hmr');
-
-export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
-  nodeResolve: true,
-  open: '/demo',
-  watch: !hmr,
-  sslCert: './ssl/server.crt',
-  sslKey: './ssl/server.key',
-  hostname: 'local.archive.org',
-  http2: true,
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto'
-
-  /** Set appIndex to enable SPA routing */
-  // appIndex: 'demo/index.html',
-
-  /** Configure bare import resolve plugin */
-  // nodeResolve: {
-  //   exportConditions: ['browser', 'development']
-  // },
-
-  plugins: [
-    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
-    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
-  ],
-
-  // See documentation for all available options
-});
+// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
+
+/** Use Hot Module replacement by adding --hmr to the start command */
+const hmr = process.argv.includes('--hmr');
+
+export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
+  nodeResolve: true,
+  open: '/demo',
+  watch: !hmr,
+  sslCert: './ssl/server.crt',
+  sslKey: './ssl/server.key',
+  hostname: 'local.archive.org',
+  http2: true,
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto'
+
+  /** Set appIndex to enable SPA routing */
+  // appIndex: 'demo/index.html',
+
+  /** Configure bare import resolve plugin */
+  // nodeResolve: {
+  //   exportConditions: ['browser', 'development']
+  // },
+
+  plugins: [
+    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
+    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
+  ],
+
+  // See documentation for all available options
+});

package/web-test-runner.config.mjs

@@ -1,41 +1,41 @@
-// import { playwrightLauncher } from '@web/test-runner-playwright';
-
-const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
-
-export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
-  /** Test files to run */
-  files: 'dist/test/**/*.test.js',
-
-  /** Resolve bare module imports */
-  nodeResolve: {
-    exportConditions: ['browser', 'development'],
-  },
-
-  /** Filter out lit dev mode logs */
-  filterBrowserLogs(log) {
-    for (const arg of log.args) {
-      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
-        return false;
-      }
-    }
-    return true;
-  },
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto',
-
-  /** Amount of browsers to run concurrently */
-  // concurrentBrowsers: 2,
-
-  /** Amount of test files per browser to test concurrently */
-  // concurrency: 1,
-
-  /** Browsers to run tests on */
-  // browsers: [
-  //   playwrightLauncher({ product: 'chromium' }),
-  //   playwrightLauncher({ product: 'firefox' }),
-  //   playwrightLauncher({ product: 'webkit' }),
-  // ],
-
-  // See documentation for all available options
-});
+// import { playwrightLauncher } from '@web/test-runner-playwright';
+
+const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
+
+export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
+  /** Test files to run */
+  files: 'dist/test/**/*.test.js',
+
+  /** Resolve bare module imports */
+  nodeResolve: {
+    exportConditions: ['browser', 'development'],
+  },
+
+  /** Filter out lit dev mode logs */
+  filterBrowserLogs(log) {
+    for (const arg of log.args) {
+      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
+        return false;
+      }
+    }
+    return true;
+  },
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto',
+
+  /** Amount of browsers to run concurrently */
+  // concurrentBrowsers: 2,
+
+  /** Amount of test files per browser to test concurrently */
+  // concurrency: 1,
+
+  /** Browsers to run tests on */
+  // browsers: [
+  //   playwrightLauncher({ product: 'chromium' }),
+  //   playwrightLauncher({ product: 'firefox' }),
+  //   playwrightLauncher({ product: 'webkit' }),
+  // ],
+
+  // See documentation for all available options
+});