@crowi/api 2.0.0-alpha.0 → 2.0.0-alpha.2

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

@@ -4,23 +4,6 @@ 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: {
@@ -31,20 +14,8 @@ export declare const registerMeRoutes: <E extends OpenAPIHono<CrowiHonoBindings>
             };
             outputFormat: "json";
             status: 401;
-        };
-    };
-} & {
-    "/me": {
-        $put: {
-            input: {
-                json: {
-                    userForm: {
-                        name: string;
-                        email: string;
-                        lang: "en" | "ja";
-                    };
-                };
-            };
+        } | {
+            input: {};
             output: {
                 id: string;
                 username: string;
@@ -60,7 +31,11 @@ export declare const registerMeRoutes: <E extends OpenAPIHono<CrowiHonoBindings>
             };
             outputFormat: "json";
             status: 200;
-        } | {
+        };
+    };
+} & {
+    "/me": {
+        $put: {
             input: {
                 json: {
                     userForm: {
@@ -97,23 +72,36 @@ export declare const registerMeRoutes: <E extends OpenAPIHono<CrowiHonoBindings>
             };
             outputFormat: "json";
             status: 401;
-        };
-    };
-} & {
-    "/me/theme": {
-        $patch: {
+        } | {
             input: {
                 json: {
-                    theme: "system" | "light" | "dark";
+                    userForm: {
+                        name: string;
+                        email: string;
+                        lang: "en" | "ja";
+                    };
                 };
             };
             output: {
-                status: "ok";
+                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;
-        } | {
+        };
+    };
+} & {
+    "/me/theme": {
+        $patch: {
             input: {
                 json: {
                     theme: "system" | "light" | "dark";
@@ -142,24 +130,23 @@ export declare const registerMeRoutes: <E extends OpenAPIHono<CrowiHonoBindings>
             };
             outputFormat: "json";
             status: 401;
-        };
-    };
-} & {
-    "/me/picture": {
-        $post: {
+        } | {
             input: {
-                form: {
-                    file?: any;
+                json: {
+                    theme: "system" | "light" | "dark";
                 };
             };
             output: {
-                status: boolean;
-                url?: string | undefined;
-                message?: string | undefined;
+                status: "ok";
+                theme: "system" | "light" | "dark";
             };
             outputFormat: "json";
             status: 200;
-        } | {
+        };
+    };
+} & {
+    "/me/picture": {
+        $post: {
             input: {
                 form: {
                     file?: any;
@@ -188,19 +175,24 @@ export declare const registerMeRoutes: <E extends OpenAPIHono<CrowiHonoBindings>
             };
             outputFormat: "json";
             status: 401;
-        };
-    };
-} & {
-    "/me/picture": {
-        $delete: {
-            input: {};
+        } | {
+            input: {
+                form: {
+                    file?: any;
+                };
+            };
             output: {
-                status: "ok";
+                status: boolean;
+                url?: string | undefined;
                 message?: string | undefined;
             };
             outputFormat: "json";
             status: 200;
-        } | {
+        };
+    };
+} & {
+    "/me/picture": {
+        $delete: {
             input: {};
             output: {
                 status: "error";
@@ -221,6 +213,14 @@ export declare const registerMeRoutes: <E extends OpenAPIHono<CrowiHonoBindings>
             };
             outputFormat: "json";
             status: 401;
+        } | {
+            input: {};
+            output: {
+                status: "ok";
+                message?: string | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
         };
     };
 } & {
@@ -234,11 +234,12 @@ export declare const registerMeRoutes: <E extends OpenAPIHono<CrowiHonoBindings>
                 };
             };
             output: {
-                status: "ok";
+                status: "error";
                 message: string;
+                errors?: string[] | undefined;
             };
             outputFormat: "json";
-            status: 200;
+            status: 400;
         } | {
             input: {
                 json: {
@@ -248,12 +249,14 @@ export declare const registerMeRoutes: <E extends OpenAPIHono<CrowiHonoBindings>
                 };
             };
             output: {
-                status: "error";
-                message: string;
-                errors?: string[] | undefined;
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
             };
             outputFormat: "json";
-            status: 400;
+            status: 401;
         } | {
             input: {
                 json: {
@@ -262,6 +265,28 @@ export declare const registerMeRoutes: <E extends OpenAPIHono<CrowiHonoBindings>
                     oldPassword?: string | undefined;
                 };
             };
+            output: {
+                status: "ok";
+                message: string;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/me/recently-viewed-pages": {
+        $get: {
+            input: {};
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        } | {
+            input: {};
             output: {
                 error: {
                     code: "AUTHENTICATION_REQUIRED";
@@ -271,11 +296,7 @@ export declare const registerMeRoutes: <E extends OpenAPIHono<CrowiHonoBindings>
             };
             outputFormat: "json";
             status: 401;
-        };
-    };
-} & {
-    "/me/recently-viewed-pages": {
-        $get: {
+        } | {
             input: {};
             output: {
                 pages: {
@@ -340,7 +361,7 @@ export declare const registerMeRoutes: <E extends OpenAPIHono<CrowiHonoBindings>
                         editVia?: "web" | "oauth" | "pat" | undefined;
                     } | undefined;
                     redirectTo?: string | null | undefined;
-                    status?: "deleted" | "deprecated" | "published" | "wip" | "draft" | null | undefined;
+                    status?: "published" | "wip" | "deleted" | "deprecated" | "draft" | null | undefined;
                     grant?: number | undefined;
                     grantedUsers?: string[] | undefined;
                     creator?: string | {
@@ -375,27 +396,6 @@ export declare const registerMeRoutes: <E extends OpenAPIHono<CrowiHonoBindings>
             };
             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;
         };
     };
 }, "/">;

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

@@ -4,6 +4,37 @@ import type { CrowiHonoBindings } from '../app';
 export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHonoBindings>>(app: E, crowi: Crowi) => OpenAPIHono<CrowiHonoBindings, {
     "/notifications": {
         $get: {
+            input: {
+                query: {
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        } | {
+            input: {
+                query: {
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
             input: {
                 query: {
                     limit?: unknown;
@@ -18,7 +49,7 @@ export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHon
                     target: {
                         path: string;
                         _id: string;
-                        status?: "deleted" | "deprecated" | "published" | "wip" | "draft" | null | undefined;
+                        status?: "published" | "wip" | "deleted" | "deprecated" | "draft" | null | undefined;
                     };
                     action: "COMMENT" | "LIKE" | "MENTION" | "UPDATE";
                     status: "UNREAD" | "UNOPENED" | "OPENED";
@@ -44,37 +75,6 @@ export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHon
             };
             outputFormat: "json";
             status: 200;
-        } | {
-            input: {
-                query: {
-                    limit?: unknown;
-                    offset?: unknown;
-                };
-            };
-            output: {
-                error: {
-                    code: "AUTHENTICATION_REQUIRED";
-                    message: "Authentication is required";
-                    redirectTo?: string | undefined;
-                };
-            };
-            outputFormat: "json";
-            status: 401;
-        } | {
-            input: {
-                query: {
-                    limit?: unknown;
-                    offset?: unknown;
-                };
-            };
-            output: {
-                error: {
-                    code: "INTERNAL_ERROR";
-                    message: "Internal server error";
-                };
-            };
-            outputFormat: "json";
-            status: 500;
         };
     };
 } & {
@@ -82,10 +82,13 @@ export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHon
         $post: {
             input: {};
             output: {
-                ok: true;
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
             };
             outputFormat: "json";
-            status: 200;
+            status: 500;
         } | {
             input: {};
             output: {
@@ -100,13 +103,10 @@ export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHon
         } | {
             input: {};
             output: {
-                error: {
-                    code: "INTERNAL_ERROR";
-                    message: "Internal server error";
-                };
+                ok: true;
             };
             outputFormat: "json";
-            status: 500;
+            status: 200;
         };
     };
 } & {
@@ -114,12 +114,13 @@ export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHon
         $get: {
             input: {};
             output: {
-                token: string;
-                selfUserId: string;
-                expiresAt: string;
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
             };
             outputFormat: "json";
-            status: 200;
+            status: 500;
         } | {
             input: {};
             output: {
@@ -134,13 +135,12 @@ export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHon
         } | {
             input: {};
             output: {
-                error: {
-                    code: "INTERNAL_ERROR";
-                    message: "Internal server error";
-                };
+                token: string;
+                selfUserId: string;
+                expiresAt: string;
             };
             outputFormat: "json";
-            status: 500;
+            status: 200;
         };
     };
 } & {
@@ -148,10 +148,13 @@ export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHon
         $get: {
             input: {};
             output: {
-                count: number;
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
             };
             outputFormat: "json";
-            status: 200;
+            status: 500;
         } | {
             input: {};
             output: {
@@ -166,13 +169,10 @@ export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHon
         } | {
             input: {};
             output: {
-                error: {
-                    code: "INTERNAL_ERROR";
-                    message: "Internal server error";
-                };
+                count: number;
             };
             outputFormat: "json";
-            status: 500;
+            status: 200;
         };
     };
 } & {
@@ -184,34 +184,13 @@ export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHon
                 };
             };
             output: {
-                notification: {
-                    _id: string;
-                    user: string;
-                    targetModel: "Page";
-                    target: {
-                        path: string;
-                        _id: string;
-                        status?: "deleted" | "deprecated" | "published" | "wip" | "draft" | null | undefined;
-                    };
-                    action: "COMMENT" | "LIKE" | "MENTION" | "UPDATE";
-                    status: "UNREAD" | "UNOPENED" | "OPENED";
-                    actionUsers: {
-                        _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;
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
                 };
             };
             outputFormat: "json";
-            status: 200;
+            status: 500;
         } | {
             input: {
                 param: {
@@ -220,12 +199,12 @@ export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHon
             };
             output: {
                 error: {
-                    code: "INVALID_REQUEST";
-                    message: string;
+                    code: "NOTIFICATION_NOT_FOUND";
+                    message: "Notification not found";
                 };
             };
             outputFormat: "json";
-            status: 400;
+            status: 404;
         } | {
             input: {
                 param: {
@@ -234,13 +213,12 @@ export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHon
             };
             output: {
                 error: {
-                    code: "AUTHENTICATION_REQUIRED";
-                    message: "Authentication is required";
-                    redirectTo?: string | undefined;
+                    code: "INVALID_REQUEST";
+                    message: string;
                 };
             };
             outputFormat: "json";
-            status: 401;
+            status: 400;
         } | {
             input: {
                 param: {
@@ -249,12 +227,13 @@ export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHon
             };
             output: {
                 error: {
-                    code: "NOTIFICATION_NOT_FOUND";
-                    message: "Notification not found";
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
                 };
             };
             outputFormat: "json";
-            status: 404;
+            status: 401;
         } | {
             input: {
                 param: {
@@ -262,13 +241,34 @@ export declare const registerNotificationRoutes: <E extends OpenAPIHono<CrowiHon
                 };
             };
             output: {
-                error: {
-                    code: "INTERNAL_ERROR";
-                    message: "Internal server error";
+                notification: {
+                    _id: string;
+                    user: string;
+                    targetModel: "Page";
+                    target: {
+                        path: string;
+                        _id: string;
+                        status?: "published" | "wip" | "deleted" | "deprecated" | "draft" | null | undefined;
+                    };
+                    action: "COMMENT" | "LIKE" | "MENTION" | "UPDATE";
+                    status: "UNREAD" | "UNOPENED" | "OPENED";
+                    actionUsers: {
+                        _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;
                 };
             };
             outputFormat: "json";
-            status: 500;
+            status: 200;
         };
     };
 }, "/">;