@panneau/protocol 0.0.0-stage → 5.0.0-alpha.1

package/dist/schemas/definition.d.ts

@@ -0,0 +1,462 @@
+import { z } from 'zod';
+export declare const User: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    avatarUrl: z.ZodOptional<z.ZodString>;
+    abilities: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
+}, z.core.$loose>;
+export declare const AuthProvider: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+export declare const Auth: z.ZodObject<{
+    mode: z.ZodEnum<{
+        external: "external";
+        panneau: "panneau";
+    }>;
+    loginUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    password: z.ZodOptional<z.ZodBoolean>;
+    providers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>>;
+    passwordReset: z.ZodOptional<z.ZodBoolean>;
+    twoFactor: z.ZodOptional<z.ZodBoolean>;
+    passkeys: z.ZodOptional<z.ZodBoolean>;
+    emailVerification: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$loose>;
+export declare const MenuItem: z.ZodObject<{
+    type: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodString>;
+    resource: z.ZodOptional<z.ZodString>;
+    page: z.ZodOptional<z.ZodString>;
+    url: z.ZodOptional<z.ZodString>;
+    external: z.ZodOptional<z.ZodBoolean>;
+    children: z.ZodOptional<z.ZodArray<typeof MenuItem>>;
+}, z.core.$loose>;
+export declare const Page: z.ZodObject<{
+    component: z.ZodString;
+    path: z.ZodOptional<z.ZodString>;
+    label: z.ZodOptional<z.ZodString>;
+    props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$loose>;
+export declare const Widget: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    width: z.ZodOptional<z.ZodNumber>;
+    settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$loose>;
+export declare const Uploads: z.ZodObject<{
+    mode: z.ZodEnum<{
+        multipart: "multipart";
+        tus: "tus";
+        presigned: "presigned";
+    }>;
+    endpoint: z.ZodOptional<z.ZodString>;
+    maxSize: z.ZodOptional<z.ZodNumber>;
+}, z.core.$loose>;
+export declare const Definition: z.ZodObject<{
+    protocol: z.ZodLiteral<1>;
+    name: z.ZodString;
+    locale: z.ZodString;
+    locales: z.ZodArray<z.ZodString>;
+    api: z.ZodObject<{
+        baseUrl: z.ZodString;
+    }, z.core.$loose>;
+    resources: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodObject<{
+            singular: z.ZodString;
+            plural: z.ZodString;
+        }, z.core.$loose>;
+        description: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+        itemTitle: z.ZodOptional<z.ZodString>;
+        fields: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            type: z.ZodString;
+            label: z.ZodOptional<z.ZodString>;
+            help: z.ZodOptional<z.ZodString>;
+            placeholder: z.ZodOptional<z.ZodString>;
+            default: z.ZodOptional<z.ZodUnknown>;
+            localized: z.ZodOptional<z.ZodBoolean>;
+            readOnly: z.ZodOptional<z.ZodBoolean>;
+            createOnly: z.ZodOptional<z.ZodBoolean>;
+            updateOnly: z.ZodOptional<z.ZodBoolean>;
+            rules: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+                rule: z.ZodLiteral<"required">;
+                message: z.ZodOptional<z.ZodString>;
+            }, z.core.$loose>, z.ZodObject<{
+                rule: z.ZodEnum<{
+                    min: "min";
+                    max: "max";
+                }>;
+                value: z.ZodNumber;
+                message: z.ZodOptional<z.ZodString>;
+            }, z.core.$loose>, z.ZodObject<{
+                rule: z.ZodLiteral<"pattern">;
+                value: z.ZodString;
+                flags: z.ZodOptional<z.ZodString>;
+                message: z.ZodOptional<z.ZodString>;
+            }, z.core.$loose>, z.ZodObject<{
+                rule: z.ZodEnum<{
+                    email: "email";
+                    url: "url";
+                }>;
+                message: z.ZodOptional<z.ZodString>;
+            }, z.core.$loose>, z.ZodObject<{
+                rule: z.ZodLiteral<"in">;
+                value: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+                message: z.ZodOptional<z.ZodString>;
+            }, z.core.$loose>, z.ZodObject<{
+                rule: z.ZodLiteral<"accept">;
+                value: z.ZodArray<z.ZodString>;
+                message: z.ZodOptional<z.ZodString>;
+            }, z.core.$loose>, z.ZodObject<{
+                rule: z.ZodLiteral<"maxSize">;
+                value: z.ZodNumber;
+                message: z.ZodOptional<z.ZodString>;
+            }, z.core.$loose>, z.ZodObject<{
+                rule: z.ZodEnum<{
+                    before: "before";
+                    after: "after";
+                }>;
+                value: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+                    field: z.ZodString;
+                }, z.core.$loose>]>;
+                message: z.ZodOptional<z.ZodString>;
+            }, z.core.$loose>, z.ZodObject<{
+                rule: z.ZodString;
+                message: z.ZodOptional<z.ZodString>;
+            }, z.core.$loose>]>>>;
+            visibleWhen: z.ZodOptional<z.ZodObject<{
+                field: z.ZodOptional<z.ZodString>;
+                equals: z.ZodOptional<z.ZodUnknown>;
+                in: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+                notIn: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+                filled: z.ZodOptional<z.ZodBoolean>;
+                all: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
+                any: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
+            }, z.core.$loose>>;
+            options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+                label: z.ZodString;
+                description: z.ZodOptional<z.ZodString>;
+                disabled: z.ZodOptional<z.ZodBoolean>;
+            }, z.core.$loose>>>;
+            multiple: z.ZodOptional<z.ZodBoolean>;
+            resource: z.ZodOptional<z.ZodString>;
+            accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            from: z.ZodOptional<z.ZodString>;
+            display: z.ZodOptional<z.ZodString>;
+            fields: z.ZodOptional<z.ZodArray<typeof import("./field").Field>>;
+            types: z.ZodOptional<z.ZodArray<typeof import("./field").BlockType>>;
+            settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, z.core.$loose>>;
+        form: z.ZodOptional<z.ZodObject<{
+            layout: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                type: z.ZodString;
+                name: z.ZodOptional<z.ZodString>;
+                label: z.ZodOptional<z.ZodString>;
+                description: z.ZodOptional<z.ZodString>;
+                text: z.ZodOptional<z.ZodString>;
+                component: z.ZodOptional<z.ZodString>;
+                props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                width: z.ZodOptional<z.ZodNumber>;
+                collapsible: z.ZodOptional<z.ZodBoolean>;
+                collapsed: z.ZodOptional<z.ZodBoolean>;
+                visibleWhen: z.ZodOptional<z.ZodObject<{
+                    field: z.ZodOptional<z.ZodString>;
+                    equals: z.ZodOptional<z.ZodUnknown>;
+                    in: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+                    notIn: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+                    filled: z.ZodOptional<z.ZodBoolean>;
+                    all: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
+                    any: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
+                }, z.core.$loose>>;
+                children: z.ZodOptional<z.ZodArray<typeof import("./layout").LayoutNode>>;
+            }, z.core.$loose>>>;
+        }, z.core.$loose>>;
+        list: z.ZodOptional<z.ZodObject<{
+            columns: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                field: z.ZodOptional<z.ZodString>;
+                id: z.ZodOptional<z.ZodString>;
+                label: z.ZodOptional<z.ZodString>;
+                display: z.ZodOptional<z.ZodString>;
+                sortable: z.ZodOptional<z.ZodBoolean>;
+                width: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+                align: z.ZodOptional<z.ZodEnum<{
+                    start: "start";
+                    center: "center";
+                    end: "end";
+                }>>;
+            }, z.core.$loose>>>;
+            filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                type: z.ZodString;
+                label: z.ZodOptional<z.ZodString>;
+                options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+                    label: z.ZodString;
+                    description: z.ZodOptional<z.ZodString>;
+                    disabled: z.ZodOptional<z.ZodBoolean>;
+                }, z.core.$loose>>>;
+                resource: z.ZodOptional<z.ZodString>;
+                multiple: z.ZodOptional<z.ZodBoolean>;
+                default: z.ZodOptional<z.ZodUnknown>;
+            }, z.core.$loose>>>;
+            sorts: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            defaultSort: z.ZodOptional<z.ZodString>;
+            search: z.ZodOptional<z.ZodBoolean>;
+            layouts: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            perPage: z.ZodOptional<z.ZodNumber>;
+            perPageOptions: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+            inlineEdit: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            selectable: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$loose>>;
+        actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            label: z.ZodString;
+            icon: z.ZodOptional<z.ZodString>;
+            kind: z.ZodDefault<z.ZodEnum<{
+                link: "link";
+                server: "server";
+                client: "client";
+            }>>;
+            scope: z.ZodArray<z.ZodEnum<{
+                resource: "resource";
+                item: "item";
+                selection: "selection";
+            }>>;
+            placement: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                row: "row";
+                toolbar: "toolbar";
+                form: "form";
+                menu: "menu";
+            }>>>;
+            destructive: z.ZodOptional<z.ZodBoolean>;
+            confirm: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
+                title: z.ZodOptional<z.ZodString>;
+                message: z.ZodOptional<z.ZodString>;
+                confirmLabel: z.ZodOptional<z.ZodString>;
+                cancelLabel: z.ZodOptional<z.ZodString>;
+            }, z.core.$loose>]>>;
+            fields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                name: z.ZodString;
+                type: z.ZodString;
+                label: z.ZodOptional<z.ZodString>;
+                help: z.ZodOptional<z.ZodString>;
+                placeholder: z.ZodOptional<z.ZodString>;
+                default: z.ZodOptional<z.ZodUnknown>;
+                localized: z.ZodOptional<z.ZodBoolean>;
+                readOnly: z.ZodOptional<z.ZodBoolean>;
+                createOnly: z.ZodOptional<z.ZodBoolean>;
+                updateOnly: z.ZodOptional<z.ZodBoolean>;
+                rules: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+                    rule: z.ZodLiteral<"required">;
+                    message: z.ZodOptional<z.ZodString>;
+                }, z.core.$loose>, z.ZodObject<{
+                    rule: z.ZodEnum<{
+                        min: "min";
+                        max: "max";
+                    }>;
+                    value: z.ZodNumber;
+                    message: z.ZodOptional<z.ZodString>;
+                }, z.core.$loose>, z.ZodObject<{
+                    rule: z.ZodLiteral<"pattern">;
+                    value: z.ZodString;
+                    flags: z.ZodOptional<z.ZodString>;
+                    message: z.ZodOptional<z.ZodString>;
+                }, z.core.$loose>, z.ZodObject<{
+                    rule: z.ZodEnum<{
+                        email: "email";
+                        url: "url";
+                    }>;
+                    message: z.ZodOptional<z.ZodString>;
+                }, z.core.$loose>, z.ZodObject<{
+                    rule: z.ZodLiteral<"in">;
+                    value: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+                    message: z.ZodOptional<z.ZodString>;
+                }, z.core.$loose>, z.ZodObject<{
+                    rule: z.ZodLiteral<"accept">;
+                    value: z.ZodArray<z.ZodString>;
+                    message: z.ZodOptional<z.ZodString>;
+                }, z.core.$loose>, z.ZodObject<{
+                    rule: z.ZodLiteral<"maxSize">;
+                    value: z.ZodNumber;
+                    message: z.ZodOptional<z.ZodString>;
+                }, z.core.$loose>, z.ZodObject<{
+                    rule: z.ZodEnum<{
+                        before: "before";
+                        after: "after";
+                    }>;
+                    value: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+                        field: z.ZodString;
+                    }, z.core.$loose>]>;
+                    message: z.ZodOptional<z.ZodString>;
+                }, z.core.$loose>, z.ZodObject<{
+                    rule: z.ZodString;
+                    message: z.ZodOptional<z.ZodString>;
+                }, z.core.$loose>]>>>;
+                visibleWhen: z.ZodOptional<z.ZodObject<{
+                    field: z.ZodOptional<z.ZodString>;
+                    equals: z.ZodOptional<z.ZodUnknown>;
+                    in: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+                    notIn: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+                    filled: z.ZodOptional<z.ZodBoolean>;
+                    all: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
+                    any: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
+                }, z.core.$loose>>;
+                options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+                    label: z.ZodString;
+                    description: z.ZodOptional<z.ZodString>;
+                    disabled: z.ZodOptional<z.ZodBoolean>;
+                }, z.core.$loose>>>;
+                multiple: z.ZodOptional<z.ZodBoolean>;
+                resource: z.ZodOptional<z.ZodString>;
+                accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                from: z.ZodOptional<z.ZodString>;
+                display: z.ZodOptional<z.ZodString>;
+                fields: z.ZodOptional<z.ZodArray<typeof import("./field").Field>>;
+                types: z.ZodOptional<z.ZodArray<typeof import("./field").BlockType>>;
+                settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            }, z.core.$loose>>>;
+            layout: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                type: z.ZodString;
+                name: z.ZodOptional<z.ZodString>;
+                label: z.ZodOptional<z.ZodString>;
+                description: z.ZodOptional<z.ZodString>;
+                text: z.ZodOptional<z.ZodString>;
+                component: z.ZodOptional<z.ZodString>;
+                props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                width: z.ZodOptional<z.ZodNumber>;
+                collapsible: z.ZodOptional<z.ZodBoolean>;
+                collapsed: z.ZodOptional<z.ZodBoolean>;
+                visibleWhen: z.ZodOptional<z.ZodObject<{
+                    field: z.ZodOptional<z.ZodString>;
+                    equals: z.ZodOptional<z.ZodUnknown>;
+                    in: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+                    notIn: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+                    filled: z.ZodOptional<z.ZodBoolean>;
+                    all: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
+                    any: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
+                }, z.core.$loose>>;
+                children: z.ZodOptional<z.ZodArray<typeof import("./layout").LayoutNode>>;
+            }, z.core.$loose>>>;
+            queued: z.ZodOptional<z.ZodBoolean>;
+            url: z.ZodOptional<z.ZodString>;
+            route: z.ZodOptional<z.ZodString>;
+            component: z.ZodOptional<z.ZodString>;
+            abilities: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
+        }, z.core.$loose>>>;
+        abilities: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
+        features: z.ZodOptional<z.ZodObject<{
+            drafts: z.ZodOptional<z.ZodBoolean>;
+            revisions: z.ZodOptional<z.ZodBoolean>;
+            preview: z.ZodOptional<z.ZodUnion<readonly [z.ZodNull, z.ZodObject<{
+                mode: z.ZodEnum<{
+                    component: "component";
+                    iframe: "iframe";
+                }>;
+                component: z.ZodOptional<z.ZodString>;
+            }, z.core.$loose>]>>;
+            search: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$loose>>;
+        types: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            label: z.ZodString;
+            icon: z.ZodOptional<z.ZodString>;
+            fields: z.ZodArray<typeof import("./field").Field>;
+        }, z.core.$loose>>>;
+        settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$loose>>;
+    pages: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        component: z.ZodString;
+        path: z.ZodOptional<z.ZodString>;
+        label: z.ZodOptional<z.ZodString>;
+        props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$loose>>>;
+    menus: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
+        type: z.ZodString;
+        label: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+        resource: z.ZodOptional<z.ZodString>;
+        page: z.ZodOptional<z.ZodString>;
+        url: z.ZodOptional<z.ZodString>;
+        external: z.ZodOptional<z.ZodBoolean>;
+        children: z.ZodOptional<z.ZodArray<typeof MenuItem>>;
+    }, z.core.$loose>>>>;
+    routes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    auth: z.ZodOptional<z.ZodObject<{
+        mode: z.ZodEnum<{
+            external: "external";
+            panneau: "panneau";
+        }>;
+        loginUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        password: z.ZodOptional<z.ZodBoolean>;
+        providers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            label: z.ZodString;
+            url: z.ZodOptional<z.ZodString>;
+            icon: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>>;
+        passwordReset: z.ZodOptional<z.ZodBoolean>;
+        twoFactor: z.ZodOptional<z.ZodBoolean>;
+        passkeys: z.ZodOptional<z.ZodBoolean>;
+        emailVerification: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$loose>>;
+    dashboard: z.ZodOptional<z.ZodObject<{
+        widgets: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            type: z.ZodString;
+            label: z.ZodOptional<z.ZodString>;
+            width: z.ZodOptional<z.ZodNumber>;
+            settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, z.core.$loose>>;
+    }, z.core.$loose>>;
+    search: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+    }, z.core.$loose>>;
+    uploads: z.ZodOptional<z.ZodObject<{
+        mode: z.ZodEnum<{
+            multipart: "multipart";
+            tus: "tus";
+            presigned: "presigned";
+        }>;
+        endpoint: z.ZodOptional<z.ZodString>;
+        maxSize: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
+    theme: z.ZodOptional<z.ZodObject<{
+        colorScheme: z.ZodOptional<z.ZodEnum<{
+            light: "light";
+            dark: "dark";
+            auto: "auto";
+        }>>;
+    }, z.core.$loose>>;
+    user: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        email: z.ZodOptional<z.ZodString>;
+        avatarUrl: z.ZodOptional<z.ZodString>;
+        abilities: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
+    }, z.core.$loose>>>;
+}, z.core.$loose>;
+export type User = z.infer<typeof User>;
+export type AuthProvider = z.infer<typeof AuthProvider>;
+export type Auth = z.infer<typeof Auth>;
+export type MenuItem = z.infer<typeof MenuItem>;
+export type Page = z.infer<typeof Page>;
+export type Widget = z.infer<typeof Widget>;
+export type Uploads = z.infer<typeof Uploads>;
+export type Definition = z.infer<typeof Definition>;
+/** A definition as a backend writes it, before defaults are applied. */
+export type DefinitionInput = z.input<typeof Definition>;
+//# sourceMappingURL=definition.d.ts.map

package/dist/schemas/definition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"definition.d.ts","sourceRoot":"","sources":["../../src/schemas/definition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB,eAAO,MAAM,IAAI;;;;;;iBAMf,CAAC;AAEH,eAAO,MAAM,YAAY;;;;;iBAKvB,CAAC;AAEH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;iBAef,CAAC;AAEH,eAAO,MAAM,QAAQ;;;;;;;;cAYG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,QAAQ,CAAC,CAAC;iBAIjB,CAAC;AAElD,eAAO,MAAM,IAAI;;;;;iBAQf,CAAC;AAEH,eAAO,MAAM,MAAM;;;;;;iBAQjB,CAAC;AAEH,eAAO,MAAM,OAAO;;;;;;;;iBAIlB,CAAC;AAEH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAhCC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,QAAQ,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyEiC,CAAC;AAEpG,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;AACxC,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AACxD,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;AACxC,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAChD,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;AACxC,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC;AAC5C,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAC9C,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AACpD,wEAAwE;AACxE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC"}

package/dist/schemas/definition.js

@@ -0,0 +1,101 @@
+import "../version.js";
+import { Abilities, Id } from "./common.js";
+import { Resource } from "./resource.js";
+import { z } from "zod";
+//#region src/schemas/definition.ts
+var User = z.looseObject({
+	id: Id,
+	name: z.string(),
+	email: z.string().optional(),
+	avatarUrl: z.string().optional(),
+	abilities: Abilities.optional()
+});
+var AuthProvider = z.looseObject({
+	id: z.string().min(1),
+	label: z.string(),
+	url: z.string().optional().meta({ description: "Where the login with this provider starts." }),
+	icon: z.string().optional()
+});
+var Auth = z.looseObject({
+	mode: z.enum(["panneau", "external"]).meta({ description: "`panneau`: Panneau's own login pages. `external`: the site handles login." }),
+	loginUrl: z.string().nullable().optional().meta({ description: "`external`: where unauthenticated users are sent." }),
+	password: z.boolean().optional(),
+	providers: z.array(AuthProvider).optional(),
+	passwordReset: z.boolean().optional(),
+	twoFactor: z.boolean().optional(),
+	passkeys: z.boolean().optional(),
+	emailVerification: z.boolean().optional()
+});
+var MenuItem = z.looseObject({
+	type: z.string().min(1).meta({ description: "Built-in: `resources`, `resource`, `page`, `link`, `separator`, `group`." }),
+	label: z.string().optional(),
+	icon: z.string().optional(),
+	resource: z.string().optional(),
+	page: z.string().optional(),
+	url: z.string().optional(),
+	external: z.boolean().optional(),
+	get children() {
+		return z.array(MenuItem).optional();
+	}
+}).meta({ description: "An entry of a menu." });
+var Page = z.looseObject({
+	component: z.string().min(1).meta({ description: "A page provided by a plugin, or a built-in page." }),
+	path: z.string().optional().meta({ description: "Path of a custom page." }),
+	label: z.string().optional(),
+	props: z.record(z.string(), z.unknown()).optional()
+});
+var Widget = z.looseObject({
+	id: z.string().min(1),
+	type: z.string().min(1).meta({ description: "Built-in: `stat`, `chart`, `recent-items`, `shortcuts`, `welcome`." }),
+	label: z.string().optional(),
+	width: z.number().int().min(1).max(12).optional(),
+	settings: z.record(z.string(), z.unknown()).optional()
+});
+var Uploads = z.looseObject({
+	mode: z.enum([
+		"multipart",
+		"tus",
+		"presigned"
+	]),
+	endpoint: z.string().optional(),
+	maxSize: z.number().int().positive().optional()
+});
+var Definition = z.looseObject({
+	protocol: z.literal(1),
+	name: z.string(),
+	locale: z.string().min(2).meta({ description: "BCP 47 locale of the labels and messages." }),
+	locales: z.array(z.string().min(2)).min(1).meta({ description: "Locales of localized content fields." }),
+	api: z.looseObject({ baseUrl: z.string() }),
+	resources: z.array(Resource),
+	pages: z.record(z.string(), Page).optional(),
+	menus: z.record(z.string(), z.array(MenuItem)).optional(),
+	routes: z.record(z.string(), z.string()).optional().meta({ description: "Named paths of the frontend, for `link` actions and redirects." }),
+	auth: Auth.optional(),
+	dashboard: z.looseObject({ widgets: z.array(Widget) }).optional(),
+	search: z.looseObject({ enabled: z.boolean() }).optional(),
+	uploads: Uploads.optional(),
+	theme: z.looseObject({ colorScheme: z.enum([
+		"light",
+		"dark",
+		"auto"
+	]).optional() }).optional(),
+	user: User.nullable().optional()
+}).superRefine((definition, context) => {
+	const ids = /* @__PURE__ */ new Set();
+	definition.resources.forEach((resource, index) => {
+		if (ids.has(resource.id)) context.addIssue({
+			code: "custom",
+			message: `Duplicate resource id \`${resource.id}\`.`,
+			path: [
+				"resources",
+				index,
+				"id"
+			]
+		});
+		ids.add(resource.id);
+	});
+}).meta({ description: "Everything a frontend needs to render the admin for the current user." });
+//#endregion
+export { Auth, AuthProvider, Definition, MenuItem, Page, Uploads, User, Widget };
+
+//# sourceMappingURL=definition.js.map

package/dist/schemas/definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definition.js","names":[],"sources":["../../src/schemas/definition.ts"],"sourcesContent":["import { z } from 'zod';\n\nimport { PROTOCOL_VERSION } from '../version';\nimport { Abilities, Id } from './common';\nimport { Resource } from './resource';\n\nexport const User = z.looseObject({\n    id: Id,\n    name: z.string(),\n    email: z.string().optional(),\n    avatarUrl: z.string().optional(),\n    abilities: Abilities.optional(),\n});\n\nexport const AuthProvider = z.looseObject({\n    id: z.string().min(1),\n    label: z.string(),\n    url: z.string().optional().meta({ description: 'Where the login with this provider starts.' }),\n    icon: z.string().optional(),\n});\n\nexport const Auth = z.looseObject({\n    mode: z.enum(['panneau', 'external']).meta({\n        description: \"`panneau`: Panneau's own login pages. `external`: the site handles login.\",\n    }),\n    loginUrl: z\n        .string()\n        .nullable()\n        .optional()\n        .meta({ description: '`external`: where unauthenticated users are sent.' }),\n    password: z.boolean().optional(),\n    providers: z.array(AuthProvider).optional(),\n    passwordReset: z.boolean().optional(),\n    twoFactor: z.boolean().optional(),\n    passkeys: z.boolean().optional(),\n    emailVerification: z.boolean().optional(),\n});\n\nexport const MenuItem = z\n    .looseObject({\n        type: z.string().min(1).meta({\n            description: 'Built-in: `resources`, `resource`, `page`, `link`, `separator`, `group`.',\n        }),\n        label: z.string().optional(),\n        icon: z.string().optional(),\n        resource: z.string().optional(),\n        page: z.string().optional(),\n        url: z.string().optional(),\n        external: z.boolean().optional(),\n        // The return type is written out so that declaration files keep the recursion.\n        get children(): z.ZodOptional<z.ZodArray<typeof MenuItem>> {\n            return z.array(MenuItem).optional();\n        },\n    })\n    .meta({ description: 'An entry of a menu.' });\n\nexport const Page = z.looseObject({\n    component: z\n        .string()\n        .min(1)\n        .meta({ description: 'A page provided by a plugin, or a built-in page.' }),\n    path: z.string().optional().meta({ description: 'Path of a custom page.' }),\n    label: z.string().optional(),\n    props: z.record(z.string(), z.unknown()).optional(),\n});\n\nexport const Widget = z.looseObject({\n    id: z.string().min(1),\n    type: z.string().min(1).meta({\n        description: 'Built-in: `stat`, `chart`, `recent-items`, `shortcuts`, `welcome`.',\n    }),\n    label: z.string().optional(),\n    width: z.number().int().min(1).max(12).optional(),\n    settings: z.record(z.string(), z.unknown()).optional(),\n});\n\nexport const Uploads = z.looseObject({\n    mode: z.enum(['multipart', 'tus', 'presigned']),\n    endpoint: z.string().optional(),\n    maxSize: z.number().int().positive().optional(),\n});\n\nexport const Definition = z\n    .looseObject({\n        protocol: z.literal(PROTOCOL_VERSION),\n        name: z.string(),\n        locale: z\n            .string()\n            .min(2)\n            .meta({ description: 'BCP 47 locale of the labels and messages.' }),\n        locales: z\n            .array(z.string().min(2))\n            .min(1)\n            .meta({ description: 'Locales of localized content fields.' }),\n        api: z.looseObject({ baseUrl: z.string() }),\n        resources: z.array(Resource),\n        pages: z.record(z.string(), Page).optional(),\n        menus: z.record(z.string(), z.array(MenuItem)).optional(),\n        routes: z.record(z.string(), z.string()).optional().meta({\n            description: 'Named paths of the frontend, for `link` actions and redirects.',\n        }),\n        auth: Auth.optional(),\n        dashboard: z.looseObject({ widgets: z.array(Widget) }).optional(),\n        search: z.looseObject({ enabled: z.boolean() }).optional(),\n        uploads: Uploads.optional(),\n        theme: z\n            .looseObject({ colorScheme: z.enum(['light', 'dark', 'auto']).optional() })\n            .optional(),\n        user: User.nullable().optional(),\n    })\n    .superRefine((definition, context) => {\n        const ids = new Set<string>();\n        definition.resources.forEach((resource, index) => {\n            if (ids.has(resource.id)) {\n                context.addIssue({\n                    code: 'custom',\n                    message: `Duplicate resource id \\`${resource.id}\\`.`,\n                    path: ['resources', index, 'id'],\n                });\n            }\n            ids.add(resource.id);\n        });\n    })\n    .meta({ description: 'Everything a frontend needs to render the admin for the current user.' });\n\nexport type User = z.infer<typeof User>;\nexport type AuthProvider = z.infer<typeof AuthProvider>;\nexport type Auth = z.infer<typeof Auth>;\nexport type MenuItem = z.infer<typeof MenuItem>;\nexport type Page = z.infer<typeof Page>;\nexport type Widget = z.infer<typeof Widget>;\nexport type Uploads = z.infer<typeof Uploads>;\nexport type Definition = z.infer<typeof Definition>;\n/** A definition as a backend writes it, before defaults are applied. */\nexport type DefinitionInput = z.input<typeof Definition>;\n"],"mappings":";;;;;AAMA,IAAa,OAAO,EAAE,YAAY;CAC9B,IAAI;CACJ,MAAM,EAAE,OAAO;CACf,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS;CAC3B,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS;CAC/B,WAAW,UAAU,SAAS;AAClC,CAAC;AAED,IAAa,eAAe,EAAE,YAAY;CACtC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;CACpB,OAAO,EAAE,OAAO;CAChB,KAAK,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,aAAa,6CAA6C,CAAC;CAC7F,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS;AAC9B,CAAC;AAED,IAAa,OAAO,EAAE,YAAY;CAC9B,MAAM,EAAE,KAAK,CAAC,WAAW,UAAU,CAAC,CAAC,CAAC,KAAK,EACvC,aAAa,4EACjB,CAAC;CACD,UAAU,EACL,OAAO,CAAC,CACR,SAAS,CAAC,CACV,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,oDAAoD,CAAC;CAC9E,UAAU,EAAE,QAAQ,CAAC,CAAC,SAAS;CAC/B,WAAW,EAAE,MAAM,YAAY,CAAC,CAAC,SAAS;CAC1C,eAAe,EAAE,QAAQ,CAAC,CAAC,SAAS;CACpC,WAAW,EAAE,QAAQ,CAAC,CAAC,SAAS;CAChC,UAAU,EAAE,QAAQ,CAAC,CAAC,SAAS;CAC/B,mBAAmB,EAAE,QAAQ,CAAC,CAAC,SAAS;AAC5C,CAAC;AAED,IAAa,WAAW,EACnB,YAAY;CACT,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,EACzB,aAAa,2EACjB,CAAC;CACD,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS;CAC3B,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS;CAC1B,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS;CAC9B,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS;CAC1B,KAAK,EAAE,OAAO,CAAC,CAAC,SAAS;CACzB,UAAU,EAAE,QAAQ,CAAC,CAAC,SAAS;CAE/B,IAAI,WAAuD;EACvD,OAAO,EAAE,MAAM,QAAQ,CAAC,CAAC,SAAS;CACtC;AACJ,CAAC,CAAC,CACD,KAAK,EAAE,aAAa,sBAAsB,CAAC;AAEhD,IAAa,OAAO,EAAE,YAAY;CAC9B,WAAW,EACN,OAAO,CAAC,CACR,IAAI,CAAC,CAAC,CACN,KAAK,EAAE,aAAa,mDAAmD,CAAC;CAC7E,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,aAAa,yBAAyB,CAAC;CAC1E,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS;CAC3B,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS;AACtD,CAAC;AAED,IAAa,SAAS,EAAE,YAAY;CAChC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;CACpB,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,EACzB,aAAa,qEACjB,CAAC;CACD,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS;CAC3B,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS;CAChD,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS;AACzD,CAAC;AAED,IAAa,UAAU,EAAE,YAAY;CACjC,MAAM,EAAE,KAAK;EAAC;EAAa;EAAO;CAAW,CAAC;CAC9C,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS;CAC9B,SAAS,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;AAClD,CAAC;AAED,IAAa,aAAa,EACrB,YAAY;CACT,UAAU,EAAE,QAAA,CAAwB;CACpC,MAAM,EAAE,OAAO;CACf,QAAQ,EACH,OAAO,CAAC,CACR,IAAI,CAAC,CAAC,CACN,KAAK,EAAE,aAAa,4CAA4C,CAAC;CACtE,SAAS,EACJ,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CACxB,IAAI,CAAC,CAAC,CACN,KAAK,EAAE,aAAa,uCAAuC,CAAC;CACjE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;CAC1C,WAAW,EAAE,MAAM,QAAQ;CAC3B,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC,CAAC,SAAS;CAC3C,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,SAAS;CACxD,QAAQ,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EACrD,aAAa,iEACjB,CAAC;CACD,MAAM,KAAK,SAAS;CACpB,WAAW,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;CAChE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;CACzD,SAAS,QAAQ,SAAS;CAC1B,OAAO,EACF,YAAY,EAAE,aAAa,EAAE,KAAK;EAAC;EAAS;EAAQ;CAAM,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAC1E,SAAS;CACd,MAAM,KAAK,SAAS,CAAC,CAAC,SAAS;AACnC,CAAC,CAAC,CACD,aAAa,YAAY,YAAY;CAClC,MAAM,sBAAM,IAAI,IAAY;CAC5B,WAAW,UAAU,SAAS,UAAU,UAAU;EAC9C,IAAI,IAAI,IAAI,SAAS,EAAE,GACnB,QAAQ,SAAS;GACb,MAAM;GACN,SAAS,2BAA2B,SAAS,GAAG;GAChD,MAAM;IAAC;IAAa;IAAO;GAAI;EACnC,CAAC;EAEL,IAAI,IAAI,SAAS,EAAE;CACvB,CAAC;AACL,CAAC,CAAC,CACD,KAAK,EAAE,aAAa,wEAAwE,CAAC"}