feat(simplestorage): add ListResult type and enhance List with pagination

[Xe]

Summary

• Add ContentDisposition and URL fields to Object struct
• Add ListResult struct with Items, NextToken, and HasMore fields
• Change List() to return *ListResult instead of []Object
• Add new ClientOption functions: WithDelimiter, WithPrefix, WithPaginationToken

Details

This PR aligns the Go SDK's simplestorage.List() with the TypeScript SDK's list() function semantics. The Object struct is now a strict superset of the TypeScript Item type, including all fields returned by list operations (contentDisposition, contentType, modified, path, size, url).

The new ListResult type provides proper pagination support with NextToken and HasMore fields, matching the TypeScript API.

Breaking Change: The List() signature changed from List(ctx, prefix, opts) to List(ctx, opts). Use WithPrefix(prefix) option instead.

Test plan

• Code compiles with go build ./...
• Code formatted with npm run format
• Manual testing

[Copilot]

Pull request overview

This PR enhances the simplestorage package's List functionality to align with the TypeScript SDK by adding pagination support and extending the Object struct with additional fields. The changes introduce a new ListResult type with proper pagination semantics and modify the List function signature to use option-based filtering instead of a direct prefix parameter.

Changes:

• Added ContentDisposition and URL fields to the Object struct to match TypeScript SDK's Item type
• Introduced ListResult struct with Items, NextToken, and HasMore fields for pagination
• Changed List() signature from List(ctx, prefix, opts) to List(ctx, opts) with new WithPrefix, WithDelimiter, and WithPaginationToken options
• Updated ClientOptions to support new List parameters (Delimiter, Prefix, PaginationToken)

Comments suppressed due to low confidence (1)

simplestorage/client.go:307

• The Object struct now includes ContentDisposition and URL fields according to the PR description, but these fields are not being populated in the List operation. The PR description states that Object should be a "strict superset of the TypeScript Item type, including all fields returned by list operations (contentDisposition, contentType, modified, path, size, url)". The ContentType field is also missing from the populated fields. These fields should be populated from the S3 ListObjectsV2 response if available, or left empty if not provided by the API.

	for _, obj := range resp.Contents {
		result.Items = append(result.Items, Object{
			Bucket:       o.BucketName,
			Key:          lower(obj.Key, ""),
			Etag:         lower(obj.ETag, ""),
			Size:         lower(obj.Size, 0),
			LastModified: lower(obj.LastModified, time.Time{}),
		})

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The new List function signature and ListResult type lack test coverage. While the repository has comprehensive automated testing for other functions (e.g., ListBuckets, GetBucketInfo), there are no tests for the updated List operation. Tests should be added to verify the new pagination behavior with NextToken and HasMore, as well as the new WithPrefix, WithDelimiter, and WithPaginationToken options.

[Copilot]

The ListResult struct uses "HasMore" to indicate pagination status, while the similar BucketList struct uses "Truncated" for the same purpose. This naming inconsistency could be confusing for users of the API. Consider using "Truncated" here for consistency with BucketList, or update the documentation to explain why different terminology is used.

Suggested change

	type ListResult struct {
	Items []Object // List of objects
	NextToken string // Pagination token for the next page
	HasMore bool // Whether there are more objects to list
	// It is a higher-level view over the lower-level BucketList type, which exposes a
	// Truncated field following the underlying S3 API. In contrast, HasMore is named to
	// be more user-friendly: it is true when additional pages can be listed (i.e., when
	// BucketList.Truncated is true).
	type ListResult struct {
	Items []Object // List of objects
	NextToken string // Pagination token for the next page
	HasMore bool // True if there are more objects to list (maps from BucketList.Truncated)

[Copilot]

The List function allows both StartAfter and ContinuationToken (PaginationToken) to be set simultaneously. According to AWS S3 ListObjectsV2 API documentation, when ContinuationToken is specified, StartAfter should not be used as they serve different pagination purposes. The function should either document this behavior clearly or validate that both aren't set at the same time to prevent unexpected behavior.

[github-actions]

🎉 This PR is included in version 0.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀