@playpilot/tpi 1.3.0 → 1.4.0

package/src/tests/lib/meta.test.js

@@ -0,0 +1,201 @@
+import { describe, it, expect, beforeEach } from 'vitest'
+import { getPageHeading, getPageModifiedTime, getPagePublishedTime } from '$lib/meta'
+
+describe('meta.js', () => {
+  beforeEach(() => {
+    document.body.innerHTML = ''
+    document.head.innerHTML = ''
+  })
+
+  describe('getPageHeading', () => {
+    it('Should get the h1 in the given parent', () => {
+      document.body.innerHTML = `
+        <h1>Not this heading</h1>
+        <section>
+          <h1>This heading</h1>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPageHeading(parent)).toBe('This heading')
+    })
+
+    it('Should get the first h1 on the page if no h1 is found in the given parent', () => {
+      document.body.innerHTML = `
+        <h1>This heading</h1>
+        <section>
+          <h2>Not this heading</h2>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPageHeading(parent)).toBe('This heading')
+    })
+
+    it('Should return null if heading is not found', () => {
+      document.body.innerHTML = `
+        <section>
+          <h2>Not this heading</h2>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPageHeading(parent)).toBe(null)
+    })
+
+    it('Should return null if heading is empty', () => {
+      document.body.innerHTML = `
+        <section>
+          <h1> </h1>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPageHeading(parent)).toBe(null)
+    })
+  })
+
+  describe('getPageModifiedTime', () => {
+    it('Should use element containing itemprop when available, using the content attribute', () => {
+      document.body.innerHTML = `
+        <div itemprop="dateModified" content="2025-01-01">2025-01-02</div>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('body'))
+      expect(getPageModifiedTime(parent)).toBe('2025-01-01T00:00:00.000Z')
+    })
+
+    it('Should use element inside of given selector before others', () => {
+      document.body.innerHTML = `
+        <div itemprop="dateModified">2025-01-01</div>
+        <section>
+          <div itemprop="dateModified">2025-01-02</div>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPageModifiedTime(parent)).toBe('2025-01-02T00:00:00.000Z')
+    })
+
+    it('Should use meta tag before other elements', () => {
+      document.head.innerHTML = '<meta content="2025-01-01" property="article:modified_time">'
+      document.body.innerHTML = `
+        <div itemprop="dateModified">2025-01-02</div>
+        <section>
+          <div itemprop="dateModified">2025-01-03</div>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPageModifiedTime(parent)).toBe('2025-01-01T00:00:00.000Z')
+    })
+  })
+
+  describe('getPagePublishedTime', () => {
+    it('Should get the time element inside the parent', () => {
+      document.body.innerHTML = `
+        <time>2025-01-01</time>
+        <section>
+          <time>2025-01-02</time>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPagePublishedTime(parent)).toBe('2025-01-02T00:00:00.000Z')
+    })
+
+    it('Should get the time element out of the parent when parent contains none', () => {
+      document.body.innerHTML = `
+        <time>2025-01-01</time>
+        <section>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPagePublishedTime(parent)).toBe('2025-01-01T00:00:00.000Z')
+    })
+
+    it('Should get the time element inside the parent', () => {
+      document.body.innerHTML = `
+        <time>2025-01-01</time>
+        <section>
+          <time>2025-01-02</time>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPagePublishedTime(parent)).toBe('2025-01-02T00:00:00.000Z')
+    })
+
+    it('Should get the time element out of the parent when parent contains none', () => {
+      document.body.innerHTML = `
+        <time>2025-01-01</time>
+        <section>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPagePublishedTime(parent)).toBe('2025-01-01T00:00:00.000Z')
+    })
+
+    it('Should use element containing itemprop before others', () => {
+      document.body.innerHTML = `
+        <time>2025-01-02</time>
+        <div itemprop="datePublished">2025-01-02</div>
+        <section>
+          <time>2025-01-03</time>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPagePublishedTime(parent)).toBe('2025-01-02T00:00:00.000Z')
+    })
+
+    it('Should use element containing datetime if neither time or datePublished are present', () => {
+      document.body.innerHTML = `
+        <section>
+          <div datetime="2025-01-01"></div>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPagePublishedTime(parent)).toBe('2025-01-01T00:00:00.000Z')
+    })
+
+    it('Should return datetime attribute over text', () => {
+      document.body.innerHTML = `
+        <section>
+          <time datetime="2025-01-01">2025-01-02</time>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPagePublishedTime(parent)).toBe('2025-01-01T00:00:00.000Z')
+    })
+
+    it('Should return innertext if no datetime attribute is given', () => {
+      document.body.innerHTML = `
+        <section>
+          <time>2025-01-01</time>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPagePublishedTime(parent)).toBe('2025-01-01T00:00:00.000Z')
+    })
+
+    it('Should use meta tag before other elements', () => {
+      document.head.innerHTML = '<meta content="2025-01-01" property="article:published_time">'
+      document.body.innerHTML = `
+        <time>2025-01-02</time>
+        <div itemprop="datePublished">2025-01-03</div>
+        <section>
+          <time>2025-01-04</time>
+        </section>
+      `
+
+      const parent = /** @type {HTMLElement} */ (document.querySelector('section'))
+      expect(getPagePublishedTime(parent)).toBe('2025-01-01T00:00:00.000Z')
+    })
+  })
+})

package/src/typedefs.js

@@ -70,3 +70,11 @@
 /**
  * @typedef {{ x: number, y: number }} Position
  */
+
+/**
+ * @typedef {{ heading: string | null, modified_time: string | null, published_time: string | null }} ArticleMetaData
+ */
+
+/**
+ * @typedef {'en-US' | 'sv-SE'} LanguageCode
+ */