apeframework 0.0.0-dev.2 → 0.0.0-dev.4

package/cli/getArgs.ts

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

package/cli/parseArgs.d.ts

@@ -0,0 +1,3 @@
+import type { Args } from './Args';
+declare const parseArgs: (args: string[]) => Args;
+export { parseArgs, };

package/cli/parseArgs.js

@@ -0,0 +1,31 @@
+"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"));
+const parseArgs = (args) => {
+    const parsed = (0, yargs_parser_1.default)(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._;
+    const optional = parsed;
+    delete optional._;
+    return {
+        positional,
+        optional,
+    };
+};
+exports.parseArgs = parseArgs;

package/cli/parseArgs.ts

@@ -0,0 +1,34 @@
+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>
+
+  delete optional._
+
+  return {
+    positional,
+    optional,
+  }
+}
+
+export {
+  parseArgs,
+}

package/cli/utils/exit.d.ts

@@ -0,0 +1,2 @@
+declare const exit: (code?: number) => void;
+export { exit, };

package/cli/utils/exit.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exit = void 0;
+const exit = (code) => {
+    process.exit(code);
+};
+exports.exit = exit;

package/cli/utils/exit.ts

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

package/cli/utils/formatList.d.ts

@@ -0,0 +1,2 @@
+declare const formatList: (list: string[]) => string;
+export { formatList, };

package/cli/utils/formatList.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatList = void 0;
+const os_1 = require("os");
+const formatList = (list) => {
+    return list
+        .map((item) => { return `  ${item}`; })
+        .join(os_1.EOL);
+};
+exports.formatList = formatList;

package/cli/utils/formatList.ts

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

package/cli/utils/formatTable.d.ts

@@ -0,0 +1,2 @@
+declare const formatTable: (table: string[][]) => string;
+export { formatTable, };

package/cli/utils/formatTable.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatTable = void 0;
+const os_1 = require("os");
+const formatTable = (table) => {
+    const colLength = [];
+    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(os_1.EOL);
+};
+exports.formatTable = formatTable;

package/cli/utils/formatTable.ts

@@ -0,0 +1,25 @@
+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.d.ts

@@ -0,0 +1,2 @@
+declare const formatText: (text: string[]) => string;
+export { formatText, };

package/cli/utils/formatText.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatText = void 0;
+const os_1 = require("os");
+const formatText = (text) => {
+    return text.join(os_1.EOL);
+};
+exports.formatText = formatText;

package/cli/utils/formatText.ts

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

package/cli/utils/print.d.ts

@@ -0,0 +1,2 @@
+declare const print: (s: string) => void;
+export { print, };

package/cli/utils/print.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.print = void 0;
+const print = (s) => {
+    process.stdout.write(s);
+};
+exports.print = print;

package/cli/utils/print.ts

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

package/cli/utils/printLn.d.ts

@@ -0,0 +1,2 @@
+declare const printLn: (s: string) => void;
+export { printLn, };

package/cli/utils/printLn.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printLn = void 0;
+const os_1 = require("os");
+const printLn = (s) => {
+    process.stdout.write(`${s}${os_1.EOL}`);
+};
+exports.printLn = printLn;

package/cli/utils/printLn.ts

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

package/config/Config.d.ts

@@ -0,0 +1,2 @@
+type Config = Record<string, boolean | number | string>;
+export { type Config, };

package/config/Config.ts

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

package/config/Properties.d.ts

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

package/config/Properties.ts

@@ -0,0 +1,12 @@
+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.d.ts

@@ -0,0 +1,5 @@
+import { BaseError } from '../../error/BaseError';
+declare class FileReadError extends BaseError {
+    constructor(path: string, message: string);
+}
+export { FileReadError, };

package/config/errors/FileReadError.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileReadError = void 0;
+const BaseError_1 = require("../../error/BaseError");
+class FileReadError extends BaseError_1.BaseError {
+    constructor(path, message) {
+        super(`failed reading file "${path}": ${message}`);
+    }
+}
+exports.FileReadError = FileReadError;

package/config/errors/FileReadError.ts

@@ -0,0 +1,11 @@
+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.d.ts

@@ -0,0 +1,5 @@
+import { BaseError } from '../../error/BaseError';
+declare class PropertyNameError extends BaseError {
+    constructor(name: string);
+}
+export { PropertyNameError, };

package/config/errors/PropertyNameError.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyNameError = void 0;
+const BaseError_1 = require("../../error/BaseError");
+class PropertyNameError extends BaseError_1.BaseError {
+    constructor(name) {
+        super(`invalid property name "${name}"`);
+    }
+}
+exports.PropertyNameError = PropertyNameError;

package/config/errors/PropertyNameError.ts

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

package/config/errors/PropertyParseError.d.ts

@@ -0,0 +1,5 @@
+import { BaseError } from '../../error/BaseError';
+declare class PropertyParseError extends BaseError {
+    constructor(name: string, source: string, message: string);
+}
+export { PropertyParseError, };

package/config/errors/PropertyParseError.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyParseError = void 0;
+const BaseError_1 = require("../../error/BaseError");
+class PropertyParseError extends BaseError_1.BaseError {
+    constructor(name, source, message) {
+        super(`failed parsing property "${name}" from ${source}: ${message}`);
+    }
+}
+exports.PropertyParseError = PropertyParseError;

package/config/errors/PropertyParseError.ts

@@ -0,0 +1,11 @@
+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.d.ts

@@ -0,0 +1,14 @@
+import type { Config } from './Config';
+import type { Properties } from './Properties';
+import type { Args } from '../cli/Args';
+import type { Env } from '../env/Env';
+declare const getConfig: <Type extends Config>(params: {
+    properties: Properties<Type>;
+    file?: {
+        path: string;
+        required?: boolean;
+    };
+    env?: Env;
+    args?: Args;
+}) => Type;
+export { getConfig, };

package/config/getConfig.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfig = void 0;
+const getPropertyEnvVar_1 = require("./getPropertyEnvVar");
+const parseProperty_1 = require("./parseProperty");
+const readFile_1 = require("./readFile");
+const validatePropertyName_1 = require("./validatePropertyName");
+const getConfig = (params) => {
+    const file = params.file
+        ? (0, readFile_1.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) {
+        (0, validatePropertyName_1.validatePropertyName)(name);
+        config[name] = (0, parseProperty_1.parseProperty)(name, params.properties[name].parser, params.properties[name].default, file[name], env[(0, getPropertyEnvVar_1.getPropertyEnvVar)(name)], args.optional[name]);
+    }
+    return config;
+};
+exports.getConfig = getConfig;

package/config/getConfig.ts

@@ -0,0 +1,47 @@
+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.d.ts

@@ -0,0 +1,2 @@
+declare const getPropertyEnvVar: (name: string) => string;
+export { getPropertyEnvVar, };

package/config/getPropertyEnvVar.js

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

package/config/getPropertyEnvVar.ts

@@ -0,0 +1,15 @@
+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.d.ts

@@ -0,0 +1,3 @@
+import type { Parser } from '../parser/Parser';
+declare const parseProperty: <Type>(name: string, parser: Parser<Type>, defaultValue: any, fileValue: any, envValue: any, argsValue: any) => Type;
+export { parseProperty, };

package/config/parseProperty.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseProperty = void 0;
+const PropertyParseError_1 = require("./errors/PropertyParseError");
+const parseProperty = (name, parser, defaultValue, fileValue, envValue, argsValue) => {
+    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_1.PropertyParseError(name, source.name, error.message);
+    }
+};
+exports.parseProperty = parseProperty;

package/config/parseProperty.ts

@@ -0,0 +1,47 @@
+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.d.ts

@@ -0,0 +1,2 @@
+declare const readFile: (path: string, required?: boolean) => Record<string, any>;
+export { readFile, };

package/config/readFile.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readFile = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const FileReadError_1 = require("./errors/FileReadError");
+const readFile = (path, required = false) => {
+    let json = {};
+    let fileExists;
+    try {
+        fileExists = fs_extra_1.default.existsSync(path);
+        if (fileExists) {
+            json = fs_extra_1.default.readJsonSync(path);
+        }
+    }
+    catch (error) {
+        throw new FileReadError_1.FileReadError(path, error.message);
+    }
+    if (required && !fileExists) {
+        throw new FileReadError_1.FileReadError(path, 'missing file');
+    }
+    if (typeof json !== 'object'
+        || Array.isArray(json)
+        || json === null) {
+        throw new FileReadError_1.FileReadError(path, 'invalid content');
+    }
+    return json;
+};
+exports.readFile = readFile;