@elementor/editor-audits 4.3.0-1036

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# @elementor/editor-audits
+
+## 4.3.0
+
+- Initial release. On-demand page audit panel with a scanner audits.

package/dist/index.d.mts

@@ -0,0 +1,122 @@
+declare function init(): void;
+
+type Audit = {
+    id: string;
+    title: string;
+    description: string;
+    fixHint: string;
+    categories: AuditCategory[];
+    severity: AuditSeverity;
+    weight: number;
+    evaluate: (ctx: AuditContext) => AuditResult | Promise<AuditResult>;
+};
+type AuditCategory = 'best-practices' | 'seo' | 'accessibility' | 'performance' | 'compliance';
+type AuditSeverity = 'error' | 'warning' | 'info';
+type AuditMeta = Omit<Audit, 'evaluate'>;
+type AuditRun = {
+    audit: AuditMeta;
+    result: AuditResult;
+};
+type AuditFailMetadata = {
+    missingAltImageCount?: number;
+    oversizedImageCount?: number;
+};
+type AuditResult = {
+    status: 'pass';
+} | {
+    status: 'fail';
+    violations: AuditViolation[];
+    metadata?: AuditFailMetadata;
+} | {
+    status: 'skipped';
+    reason: string;
+};
+type AuditViolation = {
+    auditId: string;
+    elementId?: string;
+    targetHint?: 'page-settings' | 'site-settings' | 'site-identity-settings' | 'element-settings';
+    externalUrl?: string;
+    label: string;
+    detail?: string;
+    angieFix?: boolean;
+};
+type PageContextResponse = {
+    post_title: string | null;
+    post_excerpt: string | null;
+    featured_image_id: number | null;
+    image_sizes: Record<number, {
+        width: number;
+        height: number;
+        filesize_bytes: number;
+        mime: string;
+        src: string;
+        alt: string;
+    }>;
+    kit_id: number;
+    kit_is_default_unchanged: boolean;
+    is_noindex: boolean;
+    reading_settings_url: string;
+    privacy_policy_url: string | null;
+    privacy_settings_url: string;
+    ally_plugin_active: boolean;
+    ally_plugin_url: string;
+    cookiez_plugin_active: boolean;
+    cookiez_plugin_url: string;
+    image_optimization_plugin_active: boolean;
+    image_optimization_plugin_url: string;
+    site_identity: {
+        site_name_set: boolean;
+        site_description_set: boolean;
+        site_logo_set: boolean;
+        site_favicon_set: boolean;
+    };
+};
+type ElementSnapshotNode = {
+    id: string;
+    elType: string;
+    widgetType?: string;
+    settings: Record<string, unknown>;
+    elements: ElementSnapshotNode[];
+};
+type ElementsModelSnapshot = {
+    documentId: number;
+    tree: ElementSnapshotNode[];
+};
+type KitSnapshot = {
+    id: number;
+    globals: {
+        colors: Array<{
+            id: string;
+            value: string;
+            title: string;
+        }>;
+        fonts: Array<{
+            id: string;
+            value: string;
+            title: string;
+        }>;
+    };
+};
+type AuditContext = {
+    documentId: number;
+    elements: ElementsModelSnapshot;
+    pageContext: PageContextResponse;
+    kit: KitSnapshot;
+};
+type PageAuditReport = {
+    documentId: number;
+    runAt: number;
+    overall: number;
+    categories: Record<AuditCategory, {
+        score: number;
+        failed: number;
+        total: number;
+    }>;
+    auditResults: AuditRun[];
+};
+
+declare function registerAudit(audit: Audit): void;
+
+declare function runPageAudit(documentId: number): Promise<PageAuditReport>;
+
+export { type Audit, type AuditCategory, type AuditContext, type AuditMeta, type AuditResult, type AuditRun, type AuditSeverity, type AuditViolation, type PageAuditReport, init, registerAudit, runPageAudit };

package/dist/index.d.ts

@@ -0,0 +1,122 @@
+declare function init(): void;
+
+type Audit = {
+    id: string;
+    title: string;
+    description: string;
+    fixHint: string;
+    categories: AuditCategory[];
+    severity: AuditSeverity;
+    weight: number;
+    evaluate: (ctx: AuditContext) => AuditResult | Promise<AuditResult>;
+};
+type AuditCategory = 'best-practices' | 'seo' | 'accessibility' | 'performance' | 'compliance';
+type AuditSeverity = 'error' | 'warning' | 'info';
+type AuditMeta = Omit<Audit, 'evaluate'>;
+type AuditRun = {
+    audit: AuditMeta;
+    result: AuditResult;
+};
+type AuditFailMetadata = {
+    missingAltImageCount?: number;
+    oversizedImageCount?: number;
+};
+type AuditResult = {
+    status: 'pass';
+} | {
+    status: 'fail';
+    violations: AuditViolation[];
+    metadata?: AuditFailMetadata;
+} | {
+    status: 'skipped';
+    reason: string;
+};
+type AuditViolation = {
+    auditId: string;
+    elementId?: string;
+    targetHint?: 'page-settings' | 'site-settings' | 'site-identity-settings' | 'element-settings';
+    externalUrl?: string;
+    label: string;
+    detail?: string;
+    angieFix?: boolean;
+};
+type PageContextResponse = {
+    post_title: string | null;
+    post_excerpt: string | null;
+    featured_image_id: number | null;
+    image_sizes: Record<number, {
+        width: number;
+        height: number;
+        filesize_bytes: number;
+        mime: string;
+        src: string;
+        alt: string;
+    }>;
+    kit_id: number;
+    kit_is_default_unchanged: boolean;
+    is_noindex: boolean;
+    reading_settings_url: string;
+    privacy_policy_url: string | null;
+    privacy_settings_url: string;
+    ally_plugin_active: boolean;
+    ally_plugin_url: string;
+    cookiez_plugin_active: boolean;
+    cookiez_plugin_url: string;
+    image_optimization_plugin_active: boolean;
+    image_optimization_plugin_url: string;
+    site_identity: {
+        site_name_set: boolean;
+        site_description_set: boolean;
+        site_logo_set: boolean;
+        site_favicon_set: boolean;
+    };
+};
+type ElementSnapshotNode = {
+    id: string;
+    elType: string;
+    widgetType?: string;
+    settings: Record<string, unknown>;
+    elements: ElementSnapshotNode[];
+};
+type ElementsModelSnapshot = {
+    documentId: number;
+    tree: ElementSnapshotNode[];
+};
+type KitSnapshot = {
+    id: number;
+    globals: {
+        colors: Array<{
+            id: string;
+            value: string;
+            title: string;
+        }>;
+        fonts: Array<{
+            id: string;
+            value: string;
+            title: string;
+        }>;
+    };
+};
+type AuditContext = {
+    documentId: number;
+    elements: ElementsModelSnapshot;
+    pageContext: PageContextResponse;
+    kit: KitSnapshot;
+};
+type PageAuditReport = {
+    documentId: number;
+    runAt: number;
+    overall: number;
+    categories: Record<AuditCategory, {
+        score: number;
+        failed: number;
+        total: number;
+    }>;
+    auditResults: AuditRun[];
+};
+
+declare function registerAudit(audit: Audit): void;
+
+declare function runPageAudit(documentId: number): Promise<PageAuditReport>;
+
+export { type Audit, type AuditCategory, type AuditContext, type AuditMeta, type AuditResult, type AuditRun, type AuditSeverity, type AuditViolation, type PageAuditReport, init, registerAudit, runPageAudit };