@alacard-project/config-sdk 1.0.0 → 1.0.3

package/dist/config-client.d.ts

@@ -1,5 +1,4 @@
 import { VaultOptions } from './vault-client';
-export { VaultOptions };
 export interface ConfigOptions {
     serviceName: string;
     environment: string;

package/dist/index.d.ts

@@ -1 +1,3 @@
 export * from './config-client';
+export * from './vault-client';
+export * from './nest-helpers';

package/dist/index.js

@@ -15,3 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./config-client"), exports);
+__exportStar(require("./vault-client"), exports);
+__exportStar(require("./nest-helpers"), exports);

package/dist/nest-helpers.d.ts

@@ -0,0 +1,16 @@
+import { Environment } from '@alacard-project/shared';
+export declare abstract class BaseConfigService {
+    protected readonly configService: any;
+    private remoteConfig;
+    constructor(configService: any);
+    setRemoteConfig(config: Record<string, string>): void;
+    protected get<T = string>(key: string, defaultValue?: T): T;
+    protected getRequiredString(key: string): string;
+    protected getRequiredNumber(key: string): number;
+    protected getOptionalString(key: string, defaultValue: string): string;
+    protected getOptionalNumber(key: string, defaultValue: number): number;
+    get environment(): Environment;
+    get databaseUrl(): string;
+    get kafkaBrokers(): string[];
+    get isProduction(): boolean;
+}

package/dist/nest-helpers.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseConfigService = void 0;
+const shared_1 = require("@alacard-project/shared");
+// Note: This requires @nestjs/config to be installed in the consumer microservice
+// We keep it in the SDK as a helper for NestJS-based microservices.
+class BaseConfigService {
+    configService;
+    remoteConfig = {};
+    constructor(configService) {
+        this.configService = configService;
+    }
+    setRemoteConfig(config) {
+        this.remoteConfig = { ...this.remoteConfig, ...config };
+    }
+    get(key, defaultValue) {
+        if (this.remoteConfig[key] !== undefined) {
+            return this.remoteConfig[key];
+        }
+        return this.configService.get(key, defaultValue);
+    }
+    getRequiredString(key) {
+        const value = this.get(key);
+        if (!value && process.env.NODE_ENV !== shared_1.Environment.TEST) {
+            throw new Error(`Configuration Error: ${key} is required`);
+        }
+        return value || '';
+    }
+    getRequiredNumber(key) {
+        const value = this.get(key);
+        if (!value && process.env.NODE_ENV !== shared_1.Environment.TEST) {
+            throw new Error(`Configuration Error: ${key} is required`);
+        }
+        return parseInt(value || '0', 10);
+    }
+    getOptionalString(key, defaultValue) {
+        return this.get(key, defaultValue) || defaultValue;
+    }
+    getOptionalNumber(key, defaultValue) {
+        const value = this.get(key);
+        return value ? parseInt(value, 10) : defaultValue;
+    }
+    get environment() {
+        return this.get('NODE_ENV', shared_1.Environment.DEVELOPMENT) || shared_1.Environment.DEVELOPMENT;
+    }
+    get databaseUrl() {
+        return this.getRequiredString('DATABASE_URL');
+    }
+    get kafkaBrokers() {
+        const brokers = this.get('KAFKA_BROKERS', 'localhost:9092');
+        return (brokers || 'localhost:9092').split(',');
+    }
+    get isProduction() {
+        return this.environment === shared_1.Environment.PRODUCTION;
+    }
+}
+exports.BaseConfigService = BaseConfigService;

package/package.json

@@ -1,6 +1,9 @@
 {
     "name": "@alacard-project/config-sdk",
-    "version": "1.0.0",
+    "version": "1.0.3",
+    "engines": {
+        "node": ">=24.0.0"
+    },
     "private": false,
     "description": "Standalone gRPC-based Configuration SDK for Alacard microservices",
     "main": "dist/index.js",
@@ -11,15 +14,17 @@
         "prepublishOnly": "npm run build"
     },
     "dependencies": {
+        "@alacard-project/shared": "^1.0.4",
+        "@bufbuild/protobuf": "^2.11.0",
         "@grpc/grpc-js": "^1.14.3",
         "@grpc/proto-loader": "^0.8.0",
-        "kafkajs": "^2.2.4",
+        "axios": "^1.7.9",
         "dotenv": "^16.4.6",
-        "axios": "^1.7.9"
+        "kafkajs": "^2.2.4"
     },
     "devDependencies": {
-        "typescript": "^5.5.6",
-        "@types/node": "^20.15.0",
-        "ts-proto": "^2.2.0"
+        "@types/node": "^24.10.0",
+        "ts-proto": "^2.6.1",
+        "typescript": "^5.9.3"
     }
 }

package/src/config-client.ts

@@ -6,8 +6,6 @@ import { ConfigServiceClient } from './proto/config';
 import { GetConfigRequest } from './proto/config';
 import { VaultClient, VaultOptions } from './vault-client';
 
-export { VaultOptions };
-
 export interface ConfigOptions {
     serviceName: string;
     environment: string;

package/src/index.ts

@@ -1 +1,3 @@
 export * from './config-client';
+export * from './vault-client';
+export * from './nest-helpers';

package/src/nest-helpers.ts

@@ -0,0 +1,63 @@
+import { Environment } from '@alacard-project/shared';
+
+// Note: This requires @nestjs/config to be installed in the consumer microservice
+// We keep it in the SDK as a helper for NestJS-based microservices.
+
+export abstract class BaseConfigService {
+    private remoteConfig: Record<string, string> = {};
+
+    constructor(protected readonly configService: any) { }
+
+    setRemoteConfig(config: Record<string, string>) {
+        this.remoteConfig = { ...this.remoteConfig, ...config };
+    }
+
+    protected get<T = string>(key: string, defaultValue?: T): T {
+        if (this.remoteConfig[key] !== undefined) {
+            return this.remoteConfig[key] as unknown as T;
+        }
+        return this.configService.get(key, defaultValue);
+    }
+
+    protected getRequiredString(key: string): string {
+        const value = this.get<string>(key);
+        if (!value && process.env.NODE_ENV !== Environment.TEST) {
+            throw new Error(`Configuration Error: ${key} is required`);
+        }
+        return value || '';
+    }
+
+    protected getRequiredNumber(key: string): number {
+        const value = this.get<string>(key);
+        if (!value && process.env.NODE_ENV !== Environment.TEST) {
+            throw new Error(`Configuration Error: ${key} is required`);
+        }
+        return parseInt(value || '0', 10);
+    }
+
+    protected getOptionalString(key: string, defaultValue: string): string {
+        return this.get<string>(key, defaultValue) || defaultValue;
+    }
+
+    protected getOptionalNumber(key: string, defaultValue: number): number {
+        const value = this.get<string>(key);
+        return value ? parseInt(value, 10) : defaultValue;
+    }
+
+    get environment(): Environment {
+        return this.get<Environment>('NODE_ENV', Environment.DEVELOPMENT) || Environment.DEVELOPMENT;
+    }
+
+    get databaseUrl(): string {
+        return this.getRequiredString('DATABASE_URL');
+    }
+
+    get kafkaBrokers(): string[] {
+        const brokers = this.get<string>('KAFKA_BROKERS', 'localhost:9092');
+        return (brokers || 'localhost:9092').split(',');
+    }
+
+    get isProduction(): boolean {
+        return this.environment === Environment.PRODUCTION;
+    }
+}

package/.idea/workspace.xml

@@ -1,45 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ChangeListManager">
-    <list default="true" id="d6ddd62d-b258-48c7-8ac2-ae28e47081ad" name="Changes" comment="" />
-    <option name="SHOW_DIALOG" value="false" />
-    <option name="HIGHLIGHT_CONFLICTS" value="true" />
-    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
-    <option name="LAST_RESOLUTION" value="IGNORE" />
-  </component>
-  <component name="MarkdownSettingsMigration">
-    <option name="stateVersion" value="1" />
-  </component>
-  <component name="ProjectId" id="38cLw1hfbaQQ7IG2qhtRfg4zBzC" />
-  <component name="ProjectViewState">
-    <option name="hideEmptyMiddlePackages" value="true" />
-    <option name="showLibraryContents" value="true" />
-  </component>
-  <component name="PropertiesComponent"><![CDATA[{
-  "keyToString": {
-    "RunOnceActivity.ShowReadmeOnStart": "true",
-    "WebServerToolWindowFactoryState": "false",
-    "node.js.detected.package.eslint": "true",
-    "node.js.detected.package.tslint": "true",
-    "node.js.selected.package.eslint": "(autodetect)",
-    "node.js.selected.package.tslint": "(autodetect)",
-    "nodejs_package_manager_path": "npm",
-    "vue.rearranger.settings.migration": "true"
-  }
-}]]></component>
-  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
-  <component name="TaskManager">
-    <task active="true" id="Default" summary="Default task">
-      <changelist id="d6ddd62d-b258-48c7-8ac2-ae28e47081ad" name="Changes" comment="" />
-      <created>1769094147893</created>
-      <option name="number" value="Default" />
-      <option name="presentableId" value="Default" />
-      <updated>1769094147893</updated>
-      <workItem from="1769094150802" duration="320000" />
-    </task>
-    <servers />
-  </component>
-  <component name="TypeScriptGeneratedFilesManager">
-    <option name="version" value="3" />
-  </component>
-</project>