@crowi/api 2.0.0-alpha.0

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

@@ -0,0 +1,710 @@
+import type { OpenAPIHono } from '@hono/zod-openapi';
+import type Crowi from '../../crowi';
+import type { CrowiHonoBindings } from '../app';
+export declare const registerUserRoutes: <E extends OpenAPIHono<CrowiHonoBindings>>(app: E, crowi: Crowi) => OpenAPIHono<CrowiHonoBindings, {
+    "/user/:username": {
+        $get: {
+            input: {
+                param: {
+                    username: string;
+                };
+            };
+            output: {
+                user: {
+                    _id: string;
+                    username: string;
+                    name: string;
+                    email: string;
+                    createdAt: string;
+                    id?: string | undefined;
+                    image?: string | null | undefined;
+                    introduction?: string | undefined;
+                    admin?: boolean | undefined;
+                    status?: 1 | 2 | 3 | 4 | 5 | undefined;
+                };
+                createdPagesCount: number;
+                bookmarksCount: number;
+                recentPages?: {
+                    _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;
+                }[] | undefined;
+                recentBookmarks?: {
+                    _id: string;
+                    page: {
+                        _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;
+                    };
+                    user: string | {
+                        _id: string;
+                        username: string;
+                        name: string;
+                        email: string;
+                        createdAt: string;
+                        id?: string | undefined;
+                        image?: string | null | undefined;
+                        introduction?: string | undefined;
+                        admin?: boolean | undefined;
+                        status?: 1 | 2 | 3 | 4 | 5 | undefined;
+                    };
+                    createdAt: string;
+                }[] | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    username: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    username: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "USER_NOT_FOUND";
+                    message: "User not found";
+                };
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    username: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+} & {
+    "/user/:username/bookmarks": {
+        $get: {
+            input: {
+                param: {
+                    username: string;
+                };
+            } & {
+                query: {
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                bookmarks: {
+                    _id: string;
+                    page: {
+                        _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;
+                    };
+                    user: string | {
+                        _id: string;
+                        username: string;
+                        name: string;
+                        email: string;
+                        createdAt: string;
+                        id?: string | undefined;
+                        image?: string | null | undefined;
+                        introduction?: string | undefined;
+                        admin?: boolean | undefined;
+                        status?: 1 | 2 | 3 | 4 | 5 | undefined;
+                    };
+                    createdAt: string;
+                }[];
+                pager: {
+                    prev: number | null;
+                    next: number | null;
+                    offset: number;
+                };
+                total: number;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    username: string;
+                };
+            } & {
+                query: {
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    username: string;
+                };
+            } & {
+                query: {
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                error: {
+                    code: "USER_NOT_FOUND";
+                    message: "User not found";
+                };
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    username: string;
+                };
+            } & {
+                query: {
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+} & {
+    "/user/:username/pages": {
+        $get: {
+            input: {
+                param: {
+                    username: string;
+                };
+            } & {
+                query: {
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            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;
+                }[];
+                pager: {
+                    prev: number | null;
+                    next: number | null;
+                    offset: number;
+                };
+                total: number;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    username: string;
+                };
+            } & {
+                query: {
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    username: string;
+                };
+            } & {
+                query: {
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                error: {
+                    code: "USER_NOT_FOUND";
+                    message: "User not found";
+                };
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    username: string;
+                };
+            } & {
+                query: {
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+} & {
+    "/users": {
+        $get: {
+            input: {
+                query: {
+                    q?: string | undefined;
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                users: {
+                    _id: string;
+                    username: string;
+                    name: string;
+                    image?: string | null | undefined;
+                }[];
+                pager: {
+                    prev: number | null;
+                    next: number | null;
+                    offset: number;
+                };
+                total: number;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                query: {
+                    q?: string | undefined;
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                query: {
+                    q?: string | undefined;
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+}, "/">;