Merge pull request #30 from cuiko/feat/msg-sticker-set

feat(msg): Add `msg sticker add` / `remove` to install sticker sets

Author: cuiko tang

README.md

@@ -133,6 +133,7 @@ client commands route through when present).
 | `tg msg send <ref> [text...]` | Send text. Repeat `--file <path>` to attach one or more files; text becomes the first media caption. Use `--name` to override upload filenames. `--sticker <ref>` / `--gif <ref>` send a sticker/gif — either a `msg sticker list`/`msg gif list` ref or a `<msg-ref>` of an existing one (no text/`--file`). |
 | `tg msg sticker list` | List your stickers to get a sendable `ref`. `--recent` (default), `--faved`, `--installed` (sets), `--all` (recent+faved+all sets expanded; slow). |
 | `tg msg sticker fave <ref>` / `tg msg sticker unfave <ref>` | Add or remove a sticker from favorites (`<ref>` is a list ref or `<msg-ref>`). |
+| `tg msg sticker add <set>` / `tg msg sticker remove <set>` | Install or uninstall a sticker set. `<set>` is a set short name or an `https://t.me/addstickers/<name>` link. |
 | `tg msg gif list` | List your saved GIFs, each with a sendable `ref`. |
 | `tg msg poll <ref> <question> <option>...` | Send a poll (≥2 options). `--multiple`, `--public` (default anonymous); `--correct <n>` makes it a quiz with optional `--explanation`. |
 | `tg msg vote <msg-ref> <option-number>...` | Vote on a poll by 1-based option number (multiple numbers for multiple-choice polls); `--retract` to take back your vote. |

internal/action/message/sticker_set.go

@@ -0,0 +1,72 @@
+package message
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/vika2603/telegram-cli/internal/command"
+	"github.com/vika2603/telegram-cli/internal/output"
+)
+
+// StickerSetRequest is the raw request for `tg msg sticker add` / `remove`.
+type StickerSetRequest struct {
+	RawSet string
+	Remove bool
+}
+
+// StickerSetQuery is the normalized payload passed to the Telegram layer.
+type StickerSetQuery struct {
+	ShortName string
+	Remove    bool
+}
+
+// StickerSetFunc installs or uninstalls a sticker set.
+type StickerSetFunc func(context.Context, StickerSetQuery) (output.StickerSetResult, error)
+
+// InstallStickerSet validates the request and dispatches the install/uninstall
+// (uninstall when req.Remove). Named for the positive verb, mirroring
+// FaveSticker, which likewise covers its inverse via a flag.
+func InstallStickerSet(ctx context.Context, req StickerSetRequest, do StickerSetFunc) (output.StickerSetResult, error) {
+	name, err := parseStickerSetRef(req.RawSet)
+	if err != nil {
+		return output.StickerSetResult{}, err
+	}
+	if do == nil {
+		return output.StickerSetResult{}, fmt.Errorf("%w: msg sticker set called without function", command.ErrPrecondition)
+	}
+	return do(ctx, StickerSetQuery{ShortName: name, Remove: req.Remove})
+}
+
+// stickerSetURLPrefixes are the addstickers link forms a short name may be
+// wrapped in; we strip them so the user can paste a share link directly.
+var stickerSetURLPrefixes = []string{
+	"https://t.me/addstickers/",
+	"http://t.me/addstickers/",
+	"https://telegram.me/addstickers/",
+	"t.me/addstickers/",
+	"telegram.me/addstickers/",
+	"addstickers/",
+}
+
+// parseStickerSetRef accepts a sticker set short name or an addstickers link
+// and returns the bare short name. Short-name character validation is left to
+// Telegram, which rejects unknown sets with STICKERSET_INVALID.
+func parseStickerSetRef(raw string) (string, error) {
+	s := strings.TrimSpace(raw)
+	for _, p := range stickerSetURLPrefixes {
+		if rest, ok := strings.CutPrefix(s, p); ok {
+			s = rest
+			break
+		}
+	}
+	// A link may carry a trailing query/fragment (e.g. ?foo); keep only the
+	// short-name segment.
+	if i := strings.IndexAny(s, "/?#"); i >= 0 {
+		s = s[:i]
+	}
+	if s == "" {
+		return "", fmt.Errorf("%w: empty sticker set reference", command.ErrUsage)
+	}
+	return s, nil
+}

internal/action/message/sticker_set_test.go

@@ -0,0 +1,50 @@
+package message_test
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	actionmessage "github.com/vika2603/telegram-cli/internal/action/message"
+	"github.com/vika2603/telegram-cli/internal/command"
+	"github.com/vika2603/telegram-cli/internal/output"
+)
+
+func TestStickerSet_ParsesShortNameAndLinks(t *testing.T) {
+	for _, in := range []string{
+		"Animals",
+		"addstickers/Animals",
+		"t.me/addstickers/Animals",
+		"https://t.me/addstickers/Animals",
+		"https://telegram.me/addstickers/Animals",
+		"https://t.me/addstickers/Animals?utm=x",
+	} {
+		_, err := actionmessage.InstallStickerSet(context.Background(), actionmessage.StickerSetRequest{RawSet: in},
+			func(_ context.Context, q actionmessage.StickerSetQuery) (output.StickerSetResult, error) {
+				require.Equal(t, "Animals", q.ShortName, in)
+				require.False(t, q.Remove)
+				return output.StickerSetResult{Action: "add", Set: q.ShortName}, nil
+			})
+		require.NoError(t, err, in)
+	}
+}
+
+func TestStickerSet_RemovePassesThrough(t *testing.T) {
+	_, err := actionmessage.InstallStickerSet(context.Background(), actionmessage.StickerSetRequest{RawSet: "Animals", Remove: true},
+		func(_ context.Context, q actionmessage.StickerSetQuery) (output.StickerSetResult, error) {
+			require.Equal(t, "Animals", q.ShortName)
+			require.True(t, q.Remove)
+			return output.StickerSetResult{Action: "remove", Set: q.ShortName}, nil
+		})
+	require.NoError(t, err)
+}
+
+func TestStickerSet_RejectsEmptyRef(t *testing.T) {
+	_, err := actionmessage.InstallStickerSet(context.Background(), actionmessage.StickerSetRequest{RawSet: "  "},
+		func(context.Context, actionmessage.StickerSetQuery) (output.StickerSetResult, error) {
+			t.Fatal("must not dispatch")
+			return output.StickerSetResult{}, nil
+		})
+	require.ErrorIs(t, err, command.ErrUsage)
+}

internal/cli/msg/sticker/sticker.go

@@ -27,9 +27,70 @@ func New(f *runtime.Invocation) *cobra.Command {
 	cmd.AddCommand(newList(f, nil))
 	cmd.AddCommand(newFave(f, nil, false, "fave", "Add a sticker to favorites"))
 	cmd.AddCommand(newFave(f, nil, true, "unfave", "Remove a sticker from favorites"))
+	cmd.AddCommand(newSet(f, nil, false, "add", "Install a sticker set"))
+	cmd.AddCommand(newSet(f, nil, true, "remove", "Uninstall a sticker set"))
 	return cmd
 }
 
+// SetOptions holds flags/deps for `sticker add` / `remove`.
+type SetOptions struct {
+	RawSet    string
+	Remove    bool
+	Exporter  output.Exporter
+	IOStreams *ui.IOStreams
+	Do        actionmessage.StickerSetFunc
+}
+
+func newSet(f *runtime.Invocation, runF func(*SetOptions) error, remove bool, use, short string) *cobra.Command {
+	opts := &SetOptions{Remove: remove}
+	cmd := &cobra.Command{
+		Use:   use + " <set>",
+		Short: short,
+		Long:  short + ". <set> is a sticker set short name or an https://t.me/addstickers/<name> link.",
+		Args:  cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			opts.RawSet = args[0]
+			opts.IOStreams = f.IOStreams
+			if runF != nil {
+				return runF(opts)
+			}
+			opts.Do = newSetDo(f)
+			return RunSet(cmd.Context(), opts)
+		},
+	}
+	command.SetMeta(cmd, command.Meta{NeedsAccount: true, NeedsClient: true})
+	output.AddJSONFlags(cmd, &opts.Exporter, []string{"action", "set", "title", "count", "archived"})
+	return cmd
+}
+
+// RunSet dispatches install/uninstall.
+func RunSet(ctx context.Context, opts *SetOptions) error {
+	res, err := actionmessage.InstallStickerSet(ctx, actionmessage.StickerSetRequest{RawSet: opts.RawSet, Remove: opts.Remove}, opts.Do)
+	if err != nil {
+		return err
+	}
+	if opts.Exporter != nil {
+		return opts.Exporter.Write(opts.IOStreams, res)
+	}
+	return output.RenderStickerSet(opts.IOStreams, res)
+}
+
+func newSetDo(f *runtime.Invocation) actionmessage.StickerSetFunc {
+	return func(ctx context.Context, q actionmessage.StickerSetQuery) (output.StickerSetResult, error) {
+		acct, err := f.Account("")
+		if err != nil {
+			return output.StickerSetResult{}, err
+		}
+		var res output.StickerSetResult
+		err = f.WithPeers(ctx, acct, runtime.ClientOptsFrom(f, acct),
+			func(ctx context.Context, api *tg.Client, _ *peers.Manager, _ *peer.Resolver) error {
+				res, err = telegram.InstallStickerSet(ctx, api, q)
+				return err
+			})
+		return res, err
+	}
+}
+
 // FaveOptions holds flags/deps for `sticker fave` / `unfave`.
 type FaveOptions struct {
 	RawRef    string

internal/output/sticker.go

@@ -34,6 +34,32 @@ func RenderFave(io *ui.IOStreams, r FaveResult) error {
 	return tp.Render()
 }
 
+// StickerSetResult is emitted by `tg msg sticker add` / `remove`.
+type StickerSetResult struct {
+	Action   string `json:"action"`             // "add" | "remove"
+	Set      string `json:"set"`                // set short name
+	Title    string `json:"title,omitempty"`    // set title
+	Count    int    `json:"count,omitempty"`    // stickers in set
+	Archived bool   `json:"archived,omitempty"` // add archived the set instead of installing
+}
+
+// RenderStickerSet prints an install/uninstall confirmation.
+func RenderStickerSet(io *ui.IOStreams, r StickerSetResult) error {
+	tp := NewTablePrinter(io)
+	tp.AddRow("ACTION", r.Action)
+	tp.AddRow("SET", r.Set)
+	if r.Title != "" {
+		tp.AddRow("TITLE", r.Title)
+	}
+	if r.Count > 0 {
+		tp.AddRow("COUNT", strconv.Itoa(r.Count))
+	}
+	if r.Archived {
+		tp.AddRow("ARCHIVED", "true")
+	}
+	return tp.Render()
+}
+
 // RenderStickers prints sticker rows (or set rows) as a table.
 func RenderStickers(io *ui.IOStreams, rows []StickerRow) error {
 	tp := NewTablePrinter(io)

internal/program/status/rpc.go

@@ -46,6 +46,7 @@ var rpcErrors = map[string]rpcClass{
 	tg.ErrUserCreator:          {CodeUsage, 2, "this action isn't allowed on the group/channel creator"},
 	tg.ErrFileReferenceExpired: {CodeUsage, 2, "sticker reference expired; run `tg msg sticker list` again for a fresh ref"},
 	tg.ErrFileReferenceInvalid: {CodeUsage, 2, "sticker reference is no longer valid; run `tg msg sticker list` again for a fresh ref"},
+	tg.ErrStickersetInvalid:    {CodeUsage, 2, "no such sticker set (check the short name or addstickers link)"},
 }
 
 // matchRPC returns the classification for a known raw Telegram RPC error

internal/program/status/rpc_test.go

@@ -32,7 +32,7 @@ func TestRPC_ClassifiesForbiddenFamily(t *testing.T) {
 }
 
 func TestRPC_ClassifiesUsageFamily(t *testing.T) {
-	for _, typ := range []string{"HIDE_REQUESTER_MISSING", "PARTICIPANT_ID_INVALID", "USER_CREATOR"} {
+	for _, typ := range []string{"HIDE_REQUESTER_MISSING", "PARTICIPANT_ID_INVALID", "USER_CREATOR", "STICKERSET_INVALID"} {
 		err := rpcErr(typ, 400)
 		require.Equal(t, CodeUsage, Code(err), typ)
 		require.Equal(t, 2, MapExitCode(err), typ)

internal/telegram/sticker.go

@@ -201,6 +201,46 @@ func faveStickerCall(ctx context.Context, api *tg.Client, doc *tg.InputDocument,
 	return err
 }
 
+// InstallStickerSet installs or (when q.Remove) uninstalls a sticker set by
+// short name. The set is fetched first to validate it exists and to surface
+// its title/count in the result.
+func InstallStickerSet(ctx context.Context, api *tg.Client, q actionmessage.StickerSetQuery) (output.StickerSetResult, error) {
+	input := &tg.InputStickerSetShortName{ShortName: q.ShortName}
+	got, err := api.MessagesGetStickerSet(ctx, &tg.MessagesGetStickerSetRequest{Stickerset: input})
+	if err != nil {
+		return output.StickerSetResult{}, err
+	}
+	full, ok := got.(*tg.MessagesStickerSet)
+	if !ok {
+		return output.StickerSetResult{}, fmt.Errorf("%w: sticker set %q is unavailable", command.ErrUnsupported, q.ShortName)
+	}
+	res := output.StickerSetResult{
+		Set:   full.Set.ShortName,
+		Title: full.Set.Title,
+		Count: full.Set.Count,
+	}
+
+	if q.Remove {
+		if _, err := api.MessagesUninstallStickerSet(ctx, input); err != nil {
+			return output.StickerSetResult{}, err
+		}
+		res.Action = "remove"
+		return res, nil
+	}
+
+	installed, err := api.MessagesInstallStickerSet(ctx, &tg.MessagesInstallStickerSetRequest{Stickerset: input})
+	if err != nil {
+		return output.StickerSetResult{}, err
+	}
+	res.Action = "add"
+	// Telegram may archive the set instead of installing it (e.g. when the
+	// installed-set limit is hit); surface that rather than implying success.
+	if _, ok := installed.(*tg.MessagesStickerSetInstallResultArchive); ok {
+		res.Archived = true
+	}
+	return res, nil
+}
+
 // refreshStickerRef re-fetches the sticker's owning set and returns the doc
 // with a fresh file reference. Used to recover from FILE_REFERENCE_EXPIRED.
 func refreshStickerRef(ctx context.Context, api *tg.Client, doc *actionmessage.StickerDoc) (*actionmessage.StickerDoc, error) {