@octaviaflow/accessibility-checker 1.0.0 → 1.1.2

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@octaviaflow/accessibility-checker",
-  "version": "1.0.0",
+  "version": "1.1.2",
   "license": "Apache-2.0",
+  "type": "module",
   "description": "Accessibility checker for OctaviaFlow Design System - A custom implementation",
   "main": "cjs/index.js",
   "module": "mjs/index.js",
@@ -27,13 +28,20 @@
   "bugs": "https://github.com/OctaviaFlow/OctaviaFlow-Design-System/issues",
   "scripts": {
     "clean": "rimraf cjs mjs types",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:mjs": "tsc -p tsconfig.mjs.json",
-    "build:types": "tsc -p tsconfig.types.json",
-    "build": "yarn clean && yarn build:cjs && yarn build:mjs && yarn build:types",
-    "test": "vitest",
-    "ci-check": "yarn build && yarn test",
-    "start": "node ./cjs/index.js --sample"
+    "build:cjs": "bun x tsc -p tsconfig.cjs.json",
+    "build:mjs": "bun x tsc -p tsconfig.mjs.json",
+    "build:types": "bun x tsc -p tsconfig.types.json",
+    "build": "bun run clean && bun run build:cjs && bun run build:mjs && bun run build:types",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix",
+    "format": "prettier --write src/**/*.{ts,js,json}",
+    "format:check": "prettier --check src/**/*.{ts,js,json}",
+    "ci-check": "bun run build && bun run test && bun run lint && echo \"✓ Done\"",
+    "start": "node ./cjs/index.js --sample",
+    "dev": "bun run build && bun run start",
+    "prepublishOnly": "bun run build"
   },
   "keywords": [
     "octaviaflow",
@@ -51,18 +59,30 @@
     "exceljs": "^4.3.0",
     "js-yaml": "^4.1.0",
     "jsdom": "^27.1.0",
+    "minimist": "^1.2.8",
     "puppeteer": "^24.29.1",
-    "string-hash": "^1.1.3"
+    "string-hash": "^1.1.3",
+    "chalk": "^5.3.0",
+    "ora": "^8.1.1"
   },
   "devDependencies": {
     "@types/jsdom": "^27.0.0",
-    "@types/node": "^24.10.0",
-    "eslint": "^9.31.1",
-    "jest": "^30.2.0",
+    "@types/minimist": "^1.2.5",
+    "@types/node": "^20.0.0",
+    "@eslint/js": "^9.39.1",
+    "@typescript-eslint/eslint-plugin": "^8.46.4",
+    "@typescript-eslint/parser": "^8.46.4",
+    "eslint": "^9.39.1",
+    "eslint-config-octaviaflow": "^2.0.0",
+    "jest": "^29.7.0",
+    "jest-config-octaviaflow": "^1.1.1",
+    "prettier": "^3.6.2",
+    "prettier-config-octaviaflow": "^1.1.2",
     "rimraf": "^6.0.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.8"
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.3",
+    "typescript-config-octaviaflow": "^1.1.1",
+    "vitest": "^2.1.8"
   },
   "bin": {
     "octaviaflow-achecker": "bin/achecker.js"

package/types/checker/index.d.ts

@@ -1,3 +1,4 @@
+import * as axe from 'axe-core';
 export type Issue = {
     type: string;
     message: string;
@@ -5,6 +6,12 @@ export type Issue = {
     helpUrl?: string;
     source?: string;
 };
+export interface ResultMeta {
+    timestamp: string;
+    source: string;
+    format?: string;
+    version?: string;
+}
 export type Result = {
     summary: {
         totalIssues: number;
@@ -12,7 +19,9 @@ export type Result = {
         axeViolations?: number;
     };
     issues: Issue[];
-    axe?: any;
-    meta?: any;
+    axe?: axe.AxeResults | {
+        error: string;
+    };
+    meta?: ResultMeta;
 };
 export declare function analyze(html: string): Promise<Result>;

package/types/index.d.ts

@@ -0,0 +1,16 @@
+export { analyze } from './checker/index.js';
+export { saveReport } from './storage/reportWriter.js';
+export type { Issue, Result, ResultMeta } from './checker/index.js';
+export interface CliOptions {
+    input?: string;
+    i?: string;
+    output?: string;
+    o?: string;
+    sample?: boolean;
+    format?: 'json' | 'html' | 'csv' | 'excel';
+    verbose?: boolean;
+    v?: boolean;
+    help?: boolean;
+    h?: boolean;
+}
+export declare function main(args?: string[]): Promise<void>;

package/types/storage/reportWriter.d.ts

@@ -0,0 +1,3 @@
+import { Result } from '../checker/index.js';
+export type OutputFormat = 'json' | 'html' | 'csv' | 'excel';
+export declare function saveReport(result: Result, filePath: string, format?: OutputFormat): Promise<void>;

package/types/utils/wcag-rules.d.ts

@@ -0,0 +1,10 @@
+export interface WCAGRule {
+    id: string;
+    level: 'A' | 'AA' | 'AAA';
+    principle: 'perceivable' | 'operable' | 'understandable' | 'robust';
+    guideline: string;
+    description: string;
+    helpUrl: string;
+}
+export declare const WCAG_RULES: Record<string, WCAGRule>;
+export declare function getWCAGRule(ruleId: string): WCAGRule | undefined;