@openbrf/plugin-sdk 0.0.0-stage → 1.2.0

package/dist/catalog.d.ts

@@ -0,0 +1,707 @@
+import { z } from "zod";
+import type { PluginFindingDetail } from "./findings.ts";
+/** A tarball and the digest its bytes must hash to. */
+export declare const catalogArtifactSchema: z.ZodObject<{
+    url: z.ZodString;
+    sha512: z.ZodString;
+    bytes: z.ZodOptional<z.ZodInt>;
+}, z.core.$strict>;
+export type CatalogArtifact = z.infer<typeof catalogArtifactSchema>;
+export type { LocalizedText } from "./localized-text.ts";
+/**
+ * An extension point as the index lists it: the manifest's fields, and the
+ * curator's title and description in both languages.
+ *
+ * The text is the curator's rather than the plugin's own, as an entry's `name`
+ * is, because an addon's consent screen has to name the point before the host
+ * plugin's locale files exist on the instance (ADR 0030).
+ */
+export declare const catalogExtensionPointSchema: z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodInt;
+    personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        account: "account";
+        apartment: "apartment";
+        auditTrail: "auditTrail";
+        email: "email";
+        financial: "financial";
+        freeText: "freeText";
+        health: "health";
+        name: "name";
+        personalIdentityNumber: "personalIdentityNumber";
+        phone: "phone";
+        photograph: "photograph";
+        postalAddress: "postalAddress";
+        protected: "protected";
+        residency: "residency";
+    }>>>;
+    title: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    description: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export type CatalogExtensionPoint = z.infer<typeof catalogExtensionPointSchema>;
+export declare const catalogPluginEntrySchema: z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodString;
+    name: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    description: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    artifact: z.ZodObject<{
+        url: z.ZodString;
+        sha512: z.ZodString;
+        bytes: z.ZodOptional<z.ZodInt>;
+    }, z.core.$strict>;
+    homepage: z.ZodOptional<z.ZodString>;
+    deprecated: z.ZodDefault<z.ZodBoolean>;
+    type: z.ZodLiteral<"plugin">;
+    packageName: z.ZodString;
+    apiVersion: z.ZodInt;
+    permissions: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        "addressBook:proposeImport": "addressBook:proposeImport";
+        "addressBook:read": "addressBook:read";
+        "addressBook:readContact": "addressBook:readContact";
+        "addresses:read": "addresses:read";
+        "bookings:readAvailability": "bookings:readAvailability";
+        "calendar:read": "calendar:read";
+        "finances:read": "finances:read";
+        "finances:recordDelivery": "finances:recordDelivery";
+        "jobs:schedule": "jobs:schedule";
+        "mail:send": "mail:send";
+        "media:read": "media:read";
+        "news:read": "news:read";
+        "site:blocks": "site:blocks";
+        "sms:send": "sms:send";
+        "themes:install": "themes:install";
+    }>>>;
+    personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        account: "account";
+        apartment: "apartment";
+        auditTrail: "auditTrail";
+        email: "email";
+        financial: "financial";
+        freeText: "freeText";
+        health: "health";
+        name: "name";
+        personalIdentityNumber: "personalIdentityNumber";
+        phone: "phone";
+        photograph: "photograph";
+        postalAddress: "postalAddress";
+        protected: "protected";
+        residency: "residency";
+    }>>>;
+    actions: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        capability: z.ZodString;
+        effect: z.ZodEnum<{
+            delete: "delete";
+            read: "read";
+            write: "write";
+        }>;
+        personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            account: "account";
+            apartment: "apartment";
+            auditTrail: "auditTrail";
+            email: "email";
+            financial: "financial";
+            freeText: "freeText";
+            health: "health";
+            name: "name";
+            personalIdentityNumber: "personalIdentityNumber";
+            phone: "phone";
+            photograph: "photograph";
+            postalAddress: "postalAddress";
+            protected: "protected";
+            residency: "residency";
+        }>>>;
+        surfaces: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            ai: "ai";
+            mcp: "mcp";
+            ui: "ui";
+        }>>>;
+    }, z.core.$strict>>>;
+    oauthProtectedResource: z.ZodOptional<z.ZodString>;
+    extensionPoints: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodInt;
+        personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            account: "account";
+            apartment: "apartment";
+            auditTrail: "auditTrail";
+            email: "email";
+            financial: "financial";
+            freeText: "freeText";
+            health: "health";
+            name: "name";
+            personalIdentityNumber: "personalIdentityNumber";
+            phone: "phone";
+            photograph: "photograph";
+            postalAddress: "postalAddress";
+            protected: "protected";
+            residency: "residency";
+        }>>>;
+        title: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+        description: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+    }, z.core.$strict>>>;
+    extends: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        plugin: z.ZodString;
+        point: z.ZodString;
+        version: z.ZodInt;
+        personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            account: "account";
+            apartment: "apartment";
+            auditTrail: "auditTrail";
+            email: "email";
+            financial: "financial";
+            freeText: "freeText";
+            health: "health";
+            name: "name";
+            personalIdentityNumber: "personalIdentityNumber";
+            phone: "phone";
+            photograph: "photograph";
+            postalAddress: "postalAddress";
+            protected: "protected";
+            residency: "residency";
+        }>>>;
+    }, z.core.$strict>>>;
+    recipients: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        origin: z.ZodString;
+        purpose: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+        personalData: z.ZodArray<z.ZodEnum<{
+            account: "account";
+            apartment: "apartment";
+            auditTrail: "auditTrail";
+            email: "email";
+            financial: "financial";
+            freeText: "freeText";
+            health: "health";
+            name: "name";
+            personalIdentityNumber: "personalIdentityNumber";
+            phone: "phone";
+            photograph: "photograph";
+            postalAddress: "postalAddress";
+            protected: "protected";
+            residency: "residency";
+        }>>;
+    }, z.core.$strict>>>;
+    deviceRoutes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        path: z.ZodString;
+    }, z.core.$strict>>>;
+    ai: z.ZodDefault<z.ZodBoolean>;
+    licence: z.ZodOptional<z.ZodObject<{
+        entitlement: z.ZodString;
+        issuer: z.ZodObject<{
+            name: z.ZodString;
+            url: z.ZodString;
+        }, z.core.$strict>;
+        keys: z.ZodRecord<z.ZodString, z.ZodString>;
+        audiences: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+    released: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * A theme entry. Themes install through the same download-and-verify path and
+ * are listed in the same index; what happens after the bytes are verified is
+ * the theme installer's business, not this schema's.
+ *
+ * No package name: a theme is data read out of its archive, never an npm
+ * package, and nothing that installs one keys on a package name.
+ */
+export declare const catalogThemeEntrySchema: z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodString;
+    name: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    description: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    artifact: z.ZodObject<{
+        url: z.ZodString;
+        sha512: z.ZodString;
+        bytes: z.ZodOptional<z.ZodInt>;
+    }, z.core.$strict>;
+    homepage: z.ZodOptional<z.ZodString>;
+    deprecated: z.ZodDefault<z.ZodBoolean>;
+    type: z.ZodLiteral<"theme">;
+    contract: z.ZodOptional<z.ZodString>;
+    extends: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export declare const catalogEntrySchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodString;
+    name: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    description: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    artifact: z.ZodObject<{
+        url: z.ZodString;
+        sha512: z.ZodString;
+        bytes: z.ZodOptional<z.ZodInt>;
+    }, z.core.$strict>;
+    homepage: z.ZodOptional<z.ZodString>;
+    deprecated: z.ZodDefault<z.ZodBoolean>;
+    type: z.ZodLiteral<"plugin">;
+    packageName: z.ZodString;
+    apiVersion: z.ZodInt;
+    permissions: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        "addressBook:proposeImport": "addressBook:proposeImport";
+        "addressBook:read": "addressBook:read";
+        "addressBook:readContact": "addressBook:readContact";
+        "addresses:read": "addresses:read";
+        "bookings:readAvailability": "bookings:readAvailability";
+        "calendar:read": "calendar:read";
+        "finances:read": "finances:read";
+        "finances:recordDelivery": "finances:recordDelivery";
+        "jobs:schedule": "jobs:schedule";
+        "mail:send": "mail:send";
+        "media:read": "media:read";
+        "news:read": "news:read";
+        "site:blocks": "site:blocks";
+        "sms:send": "sms:send";
+        "themes:install": "themes:install";
+    }>>>;
+    personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        account: "account";
+        apartment: "apartment";
+        auditTrail: "auditTrail";
+        email: "email";
+        financial: "financial";
+        freeText: "freeText";
+        health: "health";
+        name: "name";
+        personalIdentityNumber: "personalIdentityNumber";
+        phone: "phone";
+        photograph: "photograph";
+        postalAddress: "postalAddress";
+        protected: "protected";
+        residency: "residency";
+    }>>>;
+    actions: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        capability: z.ZodString;
+        effect: z.ZodEnum<{
+            delete: "delete";
+            read: "read";
+            write: "write";
+        }>;
+        personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            account: "account";
+            apartment: "apartment";
+            auditTrail: "auditTrail";
+            email: "email";
+            financial: "financial";
+            freeText: "freeText";
+            health: "health";
+            name: "name";
+            personalIdentityNumber: "personalIdentityNumber";
+            phone: "phone";
+            photograph: "photograph";
+            postalAddress: "postalAddress";
+            protected: "protected";
+            residency: "residency";
+        }>>>;
+        surfaces: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            ai: "ai";
+            mcp: "mcp";
+            ui: "ui";
+        }>>>;
+    }, z.core.$strict>>>;
+    oauthProtectedResource: z.ZodOptional<z.ZodString>;
+    extensionPoints: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodInt;
+        personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            account: "account";
+            apartment: "apartment";
+            auditTrail: "auditTrail";
+            email: "email";
+            financial: "financial";
+            freeText: "freeText";
+            health: "health";
+            name: "name";
+            personalIdentityNumber: "personalIdentityNumber";
+            phone: "phone";
+            photograph: "photograph";
+            postalAddress: "postalAddress";
+            protected: "protected";
+            residency: "residency";
+        }>>>;
+        title: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+        description: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+    }, z.core.$strict>>>;
+    extends: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        plugin: z.ZodString;
+        point: z.ZodString;
+        version: z.ZodInt;
+        personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            account: "account";
+            apartment: "apartment";
+            auditTrail: "auditTrail";
+            email: "email";
+            financial: "financial";
+            freeText: "freeText";
+            health: "health";
+            name: "name";
+            personalIdentityNumber: "personalIdentityNumber";
+            phone: "phone";
+            photograph: "photograph";
+            postalAddress: "postalAddress";
+            protected: "protected";
+            residency: "residency";
+        }>>>;
+    }, z.core.$strict>>>;
+    recipients: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        origin: z.ZodString;
+        purpose: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+        personalData: z.ZodArray<z.ZodEnum<{
+            account: "account";
+            apartment: "apartment";
+            auditTrail: "auditTrail";
+            email: "email";
+            financial: "financial";
+            freeText: "freeText";
+            health: "health";
+            name: "name";
+            personalIdentityNumber: "personalIdentityNumber";
+            phone: "phone";
+            photograph: "photograph";
+            postalAddress: "postalAddress";
+            protected: "protected";
+            residency: "residency";
+        }>>;
+    }, z.core.$strict>>>;
+    deviceRoutes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        path: z.ZodString;
+    }, z.core.$strict>>>;
+    ai: z.ZodDefault<z.ZodBoolean>;
+    licence: z.ZodOptional<z.ZodObject<{
+        entitlement: z.ZodString;
+        issuer: z.ZodObject<{
+            name: z.ZodString;
+            url: z.ZodString;
+        }, z.core.$strict>;
+        keys: z.ZodRecord<z.ZodString, z.ZodString>;
+        audiences: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+    released: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodString;
+    name: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    description: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    artifact: z.ZodObject<{
+        url: z.ZodString;
+        sha512: z.ZodString;
+        bytes: z.ZodOptional<z.ZodInt>;
+    }, z.core.$strict>;
+    homepage: z.ZodOptional<z.ZodString>;
+    deprecated: z.ZodDefault<z.ZodBoolean>;
+    type: z.ZodLiteral<"theme">;
+    contract: z.ZodOptional<z.ZodString>;
+    extends: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>], "type">;
+export type CatalogPluginEntry = z.infer<typeof catalogPluginEntrySchema>;
+export type CatalogThemeEntry = z.infer<typeof catalogThemeEntrySchema>;
+export type CatalogEntry = z.infer<typeof catalogEntrySchema>;
+/**
+ * The index versions this package reads.
+ *
+ * Version 2 adds the fields ADR 0030 lists: `extensionPoints` and `extends`
+ * (ADR 0030), `recipients` (ADR 0037) and `deviceRoutes` (ADR 0031). An
+ * instance reads both, and the catalog serves version 1, without the entries
+ * that need version 2, to instances that have not upgraded.
+ */
+export declare const CATALOG_INDEX_VERSIONS: readonly [1, 2];
+export declare const catalogSchema: z.ZodObject<{
+    version: z.ZodLiteral<1 | 2>;
+    entries: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodString;
+        name: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+        description: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+        artifact: z.ZodObject<{
+            url: z.ZodString;
+            sha512: z.ZodString;
+            bytes: z.ZodOptional<z.ZodInt>;
+        }, z.core.$strict>;
+        homepage: z.ZodOptional<z.ZodString>;
+        deprecated: z.ZodDefault<z.ZodBoolean>;
+        type: z.ZodLiteral<"plugin">;
+        packageName: z.ZodString;
+        apiVersion: z.ZodInt;
+        permissions: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            "addressBook:proposeImport": "addressBook:proposeImport";
+            "addressBook:read": "addressBook:read";
+            "addressBook:readContact": "addressBook:readContact";
+            "addresses:read": "addresses:read";
+            "bookings:readAvailability": "bookings:readAvailability";
+            "calendar:read": "calendar:read";
+            "finances:read": "finances:read";
+            "finances:recordDelivery": "finances:recordDelivery";
+            "jobs:schedule": "jobs:schedule";
+            "mail:send": "mail:send";
+            "media:read": "media:read";
+            "news:read": "news:read";
+            "site:blocks": "site:blocks";
+            "sms:send": "sms:send";
+            "themes:install": "themes:install";
+        }>>>;
+        personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            account: "account";
+            apartment: "apartment";
+            auditTrail: "auditTrail";
+            email: "email";
+            financial: "financial";
+            freeText: "freeText";
+            health: "health";
+            name: "name";
+            personalIdentityNumber: "personalIdentityNumber";
+            phone: "phone";
+            photograph: "photograph";
+            postalAddress: "postalAddress";
+            protected: "protected";
+            residency: "residency";
+        }>>>;
+        actions: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            capability: z.ZodString;
+            effect: z.ZodEnum<{
+                delete: "delete";
+                read: "read";
+                write: "write";
+            }>;
+            personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+                account: "account";
+                apartment: "apartment";
+                auditTrail: "auditTrail";
+                email: "email";
+                financial: "financial";
+                freeText: "freeText";
+                health: "health";
+                name: "name";
+                personalIdentityNumber: "personalIdentityNumber";
+                phone: "phone";
+                photograph: "photograph";
+                postalAddress: "postalAddress";
+                protected: "protected";
+                residency: "residency";
+            }>>>;
+            surfaces: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+                ai: "ai";
+                mcp: "mcp";
+                ui: "ui";
+            }>>>;
+        }, z.core.$strict>>>;
+        oauthProtectedResource: z.ZodOptional<z.ZodString>;
+        extensionPoints: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            version: z.ZodInt;
+            personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+                account: "account";
+                apartment: "apartment";
+                auditTrail: "auditTrail";
+                email: "email";
+                financial: "financial";
+                freeText: "freeText";
+                health: "health";
+                name: "name";
+                personalIdentityNumber: "personalIdentityNumber";
+                phone: "phone";
+                photograph: "photograph";
+                postalAddress: "postalAddress";
+                protected: "protected";
+                residency: "residency";
+            }>>>;
+            title: z.ZodObject<{
+                sv: z.ZodString;
+                en: z.ZodString;
+            }, z.core.$strict>;
+            description: z.ZodObject<{
+                sv: z.ZodString;
+                en: z.ZodString;
+            }, z.core.$strict>;
+        }, z.core.$strict>>>;
+        extends: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            plugin: z.ZodString;
+            point: z.ZodString;
+            version: z.ZodInt;
+            personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+                account: "account";
+                apartment: "apartment";
+                auditTrail: "auditTrail";
+                email: "email";
+                financial: "financial";
+                freeText: "freeText";
+                health: "health";
+                name: "name";
+                personalIdentityNumber: "personalIdentityNumber";
+                phone: "phone";
+                photograph: "photograph";
+                postalAddress: "postalAddress";
+                protected: "protected";
+                residency: "residency";
+            }>>>;
+        }, z.core.$strict>>>;
+        recipients: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            origin: z.ZodString;
+            purpose: z.ZodObject<{
+                sv: z.ZodString;
+                en: z.ZodString;
+            }, z.core.$strict>;
+            personalData: z.ZodArray<z.ZodEnum<{
+                account: "account";
+                apartment: "apartment";
+                auditTrail: "auditTrail";
+                email: "email";
+                financial: "financial";
+                freeText: "freeText";
+                health: "health";
+                name: "name";
+                personalIdentityNumber: "personalIdentityNumber";
+                phone: "phone";
+                photograph: "photograph";
+                postalAddress: "postalAddress";
+                protected: "protected";
+                residency: "residency";
+            }>>;
+        }, z.core.$strict>>>;
+        deviceRoutes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            path: z.ZodString;
+        }, z.core.$strict>>>;
+        ai: z.ZodDefault<z.ZodBoolean>;
+        licence: z.ZodOptional<z.ZodObject<{
+            entitlement: z.ZodString;
+            issuer: z.ZodObject<{
+                name: z.ZodString;
+                url: z.ZodString;
+            }, z.core.$strict>;
+            keys: z.ZodRecord<z.ZodString, z.ZodString>;
+            audiences: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        }, z.core.$strict>>;
+        released: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>, z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodString;
+        name: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+        description: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+        artifact: z.ZodObject<{
+            url: z.ZodString;
+            sha512: z.ZodString;
+            bytes: z.ZodOptional<z.ZodInt>;
+        }, z.core.$strict>;
+        homepage: z.ZodOptional<z.ZodString>;
+        deprecated: z.ZodDefault<z.ZodBoolean>;
+        type: z.ZodLiteral<"theme">;
+        contract: z.ZodOptional<z.ZodString>;
+        extends: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>], "type">>;
+}, z.core.$strict>;
+export type Catalog = z.infer<typeof catalogSchema>;
+/**
+ * The refusals of an index that its reader is told in their own language.
+ *
+ * What the schema says about one entry's field is English for the catalog's
+ * curator, who fixes the index from it. These hold one entry against another,
+ * an addon against the plugin it extends or against the plugins joined to it,
+ * and are the loader's own refusals of the same pair, under the same codes. So
+ * the refusal carries its code and the values its sentence is completed with
+ * beside the English line, and whoever shows it translates the code.
+ */
+export declare const CATALOG_REFUSALS: readonly ["extension-point-unknown", "extension-version-unsupported", "extension-personal-data-refused", "extension-permission-refused", "extension-host-personal-data-refused", "extension-group-refused"];
+export type CatalogRefusalCode = (typeof CATALOG_REFUSALS)[number];
+/**
+ * One refusal of `CATALOG_REFUSALS`: its code, and the refused entry's id as
+ * `addon` with the plugin, point and lists its sentence names.
+ */
+export interface CatalogRefusal {
+    readonly code: CatalogRefusalCode;
+    readonly detail: PluginFindingDetail;
+}
+/** One problem with an index: the English line, and its refusal if it has one. */
+export interface CatalogDiagnostic {
+    /** The line, already naming the field. */
+    readonly issue: string;
+    /** The refusal the line states, or null when it is a field's own problem. */
+    readonly refusal: CatalogRefusal | null;
+}
+export type CatalogParseResult = {
+    ok: true;
+    value: Catalog;
+} | {
+    ok: false;
+    /** One line per problem, already naming the field. */
+    issues: readonly string[];
+    /** The same problems, each with its refusal where it has one. */
+    diagnostics: readonly CatalogDiagnostic[];
+};
+/**
+ * Parses a catalog index.
+ *
+ * A single malformed entry rejects the whole index rather than being dropped
+ * quietly. A board that installs from a catalog which silently lost an entry
+ * has no way to tell that from an entry that was delisted on purpose, and the
+ * two mean opposite things.
+ *
+ * Returns a result rather than throwing, as `parsePluginPackage` does, so a
+ * catalog's own check can list every problem at once.
+ */
+export declare function parseCatalogIndex(input: unknown): CatalogParseResult;
+//# sourceMappingURL=catalog.d.ts.map