fizzy-cli 0.4.0 → 0.6.0

package/IMPLEMENTATION_PLAN.md

@@ -1,338 +0,0 @@
-# Fizzy CLI Implementation Analysis & Plan
-
-## Current Implementation Status
-
-### ✅ Implemented Commands
-
-#### Authentication & Setup
-- `fizzy login` - Authenticate with Fizzy API
-- `fizzy use --account <slug>` - Select account
-- `fizzy use --board <name>` - Select board
-
-#### Accounts
-- `fizzy account list` - List available accounts
-
-#### Boards
-- `fizzy board list` - GET `/boards`
-- `fizzy board show <id>` - GET `/boards/:id`
-- `fizzy board create <name>` - POST `/boards`
-
-#### Cards
-- `fizzy card list` - GET `/cards`
-- `fizzy card show <number>` - GET `/cards/:number`
-- `fizzy card create <title>` - POST `/boards/:id/cards`
-- `fizzy card update <number> <title>` - PUT `/cards/:number`
-- `fizzy card delete <number>` - DELETE `/cards/:number`
-- `fizzy card close <number>` - POST `/cards/:number/closure`
-- `fizzy card reopen <number>` - DELETE `/cards/:number/closure`
-- `fizzy card tag <number> <tag>` - POST `/cards/:number/taggings`
-- `fizzy card assign <number> <user_id>` - POST `/cards/:number/assignments`
-- `fizzy card triage <number> <column_id>` - POST `/cards/:number/triage`
-
-#### Columns
-- `fizzy column list` - GET `/boards/:id/columns`
-- `fizzy column create <name>` - POST `/boards/:id/columns`
-
-#### Tags
-- `fizzy tag list` - GET `/tags`
-
-#### Notifications
-- `fizzy notification list` - GET `/notifications`
-- `fizzy notification read <id>` - POST `/notifications/:id/reading`
-- `fizzy notification unread <id>` - DELETE `/notifications/:id/reading`
-- `fizzy notification read-all` - POST `/notifications/bulk_reading`
-
----
-
-## 📋 Missing API Endpoints (Not Yet Implemented)
-
-### High Priority (Core Functionality)
-
-#### Cards - Additional Operations
-- [x] `POST /cards/:number/not_now` - Move card to "Not Now" status
-- [x] `DELETE /cards/:number/triage` - Send card back to triage
-- [x] `POST /cards/:number/watch` - Subscribe to card notifications
-- [x] `DELETE /cards/:number/watch` - Unsubscribe from card notifications
-- [x] `POST /cards/:number/goldness` - Mark card as golden
-- [x] `DELETE /cards/:number/goldness` - Remove golden status
-
-#### Comments
-- [ ] `GET /cards/:number/comments` - List card comments
-- [ ] `GET /cards/:number/comments/:id` - Get specific comment
-- [ ] `POST /cards/:number/comments` - Create comment
-- [ ] `PUT /cards/:number/comments/:id` - Update comment
-- [ ] `DELETE /cards/:number/comments/:id` - Delete comment
-
-#### Reactions
-- [ ] `GET /cards/:number/comments/:id/reactions` - List reactions on comment
-- [ ] `POST /cards/:number/comments/:id/reactions` - Add reaction
-- [ ] `DELETE /cards/:number/comments/:id/reactions/:id` - Remove reaction
-
-#### Steps (To-do items)
-- [ ] `GET /cards/:number/steps/:id` - Get step details
-- [ ] `POST /cards/:number/steps` - Create step
-- [ ] `PUT /cards/:number/steps/:id` - Update step
-- [ ] `DELETE /cards/:number/steps/:id` - Delete step
-
-#### Board Management
-- [ ] `PUT /boards/:id` - Update board settings
-- [ ] `DELETE /boards/:id` - Delete board
-- [ ] Support for board parameters: `all_access`, `auto_postpone_period`, `public_description`, `user_ids`
-
-#### Columns
-- [ ] `GET /boards/:id/columns/:id` - Get specific column
-- [ ] `PUT /boards/:id/columns/:id` - Update column
-- [ ] `DELETE /boards/:id/columns/:id` - Delete column
-
-#### Users
-- [ ] `GET /users` - List account users
-- [ ] `GET /users/:id` - Get user details
-- [ ] `PUT /users/:id` - Update user
-- [ ] `DELETE /users/:id` - Deactivate user
-
-#### Identity
-- [ ] `GET /my/identity` - Get current user's accounts and identity (may already be partially implemented)
-
-### Medium Priority (Enhancement Features)
-
-#### Card Filtering & Search
-- Implement all card filter parameters:
-  - `board_ids[]` (partial - implemented)
-  - `tag_ids[]`
-  - `assignee_ids[]`
-  - `creator_ids[]`
-  - `closer_ids[]`
-  - `card_ids[]`
-  - `indexed_by` (all, closed, not_now, stalled, postponing_soon, golden)
-  - `sorted_by` (latest, newest, oldest)
-  - `assignment_status` (unassigned)
-  - `creation` (date filters)
-  - `closure` (date filters)
-  - `terms[]` (search)
-
-#### Advanced Features
-- [ ] File uploads for card images
-- [ ] Rich text field support with HTML validation
-- [ ] ActionText direct upload for embedded files
-- [ ] ETag/Cache-Control header support for bandwidth optimization
-- [ ] Pagination support (Link header rel="next")
-
----
-
-## 🎯 Implementation Priority Roadmap
-
-### Phase 1: Core Card Enhancements (Quick wins)
-These are card-related operations with minimal API client work since the pattern is established.
-
-1. ✅ **card not-now** - Move card to "Not Now" status
-2. ✅ **card untriage** - Send card back to triage
-3. ✅ **card watch** / **card unwatch** - Notification subscriptions
-4. ✅ **card golden** / **card ungolden** - Mark as golden
-
-### Phase 2: Comments & Reactions (Foundational)
-Users often need to collaborate through comments.
-
-1. **comment list** - `GET /cards/:number/comments`
-2. **comment show** - `GET /cards/:number/comments/:id`
-3. **comment add** - `POST /cards/:number/comments`
-4. **comment update** - `PUT /cards/:number/comments/:id`
-5. **comment delete** - `DELETE /cards/:number/comments/:id`
-6. **reaction add** - `POST /cards/:number/comments/:id/reactions`
-7. **reaction list** - `GET /cards/:number/comments/:id/reactions`
-8. **reaction remove** - `DELETE /cards/:number/comments/:id/reactions/:id`
-
-### Phase 3: Steps (To-do items)
-Essential for breaking down work.
-
-1. **step add** - `POST /cards/:number/steps`
-2. **step list** - Via card show (embedded)
-3. **step update** - `PUT /cards/:number/steps/:id`
-4. **step remove** - `DELETE /cards/:number/steps/:id`
-
-### Phase 4: Board & Column Management
-Administrative operations.
-
-1. **board update** - `PUT /boards/:id`
-2. **board delete** - `DELETE /boards/:id`
-3. **column show** - `GET /boards/:id/columns/:id`
-4. **column update** - `PUT /boards/:id/columns/:id`
-5. **column delete** - `DELETE /boards/:id/columns/:id`
-
-### Phase 5: Users & Advanced Features
-Less common but important for team management.
-
-1. **user list** - `GET /users`
-2. **user show** - `GET /users/:id`
-3. **user update** - `PUT /users/:id`
-4. **user deactivate** - `DELETE /users/:id`
-5. Card filtering enhancements
-6. File uploads & rich text
-7. Pagination support
-8. ETag caching
-
----
-
-## 📊 Command Structure Pattern
-
-All commands follow this pattern:
-
-```go
-// File: cmd/resource_action.go
-
-var resourceActionCmd = &cobra.Command{
-	Use:   "action <args>",
-	Short: "Brief description",
-	Long:  `Longer description`,
-	Args:  cobra.ExactArgs(N), // or other validators
-	Run: func(cmd *cobra.Command, args []string) {
-		if err := handleResourceAction(cmd, args...); err != nil {
-			fmt.Fprintf(cmd.OutOrStderr(), "Error: %v\n", err)
-		}
-	},
-}
-
-func handleResourceAction(cmd *cobra.Command, args ...string) error {
-	a := app.FromContext(cmd.Context())
-	if a == nil || a.Client == nil {
-		return fmt.Errorf("API client not available")
-	}
-	
-	// API call
-	result, err := a.Client.MethodName(context.Background(), args...)
-	if err != nil {
-		return fmt.Errorf("operation failed: %w", err)
-	}
-	
-	// Display result
-	return ui.DisplayResource(result)
-}
-
-func init() {
-	parentCmd.AddCommand(resourceActionCmd)
-	// Add flags if needed
-}
-```
-
----
-
-## 📝 API Client Work Required
-
-### New Methods Needed in `internal/api/client.go`
-
-**Card Operations:**
-```go
-func (c *Client) PostCardNotNow(ctx context.Context, cardNumber int) (bool, error)
-func (c *Client) DeleteCardTriage(ctx context.Context, cardNumber int) (bool, error)
-func (c *Client) PostCardWatch(ctx context.Context, cardNumber int) (bool, error)
-func (c *Client) DeleteCardWatch(ctx context.Context, cardNumber int) (bool, error)
-func (c *Client) PostCardGoldenness(ctx context.Context, cardNumber int) (bool, error)
-func (c *Client) DeleteCardGoldenness(ctx context.Context, cardNumber int) (bool, error)
-```
-
-**Comment Operations:**
-```go
-func (c *Client) GetCardComments(ctx context.Context, cardNumber int) ([]Comment, error)
-func (c *Client) GetCardComment(ctx context.Context, cardNumber int, commentID string) (*Comment, error)
-func (c *Client) PostCardComment(ctx context.Context, cardNumber int, body string) (bool, error)
-func (c *Client) PutCardComment(ctx context.Context, cardNumber int, commentID string, body string) (bool, error)
-func (c *Client) DeleteCardComment(ctx context.Context, cardNumber int, commentID string) (bool, error)
-```
-
-**Reaction Operations:**
-```go
-func (c *Client) GetCommentReactions(ctx context.Context, cardNumber int, commentID string) ([]Reaction, error)
-func (c *Client) PostCommentReaction(ctx context.Context, cardNumber int, commentID string, content string) (bool, error)
-func (c *Client) DeleteCommentReaction(ctx context.Context, cardNumber int, commentID string, reactionID string) (bool, error)
-```
-
-**Step Operations:**
-```go
-func (c *Client) PostCardStep(ctx context.Context, cardNumber int, content string) (bool, error)
-func (c *Client) GetCardStep(ctx context.Context, cardNumber int, stepID string) (*Step, error)
-func (c *Client) PutCardStep(ctx context.Context, cardNumber int, stepID string, payload UpdateStepPayload) (bool, error)
-func (c *Client) DeleteCardStep(ctx context.Context, cardNumber int, stepID string) (bool, error)
-```
-
-**Board Operations:**
-```go
-func (c *Client) PutBoard(ctx context.Context, boardID string, payload UpdateBoardPayload) (bool, error)
-func (c *Client) DeleteBoard(ctx context.Context, boardID string) (bool, error)
-```
-
-**Column Operations:**
-```go
-func (c *Client) GetColumn(ctx context.Context, columnID string) (*Column, error)
-func (c *Client) PutColumn(ctx context.Context, columnID string, payload UpdateColumnPayload) (bool, error)
-func (c *Client) DeleteColumn(ctx context.Context, columnID string) (bool, error)
-```
-
-**User Operations:**
-```go
-func (c *Client) GetUsers(ctx context.Context) ([]User, error)
-func (c *Client) GetUser(ctx context.Context, userID string) (*User, error)
-func (c *Client) PutUser(ctx context.Context, userID string, payload UpdateUserPayload) (bool, error)
-func (c *Client) DeleteUser(ctx context.Context, userID string) (bool, error)
-```
-
-### New Data Types Needed
-
-```go
-type Comment struct {
-	ID        string
-	CreatedAt string
-	UpdatedAt string
-	Body      map[string]string // {plain_text, html}
-	Creator   User
-	Card      CardReference
-	ReactionsURL string
-	URL       string
-}
-
-type Reaction struct {
-	ID       string
-	Content  string
-	Reacter  User
-	URL      string
-}
-
-type Step struct {
-	ID        string
-	Content   string
-	Completed bool
-}
-
-type UpdateStepPayload struct {
-	Content   string `json:"content,omitempty"`
-	Completed bool   `json:"completed,omitempty"`
-}
-
-type UpdateBoardPayload struct {
-	Name               string   `json:"name,omitempty"`
-	AllAccess          bool     `json:"all_access,omitempty"`
-	AutoPostponePeriod int      `json:"auto_postpone_period,omitempty"`
-	PublicDescription  string   `json:"public_description,omitempty"`
-	UserIDs            []string `json:"user_ids,omitempty"`
-}
-
-type UpdateColumnPayload struct {
-	Name  string `json:"name,omitempty"`
-	Color *Color `json:"color,omitempty"`
-}
-
-type UpdateUserPayload struct {
-	Name   string `json:"name,omitempty"`
-	Avatar string `json:"avatar,omitempty"` // file upload
-}
-```
-
----
-
-## 🔍 Next Steps Recommendation
-
-**Start with Phase 1 (Card Enhancements)** as they:
-- Have proven command patterns already in codebase
-- Require minimal new API client code
-- Deliver immediate user value
-- Build confidence before tackling complex features like comments
-
-**Suggested first command:** `card not-now` - single simple API call, no new data types needed.