wip

Author: 4kimov

CHANGELOG.md

@@ -1,15 +1,68 @@
 # CHANGELOG
 
-**v0.1.0-alpha.3:**
+## v0.1.0-alpha.4:
+
+### Breaking Changes
+
+- `ViewInBrowser` component now does not accept any params
+- Function definition for `Image` has changed:
+
+  ```go
+  // Old ❌
+  templateless.NewContent().
+    Image(
+      "https://example.com/image.jpg",
+      Some("https://example.com"),
+      Some(200), // Width
+      Some(100), // Height
+      Some("Alt Text"),
+    ).
+    Build()
+  
+  // New (just image) ✅
+  templateless.NewContent().
+    Image("https://example.com/image.jpg").
+    Build()
+  
+  // New (clickable image with custom attributes) ✅
+  url := "https://example.com"
+  width := 300
+  height := 200
+  alt := "Alt text"
+  templateless.NewContent().
+    Component(
+      components.NewImage(
+        "https://placekitten.com/300/200",
+        &url,
+        &width,
+        &height,
+        &alt,
+      ),
+    ).
+    Build()
+  ```
+
+### New Features
+- New social icons: `Mastodon` and `Rss`
+- New `StoreBadges` component
+- New `QrCode` component
+- New `Signature` component
+- New [examples](examples)
+
+### Enhancements
+- Updated README
+- Dependency updates
+
+## v0.1.0-alpha.3:
 - `README.md`: notice about test mode
 - Support for test mode logging
 
-**v0.1.0-alpha.2:**
+## v0.1.0-alpha.2:
 - `README.md` cleanup (listing of components)
 - Added `examples/confirm_email`
 - Renamed `SetFooter()` to `Footer()`
 
-**v0.1.0-alpha.1:**
+## v0.1.0-alpha.1:
 - Introduced `CHANGELOG.md`
 - Introduced new services as social icons:
   - `Phone` (converts into a link with `tel:` prefix)
@@ -24,5 +77,5 @@
   - `Threads`
   - `Telegram`
 
-**v0.1.0-alpha.0:**
+## v0.1.0-alpha.0:
 - Initial implementation

README.md

@@ -40,7 +40,7 @@ It's perfect for SaaS, web apps, mobile apps, scripts and anywhere you have to s
 Use go get:
 
 ```bash
-go get github.com/templateless/[email protected].3
+go get github.com/templateless/[email protected].4
 ```
 
 Then import the package into your own code:
@@ -85,10 +85,8 @@ func main() {
 		Content(*content).
 		Build()
 
-	result, _ := templateless.NewTemplateless("<YOUR_API_KEY>").
+	templateless.NewTemplateless("<YOUR_API_KEY>").
 		Send(*email)
-
-	log.Println(result)
 }
 ```
 
@@ -159,8 +157,7 @@ Link component adds an anchor tag. This is the same as a text component with the
 
 ```go
 templateless.NewContent().
-	Link("Confirm Email", "https://example.com/confirm?token=XYZ"). // or...
-	Text("[Confirm Email](https://example.com/confirm?token=XYZ)").
+	Link("Confirm Email", "https://example.com/confirm?token=XYZ").
 	Build()
 ```
 
@@ -181,13 +178,25 @@ templateless.NewContent().
 Image component will link to an image within your email. Keep in mind that a lot of email clients will prevent images from being loaded automatically for privacy reasons.
 
 ```go
+// Simple
+templateless.NewContent().
+	Image("https://placekitten.com/300/200").
+	Build()
+
+// Clickable & with attributes
+url := "https://example.com"
+width := 300
+height := 200
+alt := "Alt text"
 templateless.NewContent().
-	Image(
-		"https://placekitten.com/300/200",  // where the image is hosted
-		"https://example.com",        		// [optional] link url, if you want it to be clickable
-		300,                          		// [optional] width
-		200,                          		// [optional] height
-		"Alt text",                   		// [optional] alternate text
+	Component(
+		components.NewImage(
+			"https://placekitten.com/300/200",
+			&url,
+			&width,
+			&height,
+			&alt,
+		),
 	).
 	Build()
 ```
@@ -249,6 +258,8 @@ templateless.NewContent().
 		*components.NewSocialItem(components.Snapchat, "Username"),
 		*components.NewSocialItem(components.Threads, "Username"),
 		*components.NewSocialItem(components.Telegram, "Username"),
+		*components.NewSocialItem(components.Mastodon, "@[email protected]"),
+		*components.NewSocialItem(components.Rss, "https://example.com/blog"),
 	}).
 	Build()
 ```
@@ -264,11 +275,98 @@ You can optionally provide the text for the link. If none is provided, default i
 
 ```go
 templateless.NewContent().
-	ViewInBrowser("Read Email in Browser").
+	ViewInBrowser().
+	Build()
+```
+
+</details>
+<details><summary>Store Badges</summary>
+
+Link to your mobile apps via store badges:
+
+```go
+templateless.NewContent().
+	StoreBadges([]components.StoreBadgeItem{
+		*components.NewStoreBadgeItem(components.AppStore, "https://apps.apple.com/us/app/example/id1234567890"),
+		*components.NewStoreBadgeItem(components.GooglePlay, "https://play.google.com/store/apps/details?id=com.example"),
+		*components.NewStoreBadgeItem(components.MicrosoftStore, "https://apps.microsoft.com/detail/example"),
+	}).
 	Build()
 ```
 
 </details>
+<details><summary>QR Code</summary>
+
+You can also generate QR codes on the fly. They will be shown as images inside the email.
+
+Here are all the supported data types:
+
+```go
+// URL
+templateless.NewContent().
+	QrCode("https://example.com").
+	Build()
+
+// Email
+templateless.NewContent().
+	Component(components.QrCodeEmail("[email protected]")).
+	Build()
+
+// Phone
+templateless.NewContent().
+	Component(components.QrCodePhone("123-456-7890")).
+	Build()
+
+// SMS / Text message
+templateless.NewContent().
+	Component(components.QrCodeSMS("123-456-7890")).
+	Build()
+
+// Geo coordinates
+templateless.NewContent().
+	Component(components.QrCodeCoordinates(37.773972, -122.431297)).
+	Build()
+
+// Crypto address (for now only Bitcoin and Ethereum are supported)
+templateless.NewContent().
+	Component(components.QrCodeCryptocurrencyAddress(components.Bitcoin, "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa")).
+	Build()
+
+// You can also encode any binary data
+templateless.NewContent().
+	Component(components.NewQrCode([]byte{1, 2, 3})).
+	Build()
+```
+
+</details>
+<details><summary>Signature</summary>
+
+Generated signatures can be added to your emails to give a bit of a personal touch. This will embed an image with your custom text using one of several available fonts:
+
+```go
+// Signature with a default font
+templateless.NewContent().
+	Signature("John Smith").
+	Build()
+
+// Signature with a custom font
+templateless.NewContent().
+	Component(components.NewSignature("John Smith", &components.ReenieBeanie)).
+	Build()
+```
+
+These are the available fonts:
+
+- `ReenieBeanie` [preview →](https://fonts.google.com/specimen/Reenie+Beanie)
+- `MeowScript` [preview →](https://fonts.google.com/specimen/Meow+Script)
+- `Caveat` [preview →](https://fonts.google.com/specimen/Caveat)
+- `Zeyada` [preview →](https://fonts.google.com/specimen/Zeyada)
+- `Petemoss` [preview →](https://fonts.google.com/specimen/Petemoss)
+
+Signature should not exceed 64 characters. Only alphanumeric characters and most common symbols are allowed.
+
+</details>
+
 
 ---
 

collection.go

@@ -27,8 +27,8 @@ func (c *Collection) Button(text, url string) *Collection {
 	return c
 }
 
-func (c *Collection) Image(src string, url string, width, height int, alt string) *Collection {
-	c.Components = append(c.Components, components.NewImage(src, alt, url, width, height))
+func (c *Collection) Image(src string) *Collection {
+	c.Components = append(c.Components, components.NewImage(src, nil, nil, nil, nil))
 	return c
 }
 
@@ -52,8 +52,28 @@ func (c *Collection) Text(text string) *Collection {
 	return c
 }
 
-func (c *Collection) ViewInBrowser(text string) *Collection {
-	c.Components = append(c.Components, components.NewViewInBrowser(text))
+func (c *Collection) ViewInBrowser() *Collection {
+	c.Components = append(c.Components, components.NewViewInBrowser(nil))
+	return c
+}
+
+func (c *Collection) QrCode(url string) *Collection {
+	c.Components = append(c.Components, components.QrCodeURL(url))
+	return c
+}
+
+func (c *Collection) StoreBadges(data []components.StoreBadgeItem) *Collection {
+	c.Components = append(c.Components, components.NewStoreBadges(data))
+	return c
+}
+
+func (c *Collection) Signature(text string) *Collection {
+	c.Components = append(c.Components, components.NewSignature(text, nil))
+	return c
+}
+
+func (c *Collection) Component(component components.Component) *Collection {
+	c.Components = append(c.Components, component)
 	return c
 }
 

components/components.go

@@ -11,6 +11,9 @@ const (
 	ComponentIdSocials       ComponentId = "SOCIALS"
 	ComponentIdText          ComponentId = "TEXT"
 	ComponentIdViewInBrowser ComponentId = "VIEW_IN_BROWSER"
+	ComponentIdStoreBadges   ComponentId = "STORE_BADGES"
+	ComponentIdQrCode        ComponentId = "QR_CODE"
+	ComponentIdSignature     ComponentId = "SIGNATURE"
 )
 
 type Component interface {

components/image.go

@@ -3,13 +3,13 @@ package components
 type Image struct {
 	Id     ComponentId `json:"id"`
 	Src    string      `json:"src"`
-	Alt    string      `json:"alt"`
-	Width  int         `json:"width"`
-	Height int         `json:"height"`
-	URL    string      `json:"url"`
+	Alt    *string     `json:"alt"`
+	Width  *int        `json:"width"`
+	Height *int        `json:"height"`
+	URL    *string     `json:"url"`
 }
 
-func NewImage(src, alt, url string, width, height int) *Image {
+func NewImage(src string, url *string, width, height *int, alt *string) *Image {
 	return &Image{
 		Id:     ComponentIdImage,
 		Src:    src,

components/qr_code.go

@@ -0,0 +1,49 @@
+package components
+
+import (
+	"encoding/base64"
+	"fmt"
+)
+
+type Cryptocurrency string
+
+const (
+	Bitcoin  Cryptocurrency = "bitcoin"
+	Ethereum Cryptocurrency = "ethereum"
+)
+
+type QrCode struct {
+	Id   ComponentId `json:"id"`
+	Data string      `json:"data"`
+}
+
+func NewQrCode(data []byte) *QrCode {
+	return &QrCode{
+		Id:   ComponentIdQrCode,
+		Data: base64.StdEncoding.EncodeToString(data),
+	}
+}
+
+func QrCodeEmail(email string) *QrCode {
+	return NewQrCode([]byte(fmt.Sprintf("mailto:%s", email)))
+}
+
+func QrCodeURL(url string) *QrCode {
+	return NewQrCode([]byte(url))
+}
+
+func QrCodePhone(phone string) *QrCode {
+	return NewQrCode([]byte(fmt.Sprintf("tel:%s", phone)))
+}
+
+func QrCodeSMS(text string) *QrCode {
+	return NewQrCode([]byte(fmt.Sprintf("smsto:%s", text)))
+}
+
+func QrCodeCoordinates(lat, lng float64) *QrCode {
+	return NewQrCode([]byte(fmt.Sprintf("geo:%f,%f", lat, lng)))
+}
+
+func QrCodeCryptocurrencyAddress(crypto Cryptocurrency, address string) *QrCode {
+	return NewQrCode([]byte(fmt.Sprintf("%s:%s", crypto, address)))
+}

components/signature.go

@@ -0,0 +1,25 @@
+package components
+
+type SignatureFont string
+
+const (
+	ReenieBeanie SignatureFont = "REENIE_BEANIE"
+	MeowScript   SignatureFont = "MEOW_SCRIPT"
+	Caveat       SignatureFont = "CAVEAT"
+	Zeyada       SignatureFont = "ZEYADA"
+	Petemoss     SignatureFont = "PETEMOSS"
+)
+
+type Signature struct {
+	Id   ComponentId    `json:"id"`
+	Text string         `json:"text"`
+	Font *SignatureFont `json:"font"`
+}
+
+func NewSignature(text string, font *SignatureFont) *Signature {
+	return &Signature{
+		Id:   ComponentIdSignature,
+		Text: text,
+		Font: font,
+	}
+}