@yuktishaalaa/a11y 0.0.0-stage → 6.0.0

package/dist/report.d.ts

@@ -0,0 +1,35 @@
+export type FindingStatus = "fixed" | "check" | "unknown";
+export interface Finding {
+    rule: RuleId;
+    status: FindingStatus;
+    /** WCAG 2.2 success criterion, e.g. "1.4.3"; "" when none applies. */
+    wcag: string;
+    /** Short CSS-like path to the element, for people. */
+    where: string;
+    /** Values for the message, e.g. { ratio: 3.1, required: 4.5 }. */
+    data?: Record<string, string | number>;
+    /** The element itself (not serializable). */
+    el?: Element;
+}
+export interface Report {
+    level: "off" | "AA" | "AAA";
+    mode: "auto" | "check" | "off";
+    fixed: Finding[];
+    check: Finding[];
+    unknown: Finding[];
+    /** Elements looked at. */
+    scanned: number;
+    /** ISO time of the run. */
+    at: string;
+}
+export type RuleId = "page-lang-missing" | "page-lang-mismatch" | "part-lang-missing" | "contrast" | "contrast-unknown" | "img-alt-missing" | "control-name-missing" | "fake-button" | "clickable-not-focusable" | "field-label-missing" | "heading-skip" | "h1-count" | "link-text-vague" | "iframe-title-missing" | "iframe-cross-origin" | "table-headers-missing" | "media-autoplay" | "tabindex-positive" | "aria-hidden-focusable" | "main-landmark-missing" | "closed-shadow-root";
+export declare const WCAG: Record<RuleId, string>;
+type Lang = "en" | "te";
+/** Message templates. {name} is filled from Finding.data. */
+export declare const MESSAGES: Record<Lang, Record<RuleId, string>>;
+export declare function message(f: Finding, lang?: Lang): string;
+/** A short path for people: tag#id.class (up to 3 levels). */
+export declare function describe(el: Element): string;
+/** Report without element references, safe for JSON and postMessage. */
+export declare function toJSON(r: Report): Omit<Report, "fixed" | "check" | "unknown"> & Record<FindingStatus, Omit<Finding, "el">[]>;
+export {};

package/dist/speak.d.ts

@@ -0,0 +1,37 @@
+import { type Segment } from "./language";
+export interface SpeakOptions {
+    /** Language to assume where the text gives no clue. Default: the element's `lang`, else the page's, else "en". */
+    lang?: string;
+    /** 0.5–2. Default 1. */
+    rate?: number;
+    /** Called once per language the device cannot speak. */
+    onMissingVoice?: (lang: string) => void;
+    /** Called when everything has been read, or reading stopped. */
+    onEnd?: () => void;
+    /** Called before each part is read. */
+    onPart?: (part: Segment, index: number, total: number) => void;
+}
+export interface Speaker {
+    pause(): void;
+    resume(): void;
+    stop(): void;
+    readonly parts: Segment[];
+}
+/** True when this browser can read aloud at all. */
+export declare const canSpeak: () => boolean;
+/** The device's voices. Some browsers load them late; waits up to `timeoutMs`. */
+export declare function getVoices(timeoutMs?: number): Promise<SpeechSynthesisVoice[]>;
+/**
+ * The best voice for a language: exact region ("te-IN"), then the same
+ * language in any region ("te"), local voices before network ones. Null when
+ * the device has none — then the caller must not read that part.
+ */
+export declare function pickVoice(lang: string, voices: SpeechSynthesisVoice[]): SpeechSynthesisVoice | null;
+/** Languages the device can read, e.g. ["en", "hi", "te"]. */
+export declare function speakableLanguages(): Promise<string[]>;
+/** Cuts text into sentences of at most `max` characters (Telugu, Hindi and English stops). */
+export declare function sentences(text: string, max?: number): string[];
+/** The readable text of an element, without typing areas, code or switched-off parts. */
+export declare function readableText(el: Element): string;
+/** Reads text (or an element's text) aloud, part by part, each in its own language. */
+export declare function speak(target: string | Element, options?: SpeakOptions): Speaker;

package/dist/speakButtons.d.ts

@@ -0,0 +1,6 @@
+export interface SpeakButtonsOptions {
+    /** Called when a language has no voice on this device. */
+    onMissingVoice?: (lang: string, message: string) => void;
+}
+/** Adds the buttons; returns a function that removes them. */
+export declare function addSpeakButtons(doc: Document, opts?: SpeakButtonsOptions): () => void;

package/package.json

@@ -1,6 +1,71 @@
 {
   "name": "@yuktishaalaa/a11y",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "6.0.0",
+  "description": "Web accessibility for any page, in the browser: safe ARIA, WCAG AA/AAA contrast, automatic lang for every part, read aloud in the right voice, visitor preferences. One attribute, no server.",
+  "author": "Sandeep Miriyala — Yuktishaalaa AI Lab",
+  "license": "GPL-3.0-only",
+  "homepage": "https://sandeep-miriyala.github.io/yuktai/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sandeep-miriyala/yuktai.git",
+    "directory": "packages/a11y"
+  },
+  "bugs": {
+    "url": "https://github.com/sandeep-miriyala/yuktai/issues"
+  },
+  "keywords": [
+    "accessibility",
+    "a11y",
+    "wcag",
+    "aria",
+    "contrast",
+    "lang",
+    "text-to-speech",
+    "web-speech",
+    "telugu",
+    "indic",
+    "screen-reader"
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "unpkg": "./dist/a11y.global.js",
+  "jsdelivr": "./dist/a11y.global.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./global": "./dist/a11y.global.js",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": [
+    "./dist/a11y.global.js"
+  ],
+  "scripts": {
+    "build": "tsup && npm run build:types",
+    "build:types": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "happy-dom": "^21.0.4",
+    "tsup": "^9.0.0",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.5"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}