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

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

@@ -8,27 +8,7 @@ export declare const registerAutocompleteRoutes: <E extends OpenAPIHono<CrowiHon
                 query: {
                     q: string;
                     limit?: unknown;
-                    anchor?: "substring" | "prefix" | undefined;
-                };
-            };
-            output: {
-                results: {
-                    id: string;
-                    label: string;
-                    display: string;
-                    score: number;
-                    avatar?: string | null | undefined;
-                    modifiedAt?: string | null | undefined;
-                }[];
-            };
-            outputFormat: "json";
-            status: 200;
-        } | {
-            input: {
-                query: {
-                    q: string;
-                    limit?: unknown;
-                    anchor?: "substring" | "prefix" | undefined;
+                    anchor?: "prefix" | "substring" | undefined;
                 };
             };
             output: {
@@ -50,7 +30,7 @@ export declare const registerAutocompleteRoutes: <E extends OpenAPIHono<CrowiHon
                 query: {
                     q: string;
                     limit?: unknown;
-                    anchor?: "substring" | "prefix" | undefined;
+                    anchor?: "prefix" | "substring" | undefined;
                 };
             };
             output: {
@@ -67,26 +47,7 @@ export declare const registerAutocompleteRoutes: <E extends OpenAPIHono<CrowiHon
                 query: {
                     q: string;
                     limit?: unknown;
-                    anchor?: "substring" | "prefix" | undefined;
-                };
-            };
-            output: {
-                error: "rate_limited";
-                message: string;
-                retryAfterSeconds: number;
-            };
-            outputFormat: "json";
-            status: 429;
-        };
-    };
-} & {
-    "/pages/autocomplete": {
-        $get: {
-            input: {
-                query: {
-                    q: string;
-                    limit?: unknown;
-                    anchor?: "substring" | "prefix" | undefined;
+                    anchor?: "prefix" | "substring" | undefined;
                 };
             };
             output: {
@@ -106,7 +67,26 @@ export declare const registerAutocompleteRoutes: <E extends OpenAPIHono<CrowiHon
                 query: {
                     q: string;
                     limit?: unknown;
-                    anchor?: "substring" | "prefix" | undefined;
+                    anchor?: "prefix" | "substring" | undefined;
+                };
+            };
+            output: {
+                error: "rate_limited";
+                message: string;
+                retryAfterSeconds: number;
+            };
+            outputFormat: "json";
+            status: 429;
+        };
+    };
+} & {
+    "/pages/autocomplete": {
+        $get: {
+            input: {
+                query: {
+                    q: string;
+                    limit?: unknown;
+                    anchor?: "prefix" | "substring" | undefined;
                 };
             };
             output: {
@@ -128,7 +108,7 @@ export declare const registerAutocompleteRoutes: <E extends OpenAPIHono<CrowiHon
                 query: {
                     q: string;
                     limit?: unknown;
-                    anchor?: "substring" | "prefix" | undefined;
+                    anchor?: "prefix" | "substring" | undefined;
                 };
             };
             output: {
@@ -145,7 +125,27 @@ export declare const registerAutocompleteRoutes: <E extends OpenAPIHono<CrowiHon
                 query: {
                     q: string;
                     limit?: unknown;
-                    anchor?: "substring" | "prefix" | undefined;
+                    anchor?: "prefix" | "substring" | undefined;
+                };
+            };
+            output: {
+                results: {
+                    id: string;
+                    label: string;
+                    display: string;
+                    score: number;
+                    avatar?: string | null | undefined;
+                    modifiedAt?: string | null | undefined;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                query: {
+                    q: string;
+                    limit?: unknown;
+                    anchor?: "prefix" | "substring" | undefined;
                 };
             };
             output: {

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

@@ -4,6 +4,39 @@ import type { CrowiHonoBindings } from '../app';
 export declare const registerBacklinkRoutes: <E extends OpenAPIHono<CrowiHonoBindings>>(app: E, crowi: Crowi) => OpenAPIHono<CrowiHonoBindings, {
     "/backlinks": {
         $get: {
+            input: {
+                query: {
+                    page_id: string;
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                query: {
+                    page_id: string;
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
             input: {
                 query: {
                     page_id: string;
@@ -40,39 +73,6 @@ export declare const registerBacklinkRoutes: <E extends OpenAPIHono<CrowiHonoBin
             };
             outputFormat: "json";
             status: 200;
-        } | {
-            input: {
-                query: {
-                    page_id: string;
-                    limit?: unknown;
-                    offset?: unknown;
-                };
-            };
-            output: {
-                error: {
-                    code: "INVALID_PAGE_ID";
-                    message: string;
-                };
-            };
-            outputFormat: "json";
-            status: 400;
-        } | {
-            input: {
-                query: {
-                    page_id: string;
-                    limit?: unknown;
-                    offset?: unknown;
-                };
-            };
-            output: {
-                error: {
-                    code: "AUTHENTICATION_REQUIRED";
-                    message: "Authentication is required";
-                    redirectTo?: string | undefined;
-                };
-            };
-            outputFormat: "json";
-            status: 401;
         };
     };
 }, "/">;

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

@@ -4,6 +4,49 @@ import type { CrowiHonoBindings } from '../app';
 export declare const registerBookmarkRoutes: <E extends OpenAPIHono<CrowiHonoBindings>>(app: E, crowi: Crowi) => OpenAPIHono<CrowiHonoBindings, {
     "/bookmarks": {
         $get: {
+            input: {
+                query: {
+                    page_id: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        } | {
+            input: {
+                query: {
+                    page_id: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INVALID_PAGE_ID";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                query: {
+                    page_id: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
             input: {
                 query: {
                     page_id: string;
@@ -74,7 +117,7 @@ export declare const registerBookmarkRoutes: <E extends OpenAPIHono<CrowiHonoBin
                             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 | {
@@ -123,24 +166,30 @@ export declare const registerBookmarkRoutes: <E extends OpenAPIHono<CrowiHonoBin
             };
             outputFormat: "json";
             status: 200;
-        } | {
+        };
+    };
+} & {
+    "/bookmarks/me": {
+        $get: {
             input: {
                 query: {
-                    page_id: string;
+                    limit?: unknown;
+                    offset?: unknown;
                 };
             };
             output: {
                 error: {
-                    code: "INVALID_PAGE_ID";
-                    message: string;
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
                 };
             };
             outputFormat: "json";
-            status: 400;
+            status: 500;
         } | {
             input: {
                 query: {
-                    page_id: string;
+                    limit?: unknown;
+                    offset?: unknown;
                 };
             };
             output: {
@@ -153,24 +202,6 @@ export declare const registerBookmarkRoutes: <E extends OpenAPIHono<CrowiHonoBin
             outputFormat: "json";
             status: 401;
         } | {
-            input: {
-                query: {
-                    page_id: string;
-                };
-            };
-            output: {
-                error: {
-                    code: "INTERNAL_ERROR";
-                    message: "Internal server error";
-                };
-            };
-            outputFormat: "json";
-            status: 500;
-        };
-    };
-} & {
-    "/bookmarks/me": {
-        $get: {
             input: {
                 query: {
                     limit?: unknown;
@@ -242,7 +273,7 @@ export declare const registerBookmarkRoutes: <E extends OpenAPIHono<CrowiHonoBin
                             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 | {
@@ -297,42 +328,54 @@ export declare const registerBookmarkRoutes: <E extends OpenAPIHono<CrowiHonoBin
             };
             outputFormat: "json";
             status: 200;
+        };
+    };
+} & {
+    "/bookmarks": {
+        $post: {
+            input: {
+                json: {
+                    page_id: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
         } | {
             input: {
-                query: {
-                    limit?: unknown;
-                    offset?: unknown;
+                json: {
+                    page_id: string;
                 };
             };
             output: {
                 error: {
-                    code: "AUTHENTICATION_REQUIRED";
-                    message: "Authentication is required";
-                    redirectTo?: string | undefined;
+                    code: "INVALID_PAGE_ID";
+                    message: string;
                 };
             };
             outputFormat: "json";
-            status: 401;
+            status: 400;
         } | {
             input: {
-                query: {
-                    limit?: unknown;
-                    offset?: unknown;
+                json: {
+                    page_id: string;
                 };
             };
             output: {
                 error: {
-                    code: "INTERNAL_ERROR";
-                    message: "Internal server error";
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
                 };
             };
             outputFormat: "json";
-            status: 500;
-        };
-    };
-} & {
-    "/bookmarks": {
-        $post: {
+            status: 401;
+        } | {
             input: {
                 json: {
                     page_id: string;
@@ -403,7 +446,7 @@ export declare const registerBookmarkRoutes: <E extends OpenAPIHono<CrowiHonoBin
                             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 | {
@@ -452,49 +495,6 @@ export declare const registerBookmarkRoutes: <E extends OpenAPIHono<CrowiHonoBin
             };
             outputFormat: "json";
             status: 200;
-        } | {
-            input: {
-                json: {
-                    page_id: string;
-                };
-            };
-            output: {
-                error: {
-                    code: "INVALID_PAGE_ID";
-                    message: string;
-                };
-            };
-            outputFormat: "json";
-            status: 400;
-        } | {
-            input: {
-                json: {
-                    page_id: string;
-                };
-            };
-            output: {
-                error: {
-                    code: "AUTHENTICATION_REQUIRED";
-                    message: "Authentication is required";
-                    redirectTo?: string | undefined;
-                };
-            };
-            outputFormat: "json";
-            status: 401;
-        } | {
-            input: {
-                json: {
-                    page_id: string;
-                };
-            };
-            output: {
-                error: {
-                    code: "INTERNAL_ERROR";
-                    message: "Internal server error";
-                };
-            };
-            outputFormat: "json";
-            status: 500;
         };
     };
 } & {
@@ -506,10 +506,13 @@ export declare const registerBookmarkRoutes: <E extends OpenAPIHono<CrowiHonoBin
                 };
             };
             output: {
-                ok: true;
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
             };
             outputFormat: "json";
-            status: 200;
+            status: 500;
         } | {
             input: {
                 json: {
@@ -546,13 +549,10 @@ export declare const registerBookmarkRoutes: <E extends OpenAPIHono<CrowiHonoBin
                 };
             };
             output: {
-                error: {
-                    code: "INTERNAL_ERROR";
-                    message: "Internal server error";
-                };
+                ok: true;
             };
             outputFormat: "json";
-            status: 500;
+            status: 200;
         };
     };
 }, "/">;

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

@@ -4,34 +4,6 @@ import type { CrowiHonoBindings } from '../app';
 export declare const registerCommentRoutes: <E extends OpenAPIHono<CrowiHonoBindings>>(app: E, crowi: Crowi) => OpenAPIHono<CrowiHonoBindings, {
     "/comments": {
         $get: {
-            input: {
-                query: {
-                    page_id?: string | undefined;
-                    revision_id?: string | undefined;
-                };
-            };
-            output: {
-                comments: {
-                    _id: string;
-                    page: string;
-                    creator: string | {
-                        _id: string;
-                        username: string;
-                        name: string;
-                        email: string;
-                        createdAt: string;
-                        id?: string | undefined;
-                        image?: string | null | undefined;
-                    } | null;
-                    revision: string;
-                    comment: string;
-                    commentPosition: number;
-                    createdAt: string;
-                }[];
-            };
-            outputFormat: "json";
-            status: 200;
-        } | {
             input: {
                 query: {
                     page_id?: string | undefined;
@@ -62,21 +34,15 @@ export declare const registerCommentRoutes: <E extends OpenAPIHono<CrowiHonoBind
             };
             outputFormat: "json";
             status: 401;
-        };
-    };
-} & {
-    "/comments": {
-        $post: {
+        } | {
             input: {
-                json: {
-                    page_id: string;
-                    revision_id: string;
-                    comment: string;
-                    comment_position?: number | undefined;
+                query: {
+                    page_id?: string | undefined;
+                    revision_id?: string | undefined;
                 };
             };
             output: {
-                comment: {
+                comments: {
                     _id: string;
                     page: string;
                     creator: string | {
@@ -92,11 +58,31 @@ export declare const registerCommentRoutes: <E extends OpenAPIHono<CrowiHonoBind
                     comment: string;
                     commentPosition: number;
                     createdAt: string;
-                };
-                newlyWatching: boolean;
+                }[];
             };
             outputFormat: "json";
             status: 200;
+        };
+    };
+} & {
+    "/comments": {
+        $post: {
+            input: {
+                json: {
+                    page_id: string;
+                    revision_id: string;
+                    comment: string;
+                    comment_position?: number | undefined;
+                };
+            };
+            output: {
+                error: {
+                    code: "PAGE_NOT_FOUND";
+                    message: "Page not found";
+                };
+            };
+            outputFormat: "json";
+            status: 404;
         } | {
             input: {
                 json: {
@@ -142,13 +128,27 @@ export declare const registerCommentRoutes: <E extends OpenAPIHono<CrowiHonoBind
                 };
             };
             output: {
-                error: {
-                    code: "PAGE_NOT_FOUND";
-                    message: "Page not found";
+                comment: {
+                    _id: string;
+                    page: string;
+                    creator: string | {
+                        _id: string;
+                        username: string;
+                        name: string;
+                        email: string;
+                        createdAt: string;
+                        id?: string | undefined;
+                        image?: string | null | undefined;
+                    } | null;
+                    revision: string;
+                    comment: string;
+                    commentPosition: number;
+                    createdAt: string;
                 };
+                newlyWatching: boolean;
             };
             outputFormat: "json";
-            status: 404;
+            status: 200;
         };
     };
 } & {
@@ -161,10 +161,13 @@ export declare const registerCommentRoutes: <E extends OpenAPIHono<CrowiHonoBind
                 };
             };
             output: {
-                ok: true;
+                error: {
+                    code: "COMMENT_NOT_FOUND";
+                    message: "Comment not found";
+                };
             };
             outputFormat: "json";
-            status: 200;
+            status: 404;
         } | {
             input: {
                 json: {
@@ -204,13 +207,10 @@ export declare const registerCommentRoutes: <E extends OpenAPIHono<CrowiHonoBind
                 };
             };
             output: {
-                error: {
-                    code: "PAGE_NOT_GRANTED";
-                    message: "Page is not granted for the user";
-                };
+                ok: true;
             };
             outputFormat: "json";
-            status: 403;
+            status: 200;
         } | {
             input: {
                 json: {
@@ -220,12 +220,12 @@ export declare const registerCommentRoutes: <E extends OpenAPIHono<CrowiHonoBind
             };
             output: {
                 error: {
-                    code: "COMMENT_NOT_FOUND";
-                    message: "Comment not found";
+                    code: "PAGE_NOT_GRANTED";
+                    message: "Page is not granted for the user";
                 };
             };
             outputFormat: "json";
-            status: 404;
+            status: 403;
         };
     };
 }, "/">;