initial commit
This commit is contained in:
Brandon4466
86
node_modules/conf/dist/source/index.d.ts
generated
vendored
Normal file
86
node_modules/conf/dist/source/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,86 @@
|
||||
import { type OnDidChangeCallback, type Options, type Unsubscribe, type OnDidAnyChangeCallback } from './types.js';
|
||||
export default class Conf<T extends Record<string, any> = Record<string, unknown>> implements Iterable<[keyof T, T[keyof T]]> {
|
||||
#private;
|
||||
readonly path: string;
|
||||
readonly events: EventTarget;
|
||||
constructor(partialOptions?: Readonly<Partial<Options<T>>>);
|
||||
/**
|
||||
Get an item.
|
||||
|
||||
@param key - The key of the item to get.
|
||||
@param defaultValue - The default value if the item does not exist.
|
||||
*/
|
||||
get<Key extends keyof T>(key: Key): T[Key];
|
||||
get<Key extends keyof T>(key: Key, defaultValue: Required<T>[Key]): Required<T>[Key];
|
||||
get<Key extends string, Value = unknown>(key: Exclude<Key, keyof T>, defaultValue?: Value): Value;
|
||||
/**
|
||||
Set an item or multiple items at once.
|
||||
|
||||
@param {key|object} - You can use [dot-notation](https://github.com/sindresorhus/dot-prop) in a key to access nested properties. Or a hashmap of items to set at once.
|
||||
@param value - Must be JSON serializable. Trying to set the type `undefined`, `function`, or `symbol` will result in a `TypeError`.
|
||||
*/
|
||||
set<Key extends keyof T>(key: Key, value?: T[Key]): void;
|
||||
set(key: string, value: unknown): void;
|
||||
set(object: Partial<T>): void;
|
||||
/**
|
||||
Check if an item exists.
|
||||
|
||||
@param key - The key of the item to check.
|
||||
*/
|
||||
has<Key extends keyof T>(key: Key | string): boolean;
|
||||
/**
|
||||
Reset items to their default values, as defined by the `defaults` or `schema` option.
|
||||
|
||||
@see `clear()` to reset all items.
|
||||
|
||||
@param keys - The keys of the items to reset.
|
||||
*/
|
||||
reset<Key extends keyof T>(...keys: Key[]): void;
|
||||
/**
|
||||
Delete an item.
|
||||
|
||||
@param key - The key of the item to delete.
|
||||
*/
|
||||
delete<Key extends keyof T>(key: Key): void;
|
||||
delete(key: string): void;
|
||||
/**
|
||||
Delete all items.
|
||||
|
||||
This resets known items to their default values, if defined by the `defaults` or `schema` option.
|
||||
*/
|
||||
clear(): void;
|
||||
/**
|
||||
Watches the given `key`, calling `callback` on any changes.
|
||||
|
||||
@param key - The key to watch.
|
||||
@param callback - A callback function that is called on any changes. When a `key` is first set `oldValue` will be `undefined`, and when a key is deleted `newValue` will be `undefined`.
|
||||
@returns A function, that when called, will unsubscribe.
|
||||
*/
|
||||
onDidChange<Key extends keyof T>(key: Key, callback: OnDidChangeCallback<T[Key]>): Unsubscribe;
|
||||
/**
|
||||
Watches the whole config object, calling `callback` on any changes.
|
||||
|
||||
@param callback - A callback function that is called on any changes. When a `key` is first set `oldValue` will be `undefined`, and when a key is deleted `newValue` will be `undefined`.
|
||||
@returns A function, that when called, will unsubscribe.
|
||||
*/
|
||||
onDidAnyChange(callback: OnDidAnyChangeCallback<T>): Unsubscribe;
|
||||
get size(): number;
|
||||
get store(): T;
|
||||
set store(value: T);
|
||||
[Symbol.iterator](): IterableIterator<[keyof T, T[keyof T]]>;
|
||||
private _encryptData;
|
||||
private _handleChange;
|
||||
private readonly _deserialize;
|
||||
private readonly _serialize;
|
||||
private _validate;
|
||||
private _ensureDirectory;
|
||||
private _write;
|
||||
private _watch;
|
||||
private _migrate;
|
||||
private _containsReservedKey;
|
||||
private _isVersionInRangeFormat;
|
||||
private _shouldPerformMigration;
|
||||
private _get;
|
||||
private _set;
|
||||
}
|
||||
export type { Options, Schema } from './types.js';
|
||||
432
node_modules/conf/dist/source/index.js
generated
vendored
Normal file
432
node_modules/conf/dist/source/index.js
generated
vendored
Normal file
@@ -0,0 +1,432 @@
|
||||
/* eslint-disable @typescript-eslint/naming-convention, @typescript-eslint/no-unsafe-return */
|
||||
import { isDeepStrictEqual } from 'node:util';
|
||||
import process from 'node:process';
|
||||
import fs from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import crypto from 'node:crypto';
|
||||
import assert from 'node:assert';
|
||||
import { getProperty, hasProperty, setProperty, deleteProperty, } from 'dot-prop';
|
||||
import envPaths from 'env-paths';
|
||||
import { writeFileSync as atomicWriteFileSync } from 'atomically';
|
||||
import { Ajv2020 as Ajv } from 'ajv/dist/2020.js';
|
||||
import ajvFormatsModule from 'ajv-formats';
|
||||
import debounceFn from 'debounce-fn';
|
||||
import semver from 'semver';
|
||||
import { concatUint8Arrays, stringToUint8Array, uint8ArrayToString, } from 'uint8array-extras';
|
||||
// FIXME: https://github.com/ajv-validator/ajv/issues/2047
|
||||
const ajvFormats = ajvFormatsModule.default;
|
||||
const encryptionAlgorithm = 'aes-256-cbc';
|
||||
const createPlainObject = () => Object.create(null);
|
||||
const isExist = (data) => data !== undefined && data !== null;
|
||||
const checkValueType = (key, value) => {
|
||||
const nonJsonTypes = new Set([
|
||||
'undefined',
|
||||
'symbol',
|
||||
'function',
|
||||
]);
|
||||
const type = typeof value;
|
||||
if (nonJsonTypes.has(type)) {
|
||||
throw new TypeError(`Setting a value of type \`${type}\` for key \`${key}\` is not allowed as it's not supported by JSON`);
|
||||
}
|
||||
};
|
||||
const INTERNAL_KEY = '__internal__';
|
||||
const MIGRATION_KEY = `${INTERNAL_KEY}.migrations.version`;
|
||||
export default class Conf {
|
||||
path;
|
||||
events;
|
||||
#validator;
|
||||
#encryptionKey;
|
||||
#options;
|
||||
#defaultValues = {};
|
||||
constructor(partialOptions = {}) {
|
||||
const options = {
|
||||
configName: 'config',
|
||||
fileExtension: 'json',
|
||||
projectSuffix: 'nodejs',
|
||||
clearInvalidConfig: false,
|
||||
accessPropertiesByDotNotation: true,
|
||||
configFileMode: 0o666,
|
||||
...partialOptions,
|
||||
};
|
||||
if (!options.cwd) {
|
||||
if (!options.projectName) {
|
||||
throw new Error('Please specify the `projectName` option.');
|
||||
}
|
||||
options.cwd = envPaths(options.projectName, { suffix: options.projectSuffix }).config;
|
||||
}
|
||||
this.#options = options;
|
||||
if (options.schema ?? options.ajvOptions ?? options.rootSchema) {
|
||||
if (options.schema && typeof options.schema !== 'object') {
|
||||
throw new TypeError('The `schema` option must be an object.');
|
||||
}
|
||||
const ajv = new Ajv({
|
||||
allErrors: true,
|
||||
useDefaults: true,
|
||||
...options.ajvOptions,
|
||||
});
|
||||
ajvFormats(ajv);
|
||||
const schema = {
|
||||
...options.rootSchema,
|
||||
type: 'object',
|
||||
properties: options.schema,
|
||||
};
|
||||
this.#validator = ajv.compile(schema);
|
||||
for (const [key, value] of Object.entries(options.schema ?? {})) { // TODO: Remove the `as any`.
|
||||
if (value?.default) {
|
||||
this.#defaultValues[key] = value.default; // eslint-disable-line @typescript-eslint/no-unsafe-assignment
|
||||
}
|
||||
}
|
||||
}
|
||||
if (options.defaults) {
|
||||
this.#defaultValues = {
|
||||
...this.#defaultValues,
|
||||
...options.defaults,
|
||||
};
|
||||
}
|
||||
if (options.serialize) {
|
||||
this._serialize = options.serialize;
|
||||
}
|
||||
if (options.deserialize) {
|
||||
this._deserialize = options.deserialize;
|
||||
}
|
||||
this.events = new EventTarget();
|
||||
this.#encryptionKey = options.encryptionKey;
|
||||
const fileExtension = options.fileExtension ? `.${options.fileExtension}` : '';
|
||||
this.path = path.resolve(options.cwd, `${options.configName ?? 'config'}${fileExtension}`);
|
||||
const fileStore = this.store;
|
||||
const store = Object.assign(createPlainObject(), options.defaults, fileStore);
|
||||
if (options.migrations) {
|
||||
if (!options.projectVersion) {
|
||||
throw new Error('Please specify the `projectVersion` option.');
|
||||
}
|
||||
this._migrate(options.migrations, options.projectVersion, options.beforeEachMigration);
|
||||
}
|
||||
// We defer validation until after migrations are applied so that the store can be updated to the current schema.
|
||||
this._validate(store);
|
||||
try {
|
||||
assert.deepEqual(fileStore, store);
|
||||
}
|
||||
catch {
|
||||
this.store = store;
|
||||
}
|
||||
if (options.watch) {
|
||||
this._watch();
|
||||
}
|
||||
}
|
||||
get(key, defaultValue) {
|
||||
if (this.#options.accessPropertiesByDotNotation) {
|
||||
return this._get(key, defaultValue);
|
||||
}
|
||||
const { store } = this;
|
||||
return key in store ? store[key] : defaultValue;
|
||||
}
|
||||
set(key, value) {
|
||||
if (typeof key !== 'string' && typeof key !== 'object') {
|
||||
throw new TypeError(`Expected \`key\` to be of type \`string\` or \`object\`, got ${typeof key}`);
|
||||
}
|
||||
if (typeof key !== 'object' && value === undefined) {
|
||||
throw new TypeError('Use `delete()` to clear values');
|
||||
}
|
||||
if (this._containsReservedKey(key)) {
|
||||
throw new TypeError(`Please don't use the ${INTERNAL_KEY} key, as it's used to manage this module internal operations.`);
|
||||
}
|
||||
const { store } = this;
|
||||
const set = (key, value) => {
|
||||
checkValueType(key, value);
|
||||
if (this.#options.accessPropertiesByDotNotation) {
|
||||
setProperty(store, key, value);
|
||||
}
|
||||
else {
|
||||
store[key] = value;
|
||||
}
|
||||
};
|
||||
if (typeof key === 'object') {
|
||||
const object = key;
|
||||
for (const [key, value] of Object.entries(object)) {
|
||||
set(key, value);
|
||||
}
|
||||
}
|
||||
else {
|
||||
set(key, value);
|
||||
}
|
||||
this.store = store;
|
||||
}
|
||||
/**
|
||||
Check if an item exists.
|
||||
|
||||
@param key - The key of the item to check.
|
||||
*/
|
||||
has(key) {
|
||||
if (this.#options.accessPropertiesByDotNotation) {
|
||||
return hasProperty(this.store, key);
|
||||
}
|
||||
return key in this.store;
|
||||
}
|
||||
/**
|
||||
Reset items to their default values, as defined by the `defaults` or `schema` option.
|
||||
|
||||
@see `clear()` to reset all items.
|
||||
|
||||
@param keys - The keys of the items to reset.
|
||||
*/
|
||||
reset(...keys) {
|
||||
for (const key of keys) {
|
||||
if (isExist(this.#defaultValues[key])) {
|
||||
this.set(key, this.#defaultValues[key]);
|
||||
}
|
||||
}
|
||||
}
|
||||
delete(key) {
|
||||
const { store } = this;
|
||||
if (this.#options.accessPropertiesByDotNotation) {
|
||||
deleteProperty(store, key);
|
||||
}
|
||||
else {
|
||||
// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
|
||||
delete store[key];
|
||||
}
|
||||
this.store = store;
|
||||
}
|
||||
/**
|
||||
Delete all items.
|
||||
|
||||
This resets known items to their default values, if defined by the `defaults` or `schema` option.
|
||||
*/
|
||||
clear() {
|
||||
this.store = createPlainObject();
|
||||
for (const key of Object.keys(this.#defaultValues)) {
|
||||
this.reset(key);
|
||||
}
|
||||
}
|
||||
/**
|
||||
Watches the given `key`, calling `callback` on any changes.
|
||||
|
||||
@param key - The key to watch.
|
||||
@param callback - A callback function that is called on any changes. When a `key` is first set `oldValue` will be `undefined`, and when a key is deleted `newValue` will be `undefined`.
|
||||
@returns A function, that when called, will unsubscribe.
|
||||
*/
|
||||
onDidChange(key, callback) {
|
||||
if (typeof key !== 'string') {
|
||||
throw new TypeError(`Expected \`key\` to be of type \`string\`, got ${typeof key}`);
|
||||
}
|
||||
if (typeof callback !== 'function') {
|
||||
throw new TypeError(`Expected \`callback\` to be of type \`function\`, got ${typeof callback}`);
|
||||
}
|
||||
return this._handleChange(() => this.get(key), callback);
|
||||
}
|
||||
/**
|
||||
Watches the whole config object, calling `callback` on any changes.
|
||||
|
||||
@param callback - A callback function that is called on any changes. When a `key` is first set `oldValue` will be `undefined`, and when a key is deleted `newValue` will be `undefined`.
|
||||
@returns A function, that when called, will unsubscribe.
|
||||
*/
|
||||
onDidAnyChange(callback) {
|
||||
if (typeof callback !== 'function') {
|
||||
throw new TypeError(`Expected \`callback\` to be of type \`function\`, got ${typeof callback}`);
|
||||
}
|
||||
return this._handleChange(() => this.store, callback);
|
||||
}
|
||||
get size() {
|
||||
return Object.keys(this.store).length;
|
||||
}
|
||||
get store() {
|
||||
try {
|
||||
const data = fs.readFileSync(this.path, this.#encryptionKey ? null : 'utf8');
|
||||
const dataString = this._encryptData(data);
|
||||
const deserializedData = this._deserialize(dataString);
|
||||
this._validate(deserializedData);
|
||||
return Object.assign(createPlainObject(), deserializedData);
|
||||
}
|
||||
catch (error) {
|
||||
if (error?.code === 'ENOENT') {
|
||||
this._ensureDirectory();
|
||||
return createPlainObject();
|
||||
}
|
||||
if (this.#options.clearInvalidConfig && error.name === 'SyntaxError') {
|
||||
return createPlainObject();
|
||||
}
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
set store(value) {
|
||||
this._ensureDirectory();
|
||||
this._validate(value);
|
||||
this._write(value);
|
||||
this.events.dispatchEvent(new Event('change'));
|
||||
}
|
||||
*[Symbol.iterator]() {
|
||||
for (const [key, value] of Object.entries(this.store)) {
|
||||
yield [key, value];
|
||||
}
|
||||
}
|
||||
_encryptData(data) {
|
||||
if (!this.#encryptionKey) {
|
||||
return typeof data === 'string' ? data : uint8ArrayToString(data);
|
||||
}
|
||||
// Check if an initialization vector has been used to encrypt the data.
|
||||
try {
|
||||
const initializationVector = data.slice(0, 16);
|
||||
const password = crypto.pbkdf2Sync(this.#encryptionKey, initializationVector.toString(), 10_000, 32, 'sha512');
|
||||
const decipher = crypto.createDecipheriv(encryptionAlgorithm, password, initializationVector);
|
||||
const slice = data.slice(17);
|
||||
const dataUpdate = typeof slice === 'string' ? stringToUint8Array(slice) : slice;
|
||||
return uint8ArrayToString(concatUint8Arrays([decipher.update(dataUpdate), decipher.final()]));
|
||||
}
|
||||
catch { }
|
||||
return data.toString();
|
||||
}
|
||||
_handleChange(getter, callback) {
|
||||
let currentValue = getter();
|
||||
const onChange = () => {
|
||||
const oldValue = currentValue;
|
||||
const newValue = getter();
|
||||
if (isDeepStrictEqual(newValue, oldValue)) {
|
||||
return;
|
||||
}
|
||||
currentValue = newValue;
|
||||
callback.call(this, newValue, oldValue);
|
||||
};
|
||||
this.events.addEventListener('change', onChange);
|
||||
return () => {
|
||||
this.events.removeEventListener('change', onChange);
|
||||
};
|
||||
}
|
||||
_deserialize = value => JSON.parse(value);
|
||||
_serialize = value => JSON.stringify(value, undefined, '\t');
|
||||
_validate(data) {
|
||||
if (!this.#validator) {
|
||||
return;
|
||||
}
|
||||
const valid = this.#validator(data);
|
||||
if (valid || !this.#validator.errors) {
|
||||
return;
|
||||
}
|
||||
const errors = this.#validator.errors
|
||||
.map(({ instancePath, message = '' }) => `\`${instancePath.slice(1)}\` ${message}`);
|
||||
throw new Error('Config schema violation: ' + errors.join('; '));
|
||||
}
|
||||
_ensureDirectory() {
|
||||
// Ensure the directory exists as it could have been deleted in the meantime.
|
||||
fs.mkdirSync(path.dirname(this.path), { recursive: true });
|
||||
}
|
||||
_write(value) {
|
||||
let data = this._serialize(value);
|
||||
if (this.#encryptionKey) {
|
||||
const initializationVector = crypto.randomBytes(16);
|
||||
const password = crypto.pbkdf2Sync(this.#encryptionKey, initializationVector.toString(), 10_000, 32, 'sha512');
|
||||
const cipher = crypto.createCipheriv(encryptionAlgorithm, password, initializationVector);
|
||||
data = concatUint8Arrays([initializationVector, stringToUint8Array(':'), cipher.update(stringToUint8Array(data)), cipher.final()]);
|
||||
}
|
||||
// Temporary workaround for Conf being packaged in a Ubuntu Snap app.
|
||||
// See https://github.com/sindresorhus/conf/pull/82
|
||||
if (process.env.SNAP) {
|
||||
fs.writeFileSync(this.path, data, { mode: this.#options.configFileMode });
|
||||
}
|
||||
else {
|
||||
try {
|
||||
atomicWriteFileSync(this.path, data, { mode: this.#options.configFileMode });
|
||||
}
|
||||
catch (error) {
|
||||
// Fix for https://github.com/sindresorhus/electron-store/issues/106
|
||||
// Sometimes on Windows, we will get an EXDEV error when atomic writing
|
||||
// (even though to the same directory), so we fall back to non atomic write
|
||||
if (error?.code === 'EXDEV') {
|
||||
fs.writeFileSync(this.path, data, { mode: this.#options.configFileMode });
|
||||
return;
|
||||
}
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
_watch() {
|
||||
this._ensureDirectory();
|
||||
if (!fs.existsSync(this.path)) {
|
||||
this._write(createPlainObject());
|
||||
}
|
||||
if (process.platform === 'win32') {
|
||||
fs.watch(this.path, { persistent: false }, debounceFn(() => {
|
||||
// On Linux and Windows, writing to the config file emits a `rename` event, so we skip checking the event type.
|
||||
this.events.dispatchEvent(new Event('change'));
|
||||
}, { wait: 100 }));
|
||||
}
|
||||
else {
|
||||
fs.watchFile(this.path, { persistent: false }, debounceFn(() => {
|
||||
this.events.dispatchEvent(new Event('change'));
|
||||
}, { wait: 5000 }));
|
||||
}
|
||||
}
|
||||
_migrate(migrations, versionToMigrate, beforeEachMigration) {
|
||||
let previousMigratedVersion = this._get(MIGRATION_KEY, '0.0.0');
|
||||
const newerVersions = Object.keys(migrations)
|
||||
.filter(candidateVersion => this._shouldPerformMigration(candidateVersion, previousMigratedVersion, versionToMigrate));
|
||||
let storeBackup = { ...this.store };
|
||||
for (const version of newerVersions) {
|
||||
try {
|
||||
if (beforeEachMigration) {
|
||||
beforeEachMigration(this, {
|
||||
fromVersion: previousMigratedVersion,
|
||||
toVersion: version,
|
||||
finalVersion: versionToMigrate,
|
||||
versions: newerVersions,
|
||||
});
|
||||
}
|
||||
const migration = migrations[version];
|
||||
migration?.(this);
|
||||
this._set(MIGRATION_KEY, version);
|
||||
previousMigratedVersion = version;
|
||||
storeBackup = { ...this.store };
|
||||
}
|
||||
catch (error) {
|
||||
this.store = storeBackup;
|
||||
throw new Error(`Something went wrong during the migration! Changes applied to the store until this failed migration will be restored. ${error}`);
|
||||
}
|
||||
}
|
||||
if (this._isVersionInRangeFormat(previousMigratedVersion) || !semver.eq(previousMigratedVersion, versionToMigrate)) {
|
||||
this._set(MIGRATION_KEY, versionToMigrate);
|
||||
}
|
||||
}
|
||||
_containsReservedKey(key) {
|
||||
if (typeof key === 'object') {
|
||||
const firsKey = Object.keys(key)[0];
|
||||
if (firsKey === INTERNAL_KEY) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
if (typeof key !== 'string') {
|
||||
return false;
|
||||
}
|
||||
if (this.#options.accessPropertiesByDotNotation) {
|
||||
if (key.startsWith(`${INTERNAL_KEY}.`)) {
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
_isVersionInRangeFormat(version) {
|
||||
return semver.clean(version) === null;
|
||||
}
|
||||
_shouldPerformMigration(candidateVersion, previousMigratedVersion, versionToMigrate) {
|
||||
if (this._isVersionInRangeFormat(candidateVersion)) {
|
||||
if (previousMigratedVersion !== '0.0.0' && semver.satisfies(previousMigratedVersion, candidateVersion)) {
|
||||
return false;
|
||||
}
|
||||
return semver.satisfies(versionToMigrate, candidateVersion);
|
||||
}
|
||||
if (semver.lte(candidateVersion, previousMigratedVersion)) {
|
||||
return false;
|
||||
}
|
||||
if (semver.gt(candidateVersion, versionToMigrate)) {
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
_get(key, defaultValue) {
|
||||
return getProperty(this.store, key, defaultValue);
|
||||
}
|
||||
_set(key, value) {
|
||||
const { store } = this;
|
||||
setProperty(store, key, value);
|
||||
this.store = store;
|
||||
}
|
||||
}
|
||||
280
node_modules/conf/dist/source/types.d.ts
generated
vendored
Normal file
280
node_modules/conf/dist/source/types.d.ts
generated
vendored
Normal file
@@ -0,0 +1,280 @@
|
||||
import { type JSONSchema as TypedJSONSchema } from 'json-schema-typed';
|
||||
import type { CurrentOptions as AjvOptions } from 'ajv/dist/core.js';
|
||||
import type Conf from './index.js';
|
||||
export type Options<T extends Record<string, any>> = {
|
||||
/**
|
||||
Config used if there are no existing config.
|
||||
|
||||
**Note:** The values in `defaults` will overwrite the `default` key in the `schema` option.
|
||||
*/
|
||||
defaults?: Readonly<T>;
|
||||
/**
|
||||
[JSON Schema](https://json-schema.org) to validate your config data.
|
||||
|
||||
This will be the [`properties`](https://json-schema.org/understanding-json-schema/reference/object.html#properties) object of the JSON schema. That is, define `schema` as an object where each key is the name of your data's property and each value is a JSON schema used to validate that property.
|
||||
|
||||
@example
|
||||
```
|
||||
import Conf from 'conf';
|
||||
|
||||
const schema = {
|
||||
foo: {
|
||||
type: 'number',
|
||||
maximum: 100,
|
||||
minimum: 1,
|
||||
default: 50
|
||||
},
|
||||
bar: {
|
||||
type: 'string',
|
||||
format: 'url'
|
||||
}
|
||||
};
|
||||
|
||||
const config = new Conf({
|
||||
projectName: 'foo',
|
||||
schema
|
||||
});
|
||||
|
||||
console.log(config.get('foo'));
|
||||
//=> 50
|
||||
|
||||
config.set('foo', '1');
|
||||
// [Error: Config schema violation: `foo` should be number]
|
||||
```
|
||||
|
||||
**Note:** The `default` value will be overwritten by the `defaults` option if set.
|
||||
*/
|
||||
schema?: Schema<T>;
|
||||
/**
|
||||
Top-level properties for the schema, excluding `properties` field.
|
||||
|
||||
@example
|
||||
```
|
||||
import Conf from 'conf';
|
||||
|
||||
const store = new Conf({
|
||||
projectName: 'foo',
|
||||
schema: {},
|
||||
rootSchema: {
|
||||
additionalProperties: false
|
||||
}
|
||||
});
|
||||
```
|
||||
*/
|
||||
rootSchema?: Omit<TypedJSONSchema, 'properties'>;
|
||||
/**
|
||||
[Options passed to AJV](https://ajv.js.org/options.html).
|
||||
|
||||
Under the hood, the JSON Schema validator [ajv](https://ajv.js.org/json-schema.html) is used to validate your config. We use [JSON Schema draft-2020-12](https://json-schema.org/draft/2020-12/release-notes) and support all validation keywords and formats.
|
||||
|
||||
**Note:** By default, `allErrors` and `useDefaults` are both set to `true`, but can be overridden.
|
||||
|
||||
@example
|
||||
```
|
||||
import Conf from 'conf';
|
||||
|
||||
const store = new Conf({
|
||||
projectName: 'foo',
|
||||
schema: {},
|
||||
rootSchema: {
|
||||
additionalProperties: false
|
||||
},
|
||||
ajvOptions: {
|
||||
removeAdditional: true
|
||||
}
|
||||
});
|
||||
```
|
||||
*/
|
||||
ajvOptions?: AjvOptions;
|
||||
/**
|
||||
Name of the config file (without extension).
|
||||
|
||||
Useful if you need multiple config files for your app or module. For example, different config files between two major versions.
|
||||
|
||||
@default 'config'
|
||||
*/
|
||||
configName?: string;
|
||||
/**
|
||||
__Required unless you specify the `cwd` option.__
|
||||
|
||||
You can fetch the `name` field from package.json.
|
||||
*/
|
||||
projectName?: string;
|
||||
/**
|
||||
__Required if you specify the `migration` option.__
|
||||
|
||||
You can fetch the `version` field from package.json.
|
||||
*/
|
||||
projectVersion?: string;
|
||||
/**
|
||||
You can use migrations to perform operations to the store whenever a version is changed.
|
||||
|
||||
The `migrations` object should consist of a key-value pair of `'version': handler`. The `version` can also be a [semver range](https://github.com/npm/node-semver#ranges).
|
||||
|
||||
Note: The version the migrations use refers to the __project version__ by default. If you want to change this behavior, specify the `projectVersion` option.
|
||||
|
||||
@example
|
||||
```
|
||||
import Conf from 'conf';
|
||||
|
||||
const store = new Conf({
|
||||
projectName: 'foo',
|
||||
projectVersion: …,
|
||||
migrations: {
|
||||
'0.0.1': store => {
|
||||
store.set('debugPhase', true);
|
||||
},
|
||||
'1.0.0': store => {
|
||||
store.delete('debugPhase');
|
||||
store.set('phase', '1.0.0');
|
||||
},
|
||||
'1.0.2': store => {
|
||||
store.set('phase', '1.0.2');
|
||||
},
|
||||
'>=2.0.0': store => {
|
||||
store.set('phase', '>=2.0.0');
|
||||
}
|
||||
}
|
||||
});
|
||||
```
|
||||
*/
|
||||
migrations?: Migrations<T>;
|
||||
/**
|
||||
The given callback function will be called before each migration step.
|
||||
|
||||
This can be useful for logging purposes, preparing migration data, etc.
|
||||
*/
|
||||
beforeEachMigration?: BeforeEachMigrationCallback<T>;
|
||||
/**
|
||||
__You most likely don't need this. Please don't use it unless you really have to.__
|
||||
|
||||
The only use-case I can think of is having the config located in the app directory or on some external storage. Default: System default user [config directory](https://github.com/sindresorhus/env-paths#pathsconfig).
|
||||
*/
|
||||
cwd?: string;
|
||||
/**
|
||||
Note that this is __not intended for security purposes__, since the encryption key would be easily found inside a plain-text Node.js app.
|
||||
|
||||
Its main use is for obscurity. If a user looks through the config directory and finds the config file, since it's just a JSON file, they may be tempted to modify it. By providing an encryption key, the file will be obfuscated, which should hopefully deter any users from doing so.
|
||||
|
||||
It also has the added bonus of ensuring the config file's integrity. If the file is changed in any way, the decryption will not work, in which case the store will just reset back to its default state.
|
||||
|
||||
When specified, the store will be encrypted using the [`aes-256-cbc`](https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation) encryption algorithm.
|
||||
*/
|
||||
encryptionKey?: string | Uint8Array | NodeJS.TypedArray | DataView;
|
||||
/**
|
||||
Extension of the config file.
|
||||
|
||||
You would usually not need this, but could be useful if you want to interact with a file with a custom file extension that can be associated with your app. These might be simple save/export/preference files that are intended to be shareable or saved outside of the app.
|
||||
|
||||
@default 'json'
|
||||
*/
|
||||
fileExtension?: string;
|
||||
/**
|
||||
The config is cleared if reading the config file causes a `SyntaxError`. This is a good behavior for unimportant data, as the config file is not intended to be hand-edited, so it usually means the config is corrupt and there's nothing the user can do about it anyway. However, if you let the user edit the config file directly, mistakes might happen and it could be more useful to throw an error when the config is invalid instead of clearing.
|
||||
|
||||
@default false
|
||||
*/
|
||||
clearInvalidConfig?: boolean;
|
||||
/**
|
||||
Function to serialize the config object to a UTF-8 string when writing the config file.
|
||||
|
||||
You would usually not need this, but it could be useful if you want to use a format other than JSON.
|
||||
|
||||
@default value => JSON.stringify(value, null, '\t')
|
||||
*/
|
||||
readonly serialize?: Serialize<T>;
|
||||
/**
|
||||
Function to deserialize the config object from a UTF-8 string when reading the config file.
|
||||
|
||||
You would usually not need this, but it could be useful if you want to use a format other than JSON.
|
||||
|
||||
@default JSON.parse
|
||||
*/
|
||||
readonly deserialize?: Deserialize<T>;
|
||||
/**
|
||||
__You most likely don't need this. Please don't use it unless you really have to.__
|
||||
|
||||
Suffix appended to `projectName` during config file creation to avoid name conflicts with native apps.
|
||||
|
||||
You can pass an empty string to remove the suffix.
|
||||
|
||||
For example, on macOS, the config file will be stored in the `~/Library/Preferences/foo-nodejs` directory, where `foo` is the `projectName`.
|
||||
|
||||
@default 'nodejs'
|
||||
*/
|
||||
readonly projectSuffix?: string;
|
||||
/**
|
||||
Access nested properties by dot notation.
|
||||
|
||||
@default true
|
||||
|
||||
@example
|
||||
```
|
||||
const config = new Conf({projectName: 'foo'});
|
||||
|
||||
config.set({
|
||||
foo: {
|
||||
bar: {
|
||||
foobar: '🦄'
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
console.log(config.get('foo.bar.foobar'));
|
||||
//=> '🦄'
|
||||
```
|
||||
|
||||
Alternatively, you can set this option to `false` so the whole string would be treated as one key.
|
||||
|
||||
@example
|
||||
```
|
||||
const config = new Conf({
|
||||
projectName: 'foo',
|
||||
accessPropertiesByDotNotation: false
|
||||
});
|
||||
|
||||
config.set({
|
||||
`foo.bar.foobar`: '🦄'
|
||||
});
|
||||
|
||||
console.log(config.get('foo.bar.foobar'));
|
||||
//=> '🦄'
|
||||
```
|
||||
|
||||
*/
|
||||
readonly accessPropertiesByDotNotation?: boolean;
|
||||
/**
|
||||
Watch for any changes in the config file and call the callback for `onDidChange` or `onDidAnyChange` if set. This is useful if there are multiple processes changing the same config file.
|
||||
|
||||
@default false
|
||||
*/
|
||||
readonly watch?: boolean;
|
||||
/**
|
||||
The [mode](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation) that will be used for the config file.
|
||||
|
||||
You would usually not need this, but it could be useful if you want to restrict the permissions of the config file. Setting a permission such as `0o600` would result in a config file that can only be accessed by the user running the program.
|
||||
|
||||
Note that setting restrictive permissions can cause problems if different users need to read the file. A common problem is a user running your tool with and without `sudo` and then not being able to access the config the second time.
|
||||
|
||||
@default 0o666
|
||||
*/
|
||||
readonly configFileMode?: number;
|
||||
};
|
||||
export type Migrations<T extends Record<string, any>> = Record<string, (store: Conf<T>) => void>;
|
||||
export type BeforeEachMigrationContext = {
|
||||
fromVersion: string;
|
||||
toVersion: string;
|
||||
finalVersion: string;
|
||||
versions: string[];
|
||||
};
|
||||
export type BeforeEachMigrationCallback<T extends Record<string, any>> = (store: Conf<T>, context: BeforeEachMigrationContext) => void;
|
||||
export type Schema<T> = {
|
||||
[Property in keyof T]: ValueSchema;
|
||||
};
|
||||
export type ValueSchema = TypedJSONSchema;
|
||||
export type Serialize<T> = (value: T) => string;
|
||||
export type Deserialize<T> = (text: string) => T;
|
||||
export type OnDidChangeCallback<T> = (newValue?: T, oldValue?: T) => void;
|
||||
export type OnDidAnyChangeCallback<T> = (newValue?: Readonly<T>, oldValue?: Readonly<T>) => void;
|
||||
export type Unsubscribe = () => void;
|
||||
export type { CurrentOptions as AjvOptions } from 'ajv/dist/core.js';
|
||||
1
node_modules/conf/dist/source/types.js
generated
vendored
Normal file
1
node_modules/conf/dist/source/types.js
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
export {};
|
||||
Reference in New Issue
Block a user