;
/** certificate validity start datetime */
validityNotBefore: Date;
/** certificate validity end datetime */
validityNotAfter: Date;
}
/**
* Returns information about a certificate
*
* @param cert
* @returns certificate information object
*/
export declare function getCertificateInfo(cert: string): null | CertificateInfo;
export interface DefaultCertificates {
defaultPrivate: string;
defaultPublic: string;
}
/** Maximum time after which cert has to expire - 365 days in ms */
export declare const MAX_CERT_VALIDITY: number;
/**
* Returns default SSL certificates (private and public)
*
*
* The following info will be returned:
* - defaultPrivate: private RSA key
* - defaultPublic: public certificate
*
*
* const certificates = tools.generateDefaultCertificates();
*
*/
export declare function generateDefaultCertificates(): DefaultCertificates;
/**
* Collects information about host and available adapters
*
* Following info will be collected:
* - available adapters
* - node.js --version
* - npm --version
*
* @param objects db
*/
export declare function getHostInfo(objects: any): Promise;
/**
* Finds the controller root directory
*
* @returns absolute path to controller dir without ending slash
*/
export declare function getControllerDir(): string;
/**
* Get the root dir of the ioBroker installation
*/
export declare function getRootDir(): string;
/** Returns whether the current process is executed via dev-server */
export declare function isDevServerInstallation(): boolean;
/**
* All paths are returned always relative to /node_modules/' + appName + '.js-controller
* the result has always "/" as last symbol
*/
export declare function getDefaultDataDir(): string;
/**
* Returns the path of the config file
*/
export declare function getConfigFileName(): string;
/**
* Promisifies a function which returns an error as the first argument in its callback
*
* @param fn The function to promisify
* @param context (optional) The context (value of `this` to bind the function to)
* @param returnArgNames (optional) If the callback contains multiple arguments,
* you can combine them into one object by passing the names as an array.
* Otherwise, the Promise will resolve with an array
*/
export declare function promisify(fn: (...args: any[]) => void, context?: any, returnArgNames?: string[]): (...args: any[]) => Promise;
/**
* Promisifies a function which does not provide an error as the first argument in its callback
*
* @param fn The function to promisify
* @param context (optional) The context (value of `this` to bind the function to)
* @param returnArgNames (optional) If the callback contains multiple arguments,
* you can combine them into one object by passing the names as an array.
* Otherwise, the Promise will resolve with an array
*/
export declare function promisifyNoError(fn: (...args: any[]) => void, context?: any, returnArgNames?: string[]): (...args: any[]) => Promise;
export declare function setQualityForInstance(objects: any, states: any, namespace: string, q: number): Promise;
/**
* Converts ioB pattern into regex.
*
* @param pattern - Regex string to use it in new RegExp(pattern)
*/
export declare function pattern2RegEx(pattern: string): string;
/**
* Checks if a pattern is valid
*
* @param pattern
* @pattern pattern to check for validity
*/
export declare function isValidPattern(pattern: string): boolean;
/**
* Appends the stack trace generated by `captureStackTrace` to the given string
*
* @param str - The string to append the stack trace to
*/
export declare function appendStackTrace(str: string): string;
/**
* encrypts a value by a given key via AES-192-CBC
*
* @param key - Secret key
* @param value - value to decrypt
*/
export declare function encrypt(key: string, value: string): string;
/**
* encrypts a value by a given key via AES-192-CBC
*
* @param key - Secret key
* @param value - value to decrypt
*/
export declare function decrypt(key: string, value: string): string;
/**
* Tests whether the given variable is a real object and not an Array
*
* @param it The variable to test
* @returns true if it is Record
*/
export declare function isObject(it: unknown): it is Record;
/**
* Tests whether the given variable is really an Array
*
* @param it The variable to test
*/
export declare function isArray(it: unknown): it is any[];
/**
* Measure the Node.js event loop lag and repeatedly call the provided callback function with the updated results
*
* @param ms The number of milliseconds for monitoring
* @param cb Callback function to call for each new value
*/
export declare function measureEventLoopLag(ms: number, cb: (eventLoopLag?: number) => void): void;
/**
* This function convert state values by read and write of aliases. Function is synchronous.
* On errors, null is returned instead
*
* @param options
*/
export declare function formatAliasValue(options: FormatAliasValueOptions): ioBroker.State | null;
/**
* remove given id from all enums
*
* @param objects object to access objects db
* @param id the object id which will be deleted from enums
* @param allEnums objects with all enums to use - if not provided all enums will be queried
* @returns Promise All objects are tried to be updated - reject will happen as soon as one fails with the error of the first fail
*/
export declare function removeIdFromAllEnums(objects: any, id: string, allEnums?: Record): Promise;
/**
* Parses dependencies to standardized object of form
*
* @param dependencies dependencies array or single dependency
* @returns parsedDeps parsed dependencies
*/
export declare function parseDependencies(dependencies: string[] | Record[] | string | Record | undefined): Record;
/**
* Validates types of `obj.common` properties and `object.type`, if invalid types are used, an error is thrown.
* If attributes of `obj.common` are not provided, no error is thrown. obj.type has to be there and has to be valid.
*
* @param obj an object which will be validated
* @param extend (optional) if true checks allow more optional cases for extendObject calls
* @throws Error if a property has the wrong type or `obj.type` is non-existing
*/
export declare function validateGeneralObjectProperties(obj: any, extend?: boolean): void;
/**
* get all instances of all adapters in the list
*
* @param adapters list of adapter names to get instances for
* @param objects class redis objects
* @returns array of IDs
*/
export declare function getAllInstances(adapters: string[], objects: any): Promise;
/**
* Get all existing enums
*
* @param objects - objects db
* @returns Promise
*/
export declare function getAllEnums(objects: any): Promise>;
/**
* get async all instances of one adapter
*
* @param adapter name of the adapter
* @param objects objects DB
* @param withObjects return objects instead of only ids
*/
export declare function getInstances(adapter: string, objects: any, withObjects: TWithObjects): Promise;
/**
* Executes a command asynchronously. On success, the promise resolves with stdout and stderr.
* On error, the promise rejects with the exit code or signal, as well as stdout and stderr.
*
* @param command The command to execute
* @param execOptions The options for child_process.exec
* @returns child process promise
*/
export declare function execAsync(command: string, execOptions?: ExecOptions): ChildProcessPromise;
/**
* Takes input from one stream and writes it to another as soon as a complete line was read.
*
* @param input The stream to read from
* @param output The stream to write into
*/
export declare function pipeLinewise(input: NodeJS.ReadableStream, output: NodeJS.WritableStream): void;
/**
* Checks if an adapter is an ESM module or CJS
*
* @param adapter name of the adapter like hm-rpc
*/
export declare function isAdapterEsmModule(adapter: string): Promise;
/**
* Find the adapter main file as full path
*
* @param adapter - adapter name of the adapter, e.g., hm-rpc
* @returns full file name
*/
export declare function resolveAdapterMainFile(adapter: string): Promise;
/**
* Returns the default nodeArgs required to execute the main file, e.g., transpile hooks for TypeScript
*
* @param mainFile
* @returns default node args for cli
*/
export declare function getDefaultNodeArgs(mainFile: string): string[];
/**
* Returns the default paths used to resolve modules using `require.resolve()`
*
* @param callerModule The module that wants to resolve another module
*/
export declare function getDefaultRequireResolvePaths(callerModule: NodeModule): string[];
/**
* Tests if the given URL matches the format /[#]
*
* @param url The URL to parse
*/
export declare function isShortGithubUrl(url: string): boolean;
export interface ParsedGithubUrl {
user: string;
repo: string;
commit?: string;
}
/**
* Tries to parse a URL in the format /[#] into its separate parts
*
* @param url The URL to parse
*/
export declare function parseShortGithubUrl(url: string): ParsedGithubUrl | null;
/**
* Tests if the given pathname matches the format //[.git][//[.zip|.gz]]
*
* @param pathname The pathname part of a GitHub URL
*/
export declare function isGithubPathname(pathname: string): boolean;
/**
* Tries to a GitHub pathname format //[.git][//[.zip|.gz|.tar.gz]] into its separate parts
*
* @param pathname The pathname part of a GitHub URL
*/
export declare function parseGithubPathname(pathname: string): ParsedGithubUrl | null;
/**
* Removes properties which are given by preserve
*
* @param preserve - object which has true entries (or array of selected attributes) for all attributes that should be removed from currObj
* @param oldObj - old object
* @param newObj - new object
*/
export declare function removePreservedProperties(preserve: Record, oldObj: Record, newObj: Record): void;
/**
* Returns the array of system.adapter..* objects which are created for every instance
*
* @param namespace - adapter namespace + id, e.g., hm-rpc.0
*/
export declare function getInstanceIndicatorObjects(namespace: string): ioBroker.StateObject[];
export type InternalLogger = Omit;
export declare function getLogger(log: any): InternalLogger;
/**
* Set capabilities of the given executable on Linux systems
*
* @param execPath - path to the executable for node you can determine it via process.execPath
* @param capabilities - capabilities to set, e.g. ['cap_net_admin', 'cap_net_bind_service']
* @param modeEffective - add effective mode
* @param modePermitted - add permitted mode
* @param modeInherited - add inherited mode
*/
export declare function setExecutableCapabilities(execPath: string, capabilities: string[], modeEffective?: boolean, modePermitted?: boolean, modeInherited?: boolean): Promise;
/**
* Reads the licenses from iobroker.net
* Reads the licenses from iobroker.net and if no login/password provided stores it in `system.licenses`
*
* @param objects Object store instance
* @param login Login for ioBroker.net
* @param password Decoded password for ioBroker.net
* @returns array of all licenses stored on iobroker.net
*/
export declare function updateLicenses(objects: any, login: string, password: string): Promise;
export interface GZipFileOptions {
deleteInput?: boolean;
}
/**
* Compresses an input file using GZip and writes it somewhere else
*
* @param inputFilename The filename of the input file that should be gzipped
* @param outputFilename The filename of the output file where the gzipped content should be written to
* @param options Options for the compression
*/
export declare function compressFileGZip(inputFilename: string, outputFilename: string, options?: GZipFileOptions): Promise;
export interface DataDirValidation {
/** if data directory is valid */
valid: boolean;
/** absolute path it resolves too */
path: string;
/** reason of rejection */
reason: string;
}
/**
* Validate if the dir, is a valid dataDir
* Data dirs in node_modules are not allowed, note that dataDirs are relative to js-controller dir or absolute
*
* @param dataDir dataDir to check
*/
export declare function validateDataDir(dataDir: string): DataDirValidation;
/**
* If an array is passed it will be stringified, else the parameter is returned
*
* @param maybeArr parameter which will be stringified if it is an array
*/
export declare function maybeArrayToString(maybeArr: T): T extends any[] ? string : T;
/**
* Checks if given ip address is matching ipv4 or ipv6 localhost
*
* @param ip ipv4 or ipv6 address
*/
export declare function isLocalAddress(ip: string): boolean;
/**
* Checks if given ip address is matching ipv4 or ipv6 "listen all" address
*
* @param ip ipv4 or ipv6 address
*/
export declare function isListenAllAddress(ip: string): boolean;
/**
* Retrieve the localhost address according to the configured DNS resolution strategy
*/
export declare function getLocalAddress(): '127.0.0.1' | '::1';
/**
* Get the ip to listen to all addresses according to configured DNS resolution strategy
*/
export declare function getListenAllAddress(): '0.0.0.0' | '::';
/**
* Ensure that DNS is resolved according to ioBroker config
*/
export declare function ensureDNSOrder(): void;
/**
* Determine if ioBroker is installed as systemd service
*/
export declare function isIoBrokerInstalledAsSystemd(): Promise;
/**
* Get a new host object
*
* @param oldObj the previous host object
*/
export declare function getHostObject(oldObj?: ioBroker.HostObject | null): ioBroker.HostObject;
/**
* Get file name of the pids file
*
* @returns file name of the pids file
*/
export declare function getPidsFileName(): string;
/**
* Get all ioBroker process ids
*
* @returns process ids or empty array if no process running
*/
export declare function getPids(): Promise;
/**
* Get the controller pid
*
* @returns pid if running else undefined
*/
export declare function getControllerPid(): Promise;
export * from '../../lib/common/maybeCallback.js';
//# sourceMappingURL=tools.d.ts.map