Merge pull request #285 from dropbox/json-version-share-folder

Add version JSON output and share list folder structured output

Author: AndreyVMarkelov

README.md

@@ -138,6 +138,7 @@ Text output is the default. JSON output is available through the global `--outpu
 
 ```sh
 $ dbxcli <command> --output=json
+$ dbxcli version --output=json
 $ dbxcli account --output=json
 $ dbxcli du --output=json
 $ dbxcli ls --output=json /
@@ -153,12 +154,13 @@ $ dbxcli share-link info --output=json https://www.dropbox.com/s/example/old.pdf
 $ dbxcli share-link update --output=json https://www.dropbox.com/s/example/old.pdf --expires 2026-07-01T00:00:00Z
 $ dbxcli share-link revoke --output=json https://www.dropbox.com/s/example/old.pdf
 $ dbxcli share-link download --output=json https://www.dropbox.com/s/example/old.pdf ./old.pdf
+$ dbxcli share list folder --output=json
 $ dbxcli mkdir --output=json /new-folder
 $ dbxcli rm --output=json /old-file.txt
 $ dbxcli restore --output=json /Reports/old.pdf 015f...
 ```
 
-Structured success output is rolling out command by command. Currently migrated commands are `account`, `du`, `ls`, `search`, `revs`, `cp`, `mv`, `put`, `get`, `share-link create`, `share-link list`, `share-link info`, `share-link update`, `share-link revoke`, `share-link download`, `mkdir`, `rm`, and `restore`. Commands that have not been migrated return a JSON error whose `error.message` is `structured output is not supported for this command yet` when used with `--output=json`.
+Structured success output is rolling out command by command. Currently migrated commands are `version`, `account`, `du`, `ls`, `search`, `revs`, `cp`, `mv`, `put`, `get`, `share-link create`, `share-link list`, `share-link info`, `share-link update`, `share-link revoke`, `share-link download`, `share list folder`, `mkdir`, `rm`, and `restore`. Commands that have not been migrated return a JSON error whose `error.message` is `structured output is not supported for this command yet` when used with `--output=json`.
 
 Command results and JSON errors are written to stdout. Status, progress, human-facing warnings, diagnostics, and verbose logs are written to stderr. JSON errors include a `warnings` array for machine-actionable warnings; it is `[]` when no warnings are present. Successful JSON payloads use the same `warnings` field.
 
@@ -308,7 +310,25 @@ Entry-list commands such as `ls`, `search`, and `revs` use the operation-style w
 }
 ```
 
-Account and usage commands use the operation-style wrapper with a single result:
+Version, account, and usage commands use the operation-style wrapper with a single result:
+
+```json
+{
+  "input": {},
+  "results": [
+    {
+      "kind": "version",
+      "input": {},
+      "result": {
+        "version": "3.4.0",
+        "sdk_version": "6.0.5",
+        "spec_version": "c36ba27"
+      }
+    }
+  ],
+  "warnings": []
+}
+```
 
 ```json
 {
@@ -377,6 +397,31 @@ Shared-link commands use the same operation-style wrapper. `share-link create`,
 
 `share-link revoke` uses `revoked` results whose `result` contains the revoked URL and, when available, the shared-link metadata. `share-link download` uses `downloaded` results whose `result` contains the local `target` and `link` metadata.
 
+The legacy `share list folder` command also supports operation-style JSON. It uses `listed` results with `shared_folder` metadata:
+
+```json
+{
+  "input": {},
+  "results": [
+    {
+      "status": "listed",
+      "kind": "shared_folder",
+      "result": {
+        "type": "shared_folder",
+        "name": "Reports",
+        "path_lower": "/reports",
+        "shared_folder_id": "1234567890",
+        "preview_url": "https://www.dropbox.com/scl/fo/...",
+        "access_type": "owner",
+        "is_inside_team_folder": false,
+        "is_team_folder": false
+      }
+    }
+  ],
+  "warnings": []
+}
+```
+
 `get --output=json <source> -` and `share-link download --output=json <url> -` are not supported because stdout is reserved for downloaded file bytes when the target is `-`.
 
 In JSON mode, command errors are written to stdout as JSON, including errors from commands that do not yet support structured success output. The process still exits with a non-zero status. Detailed diagnostics may also be written to stderr:

cmd/share-list-folders.go

@@ -16,40 +16,138 @@ package cmd
 
 import (
 	"fmt"
+	"io"
 
+	"github.com/dropbox/dropbox-sdk-go-unofficial/v6/dropbox"
 	"github.com/dropbox/dropbox-sdk-go-unofficial/v6/dropbox/sharing"
 	"github.com/spf13/cobra"
 )
 
+type sharedFolderClient interface {
+	ListFolders(*sharing.ListFoldersArgs) (*sharing.ListFoldersResult, error)
+	ListFoldersContinue(*sharing.ListFoldersContinueArg) (*sharing.ListFoldersResult, error)
+}
+
+type shareFolderListInput struct{}
+
+type shareFolderJSONMetadata struct {
+	Type                 string   `json:"type"`
+	Name                 string   `json:"name"`
+	PathLower            string   `json:"path_lower,omitempty"`
+	SharedFolderID       string   `json:"shared_folder_id"`
+	PreviewURL           string   `json:"preview_url,omitempty"`
+	AccessType           string   `json:"access_type,omitempty"`
+	IsInsideTeamFolder   bool     `json:"is_inside_team_folder"`
+	IsTeamFolder         bool     `json:"is_team_folder"`
+	OwnerDisplayNames    []string `json:"owner_display_names,omitempty"`
+	ParentSharedFolderID string   `json:"parent_shared_folder_id,omitempty"`
+	ParentFolderName     string   `json:"parent_folder_name,omitempty"`
+	TimeInvited          *string  `json:"time_invited,omitempty"`
+	AccessInheritance    string   `json:"access_inheritance,omitempty"`
+}
+
+const (
+	shareFolderJSONStatusListed = "listed"
+	shareFolderJSONKindFolder   = "shared_folder"
+)
+
+var newSharedFolderClient = func(cfg dropbox.Config) sharedFolderClient {
+	return sharing.New(cfg)
+}
+
 func shareListFolders(cmd *cobra.Command, args []string) (err error) {
 	arg := sharing.NewListFoldersArgs()
 
-	dbx := sharing.New(config)
-	res, err := dbx.ListFolders(arg)
+	dbx := newSharedFolderClient(config)
+	entries, err := listSharedFolders(dbx, arg)
 	if err != nil {
 		return
 	}
 
-	printFolders(res.Entries)
+	commandVerboseStatus(cmd, "Listed %d shared folders", len(entries))
+
+	return commandOutput(cmd).Render(func(w io.Writer) error {
+		return renderSharedFolders(w, entries)
+	}, newJSONOperationOutput(
+		shareFolderListInput{},
+		shareFolderJSONOperationResults(shareFolderJSONMetadataListFromDropbox(entries)),
+		nil,
+	))
+}
+
+func listSharedFolders(dbx sharedFolderClient, arg *sharing.ListFoldersArgs) ([]*sharing.SharedFolderMetadata, error) {
+	var entries []*sharing.SharedFolderMetadata
+	res, err := dbx.ListFolders(arg)
+	if err != nil {
+		return nil, err
+	}
+	entries = append(entries, res.Entries...)
 
 	for len(res.Cursor) > 0 {
 		continueArg := sharing.NewListFoldersContinueArg(res.Cursor)
 
 		res, err = dbx.ListFoldersContinue(continueArg)
 		if err != nil {
-			return
+			return nil, err
 		}
 
-		printFolders(res.Entries)
+		entries = append(entries, res.Entries...)
 	}
 
-	return
+	return entries, nil
 }
 
-func printFolders(entries []*sharing.SharedFolderMetadata) {
+func renderSharedFolders(out io.Writer, entries []*sharing.SharedFolderMetadata) error {
 	for _, f := range entries {
-		fmt.Printf("%v\t%v\n", f.PathLower, f.PreviewUrl)
+		if _, err := fmt.Fprintf(out, "%v\t%v\n", f.PathLower, f.PreviewUrl); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func shareFolderJSONMetadataListFromDropbox(entries []*sharing.SharedFolderMetadata) []shareFolderJSONMetadata {
+	result := make([]shareFolderJSONMetadata, 0, len(entries))
+	for _, entry := range entries {
+		result = append(result, shareFolderJSONMetadataFromDropbox(entry))
+	}
+	return result
+}
+
+func shareFolderJSONMetadataFromDropbox(entry *sharing.SharedFolderMetadata) shareFolderJSONMetadata {
+	if entry == nil {
+		return shareFolderJSONMetadata{Type: shareFolderJSONKindFolder}
+	}
+
+	result := shareFolderJSONMetadata{
+		Type:                 shareFolderJSONKindFolder,
+		Name:                 entry.Name,
+		PathLower:            entry.PathLower,
+		SharedFolderID:       entry.SharedFolderId,
+		PreviewURL:           entry.PreviewUrl,
+		IsInsideTeamFolder:   entry.IsInsideTeamFolder,
+		IsTeamFolder:         entry.IsTeamFolder,
+		OwnerDisplayNames:    entry.OwnerDisplayNames,
+		ParentSharedFolderID: entry.ParentSharedFolderId,
+		ParentFolderName:     entry.ParentFolderName,
+		TimeInvited:          jsonTime(entry.TimeInvited),
+	}
+	if entry.AccessType != nil {
+		result.AccessType = entry.AccessType.Tag
+	}
+	if entry.AccessInheritance != nil {
+		result.AccessInheritance = entry.AccessInheritance.Tag
+	}
+	return result
+}
+
+func shareFolderJSONOperationResults(entries []shareFolderJSONMetadata) []jsonOperationResult {
+	results := make([]jsonOperationResult, 0, len(entries))
+	for _, entry := range entries {
+		results = append(results, newJSONOperationResult(shareFolderJSONStatusListed, shareFolderJSONKindFolder, nil, entry))
 	}
+	return results
 }
 
 var shareListFoldersCmd = &cobra.Command{
@@ -60,4 +158,5 @@ var shareListFoldersCmd = &cobra.Command{
 
 func init() {
 	shareListCmd.AddCommand(shareListFoldersCmd)
+	enableStructuredOutput(shareListFoldersCmd)
 }