mayo-firebase-config 1.0.5

package/README.md

@@ -0,0 +1,65 @@
+# Description
+
+__rn-firebase-config__ is a React Native module designed to extract Firebase configuration details from native files (google-services.json for Android and GoogleService-Info.plist for iOS) to be used in JavaScript code.
+How it Works
+
+Behind the scenes, mayo-firebase-config employs native modules in both Android and iOS:
+
+- Android: Reads the google-services.json file from the assets folder, extracts the required Firebase configuration details, and returns them to the React Native JavaScript layer.
+
+- iOS: Reads the GoogleService-Info.plist file, extracts the required Firebase configuration details, and returns them to the React Native JavaScript layer.
+
+# How to Use
+
+Ensure that you have the google-services.json file in the assets folder for Android and the GoogleService-Info.plist in the main bundle for iOS.
+
+Use the extractFirebaseConfig function in your React Native code as follows:
+
+```javascript
+
+import { extractFirebaseConfig } from 'mayo-firebase-config';
+
+const firebaseConfig = extractFirebaseConfig();
+console.log(firebaseConfig);
+
+```
+
+This function logs the extraction process and returns the extracted configuration. If the extraction is successful, you'll get an object with Firebase details; otherwise, a warning log indicates any issues.
+Points to Note
+
+- The module handles errors gracefully and will provide clear logs in case of extraction failures.
+
+- For security reasons, be cautious about logging the full Firebase config in a production environment as it may expose sensitive information.
+
+## Dependencies
+
+React Native
+
+## Installation
+
+For the module to work, you need to ensure that the native modules are correctly linked in your React Native project. Follow the standard React Native linking procedures for native modules if not using auto-linking.
+Contributing
+
+### We welcome contributions to mayo-firebase-config!
+
+Here's how you can help:
+
+- Fork the Repository: Click on the 'Fork' button at the top right corner of this page.
+
+- Clone Your Forked Repository: git clone https://github.com/YOUR_USERNAME/mayo-firebase-config.git
+
+- Navigate to the cloned directory: cd mayo-firebase-config
+
+- Create a New Branch: git checkout -b new-feature-or-bug-fix
+
+- Make Changes: Implement your new feature or fix a bug and commit the changes.
+
+- Push to GitHub: git push origin new-feature-or-bug-fix
+
+- Submit a Pull Request: Go to the mayo-firebase-config GitHub page and click on the 'New Pull Request' button. Select your branch from the dropdown and submit your pull request.
+
+- Wait for the Review: Maintainers will review your pull request, suggest changes if necessary, and merge it once it's approved.
+
+### License
+
+mayo-firebase-config is licensed under the MIT License. Refer to the LICENSE file in the repository for more details.

package/android/src/main/com/rnwritefirestore/FirebaseConfigExtractorModule.java

@@ -0,0 +1,85 @@
+package com.yourprojectname;
+
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.ReactContextBaseJavaModule;
+import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.bridge.Promise;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.util.HashMap;
+import java.util.Map;
+
+public class FirebaseConfigExtractorModule extends ReactContextBaseJavaModule {
+
+    public FirebaseConfigExtractorModule(ReactApplicationContext reactContext) {
+        super(reactContext);
+    }
+
+    @Override
+    public String getName() {
+        return "FirebaseConfigExtractor";
+    }
+
+    @ReactMethod
+    public void extractConfig(Promise promise) {
+        try {
+            // Use AssetManager to read the google-services.json file from the assets folder
+            AssetManager assetManager = getReactApplicationContext().getAssets();
+            InputStream input = assetManager.open("google-services.json");
+            
+            // Convert InputStream to String
+            String json = convertStreamToString(input);
+
+            // Use JSONObject to parse the JSON string
+            JSONObject jsonObject = new JSONObject(json);
+            JSONArray clientArray = jsonObject.getJSONArray("client");
+            JSONObject clientObject = clientArray.getJSONObject(0);
+            JSONObject projectInfo = jsonObject.getJSONObject("project_info");
+            JSONArray apiKeyArray = clientObject.getJSONArray("api_key");
+            JSONObject apiKeyObject = apiKeyArray.getJSONObject(0);
+
+            // Extract webClientId
+            JSONArray oauthClientArray = clientObject.getJSONArray("oauth_client");
+            String webClientId = "";
+            for (int i = 0; i < oauthClientArray.length(); i++) {
+                JSONObject oauthClientObject = oauthClientArray.getJSONObject(i);
+                if (oauthClientObject.getInt("client_type") == 3) {
+                    webClientId = oauthClientObject.getString("client_id");
+                    break;
+                }
+            }
+            
+            // Extract the values
+            Map<String, String> config = new HashMap<>();
+            config.put("webClientId", webClientId);
+            config.put("apiKey", apiKeyObject.getString("current_key"));
+            config.put("authDomain", projectInfo.getString("project_id") + ".firebaseapp.com");
+            config.put("projectId", projectInfo.getString("project_id"));
+            config.put("storageBucket", projectInfo.getString("storage_bucket"));
+            config.put("messagingSenderId", projectInfo.getString("project_number"));
+            config.put("appId", clientObject.getJSONObject("client_info").getString("mobilesdk_app_id"));
+            // Add logic for measurement ID if needed
+            config.put("databaseURL", "https://" + projectInfo.getString("project_id") + ".firebaseio.com");
+            
+            promise.resolve(config);
+        } catch (Exception e) {
+            promise.reject("ERR_UNEXPECTED_EXCEPTION", "Error extracting Firebase config on Android", e);
+        }
+    }
+
+    // Helper method to convert InputStream to String
+    private String convertStreamToString(InputStream is) throws IOException {
+        BufferedReader reader = new BufferedReader(new InputStreamReader(is));
+        StringBuilder sb = new StringBuilder();
+        String line;
+        while ((line = reader.readLine()) != null) {
+            sb.append(line).append("\n");
+        }
+        reader.close();
+        return sb.toString();
+    }
+
+}

package/dist/extractFirebaseConfig.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractFirebaseConfig = void 0;
+const react_native_1 = require("react-native");
+const rn_logging_1 = require("mayo-logging");
+const { FirebaseConfigExtractor } = react_native_1.NativeModules;
+const extractFirebaseConfig = () => {
+    rn_logging_1.Logger.info('Starting Firebase config extraction...', null, { tag: 'mayo-firebase-config-extractor' });
+    const config = FirebaseConfigExtractor.extractConfig();
+    if (config && typeof config === 'object' && Object.keys(config).length > 0) {
+        rn_logging_1.Logger.info('Successfully extracted Firebase config', null, { tag: 'mayo-firebase-config-extractor' });
+    }
+    else {
+        rn_logging_1.Logger.warn('Failed to extract valid Firebase config or the config is empty', null, { tag: 'mayo-firebase-config-extractor' });
+    }
+    // This log may expose sensitive information, so be cautious about using it in a production environment
+    rn_logging_1.Logger.info('Extracted Firebase config:', { config }, { tag: 'mayo-firebase-config-extractor' });
+    return config;
+};
+exports.extractFirebaseConfig = extractFirebaseConfig;

package/index.d.ts

@@ -0,0 +1,13 @@
+declare module 'mayo-firebase-config/extractor' {
+  export function extractFirebaseConfig(): {
+    apiKey: string;
+    authDomain: string;
+    projectId: string;
+    storageBucket: string;
+    messagingSenderId: string;
+    appId: string;
+    measurementId: string;
+    databaseURL: string;
+    webClientId?: string;
+  };
+}

package/index.ts

@@ -0,0 +1 @@
+export { extractFirebaseConfig } from './src/extractFirebaseConfig';

package/ios/FirebaseConfigExtractor.m

@@ -0,0 +1,7 @@
+#import <React/RCTBridgeModule.h>
+
+@interface RCT_EXTERN_MODULE(FirebaseConfigExtractor, NSObject)
+
+RCT_EXTERN_METHOD(extractConfig: (RCTPromiseResolveBlock)resolver rejecter:(RCTPromiseRejectBlock)rejecter)
+
+@end

package/ios/FirebaseConfigExtractor.swift

@@ -0,0 +1,28 @@
+  import React
+
+  @objc(FirebaseConfigExtractor)
+  class FirebaseConfigExtractor: NSObject, RCTBridgeModule {
+    static func moduleName() -> String {
+      return "FirebaseConfigExtractor"
+    }
+
+    @objc func extractConfig(_ resolver: @escaping RCTPromiseResolveBlock, rejecter: @escaping RCTPromiseRejectBlock) {
+      if let path = Bundle.main.path(forResource: "GoogleService-Info", ofType: "plist"),
+        let plist = NSDictionary(contentsOfFile: path) as? [String: Any] {
+        let config: [String: Any] = [
+          "apiKey": plist["API_KEY"] as? String ?? "",
+          "authDomain": "\(plist["PROJECT_ID"] as? String ?? "").firebaseapp.com",
+          "projectId": plist["PROJECT_ID"] as? String ?? "",
+          "storageBucket": "\(plist["PROJECT_ID"] as? String ?? "").appspot.com",
+          "messagingSenderId": plist["GCM_SENDER_ID"] as? String ?? "",
+          "appId": plist["GOOGLE_APP_ID"] as? String ?? "",
+          "measurementId": "", // Add logic for measurement ID if needed
+          "databaseURL": "https://\(plist["PROJECT_ID"] as? String ?? "").firebaseio.com",
+          "webClientId": plist["WEB_CLIENT_ID"] as? String ?? "" // Add this line
+        ]
+        resolver(config)
+      } else {
+        rejecter("ERR_UNEXPECTED_EXCEPTION", "Could not read the GoogleService-Info.plist", nil)
+      }
+    }
+  }

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "mayo-firebase-config",
+  "version": "1.0.5",
+  "license": "MIT",
+  "author": "Mohamed Bennekrouf",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",  
+  "scripts": {
+    "semantic-release": "semantic-release"
+  },
+  "husky": {
+    "hooks": {
+      "pre-push": "npm run semantic-release"
+    }
+  },
+  "dependencies": {
+    "mayo-logging": "^1.0.6"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.21",
+    "@types/react-native": "^0.72.2",
+    "react": "18.2.0",
+    "react-native": "^0.72.5",
+    "typescript": "^5.2.2"
+  },
+  "peerDependencies": {
+    "react-native": "^0.59.0 || ^1000.0.0",
+    "react-native-device-info": "^10.11.0"
+  },
+  "resolutions": {
+    "react": "16.14.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bennekrouf/mayo-firebase-config.git"
+  }
+}

package/rn-write-firestore.podspec

@@ -0,0 +1,24 @@
+Pod::Spec.new do |s|
+    s.name         = "mayo-firebase-config"
+    s.version      = "1.1.1"
+    s.summary      = "Firebase config auto extractor."
+  
+    s.description  = <<-DESC
+                    From firebase config we can extract a file that already contains all what is needed to interact with firebase and firestore. So this package is extracting these parameters from these files, to avoid to have to build again a firebaseconfig object or file
+                    DESC
+  
+    s.homepage     = "https://github.com/bennekrouf/mayo-firebase-config"
+  
+    s.license      = { :type => "MIT", :file => "LICENSE" }
+  
+    s.author             = { "bennekrouf" => "mb@mayorana.ch" }
+    s.platform     = :ios, "9.0"
+    
+    s.source       = { :git => "https://github.com/bennekrouf/mayo-firebase-config.git", :tag => s.version.to_s }
+  
+    s.source_files  = "ios/**/*.{h,m,swift}"
+    s.dependency 'React'
+  
+    s.swift_version = '5.0'
+  end
+  

package/src/extractFirebaseConfig.ts

@@ -0,0 +1,34 @@
+import { NativeModules } from 'react-native';
+import { Logger } from 'mayo-logging';
+
+interface FirebaseConfig {
+    apiKey?: string;
+    authDomain?: string;
+    projectId?: string;
+    storageBucket?: string;
+    messagingSenderId?: string;
+    appId?: string;
+    measurementId?: string;
+    databaseURL?: string;
+    webClientId?: string; // Add this line
+    [key: string]: string | undefined; // To cater for any other properties that might be added
+}  
+
+const { FirebaseConfigExtractor } = NativeModules;
+
+export const extractFirebaseConfig = (): FirebaseConfig => {
+  Logger.info('Starting Firebase config extraction...', null, { tag: 'mayo-firebase-config-extractor' });
+
+  const config: FirebaseConfig = FirebaseConfigExtractor.extractConfig();
+
+  if (config && typeof config === 'object' && Object.keys(config).length > 0) {
+    Logger.info('Successfully extracted Firebase config', null, { tag: 'mayo-firebase-config-extractor' });
+  } else {
+    Logger.warn('Failed to extract valid Firebase config or the config is empty', null, { tag: 'mayo-firebase-config-extractor' });
+  }
+
+  // This log may expose sensitive information, so be cautious about using it in a production environment
+  Logger.info('Extracted Firebase config:', { config }, { tag: 'mayo-firebase-config-extractor' });
+
+  return config;
+};

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "typeRoots": ["./types", "./node_modules/@types"],
+    "jsx": "react",
+    "outDir": "./dist",  // specify the output directory
+    "rootDir": "./src",  // specify the root directory of source files
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "include": [
+    "src/**/*.ts"  // source files to include in the compilation
+  ],
+  "exclude": [
+    "node_modules"  // dependencies to exclude from compilation
+  ]
+}