@proteinjs/email-server 1.0.1 → 1.0.3

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.3](https://github.com/proteinjs/notifications/compare/@proteinjs/email-server@1.0.2...@proteinjs/email-server@1.0.3) (2024-07-12)
+
+
+### Bug Fixes
+
+* rename location for config ([1616edc](https://github.com/proteinjs/notifications/commit/1616edc59d4ff8667cda03c27949a42f1aa1b63a))
+
+
+
+
+
+## [1.0.2](https://github.com/proteinjs/notifications/compare/@proteinjs/email-server@1.0.1...@proteinjs/email-server@1.0.2) (2024-07-12)
+
+
+### Bug Fixes
+
+* update location of config factory ([3bef859](https://github.com/proteinjs/notifications/commit/3bef8595ba48ed3b7b91376ca1ba9b8f1a1b8f18))
+
+
+
+
+
 ## 1.0.1 (2024-07-12)
 
 **Note:** Version bump only for package @proteinjs/email-server

package/dist/generated/index.d.ts

@@ -1,6 +1,6 @@
 /** Load Dependency Source Graphs */
-import '@proteinjs/util';
 import '@proteinjs/reflection';
+import '@proteinjs/util';
 import 'nodemailer';
 export * from '../index';
 //# sourceMappingURL=index.d.ts.map

package/dist/generated/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../generated/index.ts"],"names":[],"mappings":"AAAA,oCAAoC;AAEpC,OAAO,iBAAiB,CAAC;AACzB,OAAO,uBAAuB,CAAC;AAC/B,OAAO,YAAY,CAAC;AAqBpB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../generated/index.ts"],"names":[],"mappings":"AAAA,oCAAoC;AAEpC,OAAO,uBAAuB,CAAC;AAC/B,OAAO,iBAAiB,CAAC;AACzB,OAAO,YAAY,CAAC;AAqBpB,cAAc,UAAU,CAAC"}

package/dist/generated/index.js

@@ -15,8 +15,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 });
-require("@proteinjs/util");
 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\"}]}";

package/dist/generated/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../generated/index.ts"],"names":[],"mappings":";AAAA,oCAAoC;;;;;;;;;;;;;;;;AAEpC,2BAAyB;AACzB,iCAA+B;AAC/B,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,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"}

package/dist/src/EmailConfigs.d.ts

@@ -2,8 +2,33 @@ import { Loadable } from '@proteinjs/reflection';
 import Mail from 'nodemailer/lib/mailer';
 export declare const getDefaultPasswordResetEmailConfigFactory: () => DefaultPasswordResetEmailConfigFactory;
 export interface PasswordResetEmailConfig {
+    /**
+     * 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;
-    getEmailContent: (token: string) => {
+    /**
+     * A function that generates the email content (both text and HTML versions) for the password reset email.
+     *
+     * @param resetPathWithToken A partial URL path for resetting the password, including the reset token.
+     * This is in the format: 'login/reset-password?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: (resetPathWithToken) => {
+     *   const fullResetUrl = `https://myapp.com/${resetPathWithToken}`;
+     *   return {
+     *     text: `Click here to reset your password: ${fullResetUrl}`,
+     *     html: `<p>Click <a href="${fullResetUrl}">here</a> to reset your password.</p>`
+     *   };
+     * }
+     */
+    getEmailContent: (resetPathWithToken: string) => {
         text: string;
         html?: string;
     };

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

@@ -1 +1 @@
-{"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,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;IACvB,eAAe,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK;QAClC,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"}
+{"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

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDefaultPasswordResetEmailConfigFactory = void 0;
 var reflection_1 = require("@proteinjs/reflection");
 var getDefaultPasswordResetEmailConfigFactory = function () {
-    return reflection_1.SourceRepository.get().object('@proteinjs/user-server/DefaultPasswordResetEmailConfigFactory');
+    return reflection_1.SourceRepository.get().object('@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory');
 };
 exports.getDefaultPasswordResetEmailConfigFactory = getDefaultPasswordResetEmailConfigFactory;
 //# sourceMappingURL=EmailConfigs.js.map

package/dist/src/EmailConfigs.js.map

@@ -1 +1 @@
-{"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,+DAA+D,CAChE;AAFD,CAEC,CAAC;AAHS,QAAA,yCAAyC,6CAGlD"}
+{"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"}

package/dist/src/EmailSender.js

@@ -68,9 +68,9 @@ var EmailSender = /** @class */ (function () {
     }
     EmailSender.prototype.getDefaultEmailConfig = function () {
         if (!EmailSender.defaultEmailConfig) {
-            var defaultEmailConfigFactory = reflection_1.SourceRepository.get().object('@proteinjs/user-server/DefaultEmailConfigFactory');
+            var defaultEmailConfigFactory = reflection_1.SourceRepository.get().object('@proteinjs/email-server/DefaultEmailConfigFactory');
             if (!defaultEmailConfigFactory) {
-                throw new Error("Unable to find a @proteinjs/user-server/DefaultEmailConfigFactory implementation. Either implement DefaultEmailConfigFactory or pass in an email config when instantiating EmailSender.");
+                throw new Error("Unable to find a @proteinjs/email-server/DefaultEmailConfigFactory implementation. Either implement DefaultEmailConfigFactory or pass in an email config when instantiating EmailSender.");
             }
             EmailSender.defaultEmailConfig = defaultEmailConfigFactory.getEmailConfig();
         }

package/dist/src/EmailSender.js.map

@@ -1 +1 @@
-{"version":3,"file":"EmailSender.js","sourceRoot":"","sources":["../../src/EmailSender.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0DAAoC;AACpC,wCAAyC;AACzC,oDAAmE;AAqBnE;IAOE,qBAAY,MAAoB;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC7D,IAAI,CAAC,WAAW,GAAG,oBAAU,CAAC,eAAe,CAAC;YAC5C,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;YACtB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;YACtB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YAC1B,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;SACvB,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,IAAI,aAAM,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IAEO,2CAAqB,GAA7B;QACE,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE;YACnC,IAAM,yBAAyB,GAAG,6BAAgB,CAAC,GAAG,EAAE,CAAC,MAAM,CAC7D,kDAAkD,CACnD,CAAC;YACF,IAAI,CAAC,yBAAyB,EAAE;gBAC9B,MAAM,IAAI,KAAK,CACb,yLAAyL,CAC1L,CAAC;aACH;YAED,WAAW,CAAC,kBAAkB,GAAG,yBAAyB,CAAC,cAAc,EAAE,CAAC;SAC7E;QAED,OAAO,WAAW,CAAC,kBAAkB,CAAC;IACxC,CAAC;IAEK,+BAAS,GAAf,UAAgB,WAAyB;;;;;;wBACjC,gBAAgB,cACpB,IAAI,EAAE,IAAI,CAAC,WAAW,IACnB,WAAW,CACf,CAAC;;;;wBAGA,qBAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAA;;wBAAjD,SAAiD,CAAC;wBAClD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qCAA8B,WAAW,CAAC,EAAE,CAAE,CAAC,CAAC;;;;wBAEjE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE,OAAK,CAAC,CAAC;wBACjD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;;;;;KAE3C;IACH,kBAAC;AAAD,CAAC,AAlDD,IAkDC;AAlDY,kCAAW;AAoDxB,SAAgB,iBAAiB,CAAC,MAAmB;IACnD,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAFD,8CAEC"}
+{"version":3,"file":"EmailSender.js","sourceRoot":"","sources":["../../src/EmailSender.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0DAAoC;AACpC,wCAAyC;AACzC,oDAAmE;AAqBnE;IAOE,qBAAY,MAAoB;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC7D,IAAI,CAAC,WAAW,GAAG,oBAAU,CAAC,eAAe,CAAC;YAC5C,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;YACtB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;YACtB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YAC1B,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;SACvB,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,IAAI,aAAM,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IAEO,2CAAqB,GAA7B;QACE,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE;YACnC,IAAM,yBAAyB,GAAG,6BAAgB,CAAC,GAAG,EAAE,CAAC,MAAM,CAC7D,mDAAmD,CACpD,CAAC;YACF,IAAI,CAAC,yBAAyB,EAAE;gBAC9B,MAAM,IAAI,KAAK,CACb,0LAA0L,CAC3L,CAAC;aACH;YAED,WAAW,CAAC,kBAAkB,GAAG,yBAAyB,CAAC,cAAc,EAAE,CAAC;SAC7E;QAED,OAAO,WAAW,CAAC,kBAAkB,CAAC;IACxC,CAAC;IAEK,+BAAS,GAAf,UAAgB,WAAyB;;;;;;wBACjC,gBAAgB,cACpB,IAAI,EAAE,IAAI,CAAC,WAAW,IACnB,WAAW,CACf,CAAC;;;;wBAGA,qBAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAA;;wBAAjD,SAAiD,CAAC;wBAClD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qCAA8B,WAAW,CAAC,EAAE,CAAE,CAAC,CAAC;;;;wBAEjE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE,OAAK,CAAC,CAAC;wBACjD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;;;;;KAE3C;IACH,kBAAC;AAAD,CAAC,AAlDD,IAkDC;AAlDY,kCAAW;AAoDxB,SAAgB,iBAAiB,CAAC,MAAmB;IACnD,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAFD,8CAEC"}

package/generated/index.ts

@@ -1,7 +1,7 @@
 /** Load Dependency Source Graphs */
 
-import '@proteinjs/util';
 import '@proteinjs/reflection';
+import '@proteinjs/util';
 import 'nodemailer';
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proteinjs/email-server",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Email server libraries",
   "main": "./dist/generated/index.js",
   "types": "./dist/generated/index.d.ts",
@@ -41,5 +41,5 @@
     "ts-jest": "29.1.1",
     "typescript": "5.2.2"
   },
-  "gitHead": "fb083f030cced657b131af60dc7e4f5934911aa1"
+  "gitHead": "bbe2ed40e15cfd66be099eedb2e452880150f540"
 }

package/src/EmailConfigs.ts

@@ -3,12 +3,38 @@ import Mail from 'nodemailer/lib/mailer';
 
 export const getDefaultPasswordResetEmailConfigFactory = () =>
   SourceRepository.get().object<DefaultPasswordResetEmailConfigFactory>(
-    '@proteinjs/user-server/DefaultPasswordResetEmailConfigFactory'
+    '@proteinjs/email-server/DefaultPasswordResetEmailConfigFactory'
   );
 
 export interface PasswordResetEmailConfig {
+  /**
+   * 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;
-  getEmailContent: (token: string) => {
+
+  /**
+   * A function that generates the email content (both text and HTML versions) for the password reset email.
+   *
+   * @param resetPathWithToken A partial URL path for resetting the password, including the reset token.
+   * This is in the format: 'login/reset-password?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: (resetPathWithToken) => {
+   *   const fullResetUrl = `https://myapp.com/${resetPathWithToken}`;
+   *   return {
+   *     text: `Click here to reset your password: ${fullResetUrl}`,
+   *     html: `<p>Click <a href="${fullResetUrl}">here</a> to reset your password.</p>`
+   *   };
+   * }
+   */
+  getEmailContent: (resetPathWithToken: string) => {
     text: string;
     html?: string;
   };

package/src/EmailSender.ts

@@ -43,11 +43,11 @@ export class EmailSender {
   private getDefaultEmailConfig(): EmailConfig {
     if (!EmailSender.defaultEmailConfig) {
       const defaultEmailConfigFactory = SourceRepository.get().object<DefaultEmailConfigFactory>(
-        '@proteinjs/user-server/DefaultEmailConfigFactory'
+        '@proteinjs/email-server/DefaultEmailConfigFactory'
       );
       if (!defaultEmailConfigFactory) {
         throw new Error(
-          `Unable to find a @proteinjs/user-server/DefaultEmailConfigFactory implementation. Either implement DefaultEmailConfigFactory or pass in an email config when instantiating EmailSender.`
+          `Unable to find a @proteinjs/email-server/DefaultEmailConfigFactory implementation. Either implement DefaultEmailConfigFactory or pass in an email config when instantiating EmailSender.`
         );
       }