Rename Bindings to Environment and add Email value

Author: sergiodxa

README.md

@@ -47,8 +47,8 @@ async function getLoadContext(request: Request) {
 }
 
 declare module "edgekitjs" {
-  export interface Bindings {
-    // Add your custom bindings here
+  export interface Environment {
+    // Add your custom env variables or bindings here
   }
 
   type Schema = typeof schema;
@@ -579,21 +579,21 @@ import {
 } from "edgekitjs";
 ```
 
-### Override Bindings
+### Override Environment
 
-You can override the bindings by creating a `d.ts` file in your project with this content
+You can override the environment by creating a `d.ts` file in your project with this content
 
 ```ts
 import "edgekitjs";
 
 declare module "edgekitjs" {
-  interface Bindings {
-    // Add your custom bindings here
+  interface Environment {
+    // Add your custom env variables and bindings here
   }
 }
 ```
 
-If you're using `wrangler types` to generate the types, you can make `Bindings` extends the interface generated by `wrangler types`.
+If you're using `wrangler types` to generate the types, you can make `Environment` extends the interface generated by `wrangler types`.
 
 ### Override Database Schema
 

docs/setup.md

@@ -1,5 +1,5 @@
 export type { AI } from "./lib/ai/ai.js";
-export type { Bindings, DatabaseSchema } from "./lib/types.js";
+export type { Environment, DatabaseSchema } from "./lib/types.js";
 export type { Cache } from "./lib/cache/cache.js";
 export type { Env } from "./lib/env/env.js";
 export type { FS } from "./lib/fs/fs.js";

src/index.ts

@@ -0,0 +1,60 @@
+import { afterAll, beforeAll, describe, expect, mock, test } from "bun:test";
+import { http, HttpResponse } from "msw";
+import { setupServer } from "msw/native";
+import { Email } from "./email.js";
+import { EmailVerifier } from "./verifier";
+
+mock.module("@edgefirst-dev/core", () => {
+	return {
+		orm: mock(),
+		env() {
+			return {
+				fetch(key: string) {
+					return key;
+				},
+			};
+		},
+	};
+});
+
+describe(EmailVerifier.name, () => {
+	let server = setupServer();
+	let email = Email.from("john.doe@company.com");
+
+	beforeAll(() => server.listen());
+	afterAll(() => server.close());
+
+	test("#constructor()", () => {
+		const client = new EmailVerifier();
+		expect(client).toBeInstanceOf(EmailVerifier);
+	});
+
+	test("#verify()", async () => {
+		let client = new EmailVerifier();
+
+		server.resetHandlers(
+			http.get(`https://verifier.meetchopra.com/verify/${email}`, () => {
+				return HttpResponse.json({ status: true });
+			}),
+		);
+
+		expect(client.verify(email)).resolves.toBeUndefined();
+	});
+
+	test("#profile() with error", async () => {
+		let client = new EmailVerifier();
+
+		server.resetHandlers(
+			http.get(`https://verifier.meetchopra.com/verify/${email}`, () => {
+				return HttpResponse.json({
+					status: false,
+					error: { code: 2, message: "Disposable email address" },
+				});
+			}),
+		);
+
+		expect(client.verify(email)).rejects.toThrowError(
+			EmailVerifier.InvalidEmailError,
+		);
+	});
+});

src/lib/clients/verifier.test.ts

@@ -0,0 +1,57 @@
+import { APIClient } from "@edgefirst-dev/api-client";
+import { ObjectParser } from "@edgefirst-dev/data/parser";
+
+import { env } from "../storage/accessors.js";
+import type { Email } from "../values/email.js";
+
+export class EmailVerifier extends APIClient {
+	constructor() {
+		super(new URL("https://verifier.meetchopra.com"));
+	}
+
+	override async before(request: Request) {
+		let url = new URL(request.url);
+		let apiKey = env().fetch("VERIFIER_API_KEY");
+		if (apiKey) url.searchParams.append("token", apiKey);
+		return new Request(url.toString(), request);
+	}
+
+	public async verify(value: Email) {
+		let response = await this.get(`/verify/${value.toString()}`);
+
+		let result = await response.json();
+
+		let parser = new ObjectParser(result);
+
+		if (parser.boolean("status")) return;
+		let error = parser.object("error");
+
+		throw new EmailVerifier.InvalidEmailError(
+			error.number("code"),
+			error.string("message"),
+		);
+	}
+}
+
+export namespace EmailVerifier {
+	/**
+	 * The `InvalidEmailError` is thrown when an email fails verification by the
+	 * external API.
+	 */
+	export class InvalidEmailError extends Error {
+		override name = "InvalidEmailError";
+
+		/**
+		 * Constructs an `InvalidEmailError` with a specific error code and message.
+		 *
+		 * @param code - The error code returned by the API.
+		 * @param message - The error message returned by the API.
+		 */
+		constructor(
+			public code: number,
+			message: string,
+		) {
+			super(message);
+		}
+	}
+}

src/lib/clients/verifier.ts

@@ -1,41 +1,41 @@
 import { describe, expect, test } from "bun:test";
 
 import { EdgeEnvKeyError } from "../errors.js";
-import { Bindings } from "../types.js";
+import { Environment } from "../types.js";
 import { Env } from "./env.js";
 
 describe(Env.name, () => {
-	let bindings = { KEY: "value" } as unknown as Bindings;
+	let environment = { KEY: "value" } as unknown as Environment;
 
 	test("#constructor", () => {
-		let env = new Env(bindings);
+		let env = new Env(environment);
 		expect(env).toBeInstanceOf(Env);
 	});
 
-	test("#constructor with missing bindings", () => {
+	test("#constructor with missing environment", () => {
 		// @ts-expect-error - Testing invalid input
 		expect(() => new Env(undefined)).toThrow();
 	});
 
 	test("#fetch", () => {
-		let env = new Env(bindings);
+		let env = new Env(environment);
 		expect(env.fetch("KEY")).toBe("value");
 	});
 
 	test("#fetch with fallback", () => {
-		let env = new Env(bindings);
+		let env = new Env(environment);
 		expect(env.fetch("OPTIONAL", "fallback")).toBe("fallback");
 	});
 
 	test("#fetch with missing", () => {
-		let env = new Env(bindings);
+		let env = new Env(environment);
 		expect(() => env.fetch("OPTIONAL")).toThrow(EdgeEnvKeyError);
 	});
 });
 
-// Overwrite Bindings on this file
+// Overwrite Environment on this file
 declare module "../types.js" {
-	interface Bindings {
+	interface Environment {
 		KEY: string;
 		OPTIONAL?: string;
 	}

src/lib/env/env.test.ts

@@ -1,12 +1,12 @@
 import { EdgeContextError, EdgeEnvKeyError } from "../errors.js";
-import type { Bindings } from "../types.js";
+import type { Environment } from "../types.js";
 
 /**
  * Access environment variables in your Edge-first application.
  */
 export class Env {
-	constructor(protected bindings: Bindings) {
-		if (!bindings) throw new EdgeContextError("env().fetch");
+	constructor(protected env: Environment) {
+		if (!env) throw new EdgeContextError("env().fetch");
 	}
 
 	/**
@@ -17,11 +17,11 @@ export class Env {
 	 * @param fallback An optional fallback value to return if the key is not found.
 	 * @returns
 	 */
-	fetch<Key extends keyof Bindings>(
+	fetch<Key extends keyof Environment>(
 		key: Key,
-		fallback?: Bindings[Key],
-	): Bindings[Key] {
-		let data = this.bindings[key];
+		fallback?: Environment[Key],
+	): Environment[Key] {
+		let data = this.env[key];
 		if (data) return data;
 
 		if (fallback) return fallback;