tunli 0.0.27 → 0.2.0

package/src/commands/helper/SharedArg.js

@@ -1,32 +0,0 @@
-import {Ref} from "#src/core/Ref";
-
-/**
- * Class representing a shared argument, extending Ref.
- */
-class SharedArg extends Ref {
-  /**
-   * Create a SharedArg instance.
-   * @param {*} value - The initial value for the shared argument.
-   */
-  constructor(value) {
-    super(value)
-  }
-}
-
-/**
- * Create a new SharedArg instance.
- * @param {*} value - The initial value for the shared argument.
- * @returns {SharedArg} - The created SharedArg instance.
- */
-export const sharedArg = (value) => {
-  return new SharedArg(value)
-}
-
-/**
- * Check if a value is an instance of SharedArg.
- * @param {SharedArg|*} value - The value to check.
- * @returns {boolean} - True if the value is an instance of SharedArg, false otherwise.
- */
-export const isSharedArg = (value) => {
-  return value instanceof SharedArg
-}

package/src/commands/utils.js

@@ -1,96 +0,0 @@
-import {Command} from "commander";
-import {checkIpV4Cidr} from "#src/utils/checkFunctions";
-
-export const validateArrayArguments = (validationCallback) => {
-
-  return (value, previous) => {
-    const ref = {value}
-    validationCallback(ref)
-    previous ??= []
-    previous.push(ref.value)
-    return previous
-  }
-}
-export const validateIpV4 = (ref) => {
-  ref.value = checkIpV4Cidr(ref.value)
-}
-
-const extendedUsages = []
-
-/**
- * @param {Command} program
- * @param {Command} command
- */
-export const extendUsage = (program, command) => {
-
-  extendedUsages.push({program, command})
-
-}
-
-export const addUsage = (program) => {
-
-  const help = program.createHelp()
-
-  for (const {program, command} of extendedUsages) {
-    const usage = help.commandUsage(command)
-    const before = program.usage()
-    program.usage(before + "\n" + ''.padEnd(7, ' ') + usage)
-  }
-}
-
-/**
- * Add examples to the command help text.
- * @param {Command} program - The commander program instance.
- */
-export const addExamples = (program) => {
-
-  const usage = program.usage()
-  program.usage('')
-
-  const maxRowLength = {
-    length: 0
-  }
-
-  const rows = [].slice.call(program.helpInformation().split("\n").map(x => {
-    x = x.trim()
-    const rowLength = x.length
-    if (rowLength > maxRowLength.length) {
-      maxRowLength.length = rowLength
-      maxRowLength.row = x
-    }
-    return x
-  }).filter(Boolean), 2)
-  program.usage(usage)
-
-  const maxWhitespaceLength = {
-    length: 0
-  }
-
-  for (const match of maxRowLength.row.matchAll(/(\s)+/g)) {
-    const whiteSpacesCount = match[0].length
-    if (whiteSpacesCount > maxWhitespaceLength.length) {
-      maxWhitespaceLength.length = whiteSpacesCount
-      maxWhitespaceLength.index = match.index
-    }
-  }
-
-  const padLength = maxWhitespaceLength.index + maxWhitespaceLength.length - 6
-  program.addHelpText('after', "\nExamples:")
-
-  for (const {example, description} of examples) {
-    const whitespaces = ''.padStart(padLength - example.length, ' ')
-    program.addHelpText('after', `  tunli ${example}${whitespaces}${description}`)
-  }
-}
-
-/**
- * Adds an example to the list of examples.
- * @param {string} example - The example command.
- * @param {string} description - The description of the example.
- */
-export const addExample = (example, description) => {
-  examples.push({
-    example, description
-  })
-}
-const examples = []

package/src/config/ConfigAbstract.js

@@ -1,353 +0,0 @@
-import {existsSync, readFileSync, writeFileSync} from "fs"
-import {dirname} from 'path'
-import {ensureDirectoryExists} from "#src/core/FS/utils";
-import {PropertyConfig} from "#src/config/PropertyConfig";
-
-const callerStack = new Map()
-
-/**
- * Mark a value with a caller reference.
- * @param {Object} callee - The caller object.
- * @param {*} value - The value to be marked.
- * @returns {*} - The marked value.
- */
-const caller = (callee, value) => {
-  value = {value}
-  callerStack.set(value, callee)
-  return value
-}
-
-/**
- * Check if a value is marked with a caller reference.
- * @param {*} value - The value to check.
- * @returns {boolean} - True if the value is marked, false otherwise.
- */
-const isCaller = (value) => {
-  return callerStack.has(value)
-}
-
-/**
- * Retrieve the caller reference for a value.
- * @param {*} value - The value with the caller reference.
- * @returns {Object} - The caller object.
- */
-const callee = (value) => {
-  return callerStack.get(value)
-}
-
-export const VISIBILITY_PRIVATE = 0
-export const VISIBILITY_PUBLIC = 1
-
-/**
- * Abstract class representing the basic configuration functionality.
- * @implements {AppConfig}
- */
-export class ConfigAbstract {
-  /**
-   * Configuration data.
-   * @type {Object}
-   * @private
-   */
-  #data = {}
-
-  /**
-   * Profile and system configuration data.
-   * @type {Object}
-   * @private
-   */
-  #profileData = {
-    profile: {}, system: {},
-  }
-
-  /**
-   * Path to the configuration file.
-   * @type {string}
-   * @private
-   */
-  #path
-
-  /**
-   * Fallback configuration instance.
-   * @type {ConfigAbstract}
-   * @private
-   */
-  #fallbackConfig
-
-  /**
-   * Defined properties.
-   * @type {Array<string>}
-   * @private
-   */
-  #definedProperties = []
-
-  /**
-   * Property configuration.
-   * @type {Object<string, PropertyConfig>}
-   * @private
-   */
-  #propertyConfig
-
-  /**
-   * Defined properties with inheritance.
-   * @type {Array<string>}
-   * @private
-   */
-  #definedWithInheritProperties
-
-  /**
-   * Active profile name.
-   * @type {string}
-   * @private
-   */
-  #activeProfile = 'default'
-
-  /**
-   * Create a ConfigAbstract instance.
-   * @param {Object} prefillData - Initial data to prefill the configuration.
-   * @param {string} path - The path to the configuration file.
-   * @param {ConfigAbstract} [fallbackConfig] - The fallback configuration.
-   */
-  constructor(prefillData = {}, path, fallbackConfig) {
-    this.#profileData = prefillData
-    this.#profileData.profile ??= {}
-    this.#profileData.system ??= {}
-    this.#path = path
-    this.#fallbackConfig = fallbackConfig
-  }
-
-  /**
-   * Get the fallback configuration.
-   * @return {ConfigAbstract}
-   */
-  get fallbackConfig() {
-    return this.#fallbackConfig
-  }
-
-  /**
-   * Get the profile data.
-   * @return {profileConfig}
-   */
-  get profileData() {
-    return this.#profileData
-  }
-
-  /**
-   * Get the configuration path.
-   * @return {string}
-   */
-  get configPath() {
-    return this.#path
-  }
-
-  get profile() {
-    return this.#activeProfile
-  }
-
-  /**
-   * @return {string[]}
-   */
-  get profiles() {
-    return Object.keys(this.#profileData.profile)
-  }
-
-  exists() {
-    return existsSync(this.#path)
-  }
-
-  /**
-   * Prepare the configuration by defining properties.
-   * @param {{[p: string]: PropertyConfig}} propertyConfig - The configuration properties.
-   */
-  prepare(propertyConfig = {}) {
-    this.#propertyConfig = propertyConfig
-
-    /**
-     * Define a property.
-     * @param {string} name - The name of the property.
-     * @param {PropertyConfig} propertyConfig - The configuration of the property.
-     */
-    const defineProperty = (name, propertyConfig) => {
-
-      let {writeable, visibility, type, defaultValue} = propertyConfig
-
-      this.#definedProperties.push(name)
-      const attributes = {
-        get: () => {
-          return this.#data[name] ?? this.#fallbackConfig?.[name] ?? defaultValue
-        }
-      }
-
-      if (writeable) {
-        /**
-         * Set the value of the property.
-         * This method checks if the value is marked with a caller reference
-         * and handles the writeable state accordingly. If the property is
-         * not writeable, an error is thrown. The value is also validated
-         * if a validation function is provided. Finally, the validated
-         * value is stored in the configuration data.
-         *
-         * @param {*} value - The value to set.
-         * @throws {Error} If the property is not writeable.
-         */
-        attributes.set = (value) => {
-          if (isCaller(value)) {
-            const writer = callee(value)
-            if (writeable && writeable !== true) {
-              writeable = writer instanceof writeable
-            }
-            value = value.value
-          }
-
-          if (!writeable) {
-            throw new Error(`property ${name} is not writeable`)
-          }
-
-          if (propertyConfig.validate) {
-            value = propertyConfig.validate(value)
-          }
-
-          this.#data[name] = value
-        }
-      }
-
-      Object.defineProperty(this, name, attributes)
-    }
-
-    for (const [name, setting] of Object.entries(propertyConfig)) {
-      defineProperty(name, setting)
-    }
-
-    this.#definedWithInheritProperties = Array.from(new Set([
-      ...this.#definedProperties,
-      ...(this.#fallbackConfig?.#definedWithInheritProperties ?? [])
-    ]))
-
-    for (const name of this.#fallbackConfig?.#definedWithInheritProperties ?? []) {
-      if (this.#definedProperties.includes(name)) {
-        continue
-      }
-
-      Object.defineProperty(this, name, {
-        get: () => {
-          return this.#fallbackConfig[name]
-        },
-        set: (value) => {
-          if (!isCaller(value)) {
-            value = caller(this, value)
-          }
-          this.#fallbackConfig[name] = value
-        }
-      })
-    }
-  }
-
-  /**
-   * Check if a property is public.
-   * @param {string} key - The property key.
-   * @returns {boolean} - True if the property is public, false otherwise.
-   */
-  isPublic(key) {
-    return this.#propertyConfig[key]?.visibility === VISIBILITY_PUBLIC
-  }
-
-  /**
-   * Save the configuration to the file system.
-   * @returns {ConfigAbstract} - The instance of the configuration.
-   */
-  save() {
-    ensureDirectoryExists(dirname(this.#path))
-    console.log(this.#path)
-    const isGlobal = this.constructor.name === 'GlobalConfig'
-    const isSystem = this.constructor.name === 'SystemConfig'
-
-    if (!isGlobal && !isSystem) {
-      delete this.#profileData.system
-    }
-
-    writeFileSync(this.#path, JSON.stringify(this.#profileData, null, 2) + "\n")
-    return this
-  }
-
-  /**
-   * @param {{[p:string]: any}} value
-   * @return {ConfigAbstract}
-   */
-  update(value) {
-    ensureDirectoryExists(dirname(this.#path))
-
-    const isSystem = this.#data === this.#profileData.system
-    const profileData = JSON.parse(readFileSync(this.#path, 'utf-8'))
-    profileData.system ??= {}
-    profileData.profile ??= {}
-    profileData.profile[this.profile] ??= {}
-
-    const updateData = isSystem ? profileData.system : profileData.profile[this.profile]
-
-    for (const [k, v] of Object.entries(value)) {
-      updateData[k] = v
-      this[k] = v
-    }
-
-    writeFileSync(this.#path, JSON.stringify(profileData, null, 2) + "\n")
-    return this
-  }
-
-  /**
-   * Use the system configuration.
-   * @returns {ConfigAbstract} - The instance of the configuration.
-   */
-  useSystem() {
-    this.#data = this.#profileData.system
-    return this
-  }
-
-  /**
-   * Use a specific profile configuration.
-   * @param {string} profile - The profile name.
-   * @returns {ConfigAbstract} - The instance of the configuration.
-   */
-  use(profile) {
-    this.#profileData.profile[profile] ??= {}
-    this.#data = this.#profileData.profile[profile]
-    this.#activeProfile = profile
-    return this
-  }
-
-  /**
-   * Delete a property from the configuration.
-   * @param {string} key - The property key.
-   * @returns {ConfigAbstract} - The instance of the configuration.
-   */
-  del(key) {
-    this.#data[key] = undefined
-    return this
-  }
-
-  /**
-   * Copy the current profile to a new profile.
-   * @param {string} profile - The new profile name.
-   * @returns {ConfigAbstract} - The instance of the configuration.
-   */
-  copyCurrentProfileTo(profile) {
-    this.#profileData.profile[profile] = {...this.#data}
-    return this
-  }
-
-  /**
-   * Dump the configuration properties.
-   * @returns {Object} - The dumped properties.
-   */
-  dump() {
-    return Object.fromEntries(this.#definedProperties.map(x => {
-      let t = this[x]
-      if (Array.isArray(t)) {
-        if (t.length) {
-          t = t.join(', ')
-        } else {
-          t = undefined
-        }
-      }
-      return [x, t]
-    }))
-  }
-}

package/src/config/ConfigManager.js

@@ -1,70 +0,0 @@
-import {resolve} from "path";
-import {CONFIG_DIR_NAME, CONFIG_FILENAME, GLOBAL_CONFIG_DIR} from "#lib/defs";
-import {readJsonFile, searchDirInDirectoryTree} from "#src/core/FS/utils";
-import {existsSync} from "fs";
-
-import {GlobalConfig} from "#src/config/GlobalConfig";
-import {SystemConfig} from "#src/config/SystemConfig";
-import {LocalConfig} from "#src/config/LocalConfig";
-
-const LOCAL_CONFIG_DIR = resolve(process.cwd(), CONFIG_DIR_NAME)
-export const WORKDIR_CONFIG_DIR = resolve(process.cwd(), CONFIG_DIR_NAME)
-
-const searchConfigInDirectoryTree = () => {
-  return searchDirInDirectoryTree(CONFIG_DIR_NAME, undefined, [GLOBAL_CONFIG_DIR])
-}
-
-export class ConfigManager {
-
-  static loadLocalOnly(profile = 'default', searchInDirectoryTree = true) {
-    profile = normalizeProfileAlias(profile)
-
-    let configDirectory
-    if (searchInDirectoryTree) {
-      configDirectory = searchConfigInDirectoryTree() ?? LOCAL_CONFIG_DIR
-    } else {
-      configDirectory = LOCAL_CONFIG_DIR
-    }
-
-    const configFilePath = resolve(configDirectory, CONFIG_FILENAME);
-    const data = existsSync(configFilePath) ? readJsonFile(configFilePath) : {}
-
-    return new LocalConfig(data, configFilePath).use(profile)
-  }
-
-  static loadCombined(profile = 'default') {
-    profile = normalizeProfileAlias(profile)
-
-    const globalConfig = ConfigManager.loadGlobalOnly()
-    const localConfigDirectory = searchConfigInDirectoryTree() ?? LOCAL_CONFIG_DIR
-
-    const localConfigFilePath = resolve(localConfigDirectory, CONFIG_FILENAME);
-    const localExists = existsSync(localConfigFilePath)
-
-    if (localExists) {
-      return new LocalConfig(readJsonFile(localConfigFilePath), localConfigFilePath, globalConfig).use(profile)
-    }
-
-    return globalConfig.use(profile)
-  }
-
-  static loadSystem() {
-    const configFilePath = resolve(GLOBAL_CONFIG_DIR, CONFIG_FILENAME);
-    const data = existsSync(configFilePath) ? readJsonFile(configFilePath) : {}
-    return new SystemConfig(data)
-  }
-
-  static loadGlobalOnly(profile = 'default') {
-    profile = normalizeProfileAlias(profile)
-    const configFilePath = resolve(GLOBAL_CONFIG_DIR, CONFIG_FILENAME);
-    const data = existsSync(configFilePath) ? readJsonFile(configFilePath) : {}
-    return new GlobalConfig(data).use(profile)
-  }
-}
-
-const normalizeProfileAlias = (profileAlias) => {
-  if (typeof profileAlias === 'string' && profileAlias.startsWith('@')) {
-    profileAlias = profileAlias.toString().substring(1)
-  }
-  return profileAlias.toLowerCase()
-}

package/src/config/GlobalConfig.js

@@ -1,14 +0,0 @@
-import {GLOBAL_CONFIG_DIR} from "#lib/defs";
-import {resolve} from "path";
-import {GlobalLocalShardConfigAbstract} from "#src/config/GlobalLocalShardConfigAbstract";
-import {SystemConfig} from "#src/config/SystemConfig";
-
-export class GlobalConfig extends GlobalLocalShardConfigAbstract {
-
-  constructor(data) {
-    const alias = 'default'
-    const configFilePath = resolve(GLOBAL_CONFIG_DIR, `${alias}.json`);
-
-    super({}, data, configFilePath, new SystemConfig(data));
-  }
-}

package/src/config/GlobalLocalShardConfigAbstract.js

@@ -1,98 +0,0 @@
-import {checkHost, checkInArray, checkIpV4Cidr, checkMd5, checkPort, checkUrl} from "#src/utils/checkFunctions";
-import {ConfigAbstract, VISIBILITY_PUBLIC} from "#src/config/ConfigAbstract";
-import {property} from "#src/config/PropertyConfig";
-import {ConfigManager} from "#src/config/ConfigManager";
-
-/**
- * Abstract class for managing global and local shard configurations.
- * Extends the ConfigAbstract class to include properties specific to network configuration.
- */
-export class GlobalLocalShardConfigAbstract extends ConfigAbstract {
-
-  #config = {
-
-    allowCidr: property({
-      visibility: VISIBILITY_PUBLIC,
-      writeable: true,
-      type: Array,
-      defaultValue: [],
-      validate(val) {
-        return val.map(checkIpV4Cidr)
-      }
-    }),
-    proxyURLs: property({
-      defaultValue: {},
-      visibility: VISIBILITY_PUBLIC,
-      writeable: true,
-      type: Array,
-      validate(val) {
-        const final = {}
-        for (const [hash, proxyURL] of Object.entries(val)) {
-          final[checkMd5(hash)] = checkUrl(proxyURL)
-        }
-        return final
-      }
-    }),
-    proxyURL: property({
-      visibility: VISIBILITY_PUBLIC,
-      writeable: true,
-      type: String,
-      validate(val) {
-        if (!val) {
-          return
-        }
-        return checkUrl(val)
-      }
-    }),
-    denyCidr: property({
-      visibility: VISIBILITY_PUBLIC,
-      writeable: true,
-      type: Array,
-      defaultValue: [],
-      validate(val) {
-        return val.map(checkIpV4Cidr)
-      }
-    }),
-    port: property({
-      visibility: VISIBILITY_PUBLIC,
-      writeable: true,
-      type: Number,
-      defaultValue: 80,
-      validate(val) {
-        return checkPort(val)
-      }
-    }),
-    host: property({
-      visibility: VISIBILITY_PUBLIC,
-      writeable: true,
-      type: String,
-      defaultValue: '127.0.0.1',
-      validate(val) {
-        return checkHost(val)
-      }
-    }),
-    protocol: property({
-      visibility: VISIBILITY_PUBLIC,
-      writeable: true,
-      type: String,
-      defaultValue: 'http',
-      validate(val) {
-        return checkInArray(val, ['http', 'https'])
-      }
-    }),
-  }
-
-  /**
-   * Create a GlobalLocalShardConfigAbstract.
-   * @param {Object} additionalConfig - Additional configuration properties to be merged with the default config.
-   * @param {Object} prefillData - Initial data to prefill the configuration.
-   * @param {string} path - The path to the configuration file.
-   * @param {ConfigAbstract} fallbackConfig - The fallback configuration to be used when specific data is not available.
-   */
-  constructor(additionalConfig = {}, prefillData = {}, path, fallbackConfig) {
-    fallbackConfig ??= ConfigManager.loadSystem()
-    super(prefillData, path, fallbackConfig)
-    this.prepare({...this.#config, ...additionalConfig})
-    this.use('default')
-  }
-}

package/src/config/LocalConfig.js

@@ -1,7 +0,0 @@
-import {GlobalLocalShardConfigAbstract} from "#src/config/GlobalLocalShardConfigAbstract";
-
-export class LocalConfig extends GlobalLocalShardConfigAbstract {
-  constructor(data, path, globalConfig) {
-    super({}, data, path, globalConfig);
-  }
-}