@crowi/api 2.0.0-alpha.0

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

@@ -0,0 +1,687 @@
+import type { OpenAPIHono } from '@hono/zod-openapi';
+import type Crowi from '../../crowi';
+import type { CrowiHonoBindings } from '../app';
+export declare const registerAttachmentRoutes: <E extends OpenAPIHono<CrowiHonoBindings>>(app: E, crowi: Crowi) => OpenAPIHono<CrowiHonoBindings, {
+    "/pages/:pageId/attachments/usage": {
+        $get: {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            };
+            output: {
+                pagePath: string;
+                latest: {
+                    _id: string;
+                    page: string;
+                    creator: {
+                        _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;
+                    };
+                    filePath: string;
+                    fileName: string;
+                    originalName: string;
+                    fileFormat: string;
+                    fileSize: number;
+                    createdAt: string;
+                    url: string;
+                    inUse: boolean;
+                }[];
+                past: {
+                    attachment: {
+                        _id: string;
+                        page: string;
+                        creator: {
+                            _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;
+                        };
+                        filePath: string;
+                        fileName: string;
+                        originalName: string;
+                        fileFormat: string;
+                        fileSize: number;
+                        createdAt: string;
+                        url: string;
+                        inUse: boolean;
+                    };
+                    referencingRevisions: {
+                        revisionId: string;
+                        createdAt: string;
+                        author: {
+                            _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;
+                        };
+                    }[];
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+} & {
+    "/pages/:pageId/attachments": {
+        $get: {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            };
+            output: {
+                attachments: {
+                    _id: string;
+                    page: string;
+                    creator: {
+                        _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;
+                    };
+                    filePath: string;
+                    fileName: string;
+                    originalName: string;
+                    fileFormat: string;
+                    fileSize: number;
+                    createdAt: string;
+                    url: string;
+                    inUse: boolean;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+} & {
+    "/pages/:pageId/attachments": {
+        $post: {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            } & {
+                form: {
+                    file?: any;
+                };
+            };
+            output: {
+                attachment: {
+                    _id: string;
+                    page: string;
+                    creator: {
+                        _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;
+                    };
+                    filePath: string;
+                    fileName: string;
+                    originalName: string;
+                    fileFormat: string;
+                    fileSize: number;
+                    createdAt: string;
+                    url: string;
+                    inUse: boolean;
+                };
+                url: string;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            } & {
+                form: {
+                    file?: any;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            } & {
+                form: {
+                    file?: any;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            } & {
+                form: {
+                    file?: any;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            } & {
+                form: {
+                    file?: any;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 413;
+        } | {
+            input: {
+                param: {
+                    pageId: string;
+                };
+            } & {
+                form: {
+                    file?: any;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+} & {
+    "/attachments/upload": {
+        $post: {
+            input: {
+                form: {
+                    file?: any;
+                    pageId?: string | undefined;
+                    intent?: string | undefined;
+                };
+            };
+            output: {
+                url: string;
+                filename: string;
+                mimeType: string;
+                sizeBytes: number;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                form: {
+                    file?: any;
+                    pageId?: string | undefined;
+                    intent?: string | undefined;
+                };
+            };
+            output: {
+                error: "rate_limited" | "too_large" | "disallowed_type" | "no_permission";
+                message: string;
+                details?: {
+                    [x: string]: import("hono/utils/types").JSONValue;
+                } | undefined;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                form: {
+                    file?: any;
+                    pageId?: string | undefined;
+                    intent?: string | undefined;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                form: {
+                    file?: any;
+                    pageId?: string | undefined;
+                    intent?: string | undefined;
+                };
+            };
+            output: {
+                error: "rate_limited" | "too_large" | "disallowed_type" | "no_permission";
+                message: string;
+                details?: {
+                    [x: string]: import("hono/utils/types").JSONValue;
+                } | undefined;
+            };
+            outputFormat: "json";
+            status: 403;
+        } | {
+            input: {
+                form: {
+                    file?: any;
+                    pageId?: string | undefined;
+                    intent?: string | undefined;
+                };
+            };
+            output: {
+                error: "rate_limited" | "too_large" | "disallowed_type" | "no_permission";
+                message: string;
+                details?: {
+                    [x: string]: import("hono/utils/types").JSONValue;
+                } | undefined;
+            };
+            outputFormat: "json";
+            status: 413;
+        } | {
+            input: {
+                form: {
+                    file?: any;
+                    pageId?: string | undefined;
+                    intent?: string | undefined;
+                };
+            };
+            output: {
+                error: "rate_limited" | "too_large" | "disallowed_type" | "no_permission";
+                message: string;
+                details?: {
+                    [x: string]: import("hono/utils/types").JSONValue;
+                } | undefined;
+            };
+            outputFormat: "json";
+            status: 415;
+        } | {
+            input: {
+                form: {
+                    file?: any;
+                    pageId?: string | undefined;
+                    intent?: string | undefined;
+                };
+            };
+            output: {
+                error: "rate_limited" | "too_large" | "disallowed_type" | "no_permission";
+                message: string;
+                details?: {
+                    [x: string]: import("hono/utils/types").JSONValue;
+                } | undefined;
+            };
+            outputFormat: "json";
+            status: 429;
+        } | {
+            input: {
+                form: {
+                    file?: any;
+                    pageId?: string | undefined;
+                    intent?: string | undefined;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+} & {
+    "/attachments/:id/meta": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                createdAt: string;
+                _id: string;
+                creator: {
+                    _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;
+                };
+                page: string;
+                url: string;
+                filePath: string;
+                fileName: string;
+                originalName: string;
+                fileFormat: string;
+                fileSize: number;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+} & {
+    "/attachments/:id": {
+        $delete: {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                success: true;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 403;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+}, "/">;