@jhenbert/byteminds-util@0.1.4

Built and signed on GitHub Actions

Built and signed on GitHub Actions

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188
import { Cookies } from "npm:@sveltejs/kit@^2.5.18";
import { Lucia } from "npm:lucia@^3.2.0";
import * as nodemailer from "npm:nodemailer@^6.9.14";
import type SMTPTransport from "npm:nodemailer@^6.9.14/lib/smtp-transport";

type ComposeMessage = {
  from: string;
  to: string;
  subject: string;
  html: string;
};

/**
 * Composes an email message object with the specified sender, recipient, subject, and body content.
 *
 * @param {string} from - The email address of the sender.
 *
 * @param {string} to - The email address of the recipient.
 *
 * @param {string} subject - The subject line of the email.
 *
 * @param {string} body - The HTML content of the email body.
 *
 * @returns {object} - An object representing the composed email message. This object includes:
 *                     - `from`: The sender's email address.
 *                     - `to`: The recipient's email address.
 *                     - `subject`: The subject line of the email.
 *                     - `html`: The HTML content of the email body.
 *
 * @example
 * const from = 'sender@example.com';
 * const to = 'recipient@example.com';
 * const subject = 'Hello!';
 * const body = '<p>This is a test email.</p>';
 *
 * const message = mod.composeMessage(from, to, subject, body);
 *
 * console.log(message);
 * // Output:
 * // {
 * //   from: 'sender@example.com',
 * //   to: 'recipient@example.com',
 * //   subject: 'Hello!',
 * //   html: '<p>This is a test email.</p>',
 * // }
 */
export const composeMessage = (
  from: string,
  to: string,
  subject: string,
  body: string
): ComposeMessage => {
  return {
    from,
    to,
    subject,
    html: body,
  };
};

/**
 * Creates a mail transporter object using nodemailer for sending emails.
 *
 * @param {string} host - The hostname or IP address of the SMTP server.
 *
 * @param {number} port - The port number of the SMTP server.
 *
 * @param {boolean} secure - If true, the connection will use TLS when connecting to the SMTP server.
 *                           If false, the connection will use plaintext if the server supports it.
 *
 * @param {string} service - The name of the email service to use (e.g., 'gmail', 'yahoo').
 *                           This is optional if host and port are provided.
 *
 * @param {string} email - The email address used for authentication with the SMTP server.
 *
 * @param {string} password - The password used for authentication with the SMTP server.
 *
 * @returns {object} - A nodemailer transport object configured with the provided SMTP settings.
 *
 * @example
 * const host = 'smtp.example.com';
 * const port = 587;
 * const secure = false;
 * const service = 'gmail';
 * const email = 'user@example.com';
 * const password = 'user_app_password';
 *
 * const transporter = mod.mailTransporter(host, port, secure, service, email, password);
 *
 * console.log(transporter);
 * // Output: Transport object configured with the provided settings.
 */
export const mailTransporter = (
  host: string,
  port: number,
  secure: boolean,
  service: string,
  email: string,
  password: string
): nodemailer.Transporter<SMTPTransport.SentMessageInfo> => {
  return nodemailer.createTransport({
    host,
    port,
    secure,
    service,
    auth: {
      user: email,
      pass: password,
    },
  });
};

/**
 * Creates a new session for a user and sets the session cookie in the provided cookies object.
 *
 * @param {Lucia} lucia - An instance of the Lucia authentication library.
 * @param {string} userId - The unique identifier of the user for whom the session is being created.
 * @param {Cookies} cookies - An object representing the cookies to be set in the HTTP response.
 *
 * @returns {Promise<void>} - A promise that resolves when the session and cookie have been successfully created and set.
 *
 * @example
 * import type { Actions, PageServerLoad } from "./$types";
 * import { lucia } from "$lib/server/auth";
 * import * as mod from "@jhenbert/byteminds-util";
 *
 * export const actions: Actions = {
 * login: async ({ request, url, cookies }) => {
 *
 * //some of your code
 *
 * await mod.luciaCreateAndSetSession(lucia, existingUser.id, cookies);
 * },
 */
export const createAndSetSession = async (
  lucia: Lucia,
  userId: string,
  cookies: Cookies
): Promise<void> => {
  // Create a new session for the specified user
  const session = await lucia.createSession(userId, {});

  // Generate a session cookie using the session ID
  const sessionCookie = lucia.createSessionCookie(session.id);

  // Set the session cookie in the cookies object with the appropriate attributes
  cookies.set(sessionCookie.name, sessionCookie.value, {
    path: ".",
    ...sessionCookie.attributes,
  });
};

/**
 * Deletes the current session cookie by setting a blank session cookie in the provided cookies object.
 *
 * @param {Lucia} lucia - An instance of the Lucia authentication library.
 * @param {Cookies} cookies - An object representing the cookies to be set in the HTTP response.
 *
 * @returns {Promise<void>} - A promise that resolves when the session cookie has been successfully deleted.
 *
 * @example
 * import type { Actions } from "./$types";
 * import { lucia } from "$lib/server/auth";
 * import * as mod from "@jhenbert/byteminds-util";
 * 
 * export const actions: Actions = {
 * default: async ({ locals, cookies }) => {
 * 
 * //some of your codes
 * 
 * await mod.luciaDeleteSessionCookie(lucia, cookies);
 * 
 * },
};
 */
export const deleteSessionCookie = async (
  lucia: Lucia,
  cookies: Cookies
): Promise<void> => {
  // Create a blank session cookie to delete the current session cookie
  const sessionCookie = lucia.createBlankSessionCookie();

  // Set the blank session cookie in the cookies object with the appropriate attributes
  cookies.set(sessionCookie.name, sessionCookie.value, {
    path: ".",
    ...sessionCookie.attributes,
  });
};