wip

4kimov · 4kimov · commit 6039c22f6322 · 2024-02-04T16:55:33.000-06:00
diff --git a/.gitignore b/.gitignore
@@ -40,4 +40,5 @@ node_modules/
 
 .DS_Store
 
-.env
+.env
+/examples/**/package-lock.json
diff --git a/README.md b/README.md
@@ -65,6 +65,12 @@ Note:
 1. Get your **free API key** here: <https://app.templateless.com> ✨
 1. There are more JavaScript examples in the [examples](examples) folder
 
+  ```bash
+  TEMPLATELESS_API_KEY=<Your API Key> \
+    TEMPLATELESS_EMAIL_ADDRESS=<Your Own Email Address> \
+    node examples/simple
+  ```
+
 ## 🤝 Contributing
 
 - Contributions are more than welcome <3
diff --git a/dist/bundle.cjs.js b/dist/bundle.cjs.js
diff --git a/dist/bundle.esm.js b/dist/bundle.esm.js
diff --git a/dist/bundle.umd.js b/dist/bundle.umd.js
diff --git a/dist/collection.d.ts b/dist/collection.d.ts
@@ -1,5 +1,4 @@
 import { Component, SocialItem } from './components';
-import { Result } from '.';
 export declare class Collection {
     components: Component[];
     constructor(builder: CollectionBuilder);
@@ -15,7 +14,7 @@ declare class CollectionBuilder {
     socials(data: SocialItem[]): this;
     text(text: string): this;
     viewInBrowser(text: string): this;
-    build(): Result<Collection>;
+    build(): Collection;
     private push;
 }
 export {};
diff --git a/dist/content.d.ts b/dist/content.d.ts
@@ -1,5 +1,5 @@
 import { Component, SocialItem } from './components';
-import { Result, Header, Footer } from '.';
+import { Header, Footer } from '.';
 export declare enum Theme {
     Unstyled = "UNSTYLED",
     Simple = "SIMPLE"
@@ -29,7 +29,7 @@ declare class ContentBuilder {
     socials(data: SocialItem[]): this;
     text(text: string): this;
     viewInBrowser(text: string): this;
-    build(): Result<Content>;
+    build(): Content;
     private push;
 }
 export {};
diff --git a/dist/email.d.ts b/dist/email.d.ts
@@ -1,4 +1,4 @@
-import { EmailAddress, Result } from '.';
+import { EmailAddress } from '.';
 interface EmailOptions {
     deleteAfter?: number;
 }
@@ -24,6 +24,6 @@ declare class EmailBuilder {
     subject(subject: string): this;
     content(content: Content): this;
     deleteAfter(seconds: number): this;
-    build(): Result<Email>;
+    build(): Email;
 }
 export {};
diff --git a/dist/errors.d.ts b/dist/errors.d.ts
@@ -26,4 +26,3 @@ export declare class UnknownError extends Error {
     constructor();
 }
 export type TemplatelessError = UnauthorizedError | ForbiddenError | InvalidParameterError | BadRequestError | UnavailableError | UnknownError;
-export type Result<T> = T | TemplatelessError;
diff --git a/dist/templateless.d.ts b/dist/templateless.d.ts
@@ -1,4 +1,4 @@
-import { Email, Result, ObjectId } from '.';
+import { Email, ObjectId } from '.';
 export interface EmailResponse {
     emails: ObjectId[];
 }
@@ -7,6 +7,6 @@ export declare class Templateless {
     private _domain;
     constructor(apiKey: string);
     domain(domain: string): this;
-    send(email: Email): Promise<Result<ObjectId[]>>;
-    sendMany(emails: Email[]): Promise<Result<ObjectId[]>>;
+    send(email: Email): Promise<ObjectId[]>;
+    sendMany(emails: Email[]): Promise<ObjectId[]>;
 }
diff --git a/examples/simple.js b/examples/simple.js
diff --git a/examples/simple/index.js b/examples/simple/index.js
@@ -0,0 +1,31 @@
+import 'dotenv/config'
+import { Content, Email, EmailAddress, Templateless } from 'templateless-js'
+
+const sendEmail = async () => {
+  let 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
+  if (!email_address) {
+    console.error('Set TEMPLATELESS_EMAIL_ADDRESS to your own email address')
+    return
+  }
+
+  const content = Content.builder().text('Hello world').build()
+
+  const email = Email.builder()
+    .to(new EmailAddress(email_address))
+    .subject('Hello')
+    .content(content)
+    .build()
+
+  const templateless = new Templateless(api_key)
+  const result = await templateless.send(email)
+
+  console.log(result)
+}
+
+sendEmail()
diff --git a/examples/simple/package.json b/examples/simple/package.json
@@ -0,0 +1,13 @@
+{
+  "name": "templateless-js-example-simple",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "node index.js"
+  },
+  "dependencies": {
+    "templateless-js": "file:../..",
+    "dotenv": "16.4.1"
+  }
+}
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "templateless-js",
-  "version": "0.1.0-alpha.0",
+  "version": "0.1.0-alpha.1",
   "description": "Ship faster by sending elegant emails using just code",
   "author": "",
   "keywords": [
diff --git a/src/collection.ts b/src/collection.ts
@@ -9,7 +9,6 @@ import {
   ViewInBrowser,
   SocialItem,
 } from './components'
-import { Result } from '.'
 
 export class Collection {
   components: Component[]
@@ -66,7 +65,7 @@ class CollectionBuilder {
     return this.push(new ViewInBrowser(text))
   }
 
-  build(): Result<Collection> {
+  build(): Collection {
     return new Collection(this)
   }
 
diff --git a/src/content.ts b/src/content.ts
@@ -9,7 +9,7 @@ import {
   ViewInBrowser,
   SocialItem,
 } from './components'
-import { Result, Header, Footer } from '.'
+import { Header, Footer } from '.'
 
 export enum Theme {
   Unstyled = 'UNSTYLED',
@@ -100,7 +100,7 @@ class ContentBuilder {
     return this.push(new ViewInBrowser(text))
   }
 
-  build(): Result<Content> {
+  build(): Content {
     return new Content(this)
   }
 
diff --git a/src/email.ts b/src/email.ts
@@ -1,4 +1,4 @@
-import { EmailAddress, Result } from '.'
+import { EmailAddress } from '.'
 
 interface EmailOptions {
   deleteAfter?: number
@@ -66,7 +66,7 @@ class EmailBuilder {
     return this
   }
 
-  build(): Result<Email> {
+  build(): Email {
     return new Email(this)
   }
 }
diff --git a/src/errors.ts b/src/errors.ts
@@ -62,5 +62,3 @@ export type TemplatelessError =
   | BadRequestError
   | UnavailableError
   | UnknownError
-
-export type Result<T> = T | TemplatelessError
diff --git a/src/templateless.ts b/src/templateless.ts
@@ -3,7 +3,6 @@ import axios from 'axios'
 import pkg from '../package.json'
 import {
   Email,
-  Result,
   ObjectId,
   UnauthorizedError,
   ForbiddenError,
@@ -31,11 +30,11 @@ export class Templateless {
     return this
   }
 
-  async send(email: Email): Promise<Result<ObjectId[]>> {
+  async send(email: Email): Promise<ObjectId[]> {
     return this.sendMany([email])
   }
 
-  async sendMany(emails: Email[]): Promise<Result<ObjectId[]>> {
+  async sendMany(emails: Email[]): Promise<ObjectId[]> {
     try {
       const response = await axios.post(
         `${this._domain}/v1/emails`,
@@ -68,7 +67,7 @@ export class Templateless {
           throw new UnknownError()
       }
     } catch (error) {
-      return new UnknownError()
+      throw new UnknownError()
     }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { EmailAddress, Result } from '.';`
	`1`	`+import { EmailAddress } from '.';`
`2`	`2`	`interface EmailOptions {`
`3`	`3`	`deleteAfter?: number;`
`4`	`4`	`}`
`@@ -24,6 +24,6 @@ declare class EmailBuilder {`
`24`	`24`	`subject(subject: string): this;`
`25`	`25`	`content(content: Content): this;`
`26`	`26`	`deleteAfter(seconds: number): this;`
`27`		`- build(): Result<Email>;`
	`27`	`+ build(): Email;`
`28`	`28`	`}`
`29`	`29`	`export {};`
Original file line number	Diff line number	Diff line change
`@@ -26,4 +26,3 @@ export declare class UnknownError extends Error {`
`26`	`26`	`constructor();`
`27`	`27`	`}`
`28`	`28`	`export type TemplatelessError = UnauthorizedError \| ForbiddenError \| InvalidParameterError \| BadRequestError \| UnavailableError \| UnknownError;`
`29`		`-export type Result<T> = T \| TemplatelessError;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { Email, Result, ObjectId } from '.';`
	`1`	`+import { Email, ObjectId } from '.';`
`2`	`2`	`export interface EmailResponse {`
`3`	`3`	`emails: ObjectId[];`
`4`	`4`	`}`
`@@ -7,6 +7,6 @@ export declare class Templateless {`
`7`	`7`	`private _domain;`
`8`	`8`	`constructor(apiKey: string);`
`9`	`9`	`domain(domain: string): this;`
`10`		`- send(email: Email): Promise<Result<ObjectId[]>>;`
`11`		`- sendMany(emails: Email[]): Promise<Result<ObjectId[]>>;`
	`10`	`+ send(email: Email): Promise<ObjectId[]>;`
	`11`	`+ sendMany(emails: Email[]): Promise<ObjectId[]>;`
`12`	`12`	`}`