@appweaver/core 1.0.0

package/health/health-schema.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.healthReadySchema = exports.ReadyResponse = exports.HealthCheckCommonData = exports.HealthCheckResult = void 0;
+exports.createHealthCheckSchema = createHealthCheckSchema;
+const typebox_1 = require("@sinclair/typebox");
+const common_1 = require("@appweaver/common");
+const errors_1 = require("../errors");
+const utils_1 = require("../utils");
+exports.HealthCheckResult = typebox_1.Type.Object({
+    status: (0, common_1.StringEnum)(common_1.HealthCheckStatus),
+    message: typebox_1.Type.Optional(typebox_1.Type.String())
+});
+exports.HealthCheckCommonData = typebox_1.Type.Object({
+    status: (0, common_1.StringEnum)(common_1.HealthCheckStatus),
+    timestamp: (0, common_1.StringDate)()
+});
+exports.ReadyResponse = typebox_1.Type.Object({
+    ready: typebox_1.Type.Boolean({ example: true })
+}, { $id: 'HealthReadyResponse' });
+exports.healthReadySchema = {
+    tags: ['Health'],
+    summary: 'Application ready status',
+    description: 'Application ready status',
+    response: {
+        200: (0, utils_1.createSchemaModel)(exports.ReadyResponse),
+        ...errors_1.AllErrorResponses
+    }
+};
+function createHealthCheckSchema(serviceNames) {
+    const healthChecks = {};
+    const healthCheckResult = (0, utils_1.createSchemaModel)(exports.HealthCheckResult, {
+        name: 'HealthCheckResult'
+    });
+    for (const service of serviceNames) {
+        healthChecks[service] = healthCheckResult;
+    }
+    const healthCheckResponse = (0, utils_1.createSchemaModel)(typebox_1.Type.Composite([
+        exports.HealthCheckCommonData,
+        typebox_1.Type.Object({ checks: typebox_1.Type.Object(healthChecks) })
+    ], { $id: 'HealthCheckResponse' }));
+    return {
+        tags: ['Health'],
+        security: common_1.config.HEALTH_CHECK_AUTH ? [{ bearer: [] }] : [],
+        summary: 'Health check status',
+        description: 'Health check status',
+        response: {
+            200: healthCheckResponse,
+            503: healthCheckResponse,
+            ...errors_1.AllErrorResponses
+        }
+    };
+}

package/health/health-service.d.ts

@@ -0,0 +1,38 @@
+import { HealthCheckConfig, HealthCheckStatus, IHealthCheck } from '@appweaver/common';
+export type HealthCheckResponse = {
+    status: HealthCheckStatus;
+    message?: string;
+};
+export type HealthCheckInstance = {
+    name: string;
+    value: IHealthCheck;
+    config?: HealthCheckConfig;
+};
+export declare class HealthService {
+    /**
+     * Performs a health check for multiple health check instances by invoking their respective health check methods.
+     *
+     * @return {Promise<Record<string, HealthCheckResponse>>} A promise that resolves to an object where each key is the
+     * name of the instance, and the value is a health check response containing the instance status and, if applicable,
+     * its corresponding message.
+     */
+    checkHealth(): Promise<Record<string, HealthCheckResponse>>;
+    /**
+     * Asynchronously checks the readiness status of a system or component.
+     *
+     * @return {Promise<boolean>} A promise that resolves to a boolean value indicating readiness status. Returns `true`
+     * if ready, otherwise `false`.
+     */
+    checkReadiness(): Promise<boolean>;
+    /**
+     * Retrieves a list of instances that implement the health check functionality, ensuring they are unique
+     * and properly configured. Each instance is returned with its name, instance, and optional configuration.
+     * Some instances can be removed from the list based on the configured pick and omit properties.
+     *
+     * @return {HealthCheckInstance[]} An array of objects, where each object contains:
+     *         - `name`: The unique name assigned to the instance.
+     *         - `value`: The instance value implementing the health check interface.
+     *         - `config` (optional): Additional configuration details for the health check, if available.
+     */
+    healthCheckInstances(): HealthCheckInstance[];
+}

package/health/health-service.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthService = void 0;
+const common_1 = require("@appweaver/common");
+const context_1 = require("../context");
+class HealthService {
+    /**
+     * Performs a health check for multiple health check instances by invoking their respective health check methods.
+     *
+     * @return {Promise<Record<string, HealthCheckResponse>>} A promise that resolves to an object where each key is the
+     * name of the instance, and the value is a health check response containing the instance status and, if applicable,
+     * its corresponding message.
+     */
+    async checkHealth() {
+        const healthCheckInstances = this.healthCheckInstances();
+        const hideMessages = [];
+        const healthChecks = {};
+        for (const instance of healthCheckInstances) {
+            healthChecks[instance.name] = instance.value.checkHealth();
+            if (instance.config?.showMessage === false) {
+                hideMessages.push(instance.name);
+            }
+        }
+        const checkResults = await Promise.all(Object.values(healthChecks));
+        const healthCheckResponse = Object.keys(healthChecks).reduce((acc, key, index) => {
+            acc[key] = {
+                status: checkResults[index].success
+                    ? common_1.HealthCheckStatus.Up
+                    : common_1.HealthCheckStatus.Down,
+                message: !hideMessages[key] ? checkResults[index].message : undefined
+            };
+            return acc;
+        }, {});
+        common_1.logger.debug({ healthCheckResponse }, 'Health checks completed');
+        return healthCheckResponse;
+    }
+    /**
+     * Asynchronously checks the readiness status of a system or component.
+     *
+     * @return {Promise<boolean>} A promise that resolves to a boolean value indicating readiness status. Returns `true`
+     * if ready, otherwise `false`.
+     */
+    async checkReadiness() {
+        return true;
+    }
+    /**
+     * Retrieves a list of instances that implement the health check functionality, ensuring they are unique
+     * and properly configured. Each instance is returned with its name, instance, and optional configuration.
+     * Some instances can be removed from the list based on the configured pick and omit properties.
+     *
+     * @return {HealthCheckInstance[]} An array of objects, where each object contains:
+     *         - `name`: The unique name assigned to the instance.
+     *         - `value`: The instance value implementing the health check interface.
+     *         - `config` (optional): Additional configuration details for the health check, if available.
+     */
+    healthCheckInstances() {
+        const instances = (0, context_1.injectAllWhere)((def) => (0, common_1.isHealthCheck)(def.value));
+        // Return a unique set of instances that correctly implement the health check
+        let all = Array.from(new Map(instances.map((value) => {
+            const instanceConfig = value.checkHealthConfig?.();
+            const name = instanceConfig?.name || (0, common_1.uncapitalize)(value.constructor.name);
+            return [
+                name,
+                {
+                    name,
+                    value,
+                    config: instanceConfig
+                }
+            ];
+        })).values());
+        const pick = common_1.config.HEALTH_CHECK_PICK_INSTANCES;
+        if (pick) {
+            all = all.filter((instance) => pick.includes(instance.name));
+        }
+        const omit = common_1.config.HEALTH_CHECK_OMIT_INSTANCES;
+        if (omit) {
+            all = all.filter((instance) => !omit.includes(instance.name));
+        }
+        return all;
+    }
+}
+exports.HealthService = HealthService;

package/health/index.d.ts

@@ -0,0 +1,2 @@
+export * from './health-routes';
+export * from './health-service';

package/health/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./health-routes"), exports);
+__exportStar(require("./health-service"), exports);

package/index.d.ts

@@ -0,0 +1,15 @@
+export * from './app';
+export * from './context/dependency-injection';
+export * from './errors';
+export * from './export/export-service';
+export * from './factory';
+export * from './mailer/email-service';
+export * from './database';
+export * from './resource';
+export * from './security';
+export * from './seeder';
+export * from './security/create-auth-resources';
+export * from './server';
+export * from './storage/file-service';
+export * from './types';
+export * from './utils';

package/index.js

@@ -0,0 +1,31 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./app"), exports);
+__exportStar(require("./context/dependency-injection"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./export/export-service"), exports);
+__exportStar(require("./factory"), exports);
+__exportStar(require("./mailer/email-service"), exports);
+__exportStar(require("./database"), exports);
+__exportStar(require("./resource"), exports);
+__exportStar(require("./security"), exports);
+__exportStar(require("./seeder"), exports);
+__exportStar(require("./security/create-auth-resources"), exports);
+__exportStar(require("./server"), exports);
+__exportStar(require("./storage/file-service"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);

package/mailer/email-service.d.ts

@@ -0,0 +1,36 @@
+import { Email } from '@appweaver/common';
+export declare class EmailService {
+    constructor();
+    /**
+     * Sends an email by adding it to the mail queue for processing.
+     *
+     * @param {Email} email - The email object containing the details of the email to be sent.
+     * @return A promise that resolves when the email is successfully added to the queue.
+     */
+    sendEmail(email: Email): Promise<void>;
+    /**
+     * Sends bulk emails by queuing them for asynchronous processing.
+     *
+     * @param {Email[]} email - An array of email objects to be sent in bulk.
+     * @return {Promise<void>} A promise that resolves when the bulk email jobs are successfully queued.
+     */
+    sendEmailBulk(email: Email[]): Promise<void>;
+    /**
+     * Sends bulk emails and waits for all of them to finish.
+     *
+     * @param {Email[]} emails - An array of email objects to be sent.
+     * @return {Promise<{ success: boolean; error?: Error }[]>} A promise that resolves with an array of results, each
+     * containing `success` and an optional `error`.
+     */
+    sendEmailBulkAndWait(emails: Email[]): Promise<{
+        success: boolean;
+        error?: Error;
+    }[]>;
+    /**
+     * Sends an email and waits for the sending process to finish.
+     *
+     * @param {Email} email - The email object containing the details of the email to be sent.
+     * @return A promise that resolves with `true` when the email is sent successfully, or rejects if sending fails.
+     */
+    sendEmailAndWait(email: Email): Promise<boolean>;
+}

package/mailer/email-service.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailService = void 0;
+const common_1 = require("@appweaver/common");
+const context_1 = require("../context");
+class EmailService {
+    /** @internal */
+    _mailer = (0, context_1.inject)(common_1.Mailer);
+    /** @internal */
+    _mailQueue = (0, context_1.inject)(common_1.Queue).get('email');
+    /** @internal */
+    _waitedJobs = new Map();
+    constructor() {
+        this._mailQueue.addWorker(this.processEmail.bind(this));
+        this._mailQueue.onCompleted(this.onEmailSent.bind(this));
+        this._mailQueue.onFailed(this.onEmailError.bind(this));
+    }
+    /**
+     * Sends an email by adding it to the mail queue for processing.
+     *
+     * @param {Email} email - The email object containing the details of the email to be sent.
+     * @return A promise that resolves when the email is successfully added to the queue.
+     */
+    async sendEmail(email) {
+        await this._mailQueue.sendJob(email);
+    }
+    /**
+     * Sends bulk emails by queuing them for asynchronous processing.
+     *
+     * @param {Email[]} email - An array of email objects to be sent in bulk.
+     * @return {Promise<void>} A promise that resolves when the bulk email jobs are successfully queued.
+     */
+    async sendEmailBulk(email) {
+        await this._mailQueue.sendBulkJobs(email.map((e) => ({ data: e })));
+    }
+    /**
+     * Sends bulk emails and waits for all of them to finish.
+     *
+     * @param {Email[]} emails - An array of email objects to be sent.
+     * @return {Promise<{ success: boolean; error?: Error }[]>} A promise that resolves with an array of results, each
+     * containing `success` and an optional `error`.
+     */
+    async sendEmailBulkAndWait(emails) {
+        const results = await Promise.allSettled(emails.map((email) => this.sendEmailAndWait(email)));
+        return results.map((result) => result.status === 'fulfilled'
+            ? { success: true }
+            : { success: false, error: result.reason });
+    }
+    /**
+     * Sends an email and waits for the sending process to finish.
+     *
+     * @param {Email} email - The email object containing the details of the email to be sent.
+     * @return A promise that resolves with `true` when the email is sent successfully, or rejects if sending fails.
+     */
+    async sendEmailAndWait(email) {
+        const job = await this._mailQueue.sendJob(email);
+        return new Promise((resolve, reject) => {
+            if (!job.id) {
+                return reject(new Error('Email Job not found. Email could still be sent.'));
+            }
+            this._waitedJobs.set(job.id, { resolve, reject });
+        }).finally(() => {
+            if (job.id) {
+                this._waitedJobs.delete(job.id);
+            }
+        });
+    }
+    /** @internal */
+    async processEmail(job) {
+        return this._mailer.sendEmail(job.data);
+    }
+    /** @internal */
+    onEmailSent(job) {
+        if (job.id) {
+            const resolver = this._waitedJobs.get(job.id);
+            resolver?.resolve(true);
+        }
+        common_1.logger.debug(`E-mail '${job.data.subject}' sent successfully`);
+    }
+    /** @internal */
+    onEmailError(job, error) {
+        if (job?.id) {
+            const resolver = this._waitedJobs.get(job.id);
+            resolver?.reject(error);
+        }
+        common_1.logger.error(error, `E-mail '${job?.data.subject}' sending failed`);
+    }
+}
+exports.EmailService = EmailService;

package/mailer/index.d.ts

@@ -0,0 +1 @@
+export * from './email-service';

package/mailer/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./email-service"), exports);

package/mailer/json-mailer.d.ts

@@ -0,0 +1,7 @@
+import { Attachment } from 'nodemailer/lib/mailer';
+import { Email, HealthCheckResult, Mailer } from '@appweaver/common';
+export declare class JsonMailer extends Mailer<Attachment> {
+    constructor();
+    sendEmail(data: Email): Promise<boolean>;
+    checkHealth(): Promise<HealthCheckResult>;
+}

package/mailer/json-mailer.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonMailer = void 0;
+const nodemailer_1 = require("nodemailer");
+const common_1 = require("@appweaver/common");
+class JsonMailer extends common_1.Mailer {
+    /** @internal */
+    _transporter;
+    constructor() {
+        super();
+        this._transporter = (0, nodemailer_1.createTransport)({
+            jsonTransport: true
+        });
+    }
+    async sendEmail(data) {
+        const { to, subject, text, html, attachments } = data;
+        const msg = await this._transporter.sendMail({
+            from: `"${common_1.config.MAILER_SENDER_NAME}" <${common_1.config.MAILER_SENDER_ADDRESS}>`,
+            to,
+            subject,
+            text,
+            html: html ?? `<p style="white-space: pre;">${text}</p>`,
+            attachments
+        });
+        common_1.logger.info(JSON.parse(msg.message), `Mock E-mail`);
+        return true;
+    }
+    async checkHealth() {
+        return { success: true };
+    }
+}
+exports.JsonMailer = JsonMailer;

package/mailer/smtp-mailer.d.ts

@@ -0,0 +1,7 @@
+import { Attachment } from 'nodemailer/lib/mailer';
+import { Email, HealthCheckResult, Mailer } from '@appweaver/common';
+export declare class SmtpMailer extends Mailer<Attachment> {
+    constructor();
+    sendEmail(data: Email): Promise<boolean>;
+    checkHealth(): Promise<HealthCheckResult>;
+}

package/mailer/smtp-mailer.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SmtpMailer = void 0;
+const nodemailer_1 = require("nodemailer");
+const common_1 = require("@appweaver/common");
+class SmtpMailer extends common_1.Mailer {
+    /** @internal */
+    _transporter;
+    constructor() {
+        super();
+        this._transporter = (0, nodemailer_1.createTransport)({
+            host: common_1.config.MAILER_SMTP_HOST,
+            port: common_1.config.MAILER_SMTP_PORT,
+            secure: common_1.config.MAILER_SMTP_SECURE,
+            auth: {
+                user: common_1.config.MAILER_SMTP_USER,
+                pass: common_1.config.MAILER_SMTP_PASSWORD
+            }
+        });
+    }
+    async sendEmail(data) {
+        const { to, subject, text, html, attachments } = data;
+        await this._transporter.sendMail({
+            from: `"${common_1.config.MAILER_SENDER_NAME}" <${common_1.config.MAILER_SENDER_ADDRESS}>`,
+            to,
+            subject,
+            text,
+            html: html ?? `<p style="white-space: pre;">${text}</p>`,
+            attachments
+        });
+        return true;
+    }
+    async checkHealth() {
+        try {
+            const success = await this._transporter.verify();
+            return { success };
+        }
+        catch (e) {
+            return { success: false, message: e.message };
+        }
+    }
+}
+exports.SmtpMailer = SmtpMailer;

package/memory/in-memory.d.ts

@@ -0,0 +1,24 @@
+import { HealthCheckResult, Memory } from '@appweaver/common';
+export declare class InMemory extends Memory {
+    onInit(): Promise<void>;
+    onDestroy(): Promise<void>;
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    createClient(): undefined;
+    getValue<T = any>(key: string): Promise<T | null>;
+    putValue(key: string, value: any, expireMs?: number): Promise<boolean>;
+    hasKey(key: string): Promise<boolean>;
+    removeValue(key: string): Promise<boolean>;
+    removeEntries(query: string): Promise<number>;
+    findKeys(pattern?: string): Promise<Set<string>>;
+    valueSizeBytes(key: string): Promise<number | null>;
+    lock(resource: string, lockConfig?: {
+        expireMs?: number;
+        retryCount?: number;
+        retryDelay?: number;
+    }): Promise<{
+        release: () => Promise<boolean>;
+    }>;
+    checkHealth(): Promise<HealthCheckResult>;
+    private cleanupExpired;
+}