feat(core): Add registerFramework util

Author: dackers86

packages/core/src/index.ts

@@ -14,10 +14,17 @@
  * limitations under the License.
  */
 
+import { registerFramework } from "./register-framework";
+import pkgJson from '../package.json';
+
+registerFramework("core", pkgJson.version);
+
 export * from "./auth";
 export * from "./behaviors";
 export * from "./config";
 export * from "./errors";
 export * from "./schemas";
 export * from "./country-data";
 export * from "./translations";
+export * from "./register-framework";
+

packages/core/src/register-framework.test.ts

@@ -0,0 +1,62 @@
+import { describe, it, expect, vi, beforeEach } from "vitest";
+import { registerFramework } from "./register-framework";
+
+vi.mock("firebase/app", () => ({
+  registerVersion: vi.fn(),
+}));
+
+import { registerVersion } from "firebase/app";
+
+describe("registerFramework", () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it("should call registerVersion with correct parameters", () => {
+    const framework = "react";
+    const version = "1.0.0";
+
+    registerFramework(framework, version);
+
+    expect(registerVersion).toHaveBeenCalledWith("firebase-ui-web", version, framework);
+    expect(registerVersion).toHaveBeenCalledTimes(1);
+  });
+
+  it("should handle different framework types", () => {
+    const frameworks = ["react", "angular"];
+    const version = "2.0.0";
+
+    frameworks.forEach((framework) => {
+      registerFramework(framework, version);
+    });
+
+    expect(registerVersion).toHaveBeenCalledTimes(frameworks.length);
+    frameworks.forEach((framework) => {
+      expect(registerVersion).toHaveBeenCalledWith("firebase-ui-web", version, framework);
+    });
+  });
+
+  it("should handle different version formats", () => {
+    const framework = "react";
+    const versions = ["1.0.0", "2.1.3", "0.0.1", "10.20.30"];
+
+    versions.forEach((version) => {
+      registerFramework(framework, version);
+    });
+
+    expect(registerVersion).toHaveBeenCalledTimes(versions.length);
+    versions.forEach((version) => {
+      expect(registerVersion).toHaveBeenCalledWith("firebase-ui-web", version, framework);
+    });
+  });
+
+  it("should handle special characters in parameters", () => {
+    const framework = "react";
+    const version = "1.0.0-beta.1";
+
+    registerFramework(framework, version);
+
+    expect(registerVersion).toHaveBeenCalledWith("firebase-ui-web", version, framework);
+    expect(registerVersion).toHaveBeenCalledTimes(1);
+  });
+});

packages/core/src/register-framework.ts

@@ -0,0 +1,11 @@
+import { registerVersion } from "firebase/app";
+
+/**
+ * Register a framework with the FirebaseUI configuration.
+ * @internal
+ * @param framework The type of framework being registered.
+ * @param version The version of the framework being registered.
+ */
+export function registerFramework(framework: string, version: string) {
+  registerVersion("firebase-ui-web", version, framework);
+}

packages/react/src/index.ts

@@ -14,7 +14,12 @@
  * limitations under the License.
  */
 
+import { registerFramework } from "@firebase-ui/core";
+import pkgJson from '../package.json';
+
 export * from "./auth";
 export * from "./hooks";
 export * from "./components";
 export { FirebaseUIProvider, type FirebaseUIProviderProps } from "./context";
+
+registerFramework("react", pkgJson.version);