@abreen/tada 1.1.0 → 1.2.0

package/src/search/index.test.ts

@@ -0,0 +1,203 @@
+import { describe, expect, test } from 'bun:test';
+import { getPdfPageNumber, getPdfBaseUrl, groupPdfResults } from './pdf-utils';
+import type { Result } from './pdf-utils';
+
+describe('getPdfPageNumber', () => {
+  test('returns page number from meta string', () => {
+    expect(getPdfPageNumber('/doc.pdf#page=3', '3')).toBe(3);
+  });
+
+  test('prefers meta over URL hash', () => {
+    expect(getPdfPageNumber('/doc.pdf#page=5', '2')).toBe(2);
+  });
+
+  test('falls back to URL hash when meta is undefined', () => {
+    expect(getPdfPageNumber('/doc.pdf#page=7', undefined)).toBe(7);
+  });
+
+  test('falls back to URL hash when meta is empty', () => {
+    expect(getPdfPageNumber('/doc.pdf#page=4', '')).toBe(4);
+  });
+
+  test('falls back to URL hash when meta is not a number', () => {
+    expect(getPdfPageNumber('/doc.pdf#page=4', 'abc')).toBe(4);
+  });
+
+  test('returns null when neither meta nor hash has a page', () => {
+    expect(getPdfPageNumber('/doc.pdf', undefined)).toBeNull();
+  });
+
+  test('returns null for non-positive meta page number', () => {
+    expect(getPdfPageNumber('/doc.pdf', '0')).toBeNull();
+  });
+
+  test('returns null for negative meta page number', () => {
+    expect(getPdfPageNumber('/doc.pdf', '-1')).toBeNull();
+  });
+
+  test('returns null for hash page=0', () => {
+    expect(getPdfPageNumber('/doc.pdf#page=0', undefined)).toBeNull();
+  });
+
+  test('parses page from hash with other params', () => {
+    expect(getPdfPageNumber('/doc.pdf#zoom=100&page=12', undefined)).toBe(12);
+  });
+
+  test('handles case-insensitive page hash', () => {
+    expect(getPdfPageNumber('/doc.pdf#Page=9', undefined)).toBe(9);
+  });
+});
+
+describe('getPdfBaseUrl', () => {
+  test('returns base URL for a PDF with hash', () => {
+    expect(getPdfBaseUrl('/docs/guide.pdf#page=3')).toBe('/docs/guide.pdf');
+  });
+
+  test('returns URL unchanged when no hash present', () => {
+    expect(getPdfBaseUrl('/docs/guide.pdf')).toBe('/docs/guide.pdf');
+  });
+
+  test('returns null for non-PDF URL', () => {
+    expect(getPdfBaseUrl('/about/')).toBeNull();
+  });
+
+  test('returns null for non-PDF URL with hash', () => {
+    expect(getPdfBaseUrl('/about/#section')).toBeNull();
+  });
+
+  test('handles .PDF extension case-insensitively', () => {
+    expect(getPdfBaseUrl('/docs/GUIDE.PDF#page=1')).toBe('/docs/GUIDE.PDF');
+  });
+});
+
+describe('groupPdfResults', () => {
+  function makeResult(overrides: Partial<Result>): Result {
+    return {
+      title: 'doc.pdf',
+      url: '/doc.pdf',
+      excerpt: '',
+      score: 1,
+      subResults: [],
+      pageNumber: null,
+      ...overrides,
+    };
+  }
+
+  test('passes through non-PDF results unchanged', () => {
+    const results: Result[] = [
+      makeResult({ title: 'About', url: '/about/', score: 5 }),
+      makeResult({ title: 'Home', url: '/', score: 3 }),
+    ];
+    const grouped = groupPdfResults(results);
+    expect(grouped).toEqual(results);
+  });
+
+  test('groups multiple PDF page results into one result with sub-results', () => {
+    const results: Result[] = [
+      makeResult({
+        url: '/doc.pdf#page=3',
+        score: 10,
+        pageNumber: 3,
+        excerpt: 'page 3 text',
+      }),
+      makeResult({
+        url: '/doc.pdf#page=1',
+        score: 5,
+        pageNumber: 1,
+        excerpt: 'page 1 text',
+      }),
+    ];
+    const grouped = groupPdfResults(results);
+    expect(grouped).toHaveLength(1);
+    expect(grouped[0].url).toBe('/doc.pdf');
+    expect(grouped[0].score).toBe(10);
+    expect(grouped[0].subResults).toEqual([
+      { title: 'Page 1', url: '/doc.pdf#page=1', excerpt: 'page 1 text' },
+      { title: 'Page 3', url: '/doc.pdf#page=3', excerpt: 'page 3 text' },
+    ]);
+  });
+
+  test('sub-results are sorted by page number', () => {
+    const results: Result[] = [
+      makeResult({ url: '/doc.pdf#page=5', score: 1, pageNumber: 5 }),
+      makeResult({ url: '/doc.pdf#page=2', score: 8, pageNumber: 2 }),
+      makeResult({ url: '/doc.pdf#page=9', score: 3, pageNumber: 9 }),
+    ];
+    const grouped = groupPdfResults(results);
+    expect(grouped[0].subResults.map(s => s.title)).toEqual([
+      'Page 2',
+      'Page 5',
+      'Page 9',
+    ]);
+  });
+
+  test('primary result uses highest-scoring page', () => {
+    const results: Result[] = [
+      makeResult({
+        url: '/doc.pdf#page=1',
+        score: 2,
+        pageNumber: 1,
+        excerpt: 'low',
+      }),
+      makeResult({
+        url: '/doc.pdf#page=4',
+        score: 9,
+        pageNumber: 4,
+        excerpt: 'high',
+      }),
+    ];
+    const grouped = groupPdfResults(results);
+    expect(grouped[0].excerpt).toBe('high');
+    expect(grouped[0].score).toBe(9);
+  });
+
+  test('mixes non-PDF and grouped PDF results sorted by score', () => {
+    const results: Result[] = [
+      makeResult({
+        title: 'About',
+        url: '/about/',
+        score: 7,
+        pageNumber: null,
+      }),
+      makeResult({ url: '/doc.pdf#page=1', score: 10, pageNumber: 1 }),
+      makeResult({ url: '/doc.pdf#page=2', score: 3, pageNumber: 2 }),
+    ];
+    const grouped = groupPdfResults(results);
+    expect(grouped).toHaveLength(2);
+    expect(grouped[0].url).toBe('/doc.pdf');
+    expect(grouped[0].score).toBe(10);
+    expect(grouped[1].url).toBe('/about/');
+    expect(grouped[1].score).toBe(7);
+  });
+
+  test('does not group PDF result without a page number', () => {
+    const results: Result[] = [
+      makeResult({ url: '/doc.pdf', score: 5, pageNumber: null }),
+    ];
+    const grouped = groupPdfResults(results);
+    expect(grouped).toHaveLength(1);
+    expect(grouped[0].url).toBe('/doc.pdf');
+    expect(grouped[0].subResults).toEqual([]);
+  });
+
+  test('groups results from different PDFs separately', () => {
+    const results: Result[] = [
+      makeResult({
+        title: 'a.pdf',
+        url: '/a.pdf#page=1',
+        score: 5,
+        pageNumber: 1,
+      }),
+      makeResult({
+        title: 'b.pdf',
+        url: '/b.pdf#page=1',
+        score: 8,
+        pageNumber: 1,
+      }),
+    ];
+    const grouped = groupPdfResults(results);
+    expect(grouped).toHaveLength(2);
+    const urls = grouped.map(r => r.url).sort();
+    expect(urls).toEqual(['/a.pdf', '/b.pdf']);
+  });
+});

package/src/search/index.ts

@@ -1,4 +1,6 @@
 import { getElement, applyBasePath } from '../util';
+import { getPdfPageNumber, groupPdfResults } from './pdf-utils';
+import type { Result } from './pdf-utils';
 
 const MAX_RESULTS = 24;
 
@@ -28,14 +30,6 @@ interface Pagefind {
 let pagefind: Pagefind | null = null;
 
 type SubResult = { title: string; url: string; excerpt: string };
-type Result = {
-  title: string;
-  url: string;
-  excerpt: string;
-  score: number;
-  subResults: SubResult[];
-  pageNumber: number | null;
-};
 
 type State = {
   value: string;
@@ -44,76 +38,6 @@ type State = {
   totalResults: number;
 };
 
-function getPdfPageNumber(
-  url: string,
-  pageMeta: string | undefined,
-): number | null {
-  const fromMeta = Number.parseInt(pageMeta ?? '', 10);
-  if (Number.isInteger(fromMeta) && fromMeta > 0) {
-    return fromMeta;
-  }
-  const match = url.match(/#(?:.*&)?page=(\d+)\b/i);
-  if (!match) {
-    return null;
-  }
-  const fromUrl = Number.parseInt(match[1], 10);
-  return Number.isInteger(fromUrl) && fromUrl >= 1 ? fromUrl : null;
-}
-
-function getPdfBaseUrl(url: string): string | null {
-  const hashIndex = url.indexOf('#');
-  const baseUrl = hashIndex >= 0 ? url.slice(0, hashIndex) : url;
-  return baseUrl.toLowerCase().endsWith('.pdf') ? baseUrl : null;
-}
-
-function groupPdfResults(results: Result[]): Result[] {
-  const pdfGroups = new Map<string, Result[]>();
-  const other: Result[] = [];
-
-  for (const result of results) {
-    const baseUrl = getPdfBaseUrl(result.url);
-    if (!baseUrl || result.pageNumber == null) {
-      other.push(result);
-      continue;
-    }
-    if (!pdfGroups.has(baseUrl)) {
-      pdfGroups.set(baseUrl, []);
-    }
-    pdfGroups.get(baseUrl)!.push(result);
-  }
-
-  const grouped: Result[] = [...other];
-
-  pdfGroups.forEach((pages, baseUrl) => {
-    const primary = pages
-      .slice()
-      .sort(
-        (a, b) =>
-          b.score - a.score || (a.pageNumber ?? 0) - (b.pageNumber ?? 0),
-      )[0];
-    const subResults = pages
-      .slice()
-      .sort((a, b) => (a.pageNumber ?? 0) - (b.pageNumber ?? 0))
-      .map(page => ({
-        title: `Page ${page.pageNumber ?? '?'}`,
-        url: page.url,
-        excerpt: page.excerpt,
-      }));
-
-    grouped.push({
-      title: primary.title,
-      url: baseUrl,
-      excerpt: primary.excerpt,
-      score: primary.score,
-      subResults,
-      pageNumber: null,
-    });
-  });
-
-  grouped.sort((a, b) => b.score - a.score);
-  return grouped;
-}
-
 async function doSearch(state: State) {
   if (pagefind == null) {
     return;
@@ -129,7 +53,7 @@ async function doSearch(state: State) {
   const slice = search.results.slice(0, MAX_RESULTS);
   const data = await Promise.all(slice.map(r => r.data()));
 
-  const titlePostfix = window.siteVariables.titlePostfix ?? '';
+  const titlePostfix = __SITE_TITLE_POSTFIX__;
   const results: Result[] = data.map((d: PagefindResult) => {
     let title: string = d.meta?.title ?? d.url;
     if (titlePostfix && title.endsWith(titlePostfix)) {

package/src/search/pdf-utils.ts

@@ -0,0 +1,79 @@
+export type SubResult = { title: string; url: string; excerpt: string };
+export type Result = {
+  title: string;
+  url: string;
+  excerpt: string;
+  score: number;
+  subResults: SubResult[];
+  pageNumber: number | null;
+};
+
+export function getPdfPageNumber(
+  url: string,
+  pageMeta: string | undefined,
+): number | null {
+  const fromMeta = Number.parseInt(pageMeta ?? '', 10);
+  if (Number.isInteger(fromMeta) && fromMeta > 0) {
+    return fromMeta;
+  }
+  const match = url.match(/#(?:.*&)?page=(\d+)\b/i);
+  if (!match) {
+    return null;
+  }
+  const fromUrl = Number.parseInt(match[1], 10);
+  return Number.isInteger(fromUrl) && fromUrl >= 1 ? fromUrl : null;
+}
+
+export function getPdfBaseUrl(url: string): string | null {
+  const hashIndex = url.indexOf('#');
+  const baseUrl = hashIndex >= 0 ? url.slice(0, hashIndex) : url;
+  return baseUrl.toLowerCase().endsWith('.pdf') ? baseUrl : null;
+}
+
+export function groupPdfResults(results: Result[]): Result[] {
+  const pdfGroups = new Map<string, Result[]>();
+  const other: Result[] = [];
+
+  for (const result of results) {
+    const baseUrl = getPdfBaseUrl(result.url);
+    if (!baseUrl || result.pageNumber == null) {
+      other.push(result);
+      continue;
+    }
+    if (!pdfGroups.has(baseUrl)) {
+      pdfGroups.set(baseUrl, []);
+    }
+    pdfGroups.get(baseUrl)!.push(result);
+  }
+
+  const grouped: Result[] = [...other];
+
+  pdfGroups.forEach((pages, baseUrl) => {
+    const primary = pages
+      .slice()
+      .sort(
+        (a, b) =>
+          b.score - a.score || (a.pageNumber ?? 0) - (b.pageNumber ?? 0),
+      )[0];
+    const subResults = pages
+      .slice()
+      .sort((a, b) => (a.pageNumber ?? 0) - (b.pageNumber ?? 0))
+      .map(page => ({
+        title: `Page ${page.pageNumber ?? '?'}`,
+        url: page.url,
+        excerpt: page.excerpt,
+      }));
+
+    grouped.push({
+      title: primary.title,
+      url: baseUrl,
+      excerpt: primary.excerpt,
+      score: primary.score,
+      subResults,
+      pageNumber: null,
+    });
+  });
+
+  grouped.sort((a, b) => b.score - a.score);
+  return grouped;
+}

package/src/search/style.scss

@@ -8,21 +8,7 @@ header {
     gap: 0.5rem;
 
     input.search {
-      background-color: var(--bg-color);
-      background-image: var(--icon-search);
-      background-repeat: no-repeat;
-      background-position: left 6px center;
-      background-size: 16px 16px;
-      padding-left: 2rem;
-
-      border-radius: 18px;
       flex: 1;
-      min-width: 0;
-
-      &:disabled {
-        opacity: 0.4;
-        cursor: not-allowed;
-      }
     }
   }
 

package/src/style.scss

@@ -47,60 +47,18 @@
   outline-offset: 1px;
 }
 
-.info {
-  @include user-select(none);
-  display: grid;
-  grid-template-columns: 1fr auto;
-  align-items: baseline;
-  color: var(--fg2-color);
-  font-size: var(--font-size-smaller);
-
-  @media (width < 450px) {
-    grid-template-columns: 1fr;
-  }
-
-  aside.author {
-    a {
-      text-decoration: none;
-
-      .text {
-        color: var(--fg2-color);
-        text-decoration: underline;
-        text-decoration-color: var(--fg2-color);
-        text-decoration-thickness: 1px;
-        text-underline-offset: 3px;
-      }
-    }
-
-    .avatar {
-      width: 24px;
-      height: 24px;
-      vertical-align: middle;
-      margin-left: 4px;
-    }
-  }
-}
-
 a.disabled {
   color: var(--fg-color-translucent);
   text-decoration-color: var(--fg-color-translucent);
   cursor: not-allowed;
-}
-
-@media (hover: hover) {
-  a:hover {
-    color: var(--fg2-color);
-  }
 
-  a.disabled:hover {
-    color: var(--fg-color-translucent);
+  @media (hover: hover) {
+    &:hover {
+      color: var(--fg-color-translucent);
+    }
   }
 }
 
-a:active {
-  color: var(--link-active-color);
-}
-
 a.external::after {
   content: '';
   background: var(--icon-external-link);
@@ -233,16 +191,6 @@ main details {
   border: 2px solid var(--fg-color);
 }
 
-input[type='text'],
-input[type='search'] {
-  background: var(--bg-color);
-  color: var(--fg-color);
-  border: var(--control-border-width) solid var(--fg2-color);
-  border-radius: var(--border-radius);
-  font-size: 12pt;
-  padding: 4px 4px;
-}
-
 button,
 a.button,
 input[type='submit'] {
@@ -279,7 +227,7 @@ input[type='submit']:focus-visible,
 input[type='text']:focus-visible,
 input[type='search']:focus-visible {
   border-color: var(--fg-color);
-  background: var(--bg2-color);
+  background-color: var(--bg2-color);
 }
 
 button.icon-button {
@@ -470,6 +418,10 @@ dl {
           text-decoration-color: var(--fg2-color);
         }
       }
+
+      &:active {
+        text-decoration-color: var(--link-active-color);
+      }
     }
   }
 

package/src/timezone/index.ts

@@ -84,14 +84,13 @@ function getOffsetMinutes(tz: string, date: Date): number {
   return (utcTs - date.getTime()) / 60000;
 }
 
-// window.siteVariables.timezones is replaced by DefinePlugin at build time.
-// The typeof guard prevents a ReferenceError in test environments where
-// window is not defined.
-const TIMEZONES: TimezoneDef[] =
-  typeof window !== 'undefined' ? window.siteVariables.timezones : [];
+// typeof guard prevents ReferenceError when tests import this module
+// without going through the bundler (which substitutes __SITE_TIMEZONES__).
+const TIMEZONES: TimeZone[] =
+  typeof __SITE_TIMEZONES__ !== 'undefined' ? __SITE_TIMEZONES__ : [];
 
 function getDefaultTimezone() {
-  const value = window.siteVariables.defaultTimeZone;
+  const value = __SITE_DEFAULT_TIMEZONE__;
   return TIMEZONES.find(tz => tz.value === value)!;
 }
 

package/src/util.ts

@@ -34,7 +34,7 @@ export function applyBasePath(subPath: string): string {
     throw new Error('invalid internal path, must start with "/": ' + subPath);
   }
 
-  let path = window.siteVariables.basePath || '/';
+  let path = __SITE_BASE_PATH__;
   if (path.endsWith('/')) {
     path = path.slice(0, -1);
   }

package/templates/_top.html

@@ -54,7 +54,7 @@
     <header data-pagefind-ignore>
       <details>
         <summary aria-label="Toggle site navigation">
-          <span class="logo" aria-hidden="true"><%= site.symbol %></span>
+          <% if (site.symbol) { %><span class="logo" aria-hidden="true"><%= site.symbol %></span><% } %>
           <span class="site-title" aria-hidden="true"><%= site.title %></span>
           <div id="to-top-container" class="to-top-container"></div>
           <% if (site.features.search) { %>

package/types/dev.d.ts

@@ -1,3 +1 @@
-interface Window {
-  IS_DEV: boolean | undefined;
-}
+declare const __IS_DEV__: boolean;

package/types/site-variables.d.ts

@@ -1,16 +1,12 @@
-interface TimezoneDef {
+interface TimeZone {
   value: string;
   label: string;
   abbreviation: string;
   offsetMinutes?: number;
 }
 
-interface Window {
-  siteVariables: {
-    base: string;
-    basePath: string;
-    titlePostfix?: string;
-    defaultTimeZone: string;
-    timezones: TimezoneDef[];
-  };
-}
+declare const __SITE_BASE__: string;
+declare const __SITE_BASE_PATH__: string;
+declare const __SITE_TITLE_POSTFIX__: string;
+declare const __SITE_DEFAULT_TIMEZONE__: string;
+declare const __SITE_TIMEZONES__: TimeZone[];

package/types/untyped-modules.d.ts

@@ -22,6 +22,13 @@ declare module 'pagefind' {
   export function close(): Promise<void>;
 }
 
+declare module 'katex/contrib/render-a11y-string' {
+  export default function renderA11yString(
+    text: string,
+    settings?: Record<string, unknown>,
+  ): string;
+}
+
 declare module 'jsdom' {
   export class JSDOM {
     constructor(html?: string | Buffer, options?: Record<string, unknown>);

package/config/authors.json

@@ -1 +0,0 @@
-{ "alex": { "name": "Alex Breen", "avatar": "/avatars/alex.jpg" } }

package/config/nav.json

@@ -1,28 +0,0 @@
-[
-  {
-    "title": "Navigation",
-    "links": [{ "text": "Home", "internal": "/index.html" }]
-  },
-  {
-    "title": "Topics",
-    "links": [
-      { "text": "Lectures", "internal": "/lectures/index.html" },
-      {
-        "text": "Problem Sets",
-        "internal": "/problem_sets/index.html",
-        "disabled": true
-      }
-    ]
-  },
-  {
-    "title": "Links",
-    "links": [
-      { "text": "Zoom", "external": "https://zoom.com" },
-      {
-        "text": "Canvas",
-        "external": "https://www.instructure.com/",
-        "disabled": true
-      }
-    ]
-  }
-]