approval: 承認待ち件数取得・承認完了書類非表示設定サブコマンドを追加 (#26)

- `xp approval wait` (GET /api/v1/approvals/wait) を追加
- `xp approval hidden` (PUT /api/v1/approvals/hidden) を追加
- 対応する schema JSON (approval.wait.json / approval.hidden.json) を同梱

Author: buty4649

cmd/approval.go

@@ -22,6 +22,17 @@ var (
 	approvalListShowHiddenDoc bool
 	approvalListOutput        string
 	approvalListJQ            string
+
+	approvalWaitFGID   int
+	approvalWaitFID    int
+	approvalWaitStep   int
+	approvalWaitOutput string
+	approvalWaitJQ     string
+
+	approvalHiddenShow      bool
+	approvalHiddenProxyUser string
+	approvalHiddenOutput    string
+	approvalHiddenJQ        string
 )
 
 var approvalCmd = &cobra.Command{
@@ -36,6 +47,24 @@ var approvalListCmd = &cobra.Command{
 	RunE:  runApprovalList,
 }
 
+var approvalWaitCmd = &cobra.Command{
+	Use:   "wait",
+	Short: "Get approval counts and latest pending documents",
+	Long:  "Fetch approval counts and the latest pending documents via GET /api/v1/approvals/wait.",
+	RunE:  runApprovalWait,
+}
+
+var approvalHiddenCmd = &cobra.Command{
+	Use:   "hidden <docid> [<docid>...]",
+	Short: "Hide or show completed approval documents",
+	Long: `Set the hidden flag on completed approval documents via PUT /api/v1/approvals/hidden.
+
+By default the given document IDs are hidden. Pass --show to restore them.
+Only documents in the "承認完了" (completed) status may be specified.`,
+	Args: cobra.MinimumNArgs(1),
+	RunE: runApprovalHidden,
+}
+
 func init() {
 	rootCmd.AddCommand(approvalCmd)
 	approvalCmd.AddCommand(approvalListCmd)
@@ -51,6 +80,21 @@ func init() {
 	f.BoolVar(&approvalListShowHiddenDoc, "show-hidden-doc", false, "include hidden completed documents")
 	f.StringVarP(&approvalListOutput, "output", "o", "", "output format: table|json (default: table on TTY, json otherwise)")
 	f.StringVar(&approvalListJQ, "jq", "", "apply a gojq filter to the JSON response (forces JSON output)")
+
+	approvalCmd.AddCommand(approvalWaitCmd)
+	fw := approvalWaitCmd.Flags()
+	fw.IntVar(&approvalWaitFGID, "fgid", 0, "form group ID (0 = omit)")
+	fw.IntVar(&approvalWaitFID, "fid", 0, "form ID (0 = omit)")
+	fw.IntVar(&approvalWaitStep, "step", 0, "approval step (0 = omit)")
+	fw.StringVarP(&approvalWaitOutput, "output", "o", "", "output format: table|json (default: table on TTY, json otherwise)")
+	fw.StringVar(&approvalWaitJQ, "jq", "", "apply a gojq filter to the JSON response (forces JSON output)")
+
+	approvalCmd.AddCommand(approvalHiddenCmd)
+	fh := approvalHiddenCmd.Flags()
+	fh.BoolVar(&approvalHiddenShow, "show", false, "show (un-hide) the given documents instead of hiding them")
+	fh.StringVar(&approvalHiddenProxyUser, "proxy-user", "", "proxy approver user code (required when toggling proxy-approved documents)")
+	fh.StringVarP(&approvalHiddenOutput, "output", "o", "", "output format: table|json (default: table on TTY, json otherwise)")
+	fh.StringVar(&approvalHiddenJQ, "jq", "", "apply a gojq filter to the JSON response (forces JSON output)")
 }
 
 func runApprovalList(cmd *cobra.Command, args []string) error {
@@ -108,3 +152,88 @@ func runApprovalList(cmd *cobra.Command, args []string) error {
 		return nil
 	})
 }
+
+func runApprovalWait(cmd *cobra.Command, args []string) error {
+	client, err := newClientFromFlags(cmd.Context())
+	if err != nil {
+		return err
+	}
+
+	var params xpoint.ApprovalsWaitParams
+	if approvalWaitFGID != 0 {
+		v := approvalWaitFGID
+		params.FormGroupID = &v
+	}
+	if approvalWaitFID != 0 {
+		v := approvalWaitFID
+		params.FormID = &v
+	}
+	if approvalWaitStep != 0 {
+		v := approvalWaitStep
+		params.Step = &v
+	}
+
+	res, err := client.GetApprovalsWait(cmd.Context(), params)
+	if err != nil {
+		return err
+	}
+
+	return render(res, resolveOutputFormat(approvalWaitOutput), approvalWaitJQ, func() error {
+		w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
+		fmt.Fprintln(w, "TYPE\tNAME\tCOUNT")
+		for _, s := range res.StatusList {
+			fmt.Fprintf(w, "%d\t%s\t%d\n", s.Type, s.Name, s.Count)
+		}
+		w.Flush()
+
+		if len(res.WaitList) > 0 {
+			fmt.Fprintln(os.Stdout)
+			fmt.Fprintln(os.Stdout, "最新の承認待ち書類:")
+			w2 := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
+			fmt.Fprintln(w2, "DOCID\tFORM_NAME\tWRITER\tWRITE_DATE\tTITLE")
+			for _, d := range res.WaitList {
+				fmt.Fprintf(w2, "%d\t%s\t%s\t%s\t%s\n", d.DocID, d.Name, d.WriterName, d.WriteDate, d.Title)
+			}
+			w2.Flush()
+		}
+		return nil
+	})
+}
+
+func runApprovalHidden(cmd *cobra.Command, args []string) error {
+	client, err := newClientFromFlags(cmd.Context())
+	if err != nil {
+		return err
+	}
+
+	docIDs := make([]int, 0, len(args))
+	for _, a := range args {
+		id, err := parseDocID(a)
+		if err != nil {
+			return fmt.Errorf("invalid docid %q: %w", a, err)
+		}
+		docIDs = append(docIDs, id)
+	}
+
+	req := xpoint.SetApprovalsHiddenRequest{
+		Hidden:    !approvalHiddenShow,
+		DocID:     docIDs,
+		ProxyUser: approvalHiddenProxyUser,
+	}
+
+	res, err := client.SetApprovalsHidden(cmd.Context(), req)
+	if err != nil {
+		return err
+	}
+
+	return render(res, resolveOutputFormat(approvalHiddenOutput), approvalHiddenJQ, func() error {
+		fmt.Fprintf(os.Stdout, "message: %s\n", res.Message)
+		w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
+		defer w.Flush()
+		fmt.Fprintln(w, "DOCID")
+		for _, id := range res.DocID {
+			fmt.Fprintf(w, "%d\n", id)
+		}
+		return nil
+	})
+}

internal/schema/approval.hidden.json

@@ -0,0 +1,47 @@
+{
+  "method": "PUT",
+  "path": "/api/v1/approvals/hidden",
+  "summary": "承認完了書類非表示設定",
+  "description": "承認完了書類の表示／非表示フラグをまとめて切り替える。承認待ち一覧取得APIで取得した docid を指定すること。承認完了以外の書類を指定するとエラー応答となる。",
+  "requestBody": {
+    "type": "object",
+    "required": ["hidden", "docid"],
+    "properties": {
+      "hidden": {
+        "type": "boolean",
+        "description": "true: 指定書類を非表示 / false: 指定書類を表示"
+      },
+      "docid": {
+        "type": "array",
+        "description": "対象の書類ID配列 (承認完了書類のみ有効)",
+        "items": {
+          "type": "integer"
+        }
+      },
+      "proxy_user": {
+        "type": "string",
+        "description": "代理承認者ユーザCD (代理承認した承認完了書類を対象にするとき指定)"
+      }
+    }
+  },
+  "response": {
+    "type": "object",
+    "properties": {
+      "docid": {
+        "type": "array",
+        "description": "非表示／表示設定した書類ID配列",
+        "items": {
+          "type": "integer"
+        }
+      },
+      "message_type": {
+        "type": "integer",
+        "description": "メッセージタイプ (3:INFO 固定)"
+      },
+      "message": {
+        "type": "string",
+        "description": "メッセージ内容"
+      }
+    }
+  }
+}

internal/schema/approval.wait.json

@@ -0,0 +1,81 @@
+{
+  "method": "GET",
+  "path": "/api/v1/approvals/wait",
+  "summary": "承認待ち件数取得",
+  "description": "PCブラウザのユーザートップ「承認」ガジェット相当の、11種類の承認状況別件数、および最新の承認待ち書類5件の情報を取得する。",
+  "parameters": [
+    {
+      "name": "fgid",
+      "in": "query",
+      "type": "integer",
+      "description": "フォームグループID で絞り込み"
+    },
+    {
+      "name": "fid",
+      "in": "query",
+      "type": "integer",
+      "description": "フォームID で絞り込み (fgid が指定されているときのみ有効)"
+    },
+    {
+      "name": "step",
+      "in": "query",
+      "type": "integer",
+      "description": "ステップ番号で絞り込み (fgid と fid が指定されているときのみ有効)"
+    }
+  ],
+  "response": {
+    "type": "object",
+    "properties": {
+      "status_list": {
+        "type": "array",
+        "description": "承認状況別の件数リスト",
+        "items": {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "integer",
+              "description": "承認状況種別 (0:承認待ち / 1:差し戻され / 2:下書き / 3:保留 / 4:承認中(申請) / 5:差し戻し / 6:承認完了(申請) / 7:却下 / 8:回覧 / 9:承認中(承認) / 10:承認完了(承認))"
+            },
+            "name": {
+              "type": "string",
+              "description": "承認状況名称"
+            },
+            "count": {
+              "type": "integer",
+              "description": "件数"
+            }
+          }
+        }
+      },
+      "wait_list": {
+        "type": "array",
+        "description": "最新の承認待ち書類5件",
+        "items": {
+          "type": "object",
+          "properties": {
+            "docid": {
+              "type": "integer",
+              "description": "書類ID"
+            },
+            "name": {
+              "type": "string",
+              "description": "フォーム名称"
+            },
+            "title": {
+              "type": "string",
+              "description": "件名"
+            },
+            "writername": {
+              "type": "string",
+              "description": "申請者名"
+            },
+            "writedate": {
+              "type": "string",
+              "description": "申請日時 (YYYY/MM/DD hh:mm:ss)"
+            }
+          }
+        }
+      }
+    }
+  }
+}

internal/schema/schema_test.go

@@ -8,7 +8,9 @@ import (
 func TestAliases_Sorted(t *testing.T) {
 	got := Aliases()
 	want := []string{
+		"approval.hidden",
 		"approval.list",
+		"approval.wait",
 		"document.attachment.add",
 		"document.attachment.delete",
 		"document.attachment.get",

internal/xpoint/client.go

@@ -221,6 +221,81 @@ func (c *Client) ListApprovals(ctx context.Context, p ApprovalsListParams) (*App
 	return &out, nil
 }
 
+type ApprovalsWaitStatus struct {
+	Type  int    `json:"type"`
+	Name  string `json:"name"`
+	Count int    `json:"count"`
+}
+
+type ApprovalsWaitItem struct {
+	DocID      int    `json:"docid"`
+	Name       string `json:"name"`
+	Title      string `json:"title"`
+	WriterName string `json:"writername"`
+	WriteDate  string `json:"writedate"`
+}
+
+type ApprovalsWaitResponse struct {
+	StatusList []ApprovalsWaitStatus `json:"status_list"`
+	WaitList   []ApprovalsWaitItem   `json:"wait_list"`
+}
+
+// ApprovalsWaitParams holds query parameters for GET /api/v1/approvals/wait.
+type ApprovalsWaitParams struct {
+	FormGroupID *int
+	FormID      *int
+	Step        *int
+}
+
+func (p ApprovalsWaitParams) query() url.Values {
+	v := url.Values{}
+	if p.FormGroupID != nil {
+		v.Set("fgid", strconv.Itoa(*p.FormGroupID))
+	}
+	if p.FormID != nil {
+		v.Set("fid", strconv.Itoa(*p.FormID))
+	}
+	if p.Step != nil {
+		v.Set("step", strconv.Itoa(*p.Step))
+	}
+	return v
+}
+
+// GetApprovalsWait calls GET /api/v1/approvals/wait.
+func (c *Client) GetApprovalsWait(ctx context.Context, p ApprovalsWaitParams) (*ApprovalsWaitResponse, error) {
+	var out ApprovalsWaitResponse
+	if err := c.do(ctx, http.MethodGet, "/api/v1/approvals/wait", p.query(), nil, &out); err != nil {
+		return nil, err
+	}
+	return &out, nil
+}
+
+// SetApprovalsHiddenRequest is the PUT /api/v1/approvals/hidden body.
+type SetApprovalsHiddenRequest struct {
+	Hidden    bool   `json:"hidden"`
+	DocID     []int  `json:"docid"`
+	ProxyUser string `json:"proxy_user,omitempty"`
+}
+
+type SetApprovalsHiddenResponse struct {
+	DocID       []int  `json:"docid"`
+	MessageType int    `json:"message_type"`
+	Message     string `json:"message"`
+}
+
+// SetApprovalsHidden calls PUT /api/v1/approvals/hidden.
+func (c *Client) SetApprovalsHidden(ctx context.Context, req SetApprovalsHiddenRequest) (*SetApprovalsHiddenResponse, error) {
+	body, err := json.Marshal(req)
+	if err != nil {
+		return nil, fmt.Errorf("marshal request: %w", err)
+	}
+	var out SetApprovalsHiddenResponse
+	if err := c.do(ctx, http.MethodPut, "/api/v1/approvals/hidden", nil, body, &out); err != nil {
+		return nil, err
+	}
+	return &out, nil
+}
+
 type SearchForm struct {
 	ID   int    `json:"id"`
 	Code string `json:"code"`