nodeconfigloder 1.0.0

package/dist/src/configloder/ConfigLoder.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 処理名: 設定ファイル読み込み・書き込みライブラリ
+ *
+ * 処理概要:
+ * JSON/YAML形式の設定ファイルを読み込み・書き込みするためのクラス。
+ * 同期処理で設定ファイルを管理し、フォーマット変換機能を提供する
+ *
+ * 実装理由:
+ * アプリケーション起動時に設定ファイルを即座に読み込む必要があり、
+ * JSON/YAMLの双方に対応する必要があるため
+ */
+export declare class ConfigLoder {
+    private debug;
+    /**
+     * 処理名: コンストラクタ
+     *
+     * 処理概要:
+     * ConfigLoderインスタンスを初期化する
+     *
+     * 実装理由:
+     * デバッグフラグを設定し、詳細なログ出力をコントロールするため
+     * @param {boolean} [debug] デバッグモード（省略可能、デフォルト: false）
+     */
+    constructor(debug?: boolean);
+    /**
+     * 処理名: リスト形式の設定ファイル読み込み
+     *
+     * 処理概要:
+     * 改行区切りのテキストファイルを読み込み、配列に変換して返す
+     *
+     * 実装理由:
+     * シンプルなリスト形式の設定を効率的に読み込むため
+     * @param {string} filepath ファイルパス
+     * @returns {string[]} 行単位に分割された文字列配列
+     * @throws {Error} ファイルが存在しないか読み込みに失敗した場合
+     */
+    readListSync(filepath: string): string[];
+    /**
+     * 処理名: 設定ファイル読み込み
+     *
+     * 処理概要:
+     * JSON/YAML形式の設定ファイルを読み込み、JSON文字列として返す。
+     * YAMLは自動的にJSONに変換される
+     *
+     * 実装理由:
+     * 複数のフォーマットに対応しながら、内部的にはJSONで統一处理するため
+     * @param {string} filepath ファイルパス
+     * @returns {string} JSON形式の文字列
+     * @throws {Error} ファイルが存在しないか読み込みに失敗した場合
+     */
+    readConfigSync(filepath: string): string;
+    /**
+     * 処理名: YAML形式への変換
+     *
+     * 処理概要:
+     * JavaScriptオブジェクトをYAML形式のテキストに変換する
+     *
+     * 実装理由:
+     * 設定ファイルの人間が読みやすいYAML形式での出力を実現するため
+     * @param {unknown} json 変換元のオブジェクト
+     * @returns {string} YAML形式の文字列
+     */
+    toYamlText(json: unknown): string;
+    /**
+     * 処理名: JSON形式への変換
+     *
+     * 処理概要:
+     * JavaScriptオブジェクトをフォーマット済みのJSON文字列に変換する
+     *
+     * 実装理由:
+     * 設定ファイルのJSON形式での出力を提供するため
+     * @param {unknown} json 変換元のオブジェクト
+     * @returns {string} フォーマット済みJSON文字列
+     */
+    toJsonText(json: unknown): string;
+    /**
+     * 処理名: 設定ファイル書き込み
+     *
+     * 処理概要:
+     * 設定データをJSONまたはYAML形式で指定されたパスに書き込む。
+     * ファイル拡張子から自動的にフォーマットを判定
+     *
+     * 実装理由:
+     * 変更された設定を指定フォーマットで永続化するため
+     * @param {string} filepath ファイルパス
+     * @param {unknown} data 書き込むデータ
+     * @throws {Error} 書き込みに失敗した場合
+     */
+    writeConfigSync(filepath: string, data: unknown): void;
+}
+export default ConfigLoder;
+//# sourceMappingURL=ConfigLoder.d.ts.map

package/dist/src/configloder/ConfigLoder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigLoder.d.ts","sourceRoot":"","sources":["../../../src/configloder/ConfigLoder.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;GAUG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,KAAK,CAAU;IAEvB;;;;;;;;;OASG;gBACS,KAAK,CAAC,EAAE,OAAO;IAI3B;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE;IAYxC;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAexC;;;;;;;;;;OAUG;IACH,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM;IAIjC;;;;;;;;;;OAUG;IACH,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM;IAIjC;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI;CAYvD;AAED,eAAe,WAAW,CAAC"}

package/dist/src/configloder/FindDifferences.d.ts

@@ -0,0 +1,152 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+/**
+ * ハッシュツリーのノード型
+ */
+interface HashTreeNode {
+    __hash: string;
+    [key: string]: unknown;
+}
+/**
+ * 処理名: 差分検出エンジン
+ *
+ * 処理概要:
+ * ハッシュツリーを使用して2つのJSON構造の差分を効率的に検出する。
+ * EventEmitterを継承し、差分を'difference'イベントで通知
+ *
+ * 実装理由:
+ * 大規模な設定ファイルの変更検出において、全体比較ではなく
+ * ハッシュツリーの活用で計算量を最小化するため
+ */
+export declare class FindDifferences extends EventEmitter {
+    private previousHashTree;
+    /**
+     * 処理名: コンストラクタ
+     *
+     * 処理概要:
+     * FindDifferencesインスタンスを初期化し、前回のハッシュツリーを空の状態で保持
+     *
+     * 実装理由:
+     * EventEmitterの初期化と、差分検出のための状態を保持するため
+     */
+    constructor();
+    /**
+     * 処理名: ハッシュ値計算
+     *
+     * 処理概要:
+     * 与えられた値のSHA256ハッシュを計算する
+     *
+     * 実装理由:
+     * オブジェクトの内容をコンパクトに表現し、変更検出の基盤とするため
+     * @param {string} value ハッシュ対象の値
+     * @returns {string} ハッシュ文字列
+     * @private
+     */
+    private calculateHash;
+    /**
+     * 処理名: ハッシュツリー構築
+     *
+     * 処理概要:
+     * JSONデータから再帰的にハッシュツリーを構築する。
+     * 各ノードには__hashキーで当該ノード以下の変更を示すハッシュを保持
+     *
+     * 実装理由:
+     * 差分検出時に__hashの比較だけで下層の探索を短縮するため
+     * @param {unknown} data 構築対象のデータ
+     * @returns {HashTreeNode} ハッシュツリー
+     * @private
+     */
+    private buildHashTree;
+    /**
+     * 処理名: 削除・更新キーの処理
+     * @param {HashTreeNode} hashTree ハッシュツリー
+     * @param {Record<string, unknown>} jsonData JSON データ
+     * @param {string} path パス
+     * @returns {void}
+     * @private
+     */
+    private processExistingKeys;
+    /**
+     * 処理名: キー値の処理
+     * @param {HashTreeNode} hashTree ハッシュツリー
+     * @param {Record<string, unknown>} jsonData JSON データ
+     * @param {string} key キー
+     * @param {string} currentPath 現在のパス
+     * @returns {void}
+     * @private
+     */
+    private processKeyValue;
+    /**
+     * 処理名: オブジェクト値の処理
+     * @param {HashTreeNode} hashTree ハッシュツリー
+     * @param {Record<string, unknown>} jsonValue JSON 値
+     * @param {string} key キー
+     * @param {string} currentPath 現在のパス
+     * @returns {void}
+     * @private
+     */
+    private processObjectValue;
+    /**
+     * 処理名: プリミティブ値の処理
+     * @param {HashTreeNode} hashTree ハッシュツリー
+     * @param {unknown} jsonValue JSON 値
+     * @param {string} key キー
+     * @param {string} currentPath 現在のパス
+     * @returns {void}
+     * @private
+     */
+    private processPrimitiveValue;
+    /**
+     * 処理名: 追加されたキーの処理
+     * @param {HashTreeNode} hashTree ハッシュツリー
+     * @param {Record<string, unknown>} jsonData JSON データ
+     * @param {string} path パス
+     * @returns {void}
+     * @private
+     */
+    private processAddedKeys;
+    /**
+     * 処理名: 差分検出と更新
+     *
+     * 処理概要:
+     * 前回のハッシュツリーと新しいJSONデータを比較し、
+     * 追加・削除・更新されたパスを'difference'イベントで通知
+     *
+     * 実装理由:
+     * ハッシュ値の比較で不要な再帰を避け、変更箇所のみを検出するため
+     * @param {HashTreeNode} hashTree ハッシュツリー
+     * @param {unknown} jsonData JSON データ
+     * @param {string} path パス
+     * @returns {void}
+     * @private
+     */
+    private findDifferencesAndUpdate;
+    /**
+     * 処理名: ハッシュツリー初期化
+     *
+     * 処理概要:
+     * 初回読み込み時にハッシュツリーを構築し、前回状態として保持
+     *
+     * 実装理由:
+     * 次回の差分検出の基準となるベースラインを作成するため
+     * @param {unknown} jsonData 初回のJSONデータ
+     * @returns {HashTreeNode} 構築されたハッシュツリー
+     */
+    initialize(jsonData: unknown): HashTreeNode;
+    /**
+     * 処理名: 差分検出
+     *
+     * 処理概要:
+     * 新しいJSONデータと前回のハッシュツリーを比較し、
+     * 差分を検出して'difference'イベントで通知。
+     * 内部的にハッシュツリーを更新して次回検出に備える
+     *
+     * 実装理由:
+     * ファイル監視やリアルタイム変更検出のため、継続的に差分を検出するため
+     * @param {unknown} jsonData 新しいJSONデータ
+     * @returns {HashTreeNode} 更新上のハッシュツリー
+     */
+    detectChanges(jsonData: unknown): HashTreeNode;
+}
+export default FindDifferences;
+//# sourceMappingURL=FindDifferences.d.ts.map

package/dist/src/configloder/FindDifferences.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FindDifferences.d.ts","sourceRoot":"","sources":["../../../src/configloder/FindDifferences.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC;;GAEG;AACH,UAAU,YAAY;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAUD;;;;;;;;;;GAUG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IAC/C,OAAO,CAAC,gBAAgB,CAAe;IAEvC;;;;;;;;OAQG;;IAMH;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,aAAa;IAIrB;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,aAAa;IAyCrB;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IAqB3B;;;;;;;;OAQG;IACH,OAAO,CAAC,eAAe;IAcvB;;;;;;;;OAQG;IACH,OAAO,CAAC,kBAAkB;IA2B1B;;;;;;;;OAQG;IACH,OAAO,CAAC,qBAAqB;IAgB7B;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB;IAqBxB;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,wBAAwB;IAsBhC;;;;;;;;;;OAUG;IACH,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,YAAY;IAI3C;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,QAAQ,EAAE,OAAO,GAAG,YAAY;CAI/C;AAED,eAAe,eAAe,CAAC"}

package/dist/src/configloder/Serializer.d.ts

@@ -0,0 +1,108 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/**
+ * 処理名: 設定値のシリアライズ・暗号化ライブラリ
+ *
+ * 処理概要:
+ * JavaScriptの設定オブジェクトをシリアライズ・デシリアライズする。
+ * 正規表現、Buffer、環境変数、シークレット情報の特殊なハンドリングをサポート
+ *
+ * 実装理由:
+ * 複雑な設定オブジェクト（正規表現、バイナリデータ、暗号情報）を
+ * JSON形式で安全に保存・復元するため
+ */
+export declare class Serializer {
+    private crypto;
+    private debug;
+    /**
+     * 処理名: コンストラクタ
+     *
+     * 処理概要:
+     * Serializerインスタンスを初期化し、暗号化キーとデバッグフラグを設定
+     * 実装理由:
+     * 暗号化・複号化処理で使用する秘密鍵を保持するため
+     * @param {Buffer} cryptokey 暗号化用の秘密鍵
+     * @param {boolean} [debug] デバッグモード
+     */
+    constructor(cryptokey: Buffer, debug?: boolean);
+    /**
+     * 処理名: 暗号化キー生成
+     * 処理概要:
+     * パスワードから暗号化キーを生成する。
+     * パスワードが指定されない場合はランダムに生成
+     *
+     * 実装理由:
+     * 安全な暗号化キー生成のためにscrypt関数を使用
+     * @param {string} [password] 暗号化パスワード
+     * @returns {Buffer} 32バイトの暗号化キー
+     */
+    static generatekey(password?: string): Buffer;
+    /**
+     * 処理名: RegExp デシリアライズ処理
+     * @param {unknown} value 値
+     * @returns {unknown} 処理済み値
+     * @private
+     */
+    private deserializeRegExp;
+    /**
+     * 処理名: Buffer デシリアライズ処理
+     * @param {unknown} value 値
+     * @returns {unknown} 処理済み値
+     * @private
+     */
+    private deserializeBuffer;
+    /**
+     * 処理名: Secret デシリアライズ処理
+     * @param {unknown} value 値
+     * @returns {unknown} 処理済み値
+     * @private
+     */
+    private deserializeSecret;
+    /**
+     * 処理名: Env デシリアライズ処理
+     * @param {unknown} value 値
+     * @returns {unknown} 処理済み値
+     * @private
+     */
+    private deserializeEnv;
+    /**
+     * 処理名: リバイバー関数
+     * @param {string} _key キー名
+     * @param {unknown} value 値
+     * @returns {unknown} 処理済み値
+     * @private
+     */
+    private reviver;
+    /**
+     * 処理名: JSON文字列のデシリアライズ
+     *
+     * 処理概要:
+     * JSON文字列を復元し、特殊なtype値を持つオブジェクトを
+     * 適切なJavaScriptオブジェクトに変換する
+     *
+     * 実装理由:
+     * 保存されたシリアライズデータから元の正規表現、Buffer、Secret等を
+     * 復元するため
+     * @param {string} json JSON文字列
+     * @returns {unknown} デシリアライズされたオブジェクト
+     * @throws {Error} デシリアライズに失敗した場合
+     */
+    deserializeObject(json: string): unknown;
+    /**
+     * 処理名: JavaScriptコードのシリアライズ
+     *
+     * 処理概要:
+     * JavaScriptコード文字列を実行し、正規表現・Buffer・環境変数・Secret等の
+     * 特殊なオブジェクトを適切にシリアライズ可能な形式に変換
+     *
+     * 実装理由:
+     * module.exportsで定義された設定オブジェクトに対し、
+     * カスタムtoJSONメソッドを動的に追加してシリアライズ処理を統一するため
+     * @param {string} jsCode JavaScriptのコード文字列
+     * @returns {unknown} シリアライズされた設定オブジェクト
+     * @throws {Error} コード実行に失敗した場合
+     */
+    serializeObject(jsCode: string): unknown;
+}
+export default Serializer;
+//# sourceMappingURL=Serializer.d.ts.map

package/dist/src/configloder/Serializer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Serializer.d.ts","sourceRoot":"","sources":["../../../src/configloder/Serializer.ts"],"names":[],"mappings":";;AAMA;;;;;;;;;;GAUG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAIZ;IACF,OAAO,CAAC,KAAK,CAAU;IAEvB;;;;;;;;;OASG;gBACS,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO;IAS9C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM;IAO7C;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAczB;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAKzB;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAazB;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAQtB;;;;;;OAMG;IACH,OAAO,CAAC,OAAO;IAyBf;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAQxC;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;CA+CzC;AAED,eAAe,UAAU,CAAC"}

package/dist/src/tools/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/src/tools/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/tools/index.ts"],"names":[],"mappings":""}

package/dist/test/unit/configloder/ConfigLoder.test.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 処理名: ConfigLoder ユニットテスト
+ *
+ * 処理概要:
+ * ConfigLoderクラスの各メソッドをテストする
+ *
+ * 実装理由:
+ * ファイル読み込み・書き込み・フォーマット変換の機能を検証するため
+ */
+export {};
+//# sourceMappingURL=ConfigLoder.test.d.ts.map

package/dist/test/unit/configloder/ConfigLoder.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigLoder.test.d.ts","sourceRoot":"","sources":["../../../../test/unit/configloder/ConfigLoder.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/dist/test/unit/configloder/FindDifferences.test.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 処理名: FindDifferences ユニットテスト
+ *
+ * 処理概要:
+ * FindDifferencesクラスの差分検出機能をテストする
+ *
+ * 実装理由:
+ * ハッシュツリーベースの差分検出アルゴリズムが正しく動作することを検証するため
+ */
+export {};
+//# sourceMappingURL=FindDifferences.test.d.ts.map

package/dist/test/unit/configloder/FindDifferences.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FindDifferences.test.d.ts","sourceRoot":"","sources":["../../../../test/unit/configloder/FindDifferences.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/dist/test/unit/configloder/Serializer.test.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 処理名: Serializer ユニットテスト
+ *
+ * 処理概要:
+ * Serializerクラスのシリアライズ・デシリアライズ機能をテストする
+ *
+ * 実装理由:
+ * 正規表現、Buffer、Secret等の特殊なオブジェクトの安全な処理を検証するため
+ */
+export {};
+//# sourceMappingURL=Serializer.test.d.ts.map

package/dist/test/unit/configloder/Serializer.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Serializer.test.d.ts","sourceRoot":"","sources":["../../../../test/unit/configloder/Serializer.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "nodeconfigloder",
+  "version": "1.0.0",
+  "description": "Flexible configuration file loader with support for multiple formats including JSON, YAML, and JavaScript",
+  "keywords": [
+    "config",
+    "configuration",
+    "loader",
+    "json",
+    "yaml",
+    "cli"
+  ],
+  "main": "dist/configloder.bundle.js",
+  "files": [
+    "dist",
+    "package.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "bin": {
+    "configtool": "dist/conftool.bundle.js"
+  },
+  "scripts": {
+    "test": "jest --config jest.unit.config.js",
+    "build": "cross-env NODE_ENV=test webpack",
+    "test:ci": "jest --config jest.unit.config.js --coverage",
+    "lint": "eslint .",
+    "docs": "typedoc --config typedoc.js",
+    "depcruise": "depcruise src --config .dependency-cruiser.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nojaja/NodeConfigLoder.git"
+  },
+  "author": "nojaja <free.riccia@gmail.com> (https://github.com/nojaja)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/nojaja/NodeConfigLoder/issues"
+  },
+  "homepage": "https://github.com/nojaja/NodeConfigLoder#readme",
+  "devDependencies": {
+    "@babel/preset-env": "^7.23.0",
+    "@eslint/js": "^8.54.0",
+    "@nojaja/pathutil": "^1.0.3",
+    "@types/jest": "^29.5.8",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^20.10.6",
+    "@types/source-map-support": "^0.5.10",
+    "@typescript-eslint/eslint-plugin": "^6.17.0",
+    "@typescript-eslint/parser": "^6.17.0",
+    "babel-jest": "^29.7.0",
+    "commander": "^8.3.0",
+    "cross-env": "^7.0.3",
+    "dependency-cruiser": "^17.3.5",
+    "eslint": "^8.54.0",
+    "eslint-plugin-jsdoc": "^46.9.1",
+    "eslint-plugin-sonarjs": "^0.23.0",
+    "jest": "^29.7.0",
+    "js-yaml": "^4.1.0",
+    "log4js": "^6.9.1",
+    "object-path": "^0.11.8",
+    "ts-jest": "^29.1.1",
+    "ts-loader": "^9.5.1",
+    "typedoc": "^0.25.4",
+    "typescript": "5.3.3",
+    "webpack": "^5.74.0",
+    "webpack-cli": "^4.10.0"
+  }
+}