@simmalugnt-se/payload-content-health 0.8.0 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.9.0
+
+- New check `media.video-description-missing` (Accessibility), turned on per collection with
+  `videoDescription`: a video without a description, its text alternative, in a language. Reads
+  `description` by default, as in `@simmalugnt-se/payload-mux`.
+
 ## 0.8.0
 
 - The editor assistant (0.15.0 or later, with `extensions: { "content-health": true }`) reads the

package/README.md

@@ -27,6 +27,7 @@ Requires Payload `>=3.90.2 <4`, Next 16 and React 19. The widget uses Payload's
        collections: {
          pages: { seo: true },
          images: { altText: true },
+         videos: { videoDescription: true },
        },
      }),
    ];
@@ -41,6 +42,7 @@ Requires Payload `>=3.90.2 <4`, Next 16 and React 19. The widget uses Payload's
 | Check                       | Option             | Finds                                          |
 | --------------------------- | ------------------ | ---------------------------------------------- |
 | `media.alt-missing`         | `altText`          | Images (`image/*`) with an empty alt field     |
+| `media.video-description-missing` | `videoDescription` | Videos with an empty description (`description`, as in `@simmalugnt-se/payload-mux`) |
 | `seo.title-missing`         | `seo`              | Empty meta title                               |
 | `seo.title-length`          | `seo`              | Meta title outside 50–60 characters            |
 | `seo.title-duplicate`       | `seo`              | Meta title another document also uses          |

package/dist/categories.js

@@ -18,7 +18,7 @@ export const CATEGORY_CHECKS = {
         "links.broken",
     ],
     translations: ["content.untranslated"],
-    accessibility: ["media.alt-missing"],
+    accessibility: ["media.alt-missing", "media.video-description-missing"],
 };
 export function categoryOf(check) {
     return CATEGORY_IDS.find((id) => CATEGORY_CHECKS[id].includes(check));

package/dist/checks.js

@@ -18,6 +18,11 @@ export function rulesFor(options) {
         const field = (options.altText === true ? undefined : options.altText.field) ?? "alt";
         rules.push({ check: "media.alt-missing", kind: "required", path: field, imagesOnly: true });
     }
+    if (options.videoDescription) {
+        const field = (options.videoDescription === true ? undefined : options.videoDescription.field) ??
+            "description";
+        rules.push({ check: "media.video-description-missing", kind: "required", path: field });
+    }
     if (options.seo) {
         const seo = options.seo === true ? {} : options.seo;
         const title = seo.title ?? SEO_DEFAULTS.title;

package/dist/copy.js

@@ -4,6 +4,7 @@ export function uiLanguage(adminLanguage) {
 export const CHECK_LABELS = {
     en: {
         "media.alt-missing": "Missing alt text",
+        "media.video-description-missing": "Missing video description",
         "seo.title-missing": "Missing meta title",
         "seo.title-length": "Meta title length",
         "seo.title-duplicate": "Duplicate meta title",
@@ -20,6 +21,7 @@ export const CHECK_LABELS = {
     },
     sv: {
         "media.alt-missing": "Alt-text saknas",
+        "media.video-description-missing": "Videobeskrivning saknas",
         "seo.title-missing": "Metatitel saknas",
         "seo.title-length": "Metatitelns längd",
         "seo.title-duplicate": "Dubblerad metatitel",
@@ -98,6 +100,7 @@ export const COPY = {
 export const ASK = {
     en: {
         "media.alt-missing": () => "Write an alt text for this image.",
+        "media.video-description-missing": () => "Write a description of this video for readers who cannot see it.",
         "seo.title-missing": ({ range }) => range
             ? `Write a meta title for this page, ${range.min}–${range.max} characters.`
             : "Write a meta title for this page.",
@@ -130,6 +133,7 @@ export const ASK = {
     },
     sv: {
         "media.alt-missing": () => "Skriv en alt-text för den här bilden.",
+        "media.video-description-missing": () => "Skriv en beskrivning av den här videon för den som inte kan se den.",
         "seo.title-missing": ({ range }) => range
             ? `Skriv en metatitel för den här sidan, ${range.min}–${range.max} tecken.`
             : "Skriv en metatitel för den här sidan.",

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-export declare const CHECK_IDS: readonly ["media.alt-missing", "seo.title-missing", "seo.title-length", "seo.title-duplicate", "seo.description-missing", "seo.description-length", "seo.description-duplicate", "seo.image-missing", "content.h1-missing", "content.h1-multiple", "content.heading-skip", "content.thin", "links.broken", "content.untranslated"];
+export declare const CHECK_IDS: readonly ["media.alt-missing", "media.video-description-missing", "seo.title-missing", "seo.title-length", "seo.title-duplicate", "seo.description-missing", "seo.description-length", "seo.description-duplicate", "seo.image-missing", "content.h1-missing", "content.h1-multiple", "content.heading-skip", "content.thin", "links.broken", "content.untranslated"];
 export type CheckId = (typeof CHECK_IDS)[number];
 export type LengthRange = {
     min: number;
@@ -94,11 +94,20 @@ export type AltTextOptions = {
     /** Field holding the alt text. Default `alt`. */
     field?: string;
 };
+export type VideoDescriptionOptions = {
+    /** Field holding the description. Default `description`, as in `@simmalugnt-se/payload-mux`. */
+    field?: string;
+};
 export type CollectionHealthOptions = {
     /** SEO checks on the fields `@payloadcms/plugin-seo` adds, or the paths given here. */
     seo?: boolean | SeoOptions;
     /** Alt text on images in an upload collection. Files that are not images are skipped. */
     altText?: boolean | AltTextOptions;
+    /**
+     * A description on every video, its text alternative for readers who cannot see it, as an alt
+     * text is for an image. For a videos collection such as `@simmalugnt-se/payload-mux`'s.
+     */
+    videoDescription?: boolean | VideoDescriptionOptions;
     /** Heading structure and thin content, read from the page body. */
     content?: ContentOptions;
     /**

package/dist/types.js

@@ -1,5 +1,6 @@
 export const CHECK_IDS = [
     "media.alt-missing",
+    "media.video-description-missing",
     "seo.title-missing",
     "seo.title-length",
     "seo.title-duplicate",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simmalugnt-se/payload-content-health",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Content health checks and dashboard widgets for Payload Admin: alt texts, SEO fields and more",
   "keywords": [
     "payload",