apeframework 0.0.0-dev.20 → 0.0.0-dev.21

package/cipher/errors/DecryptError.ts

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

package/cipher/errors/SecretLengthError.ts

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

package/cipher/validateSecretLength.ts

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

package/cli/Args.ts

@@ -1,8 +0,0 @@
-interface Args {
-  positional: string[],
-  optional: Record<string, boolean | string | undefined>,
-}
-
-export {
-  type Args,
-}

package/cli/Command.ts

@@ -1,7 +0,0 @@
-import type { Args } from './Args'
-
-type Command = (args: Args) => Promise<void>
-
-export {
-  type Command,
-}

package/cli/getArgs.ts

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

package/cli/parseArgs.ts

@@ -1,34 +0,0 @@
-import yargsParser from 'yargs-parser'
-import type { Args } from './Args'
-
-const parseArgs = (args: string[]): Args => {
-  const parsed = yargsParser(args, {
-    configuration: {
-      'boolean-negation': false,
-      'camel-case-expansion': true,
-      'dot-notation': false,
-      'duplicate-arguments-array': false,
-      'flatten-duplicate-arrays': false,
-      'greedy-arrays': false,
-      'parse-numbers': false,
-      'parse-positional-numbers': false,
-      'short-option-groups': true,
-      'strip-dashed': true,
-    },
-  })
-
-  const positional = parsed._ as string[]
-
-  const optional = parsed as Record<string, boolean | string | undefined>
-
-  delete optional._
-
-  return {
-    positional,
-    optional,
-  }
-}
-
-export {
-  parseArgs,
-}

package/cli/utils/exit.ts

@@ -1,7 +0,0 @@
-const exit = (code?: number): void => {
-  process.exit(code)
-}
-
-export {
-  exit,
-}

package/cli/utils/formatList.ts

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

package/cli/utils/formatTable.ts

@@ -1,25 +0,0 @@
-import { EOL } from 'os'
-
-const formatTable = (table: string[][]): string => {
-  const colLength: number[] = []
-
-  table.forEach((row) => {
-    ['', ...row].forEach((col, i) => {
-      colLength[i] = col.length > (colLength[i] ?? 0)
-        ? col.length
-        : colLength[i] ?? 0
-    })
-  })
-
-  return table
-    .map((row) => {
-      return ['', ...row]
-        .map((col, i) => { return col.padEnd(colLength[i], ' ') })
-        .join('  ')
-    })
-    .join(EOL)
-}
-
-export {
-  formatTable,
-}

package/cli/utils/formatText.ts

@@ -1,9 +0,0 @@
-import { EOL } from 'os'
-
-const formatText = (text: string[]): string => {
-  return text.join(EOL)
-}
-
-export {
-  formatText,
-}

package/cli/utils/print.ts

@@ -1,7 +0,0 @@
-const print = (s: string): void => {
-  process.stdout.write(s)
-}
-
-export {
-  print,
-}

package/cli/utils/printLn.ts

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

package/config/Config.ts

@@ -1,5 +0,0 @@
-type Config = Record<string, any>
-
-export {
-  type Config,
-}

package/config/Properties.ts

@@ -1,12 +0,0 @@
-import type { Parser } from '../parser/Parser'
-
-type Properties<Type> = {
-  [Property in keyof Type]: {
-    parser: Parser<Type[Property]>,
-    default?: any,
-  }
-}
-
-export {
-  type Properties,
-}

package/config/errors/FileReadError.ts

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

package/config/errors/PropertyNameError.ts

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

package/config/errors/PropertyParseError.ts

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

package/config/getConfig.ts

@@ -1,47 +0,0 @@
-import { getPropertyEnvVar } from './getPropertyEnvVar'
-import { parseProperty } from './parseProperty'
-import { readFile } from './readFile'
-import { validatePropertyName } from './validatePropertyName'
-import type { Config } from './Config'
-import type { Properties } from './Properties'
-import type { Args } from '../cli/Args'
-import type { Env } from '../env/Env'
-
-const getConfig = <Type extends Config>(params: {
-  properties: Properties<Type>,
-  file?: {
-    path: string,
-    required?: boolean,
-  },
-  env?: Env,
-  args?: Args,
-}): Type => {
-  const file = params.file
-    ? readFile(params.file.path, params.file.required)
-    : {}
-
-  const env: Env = params.env ?? {}
-
-  const args: Args = params.args ?? { positional: [], optional: {} }
-
-  const config: 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 as Type
-}
-
-export {
-  getConfig,
-}

package/config/getPropertyEnvVar.ts

@@ -1,15 +0,0 @@
-const capitalLetterRegex = /[A-Z]/gu
-
-const capitalLetterReplacer = (letter: string): string => {
-  return `_${letter}`
-}
-
-const getPropertyEnvVar = (name: string): string => {
-  return name
-    .replace(capitalLetterRegex, capitalLetterReplacer)
-    .toUpperCase()
-}
-
-export {
-  getPropertyEnvVar,
-}

package/config/parseProperty.ts

@@ -1,47 +0,0 @@
-import { PropertyParseError } from './errors/PropertyParseError'
-import type { Parser } from '../parser/Parser'
-
-const parseProperty = <Type>(
-  name: string,
-  parser: Parser<Type>,
-  defaultValue: any,
-  fileValue: any,
-  envValue: any,
-  argsValue: any,
-): Type => {
-  const sources = [
-    {
-      name: 'command line arguments',
-      value: argsValue,
-    },
-    {
-      name: 'environment variables',
-      value: envValue,
-    },
-    {
-      name: 'configuration file',
-      value: fileValue,
-    },
-    {
-      name: 'default value',
-      value: defaultValue,
-    },
-  ]
-
-  const source = sources.find((s) => {
-    return s.value !== undefined
-  }) || {
-    name: 'undefined value',
-    value: undefined,
-  }
-
-  try {
-    return parser(source.value)
-  } catch (error) {
-    throw new PropertyParseError(name, source.name, (error as Error).message)
-  }
-}
-
-export {
-  parseProperty,
-}

package/config/readFile.ts

@@ -1,34 +0,0 @@
-import fs from 'fs-extra'
-import { FileReadError } from './errors/FileReadError'
-
-const readFile = (path: string, required = false): Record<string, any> => {
-  let json: any = {}
-  let fileExists: boolean
-
-  try {
-    fileExists = fs.existsSync(path)
-    if (fileExists) {
-      json = fs.readJsonSync(path)
-    }
-  } catch (error) {
-    throw new FileReadError(path, (error as 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 as Record<string, any>
-}
-
-export {
-  readFile,
-}

package/config/validatePropertyName.ts

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

package/env/Env.ts

@@ -1,5 +0,0 @@
-type Env = Record<string, string>
-
-export {
-  type Env,
-}

package/env/errors/FileReadError.ts

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

package/env/getEnv.ts

@@ -1,24 +0,0 @@
-import { readFile } from './readFile'
-import type { Env } from './Env'
-
-const getEnv = (params?: {
-  file?: {
-    path: string,
-    required?: boolean,
-  },
-}): Env => {
-  let file: Env = {}
-
-  if (params?.file) {
-    file = readFile(params.file.path, params.file.required)
-  }
-
-  return {
-    ...file,
-    ...process.env as Env,
-  }
-}
-
-export {
-  getEnv,
-}

package/env/readFile.ts

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

package/error/BaseError.ts

@@ -1,12 +0,0 @@
-class BaseError extends Error {
-  public constructor(message: string) {
-    super(message)
-    this.name = new.target.name
-    Error.captureStackTrace(this, new.target)
-    Object.setPrototypeOf(this, new.target.prototype)
-  }
-}
-
-export {
-  BaseError,
-}

package/jwt/Algorithm.ts

@@ -1,9 +0,0 @@
-enum Algorithm {
-  HS256 = 'HS256',
-  HS384 = 'HS384',
-  HS512 = 'HS512',
-}
-
-export {
-  Algorithm,
-}

package/jwt/Jwt.ts

@@ -1,49 +0,0 @@
-import { SignJWT, jwtVerify } from 'jose'
-import { validateSecretLength } from './validateSecretLength'
-import type { Algorithm } from './Algorithm'
-import type { Payload } from './Payload'
-
-class Jwt {
-  private readonly algorithm: Algorithm
-
-  private readonly secret: Uint8Array
-
-  public constructor(params: {
-    algorithm: Algorithm,
-    secret: string,
-  }) {
-    validateSecretLength(params.algorithm, params.secret)
-
-    this.algorithm = params.algorithm
-    this.secret = new TextEncoder().encode(params.secret)
-  }
-
-  public async createToken(payload: Payload): Promise<string> {
-    return new SignJWT(payload)
-      .setProtectedHeader({
-        typ: 'JWT',
-        alg: this.algorithm,
-      })
-      .sign(this.secret)
-  }
-
-  public async verifyToken<Type extends Payload>(
-    token: string,
-    timestamp: number,
-  ): Promise<Type | undefined> {
-    try {
-      const { payload } = await jwtVerify(token, this.secret, {
-        typ: 'JWT',
-        currentDate: new Date(timestamp * 1000),
-      })
-
-      return payload as Type
-    } catch (error) {
-      return undefined
-    }
-  }
-}
-
-export {
-  Jwt,
-}

package/jwt/Payload.ts

@@ -1,14 +0,0 @@
-interface Payload {
-  [key: string]: unknown,
-  iss?: string,
-  aud?: string[],
-  sub?: string,
-  jti?: string,
-  iat?: number,
-  exp?: number,
-  nbf?: number,
-}
-
-export {
-  type Payload,
-}

package/jwt/errors/SecretLengthError.ts

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

package/jwt/validateSecretLength.ts

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

package/logger/Level.ts

@@ -1,13 +0,0 @@
-enum Level {
-  TRACE = 'trace',
-  DEBUG = 'debug',
-  INFO = 'info',
-  WARN = 'warn',
-  ERROR = 'error',
-  FATAL = 'fatal',
-  OFF = 'off',
-}
-
-export {
-  Level,
-}

package/logger/Logger.ts

@@ -1,19 +0,0 @@
-abstract class Logger {
-  public abstract trace(message: string, data?: unknown): void
-
-  public abstract debug(message: string, data?: unknown): void
-
-  public abstract info(message: string, data?: unknown): void
-
-  public abstract warn(message: string, data?: unknown): void
-
-  public abstract error(message: string, data?: unknown): void
-
-  public abstract fatal(message: string, data?: unknown): void
-
-  public abstract close(): Promise<void>
-}
-
-export {
-  Logger,
-}

package/logger/Severity.ts

@@ -1,12 +0,0 @@
-enum Severity {
-  TRACE = 10,
-  DEBUG = 20,
-  INFO = 30,
-  WARN = 40,
-  ERROR = 50,
-  FATAL = 60,
-}
-
-export {
-  Severity,
-}