@johnmmackey/ms-utils 4.2.1 → 4.4.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Version 4.4.0
+* Added a module declaration file for typescript consumers
+
+## Version 4.3.0
+* Ensure .env is the highest priority
+
 ## Version 4.2.1
 * Bug fix on load
 

package/README.md

@@ -47,7 +47,7 @@ sendmail(
 * uses ```dotenv``` to load a .env file in the current working directory into the environment
 * pushes all items loaded from etcd into the environment.
 
-The order of precedence: etcd > .env > external set environment
+The order of precedence: .env > ETCD > externally set environment
 
 ## Future
 * Add local queueing for log events when AMQP is not operative.

package/index.d.ts

@@ -0,0 +1,175 @@
+// Type definitions for @johnmmackey/ms-utils
+// Project: https://bitbucket.org/52westlabs/ms-utils
+// Definitions by: GitHub Copilot
+
+/// <reference types="node" />
+
+import { SESv2Client, SendEmailCommandOutput } from '@aws-sdk/client-sesv2';
+
+// ============================================================================
+// Utils Module
+// ============================================================================
+
+export namespace Utils {
+  /**
+   * Masks sensitive keys in configuration objects
+   * @param config - Configuration object to mask
+   * @returns A new object with masked sensitive values
+   */
+  function maskKeys(config: Record<string, any>): Record<string, any>;
+}
+
+// ============================================================================
+// Config Module
+// ============================================================================
+
+export namespace Config {
+  /**
+   * Loads configuration from etcd for the specified service
+   * @param serviceName - Name of the service to load configuration for
+   * @returns Promise that resolves to the configuration object
+   */
+  function load(serviceName: string): Promise<Record<string, string>>;
+
+  /**
+   * Gets a configuration value by key or all configuration if no key provided
+   * @param k - Optional configuration key
+   * @returns Configuration value or entire configuration object
+   */
+  function get(): Record<string, string>;
+  function get(k: string): string;
+
+  /**
+   * Gets a configuration value as a parsed JSON object
+   * @param k - Configuration key
+   * @returns Parsed JSON object or null if parsing fails
+   */
+  function getObj(k: string): any | null;
+}
+
+// ============================================================================
+// Winston MSLogger Factory
+// ============================================================================
+
+export interface MSLoggerOptions {
+  level?: string;
+}
+
+export interface ConnectionManager {
+  addConfig(callback: (channel: any) => void): void;
+  sendToQueue(queue: string, content: Buffer, options?: any): void;
+  ch?: any;
+}
+
+export interface WinstonTransport {
+  name: string;
+  level: string;
+  log(level: string, msg: string, meta: any, callback: (error: Error | null, success: boolean) => void): void;
+}
+
+export interface Winston {
+  transports: {
+    MSLogger?: any;
+  };
+  Transport: any;
+}
+
+/**
+ * Factory function to create a Winston MSLogger transport
+ * @param winston - Winston instance
+ * @param serviceName - Name of the service
+ * @param cm - Connection manager instance
+ * @returns MSLogger constructor
+ */
+export function winstonMSLoggerFactory(
+  winston: Winston,
+  serviceName: string,
+  cm: ConnectionManager
+): new (options: MSLoggerOptions) => WinstonTransport;
+
+// ============================================================================
+// Mailer Module
+// ============================================================================
+
+export interface MailRecipient {
+  email: string;
+  name: string;
+}
+
+export interface MailAttachment {
+  originalname: string;
+  mimetype: string;
+  path?: string;
+  content?: Buffer;
+  contentDisposition?: string;
+  cid?: string;
+}
+
+export interface MailOptions {
+  from?: string;
+  subject?: string;
+  replyTo?: string;
+  textBody?: string;
+  htmlBody?: string;
+  attachments?: MailAttachment[];
+  includeUnsubscribeLink?: boolean;
+  mailingLists?: any;
+}
+
+export class Mailer {
+  /**
+   * Creates a new Mailer instance
+   * @param connectionManager - AMQP connection manager
+   */
+  constructor(connectionManager: ConnectionManager);
+
+  /**
+   * Sends an email message
+   * @param recipients - Array of recipients
+   * @param options - Mail options
+   * @returns Promise that resolves when email is queued
+   */
+  send(recipients: MailRecipient[], options: MailOptions): Promise<void>;
+
+  /**
+   * Writes a key-value pair to Redis
+   * @param v - Value to store
+   * @param type - Type identifier
+   * @returns Promise that resolves to the generated key
+   */
+  writeKey(v: string, type: string): Promise<string>;
+}
+
+// ============================================================================
+// AWS SES Send Mail Module
+// ============================================================================
+
+export interface AwsMailMessage {
+  from: string;
+  to: string | string[];
+  replyTo?: string;
+  subject: string;
+  textBody?: string;
+  htmlBody?: string;
+}
+
+/**
+ * Sends an email via AWS SES v2
+ * @param message - Email message details
+ * @returns Promise that resolves to AWS SES response
+ */
+export function awsSendMail(message: AwsMailMessage): Promise<SendEmailCommandOutput>;
+
+// ============================================================================
+// Main Module Exports
+// ============================================================================
+
+declare const _default: {
+  Utils: typeof Utils;
+  Config: typeof Config;
+  winstonMSLoggerFactory: typeof winstonMSLoggerFactory;
+  Mailer: typeof Mailer;
+  awsSendMail: typeof awsSendMail;
+};
+
+export default _default;

package/lib/config.js

@@ -33,6 +33,11 @@ async function load(serviceName) {
 
     // as a side-effect, load these into process.env
     dotenv.populate(process.env, config, { override: true });
+    
+    // load any .env file that may be present into the environment
+    // again to override
+    // why? the first one may be necessary to find an etcd server...
+    dotenv.config({ override: true });
     return config;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@johnmmackey/ms-utils",
-  "version": "4.2.1",
+  "version": "4.4.0",
   "description": "Utility functions for Microservice Architecture",
   "main": "index.js",
   "scripts": {
@@ -14,8 +14,8 @@
   "license": "ISC",
   "homepage": "https://bitbucket.org/52westlabs/ms-utils#readme",
   "dependencies": {
-    "@aws-sdk/client-sesv2": "^3.758.0",
-    "dotenv": "^16.4.7",
+    "@aws-sdk/client-sesv2": "^3.987.0",
+    "dotenv": "^17.2.4",
     "etcd3": "^1.1.2",
     "redis": "^4.7.0",
     "uuid": "^11.1.0"