@crowi/api 2.0.0-alpha.0

package/dist/hono/handlers/me.d.ts

@@ -0,0 +1,401 @@
+import type { OpenAPIHono } from '@hono/zod-openapi';
+import type Crowi from '../../crowi';
+import type { CrowiHonoBindings } from '../app';
+export declare const registerMeRoutes: <E extends OpenAPIHono<CrowiHonoBindings>>(app: E, crowi: Crowi) => OpenAPIHono<CrowiHonoBindings, {
+    "/me": {
+        $get: {
+            input: {};
+            output: {
+                id: string;
+                username: string;
+                name: string;
+                email: string;
+                lang: "en" | "ja";
+                theme: "system" | "light" | "dark";
+                image: string | null;
+                hasPassword: boolean;
+                createdAt: string;
+                introduction?: string | undefined;
+                emailChangePending?: boolean | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {};
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        };
+    };
+} & {
+    "/me": {
+        $put: {
+            input: {
+                json: {
+                    userForm: {
+                        name: string;
+                        email: string;
+                        lang: "en" | "ja";
+                    };
+                };
+            };
+            output: {
+                id: string;
+                username: string;
+                name: string;
+                email: string;
+                lang: "en" | "ja";
+                theme: "system" | "light" | "dark";
+                image: string | null;
+                hasPassword: boolean;
+                createdAt: string;
+                introduction?: string | undefined;
+                emailChangePending?: boolean | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                json: {
+                    userForm: {
+                        name: string;
+                        email: string;
+                        lang: "en" | "ja";
+                    };
+                };
+            };
+            output: {
+                status: "error";
+                code?: string | undefined;
+                message?: string | undefined;
+                errors?: string[] | undefined;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                json: {
+                    userForm: {
+                        name: string;
+                        email: string;
+                        lang: "en" | "ja";
+                    };
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        };
+    };
+} & {
+    "/me/theme": {
+        $patch: {
+            input: {
+                json: {
+                    theme: "system" | "light" | "dark";
+                };
+            };
+            output: {
+                status: "ok";
+                theme: "system" | "light" | "dark";
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                json: {
+                    theme: "system" | "light" | "dark";
+                };
+            };
+            output: {
+                status: "error";
+                code?: string | undefined;
+                message?: string | undefined;
+                errors?: string[] | undefined;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                json: {
+                    theme: "system" | "light" | "dark";
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        };
+    };
+} & {
+    "/me/picture": {
+        $post: {
+            input: {
+                form: {
+                    file?: any;
+                };
+            };
+            output: {
+                status: boolean;
+                url?: string | undefined;
+                message?: string | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                form: {
+                    file?: any;
+                };
+            };
+            output: {
+                status: "error";
+                code?: string | undefined;
+                message?: string | undefined;
+                errors?: string[] | undefined;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                form: {
+                    file?: any;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        };
+    };
+} & {
+    "/me/picture": {
+        $delete: {
+            input: {};
+            output: {
+                status: "ok";
+                message?: string | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {};
+            output: {
+                status: "error";
+                code?: string | undefined;
+                message?: string | undefined;
+                errors?: string[] | undefined;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {};
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        };
+    };
+} & {
+    "/me/password": {
+        $put: {
+            input: {
+                json: {
+                    newPassword: string;
+                    newPasswordConfirm: string;
+                    oldPassword?: string | undefined;
+                };
+            };
+            output: {
+                status: "ok";
+                message: string;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                json: {
+                    newPassword: string;
+                    newPasswordConfirm: string;
+                    oldPassword?: string | undefined;
+                };
+            };
+            output: {
+                status: "error";
+                message: string;
+                errors?: string[] | undefined;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                json: {
+                    newPassword: string;
+                    newPasswordConfirm: string;
+                    oldPassword?: string | undefined;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        };
+    };
+} & {
+    "/me/recently-viewed-pages": {
+        $get: {
+            input: {};
+            output: {
+                pages: {
+                    _id: string;
+                    path: string;
+                    commentCount: number;
+                    createdAt: string;
+                    revision?: string | {
+                        _id: string;
+                        path: string;
+                        body: string;
+                        format: string;
+                        createdAt: string;
+                        author?: {
+                            _id: string;
+                            username: string;
+                            name: string;
+                            email: string;
+                            createdAt: string;
+                            id?: string | undefined;
+                            image?: string | null | undefined;
+                        } | null | undefined;
+                        meta?: {
+                            toc?: {
+                                level: number;
+                                text: string;
+                                anchorId: string;
+                            }[] | undefined;
+                            wikiLinks?: {
+                                raw: string;
+                                target: string;
+                                displayText?: string | undefined;
+                            }[] | undefined;
+                            mentions?: {
+                                username: string;
+                            }[] | undefined;
+                            codeBlockLanguages?: string[] | undefined;
+                        } | undefined;
+                        renderedAst?: import("hono/utils/types").JSONValue | undefined;
+                        rendererVersion?: string | undefined;
+                        parentRevisionId?: string | null | undefined;
+                        type?: "snapshot" | "incremental" | undefined;
+                        savedBy?: string | {
+                            _id: string;
+                            username: string;
+                            name: string;
+                            email: string;
+                            createdAt: string;
+                            id?: string | undefined;
+                            image?: string | null | undefined;
+                        } | null | undefined;
+                        contributors?: (string | {
+                            _id: string;
+                            username: string;
+                            name: string;
+                            email: string;
+                            createdAt: string;
+                            id?: string | undefined;
+                            image?: string | null | undefined;
+                        })[] | undefined;
+                        message?: string | undefined;
+                        editVia?: "web" | "oauth" | "pat" | undefined;
+                    } | undefined;
+                    redirectTo?: string | null | undefined;
+                    status?: "deleted" | "deprecated" | "published" | "wip" | "draft" | null | undefined;
+                    grant?: number | undefined;
+                    grantedUsers?: string[] | undefined;
+                    creator?: string | {
+                        _id: string;
+                        username: string;
+                        name: string;
+                        email: string;
+                        createdAt: string;
+                        id?: string | undefined;
+                        image?: string | null | undefined;
+                    } | null | undefined;
+                    lastUpdateUser?: string | {
+                        _id: string;
+                        username: string;
+                        name: string;
+                        email: string;
+                        createdAt: string;
+                        id?: string | undefined;
+                        image?: string | null | undefined;
+                    } | null | undefined;
+                    liker?: string[] | undefined;
+                    extended?: {
+                        [x: string]: any;
+                    } | undefined;
+                    updatedAt?: string | undefined;
+                    currentRevision?: string | null | undefined;
+                    yjsCheckpointAt?: string | null | undefined;
+                    latestRevision?: string | undefined;
+                    likerCount?: number | undefined;
+                    seenUsersCount?: number | undefined;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {};
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {};
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+}, "/">;