apeframework 0.0.0-dev.20 → 0.0.0-dev.22

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Matthieu Symoens
+Copyright (c) 2024 Matthieu Symoens
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/{cipher → dist/cipher}/Algorithm.js

@@ -1,9 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Algorithm = void 0;
 var Algorithm;
 (function (Algorithm) {
     Algorithm["AES128"] = "aes-128-cbc";
     Algorithm["AES192"] = "aes-192-cbc";
     Algorithm["AES256"] = "aes-256-cbc";
-})(Algorithm || (exports.Algorithm = Algorithm = {}));
+})(Algorithm || (Algorithm = {}));
+export { Algorithm, };

package/dist/cipher/Cipher.js

@@ -0,0 +1,32 @@
+import crypto from 'crypto';
+import { DecryptError } from './errors/DecryptError';
+import { validateSecretLength } from './validateSecretLength';
+class Cipher {
+    algorithm;
+    secret;
+    constructor(params) {
+        validateSecretLength(params.algorithm, params.secret);
+        this.algorithm = params.algorithm;
+        this.secret = Buffer.from(params.secret, 'utf8');
+    }
+    encrypt(string) {
+        const iv = crypto.randomBytes(16);
+        const cipher = crypto.createCipheriv(this.algorithm, this.secret, iv);
+        return iv.toString('hex')
+            + cipher.update(string, 'utf8', 'hex')
+            + cipher.final('hex');
+    }
+    decrypt(string) {
+        const buffer = Buffer.from(string, 'hex');
+        const iv = buffer.subarray(0, 16);
+        const decipher = crypto.createDecipheriv(this.algorithm, this.secret, iv);
+        try {
+            return decipher.update(buffer.subarray(16), undefined, 'utf8')
+                + decipher.final('utf8');
+        }
+        catch (error) {
+            throw new DecryptError(error.message);
+        }
+    }
+}
+export { Cipher, };

package/dist/cipher/errors/DecryptError.js

@@ -0,0 +1,7 @@
+import { BaseError } from '../../error/BaseError';
+class DecryptError extends BaseError {
+    constructor(message) {
+        super(`failed decrypting string: ${message}`);
+    }
+}
+export { DecryptError, };

package/dist/cipher/errors/SecretLengthError.js

@@ -0,0 +1,7 @@
+import { BaseError } from '../../error/BaseError';
+class SecretLengthError extends BaseError {
+    constructor() {
+        super('invalid secret length');
+    }
+}
+export { SecretLengthError, };

package/dist/cipher/validateSecretLength.js

@@ -0,0 +1,13 @@
+import { Algorithm } from './Algorithm';
+import { SecretLengthError } from './errors/SecretLengthError';
+const secretLength = {
+    [Algorithm.AES128]: 16,
+    [Algorithm.AES192]: 24,
+    [Algorithm.AES256]: 32,
+};
+const validateSecretLength = (algorithm, secret) => {
+    if (Buffer.from(secret).length !== secretLength[algorithm]) {
+        throw new SecretLengthError();
+    }
+};
+export { validateSecretLength, };

package/dist/cli/Args.js

@@ -0,0 +1 @@
+export {};

package/dist/cli/Command.js

@@ -0,0 +1 @@
+export {};

package/dist/cli/getArgs.js

@@ -0,0 +1,5 @@
+import { parseArgs } from './parseArgs';
+const getArgs = () => {
+    return parseArgs(process.argv.slice(2));
+};
+export { getArgs, };

package/{cli → dist/cli}/parseArgs.js

@@ -1,12 +1,6 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseArgs = void 0;
-const yargs_parser_1 = __importDefault(require("yargs-parser"));
+import yargsParser from 'yargs-parser';
 const parseArgs = (args) => {
-    const parsed = (0, yargs_parser_1.default)(args, {
+    const parsed = yargsParser(args, {
         configuration: {
             'boolean-negation': false,
             'camel-case-expansion': true,
@@ -28,4 +22,4 @@ const parseArgs = (args) => {
         optional,
     };
 };
-exports.parseArgs = parseArgs;
+export { parseArgs, };

package/dist/cli/utils/exit.js

@@ -0,0 +1,4 @@
+const exit = (code) => {
+    process.exit(code);
+};
+export { exit, };

package/dist/cli/utils/formatList.js

@@ -0,0 +1,7 @@
+import { EOL } from 'os';
+const formatList = (list) => {
+    return list
+        .map((item) => { return `  ${item}`; })
+        .join(EOL);
+};
+export { formatList, };

package/{cli → dist/cli}/utils/formatTable.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatTable = void 0;
-const os_1 = require("os");
+import { EOL } from 'os';
 const formatTable = (table) => {
     const colLength = [];
     table.forEach((row) => {
@@ -17,6 +14,6 @@ const formatTable = (table) => {
             .map((col, i) => { return col.padEnd(colLength[i], ' '); })
             .join('  ');
     })
-        .join(os_1.EOL);
+        .join(EOL);
 };
-exports.formatTable = formatTable;
+export { formatTable, };

package/dist/cli/utils/formatText.js

@@ -0,0 +1,5 @@
+import { EOL } from 'os';
+const formatText = (text) => {
+    return text.join(EOL);
+};
+export { formatText, };

package/dist/cli/utils/print.js

@@ -0,0 +1,4 @@
+const print = (s) => {
+    process.stdout.write(s);
+};
+export { print, };

package/dist/cli/utils/printLn.js

@@ -0,0 +1,5 @@
+import { EOL } from 'os';
+const printLn = (s) => {
+    process.stdout.write(`${s}${EOL}`);
+};
+export { printLn, };

package/dist/config/Config.js

@@ -0,0 +1 @@
+export {};

package/dist/config/Properties.js

@@ -0,0 +1 @@
+export {};

package/dist/config/errors/FileReadError.js

@@ -0,0 +1,7 @@
+import { BaseError } from '../../error/BaseError';
+class FileReadError extends BaseError {
+    constructor(path, message) {
+        super(`failed reading file "${path}": ${message}`);
+    }
+}
+export { FileReadError, };

package/dist/config/errors/PropertyNameError.js

@@ -0,0 +1,7 @@
+import { BaseError } from '../../error/BaseError';
+class PropertyNameError extends BaseError {
+    constructor(name) {
+        super(`invalid property name "${name}"`);
+    }
+}
+export { PropertyNameError, };

package/dist/config/errors/PropertyParseError.js

@@ -0,0 +1,7 @@
+import { BaseError } from '../../error/BaseError';
+class PropertyParseError extends BaseError {
+    constructor(name, source, message) {
+        super(`failed parsing property "${name}" from ${source}: ${message}`);
+    }
+}
+export { PropertyParseError, };

package/dist/config/getConfig.js

@@ -0,0 +1,18 @@
+import { getPropertyEnvVar } from './getPropertyEnvVar';
+import { parseProperty } from './parseProperty';
+import { readFile } from './readFile';
+import { validatePropertyName } from './validatePropertyName';
+const getConfig = (params) => {
+    const file = params.file
+        ? readFile(params.file.path, params.file.required)
+        : {};
+    const env = params.env ?? {};
+    const args = params.args ?? { positional: [], optional: {} };
+    const config = {};
+    for (const name in params.properties) {
+        validatePropertyName(name);
+        config[name] = parseProperty(name, params.properties[name].parser, params.properties[name].default, file[name], env[getPropertyEnvVar(name)], args.optional[name]);
+    }
+    return config;
+};
+export { getConfig, };

package/{config → dist/config}/getPropertyEnvVar.js

@@ -1,6 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPropertyEnvVar = void 0;
 const capitalLetterRegex = /[A-Z]/gu;
 const capitalLetterReplacer = (letter) => {
     return `_${letter}`;
@@ -10,4 +7,4 @@ const getPropertyEnvVar = (name) => {
         .replace(capitalLetterRegex, capitalLetterReplacer)
         .toUpperCase();
 };
-exports.getPropertyEnvVar = getPropertyEnvVar;
+export { getPropertyEnvVar, };

package/{config → dist/config}/parseProperty.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseProperty = void 0;
-const PropertyParseError_1 = require("./errors/PropertyParseError");
+import { PropertyParseError } from './errors/PropertyParseError';
 const parseProperty = (name, parser, defaultValue, fileValue, envValue, argsValue) => {
     const sources = [
         {
@@ -31,7 +28,7 @@ const parseProperty = (name, parser, defaultValue, fileValue, envValue, argsValu
         return parser(source.value);
     }
     catch (error) {
-        throw new PropertyParseError_1.PropertyParseError(name, source.name, error.message);
+        throw new PropertyParseError(name, source.name, error.message);
     }
 };
-exports.parseProperty = parseProperty;
+export { parseProperty, };

package/dist/config/readFile.js

@@ -0,0 +1,25 @@
+import fs from 'fs-extra';
+import { FileReadError } from './errors/FileReadError';
+const readFile = (path, required = false) => {
+    let json = {};
+    let fileExists;
+    try {
+        fileExists = fs.existsSync(path);
+        if (fileExists) {
+            json = fs.readJsonSync(path);
+        }
+    }
+    catch (error) {
+        throw new FileReadError(path, error.message);
+    }
+    if (required && !fileExists) {
+        throw new FileReadError(path, 'missing file');
+    }
+    if (typeof json !== 'object'
+        || Array.isArray(json)
+        || json === null) {
+        throw new FileReadError(path, 'invalid content');
+    }
+    return json;
+};
+export { readFile, };

package/dist/config/validatePropertyName.js

@@ -0,0 +1,8 @@
+import { PropertyNameError } from './errors/PropertyNameError';
+const propertyNameRegex = /^[a-z](?:[0-9A-Za-z])*$/u;
+const validatePropertyName = (name) => {
+    if (!propertyNameRegex.test(name)) {
+        throw new PropertyNameError(name);
+    }
+};
+export { validatePropertyName, };

package/dist/env/Env.js

@@ -0,0 +1 @@
+export {};

package/dist/env/errors/FileReadError.js

@@ -0,0 +1,7 @@
+import { BaseError } from '../../error/BaseError';
+class FileReadError extends BaseError {
+    constructor(path, message) {
+        super(`failed reading file "${path}": ${message}`);
+    }
+}
+export { FileReadError, };

package/dist/env/getEnv.js

@@ -0,0 +1,12 @@
+import { readFile } from './readFile';
+const getEnv = (params) => {
+    let file = {};
+    if (params?.file) {
+        file = readFile(params.file.path, params.file.required);
+    }
+    return {
+        ...file,
+        ...process.env,
+    };
+};
+export { getEnv, };

package/dist/env/readFile.js

@@ -0,0 +1,18 @@
+import dotenv from 'dotenv';
+import fs from 'fs-extra';
+import { FileReadError } from './errors/FileReadError';
+const readFile = (path, required = false) => {
+    try {
+        if (fs.existsSync(path)) {
+            return dotenv.parse(fs.readFileSync(path));
+        }
+    }
+    catch (error) {
+        throw new FileReadError(path, error.message);
+    }
+    if (required) {
+        throw new FileReadError(path, 'missing file');
+    }
+    return {};
+};
+export { readFile, };

package/{error → dist/error}/BaseError.js

@@ -1,6 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseError = void 0;
 class BaseError extends Error {
     constructor(message) {
         super(message);
@@ -9,4 +6,4 @@ class BaseError extends Error {
         Object.setPrototypeOf(this, new.target.prototype);
     }
 }
-exports.BaseError = BaseError;
+export { BaseError, };

package/dist/jwt/Algorithm.js

@@ -0,0 +1,7 @@
+var Algorithm;
+(function (Algorithm) {
+    Algorithm["HS256"] = "HS256";
+    Algorithm["HS384"] = "HS384";
+    Algorithm["HS512"] = "HS512";
+})(Algorithm || (Algorithm = {}));
+export { Algorithm, };

package/{jwt → dist/jwt}/Jwt.js

@@ -1,18 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Jwt = void 0;
-const jose_1 = require("jose");
-const validateSecretLength_1 = require("./validateSecretLength");
+import { SignJWT, jwtVerify } from 'jose';
+import { validateSecretLength } from './validateSecretLength';
 class Jwt {
     algorithm;
     secret;
     constructor(params) {
-        (0, validateSecretLength_1.validateSecretLength)(params.algorithm, params.secret);
+        validateSecretLength(params.algorithm, params.secret);
         this.algorithm = params.algorithm;
         this.secret = new TextEncoder().encode(params.secret);
     }
     async createToken(payload) {
-        return new jose_1.SignJWT(payload)
+        return new SignJWT(payload)
             .setProtectedHeader({
             typ: 'JWT',
             alg: this.algorithm,
@@ -21,7 +18,7 @@ class Jwt {
     }
     async verifyToken(token, timestamp) {
         try {
-            const { payload } = await (0, jose_1.jwtVerify)(token, this.secret, {
+            const { payload } = await jwtVerify(token, this.secret, {
                 typ: 'JWT',
                 currentDate: new Date(timestamp * 1000),
             });
@@ -32,4 +29,4 @@ class Jwt {
         }
     }
 }
-exports.Jwt = Jwt;
+export { Jwt, };

package/dist/jwt/Payload.js

@@ -0,0 +1 @@
+export {};

package/dist/jwt/errors/SecretLengthError.js

@@ -0,0 +1,7 @@
+import { BaseError } from '../../error/BaseError';
+class SecretLengthError extends BaseError {
+    constructor() {
+        super('invalid secret length');
+    }
+}
+export { SecretLengthError, };

package/dist/jwt/validateSecretLength.js

@@ -0,0 +1,13 @@
+import { Algorithm } from './Algorithm';
+import { SecretLengthError } from './errors/SecretLengthError';
+const minSecretLength = {
+    [Algorithm.HS256]: 32,
+    [Algorithm.HS384]: 48,
+    [Algorithm.HS512]: 64,
+};
+const validateSecretLength = (algorithm, secret) => {
+    if (Buffer.from(secret).length < minSecretLength[algorithm]) {
+        throw new SecretLengthError();
+    }
+};
+export { validateSecretLength, };

package/{logger → dist/logger}/Level.js

@@ -1,6 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Level = void 0;
 var Level;
 (function (Level) {
     Level["TRACE"] = "trace";
@@ -10,4 +7,5 @@ var Level;
     Level["ERROR"] = "error";
     Level["FATAL"] = "fatal";
     Level["OFF"] = "off";
-})(Level || (exports.Level = Level = {}));
+})(Level || (Level = {}));
+export { Level, };

package/dist/logger/Logger.js

@@ -0,0 +1,3 @@
+class Logger {
+}
+export { Logger, };

package/{logger → dist/logger}/Severity.js

@@ -1,6 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Severity = void 0;
 var Severity;
 (function (Severity) {
     Severity[Severity["TRACE"] = 10] = "TRACE";
@@ -9,4 +6,5 @@ var Severity;
     Severity[Severity["WARN"] = 40] = "WARN";
     Severity[Severity["ERROR"] = 50] = "ERROR";
     Severity[Severity["FATAL"] = 60] = "FATAL";
-})(Severity || (exports.Severity = Severity = {}));
+})(Severity || (Severity = {}));
+export { Severity, };

package/{logger → dist/logger}/adapters/file/FileLogger.js

@@ -1,23 +1,17 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileLogger = void 0;
-const pino_1 = __importDefault(require("pino"));
-const Level_1 = require("../../Level");
-const Logger_1 = require("../../Logger");
-const initFile_1 = require("./initFile");
-class FileLogger extends Logger_1.Logger {
+import pino from 'pino';
+import { Level } from '../../Level';
+import { Logger } from '../../Logger';
+import { initFile } from './initFile';
+class FileLogger extends Logger {
     logger;
     context;
     constructor(params) {
         super();
-        (0, initFile_1.initFile)(params.path);
-        const stream = pino_1.default.destination(params.path);
-        this.logger = (0, pino_1.default)({
-            enabled: params.level !== Level_1.Level.OFF,
-            level: params.level ?? Level_1.Level.INFO,
+        initFile(params.path);
+        const stream = pino.destination(params.path);
+        this.logger = pino({
+            enabled: params.level !== Level.OFF,
+            level: params.level ?? Level.INFO,
             messageKey: 'message',
             formatters: {
                 level(label, number) {
@@ -67,4 +61,4 @@ class FileLogger extends Logger_1.Logger {
         };
     }
 }
-exports.FileLogger = FileLogger;
+export { FileLogger, };

package/dist/logger/adapters/file/errors/FileInitError.js

@@ -0,0 +1,7 @@
+import { BaseError } from '../../../../error/BaseError';
+class FileInitError extends BaseError {
+    constructor(path, message) {
+        super(`failed initializing file "${path}": ${message}`);
+    }
+}
+export { FileInitError, };

package/dist/logger/adapters/file/initFile.js

@@ -0,0 +1,14 @@
+import fs from 'fs-extra';
+import { FileInitError } from './errors/FileInitError';
+const initFile = (path) => {
+    if (path === '') {
+        throw new FileInitError('', 'empty path');
+    }
+    try {
+        fs.ensureFileSync(path);
+    }
+    catch (error) {
+        throw new FileInitError(path, error.message);
+    }
+};
+export { initFile, };

package/dist/logger/adapters/noop/NoopLogger.js

@@ -0,0 +1,11 @@
+import { Logger } from '../../Logger';
+class NoopLogger extends Logger {
+    trace() { }
+    debug() { }
+    info() { }
+    warn() { }
+    error() { }
+    fatal() { }
+    async close() { }
+}
+export { NoopLogger, };

package/{logger → dist/logger}/adapters/stdio/StdioLogger.js

@@ -1,24 +1,18 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StdioLogger = void 0;
-const pino_1 = __importDefault(require("pino"));
-const pino_pretty_1 = __importDefault(require("pino-pretty"));
-const Level_1 = require("../../Level");
-const Logger_1 = require("../../Logger");
-class StdioLogger extends Logger_1.Logger {
+import pino from 'pino';
+import pretty from 'pino-pretty';
+import { Level } from '../../Level';
+import { Logger } from '../../Logger';
+class StdioLogger extends Logger {
     logger;
     context;
     constructor(params) {
         super();
         const stream = params?.pretty
-            ? (0, pino_pretty_1.default)()
-            : pino_1.default.destination(process.stdout.fd);
-        this.logger = (0, pino_1.default)({
-            enabled: params?.level !== Level_1.Level.OFF,
-            level: params?.level ?? Level_1.Level.INFO,
+            ? pretty()
+            : pino.destination(process.stdout.fd);
+        this.logger = pino({
+            enabled: params?.level !== Level.OFF,
+            level: params?.level ?? Level.INFO,
             messageKey: 'message',
             formatters: {
                 level(label, number) {
@@ -70,4 +64,4 @@ class StdioLogger extends Logger_1.Logger {
         };
     }
 }
-exports.StdioLogger = StdioLogger;
+export { StdioLogger, };

package/dist/mailer/Address.js

@@ -0,0 +1 @@
+export {};

package/dist/mailer/Attachment.js

@@ -0,0 +1 @@
+export {};

package/dist/mailer/Event.js

@@ -0,0 +1 @@
+export {};

package/dist/mailer/List.js

@@ -0,0 +1 @@
+export {};

package/dist/mailer/Location.js

@@ -0,0 +1 @@
+export {};

package/dist/mailer/Mail.js

@@ -0,0 +1 @@
+export {};