nestjs-mailchannels 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MailChannels
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,204 @@
-# Temporary Holding Version
+# Nestjs MailChannels
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<!-- oxfmt-ignore-start -->
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+<!-- oxfmt-ignore-end -->
+
+MailChannels Email API module integration for NestJS.
+
+Leverages [`@mailchannels/sdk`](https://github.com/mailchannels/mailchannels-email-api-sdk-js)
+package, the Official MailChannels Email API SDK for Node.js.
+
+- [✨ Release Notes](CHANGELOG.md)
+- [🏀 Online playground](https://stackblitz.com/github/yizack/nestjs-mailchannels?file=playground%2Fsrc%2Fapp.module.ts)
+
+## Contents
+
+- [Features](#features)
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Usage](#usage)
+- [License](#license)
+- [Development](#development)
+
+## Features
+
+- All MailChannels Email API SDK features available
+
+## Requirements
+
+- NestJS 12 or higher
+- MailChannels account and Email API key
+
+## Installation
+
+1. Add `nestjs-mailchannels` dependency to your project
+
+```sh
+# npm
+$ npm install nestjs-mailchannels
+
+# yarn
+$ yarn add nestjs-mailchannels
+
+# pnpm
+$ pnpm add nestjs-mailchannels
+```
+
+## Usage
+
+### Import the module
+
+```ts
+import { Module } from '@nestjs/common'
+import { MailChannelsModule } from 'nestjs-mailchannels'
+
+@Module({
+  imports: [
+    MailChannelsModule.forRoot({
+      apiKey: 'YOUR-API-KEY'
+    })
+  ],
+  controllers: [],
+  providers: [],
+  exports: []
+})
+```
+
+### Import the module Asynchronously
+
+```ts
+import { Module } from '@nestjs/common'
+import { MailChannelsModule } from 'nestjs-mailchannels'
+
+@Module({
+  imports: [
+    MailChannelsModule.forRootAsync({
+      useFactory: async () => ({
+        apiKey: 'YOUR-API-KEY'
+      })
+    })
+  ],
+  controllers: [],
+  providers: [],
+  exports: []
+})
+```
+
+### Controller for sending emails
+
+```ts
+import { Controller, HttpException, Post } from "@nestjs/common";
+import { MailChannelsService } from "nestjs-mailchannels";
+
+@Controller()
+export class EmailsController {
+  constructor(private readonly mailchannelsService: MailChannelsService) {}
+
+  @Post("emails/send")
+  async send() {
+    const { data, error } = await this.mailchannelsService.emails.send({
+      from: "Name <from@example.com>",
+      to: "to@example.net",
+      subject: "Test email",
+      text: "Hello from NestJS",
+      html: "<p>Hello from NestJS</p>"
+    });
+
+    if (error) {
+      throw new HttpException(error.message, error.statusCode || 500);
+    }
+
+    return data;
+  }
+
+  @Post("emails/queue")
+  async queue() {
+    const { data, error } = await this.mailchannelsService.emails.queue({
+      from: "Name <from@example.com>",
+      to: "to@example.net",
+      subject: "Test email",
+      text: "Hello from NestJS",
+      html: "<p>Hello from NestJS</p>"
+    });
+
+    if (error) {
+      throw new HttpException(error.message, error.statusCode || 500);
+    }
+
+    return data;
+  }
+}
+```
+
+### Add your controller to your module
+
+```ts
+import { Module } from '@nestjs/common'
+import { MailChannelsModule } from 'nestjs-mailchannels'
+import { EmailsController } from './emails/emails.controller.js'
+
+@Module({
+  imports: [
+    MailChannelsModule.forRoot({
+      apiKey: 'YOUR-API-KEY'
+    })
+  ],
+  controllers: [EmailsController], // Add your controller here
+  providers: [],
+  exports: []
+})
+```
+
+## License
+
+[MIT License](LICENSE)
+
+## Development
+
+<details>
+  <summary>Local development</summary>
+
+```sh
+# Install dependencies
+pnpm install
+
+# Prepare environment
+pnpm build
+
+# Develop with the playground
+pnpm playground:start
+
+# Run Oxlint
+pnpm lint
+
+# Run Formatter
+pnpm format
+
+# Run Tests
+pnpm test
+
+# Run typecheck
+pnpm test:types
+
+# Release new version
+pnpm release
+```
+
+</details>
+
+<!-- oxfmt-ignore-start -->
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/nestjs-mailchannels/latest.svg
+[npm-version-href]: https://npmjs.com/package/nestjs-mailchannels
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/nestjs-mailchannels.svg
+[npm-downloads-href]: https://npmjs.com/package/nestjs-mailchannels
+
+[license-src]: https://img.shields.io/npm/l/nestjs-mailchannels.svg
+[license-href]: LICENSE
+
+<!-- oxfmt-ignore-end -->

package/dist/index.d.mts

@@ -0,0 +1,5 @@
+import { MAILCHANNELS_CONFIGURATION_OPTIONS } from "./mailchannels.constant.mjs";
+import { MailChannelsOptions, MailChannelsOptionsAsync } from "./mailchannels.interface.mjs";
+import { MailChannelsModule } from "./mailchannels.module.mjs";
+import { MailChannelsService } from "./mailchannels.service.mjs";
+export { MAILCHANNELS_CONFIGURATION_OPTIONS, MailChannelsModule, type MailChannelsOptions, type MailChannelsOptionsAsync, MailChannelsService };

package/dist/index.mjs

@@ -0,0 +1,4 @@
+import { MAILCHANNELS_CONFIGURATION_OPTIONS } from "./mailchannels.constant.mjs";
+import { MailChannelsModule } from "./mailchannels.module.mjs";
+import { t as MailChannelsService } from "./mailchannels.service-DlISywKM.mjs";
+export { MAILCHANNELS_CONFIGURATION_OPTIONS, MailChannelsModule, MailChannelsService };

package/dist/mailchannels.constant.d.mts

@@ -0,0 +1 @@
+export declare const MAILCHANNELS_CONFIGURATION_OPTIONS = "MAILCHANNELS_CONFIGURATION";

package/dist/mailchannels.constant.mjs

@@ -0,0 +1,3 @@
+// src/mailchannels.constant.ts
+const MAILCHANNELS_CONFIGURATION_OPTIONS = "MAILCHANNELS_CONFIGURATION";
+export { MAILCHANNELS_CONFIGURATION_OPTIONS };

package/dist/mailchannels.interface.d.mts

@@ -0,0 +1,10 @@
+import { FactoryProvider, ModuleMetadata } from "@nestjs/common";
+import { MailChannelsClientOptions } from "@mailchannels/sdk";
+export interface MailChannelsOptions extends MailChannelsClientOptions {
+  apiKey: string;
+}
+export interface MailChannelsOptionsAsync extends Pick<ModuleMetadata, "imports"> {
+  name?: string;
+  useFactory: (...args: unknown[]) => MailChannelsOptions | Promise<MailChannelsOptions>;
+  inject?: FactoryProvider<MailChannelsOptions>["inject"];
+}

package/dist/mailchannels.interface.mjs

@@ -0,0 +1 @@
+export {};

package/dist/mailchannels.module.d.mts

@@ -0,0 +1,6 @@
+import { MailChannelsOptions, MailChannelsOptionsAsync } from "./mailchannels.interface.mjs";
+import { DynamicModule } from "@nestjs/common";
+export declare class MailChannelsModule {
+  static forRoot(options: MailChannelsOptions): DynamicModule;
+  static forRootAsync(options: MailChannelsOptionsAsync): DynamicModule;
+}

package/dist/mailchannels.module.mjs

@@ -0,0 +1,35 @@
+import { MAILCHANNELS_CONFIGURATION_OPTIONS } from "./mailchannels.constant.mjs";
+import { n as __decorate, t as MailChannelsService } from "./mailchannels.service-DlISywKM.mjs";
+import { Module } from "@nestjs/common";
+// src/mailchannels.module.ts
+var _MailChannelsModule;
+let MailChannelsModule = _MailChannelsModule = class MailChannelsModule {
+	static forRoot(options) {
+		return {
+			module: _MailChannelsModule,
+			providers: [{
+				provide: MAILCHANNELS_CONFIGURATION_OPTIONS,
+				useValue: options
+			}],
+			exports: [MailChannelsService]
+		};
+	}
+	static forRootAsync(options) {
+		const mailchannelsModuleOptions = {
+			provide: MAILCHANNELS_CONFIGURATION_OPTIONS,
+			useFactory: options.useFactory,
+			inject: options.inject || []
+		};
+		return {
+			module: _MailChannelsModule,
+			imports: options.imports,
+			providers: [mailchannelsModuleOptions],
+			exports: [MailChannelsService]
+		};
+	}
+};
+MailChannelsModule = _MailChannelsModule = __decorate([Module({
+	providers: [MailChannelsService],
+	exports: [MailChannelsService]
+})], MailChannelsModule);
+export { MailChannelsModule };

package/dist/mailchannels.service-DlISywKM.mjs

@@ -0,0 +1,32 @@
+import { MAILCHANNELS_CONFIGURATION_OPTIONS } from "./mailchannels.constant.mjs";
+import { Inject, Injectable } from "@nestjs/common";
+import { MailChannels } from "@mailchannels/sdk";
+// \0@oxc-project+runtime@0.157.0/helpers/esm/decorateMetadata.js
+function __decorateMetadata(k, v) {
+	if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+// \0@oxc-project+runtime@0.157.0/helpers/esm/decorateParam.js
+function __decorateParam(paramIndex, decorator) {
+	return function(target, key) {
+		decorator(target, key, paramIndex);
+	};
+}
+// \0@oxc-project+runtime@0.157.0/helpers/esm/decorate.js
+function __decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+// src/mailchannels.service.ts
+let MailChannelsService = class MailChannelsService extends MailChannels {
+	constructor(options) {
+		super(options.apiKey, options);
+	}
+};
+MailChannelsService = __decorate([
+	Injectable(),
+	__decorateParam(0, Inject(MAILCHANNELS_CONFIGURATION_OPTIONS)),
+	__decorateMetadata("design:paramtypes", [Object])
+], MailChannelsService);
+export { __decorate as n, MailChannelsService as t };

package/dist/mailchannels.service.d.mts

@@ -0,0 +1,5 @@
+import { MailChannelsOptions } from "./mailchannels.interface.mjs";
+import { MailChannels } from "@mailchannels/sdk";
+export declare class MailChannelsService extends MailChannels {
+  constructor(options: MailChannelsOptions);
+}

package/dist/mailchannels.service.mjs

@@ -0,0 +1,2 @@
+import "./mailchannels.constant.mjs";
+export { t as MailChannelsService } from "./mailchannels.service-DlISywKM.mjs";

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "nestjs-mailchannels",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "NestJS module for the MailChannels Email API",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "dependencies": {
+    "@mailchannels/sdk": "^1.9.1",
+    "@nestjs/common": "^12.4.0"
+  },
+  "devDependencies": {
+    "@nestjs/core": "^12.4.0",
+    "@types/node": "^26.6.6",
+    "oxfmt": "^0.77.0",
+    "oxlint": "^1.92.0",
+    "reflect-metadata": "^0.2.2",
+    "tsdown": "^0.23.7",
+    "typescript": "^6.0.3"
+  },
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "playground:start": "cd playground && pnpm start",
+    "test:types": "tsc --noEmit",
+    "test": "node --run build && node --run test:types && node --test test/*.test.ts",
+    "lint": "oxlint",
+    "lint:fix": "oxlint --fix",
+    "format": "oxfmt --check",
+    "format:fix": "oxfmt",
+    "checks": "node --run test && node --run test:types &&node --run lint && node --run format",
+    "release": "node --run checks && changelogen --release --push --no-github",
+    "release:github": "changelogen gh release"
+  }
 }