cleanup

Author: 4kimov

.eslintrc.js

@@ -22,6 +22,7 @@ module.exports = {
     'no-underscore-dangle': 'off',
     'node/no-unsupported-features/es-builtins': 'off',
     'unicorn/prefer-spread': 'off',
+    'prefer-const': 'error',
   },
   ignorePatterns: ['*.mjs', '*.cjs'],
 }

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+**v0.1.0-alpha.3:**
+- `README.md` cleanup (listing of components)
+- `Image` component now requires only `src`; the other params are optional
+- `ViewInBrowser` component has changed: text is optional
+- npm updates
+
 **v0.1.0-alpha.2:**
 - Introduced `CHANGELOG.md`
 - npm updates

README.md

@@ -24,6 +24,8 @@
 
 [Templateless](https://templateless.com) lets you generate and send transactional emails quickly and easily so you can focus on building your product.
 
+It's perfect for SaaS, web apps, mobile apps, scripts and anywhere you have to send email programmatically.
+
 ## ✨ Features
 
 - 👋 **Anti drag-and-drop by design** — emails are a part of your code
@@ -48,14 +50,24 @@ Or npm:
 npm install --save templateless-js
 ```
 
+## 🔑 Get Your API Key
+
+You'll need an API key for the example below ⬇️
+
+[![Get Your API Key](https://img.shields.io/badge/Get_Your_API_Key-free-blue?style=for-the-badge)](https://app.templateless.com/)
+
+- 3,000 emails per month
+- All popular email provider integrations
+- Start sending right away
+
 ## 👩‍💻 Quick example
 
 This is all it takes to send a signup confirmation email:
 
 ```javascript
 import { Content, Email, EmailAddress, Templateless } from 'templateless-js'
 
-;(async () => {
+const sendEmail = async () => {
   const content = Content
     .builder()
     .text('Hi, please **confirm your email**:')
@@ -73,27 +85,204 @@ import { Content, Email, EmailAddress, Templateless } from 'templateless-js'
   const result = await templateless.send(email)
 
   console.log(result)
-})()
+}
+
+sendEmail()
 ```
 
-> **Note**
-> 🚧 **This SDK is not stable yet.** The API might change as more features are added. Please pay attention to the [CHANGELOG](CHANGELOG.md) for breaking changes.
+There are more C# examples in the [examples](examples) folder ✨
+
+> [!NOTE]
+> 🚧 **The SDK is not stable yet.** This API might change as more features are added. Please watch the repo for the changes in the [CHANGELOG](CHANGELOG.md).
+
+## 🔳 Components
+
+Emails are crafted programmatically by making function calls. There's no dealing with HTML or drag-and-drop builders.
+
+All of the following components can be mixed and matched to create dynamic emails:
 
-Examples:
+<details>
+  <summary>Text / Markdown</summary>
 
-1. Get your **free API key** here: <https://app.templateless.com> ✨
-1. There are more JavaScript examples in the [examples](examples) folder
+Text component allow you to insert a paragraph. Each paragraph supports basic markdown:
 
-  ```bash
-  TEMPLATELESS_API_KEY=<Your API Key> \
-    TEMPLATELESS_EMAIL_ADDRESS=<Your Own Email Address> \
-    node examples/simple
+- Bold text: `**bold text**`
+- Italic text: `_italic text_`
+- Link: `[link text](https://example.com)`
+- Also a link: `<https://example.com>`
+- Headers (h1-h6):
+
+  - `# Big Header`
+  - `###### Small Header`
+
+- Unordered list:
+
+  ```md
+  - item one
+  - item two
+  - item three
   ```
 
+- Ordered list:
+
+  ```md
+  1. item one
+  1. item two
+  1. item three
+  ```
+
+```javascript
+Content.builder()
+    .text("## Thank you for signing up")
+    .text("Please **verify your email** by [clicking here](https://example.com/confirm?token=XYZ)")
+    .build()
+```
+
+</details>
+<details><summary>Link</summary>
+
+Link component adds an anchor tag. This is the same as a text component with the link written in markdown:
+
+```javascript
+Content.builder()
+    .link("Confirm Email", "https://example.com/confirm?token=XYZ") // or...
+    .text("[Confirm Email](https://example.com/confirm?token=XYZ)")
+    .build()
+```
+
+</details>
+<details><summary>Button</summary>
+
+Button can also be used as a call to action. Button color is set via your dashboard's app color.
+
+```javascript
+Content.builder()
+    .button("Confirm Email", "https://example.com/confirm?token=XYZ")
+    .build()
+```
+
+</details>
+<details><summary>Image</summary>
+
+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.
+
+```javascript
+Content.builder()
+    .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
+    )
+    .build()
+```
+
+Only the `src` parameter is required; everything else is optional.
+
+**If you have "Image Optimization" turned on:**
+
+1. Your images will be cached and distributed by our CDN for faster loading. The cache does not expire. If you'd like to re-cache, simply append a query parameter to the end of your image url.
+1. Images will be converted into formats that are widely supported by email clients. The following image formats will be processed automatically:
+
+    - Jpeg
+    - Png
+    - Gif
+    - WebP
+    - Tiff
+    - Ico
+    - Bmp
+    - Svg
+
+1. Maximum image size is 5MB for free accounts and 20MB for paid accounts.
+1. You can specify `width` and/or `height` if you'd like (they are optional). Keep in mind that images will be scaled down to fit within the email theme, if they're too large.
+
+</details>
+<details><summary>One-Time Password</summary>
+
+OTP component is designed for showing temporary passwords and reset codes.
+
+```javascript
+Content.builder()
+    .text("Here's your **temporary login code**:")
+    .otp("XY78-2BT0-YFNB-ALW9")
+    .build()
+```
+
+</details>
+<details><summary>Social Icons</summary>
+
+You can easily add social icons with links by simply specifying the username. Usually, this component is placed in the footer of the email.
+
+These are all the supported platforms:
+
+```javascript
+Content.builder()
+    .socials([
+      new SocialItem(Service.Website, 'https://example.com'),
+      new SocialItem(Service.Email, '[email protected]'),
+      new SocialItem(Service.Phone, '123-456-7890'), // `tel:` link
+      new SocialItem(Service.Facebook, 'ExampleApp'),
+      new SocialItem(Service.YouTube, 'ChannelID'),
+      new SocialItem(Service.Twitter, 'ExampleApp'),
+      new SocialItem(Service.X, 'ExampleApp'),
+      new SocialItem(Service.GitHub, 'ExampleApp'),
+      new SocialItem(Service.Instagram, 'ExampleApp'),
+      new SocialItem(Service.LinkedIn, 'ExampleApp'),
+      new SocialItem(Service.Slack, 'Org'),
+      new SocialItem(Service.Discord, 'ExampleApp'),
+      new SocialItem(Service.TikTok, 'ExampleApp'),
+      new SocialItem(Service.Snapchat, 'ExampleApp'),
+      new SocialItem(Service.Threads, 'ExampleApp'),
+      new SocialItem(Service.Telegram, 'ExampleApp'),
+    ])
+    .build()
+```
+
+</details>
+<details><summary>View in Browser</summary>
+
+If you'd like your recipients to be able to read the email in a browser, you can add the "view in browser" component that will automatically generate a link. Usually, this is placed in the header or footer of the email.
+
+You can optionally provide the text for the link. If none is provided, default is used: "View in browser"
+
+**This will make the email public to anyone that has access to the link.**
+
+```javascript
+Content.builder()
+    .viewInBrowser("Read Email in Browser")
+    .build()
+```
+
+</details>
+
+---
+
+Components can be placed in the header, body and footer of the email. Header and footer styling is usually a bit different from the body (for example the text is smaller).
+
+```javascript
+const header = Header.builder() // header of the email
+  .text("Smaller text")
+  .build()
+
+const content = Content.builder() // body of the email
+  .text("Normal text")
+  .build()
+```
+
+Currently there are 2 themes to choose from: `Theme.Unstyled` and `Theme.Simple`
+
+```javascript
+const content = Content.builder()
+  .theme(Theme.Simple)
+  .text("Hello world")
+  .build()
+```
+
 ## 🤝 Contributing
 
-- Contributions are more than welcome <3
-- Please **star this repo** for more visibility ★
+- Contributions are more than welcome
+- Please **star this repo** for more visibility <3
 
 ## 📫 Get in touch
 
@@ -103,7 +292,7 @@ Examples:
 
     - For feature requests, please [start a discussion](https://github.com/templateless/templateless-javascript/discussions)
     - Found a bug? [Open an issue!](https://github.com/templateless/templateless-javascript/issues)
-    - We are also on Twitter: [@Templateless](https://twitter.com/templateless)
+    - Say hi [@Templateless](https://twitter.com/templateless) 👋
 
 ## 🍻 License
 

dist/bundle.cjs.js

@@ -13,7 +13,7 @@ declare class CollectionBuilder {
     otp(text: string): this;
     socials(data: SocialItem[]): this;
     text(text: string): this;
-    viewInBrowser(text: string): this;
+    viewInBrowser(text?: string): this;
     build(): Collection;
     private push;
 }

dist/bundle.esm.js

@@ -2,11 +2,11 @@ import { ComponentId } from '../common';
 export declare class Image implements Component {
     id: ComponentId;
     src: string;
-    alt: string;
-    width: number;
-    height: number;
-    url: string;
-    constructor(src: string, alt: string, width: number, height: number, url: string);
+    alt?: string;
+    width?: number;
+    height?: number;
+    url?: string;
+    constructor(src: string, alt?: string, width?: number, height?: number, url?: string);
 }
 interface Component {
 }

dist/bundle.umd.js

@@ -1,8 +1,8 @@
 import { ComponentId } from '../common';
 export declare class ViewInBrowser implements Component {
     id: ComponentId;
-    text: string;
-    constructor(text: string);
+    text?: string;
+    constructor(text?: string);
 }
 interface Component {
 }

dist/collection.d.ts

@@ -28,7 +28,7 @@ declare class ContentBuilder {
     otp(text: string): this;
     socials(data: SocialItem[]): this;
     text(text: string): this;
-    viewInBrowser(text: string): this;
+    viewInBrowser(text?: string): this;
     build(): Content;
     private push;
 }

dist/components/image.d.ts

@@ -11,13 +11,13 @@ import {
 } from 'templateless-js'
 
 const sendEmail = async () => {
-  let api_key = process.env.TEMPLATELESS_API_KEY
+  const api_key = process.env.TEMPLATELESS_API_KEY
   if (!api_key) {
     console.error('Set TEMPLATELESS_API_KEY to your Templateless API key')
     return
   }
 
-  let email_address = process.env.TEMPLATELESS_EMAIL_ADDRESS
+  const email_address = process.env.TEMPLATELESS_EMAIL_ADDRESS
   if (!email_address) {
     console.error('Set TEMPLATELESS_EMAIL_ADDRESS to your own email address')
     return

dist/components/viewInBrowser.d.ts

@@ -2,13 +2,13 @@ import 'dotenv/config'
 import { Content, Email, EmailAddress, Templateless } from 'templateless-js'
 
 const sendEmail = async () => {
-  let api_key = process.env.TEMPLATELESS_API_KEY
+  const api_key = process.env.TEMPLATELESS_API_KEY
   if (!api_key) {
     console.error('Set TEMPLATELESS_API_KEY to your Templateless API key')
     return
   }
 
-  let email_address = process.env.TEMPLATELESS_EMAIL_ADDRESS
+  const email_address = process.env.TEMPLATELESS_EMAIL_ADDRESS
   if (!email_address) {
     console.error('Set TEMPLATELESS_EMAIL_ADDRESS to your own email address')
     return