@lakutata/core 1.0.59 → 3.0.0-beta.0

package/src/plugins/Security.ts

@@ -1,273 +0,0 @@
-import stringRandom from 'string-random'
-import {
-	AES,
-	enc,
-	HmacMD5,
-	HmacSHA1,
-	HmacSHA224,
-	HmacSHA256,
-	HmacSHA3,
-	HmacSHA384,
-	HmacSHA512,
-	MD5,
-	SHA1,
-	SHA224,
-	SHA256,
-	SHA3,
-	SHA384,
-	SHA512
-} from 'crypto-js'
-import sortKeys from 'sort-keys'
-import {compare, compareSync, genSalt, genSaltSync, hash, hashSync} from 'bcryptjs'
-import {Plugin} from '../base/Plugin'
-import {JSON} from './JSON'
-import {Crypto} from './Crypto'
-import {Configurable, Inject} from '../decorators/DependencyInjection'
-
-declare module '../Core' {
-	interface Application {
-		Security: Security
-	}
-}
-
-export class Security extends Plugin {
-	@Inject('JSON')
-	private readonly JSON: JSON
-
-	@Inject('Crypto')
-	private readonly Crypto: Crypto
-
-	/**
-	 * 盐值
-	 * @type {number}
-	 * @protected
-	 */
-	@Configurable()
-	protected readonly saltRound: number = 8
-
-	/**
-	 * 将数据转换为字符串
-	 * @param data
-	 * @returns {string}
-	 * @protected
-	 */
-	protected stringifyData(data: any): string {
-		return typeof data === 'string' ? data : this.JSON.stringify(sortKeys(this.JSON.parse(this.JSON.stringify(data)), {deep: true}))
-	}
-
-	/**
-	 * 生成随机字符串
-	 * @param {number} length
-	 * @param {{numbers: boolean | string, letters: boolean | string, specials: boolean | string}} options
-	 * @returns {string}
-	 */
-	public generateRandomString(length: number = 16, options: { numbers: boolean | string, letters: boolean | string, specials: boolean | string } = {
-		numbers: true,
-		letters: true,
-		specials: false
-	}): string {
-		return stringRandom(length, {
-			numbers: options.numbers === undefined ? true : options.numbers,
-			letters: options.letters === undefined ? true : options.letters,
-			specials: options.specials === undefined ? false : options.specials
-		})
-	}
-
-	/**
-	 * 计算MD5哈希值
-	 * @param data
-	 * @param {string} key
-	 * @returns {string}
-	 * @constructor
-	 */
-	public MD5(data: any, key?: string): string {
-		const stringData: string = this.stringifyData(data)
-		if (key) {
-			return HmacMD5(stringData, key).toString()
-		} else {
-			return MD5(stringData).toString()
-		}
-	}
-
-	/**
-	 * 计算SHA1哈希值
-	 * @param data
-	 * @param {string} key
-	 * @returns {string}
-	 * @constructor
-	 */
-	public SHA1(data: any, key?: string): string {
-		const stringData: string = this.stringifyData(data)
-		if (key) {
-			return HmacSHA1(stringData, key).toString()
-		} else {
-			return SHA1(stringData).toString()
-		}
-	}
-
-	/**
-	 * 计算SHA3哈希值
-	 * @param data
-	 * @param {string} key
-	 * @returns {string}
-	 * @constructor
-	 */
-	public SHA3(data: any, key?: string): string {
-		const stringData: string = this.stringifyData(data)
-		if (key) {
-			return HmacSHA3(stringData, key).toString()
-		} else {
-			return SHA3(stringData).toString()
-		}
-	}
-
-	/**
-	 * 计算SHA224哈希值
-	 * @param data
-	 * @param {string} key
-	 * @returns {string}
-	 * @constructor
-	 */
-	public SHA224(data: any, key?: string): string {
-		const stringData: string = this.stringifyData(data)
-		if (key) {
-			return HmacSHA224(stringData, key).toString()
-		} else {
-			return SHA224(stringData).toString()
-		}
-	}
-
-	/**
-	 * 计算SHA256哈希值
-	 * @param data
-	 * @param {string} key
-	 * @returns {string}
-	 * @constructor
-	 */
-	public SHA256(data: any, key?: string): string {
-		const stringData: string = this.stringifyData(data)
-		if (key) {
-			return HmacSHA256(stringData, key).toString()
-		} else {
-			return SHA256(stringData).toString()
-		}
-	}
-
-	/**
-	 * 计算SHA384哈希值
-	 * @param data
-	 * @param {string} key
-	 * @returns {string}
-	 * @constructor
-	 */
-	public SHA384(data: any, key?: string): string {
-		const stringData: string = this.stringifyData(data)
-		if (key) {
-			return HmacSHA384(stringData, key).toString()
-		} else {
-			return SHA384(stringData).toString()
-		}
-	}
-
-	/**
-	 * 计算SHA512哈希值
-	 * @param data
-	 * @param {string} key
-	 * @returns {string}
-	 * @constructor
-	 */
-	public SHA512(data: any, key?: string): string {
-		const stringData: string = this.stringifyData(data)
-		if (key) {
-			return HmacSHA512(stringData, key).toString()
-		} else {
-			return SHA512(stringData).toString()
-		}
-	}
-
-	/**
-	 * 使用密码加密数据
-	 * @param data
-	 * @param {string} password
-	 * @returns {string}
-	 */
-	public encryptByPassword<T = any>(data: T, password: string): string {
-		const stringData: string = this.stringifyData(data)
-		return AES.encrypt(stringData, password).toString()
-	}
-
-	/**
-	 * 使用密码解密数据
-	 * @param {string} ciphertext
-	 * @param {string} password
-	 * @returns {T}
-	 */
-	public decryptByPassword<T = any>(ciphertext: string, password: string): T {
-		const decryptString: string = AES.decrypt(ciphertext, password).toString(enc.Utf8)
-		try {
-			return this.JSON.parse(decryptString)
-		} catch (e) {
-			return decryptString as any
-		}
-	}
-
-	/**
-	 * 使用密钥加密数据
-	 * @param {T} data
-	 * @param {string} secretKey
-	 * @returns {string}
-	 */
-	public encryptByKey<T = any>(data: T, secretKey: string): string {
-		return this.Crypto.encrypt(data, secretKey)
-	}
-
-	/**
-	 * 使用密钥解密数据
-	 * @param {string} ciphertext
-	 * @param {string} secretKey
-	 * @returns {T}
-	 */
-	public decryptByKey<T = any>(ciphertext: string, secretKey: string): T {
-		return this.Crypto.decrypt(ciphertext, secretKey)
-	}
-
-	/**
-	 * 生成带盐值的密码哈希
-	 * @param {string} password
-	 * @returns {string}
-	 */
-	public generatePasswordHashSync(password: string): string {
-		const salt: string = genSaltSync(this.saltRound)
-		return hashSync(password, salt)
-	}
-
-	/**
-	 * 异步生成带盐值的密码哈希
-	 * @param {string} password
-	 * @returns {Promise<string>}
-	 */
-	public async generatePasswordHash(password: string): Promise<string> {
-		const salt: string = await genSalt(this.saltRound)
-		return await hash(password, salt)
-	}
-
-	/**
-	 * 验证密码与哈希是否匹配
-	 * @param {string} password
-	 * @param {string} hash
-	 * @returns {boolean}
-	 */
-	public validatePasswordSync(password: string, hash: string): boolean {
-		return compareSync(password, hash)
-	}
-
-	/**
-	 * 异步验证密码与哈希是否匹配
-	 * @param {string} password
-	 * @param {string} hash
-	 * @returns {Promise<boolean>}
-	 */
-	public async validatePassword(password: string, hash: string): Promise<boolean> {
-		return await compare(password, hash)
-	}
-}

package/src/plugins/Shell.ts

@@ -1,371 +0,0 @@
-import {Plugin} from '../base/Plugin'
-import {
-	CatFunction,
-	ChmodFunction,
-	CopyFunction,
-	DirsFunction,
-	EchoFunction,
-	ExecFunction,
-	FindFunction,
-	GrepFunction,
-	HeadFunction,
-	LinkFunction,
-	ListFunction,
-	MkdirFunction,
-	MoveFunction,
-	PopDirFunction,
-	PushDirFunction,
-	RemoveFunction,
-	SedFunction,
-	ShellString,
-	SortFunction,
-	TailFunction,
-	TestOptions,
-	TouchFunction,
-	UniqFunction
-} from '../interfaces/ShellJsInterfaces'
-
-const shelljs = require('../lib/minified/ShellJs')
-
-declare module '../Core' {
-	interface Application {
-		Shell: Shell
-	}
-}
-
-export class Shell extends Plugin {
-	protected shelljs: any = shelljs
-
-	/**
-	 * Changes the current working directory dir for the duration of the script.
-	 * Changes to the home directory if no argument is supplied.
-	 *
-	 * @param dir Directory to change to.
-	 * @return    Object with shell exit code, stderr and stdout.
-	 */
-	public cd(dir?: string): ShellString {
-		return this.shelljs.cd(dir)
-	}
-
-	/**
-	 * Returns the current directory.
-	 * @return The current directory.
-	 */
-	public pwd(): ShellString {
-		return this.shelljs.pwd()
-	}
-
-	/**
-	 * Evaluates expression using the available primaries and returns corresponding value.
-	 *
-	 * @param option Valid options:
-	 *        - `-b`: true if path is a block device;
-	 *        - `-c`: true if path is a character device;
-	 *        - `-d`: true if path is a directory;
-	 *        - `-e`: true if path exists;
-	 *        - `-f`: true if path is a regular file;
-	 *        - `-L`: true if path is a symbolic link;
-	 *        - `-p`: true if path is a pipe (FIFO);
-	 *        - `-S`: true if path is a socket
-	 * @param path    The path.
-	 * @return        See option parameter.
-	 */
-	public test(option: TestOptions, path: string): boolean {
-		return this.shelljs.test(option, path)
-	}
-
-	/**
-	 * Searches for command in the system's PATH. On Windows looks for .exe, .cmd, and .bat extensions.
-	 *
-	 * @param command The command to search for.
-	 * @return        Returns string containing the absolute path to the command.
-	 */
-	public which(command: string): ShellString {
-		return this.shelljs.which(command)
-	}
-
-	/**
-	 * Exits the current process with the given exit code.
-	 *
-	 * Equivalent to calling `process.exit(code)`.
-	 *
-	 * @param code The exit code.
-	 */
-	public exit(code?: number): never {
-		return this.shelljs.exit(code) as never
-	}
-
-	/**
-	 * Searches and returns string containing a writeable, platform-dependent temporary directory.
-	 * Follows Python's tempfile algorithm.
-	 *
-	 * @return The temp file path.
-	 */
-	public tempdir(): ShellString {
-		return this.shelljs.tempdir()
-	}
-
-	/**
-	 * Tests if error occurred in the last command.
-	 *
-	 * @return Returns null if no error occurred, otherwise returns string explaining the error
-	 */
-	public error(): ShellString {
-		return this.shelljs.error()
-	}
-
-	/**
-	 * Sets global configuration variables
-	 * @param options Available options:
-	 *        - `+/-e`: exit upon error (`config.fatal`),
-	 *        - `+/-v`: verbose: show all commands (`config.verbose`),
-	 *        - `+/-f`: disable filename expansion (globbing)
-	 */
-	public set(options: string): void {
-		return this.shelljs.set(options)
-	}
-
-	/**
-	 * Returns array of files in the given path, or in current directory if no path provided.
-	 *
-	 * @param options Available options:
-	 *        - `-R`: recursive
-	 *        - `-A`: all files (include files beginning with ., except for . and ..)
-	 *        - `-L`: follow symlinks
-	 *        - `-d`: list directories themselves, not their contents
-	 *        - `-l`: list objects representing each file, each with fields containing
-	 *                `ls -l` output fields. See fs.Stats for more info
-	 * @param paths   Paths to search.
-	 * @return        An array of files in the given path(s).
-	 */
-	public ls: ListFunction = this.shelljs.ls
-
-	/**
-	 * Returns array of all files (however deep) in the given paths.
-	 *
-	 * @param path The path(s) to search.
-	 * @return     An array of all files (however deep) in the given path(s).
-	 */
-	public find: FindFunction = this.shelljs.find
-
-	/**
-	 * Copies files. The wildcard `*` is accepted.
-	 *
-	 * @param options Available options:
-	 *        - `-f`: force (default behavior)
-	 *        - `-n`: no-clobber
-	 *        - `-u`: only copy if source is newer than dest
-	 *        - `-r`, -R: recursive
-	 *        - `-L`: follow symlinks
-	 *        - `-P`: don't follow symlinks
-	 * @param source The source.
-	 * @param dest   The destination.
-	 * @return       Object with shell exit code, stderr and stdout.
-	 */
-	public cp: CopyFunction = this.shelljs.cp
-
-	/**
-	 * Removes files. The wildcard `*` is accepted.
-	 *
-	 * @param options Available options:
-	 *        - `-f` (force),
-	 *        - `-r`, `-R` (recursive)
-	 * @param files   Files to remove.
-	 * @return        Object with shell exit code, stderr and stdout.
-	 */
-	public rm: RemoveFunction = this.shelljs.rm
-
-	/**
-	 * Moves files. The wildcard `*` is accepted.
-	 *
-	 * @param options Available options:
-	 *        - `-f`: force (default behavior)
-	 *        - `-n`: no-clobber
-	 * @param source The source.
-	 * @param dest   The destination.
-	 * @return       Object with shell exit code, stderr and stdout.
-	 */
-	public mv: MoveFunction = this.shelljs.mv
-
-	/**
-	 * Creates directories.
-	 *
-	 * @param options Available options:
-	 *        - `-p`: full paths, will create intermediate dirs if necessary
-	 * @param dir     The directories to create.
-	 * @return        Object with shell exit code, stderr and stdout.
-	 */
-	public mkdir: MkdirFunction = this.shelljs.mkdir
-
-	/**
-	 * Returns a string containing the given file, or a concatenated string
-	 * containing the files if more than one file is given (a new line character
-	 * is introduced between each file).
-	 *
-	 * @param files Files to use. Wildcard `*` accepted.
-	 * @return A string containing the given file, or a concatenated string
-	 *         containing the files if more than one file is given
-	 *         (a new line character is introduced between each file).
-	 */
-	public cat: CatFunction = this.shelljs.cat
-
-	/**
-	 * Reads an input string from file and performs a JavaScript `replace()`
-	 * on the input using the given search regex and replacement string or function.
-	 *
-	 * @param options Available options:
-	 *        - `-i`: Replace contents of 'file' in-place. Note that no backups will be created!
-	 * @param searchRegex The regular expression to use for search.
-	 * @param replacement The replacement.
-	 * @param files       The files to process.
-	 * @return            The new string after replacement.
-	 */
-	public sed: SedFunction = this.shelljs.sed
-
-	/**
-	 * Reads input string from given files and returns a string containing all lines
-	 * of the file that match the given `regex_filter`. Wildcard `*` accepted.
-	 *
-	 * @param options Available options:
-	 *        - `-v`: Inverse the sense of the regex and print
-	 *                the lines not matching the criteria.
-	 *        - `-l`: Print only filenames of matching files
-	 * @param regex_filter The regular expression to use.
-	 * @param files        The files to process.
-	 * @return Returns a string containing all lines of the file that match the given `regex_filter`.
-	 */
-	public grep: GrepFunction = this.shelljs.grep
-
-	/**
-	 * Prints string to stdout, and returns string with additional utility methods like .to().
-	 *
-	 * @param options Available options:
-	 *        - `-e`: interpret backslash escapes (default)
-	 *        - `-n`: remove trailing newline from output
-	 * @param text The text to print.
-	 * @return     Returns the string that was passed as argument.
-	 */
-	public echo: EchoFunction = this.shelljs.echo
-
-	/**
-	 * Saves the current directory on the top of the directory stack and then cd to dir.
-	 * With no arguments, `pushd` exchanges the top two directories.
-	 *
-	 * @param options Available options:
-	 *        - `-n`: Suppresses the normal change of directory when adding directories
-	 *                to the stack, so that only the stack is manipulated
-	 *        - `-q`: Suppresses output to the console.
-	 * @param dir     Makes the current working directory be the top of the stack,
-	 *                and then executes the equivalent of `cd dir`.
-	 * @return        Returns an array of paths in the stack.
-	 */
-	public pushd: PushDirFunction = this.shelljs.pushd
-
-	/**
-	 * When no arguments are given, popd removes the top directory from the stack
-	 * and performs a `cd` to the new top directory.
-	 *
-	 * The elements are numbered from 0 starting at the first directory listed with dirs;
-	 * i.e., `popd` is equivalent to `popd +0`. Returns an array of paths in the stack.
-	 *
-	 * @param options Available options:
-	 *        - `-n`: Suppresses the normal change of directory when removing directories
-	 *                from the stack, so that only the stack is manipulated
-	 *        - `-q`: Suppresses output to the console.
-	 * @param dir     You can only use -N and +N.
-	 * @return        Returns an array of paths in the stack.
-	 */
-	public popd: PopDirFunction = this.shelljs.popd
-
-	/**
-	 * Displays the list of currently remembered directories.
-	 *
-	 * @param options Available options:
-	 *        - `-c`: Clears the directory stack by deleting all of the elements.
-	 *        - `-N`: Displays the Nth directory (counting from the right of the list
-	 *                printed by dirs when invoked without options), starting with zero.
-	 *        - `+N`: Displays the Nth directory (counting from the left of the list
-	 *                printed by dirs when invoked without options), starting with zero.
-	 * @return        Returns an array of paths in the stack, or a single path if +N or -N was specified.
-	 */
-	public dirs: DirsFunction = this.shelljs.dirs
-
-	/**
-	 * Links source to dest. Use `-f` to force the link, should dest already exist.
-	 *
-	 * @param options Available options:
-	 *        - `-s`: Create a symbolic link, defaults to a hardlink
-	 *        - `-f`: Force creation
-	 * @param source The source.
-	 * @param dest   The destination.
-	 * @return       Object with shell exit code, stderr and stdout.
-	 */
-	public ln: LinkFunction = this.shelljs.ln
-
-	/**
-	 * Executes the given command.
-	 *
-	 * @param command The command to execute.
-	 * @param options Silence and synchronous options.
-	 * @param [callback] Receives code and output asynchronously.
-	 * @return Returns an object containing the return code and output as string,
-	 *         or if `{async: true}` or a `callback` was passed, a `ChildProcess`.
-	 */
-	public exec: ExecFunction = this.shelljs.exec
-
-	/**
-	 * Alters the permissions of a file or directory by either specifying the absolute
-	 * permissions in octal form or expressing the changes in symbols.
-	 *
-	 * This command tries to mimic the POSIX behavior as much as possible.
-	 *
-	 * Notable exceptions:
-	 * - In symbolic modes, 'a-r' and '-r' are identical. No consideration is given to the umask.
-	 * - There is no "quiet" option since default behavior is to run silent.
-	 *
-	 * @param options Available options:
-	 *        - `-v`: output a diagnostic for every file processed
-	 *        - `-c`: like -v but report only when a change is made
-	 *        - `-R`: change files and directories recursively
-	 * @param mode    The access mode. Can be an octal string or a symbolic mode string.
-	 * @param file    The file to use.
-	 * @return        Object with shell exit code, stderr and stdout.
-	 */
-	public chmod: ChmodFunction = this.shelljs.chmod
-
-	/**
-	 * Update the access and modification times of each FILE to the current time.
-	 * A FILE argument that does not exist is created empty, unless `-c` is supplied
-	 */
-	public touch: TouchFunction = this.shelljs.touch
-
-	/**
-	 * Read the start of a file.
-	 */
-	public head: HeadFunction = this.shelljs.head
-
-	/**
-	 * Return the contents of the files, sorted line-by-line.
-	 * Sorting multiple files mixes their content (just as unix sort does).
-	 *
-	 * @param options Available options:
-	 *        - `-r`: Reverse the results
-	 *        - `-n`: Compare according to numerical value
-	 */
-	public sort: SortFunction = this.shelljs.sort
-
-	/**
-	 * Read the end of a file.
-	 */
-	public tail: TailFunction = this.shelljs.tail
-
-	/**
-	 * Filter adjacent matching lines from input.
-	 *
-	 * @param options Available options:
-	 *        - `-i`: Ignore case while comparing
-	 *        - `-c`: Prefix lines by the number of occurrences
-	 *        - `-d`: Only print duplicate lines, one for each group of identical lines
-	 */
-	public uniq: UniqFunction = this.shelljs.uniq
-}