test mode logging support

Author: 4kimov

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+**v0.1.0-alpha.4:**
+- `README.md`: notice about test mode
+- Support for test mode logging
+- npm updates
+
 **v0.1.0-alpha.3:**
 - `README.md` cleanup (listing of components)
 - `Image` component now requires only `src`; the other params are optional

README.md

@@ -95,6 +95,18 @@ There are more 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).
 
+## 🏗 Debugging
+
+You can generate _test API keys_ by activating the **Test Mode** in your dashboard. By using these keys, you'll be able to view your fully rendered emails without actually sending them.
+
+When you use a test API key in your SDK, the following output will appear in your logs when you try to send an email:
+
+```log
+Templateless [TEST MODE]: Emailed [email protected], preview: https://tmpl.sh/ATMxHLX4r9aE
+```
+
+The preview link will display the email, but you must be logged in to Templateless to view it.
+
 ## 🔳 Components
 
 Emails are crafted programmatically by making function calls. There's no dealing with HTML or drag-and-drop builders.
@@ -246,7 +258,7 @@ If you'd like your recipients to be able to read the email in a browser, you can
 
 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.**
+**Anyone who knows the link will be able to see the email.**
 
 ```javascript
 Content.builder()

dist/bundle.cjs.js

@@ -1,6 +1,11 @@
 import { Email, ObjectId } from '.';
+export interface EmailResponsePreviews {
+    email: string;
+    preview: string;
+}
 export interface EmailResponse {
     emails: ObjectId[];
+    previews?: EmailResponsePreviews[];
 }
 export declare class Templateless {
     private _apiKey;

dist/bundle.esm.js

@@ -1,6 +1,6 @@
 {
   "name": "templateless-js",
-  "version": "0.1.0-alpha.3",
+  "version": "0.1.0-alpha.4",
   "description": "Ship faster by sending elegant emails using just code",
   "author": "",
   "keywords": [
@@ -51,8 +51,8 @@
     "@rollup/plugin-terser": "0.4.4",
     "@rollup/plugin-typescript": "11.1.6",
     "@types/jest": "29.5.12",
-    "@typescript-eslint/eslint-plugin": "7.1.0",
-    "@typescript-eslint/parser": "7.1.0",
+    "@typescript-eslint/eslint-plugin": "7.1.1",
+    "@typescript-eslint/parser": "7.1.1",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-prettier": "5.1.3",

dist/bundle.umd.js

@@ -12,8 +12,14 @@ import {
   UnknownError,
 } from '.'
 
+export interface EmailResponsePreviews {
+  email: string
+  preview: string
+}
+
 export interface EmailResponse {
   emails: ObjectId[]
+  previews?: EmailResponsePreviews[]
 }
 
 export class Templateless {
@@ -62,6 +68,15 @@ export class Templateless {
           throw new UnavailableError()
         case 200:
           const emailResponse = response.data as EmailResponse
+
+          if (emailResponse.previews) {
+            for (const preview of emailResponse.previews) {
+              console.log(
+                `Templateless [TEST MODE]: Emailed ${preview.email}, preview: https://tmpl.sh/${preview.preview}`,
+              )
+            }
+          }
+
           return emailResponse.emails
         default:
           throw new UnknownError()