Merge pull request #17 from Telegram-Mini-Apps/16-use-initdata-by-reference

fix: use pointers instead of values

Author: heyqbnk

chat.go

@@ -26,7 +26,7 @@ func (c ChatType) Known() bool {
 }
 
 // Chat describes chat information:
-// https://docs.telegram-mini-apps.com/launch-parameters/init-data#chat
+// https://docs.telegram-mini-apps.com/platform/init-data#chat
 type Chat struct {
 	// Unique identifier for this chat.
 	ID int64 `json:"id"`
@@ -39,8 +39,8 @@ type Chat struct {
 
 	// Optional. URL of the chat’s photo. The photo can be in .jpeg or .svg
 	// formats. Only returned for Web Apps launched from the attachment menu.
-	PhotoURL string `json:"photo_url"`
+	PhotoURL string `json:"photo_url,omitempty"`
 
 	// Optional. Username of the chat.
-	Username string `json:"username"`
+	Username string `json:"username,omitempty"`
 }

init_data.go

@@ -5,7 +5,7 @@ import (
 )
 
 // InitData contains init data.
-// https://docs.telegram-mini-apps.com/launch-parameters/init-data#parameters-list
+// https://docs.telegram-mini-apps.com/platform/init-data
 type InitData struct {
 	// The date the initialization data was created. Is a number representing a
 	// Unix timestamp.
@@ -14,20 +14,20 @@ type InitData struct {
 	// Optional. The number of seconds after which a message can be sent via
 	// the method answerWebAppQuery.
 	// https://core.telegram.org/bots/api#answerwebappquery
-	CanSendAfterRaw int `json:"can_send_after"`
+	CanSendAfterRaw int `json:"can_send_after,omitempty"`
 
 	// Optional. An object containing information about the chat with the bot in
 	// which the Mini Apps was launched. It is returned only for Mini Apps
 	// opened through the attachment menu.
-	Chat Chat `json:"chat"`
+	Chat *Chat `json:"chat,omitempty"`
 
 	// Optional. The type of chat from which the Mini Apps was opened.
 	// Returned only for applications opened by direct link.
-	ChatType ChatType `json:"chat_type"`
+	ChatType ChatType `json:"chat_type,omitempty"`
 
 	// Optional. A global identifier indicating the chat from which the Mini
 	// Apps was opened. Returned only for applications opened by direct link.
-	ChatInstance int64 `json:"chat_instance"`
+	ChatInstance int64 `json:"chat_instance,omitempty"`
 
 	// Initialization data signature.
 	// https://core.telegram.org/bots/webapps#validating-data-received-via-the-web-app
@@ -36,21 +36,21 @@ type InitData struct {
 	// Optional. The unique session ID of the Mini App. Used in the process of
 	// sending a message via the method answerWebAppQuery.
 	// https://core.telegram.org/bots/api#answerwebappquery
-	QueryID string `json:"query_id"`
+	QueryID string `json:"query_id,omitempty"`
 
 	// Optional. An object containing data about the chat partner of the current
 	// user in the chat where the bot was launched via the attachment menu.
 	// Returned only for private chats and only for Mini Apps launched via the
 	// attachment menu.
-	Receiver User `json:"receiver"`
+	Receiver *User `json:"receiver,omitempty"`
 
 	// Optional. The value of the startattach or startapp query parameter
 	// specified in the link. It is returned only for Mini Apps opened through
 	// the attachment menu.
-	StartParam string `json:"start_param"`
+	StartParam string `json:"start_param,omitempty"`
 
 	// Optional. An object containing information about the current user.
-	User User `json:"user"`
+	User *User `json:"user,omitempty"`
 }
 
 // AuthDate returns AuthDateRaw as time.Time.

parse.go

@@ -16,11 +16,11 @@ var (
 
 // Parse converts passed init data presented as query string to InitData
 // object.
-func Parse(initData string) (InitData, error) {
+func Parse(initData string) (*InitData, error) {
 	// Parse passed init data as query string.
 	q, err := url.ParseQuery(initData)
 	if err != nil {
-		return InitData{}, fmt.Errorf("parse init data as query: %w: %w", err, ErrUnexpectedFormat)
+		return nil, fmt.Errorf("parse init data as query: %w: %w", err, ErrUnexpectedFormat)
 	}
 
 	// According to documentation, we could only meet such types as int64,
@@ -42,10 +42,10 @@ func Parse(initData string) (InitData, error) {
 	}
 
 	// Unmarshal JSON to our custom structure.
-	var d InitData
+	var d *InitData
 	jStr := fmt.Sprintf("{%s}", strings.Join(pairs, ","))
 	if err := json.Unmarshal([]byte(jStr), &d); err != nil {
-		return InitData{}, fmt.Errorf("unmarshal init data: %w: %w", err, ErrUnexpectedFormat)
+		return nil, fmt.Errorf("unmarshal init data: %w: %w", err, ErrUnexpectedFormat)
 	}
 	return d, nil
 }

parse_test.go

@@ -13,7 +13,7 @@ const (
 type testParse struct {
 	initData    string
 	expectedErr error
-	expectedRes InitData
+	expectedRes *InitData
 }
 
 var testsParse = []testParse{
@@ -23,9 +23,9 @@ var testsParse = []testParse{
 	},
 	{
 		initData: _parseTestInitData,
-		expectedRes: InitData{
+		expectedRes: &InitData{
 			QueryID: "AAHdF6IQAAAAAN0XohDhrOrc",
-			User: User{
+			User: &User{
 				ID:           279058397,
 				FirstName:    "Vladislav",
 				LastName:     "Kibenko",

user.go

@@ -1,13 +1,13 @@
 package initdata
 
 // User describes user information:
-// https://docs.telegram-mini-apps.com/launch-parameters/init-data#user
+// https://docs.telegram-mini-apps.com/platform/init-data#user
 type User struct {
 	// Optional. True, if this user added the bot to the attachment menu.
-	AddedToAttachmentMenu bool `json:"added_to_attachment_menu"`
+	AddedToAttachmentMenu bool `json:"added_to_attachment_menu,omitempty"`
 
 	// Optional. True, if this user allowed the bot to message them.
-	AllowsWriteToPm bool `json:"allows_write_to_pm"`
+	AllowsWriteToPm bool `json:"allows_write_to_pm,omitempty"`
 
 	// First name of the user or bot.
 	FirstName string `json:"first_name"`
@@ -17,24 +17,24 @@ type User struct {
 
 	// Optional. True, if this user is a bot. Returned in the `receiver` field
 	// only.
-	IsBot bool `json:"is_bot"`
+	IsBot bool `json:"is_bot,omitempty"`
 
 	// Optional. True, if this user is a Telegram Premium user.
-	IsPremium bool `json:"is_premium"`
+	IsPremium bool `json:"is_premium,omitempty"`
 
 	// Optional. Last name of the user or bot.
-	LastName string `json:"last_name"`
+	LastName string `json:"last_name,omitempty"`
 
 	// Optional. Username of the user or bot.
-	Username string `json:"username"`
+	Username string `json:"username,omitempty"`
 
 	// Optional. IETF language tag of the user's language. Returns in user
 	// field only.
 	// https://en.wikipedia.org/wiki/IETF_language_tag
-	LanguageCode string `json:"language_code"`
+	LanguageCode string `json:"language_code,omitempty"`
 
 	// Optional. URL of the user’s profile photo. The photo can be in .jpeg or
 	// .svg formats. Only returned for Web Apps launched from the
 	// attachment menu.
-	PhotoURL string `json:"photo_url"`
+	PhotoURL string `json:"photo_url,omitempty"`
 }