@1matrix/config-loader 0.1.1 → 0.1.2

package/README.md

@@ -1,4 +1,4 @@
-# @onematrix/config-loader
+# @1matrix/config-loader
 
 Hot-reloadable public configuration management for Applications with GitHub webhook integration.
 
@@ -17,7 +17,7 @@ Hot-reloadable public configuration management for Applications with GitHub webh
 ## Installation
 
 ```bash
-pnpm add @onematrix/config-loader
+pnpm add @1matrix/config-loader
 ```
 
 ## Quick Start
@@ -25,15 +25,15 @@ pnpm add @onematrix/config-loader
 ### 1. Initialize ConfigLoader
 
 ```typescript
-import { ConfigLoader } from '@onematrix/config-loader';
+import { ConfigLoader } from "@1matrix/config-loader";
 
 const config = new ConfigLoader({
-  repository: 'OneMatrixL1/public-configs',
-  branch: 'main',
-  githubToken: process.env.GITHUB_TOKEN,
-  webhookSecret: process.env.GITHUB_WEBHOOK_SECRET,
-  cacheFile: './config-cache.json',
-  pollingInterval: 5 * 60 * 1000 // 5 minutes
+	repository: "OneMatrixL1/public-configs",
+	branch: "main",
+	githubToken: process.env.GITHUB_TOKEN,
+	webhookSecret: process.env.GITHUB_WEBHOOK_SECRET,
+	cacheFile: "./config-cache.json",
+	pollingInterval: 5 * 60 * 1000, // 5 minutes
 });
 
 await config.initialize();
@@ -43,14 +43,14 @@ await config.initialize();
 
 ```typescript
 // Get specific value
-const apiKeyName = config.get('api-keys.a129f786...');
+const apiKeyName = config.get("api-keys.a129f786...");
 
 // Get with type inference
-const handlers = config.get<string[]>('intent-handlers', []);
+const handlers = config.get<string[]>("intent-handlers", []);
 
 // Check if exists
-if (config.has('api-keys.some-hash')) {
-  // ...
+if (config.has("api-keys.some-hash")) {
+	// ...
 }
 
 // Get all configs
@@ -61,35 +61,35 @@ const allConfigs = config.getAll();
 
 ```typescript
 // Listen to all updates
-config.on('update', (newConfigs, changedKeys) => {
-  console.log('Updated configs:', changedKeys);
+config.on("update", (newConfigs, changedKeys) => {
+	console.log("Updated configs:", changedKeys);
 });
 
 // Listen to specific config updates
-config.on('update:api-keys', (newApiKeys) => {
-  console.log('API keys changed');
+config.on("update:api-keys", (newApiKeys) => {
+	console.log("API keys changed");
 });
 
 // Listen to validation errors
-config.on('validation-error', (configName, errors) => {
-  console.error('Validation failed:', configName, errors);
+config.on("validation-error", (configName, errors) => {
+	console.error("Validation failed:", configName, errors);
 });
 ```
 
 ### 4. Set Up Webhook (Express)
 
 ```typescript
-import express from 'express';
+import express from "express";
 
 const app = express();
 
 app.post(
-  '/webhook/config-update',
-  express.json(),
-  config.createWebhookHandler({
-    onUpdate: (configs) => console.log('Updated via webhook'),
-    onError: (err) => console.error(err)
-  })
+	"/webhook/config-update",
+	express.json(),
+	config.createWebhookHandler({
+		onUpdate: (configs) => console.log("Updated via webhook"),
+		onError: (err) => console.error(err),
+	})
 );
 ```
 
@@ -116,48 +116,50 @@ public-configs/
 ### Example Configurations
 
 **`dev/api-keys.json`**
+
 ```json
 {
-  "a129f7860d47c0630e6d06c153fe36711f25a31bfb4304dc6d2a79e609da0e96": "VNIDC",
-  "b234c8971e58d1741f7e17d264gf47822g36b42cgc5415ed7e3b8a710eb1fa07": "SERVICE_2"
+	"a129f7860d47c0630e6d06c153fe36711f25a31bfb4304dc6d2a79e609da0e96": "VNIDC",
+	"b234c8971e58d1741f7e17d264gf47822g36b42cgc5415ed7e3b8a710eb1fa07": "SERVICE_2"
 }
 ```
 
 **`dev/roles.json`**
+
 ```json
 {
-  "explorer.viewer": [
-    "0xE61383556642AF1Bd7c5756b13f19A63Dc8601df",
-    "0x7d5538fEe2CE89dA936ec29cC48386b6E7548FaB"
-  ],
-  "admin": [
-    "0x194f5b1755562966302Ef0BbF4349c842c60FC42"
-  ]
+	"explorer.viewer": [
+		"0xE61383556642AF1Bd7c5756b13f19A63Dc8601df",
+		"0x7d5538fEe2CE89dA936ec29cC48386b6E7548FaB"
+	],
+	"admin": ["0x194f5b1755562966302Ef0BbF4349c842c60FC42"]
 }
 ```
 
 **`dev/intent-handlers.json`**
+
 ```json
 [
-  "0x84f915BcbD5C1134BCb93a0f50D9D36E6D3b508c",
-  "0x626b1E2458A9307E73A570c291bCd467216cc1D7"
+	"0x84f915BcbD5C1134BCb93a0f50D9D36E6D3b508c",
+	"0x626b1E2458A9307E73A570c291bCd467216cc1D7"
 ]
 ```
 
 ### Example Schemas
 
 **`schemas/api-keys.schema.json`**
+
 ```json
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "patternProperties": {
-    "^[a-f0-9]{64}$": {
-      "type": "string",
-      "minLength": 1
-    }
-  },
-  "additionalProperties": false
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"type": "object",
+	"patternProperties": {
+		"^[a-f0-9]{64}$": {
+			"type": "string",
+			"minLength": 1
+		}
+	},
+	"additionalProperties": false
 }
 ```
 
@@ -167,78 +169,98 @@ public-configs/
 
 ```typescript
 interface ConfigLoaderOptions {
-  repository: string;              // GitHub repository (owner/repo)
-  branch: string;                  // Branch to fetch from
-  githubToken?: string;            // GitHub personal access token
-  webhookSecret?: string;          // GitHub webhook secret
-  envMappings?: Record<string, string>; // NODE_ENV to directory mappings
-  defaultEnv?: string;             // Default environment (default: 'dev')
-  pollingInterval?: number;        // Polling interval in ms (default: 300000)
-  cacheFile?: string;              // Cache file path (default: './config-cache.json')
-  usePackageSchemas?: boolean;     // Use built-in schemas (default: true)
+	repository: string; // GitHub repository (owner/repo)
+	branch: string; // Branch to fetch from
+	githubToken?: string; // GitHub personal access token
+	webhookSecret?: string; // GitHub webhook secret
+	envMappings?: Record<string, string>; // NODE_ENV to directory mappings
+	defaultEnv?: string; // Default environment (default: 'dev')
+	pollingInterval?: number; // Polling interval in ms (default: 300000)
+	cacheFile?: string; // Cache file path (default: './config-cache.json')
+	usePackageSchemas?: boolean; // Use built-in schemas (default: true)
 }
 ```
 
 ### Methods
 
 #### `async initialize(): Promise<void>`
+
 Initialize the config loader. Attempts to load from GitHub, falls back to cache if unavailable.
 
 #### `async refresh(): Promise<void>`
+
 Manually refresh configurations from GitHub.
 
 #### `get<T>(path: string, defaultValue?: T): T | undefined`
+
 Get a configuration value by dot-notation path.
 
 #### `has(path: string): boolean`
+
 Check if a configuration path exists.
 
 #### `getAll(): Record<string, any>`
+
 Get all configurations.
 
 #### `getCurrentEnvironment(): string`
+
 Get the current environment name.
 
 #### `getConfigNames(): string[]`
+
 Get names of all loaded configurations.
 
 #### `createWebhookHandler(options?: WebhookHandlerOptions): ExpressMiddleware`
+
 Create an Express middleware for handling GitHub webhooks.
 
 #### `destroy(): void`
+
 Clean up resources (stop polling, remove listeners).
 
 ### Events
 
 #### `'update'`
+
 Emitted when configurations are updated.
+
 ```typescript
-config.on('update', (newConfigs: Record<string, any>, changedKeys: string[]) => {
-  // Handle update
-});
+config.on(
+	"update",
+	(newConfigs: Record<string, any>, changedKeys: string[]) => {
+		// Handle update
+	}
+);
 ```
 
 #### `'update:${configName}'`
+
 Emitted when a specific configuration is updated.
+
 ```typescript
-config.on('update:api-keys', (newApiKeys: any) => {
-  // Handle API keys update
+config.on("update:api-keys", (newApiKeys: any) => {
+	// Handle API keys update
 });
 ```
 
 #### `'validation-error'`
+
 Emitted when configuration validation fails.
+
 ```typescript
-config.on('validation-error', (configName: string, errors: any[]) => {
-  // Handle validation error
+config.on("validation-error", (configName: string, errors: any[]) => {
+	// Handle validation error
 });
 ```
 
 #### `'error'`
+
 Emitted when an error occurs.
+
 ```typescript
-config.on('error', (error: Error) => {
-  // Handle error
+config.on("error", (error: Error) => {
+	// Handle error
 });
 ```
 
@@ -277,17 +299,17 @@ Map `NODE_ENV` values to configuration directories:
 
 ```typescript
 const config = new ConfigLoader({
-  // ...
-  envMappings: {
-    'dev': 'dev',
-    'development': 'dev',
-    'develop': 'develop',
-    'stg': 'stg',
-    'staging': 'staging',
-    'prod': 'prod',
-    'production': 'production'
-  },
-  defaultEnv: 'dev'
+	// ...
+	envMappings: {
+		dev: "dev",
+		development: "dev",
+		develop: "develop",
+		stg: "stg",
+		staging: "staging",
+		prod: "prod",
+		production: "production",
+	},
+	defaultEnv: "dev",
 });
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@1matrix/config-loader",
-	"version": "0.1.1",
+	"version": "0.1.2",
 	"description": "Hot-reloadable public configuration management for Apps with GitHub webhook integration",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",