@proteinjs/email-server 1.0.5 → 1.1.1

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.1.0](https://github.com/proteinjs/notifications/compare/@proteinjs/email-server@1.0.5...@proteinjs/email-server@1.1.0) (2024-08-05)
+
+
+### Features
+
+* email config files for sign up and invite ([#1](https://github.com/proteinjs/notifications/issues/1)) ([e2787d0](https://github.com/proteinjs/notifications/commit/e2787d08e21fd3642666a79065df81cf74dcef60))
+
+
+
+
+
 ## [1.0.5](https://github.com/proteinjs/notifications/compare/@proteinjs/email-server@1.0.4...@proteinjs/email-server@1.0.5) (2024-08-02)
 
 **Note:** Version bump only for package @proteinjs/email-server

package/dist/generated/index.js

@@ -19,7 +19,7 @@ require("@proteinjs/reflection");
 require("@proteinjs/util");
 require("nodemailer");
 /** Generate Source Graph */
-var sourceGraph = "{\"options\":{\"directed\":true,\"multigraph\":false,\"compound\":false},\"nodes\":[{\"v\":\"@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory\",\"value\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"DefaultPasswordResetEmailConfigFactory\",\"filePath\":\"/home/runner/work/notifications/notifications/packages/email/server/src/EmailConfigs.ts\",\"qualifiedName\":\"@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory\",\"properties\":[],\"methods\":[{\"name\":\"getConfig\",\"returnType\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"PasswordResetEmailConfig\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/email-server/PasswordResetEmailConfig\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/reflection/Loadable\"},{\"v\":\"@proteinjs/email-server/DefaultEmailConfigFactory\",\"value\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"DefaultEmailConfigFactory\",\"filePath\":\"/home/runner/work/notifications/notifications/packages/email/server/src/EmailSender.ts\",\"qualifiedName\":\"@proteinjs/email-server/DefaultEmailConfigFactory\",\"properties\":[],\"methods\":[{\"name\":\"getEmailConfig\",\"returnType\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"EmailConfig\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/email-server/EmailConfig\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}}],\"edges\":[{\"v\":\"@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"},{\"v\":\"@proteinjs/email-server/DefaultEmailConfigFactory\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"}]}";
+var sourceGraph = "{\"options\":{\"directed\":true,\"multigraph\":false,\"compound\":false},\"nodes\":[{\"v\":\"@proteinjs/email-server/DefaultEmailConfigFactory\",\"value\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"DefaultEmailConfigFactory\",\"filePath\":\"/Users/veronica/Repositories/n3xa-meta-repo/packages/proteinjs/packages/notifications/packages/email/server/src/EmailSender.ts\",\"qualifiedName\":\"@proteinjs/email-server/DefaultEmailConfigFactory\",\"properties\":[],\"methods\":[{\"name\":\"getEmailConfig\",\"returnType\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"EmailConfig\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/email-server/EmailConfig\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/reflection/Loadable\"},{\"v\":\"@proteinjs/email-server/DefaultInviteEmailConfigFactory\",\"value\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"DefaultInviteEmailConfigFactory\",\"filePath\":\"/Users/veronica/Repositories/n3xa-meta-repo/packages/proteinjs/packages/notifications/packages/email/server/src/InviteEmailConfig.ts\",\"qualifiedName\":\"@proteinjs/email-server/DefaultInviteEmailConfigFactory\",\"properties\":[],\"methods\":[{\"name\":\"getConfig\",\"returnType\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"InviteEmailConfig\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/email-server/InviteEmailConfig\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory\",\"value\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"DefaultPasswordResetEmailConfigFactory\",\"filePath\":\"/Users/veronica/Repositories/n3xa-meta-repo/packages/proteinjs/packages/notifications/packages/email/server/src/PasswordResetEmailConfig.ts\",\"qualifiedName\":\"@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory\",\"properties\":[],\"methods\":[{\"name\":\"getConfig\",\"returnType\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"PasswordResetEmailConfig\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/email-server/PasswordResetEmailConfig\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/email-server/DefaultSignupConfirmationEmailConfigFactory\",\"value\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"DefaultSignupConfirmationEmailConfigFactory\",\"filePath\":\"/Users/veronica/Repositories/n3xa-meta-repo/packages/proteinjs/packages/notifications/packages/email/server/src/SignupConfirmationEmailConfig.ts\",\"qualifiedName\":\"@proteinjs/email-server/DefaultSignupConfirmationEmailConfigFactory\",\"properties\":[],\"methods\":[{\"name\":\"getConfig\",\"returnType\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"SignupConfirmationEmailConfig\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/email-server/SignupConfirmationEmailConfig\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}}],\"edges\":[{\"v\":\"@proteinjs/email-server/DefaultEmailConfigFactory\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"},{\"v\":\"@proteinjs/email-server/DefaultInviteEmailConfigFactory\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"},{\"v\":\"@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"},{\"v\":\"@proteinjs/email-server/DefaultSignupConfirmationEmailConfigFactory\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"}]}";
 /** Generate Source Links */
 var sourceLinks = {};
 /** Load Source Graph and Links */

package/dist/generated/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../generated/index.ts"],"names":[],"mappings":";AAAA,oCAAoC;;;;;;;;;;;;;;;;AAEpC,iCAA+B;AAC/B,2BAAyB;AACzB,sBAAoB;AAGpB,4BAA4B;AAE5B,IAAM,WAAW,GAAG,k7EAAk7E,CAAC;AAGv8E,4BAA4B;AAG5B,IAAM,WAAW,GAAG,EACnB,CAAC;AAGF,kCAAkC;AAElC,oDAAyD;AACzD,6BAAgB,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;AAGjD,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../generated/index.ts"],"names":[],"mappings":";AAAA,oCAAoC;;;;;;;;;;;;;;;;AAEpC,iCAA+B;AAC/B,2BAAyB;AACzB,sBAAoB;AAGpB,4BAA4B;AAE5B,IAAM,WAAW,GAAG,s9JAAs9J,CAAC;AAG3+J,4BAA4B;AAG5B,IAAM,WAAW,GAAG,EACnB,CAAC;AAGF,kCAAkC;AAElC,oDAAyD;AACzD,6BAAgB,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;AAGjD,2CAAyB"}

package/dist/index.d.ts

@@ -1,3 +1,5 @@
-export * from './src/EmailConfigs';
+export * from './src/InviteEmailConfig';
+export * from './src/PasswordResetEmailConfig';
+export * from './src/SignupConfirmationEmailConfig';
 export * from './src/EmailSender';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,mBAAmB,CAAC"}

package/dist/index.js

@@ -14,6 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./src/EmailConfigs"), exports);
+__exportStar(require("./src/InviteEmailConfig"), exports);
+__exportStar(require("./src/PasswordResetEmailConfig"), exports);
+__exportStar(require("./src/SignupConfirmationEmailConfig"), exports);
 __exportStar(require("./src/EmailSender"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AACnC,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,iEAA+C;AAC/C,sEAAoD;AACpD,oDAAkC"}

package/dist/src/InviteEmailConfig.d.ts

@@ -0,0 +1,39 @@
+import { Loadable } from '@proteinjs/reflection';
+import Mail from 'nodemailer/lib/mailer';
+export declare const getDefaultInviteEmailConfigFactory: () => DefaultInviteEmailConfigFactory;
+export interface InviteEmailConfig {
+    /**
+     * Options to pass into the `EmailSender` object when building the email to be sent.
+     *
+     * @see https://nodemailer.com/message/ for all available options
+     */
+    options?: Mail.Options;
+    /**
+     * A function that generates the email content (both text and HTML versions) for the password reset email.
+     *
+     * @param signupPathWithToken A partial URL path for the sign up page, including the invite token.
+     * This is in the format: 'signup?token=abc123def456'.
+     * Note: This is NOT a full URL. You need to prepend your application's base URL to create a complete, clickable link in the email content.
+     *
+     * @returns An object containing the email content:
+     * text: The plain text version of the email (required)
+     * html: The HTML version of the email (optional, used for styling)
+     *
+     * @example
+     * getEmailContent: (signupPathWithToken) => {
+     *   const fullUrl = `https://myapp.com/${signupPathWithToken}`;
+     *   return {
+     *     text: `Click here to sign up: ${fullUrl}`,
+     *     html: `<p>Click <a href="${fullUrl}">here</a> to sign up.</p>`
+     *   };
+     * }
+     */
+    getEmailContent: (signupPathWithToken: string) => {
+        text: string;
+        html?: string;
+    };
+}
+export interface DefaultInviteEmailConfigFactory extends Loadable {
+    getConfig(): InviteEmailConfig;
+}
+//# sourceMappingURL=InviteEmailConfig.d.ts.map

package/dist/src/InviteEmailConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InviteEmailConfig.d.ts","sourceRoot":"","sources":["../../src/InviteEmailConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAoB,MAAM,uBAAuB,CAAC;AACnE,OAAO,IAAI,MAAM,uBAAuB,CAAC;AAEzC,eAAO,MAAM,kCAAkC,uCAG5C,CAAC;AAEJ,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;IAEvB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,EAAE,CAAC,mBAAmB,EAAE,MAAM,KAAK;QAChD,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED,MAAM,WAAW,+BAAgC,SAAQ,QAAQ;IAC/D,SAAS,IAAI,iBAAiB,CAAC;CAChC"}

package/dist/src/InviteEmailConfig.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultInviteEmailConfigFactory = void 0;
+var reflection_1 = require("@proteinjs/reflection");
+var getDefaultInviteEmailConfigFactory = function () {
+    return reflection_1.SourceRepository.get().object('@proteinjs/email-server/DefaultInviteEmailConfigFactory');
+};
+exports.getDefaultInviteEmailConfigFactory = getDefaultInviteEmailConfigFactory;
+//# sourceMappingURL=InviteEmailConfig.js.map

package/dist/src/InviteEmailConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InviteEmailConfig.js","sourceRoot":"","sources":["../../src/InviteEmailConfig.ts"],"names":[],"mappings":";;;AAAA,oDAAmE;AAG5D,IAAM,kCAAkC,GAAG;IAChD,OAAA,6BAAgB,CAAC,GAAG,EAAE,CAAC,MAAM,CAC3B,yDAAyD,CAC1D;AAFD,CAEC,CAAC;AAHS,QAAA,kCAAkC,sCAG3C"}

package/dist/src/{EmailConfigs.d.ts → PasswordResetEmailConfig.d.ts}

@@ -36,4 +36,4 @@ export interface PasswordResetEmailConfig {
 export interface DefaultPasswordResetEmailConfigFactory extends Loadable {
     getConfig(): PasswordResetEmailConfig;
 }
-//# sourceMappingURL=EmailConfigs.d.ts.map
+//# sourceMappingURL=PasswordResetEmailConfig.d.ts.map

package/dist/src/PasswordResetEmailConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PasswordResetEmailConfig.d.ts","sourceRoot":"","sources":["../../src/PasswordResetEmailConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAoB,MAAM,uBAAuB,CAAC;AACnE,OAAO,IAAI,MAAM,uBAAuB,CAAC;AAEzC,eAAO,MAAM,yCAAyC,8CAGnD,CAAC;AAEJ,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;IAEvB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,EAAE,CAAC,kBAAkB,EAAE,MAAM,KAAK;QAC/C,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED,MAAM,WAAW,sCAAuC,SAAQ,QAAQ;IACtE,SAAS,IAAI,wBAAwB,CAAC;CACvC"}

package/dist/src/{EmailConfigs.js → PasswordResetEmailConfig.js}

@@ -6,4 +6,4 @@ var getDefaultPasswordResetEmailConfigFactory = function () {
     return reflection_1.SourceRepository.get().object('@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory');
 };
 exports.getDefaultPasswordResetEmailConfigFactory = getDefaultPasswordResetEmailConfigFactory;
-//# sourceMappingURL=EmailConfigs.js.map
+//# sourceMappingURL=PasswordResetEmailConfig.js.map

package/dist/src/PasswordResetEmailConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PasswordResetEmailConfig.js","sourceRoot":"","sources":["../../src/PasswordResetEmailConfig.ts"],"names":[],"mappings":";;;AAAA,oDAAmE;AAG5D,IAAM,yCAAyC,GAAG;IACvD,OAAA,6BAAgB,CAAC,GAAG,EAAE,CAAC,MAAM,CAC3B,gEAAgE,CACjE;AAFD,CAEC,CAAC;AAHS,QAAA,yCAAyC,6CAGlD"}

package/dist/src/SignupConfirmationEmailConfig.d.ts

@@ -0,0 +1,47 @@
+import { Loadable } from '@proteinjs/reflection';
+import Mail from 'nodemailer/lib/mailer';
+export interface DefaultSignupConfirmationEmailConfigFactory extends Loadable {
+    getConfig(): SignupConfirmationEmailConfig;
+}
+export declare const getDefaultSignupConfirmationEmailConfigFactory: () => DefaultSignupConfirmationEmailConfigFactory;
+export interface SignupConfirmationEmailConfig {
+    /**
+     * Options to pass into the `EmailSender` object when building the email to be sent.
+     *
+     * @see https://nodemailer.com/message/ for all available options
+     */
+    options?: Mail.Options;
+    /**
+     * Subject for new user signup confirmation emails.
+     * If provided, this will override the subject in options for new user emails.
+     */
+    newUserSubject?: string;
+    /**
+     * Subject for existing user notification emails.
+     * If provided, this will override the subject in options for existing user emails.
+     */
+    existingUserSubject?: string;
+    /**
+     * Generates the email content for a new user signup confirmation.
+     *
+     * @returns An object containing the email content:
+     * - text: The plain text version of the email (required)
+     * - html: The HTML version of the email (optional, used for styling)
+     */
+    getNewUserEmailContent: () => {
+        text: string;
+        html?: string;
+    };
+    /**
+     * Generates the email content for an existing user if they attempt to sign up again.
+     *
+     * @returns An object containing the email content:
+     * - text: The plain text version of the email (required)
+     * - html: The HTML version of the email (optional, used for styling)
+     */
+    getExistingUserEmailContent: () => {
+        text: string;
+        html?: string;
+    };
+}
+//# sourceMappingURL=SignupConfirmationEmailConfig.d.ts.map

package/dist/src/SignupConfirmationEmailConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SignupConfirmationEmailConfig.d.ts","sourceRoot":"","sources":["../../src/SignupConfirmationEmailConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAoB,MAAM,uBAAuB,CAAC;AACnE,OAAO,IAAI,MAAM,uBAAuB,CAAC;AAEzC,MAAM,WAAW,2CAA4C,SAAQ,QAAQ;IAC3E,SAAS,IAAI,6BAA6B,CAAC;CAC5C;AAED,eAAO,MAAM,8CAA8C,QAAO,2CAiBjE,CAAC;AAEF,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;IAEvB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;;OAMG;IACH,sBAAsB,EAAE,MAAM;QAC5B,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IAEF;;;;;;OAMG;IACH,2BAA2B,EAAE,MAAM;QACjC,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH"}

package/dist/src/SignupConfirmationEmailConfig.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultSignupConfirmationEmailConfigFactory = void 0;
+var reflection_1 = require("@proteinjs/reflection");
+var getDefaultSignupConfirmationEmailConfigFactory = function () {
+    var defaultFactory = {
+        getConfig: function () { return ({
+            getNewUserEmailContent: function () { return ({
+                text: "Welcome to our app! Thank you for signing up. Your account has been successfully created.",
+            }); },
+            getExistingUserEmailContent: function () { return ({
+                text: "Hello, We received a sign up request for this email address, but you already have an account with us.\n        If you didn't attempt to sign up again, you can safely ignore this email.",
+            }); },
+        }); },
+    };
+    var factory = reflection_1.SourceRepository.get().object('@proteinjs/email-server/DefaultSignupConfirmationEmailConfigFactory');
+    return factory || defaultFactory;
+};
+exports.getDefaultSignupConfirmationEmailConfigFactory = getDefaultSignupConfirmationEmailConfigFactory;
+//# sourceMappingURL=SignupConfirmationEmailConfig.js.map

package/dist/src/SignupConfirmationEmailConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SignupConfirmationEmailConfig.js","sourceRoot":"","sources":["../../src/SignupConfirmationEmailConfig.ts"],"names":[],"mappings":";;;AAAA,oDAAmE;AAO5D,IAAM,8CAA8C,GAAG;IAC5D,IAAM,cAAc,GAAgD;QAClE,SAAS,EAAE,cAAqC,OAAA,CAAC;YAC/C,sBAAsB,EAAE,cAAM,OAAA,CAAC;gBAC7B,IAAI,EAAE,2FAA2F;aAClG,CAAC,EAF4B,CAE5B;YACF,2BAA2B,EAAE,cAAM,OAAA,CAAC;gBAClC,IAAI,EAAE,0LACoE;aAC3E,CAAC,EAHiC,CAGjC;SACH,CAAC,EAR8C,CAQ9C;KACH,CAAC;IAEF,IAAM,OAAO,GAAG,6BAAgB,CAAC,GAAG,EAAE,CAAC,MAAM,CAC3C,qEAAqE,CACtE,CAAC;IACF,OAAO,OAAO,IAAI,cAAc,CAAC;AACnC,CAAC,CAAC;AAjBW,QAAA,8CAA8C,kDAiBzD"}

package/generated/index.ts

@@ -7,7 +7,7 @@ import 'nodemailer';
 
 /** Generate Source Graph */
 
-const sourceGraph = "{\"options\":{\"directed\":true,\"multigraph\":false,\"compound\":false},\"nodes\":[{\"v\":\"@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory\",\"value\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"DefaultPasswordResetEmailConfigFactory\",\"filePath\":\"/home/runner/work/notifications/notifications/packages/email/server/src/EmailConfigs.ts\",\"qualifiedName\":\"@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory\",\"properties\":[],\"methods\":[{\"name\":\"getConfig\",\"returnType\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"PasswordResetEmailConfig\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/email-server/PasswordResetEmailConfig\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/reflection/Loadable\"},{\"v\":\"@proteinjs/email-server/DefaultEmailConfigFactory\",\"value\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"DefaultEmailConfigFactory\",\"filePath\":\"/home/runner/work/notifications/notifications/packages/email/server/src/EmailSender.ts\",\"qualifiedName\":\"@proteinjs/email-server/DefaultEmailConfigFactory\",\"properties\":[],\"methods\":[{\"name\":\"getEmailConfig\",\"returnType\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"EmailConfig\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/email-server/EmailConfig\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}}],\"edges\":[{\"v\":\"@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"},{\"v\":\"@proteinjs/email-server/DefaultEmailConfigFactory\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"}]}";
+const sourceGraph = "{\"options\":{\"directed\":true,\"multigraph\":false,\"compound\":false},\"nodes\":[{\"v\":\"@proteinjs/email-server/DefaultEmailConfigFactory\",\"value\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"DefaultEmailConfigFactory\",\"filePath\":\"/Users/veronica/Repositories/n3xa-meta-repo/packages/proteinjs/packages/notifications/packages/email/server/src/EmailSender.ts\",\"qualifiedName\":\"@proteinjs/email-server/DefaultEmailConfigFactory\",\"properties\":[],\"methods\":[{\"name\":\"getEmailConfig\",\"returnType\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"EmailConfig\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/email-server/EmailConfig\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/reflection/Loadable\"},{\"v\":\"@proteinjs/email-server/DefaultInviteEmailConfigFactory\",\"value\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"DefaultInviteEmailConfigFactory\",\"filePath\":\"/Users/veronica/Repositories/n3xa-meta-repo/packages/proteinjs/packages/notifications/packages/email/server/src/InviteEmailConfig.ts\",\"qualifiedName\":\"@proteinjs/email-server/DefaultInviteEmailConfigFactory\",\"properties\":[],\"methods\":[{\"name\":\"getConfig\",\"returnType\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"InviteEmailConfig\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/email-server/InviteEmailConfig\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory\",\"value\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"DefaultPasswordResetEmailConfigFactory\",\"filePath\":\"/Users/veronica/Repositories/n3xa-meta-repo/packages/proteinjs/packages/notifications/packages/email/server/src/PasswordResetEmailConfig.ts\",\"qualifiedName\":\"@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory\",\"properties\":[],\"methods\":[{\"name\":\"getConfig\",\"returnType\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"PasswordResetEmailConfig\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/email-server/PasswordResetEmailConfig\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/email-server/DefaultSignupConfirmationEmailConfigFactory\",\"value\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"DefaultSignupConfirmationEmailConfigFactory\",\"filePath\":\"/Users/veronica/Repositories/n3xa-meta-repo/packages/proteinjs/packages/notifications/packages/email/server/src/SignupConfirmationEmailConfig.ts\",\"qualifiedName\":\"@proteinjs/email-server/DefaultSignupConfirmationEmailConfigFactory\",\"properties\":[],\"methods\":[{\"name\":\"getConfig\",\"returnType\":{\"packageName\":\"@proteinjs/email-server\",\"name\":\"SignupConfirmationEmailConfig\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/email-server/SignupConfirmationEmailConfig\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}}],\"edges\":[{\"v\":\"@proteinjs/email-server/DefaultEmailConfigFactory\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"},{\"v\":\"@proteinjs/email-server/DefaultInviteEmailConfigFactory\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"},{\"v\":\"@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"},{\"v\":\"@proteinjs/email-server/DefaultSignupConfirmationEmailConfigFactory\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"}]}";
 
 
 /** Generate Source Links */

package/index.ts

@@ -1,2 +1,4 @@
-export * from './src/EmailConfigs';
+export * from './src/InviteEmailConfig';
+export * from './src/PasswordResetEmailConfig';
+export * from './src/SignupConfirmationEmailConfig';
 export * from './src/EmailSender';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proteinjs/email-server",
-  "version": "1.0.5",
+  "version": "1.1.1",
   "description": "Email server libraries",
   "main": "./dist/generated/index.js",
   "types": "./dist/generated/index.d.ts",
@@ -23,12 +23,12 @@
     "watch": "reflection-watch"
   },
   "dependencies": {
-    "@proteinjs/reflection": "1.1.7",
-    "@proteinjs/util": "1.3.1",
+    "@proteinjs/reflection": "1.1.8",
+    "@proteinjs/util": "1.4.0",
     "nodemailer": "6.9.14"
   },
   "devDependencies": {
-    "@proteinjs/reflection-build": "1.0.22",
+    "@proteinjs/reflection-build": "1.0.23",
     "@types/jest": "29.5.5",
     "@types/node": "20.3.1",
     "@types/nodemailer": "6.4.15",
@@ -40,6 +40,5 @@
     "jest": "29.7.0",
     "ts-jest": "29.1.1",
     "typescript": "5.2.2"
-  },
-  "gitHead": "b3340adf0c32126349cd3f74e1544ab1a0381d5e"
-}
+  }
+}

package/src/InviteEmailConfig.ts

@@ -0,0 +1,45 @@
+import { Loadable, SourceRepository } from '@proteinjs/reflection';
+import Mail from 'nodemailer/lib/mailer';
+
+export const getDefaultInviteEmailConfigFactory = () =>
+  SourceRepository.get().object<DefaultInviteEmailConfigFactory>(
+    '@proteinjs/email-server/DefaultInviteEmailConfigFactory'
+  );
+
+export interface InviteEmailConfig {
+  /**
+   * Options to pass into the `EmailSender` object when building the email to be sent.
+   *
+   * @see https://nodemailer.com/message/ for all available options
+   */
+  options?: Mail.Options;
+
+  /**
+   * A function that generates the email content (both text and HTML versions) for the password reset email.
+   *
+   * @param signupPathWithToken A partial URL path for the sign up page, including the invite token.
+   * This is in the format: 'signup?token=abc123def456'.
+   * Note: This is NOT a full URL. You need to prepend your application's base URL to create a complete, clickable link in the email content.
+   *
+   * @returns An object containing the email content:
+   * text: The plain text version of the email (required)
+   * html: The HTML version of the email (optional, used for styling)
+   *
+   * @example
+   * getEmailContent: (signupPathWithToken) => {
+   *   const fullUrl = `https://myapp.com/${signupPathWithToken}`;
+   *   return {
+   *     text: `Click here to sign up: ${fullUrl}`,
+   *     html: `<p>Click <a href="${fullUrl}">here</a> to sign up.</p>`
+   *   };
+   * }
+   */
+  getEmailContent: (signupPathWithToken: string) => {
+    text: string;
+    html?: string;
+  };
+}
+
+export interface DefaultInviteEmailConfigFactory extends Loadable {
+  getConfig(): InviteEmailConfig;
+}

package/src/SignupConfirmationEmailConfig.ts

@@ -0,0 +1,70 @@
+import { Loadable, SourceRepository } from '@proteinjs/reflection';
+import Mail from 'nodemailer/lib/mailer';
+
+export interface DefaultSignupConfirmationEmailConfigFactory extends Loadable {
+  getConfig(): SignupConfirmationEmailConfig;
+}
+
+export const getDefaultSignupConfirmationEmailConfigFactory = (): DefaultSignupConfirmationEmailConfigFactory => {
+  const defaultFactory: DefaultSignupConfirmationEmailConfigFactory = {
+    getConfig: (): SignupConfirmationEmailConfig => ({
+      getNewUserEmailContent: () => ({
+        text: `Welcome to our app! Thank you for signing up. Your account has been successfully created.`,
+      }),
+      getExistingUserEmailContent: () => ({
+        text: `Hello, We received a sign up request for this email address, but you already have an account with us.
+        If you didn't attempt to sign up again, you can safely ignore this email.`,
+      }),
+    }),
+  };
+
+  const factory = SourceRepository.get().object<DefaultSignupConfirmationEmailConfigFactory>(
+    '@proteinjs/email-server/DefaultSignupConfirmationEmailConfigFactory'
+  );
+  return factory || defaultFactory;
+};
+
+export interface SignupConfirmationEmailConfig {
+  /**
+   * Options to pass into the `EmailSender` object when building the email to be sent.
+   *
+   * @see https://nodemailer.com/message/ for all available options
+   */
+  options?: Mail.Options;
+
+  /**
+   * Subject for new user signup confirmation emails.
+   * If provided, this will override the subject in options for new user emails.
+   */
+  newUserSubject?: string;
+
+  /**
+   * Subject for existing user notification emails.
+   * If provided, this will override the subject in options for existing user emails.
+   */
+  existingUserSubject?: string;
+
+  /**
+   * Generates the email content for a new user signup confirmation.
+   *
+   * @returns An object containing the email content:
+   * - text: The plain text version of the email (required)
+   * - html: The HTML version of the email (optional, used for styling)
+   */
+  getNewUserEmailContent: () => {
+    text: string;
+    html?: string;
+  };
+
+  /**
+   * Generates the email content for an existing user if they attempt to sign up again.
+   *
+   * @returns An object containing the email content:
+   * - text: The plain text version of the email (required)
+   * - html: The HTML version of the email (optional, used for styling)
+   */
+  getExistingUserEmailContent: () => {
+    text: string;
+    html?: string;
+  };
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Brent Bahry
-
-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/dist/src/EmailConfigs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EmailConfigs.d.ts","sourceRoot":"","sources":["../../src/EmailConfigs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAoB,MAAM,uBAAuB,CAAC;AACnE,OAAO,IAAI,MAAM,uBAAuB,CAAC;AAEzC,eAAO,MAAM,yCAAyC,8CAGnD,CAAC;AAEJ,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;IAEvB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,EAAE,CAAC,kBAAkB,EAAE,MAAM,KAAK;QAC/C,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED,MAAM,WAAW,sCAAuC,SAAQ,QAAQ;IACtE,SAAS,IAAI,wBAAwB,CAAC;CACvC"}

package/dist/src/EmailConfigs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"EmailConfigs.js","sourceRoot":"","sources":["../../src/EmailConfigs.ts"],"names":[],"mappings":";;;AAAA,oDAAmE;AAG5D,IAAM,yCAAyC,GAAG;IACvD,OAAA,6BAAgB,CAAC,GAAG,EAAE,CAAC,MAAM,CAC3B,gEAAgE,CACjE;AAFD,CAEC,CAAC;AAHS,QAAA,yCAAyC,6CAGlD"}