supaapps-config-fetcher 1.2.0 → 1.3.2

package/.github/workflows/publish-to-npm.yml

@@ -8,6 +8,9 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -25,6 +28,4 @@ jobs:
         run: npm run build
 
       - name: Publish to npm
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm publish --provenance --access public

package/README.md

@@ -65,8 +65,32 @@ const customHostManager = ConfigManager.getInstance<MyAppConfig>('example-app@v1
 
 This will load the file from https://example.com/example-app@v1/localhost.json when the app is loaded from localhost
 
+## Local development config
+
+In development, you can opt in to load a local JSON file first. Place `config.local.json` in your app's public folder so it is served at `/config.local.json`.
+
+```typescript
+const configManager = ConfigManager.getInstance<MyAppConfig>(
+  'example-app@v1',
+  undefined,
+  { loadLocalConfig: true }
+);
+```
+
+When `loadLocalConfig` is `true`, the fetcher will try `/config.local.json` first and fall back to the hosted config if the local file is missing.
+
+If you use the React hook, you can pass the same options:
+
+```typescript
+const [config, error] = useConfig<MyAppConfig>(
+  'example-app@v1',
+  undefined,
+  { loadLocalConfig: true }
+);
+```
+
 ## License
 
 Notice:  While this software is open-source under the MIT License, the "Supaapps" name, branding, and logo are proprietary and copyrighted by Supaapps GmbH. Any use, reproduction, or distribution of the "Supaapps" brand assets without explicit permission is strictly prohibited.
 
-MIT License
+MIT License

package/dist/ConfigManager.d.ts

@@ -3,7 +3,10 @@ export declare class ConfigManager<T> {
     private config;
     private appName;
     private configHost;
+    private loadLocalConfig;
     private constructor();
-    static getInstance<T>(appName: string, configHost?: string): ConfigManager<T>;
+    static getInstance<T>(appName: string, configHost?: string, options?: {
+        loadLocalConfig?: boolean;
+    }): ConfigManager<T>;
     loadConfig(): Promise<T>;
 }

package/dist/ConfigManager.js

@@ -12,15 +12,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigManager = void 0;
 const axios_1 = require("axios");
 class ConfigManager {
-    constructor(appName, configHost = 'https://config.envdomain.com') {
+    constructor(appName, configHost = 'https://config.envdomain.com', loadLocalConfig = false) {
         this.config = null;
         this.appName = appName;
         this.configHost = configHost;
+        this.loadLocalConfig = loadLocalConfig;
     }
-    static getInstance(appName, configHost) {
-        const key = `${appName}-${configHost || 'default'}`;
+    static getInstance(appName, configHost, options) {
+        const loadLocalConfig = (options === null || options === void 0 ? void 0 : options.loadLocalConfig) === true;
+        const key = `${appName}-${configHost || 'default'}-${loadLocalConfig ? 'local' : 'remote'}`;
         if (!ConfigManager.instances[key]) {
-            ConfigManager.instances[key] = new ConfigManager(appName, configHost);
+            ConfigManager.instances[key] = new ConfigManager(appName, configHost, loadLocalConfig);
         }
         return ConfigManager.instances[key];
     }
@@ -29,6 +31,17 @@ class ConfigManager {
             if (this.config)
                 return this.config;
             try {
+                const isBrowser = typeof window !== 'undefined';
+                if (this.loadLocalConfig && isBrowser) {
+                    try {
+                        const localResponse = yield axios_1.default.get('/config.local.json');
+                        this.config = localResponse.data;
+                        return this.config;
+                    }
+                    catch (error) {
+                        console.warn('Local config not found, falling back to remote config.');
+                    }
+                }
                 const host = typeof window !== 'undefined' ? window.location.hostname : 'localhost';
                 const response = yield axios_1.default.get(`${this.configHost}/${this.appName}/${host}.json`);
                 this.config = response.data;

package/dist/useConfig.d.ts

@@ -1 +1,3 @@
-export declare function useConfig<T>(appName: string): [T | null, Error | null];
+export declare function useConfig<T>(appName: string, configHost?: string, options?: {
+    loadLocalConfig?: boolean;
+}): [T | null, Error | null];

package/dist/useConfig.js

@@ -12,13 +12,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useConfig = void 0;
 const react_1 = require("react");
 const ConfigManager_1 = require("./ConfigManager");
-function useConfig(appName) {
+function useConfig(appName, configHost, options) {
     const [config, setConfig] = (0, react_1.useState)(null);
     const [error, setError] = (0, react_1.useState)(null);
     (0, react_1.useEffect)(() => {
         const fetchConfig = () => __awaiter(this, void 0, void 0, function* () {
             try {
-                const cfg = yield ConfigManager_1.ConfigManager.getInstance(appName).loadConfig();
+                const cfg = yield ConfigManager_1.ConfigManager.getInstance(appName, configHost, options).loadConfig();
                 setConfig(cfg);
             }
             catch (err) {
@@ -26,7 +26,7 @@ function useConfig(appName) {
             }
         });
         fetchConfig();
-    }, [appName]);
+    }, [appName, configHost, options]);
     return [config, error];
 }
 exports.useConfig = useConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "supaapps-config-fetcher",
-  "version": "1.2.0",
+  "version": "1.3.2",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,6 +8,10 @@
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/supaapps/supaapps-config-fetcher.git"
+  },
   "keywords": [],
   "author": "",
   "license": "ISC",

package/src/ConfigManager.ts

@@ -5,16 +5,27 @@ export class ConfigManager<T> {
     private config: T | null = null;
     private appName: string;
     private configHost: string;
+    private loadLocalConfig: boolean;
 
-    private constructor(appName: string, configHost: string = 'https://config.envdomain.com') {
+    private constructor(
+        appName: string,
+        configHost: string = 'https://config.envdomain.com',
+        loadLocalConfig: boolean = false
+    ) {
         this.appName = appName;
         this.configHost = configHost;
+        this.loadLocalConfig = loadLocalConfig;
     }
 
-    public static getInstance<T>(appName: string, configHost?: string): ConfigManager<T> {
-        const key = `${appName}-${configHost || 'default'}`;
+    public static getInstance<T>(
+        appName: string,
+        configHost?: string,
+        options?: { loadLocalConfig?: boolean }
+    ): ConfigManager<T> {
+        const loadLocalConfig = options?.loadLocalConfig === true;
+        const key = `${appName}-${configHost || 'default'}-${loadLocalConfig ? 'local' : 'remote'}`;
         if (!ConfigManager.instances[key]) {
-            ConfigManager.instances[key] = new ConfigManager<T>(appName, configHost);
+            ConfigManager.instances[key] = new ConfigManager<T>(appName, configHost, loadLocalConfig);
         }
         return ConfigManager.instances[key] as ConfigManager<T>;
     }
@@ -22,6 +33,16 @@ export class ConfigManager<T> {
     public async loadConfig(): Promise<T> {
         if (this.config) return this.config;
         try {
+            const isBrowser = typeof window !== 'undefined';
+            if (this.loadLocalConfig && isBrowser) {
+                try {
+                    const localResponse = await axios.get('/config.local.json');
+                    this.config = localResponse.data;
+                    return this.config;
+                } catch (error) {
+                    console.warn('Local config not found, falling back to remote config.');
+                }
+            }
             const host = typeof window !== 'undefined' ? window.location.hostname : 'localhost';
             const response = await axios.get(`${this.configHost}/${this.appName}/${host}.json`);
             this.config = response.data;

package/src/useConfig.ts

@@ -1,21 +1,25 @@
 import { useState, useEffect } from 'react';
 import { ConfigManager } from './ConfigManager';
 
-export function useConfig<T>(appName: string): [T | null, Error | null] {
+export function useConfig<T>(
+    appName: string,
+    configHost?: string,
+    options?: { loadLocalConfig?: boolean }
+): [T | null, Error | null] {
     const [config, setConfig] = useState<T | null>(null);
     const [error, setError] = useState<Error | null>(null);
 
     useEffect(() => {
         const fetchConfig = async () => {
             try {
-                const cfg = await ConfigManager.getInstance<T>(appName).loadConfig();
+                const cfg = await ConfigManager.getInstance<T>(appName, configHost, options).loadConfig();
                 setConfig(cfg);
             } catch (err) {
-                setError(err);
+                setError(err as Error);
             }
         };
         fetchConfig();
-    }, [appName]);
+    }, [appName, configHost, options]);
 
     return [config, error];
 }