feat(sdk): simplify init api and update tracking endpoints

Author: Davidthecode

.changeset/calm-symbols-write.md

@@ -0,0 +1,11 @@
+---
+"@flagix/js-sdk": minor
+"@flagix/react": minor
+"@flagix/evaluation-core": minor
+---
+
+\*Simplified SDK initialization by making apiBaseUrl internal
+
+- Added support for \_\_internal_baseUrl for local development.
+
+- Updated event endpoints to /sync to improve reliability.

.changeset/config.json

@@ -3,7 +3,7 @@
   "changelog": "@changesets/cli/changelog",
   "commit": false,
   "fixed": [],
-  "linked": [],
+  "linked": [["@flagix/evaluation-core", "@flagix/js-sdk", "@flagix/react"]],
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",

apps/web/app/providers.tsx

@@ -16,7 +16,7 @@ const queryClient = new QueryClient({
 
 const SDK_OPTIONS = {
   apiKey: env.FLAGIX_SDK_API_KEY as string,
-  apiBaseUrl: env.FLAGIX_SDK_BASE_URL as string,
+  __internal_baseUrl: env.FLAGIX_SDK_BASE_URL,
   initialContext: {
     sessionId: "session-12345",
     platform: "web",

sdk/javascript/src/client.ts

@@ -1,6 +1,7 @@
 import { evaluateFlag, resolveIdentifier } from "@flagix/evaluation-core";
 import {
   EVENT_TO_LISTEN,
+  FLAGIX_API_URL,
   type FlagUpdateType,
   REMOVE_TRAILING_SLASH,
 } from "@/lib/constants";
@@ -15,6 +16,7 @@ import type {
   FlagConfig,
   FlagixClientOptions,
   FlagVariation,
+  InternalFlagixOptions,
   VariationValue,
 } from "@/types";
 
@@ -24,7 +26,7 @@ import type {
  */
 export class FlagixClient {
   private readonly apiKey: string;
-  private readonly apiBaseUrl: string;
+  private readonly apiBaseUrl: string = FLAGIX_API_URL;
   private readonly localCache = new Map<string, FlagConfig>();
   private context: EvaluationContext;
   private isInitialized = false;
@@ -40,8 +42,11 @@ export class FlagixClient {
   private isConnectingSSE = false;
 
   constructor(options: FlagixClientOptions) {
+    const internalOpts = options as InternalFlagixOptions;
+    this.apiBaseUrl =
+      internalOpts.__internal_baseUrl?.replace(REMOVE_TRAILING_SLASH, "") ??
+      FLAGIX_API_URL;
     this.apiKey = options.apiKey;
-    this.apiBaseUrl = options.apiBaseUrl.replace(REMOVE_TRAILING_SLASH, "");
     this.context = options.initialContext || {};
     this.emitter = new FlagixEventEmitter();
     setLogLevel(options.logs?.level ?? "none");

sdk/javascript/src/index.ts

@@ -3,7 +3,7 @@ import { FLAG_UPDATE_EVENT } from "@/lib/emitter";
 import { log } from "@/lib/logger";
 import type {
   EvaluationContext,
-  FlagixClientOptions,
+  InternalFlagixOptions,
   VariationValue,
 } from "@/types";
 
@@ -16,7 +16,7 @@ export const Flagix = {
   /**
    * Initializes the Flagix SDK, fetches all flags, and sets up an SSE connection.
    */
-  async initialize(options: FlagixClientOptions): Promise<void> {
+  async initialize(options: InternalFlagixOptions): Promise<void> {
     // this check ensures that we are able to watch for api key changes and re-initialize accordingly
     // this ensures we dont use stale clients across different api keys
     if (clientInstance) {

sdk/javascript/src/lib/constants.ts

@@ -10,3 +10,4 @@ export type FlagUpdateType =
   | "RULE_DELETED";
 
 export const EVENT_TO_LISTEN = "flag-update";
+export const FLAGIX_API_URL = "https://api.flagix.com";

sdk/javascript/src/types.ts

@@ -11,12 +11,14 @@ export type {
 export type FlagixClientOptions = {
   /** The API Key for the environment */
   apiKey: string;
-  /** The base URL for the flag evaluation API  */
-  apiBaseUrl: string;
   /** Optional context attributes  */
   initialContext?: EvaluationContext;
   /** Enable SDK logging */
   logs?: {
     level?: LogLevel; // default: "none"
   };
 };
+
+export type InternalFlagixOptions = FlagixClientOptions & {
+  __internal_baseUrl?: string;
+};

sdk/react/src/flagix-provider.tsx

@@ -4,6 +4,7 @@ import {
   type EvaluationContext,
   Flagix,
   type FlagixClientOptions,
+  type InternalFlagixOptions,
 } from "@flagix/js-sdk";
 import type React from "react";
 import { createContext, useContext, useEffect, useMemo, useState } from "react";
@@ -28,13 +29,14 @@ export const FlagixProvider = ({
 }: FlagixProviderProps) => {
   const [isReady, setIsReady] = useState(() => Flagix.isInitialized());
   const [error, setError] = useState<Error | null>(null);
-  const { apiKey, apiBaseUrl } = options;
+  const internalOptions = options as InternalFlagixOptions;
+  const { apiKey, __internal_baseUrl } = internalOptions;
 
   // biome-ignore lint/correctness/useExhaustiveDependencies: <>
   useEffect(() => {
     let mounted = true;
 
-    Flagix.initialize(options)
+    Flagix.initialize(internalOptions)
       .then(() => {
         if (mounted) {
           setIsReady(true);
@@ -52,7 +54,7 @@ export const FlagixProvider = ({
       mounted = false;
       Flagix.close();
     };
-  }, [apiKey, apiBaseUrl]);
+  }, [apiKey, __internal_baseUrl]);
 
   useEffect(() => {
     if (isReady && context) {