@guanghechen/config 1.0.0-alpha.1

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 1.0.0-alpha.1 (2023-11-07)
+
+
+### Features
+
+* ✨ add @guanghechen/config ([f982c65](https://github.com/guanghechen/sora/commit/f982c650b09cafe19311ba24bdd6a31af30b2fe2))

package/lib/cjs/index.cjs

@@ -0,0 +1,118 @@
+'use strict';
+
+var byte = require('@guanghechen/byte');
+require('node:fs');
+require('node:fs/promises');
+require('node:path');
+var mac = require('@guanghechen/mac');
+var semver = require('semver');
+var config_types = require('@guanghechen/config.types');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var semver__default = /*#__PURE__*/_interopDefault(semver);
+
+const isProduction = process.env.NODE_ENV === 'production';
+const prefix = 'Invariant failed';
+function invariant(condition, message) {
+    if (condition)
+        return;
+    if (isProduction)
+        throw new Error(prefix);
+    if (message == null)
+        throw new Error(prefix + ': ');
+    throw new Error(prefix + ': ' + (message instanceof Function ? message() : message));
+}
+
+const clazz = 'BaseConfigKeeper';
+class BaseConfigKeeper {
+    hashAlgorithm;
+    _resource;
+    _instance;
+    _nonce;
+    constructor(props) {
+        this.hashAlgorithm = props.hashAlgorithm ?? 'sha256';
+        this._resource = props.resource;
+        this._instance = undefined;
+    }
+    nonce(oldNonce) {
+        return oldNonce ?? byte.bytes2text(byte.randomBytes(20), 'hex');
+    }
+    get data() {
+        return this._instance;
+    }
+    compatible(version) {
+        return semver__default.default.satisfies(version, this.__compatible_version__, {
+            loose: false,
+            includePrerelease: true,
+        });
+    }
+    async update(instance) {
+        this._instance = instance;
+    }
+    async load(resource = this._resource) {
+        const configContent = await resource.load();
+        invariant(configContent !== undefined, `[${clazz}.load] Failed to load config.`);
+        const config = await this.decode(configContent);
+        const { __version__, __mac__, __nonce__, data } = config ?? {};
+        invariant(typeof __version__ === 'string' && typeof __mac__ === 'string', () => `[${clazz}.load] Bad config, invalid fields. (${JSON.stringify(config)})`);
+        invariant(this.compatible(__version__), `[${clazz}.load] Version not compatible. expect(${this.__compatible_version__}), received(${__version__})`);
+        const content = this.stringify(data);
+        const mac$1 = byte.bytes2text(mac.calcMac([byte.text2bytes(content, 'utf8')], this.hashAlgorithm), 'hex');
+        invariant(mac$1 === config.__mac__, () => `[${clazz}.load] Bad config, mac is not matched.`);
+        const instance = await this.deserialize(data);
+        this._instance = instance;
+        this._nonce = __nonce__;
+    }
+    async save(resource = this._resource) {
+        invariant(this._instance !== undefined, `[${clazz}.save] No valid data holding.`);
+        const data = await this.serialize(this._instance);
+        const content = this.stringify(data);
+        const __mac__ = byte.bytes2text(mac.calcMac([byte.text2bytes(content, 'utf8')], this.hashAlgorithm), 'hex');
+        const __nonce__ = this.nonce(this._nonce);
+        const config = {
+            __version__: this.__version__,
+            __mac__,
+            __nonce__,
+            data,
+        };
+        const stringifiedConfig = await this.encode(config);
+        await resource.save(stringifiedConfig);
+    }
+    async destroy() {
+        await this._resource.destroy();
+        this._instance = undefined;
+    }
+}
+
+class JsonConfigKeeper extends BaseConfigKeeper {
+    stringify(data) {
+        return JSON.stringify(data);
+    }
+    async encode(config) {
+        return JSON.stringify(config, null, 2);
+    }
+    async decode(stringifiedConfig) {
+        return JSON.parse(stringifiedConfig);
+    }
+}
+class PlainJsonConfigKeeper extends JsonConfigKeeper {
+    __version__ = '2.0.0';
+    __compatible_version__ = '~2.0.0';
+    async serialize(instance) {
+        return instance;
+    }
+    async deserialize(data) {
+        return data;
+    }
+}
+
+exports.BaseConfigKeeper = BaseConfigKeeper;
+exports.JsonConfigKeeper = JsonConfigKeeper;
+exports.PlainJsonConfigKeeper = PlainJsonConfigKeeper;
+Object.keys(config_types).forEach(function (k) {
+    if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+        enumerable: true,
+        get: function () { return config_types[k]; }
+    });
+});

package/lib/esm/index.mjs

@@ -0,0 +1,104 @@
+import { bytes2text, randomBytes, text2bytes } from '@guanghechen/byte';
+import 'node:fs';
+import 'node:fs/promises';
+import 'node:path';
+import { calcMac } from '@guanghechen/mac';
+import semver from 'semver';
+export * from '@guanghechen/config.types';
+
+const isProduction = process.env.NODE_ENV === 'production';
+const prefix = 'Invariant failed';
+function invariant(condition, message) {
+    if (condition)
+        return;
+    if (isProduction)
+        throw new Error(prefix);
+    if (message == null)
+        throw new Error(prefix + ': ');
+    throw new Error(prefix + ': ' + (message instanceof Function ? message() : message));
+}
+
+const clazz = 'BaseConfigKeeper';
+class BaseConfigKeeper {
+    hashAlgorithm;
+    _resource;
+    _instance;
+    _nonce;
+    constructor(props) {
+        this.hashAlgorithm = props.hashAlgorithm ?? 'sha256';
+        this._resource = props.resource;
+        this._instance = undefined;
+    }
+    nonce(oldNonce) {
+        return oldNonce ?? bytes2text(randomBytes(20), 'hex');
+    }
+    get data() {
+        return this._instance;
+    }
+    compatible(version) {
+        return semver.satisfies(version, this.__compatible_version__, {
+            loose: false,
+            includePrerelease: true,
+        });
+    }
+    async update(instance) {
+        this._instance = instance;
+    }
+    async load(resource = this._resource) {
+        const configContent = await resource.load();
+        invariant(configContent !== undefined, `[${clazz}.load] Failed to load config.`);
+        const config = await this.decode(configContent);
+        const { __version__, __mac__, __nonce__, data } = config ?? {};
+        invariant(typeof __version__ === 'string' && typeof __mac__ === 'string', () => `[${clazz}.load] Bad config, invalid fields. (${JSON.stringify(config)})`);
+        invariant(this.compatible(__version__), `[${clazz}.load] Version not compatible. expect(${this.__compatible_version__}), received(${__version__})`);
+        const content = this.stringify(data);
+        const mac = bytes2text(calcMac([text2bytes(content, 'utf8')], this.hashAlgorithm), 'hex');
+        invariant(mac === config.__mac__, () => `[${clazz}.load] Bad config, mac is not matched.`);
+        const instance = await this.deserialize(data);
+        this._instance = instance;
+        this._nonce = __nonce__;
+    }
+    async save(resource = this._resource) {
+        invariant(this._instance !== undefined, `[${clazz}.save] No valid data holding.`);
+        const data = await this.serialize(this._instance);
+        const content = this.stringify(data);
+        const __mac__ = bytes2text(calcMac([text2bytes(content, 'utf8')], this.hashAlgorithm), 'hex');
+        const __nonce__ = this.nonce(this._nonce);
+        const config = {
+            __version__: this.__version__,
+            __mac__,
+            __nonce__,
+            data,
+        };
+        const stringifiedConfig = await this.encode(config);
+        await resource.save(stringifiedConfig);
+    }
+    async destroy() {
+        await this._resource.destroy();
+        this._instance = undefined;
+    }
+}
+
+class JsonConfigKeeper extends BaseConfigKeeper {
+    stringify(data) {
+        return JSON.stringify(data);
+    }
+    async encode(config) {
+        return JSON.stringify(config, null, 2);
+    }
+    async decode(stringifiedConfig) {
+        return JSON.parse(stringifiedConfig);
+    }
+}
+class PlainJsonConfigKeeper extends JsonConfigKeeper {
+    __version__ = '2.0.0';
+    __compatible_version__ = '~2.0.0';
+    async serialize(instance) {
+        return instance;
+    }
+    async deserialize(data) {
+        return data;
+    }
+}
+
+export { BaseConfigKeeper, JsonConfigKeeper, PlainJsonConfigKeeper };

package/lib/types/index.d.ts

@@ -0,0 +1,53 @@
+import { IConfigKeeper, IConfig } from '@guanghechen/config.types';
+export * from '@guanghechen/config.types';
+import { IHashAlgorithm } from '@guanghechen/mac';
+import { ITextResource } from '@guanghechen/resource.types';
+
+interface IBaseConfigKeeperProps {
+    /**
+     * The resource which hold the config data.
+     */
+    readonly resource: ITextResource;
+    /**
+     * The hash algorithm for generate mac of contents.
+     * @default 'sha256'
+     */
+    readonly hashAlgorithm?: IHashAlgorithm;
+}
+declare abstract class BaseConfigKeeper<Instance, Data> implements IConfigKeeper<Instance> {
+    readonly hashAlgorithm: IHashAlgorithm;
+    abstract readonly __version__: string;
+    abstract readonly __compatible_version__: string;
+    protected readonly _resource: ITextResource;
+    protected _instance: Instance | undefined;
+    protected _nonce: string | undefined;
+    constructor(props: IBaseConfigKeeperProps);
+    protected abstract serialize(instance: Instance): Promise<Data>;
+    protected abstract deserialize(data: Data): Promise<Instance>;
+    protected abstract stringify(data: Data): string;
+    protected abstract encode(config: IConfig<Data>): Promise<string>;
+    protected abstract decode(stringifiedContent: string): Promise<IConfig<Data>>;
+    protected nonce(oldNonce: string | undefined): string | undefined;
+    get data(): Readonly<Instance> | undefined;
+    compatible(version: string): boolean;
+    update(instance: Instance): Promise<void>;
+    load(resource?: ITextResource): Promise<void>;
+    save(resource?: ITextResource): Promise<void>;
+    destroy(): Promise<void>;
+}
+
+interface IJsonConfigKeeperProps extends IBaseConfigKeeperProps {
+}
+declare abstract class JsonConfigKeeper<Instance, Data> extends BaseConfigKeeper<Instance, Data> implements IConfigKeeper<Instance> {
+    protected stringify(data: Data): string;
+    protected encode(config: IConfig<Data>): Promise<string>;
+    protected decode(stringifiedConfig: string): Promise<IConfig<Data>>;
+}
+declare class PlainJsonConfigKeeper<Data> extends JsonConfigKeeper<Data, Data> implements IConfigKeeper<Data> {
+    readonly __version__: string;
+    readonly __compatible_version__: string;
+    protected serialize(instance: Data): Promise<Data>;
+    protected deserialize(data: Data): Promise<Data>;
+}
+
+export { BaseConfigKeeper, type IBaseConfigKeeperProps, type IJsonConfigKeeperProps, JsonConfigKeeper, PlainJsonConfigKeeper };

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@guanghechen/config",
+  "version": "1.0.0-alpha.1",
+  "author": {
+    "name": "guanghechen",
+    "url": "https://github.com/guanghechen/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/config@1.0.0-alpha.0",
+    "directory": "packages/config"
+  },
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/config@1.0.0-alpha.0/packages/config#readme",
+  "type": "module",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "import": "./lib/esm/index.mjs",
+      "require": "./lib/cjs/index.cjs",
+      "types": "./lib/types/index.d.ts"
+    }
+  },
+  "source": "./src/index.ts",
+  "main": "./lib/cjs/index.cjs",
+  "module": "./lib/esm/index.mjs",
+  "types": "./lib/types/index.d.ts",
+  "license": "MIT",
+  "engines": {
+    "node": ">= 16.0.0"
+  },
+  "files": [
+    "lib/",
+    "!lib/**/*.map",
+    "package.json",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "../../node_modules/.bin/rimraf lib/ && ../../node_modules/.bin/cross-env NODE_ENV=production ../../node_modules/.bin/rollup -c ../../rollup.config.mjs",
+    "prepublishOnly": "yarn build",
+    "test": "node --experimental-vm-modules ../../node_modules/.bin/jest --config ../../jest.config.mjs --rootDir ."
+  },
+  "dependencies": {
+    "@guanghechen/byte": "^1.0.0-alpha.2",
+    "@guanghechen/config.types": "^1.0.0-alpha.1",
+    "@guanghechen/mac": "^1.0.0-alpha.1",
+    "@guanghechen/resource.types": "^1.0.0-alpha.1",
+    "semver": "^7.5.4"
+  },
+  "devDependencies": {
+    "@guanghechen/internal": "^1.0.0-alpha.0",
+    "@types/semver": "^7.5.4"
+  },
+  "gitHead": "44cbe1dd8ebc1a7c48d9e39564717b337d3b25af"
+}