tunli 0.0.27 → 0.2.0

package/src/utils/arrayFunctions.js

@@ -1,45 +0,0 @@
-/**
- * Removes duplicate elements from an array.
- * @param {any[]} value - The array from which to remove duplicates.
- * @returns {any[]|null} - A new array with unique elements, or null if the input is not an array.
- */
-export const arrayUnique = (value) => {
-  if (!Array.isArray(value)) {
-    return null
-  }
-  return Array.from(new Set(value))
-}
-
-/**
- * @template A
- * @template B
- * Merges two arrays into one.
- * @param {A[]} arr1 - The first array.
- * @param {B[]} arr2 - The second array.
- * @returns {[A, B]} - A new array containing elements from both input arrays.
- */
-export const arrayMerge = (arr1, arr2) => {
-  arr1 ??= []
-  arr2 ??= []
-  return [...arr1, ...arr2]
-}
-
-/**
- * Subtracts elements of the second array from the first array.
- * @param {any[]} arr1 - The array from which to subtract elements.
- * @param {any[]} arr2 - The array containing elements to subtract.
- * @returns {any[]} - A new array containing elements from arr1 that are not in arr2.
- */
-export const arraySub = (arr1, arr2) => {
-  arr1 ??= []
-  arr2 ??= []
-  return arr1.filter(x => !arr2.includes(x))
-}
-
-export const arrayRemoveEntry = (array, search) => {
-  const delPos = array.indexOf(search)
-  if (delPos > -1) {
-    array = [...array.slice(0, delPos), ...array.slice(delPos + 1)]
-  }
-  return array
-}

package/src/utils/checkFunctions.js

@@ -1,182 +0,0 @@
-import {InvalidArgumentError} from "commander"
-import {ipV4} from "#src/net/IPV4";
-import {isSharedArg} from "#commands/helper/SharedArg";
-
-/**
- * Validate and format an IPv4 address with CIDR notation.
- * This function checks if the provided value is a valid IPv4 address with or without CIDR suffix.
- * If valid, it returns the address formatted with its CIDR suffix.
- * If invalid, it throws an InvalidArgumentError with an appropriate message.
- *
- * @param {string} value - The IPv4 address (with or without CIDR) to validate.
- * @returns {string} - The validated and formatted IPv4 address with CIDR suffix.
- * @throws {InvalidArgumentError} - If the IPv4 address is not valid.
- */
-export const checkIpV4Cidr = (value) => {
-  const val = ipV4(value)
-  if (!val.isValid) {
-    throw new InvalidArgumentError('The provided value must be a valid IPv4 address, with or without CIDR notation.')
-  }
-  return `${val}/${val.cidrSuffix}`
-}
-/**
- * Checks if the value is an integer.
- * @param {any} value - The value to check.
- * @param {string} [errorMessage='Value must be an integer'] - The error message to throw if validation fails.
- * @returns {number} - The validated integer.
- * @throws {InvalidArgumentError} - If the value is not a valid integer.
- */
-export const checkInt = (value, errorMessage = 'Value must be an integer') => {
-  value = value.toString()
-
-  if (!/^\d+$/.test(value)) {
-    throw new InvalidArgumentError(errorMessage);
-  }
-
-  return parseInt(value)
-}
-/**
- * Checks if the value is a valid URL.
- * @param {string} value - The value to check.
- * @returns {string} - The validated URL.
- * @throws {InvalidArgumentError} - If the value is not a valid URL.
- */
-export const checkUrl = (value) => {
-  try {
-    return new URL(value).toString()
-  } catch (e) {
-    throw new InvalidArgumentError('Invalid URL')
-  }
-}
-/**
- * Checks if the value is a valid host.
- * @param {Ref|*} valueOrSharedArg - The value or shared argument to check.
- * @param {boolean} [isArgument=false] - Whether the value is an argument.
- * @param {*} [value] - The value to check.
- * @returns {string} - The validated host.
- * @throws {InvalidArgumentError} - If the value is not a valid host.
- */
-export const checkHost = (valueOrSharedArg, isArgument = false, value) => {
-  if (isSharedArg(valueOrSharedArg)) {
-    const {url, host} = valueOrSharedArg.value
-    if (url) {
-      throw new InvalidArgumentError('You must not set a host if the port argument is a URL')
-    } else if (host) {
-      throw new InvalidArgumentError('You must not set a host argument if the host option has been set')
-    }
-  } else {
-    value = valueOrSharedArg
-    valueOrSharedArg = undefined
-  }
-
-  const check = new URL('http://localhost')
-  check.hostname = value
-
-  if (check.hostname !== value.toLowerCase()) {
-    throw new InvalidArgumentError('Invalid host');
-  }
-  if (isSharedArg(valueOrSharedArg) && !isArgument) {
-    valueOrSharedArg.value.host = check.host
-  }
-
-  return check.host
-}
-/**
- * Checks if the value is a valid port.
- * @param {Ref|*} valueOrSharedArg - The value or shared argument to check.
- * @param {boolean} [isArgument=false] - Whether the value is an argument.
- * @param {*} [value] - The value to check.
- * @returns {number|Ref} - The validated port or shared argument with port.
- * @throws {InvalidArgumentError} - If the value is not a valid port.
- */
-export const checkPort = (valueOrSharedArg, isArgument = false, value) => {
-  const handleUrlArg = (value) => {
-    try {
-      const url = new URL(value)
-
-      let port = url.port
-      const protocol = url.protocol.substring(0, url.protocol.length - 1)
-
-      if (!port) {
-        if (protocol === 'http') {
-          port = 80
-        } else if (protocol === 'https') {
-          port = 443
-        }
-        url.port = port.toString()
-      }
-
-      valueOrSharedArg.value.url = {
-        protocol,
-        host: url.hostname,
-        port: parseInt(port)
-      }
-
-      return port
-    } catch (e) {
-      return null
-    }
-  }
-
-  let portFromUrl
-
-  if (isSharedArg(valueOrSharedArg)) {
-    const {url, port, host} = valueOrSharedArg.value
-    portFromUrl = isArgument ? handleUrlArg(value) : null
-
-    if (host && portFromUrl) {
-      throw new InvalidArgumentError('You must not set a URL as port argument if the host option is already set')
-    } else if (port) {
-      if (portFromUrl) {
-        throw new InvalidArgumentError('You must not set a port option if the port argument is a URL')
-      }
-      throw new InvalidArgumentError('You must not set a port option if the port argument is set')
-    } else if (url) {
-      if (port) {
-        throw new InvalidArgumentError('You must not set a port option if the port argument is a URL')
-      }
-      throw new InvalidArgumentError('Unexpected: You must not set a port argument')
-    }
-
-    value = portFromUrl ?? value
-  } else {
-    value = valueOrSharedArg
-    valueOrSharedArg = undefined
-  }
-
-  value = checkInt(value, 'Port must be a valid integer')
-
-  if (value > 65535) {
-    throw new InvalidArgumentError('Port exceeds maximum value of 65535');
-  }
-
-  if (isSharedArg(valueOrSharedArg)) {
-    if (!portFromUrl) {
-      valueOrSharedArg.value.port = value
-    }
-    return valueOrSharedArg
-  }
-
-  return value
-}
-
-export const checkProtocol = (value) => {
-  return checkInArray(value, ['http', 'https'])
-}
-
-export const checkInArray = (val, arr) => {
-  if (!arr.includes(val)) {
-    throw new InvalidArgumentError(`Value must be one of (${arr.join(', ')})`)
-  }
-
-  return val
-}
-
-export const checkMd5 = (hash) => {
-
-  if (!hash?.match(/^[0-9a-f]{32}$/i)) {
-    throw new InvalidArgumentError(`Value is not a valid md5 hash`)
-  }
-
-  return hash.toLowerCase()
-}

package/src/utils/cliFunctions.js

@@ -1,63 +0,0 @@
-import {argv, stdout} from 'node:process';
-import EventEmitter from "node:events";
-import {spawn} from "child_process";
-
-export const setCursorVisibility = (visible) => {
-  if (visible) {
-    stdout.write('\x1B[?25h');
-  } else {
-    stdout.write('\x1B[?25l');
-  }
-}
-
-export const clearTerminal = () => {
-  stdout.write('\x1B[2J\x1B[0f');
-}
-
-
-/**
- * Runs a child process and proxies its output.
- * @param {string} pathToExecutable - Relative or absolute path to the executable script
- * @param {array} [proxyArguments=process.argv.slice(2)] - Arguments to pass to the child process (default: process arguments)
- * @returns {Promise<number|null>} - Exit code of the child process
- */
-export const proxyChildProcess = (pathToExecutable, proxyArguments = argv.slice(2)) => {
-
-  const eventEmitter = new EventEmitter()
-  const createSpawnProcessPromise = () => {
-    const onError = (error) => {
-      eventEmitter.emit('close', 1)
-    }
-
-    const onClose = (code) => {
-      if (code === null) {
-        clearTerminal()
-      }
-      eventEmitter.emit('close', code)
-    }
-
-    const onMessage = (message) => {
-      if (message === 'restart') {
-        child.off('close', onClose)
-        child.kill()
-        setTimeout(() => {
-          eventEmitter.emit('spawn')
-        }, 10)
-      }
-    }
-
-    const child = spawn('node', [pathToExecutable, ...proxyArguments], {
-      stdio: ['inherit', 'inherit', 'inherit', 'ipc'] // Proxy standard output and error to the main process, enable IPC channel
-    })
-      .on('close', onClose)
-      .on('error', onError)
-      .on('message', onMessage)
-  }
-
-  eventEmitter.on('spawn', () => createSpawnProcessPromise(pathToExecutable))
-
-  return new Promise((resolve) => {
-    eventEmitter.once('close', resolve)
-    eventEmitter.emit('spawn')
-  })
-}

package/src/utils/createRequest.js

@@ -1,12 +0,0 @@
-import {Socket} from "socket.io-client";
-import {IncomingRequest} from "#lib/Tunnel/IncomingRequest";
-
-/**
- * @param {IncomingSocketIoRequest} incomingSocketIoRequest
- * @param {RequestId} requestId
- * @param {Socket} socket
- * @returns {IncomingRequest}
- */
-export const createRequestFromSocketIoRequest = (incomingSocketIoRequest, requestId, socket) => {
-  return new IncomingRequest(incomingSocketIoRequest, requestId, socket)
-}

package/src/utils/hashFunctions.js

@@ -1,9 +0,0 @@
-import {createHash} from 'crypto'
-
-/**
- * @param {string|Object<toString>} value
- * @return {string}
- */
-export const md5 = (value) => {
-  return createHash('md5').update(value.toString()).digest('hex')
-}

package/src/utils/httpFunction.js

@@ -1,23 +0,0 @@
-import {IncomingMessage} from "#src/net/http/IncomingMessage"
-import {Socket} from "socket.io-client"
-
-/**
- * Retrieves the remote address from the request headers.
- * @param {http.IncomingMessage|SocketIoRawRequestObject} request - The incoming HTTP or Socket.IO request object.
- * @return {string} - The remote address.
- */
-export const getRemoteAddress = (request) => {
-  return request.headers['x-real-ip']
-    ?? request.headers['x-forwarded-for']
-}
-
-/**
- * Creates an IncomingMessage instance from a raw Socket.IO request object.
- * @param {SocketIoRawRequestObject} req - The raw Socket.IO request object.
- * @param {string} requestId - The unique request identifier.
- * @param {Socket} socket - The socket associated with the request.
- * @return {IncomingMessage} - The created IncomingMessage instance.
- */
-export const createRequestFromRaw = (req, requestId, socket) => {
-  return new IncomingMessage(req, requestId, socket)
-}

package/src/utils/npmFunctions.js

@@ -1,27 +0,0 @@
-import {exec} from 'child_process';
-import {dirname, join} from 'path';
-
-export const checkGlobalInstallation = (packageName) => {
-  return new Promise((resolve, reject) => {
-    exec(`npm list -g --depth=0 ${packageName}`, (error, stdout, stderr) => {
-      if (stdout.includes(packageName)) {
-        resolve(true)
-      } else {
-        resolve(false)
-      }
-    });
-  });
-};
-
-export const checkLocalInstallation = (packageName) => {
-  const localPath = join(process.cwd(), 'node_modules', packageName)
-  return new Promise((resolve, reject) => {
-    exec(`npm list --depth=0 ${packageName}`, {cwd: dirname(process.argv[1])}, (error, stdout, stderr) => {
-      if (stdout.includes(localPath)) {
-        resolve(true)
-      } else {
-        resolve(false)
-      }
-    })
-  })
-}

package/src/utils/stringFunctions.js

@@ -1,59 +0,0 @@
-export const trimEnd = (string, trimChar = ' ') => {
-  const regex = new RegExp(`${trimChar}+$`)
-  return string.replace(regex, '')
-}
-
-export const trimStart = (string, trimChar) => {
-  const regex = new RegExp(`^${trimChar}+`)
-  return string.replace(regex, '')
-}
-
-export const removeControlChars = (string) => {
-  const removeControlCharsRegex = /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g
-  return string.replace(removeControlCharsRegex, '')
-}
-
-export const padEndIgnoreControlChars = (string, maxLength, fillString = ' ', autoSubstring = false) => {
-
-  if (maxLength < 0) {
-    return string
-  }
-
-  const stringWithoutCC = removeControlChars(string)
-
-  if (autoSubstring !== false && stringWithoutCC.length > maxLength) {
-    if (autoSubstring !== true) {
-      return stringWithoutCC.substring(0, maxLength - autoSubstring.length) + autoSubstring
-    } else {
-      return stringWithoutCC.substring(0, maxLength)
-    }
-  }
-
-  const padding = ''.padEnd(maxLength - stringWithoutCC.length, fillString)
-  return `${string}${padding}`
-}
-
-/**
- * Replaces template placeholders in a string with corresponding values from a replacements object.
- *
- * @param {string} template - The string containing placeholders in the format {{ placeholder }}.
- * @param {object} replacements - The object containing replacement values. Nested placeholders can be accessed using dot notation.
- */
-export const replaceTemplatePlaceholders = (template, replacements) => {
-
-  return template.replace(/{{\s*([^{}|]+)\s*(\|[^{}]+)*\s*}}/ig, (match, placeholder) => {
-
-    placeholder = placeholder.trim()
-    const keys = placeholder.split('.')
-
-    let value = replacements
-    for (const part of keys) {
-      if (!value) {
-        break
-      }
-      value = value [part]
-    }
-
-    return value ?? ''
-  })
-}

package/types/index.d.ts

@@ -1,119 +0,0 @@
-import {Socket} from 'socket.io-client';
-
-export interface Headers {
-
-  host: string
-
-  [name: string]: string
-}
-
-export type RequestMethod = "GET" | "POST" | "PATCH" | "DELETE" | "HEAD" | "OPTION" | "PUT"
-
-export type RequestId = string
-
-export type IncomingSocketIoRequest = {
-  method: RequestMethod
-  headers: Headers
-  path: string
-  port: number
-  hostname: string
-}
-
-export type SocketIoRawRequestObject = {
-  method: RequestMethod
-  headers: Headers
-  path: string
-  requestId?: string
-  tunnelSocket?: Socket
-}
-
-export type cliListOption = {
-  maxLength?: number
-  minLength?: number
-  length?: number
-  reverse?: boolean
-  minWidth?: number | Array<number | string | boolean>
-  maxWidth?: number | Array<number | string | boolean>
-}
-
-export type profileDump = {}
-export type proxyURL = string
-export type profileConfig = {
-  system: {}
-  profile: {}
-}
-
-interface ConfigAbstract {
-}
-
-export interface AppConfig {
-
-  protocol: protocol
-  port: number
-  host: string
-  authToken: string
-  proxyURL: proxyURL
-  proxyURLs: proxyURL[]
-  path: undefined
-  origin: string
-  denyCidr?: ipCidr[]
-  allowCidr?: ipCidr[]
-
-  get fallbackConfig(): AppConfig
-
-  get profileData(): profileConfig
-
-  get configPath(): string
-
-  get profile(): profileAlias
-
-  copyCurrentProfileTo(profile: profileAlias): this
-
-  save(): this
-
-  update(value: { [p: string]: any }): this
-
-  useSystem(): AppConfig
-
-  use(profile: profileAlias): AppConfig
-
-  del(configKey: string): AppConfig
-
-  copyCurrentProfileTo(profile: profileAlias): this
-
-  dump(): profileDump
-}
-
-export type protocol = "http" | "https"
-export type ipCidr = string
-export type profileAlias = string
-export type tunnelClientOptions = {
-  protocol: protocol
-  self: boolean
-  port: number
-  host: string
-  authToken: string
-  server: proxyURL
-  path?: string
-  origin?: string
-  save?: profileAlias | true
-  denyCidr?: ipCidr[]
-  allowCidr?: ipCidr[]
-  allowSelf?: ipCidr[]
-}
-
-export type keypressEventDetails = {
-  sequence: string
-  name: string
-  ctrl: boolean
-  meta: boolean
-  shift: boolean
-  full: string
-}
-
-export interface keypressEventListener {
-  (char: string, details: keypressEventDetails): void
-}
-
-
-export type tunliProxyOptions = {}