@readyfor/api-client-readyfor 0.232.0 → 0.234.0

package/dist/schemaType.d.mts

@@ -10,6 +10,13 @@ interface paths {
          */
         get: operations["Resources_CommonHeader"];
     };
+    "/api/v1/readyfor_header": {
+        /**
+         * READYFORヘッダー表示用情報を取得
+         * @description READYFORヘッダー表示用情報を取得（タブ表示機能付き）
+         */
+        get: operations["ReadyforHeader"];
+    };
     "/api/v1/receives/gmopg": {
         /**
          * GMOPG結果通知受信
@@ -2992,6 +2999,293 @@ interface components {
             message: string;
             myProjects: string;
         };
+        /**
+         * @example {
+         *   "searchDefaultValue": "searchDefaultValue",
+         *   "messageCount": 0,
+         *   "userImage": "userImage",
+         *   "unreadMessageCountAsContributor": 1,
+         *   "tabs": [
+         *     {
+         *       "name": "name",
+         *       "href": "href"
+         *     },
+         *     {
+         *       "name": "name",
+         *       "href": "href"
+         *     }
+         *   ],
+         *   "links": {
+         *     "userMenuLinks": {
+         *       "logout": "logout",
+         *       "edit": "edit",
+         *       "myProjects": "myProjects",
+         *       "history": "history",
+         *       "follow": "follow",
+         *       "message": "message"
+         *     },
+         *     "search": "search",
+         *     "projects": "projects",
+         *     "top": "top",
+         *     "intro": "intro",
+         *     "about": "about",
+         *     "login": "login"
+         *   },
+         *   "hasProject": true,
+         *   "userName": "userName",
+         *   "userSignedIn": true,
+         *   "searchMenuList": [
+         *     {
+         *       "columnTypes": {
+         *         "md": null,
+         *         "sm": "1",
+         *         "lg": null
+         *       },
+         *       "groups": [
+         *         {
+         *           "subCategory": "subCategory",
+         *           "links": [
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             },
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             }
+         *           ]
+         *         },
+         *         {
+         *           "subCategory": "subCategory",
+         *           "links": [
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             },
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             }
+         *           ]
+         *         }
+         *       ],
+         *       "section": 6,
+         *       "category": "category"
+         *     },
+         *     {
+         *       "columnTypes": {
+         *         "md": null,
+         *         "sm": "1",
+         *         "lg": null
+         *       },
+         *       "groups": [
+         *         {
+         *           "subCategory": "subCategory",
+         *           "links": [
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             },
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             }
+         *           ]
+         *         },
+         *         {
+         *           "subCategory": "subCategory",
+         *           "links": [
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             },
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             }
+         *           ]
+         *         }
+         *       ],
+         *       "section": 6,
+         *       "category": "category"
+         *     }
+         *   ],
+         *   "hasUnreadMessageAsFundraiser": true,
+         *   "settingNotificationCount": 5
+         * }
+         */
+        ReadyforHeader: {
+            /** @description プロジェクトを持っているか */
+            hasProject: boolean;
+            /** @description 未読メッセージの数 */
+            messageCount: number;
+            /** @description ヘッダーメニューの検索系リンク集 */
+            searchMenuList: components["schemas"]["ReadyforHeader_SearchMenuListItem"][];
+            /** @description ヘッダーの検索フォームの初期値 */
+            searchDefaultValue: string;
+            /** @description ユーザーのプロフィール画像URL */
+            userImage: string;
+            /** @description ユーザー名 */
+            userName: string;
+            /** @description ログインされているかどうか */
+            userSignedIn: boolean;
+            links: components["schemas"]["ReadyforHeader_Links"];
+            /** @description 未読メッセージの数(支援者) */
+            unreadMessageCountAsContributor: number;
+            /** @description 未読メッセージがあるか(実行者) */
+            hasUnreadMessageAsFundraiser: boolean;
+            /** @description 設定に関する通知の数 */
+            settingNotificationCount: number;
+            /** @description タブ情報の配列。タブ表示がない場合はnull */
+            tabs: components["schemas"]["ReadyforHeader_Tab"][] | null;
+        };
+        /**
+         * @description ヘッダーメニューの検索系リンク集
+         * @example {
+         *   "columnTypes": {
+         *     "md": null,
+         *     "sm": "1",
+         *     "lg": null
+         *   },
+         *   "groups": [
+         *     {
+         *       "subCategory": "subCategory",
+         *       "links": [
+         *         {
+         *           "title": "title",
+         *           "url": "url"
+         *         },
+         *         {
+         *           "title": "title",
+         *           "url": "url"
+         *         }
+         *       ]
+         *     },
+         *     {
+         *       "subCategory": "subCategory",
+         *       "links": [
+         *         {
+         *           "title": "title",
+         *           "url": "url"
+         *         },
+         *         {
+         *           "title": "title",
+         *           "url": "url"
+         *         }
+         *       ]
+         *     }
+         *   ],
+         *   "section": 6,
+         *   "category": "category"
+         * }
+         */
+        ReadyforHeader_SearchMenuListItem: {
+            category: string;
+            groups: components["schemas"]["ReadyforHeader_SearchMenuListItem_Group"][];
+            section: number;
+            columnTypes: components["schemas"]["ReadyforHeader_SearchMenuListItem_ColumnTypes"];
+        };
+        /**
+         * @example {
+         *   "subCategory": "subCategory",
+         *   "links": [
+         *     {
+         *       "title": "title",
+         *       "url": "url"
+         *     },
+         *     {
+         *       "title": "title",
+         *       "url": "url"
+         *     }
+         *   ]
+         * }
+         */
+        ReadyforHeader_SearchMenuListItem_Group: {
+            subCategory: string;
+            links: components["schemas"]["ReadyforHeader_SearchMenuListItem_Group_Link"][];
+        };
+        /**
+         * @example {
+         *   "title": "title",
+         *   "url": "url"
+         * }
+         */
+        ReadyforHeader_SearchMenuListItem_Group_Link: {
+            title: string;
+            url: string;
+        };
+        /**
+         * @example {
+         *   "md": null,
+         *   "sm": "1",
+         *   "lg": null
+         * }
+         */
+        ReadyforHeader_SearchMenuListItem_ColumnTypes: {
+            sm: components["schemas"]["ReadyforHeader_SearchMenuListItem_ColumnType"];
+            md: components["schemas"]["ReadyforHeader_SearchMenuListItem_ColumnType"];
+            lg: components["schemas"]["ReadyforHeader_SearchMenuListItem_ColumnType"];
+        };
+        /** @enum {string} */
+        ReadyforHeader_SearchMenuListItem_ColumnType: "1" | "2" | "auto";
+        /**
+         * @example {
+         *   "userMenuLinks": {
+         *     "logout": "logout",
+         *     "edit": "edit",
+         *     "myProjects": "myProjects",
+         *     "history": "history",
+         *     "follow": "follow",
+         *     "message": "message"
+         *   },
+         *   "search": "search",
+         *   "projects": "projects",
+         *   "top": "top",
+         *   "intro": "intro",
+         *   "about": "about",
+         *   "login": "login"
+         * }
+         */
+        ReadyforHeader_Links: {
+            about: string;
+            intro: string;
+            login: string;
+            projects: string;
+            search: string;
+            top: string;
+            userMenuLinks: components["schemas"]["ReadyforHeader_Links_UserMenuLinks"];
+        };
+        /**
+         * @example {
+         *   "logout": "logout",
+         *   "edit": "edit",
+         *   "myProjects": "myProjects",
+         *   "history": "history",
+         *   "follow": "follow",
+         *   "message": "message"
+         * }
+         */
+        ReadyforHeader_Links_UserMenuLinks: {
+            edit: string;
+            follow: string;
+            history: string;
+            logout: string;
+            message: string;
+            myProjects: string;
+        };
+        /**
+         * @description ヘッダータブの情報
+         * @example {
+         *   "name": "name",
+         *   "href": "href"
+         * }
+         */
+        ReadyforHeader_Tab: {
+            /** @description タブ名 */
+            name: string;
+            /** @description タブのリンク先URL */
+            href: string;
+        };
         /**
          * GetProjectComments
          * @example {
@@ -13506,6 +13800,29 @@ interface operations {
             };
         };
     };
+    /**
+     * READYFORヘッダー表示用情報を取得
+     * @description READYFORヘッダー表示用情報を取得（タブ表示機能付き）
+     */
+    ReadyforHeader: {
+        parameters: {
+            query?: {
+                /**
+                 * @description レスポンスにヘッダーのタブ情報を含めるかどうかのパラメータ<br>
+                 * NOTE: このAPIは、レスポンスの情報をそのままヘッダーコンポーネントに渡す事を想定している。タブは表示しないものがデフォルトとするためにこのような仕様にしている
+                 */
+                showsTabs?: boolean;
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["ReadyforHeader"];
+                };
+            };
+        };
+    };
     /**
      * GMOPG結果通知受信
      * @description GMOPG結果通知受信

package/dist/schemaType.d.ts

@@ -10,6 +10,13 @@ interface paths {
          */
         get: operations["Resources_CommonHeader"];
     };
+    "/api/v1/readyfor_header": {
+        /**
+         * READYFORヘッダー表示用情報を取得
+         * @description READYFORヘッダー表示用情報を取得（タブ表示機能付き）
+         */
+        get: operations["ReadyforHeader"];
+    };
     "/api/v1/receives/gmopg": {
         /**
          * GMOPG結果通知受信
@@ -2992,6 +2999,293 @@ interface components {
             message: string;
             myProjects: string;
         };
+        /**
+         * @example {
+         *   "searchDefaultValue": "searchDefaultValue",
+         *   "messageCount": 0,
+         *   "userImage": "userImage",
+         *   "unreadMessageCountAsContributor": 1,
+         *   "tabs": [
+         *     {
+         *       "name": "name",
+         *       "href": "href"
+         *     },
+         *     {
+         *       "name": "name",
+         *       "href": "href"
+         *     }
+         *   ],
+         *   "links": {
+         *     "userMenuLinks": {
+         *       "logout": "logout",
+         *       "edit": "edit",
+         *       "myProjects": "myProjects",
+         *       "history": "history",
+         *       "follow": "follow",
+         *       "message": "message"
+         *     },
+         *     "search": "search",
+         *     "projects": "projects",
+         *     "top": "top",
+         *     "intro": "intro",
+         *     "about": "about",
+         *     "login": "login"
+         *   },
+         *   "hasProject": true,
+         *   "userName": "userName",
+         *   "userSignedIn": true,
+         *   "searchMenuList": [
+         *     {
+         *       "columnTypes": {
+         *         "md": null,
+         *         "sm": "1",
+         *         "lg": null
+         *       },
+         *       "groups": [
+         *         {
+         *           "subCategory": "subCategory",
+         *           "links": [
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             },
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             }
+         *           ]
+         *         },
+         *         {
+         *           "subCategory": "subCategory",
+         *           "links": [
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             },
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             }
+         *           ]
+         *         }
+         *       ],
+         *       "section": 6,
+         *       "category": "category"
+         *     },
+         *     {
+         *       "columnTypes": {
+         *         "md": null,
+         *         "sm": "1",
+         *         "lg": null
+         *       },
+         *       "groups": [
+         *         {
+         *           "subCategory": "subCategory",
+         *           "links": [
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             },
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             }
+         *           ]
+         *         },
+         *         {
+         *           "subCategory": "subCategory",
+         *           "links": [
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             },
+         *             {
+         *               "title": "title",
+         *               "url": "url"
+         *             }
+         *           ]
+         *         }
+         *       ],
+         *       "section": 6,
+         *       "category": "category"
+         *     }
+         *   ],
+         *   "hasUnreadMessageAsFundraiser": true,
+         *   "settingNotificationCount": 5
+         * }
+         */
+        ReadyforHeader: {
+            /** @description プロジェクトを持っているか */
+            hasProject: boolean;
+            /** @description 未読メッセージの数 */
+            messageCount: number;
+            /** @description ヘッダーメニューの検索系リンク集 */
+            searchMenuList: components["schemas"]["ReadyforHeader_SearchMenuListItem"][];
+            /** @description ヘッダーの検索フォームの初期値 */
+            searchDefaultValue: string;
+            /** @description ユーザーのプロフィール画像URL */
+            userImage: string;
+            /** @description ユーザー名 */
+            userName: string;
+            /** @description ログインされているかどうか */
+            userSignedIn: boolean;
+            links: components["schemas"]["ReadyforHeader_Links"];
+            /** @description 未読メッセージの数(支援者) */
+            unreadMessageCountAsContributor: number;
+            /** @description 未読メッセージがあるか(実行者) */
+            hasUnreadMessageAsFundraiser: boolean;
+            /** @description 設定に関する通知の数 */
+            settingNotificationCount: number;
+            /** @description タブ情報の配列。タブ表示がない場合はnull */
+            tabs: components["schemas"]["ReadyforHeader_Tab"][] | null;
+        };
+        /**
+         * @description ヘッダーメニューの検索系リンク集
+         * @example {
+         *   "columnTypes": {
+         *     "md": null,
+         *     "sm": "1",
+         *     "lg": null
+         *   },
+         *   "groups": [
+         *     {
+         *       "subCategory": "subCategory",
+         *       "links": [
+         *         {
+         *           "title": "title",
+         *           "url": "url"
+         *         },
+         *         {
+         *           "title": "title",
+         *           "url": "url"
+         *         }
+         *       ]
+         *     },
+         *     {
+         *       "subCategory": "subCategory",
+         *       "links": [
+         *         {
+         *           "title": "title",
+         *           "url": "url"
+         *         },
+         *         {
+         *           "title": "title",
+         *           "url": "url"
+         *         }
+         *       ]
+         *     }
+         *   ],
+         *   "section": 6,
+         *   "category": "category"
+         * }
+         */
+        ReadyforHeader_SearchMenuListItem: {
+            category: string;
+            groups: components["schemas"]["ReadyforHeader_SearchMenuListItem_Group"][];
+            section: number;
+            columnTypes: components["schemas"]["ReadyforHeader_SearchMenuListItem_ColumnTypes"];
+        };
+        /**
+         * @example {
+         *   "subCategory": "subCategory",
+         *   "links": [
+         *     {
+         *       "title": "title",
+         *       "url": "url"
+         *     },
+         *     {
+         *       "title": "title",
+         *       "url": "url"
+         *     }
+         *   ]
+         * }
+         */
+        ReadyforHeader_SearchMenuListItem_Group: {
+            subCategory: string;
+            links: components["schemas"]["ReadyforHeader_SearchMenuListItem_Group_Link"][];
+        };
+        /**
+         * @example {
+         *   "title": "title",
+         *   "url": "url"
+         * }
+         */
+        ReadyforHeader_SearchMenuListItem_Group_Link: {
+            title: string;
+            url: string;
+        };
+        /**
+         * @example {
+         *   "md": null,
+         *   "sm": "1",
+         *   "lg": null
+         * }
+         */
+        ReadyforHeader_SearchMenuListItem_ColumnTypes: {
+            sm: components["schemas"]["ReadyforHeader_SearchMenuListItem_ColumnType"];
+            md: components["schemas"]["ReadyforHeader_SearchMenuListItem_ColumnType"];
+            lg: components["schemas"]["ReadyforHeader_SearchMenuListItem_ColumnType"];
+        };
+        /** @enum {string} */
+        ReadyforHeader_SearchMenuListItem_ColumnType: "1" | "2" | "auto";
+        /**
+         * @example {
+         *   "userMenuLinks": {
+         *     "logout": "logout",
+         *     "edit": "edit",
+         *     "myProjects": "myProjects",
+         *     "history": "history",
+         *     "follow": "follow",
+         *     "message": "message"
+         *   },
+         *   "search": "search",
+         *   "projects": "projects",
+         *   "top": "top",
+         *   "intro": "intro",
+         *   "about": "about",
+         *   "login": "login"
+         * }
+         */
+        ReadyforHeader_Links: {
+            about: string;
+            intro: string;
+            login: string;
+            projects: string;
+            search: string;
+            top: string;
+            userMenuLinks: components["schemas"]["ReadyforHeader_Links_UserMenuLinks"];
+        };
+        /**
+         * @example {
+         *   "logout": "logout",
+         *   "edit": "edit",
+         *   "myProjects": "myProjects",
+         *   "history": "history",
+         *   "follow": "follow",
+         *   "message": "message"
+         * }
+         */
+        ReadyforHeader_Links_UserMenuLinks: {
+            edit: string;
+            follow: string;
+            history: string;
+            logout: string;
+            message: string;
+            myProjects: string;
+        };
+        /**
+         * @description ヘッダータブの情報
+         * @example {
+         *   "name": "name",
+         *   "href": "href"
+         * }
+         */
+        ReadyforHeader_Tab: {
+            /** @description タブ名 */
+            name: string;
+            /** @description タブのリンク先URL */
+            href: string;
+        };
         /**
          * GetProjectComments
          * @example {
@@ -13506,6 +13800,29 @@ interface operations {
             };
         };
     };
+    /**
+     * READYFORヘッダー表示用情報を取得
+     * @description READYFORヘッダー表示用情報を取得（タブ表示機能付き）
+     */
+    ReadyforHeader: {
+        parameters: {
+            query?: {
+                /**
+                 * @description レスポンスにヘッダーのタブ情報を含めるかどうかのパラメータ<br>
+                 * NOTE: このAPIは、レスポンスの情報をそのままヘッダーコンポーネントに渡す事を想定している。タブは表示しないものがデフォルトとするためにこのような仕様にしている
+                 */
+                showsTabs?: boolean;
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["ReadyforHeader"];
+                };
+            };
+        };
+    };
     /**
      * GMOPG結果通知受信
      * @description GMOPG結果通知受信

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readyfor/api-client-readyfor",
-  "version": "0.232.0",
+  "version": "0.234.0",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -24,7 +24,7 @@
     "build": "tsup"
   },
   "devDependencies": {
-    "@readyfor/api-client-base": "0.232.0",
+    "@readyfor/api-client-base": "0.234.0",
     "@types/qs": "6.9.18",
     "@types/react": "19.1.2",
     "@types/use-sync-external-store": "1.5.0",
@@ -65,5 +65,5 @@
       "src"
     ]
   },
-  "gitHead": "f03dc608eec7d01e87174fb9c4f29053be5e4538"
+  "gitHead": "2339fc20b5264e0771c8392b38576f1deea8b6cc"
 }