@sweberdev/witness 0.1.0 → 0.2.0

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 export { D as Disclosure, a as DisclosureEvent, b as DisclosureOptions, c as DisclosureStorage, d as createDisclosure, m as memoryStorage } from './disclosure-C7Y_uY73.js';
 import { D as DisclosureKind, L as LocaleOverride, b as DisclosureText, c as LocaleMessages, a as MarkingInput, M as Marking, S as SourceType } from './types-WWHzrNlc.js';
 export { C as ContentKind, d as DISCLOSURE_KINDS, U as UiText } from './types-WWHzrNlc.js';
-export { I as ImageFormat, a as ImageMarkingInfo, M as MarkImageOptions, b as MarkImageResult, c as buildXmp, d as detectImageFormat, m as markImage, r as readImageMarking } from './image-B7YvdITx.js';
+import { I as ImageFormat, M as MarkImageOptions, a as ImageMarkingInfo } from './image-B7YvdITx.js';
+export { b as MarkImageResult, c as buildXmp, d as detectImageFormat, m as markImage, r as readImageMarking } from './image-B7YvdITx.js';
 
 /** The locales bundled with the free package. */
 declare const BUILT_IN_LOCALES: readonly ["en", "de", "fr", "it"];
@@ -80,6 +81,48 @@ declare function labelText(input: Marking | MarkingInput, options?: Pick<LabelHt
 declare function generatorName(m: Pick<Marking, "generator" | "generatorVersion">): string;
 declare function escapeHtml(value: string): string;
 
+/**
+ * Machine-readable AI marking for audio and video: the same XMP packet as for images, with the
+ * IPTC Digital Source Type, written where the XMP specification puts it for each container.
+ *
+ * - MP3: an ID3v2 `PRIV` frame with the owner `XMP`.
+ * - WAV: a RIFF `_PMX` chunk.
+ * - MP4, MOV and M4A: a top-level `uuid` box with the XMP UUID, appended at the end of the file
+ *   so no sample offsets move.
+ *
+ * The audio and video data is not touched. Files that carry a C2PA manifest are left unchanged
+ * by default, as for images.
+ */
+
+type MediaFormat = "mp3" | "wav" | "mp4";
+type MarkMediaOptions = MarkImageOptions;
+interface MarkMediaResult {
+    bytes: Uint8Array;
+    status: "marked" | "skipped-c2pa" | "unsupported";
+    format: MediaFormat | null;
+}
+interface MediaMarkingInfo extends Omit<ImageMarkingInfo, "format"> {
+    format: MediaFormat | null;
+}
+interface MarkFileResult {
+    bytes: Uint8Array;
+    status: "marked" | "skipped-c2pa" | "unsupported";
+    format: ImageFormat | MediaFormat | null;
+}
+interface MarkingInfo extends Omit<ImageMarkingInfo, "format"> {
+    format: ImageFormat | MediaFormat | null;
+}
+/** Detects MP3, WAV or an ISO media file (MP4, MOV, M4A) from the first bytes. */
+declare function detectMediaFormat(bytes: Uint8Array): MediaFormat | null;
+/** Writes the marking as XMP into an MP3, WAV, MP4, MOV or M4A file. */
+declare function markMedia(bytes: Uint8Array, input?: Marking | MarkingInput, options?: MarkMediaOptions): MarkMediaResult;
+/** Reads the AI marking of an audio or video file, whoever wrote it. */
+declare function readMediaMarking(bytes: Uint8Array): MediaMarkingInfo;
+/** Marks an image, audio or video file, whichever it is. */
+declare function markFile(bytes: Uint8Array, input?: Marking | MarkingInput, options?: MarkMediaOptions): MarkFileResult;
+/** Reads the AI marking of an image, audio or video file. */
+declare function readMarking(bytes: Uint8Array): MarkingInfo;
+
 /**
  * An invisible, machine-readable marker for AI-generated text.
  *
@@ -121,4 +164,4 @@ declare function hasTextWatermark(text: string): boolean;
  */
 declare function stripTextWatermark(text: string): string;
 
-export { BUILT_IN_LOCALES, DisclosureKind, DisclosureText, type LabelHtmlOptions, LocaleMessages, LocaleOverride, Marking, MarkingInput, type ReadTextWatermark, SourceType, type TextWatermark, createMarking, disclosureText, escapeHtml, format, generatorName, getMessages, hasTextWatermark, iptcSourceType, isAiSourceType, labelHtml, labelText, markingAttributes, markingJsonLd, markingMetaTags, nextMetadata, parseSourceType, readTextWatermark, registerLocale, registeredLocales, renderJsonLd, renderMetaTags, resolveLocale, schemaOrgSourceType, stripTextWatermark, watermarkSuffix, watermarkText };
+export { BUILT_IN_LOCALES, DisclosureKind, DisclosureText, ImageFormat, ImageMarkingInfo, type LabelHtmlOptions, LocaleMessages, LocaleOverride, type MarkFileResult, MarkImageOptions, type MarkMediaOptions, type MarkMediaResult, Marking, type MarkingInfo, MarkingInput, type MediaFormat, type MediaMarkingInfo, type ReadTextWatermark, SourceType, type TextWatermark, createMarking, detectMediaFormat, disclosureText, escapeHtml, format, generatorName, getMessages, hasTextWatermark, iptcSourceType, isAiSourceType, labelHtml, labelText, markFile, markMedia, markingAttributes, markingJsonLd, markingMetaTags, nextMetadata, parseSourceType, readMarking, readMediaMarking, readTextWatermark, registerLocale, registeredLocales, renderJsonLd, renderMetaTags, resolveLocale, schemaOrgSourceType, stripTextWatermark, watermarkSuffix, watermarkText };

package/dist/index.js

@@ -1,3 +1,10 @@
+import {
+  detectMediaFormat,
+  markFile,
+  markMedia,
+  readMarking,
+  readMediaMarking
+} from "./chunk-F7OWVTCS.js";
 import {
   buildXmp,
   createMarking,
@@ -23,7 +30,7 @@ import {
   stripTextWatermark,
   watermarkSuffix,
   watermarkText
-} from "./chunk-APXU3MTX.js";
+} from "./chunk-GXMGYIOK.js";
 import {
   DISCLOSURE_KINDS,
   createDisclosure,
@@ -45,6 +52,7 @@ export {
   createDisclosure,
   createMarking,
   detectImageFormat,
+  detectMediaFormat,
   disclosureText,
   escapeHtml,
   format,
@@ -55,7 +63,9 @@ export {
   isAiSourceType,
   labelHtml,
   labelText,
+  markFile,
   markImage,
+  markMedia,
   markingAttributes,
   markingJsonLd,
   markingMetaTags,
@@ -63,6 +73,8 @@ export {
   nextMetadata,
   parseSourceType,
   readImageMarking,
+  readMarking,
+  readMediaMarking,
   readTextWatermark,
   registerLocale,
   registeredLocales,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sweberdev/witness",
-  "version": "0.1.0",
-  "description": "AI transparency kit for Article 50 of the EU AI Act: chatbot notices, AI labels in DE/EN/FR/IT, IPTC/XMP marking for images, an invisible text watermark and Vercel AI SDK middleware.",
+  "version": "0.2.0",
+  "description": "AI transparency kit for Article 50 of the EU AI Act: chatbot notices, AI labels in DE/EN/FR/IT, IPTC/XMP marking for images, audio and video, an invisible text watermark and Vercel AI SDK middleware.",
   "license": "MIT",
   "author": "Seya Weber (https://github.com/sxwxbxr)",
   "homepage": "https://packages.sweber.dev/witness/docs",

package/src/cli.ts

@@ -1,8 +1,9 @@
 import { mkdir, readFile, writeFile } from "node:fs/promises";
 import { basename, extname, join } from "node:path";
 import { parseArgs } from "node:util";
-import { detectImageFormat, markImage, readImageMarking } from "./image.js";
+import { detectImageFormat } from "./image.js";
 import { iptcSourceType } from "./marking.js";
+import { detectMediaFormat, markFile, readMarking } from "./media.js";
 import type { ContentKind, MarkingInput } from "./types.js";
 import { readTextWatermark } from "./watermark.js";
 
@@ -11,7 +12,7 @@ export interface CliIo {
   err: (line: string) => void;
 }
 
-const HELP = `witness: AI Act Article 50 marking for images and text
+const HELP = `witness: AI Act Article 50 marking for images, audio, video and text
 
 Usage
   witness mark <files...> (--out <dir> | --in-place) [options]
@@ -30,7 +31,8 @@ inspect options
   --json                     one JSON object per file
   --require                  exit 1 if a file carries no AI marking
 
-Images: PNG, JPEG, WebP (XMP with IPTC Digital Source Type).
+Images: PNG, JPEG, WebP. Audio and video: MP3, WAV, MP4, MOV, M4A.
+All get XMP with the IPTC Digital Source Type.
 Text files are checked for the Witness text watermark.`;
 
 const KINDS: ContentKind[] = ["generated", "edited", "deepfake"];
@@ -86,11 +88,11 @@ async function mark(argv: string[], io: CliIo): Promise<number> {
   let failed = 0;
   for (const file of positionals) {
     const bytes = new Uint8Array(await readFile(file));
-    const result = markImage(bytes, input, {
+    const result = markFile(bytes, input, {
       c2pa: values["overwrite-c2pa"] ? "overwrite" : "skip",
     });
     if (result.status === "unsupported") {
-      io.err(`${file}: not a PNG, JPEG or WebP file, skipped`);
+      io.err(`${file}: not a PNG, JPEG, WebP, MP3, WAV or MP4 file, skipped`);
       failed++;
       continue;
     }
@@ -115,9 +117,9 @@ async function inspect(argv: string[], io: CliIo): Promise<number> {
   let unmarked = 0;
   for (const file of positionals) {
     const bytes = new Uint8Array(await readFile(file));
-    const format = detectImageFormat(bytes);
+    const format = detectImageFormat(bytes) ?? detectMediaFormat(bytes);
     if (format) {
-      const info = readImageMarking(bytes);
+      const info = readMarking(bytes);
       const marked = info.aiGenerated || info.c2pa;
       if (!marked) unmarked++;
       if (values.json) {

package/src/elements.ts

@@ -103,6 +103,8 @@ export class WitnessNoticeElement extends BaseElement {
   #disclosure: Disclosure | null = null;
   #unsubscribe: (() => void) | null = null;
   #expanded = false;
+  /** `id@version` of the disclosure a `shown` event was sent for, so attribute changes don't repeat it. */
+  #shownFor: string | null = null;
 
   connectedCallback(): void {
     if (!this.shadowRoot) this.attachShadow({ mode: "open" });
@@ -114,7 +116,8 @@ export class WitnessNoticeElement extends BaseElement {
     this.#unsubscribe = null;
   }
 
-  attributeChangedCallback(): void {
+  attributeChangedCallback(_name: string, oldValue: string | null, newValue: string | null): void {
+    if (oldValue === newValue) return;
     if (this.isConnected && this.shadowRoot) this.#setup();
   }
 
@@ -189,7 +192,11 @@ export class WitnessNoticeElement extends BaseElement {
         ),
       );
       root.replaceChildren(style, box);
-      disclosure.markShown();
+      const shownFor = `${disclosure.id}@${disclosure.version}`;
+      if (this.#shownFor !== shownFor) {
+        this.#shownFor = shownFor;
+        disclosure.markShown();
+      }
     } else {
       const reopen = h(
         doc,

package/src/image.ts

@@ -50,7 +50,8 @@ export interface ImageMarkingInfo {
 }
 
 const XMP_NS = "http://ns.adobe.com/xap/1.0/\0";
-const WITNESS_NS = "https://packages.sweber.dev/witness/ns/1.0/";
+/** @internal */
+export const WITNESS_NS = "https://packages.sweber.dev/witness/ns/1.0/";
 
 /** Detects PNG, JPEG or WebP from the first bytes. */
 export function detectImageFormat(bytes: Uint8Array): ImageFormat | null {
@@ -165,8 +166,8 @@ function buildDescription(m: Marking): string {
     : `<rdf:Description${attrs}/>`;
 }
 
-/** Reads a simple property in attribute or element form. */
-function xmpProperty(xmp: string, name: string): string | undefined {
+/** Reads a simple property in attribute or element form. @internal */
+export function xmpProperty(xmp: string, name: string): string | undefined {
   const escaped = name.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
   const attribute = new RegExp(`${escaped}="([^"]*)"`).exec(xmp);
   if (attribute?.[1] !== undefined) return unescapeXml(attribute[1]);

package/src/index.ts

@@ -43,6 +43,19 @@ export {
   renderMetaTags,
   schemaOrgSourceType,
 } from "./marking.js";
+export {
+  detectMediaFormat,
+  type MarkFileResult,
+  type MarkingInfo,
+  type MarkMediaOptions,
+  type MarkMediaResult,
+  type MediaFormat,
+  type MediaMarkingInfo,
+  markFile,
+  markMedia,
+  readMarking,
+  readMediaMarking,
+} from "./media.js";
 export {
   type ContentKind,
   DISCLOSURE_KINDS,