supaapps-config-fetcher 1.0.2

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

@@ -0,0 +1,30 @@
+name: Publish to NPM
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+            node-version: lts/*
+            registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+      - name: Publish to npm
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/LICENSE

@@ -0,0 +1,23 @@
+MIT 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.
+
+Copyright (c) 2023 Supaapps GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+
+![Supaapps Logo](https://supaapps.com/wp-content/uploads/logo.png)
+
+## Supaapps Config Fetcher
+
+
+Managing configurations in applications can be cumbrersome, whether it's containerized deployments like Docker or traditional application distributions. Rebuilding an app or creating multiple versions for a single configuration change isn't efficient. `supaapps-config-fetcher` aims to simplify this. 
+
+`supaapps-config-fetcher` is an easy-to-use package developed by Supaapps GmbH to fetch configurations from a hosted JSON file based on the application's hostname. Although intended for internal use, we've made this package available under the MIT license. Feel free to integrate it into your projects.
+
+
+
+## Installation
+
+```bash
+npm install supaapps-config-fetcher
+
+```
+Or using Yarn:
+```bash
+yarn add supaapps-config-fetcher
+
+```
+
+
+
+## Usage
+
+#### Fetching Configurations: The primary purpose of this package is to fetch configurations<br from a hosted JSON file based on the application's hostname.
+Below are an example config and how to use it with our package.
+```json
+{
+  "apiUrl": "http://localhost:8080/api"
+}
+```
+
+#### TypeScript Support: Before using the package, define the expected return type for your<br configuration.
+
+```typescript
+type MyAppConfig = {
+    apiUrl: string;
+};
+```
+
+####
+To initialize and fetch the configuration, use the code provided below:
+
+```typescript
+import { ConfigManager } from 'supaapps-config-fetcher';
+
+const configManager = ConfigManager.getInstance<MyAppConfig>('example-app@v1');
+const config = await configManager.loadConfig();
+console.log(config.apiUrl);
+// Outputs: "http://localhost:8080/api"
+
+```
+
+#
+
+you should use custom host where your config.json files are hosted https://example.com and host your files with `example-app@v1` then hostnames example: `localhost.json` 
+```typescript
+const customHostManager = ConfigManager.getInstance<MyAppConfig>('example-app@v1', 'https://example.com');
+
+```
+
+This will load the file from https://example.com/example-app@v1/localhost.json when the app is loaded from localhost
+
+## 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

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "supaapps-config-fetcher",
+  "version": "1.0.2",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "peerDependencies": {
+    "react": "^17.0.0 || ^18.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.8.8",
+    "@types/react": "^18.2.32",
+    "axios": "^1.5.1",
+    "typescript": "^5.2.2"
+  }
+}

package/src/ConfigManager.ts

@@ -0,0 +1,38 @@
+import axios from 'axios';
+
+export class ConfigManager<T> {
+    private static instances: Record<string, ConfigManager<any>> = {};
+    private config: T | null = null;
+    private appName: string;
+    private configHost: string;
+
+    private constructor(appName: string, configHost: string = 'https://config.sacl.io') {
+        this.appName = appName;
+        this.configHost = configHost;
+    }
+
+    public static getInstance<T>(appName: string, configHost?: string): ConfigManager<T> {
+        const key = `${appName}-${configHost || 'default'}`;
+        if (!ConfigManager.instances[key]) {
+            ConfigManager.instances[key] = new ConfigManager<T>(appName, configHost);
+        }
+        return ConfigManager.instances[key] as ConfigManager<T>;
+    }
+
+    public async loadConfig(): Promise<T | null> {
+        if (this.config) return this.config;
+        try {
+            const host = typeof window !== 'undefined' ? window.location.hostname : 'localhost';
+            const response = await axios.get(`${this.configHost}/${this.appName}/${host}.json`);
+            this.config = response.data;
+            return this.config;
+        } catch (error) {
+            console.error("Failed to load config:", error);
+            return null;
+        }
+    }
+
+    public getConfig(): T | null {
+        return this.config;
+    }
+}

package/src/useConfig.ts

@@ -0,0 +1,21 @@
+import { useState, useEffect } from 'react';
+import { ConfigManager } from './ConfigManager';
+
+export function useConfig<T>(appName: string): [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();
+                setConfig(cfg);
+            } catch (err) {
+                setError(err);
+            }
+        };
+        fetchConfig();
+    }, [appName]);
+
+    return [config, error];
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+      "outDir": "./dist",
+      "declaration": true,
+      "module": "commonjs",
+      "target": "ES6"
+  },
+  "include": ["src/**/*.ts"]
+}