chore: add agent header

tilyupo · tilyupo · commit 62a591740ba4 · 2025-12-22T20:02:10.000+03:00
diff --git a/package.json b/package.json
@@ -1,6 +1,7 @@
 {
   "name": "replanejs",
   "private": true,
+  "type": "module",
   "description": "Replane JavaScript SDKs monorepo",
   "scripts": {
     "build": "pnpm -r build",
diff --git a/packages/next/package.json b/packages/next/package.json
@@ -18,6 +18,7 @@
   ],
   "sideEffects": false,
   "scripts": {
+    "prebuild": "node ../../scripts/update-version.js .",
     "build": "tsdown",
     "dev": "tsdown --watch",
     "typecheck": "tsc --noEmit",
diff --git a/packages/next/src/root.tsx b/packages/next/src/root.tsx
@@ -6,6 +6,7 @@
 import type { ReactNode } from "react";
 import { getReplaneSnapshot, type ReplaneClientOptions } from "@replanejs/sdk";
 import { ReplaneProvider } from "@replanejs/react";
+import { DEFAULT_AGENT } from "./version";
 
 /**
  * Props for ReplaneRoot server component
@@ -50,10 +51,14 @@ export interface ReplaneRootProps<T extends object> {
  * ```
  */
 export async function ReplaneRoot<T extends object>({ options, children }: ReplaneRootProps<T>) {
-  const snapshot = await getReplaneSnapshot(options);
+  const optionsWithAgent = {
+    ...options,
+    agent: options.agent ?? DEFAULT_AGENT,
+  };
+  const snapshot = await getReplaneSnapshot(optionsWithAgent);
 
   return (
-    <ReplaneProvider options={options} snapshot={snapshot}>
+    <ReplaneProvider options={optionsWithAgent} snapshot={snapshot}>
       {children}
     </ReplaneProvider>
   );
diff --git a/packages/next/src/version.ts b/packages/next/src/version.ts
@@ -0,0 +1,3 @@
+// Auto-generated - do not edit manually
+export const VERSION = "0.8.8";
+export const DEFAULT_AGENT = `replane-next/${VERSION}`;
diff --git a/packages/react/package.json b/packages/react/package.json
@@ -18,6 +18,7 @@
   ],
   "sideEffects": false,
   "scripts": {
+    "prebuild": "node ../../scripts/update-version.js .",
     "build": "tsdown",
     "dev": "tsdown --watch",
     "typecheck": "tsc --noEmit",
diff --git a/packages/react/src/provider.tsx b/packages/react/src/provider.tsx
@@ -12,6 +12,7 @@ import type {
   ReplaneContextValue,
 } from "./types";
 import { hasClient } from "./types";
+import { DEFAULT_AGENT } from "./version";
 
 /**
  * Internal provider component for pre-created client.
@@ -47,6 +48,7 @@ function ReplaneProviderWithSnapshot<T extends object>({
           retryDelayMs: options.retryDelayMs,
           inactivityTimeoutMs: options.inactivityTimeoutMs,
           logger: options.logger,
+          agent: options.agent ?? DEFAULT_AGENT,
         },
         context: options.context,
       }),
diff --git a/packages/react/src/useReplaneClient.ts b/packages/react/src/useReplaneClient.ts
@@ -3,6 +3,7 @@
 import { useEffect, useRef, useState } from "react";
 import { createReplaneClient } from "@replanejs/sdk";
 import type { ReplaneClient, ReplaneClientOptions } from "@replanejs/sdk";
+import { DEFAULT_AGENT } from "./version";
 
 type ClientState<T extends object> =
   | { status: "loading"; client: null; error: null }
@@ -48,7 +49,10 @@ export function useReplaneClientInternal<T extends object = any>(
 
     async function initClient() {
       try {
-        const client = await createReplaneClient<T>(optionsRef.current);
+        const client = await createReplaneClient<T>({
+          ...optionsRef.current,
+          agent: optionsRef.current.agent ?? DEFAULT_AGENT,
+        });
         if (cancelled) {
           client.close();
           return;
@@ -100,7 +104,10 @@ export function useReplaneClientSuspense<T extends object = any>(
   }
 
   // First time - create the promise
-  const promise = createReplaneClient<T>(options)
+  const promise = createReplaneClient<T>({
+    ...options,
+    agent: options.agent ?? DEFAULT_AGENT,
+  })
     .then((client) => {
       const entry = suspenseCache.get(cacheKey);
       if (entry) {
diff --git a/packages/react/src/version.ts b/packages/react/src/version.ts
@@ -0,0 +1,3 @@
+// Auto-generated - do not edit manually
+export const VERSION = "0.8.8";
+export const DEFAULT_AGENT = `replane-react/${VERSION}`;
diff --git a/packages/react/tests/index.spec.tsx b/packages/react/tests/index.spec.tsx
@@ -409,7 +409,11 @@ describe("ReplaneProvider with options prop - Client Lifecycle", () => {
     );
 
     await waitFor(() => {
-      expect(mockCreateClient).toHaveBeenCalledWith(defaultTestOptions);
+      expect(mockCreateClient).toHaveBeenCalledWith(
+        expect.objectContaining(defaultTestOptions)
+      );
+      // Should include the agent property
+      expect(mockCreateClient.mock.calls[0][0]).toHaveProperty("agent");
     });
   });
 
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -41,6 +41,7 @@
   ],
   "sideEffects": false,
   "scripts": {
+    "prebuild": "node ../../scripts/update-version.js .",
     "build": "tsdown",
     "dev": "tsdown --watch",
     "test": "vitest run",
diff --git a/packages/sdk/src/client-types.ts b/packages/sdk/src/client-types.ts
@@ -176,6 +176,12 @@ export interface ReplaneClientOptions<T extends object> {
   fallbacks?: {
     [K in keyof T]: T[K];
   };
+
+  /**
+   * Agent identifier sent in X-Replane-Agent header.
+   * Defaults to SDK identifier (e.g., "replane-js/x.y.z").
+   */
+  agent?: string;
 }
 
 /**
@@ -223,6 +229,11 @@ export interface RestoreReplaneClientOptions<T extends object> {
      * Optional logger (defaults to console).
      */
     logger?: ReplaneLogger;
+    /**
+     * Agent identifier sent in X-Replane-Agent header.
+     * Defaults to SDK identifier (e.g., "replane-js/x.y.z").
+     */
+    agent?: string;
   };
   /**
    * Override the context from the snapshot.
@@ -245,4 +256,5 @@ export interface ReplaneFinalOptions {
   context: ReplaneContext;
   requiredConfigs: string[];
   fallbacks: ConfigDto[];
+  agent: string;
 }
diff --git a/packages/sdk/src/client.ts b/packages/sdk/src/client.ts
@@ -15,6 +15,7 @@ import { ReplaneRemoteStorage } from "./storage";
 import { ReplaneError, ReplaneErrorCode } from "./error";
 import { evaluateOverrides } from "./evaluation";
 import { Deferred } from "./utils";
+import { DEFAULT_AGENT } from "./version";
 
 /**
  * Internal options for creating the client core
@@ -411,5 +412,6 @@ function toFinalOptions<T extends object>(defaults: ReplaneClientOptions<T>): Re
         version: -1,
         value,
       })),
+    agent: defaults.agent ?? DEFAULT_AGENT,
   };
 }
diff --git a/packages/sdk/src/storage.ts b/packages/sdk/src/storage.ts
@@ -102,6 +102,7 @@ export class ReplaneRemoteStorage implements ReplaneStorage {
         headers: {
           Authorization: this.getAuthHeader(options),
           "Content-Type": "application/json",
+          "X-Replane-Agent": options.agent,
         },
         body: JSON.stringify(options.getBody()),
         timeoutMs: options.requestTimeoutMs,
diff --git a/packages/sdk/src/version.ts b/packages/sdk/src/version.ts
@@ -0,0 +1,3 @@
+// Auto-generated - do not edit manually
+export const VERSION = "0.8.8";
+export const DEFAULT_AGENT = `replane-js/${VERSION}`;
diff --git a/packages/svelte/package.json b/packages/svelte/package.json
@@ -17,6 +17,7 @@
   ],
   "sideEffects": false,
   "scripts": {
+    "prebuild": "node ../../scripts/update-version.js .",
     "build": "svelte-package -i src -o dist",
     "dev": "svelte-package -i src -o dist --watch",
     "typecheck": "svelte-check --tsconfig ./tsconfig.json",
diff --git a/packages/svelte/src/ReplaneContext.svelte b/packages/svelte/src/ReplaneContext.svelte
@@ -5,6 +5,7 @@
     ReplaneContextWithClientProps,
     ReplaneContextWithOptionsProps,
   } from "./types";
+  import { DEFAULT_AGENT } from "./version";
 
   export type {
     ReplaneContextProps,
@@ -55,6 +56,7 @@
             retryDelayMs: options.retryDelayMs,
             inactivityTimeoutMs: options.inactivityTimeoutMs,
             logger: options.logger,
+            agent: options.agent ?? DEFAULT_AGENT,
           },
           context: options.context,
         });
@@ -70,7 +72,10 @@
     // Async client creation
     state = { status: "loading", client: null, error: null };
 
-    createReplaneClient(options)
+    createReplaneClient({
+      ...options,
+      agent: options.agent ?? DEFAULT_AGENT,
+    })
       .then((client) => {
         if (cancelled) {
           client.close();
diff --git a/packages/svelte/src/version.ts b/packages/svelte/src/version.ts
@@ -0,0 +1,3 @@
+// Auto-generated - do not edit manually
+export const VERSION = "0.8.8";
+export const DEFAULT_AGENT = `replane-svelte/${VERSION}`;
diff --git a/packages/svelte/tests/index.spec.ts b/packages/svelte/tests/index.spec.ts
@@ -161,7 +161,9 @@ describe("ReplaneContext with options prop - Loading States", () => {
     });
 
     // Provider should be in loading state
-    expect(mockCreateClient).toHaveBeenCalledWith(defaultTestOptions);
+    expect(mockCreateClient).toHaveBeenCalledWith(
+      expect.objectContaining(defaultTestOptions)
+    );
     expect(screen.getByTestId("loader")).toBeInTheDocument();
   });
 
@@ -237,7 +239,9 @@ describe("ReplaneContext with options prop - Client Lifecycle", () => {
     });
 
     await waitFor(() => {
-      expect(mockCreateClient).toHaveBeenCalledWith(defaultTestOptions);
+      expect(mockCreateClient).toHaveBeenCalledWith(
+        expect.objectContaining(defaultTestOptions)
+      );
     });
   });
 
diff --git a/scripts/update-version.js b/scripts/update-version.js
@@ -0,0 +1,19 @@
+import { readFileSync, writeFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+
+// Get the package directory from command line argument or current working directory
+const packageDir = process.argv[2] || process.cwd();
+
+const pkg = JSON.parse(readFileSync(join(packageDir, "package.json"), "utf-8"));
+
+// Determine SDK name from package name
+const sdkName = pkg.name.replace("@replanejs/sdk", "replane-js").replace("@replanejs/", "replane-");
+
+const versionContent = `// Auto-generated - do not edit manually
+export const VERSION = "${pkg.version}";
+export const DEFAULT_AGENT = \`${sdkName}/\${VERSION}\`;
+`;
+
+const versionPath = join(packageDir, "src/version.ts");
+writeFileSync(versionPath, versionContent);
+console.log(`Updated ${versionPath} to ${sdkName}/${pkg.version}`);

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "replanejs",`
`3`	`3`	`"private": true,`
	`4`	`+ "type": "module",`
`4`	`5`	`"description": "Replane JavaScript SDKs monorepo",`
`5`	`6`	`"scripts": {`
`6`	`7`	`"build": "pnpm -r build",`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+// Auto-generated - do not edit manually`
	`2`	`+export const VERSION = "0.8.8";`
	`3`	+export const DEFAULT_AGENT = `replane-next/${VERSION}`;