@objectstack/client 7.2.1 → 7.4.0

package/dist/index.d.mts

@@ -271,6 +271,17 @@ interface ClientConfig {
      * @see docs/adr/0002-project-database-isolation.md
      */
     environmentId?: string;
+    /**
+     * Active UI locale (BCP-47, e.g. `'zh-CN'`). When set, the client sends
+     * it as an `Accept-Language` header on every request so the server
+     * resolves metadata translations (object/field labels, view headers,
+     * action text) for the *in-app* language rather than the browser default.
+     *
+     * Apps should keep this in sync with their language switcher via
+     * {@link ObjectStackClient.setLocale} so switching language re-fetches
+     * localized metadata without a page refresh (issue #1319).
+     */
+    locale?: string;
 }
 /**
  * Discovery Result
@@ -375,6 +386,7 @@ declare class ObjectStackClient {
     private baseUrl;
     private token?;
     private environmentId?;
+    private locale?;
     private fetchImpl;
     private discoveryInfo?;
     private logger;
@@ -1246,6 +1258,18 @@ declare class ObjectStackClient {
      * Current active project id (if set).
      */
     getProjectId(): string | undefined;
+    /**
+     * Update the active UI locale used for subsequent requests. Apps should
+     * call this from their language switcher so server-translated metadata
+     * (object/field labels, view headers, action text) follows the in-app
+     * language without a page refresh. Pass `undefined` to clear and fall
+     * back to the browser's `Accept-Language` (issue #1319).
+     */
+    setLocale(locale: string | undefined): void;
+    /**
+     * Current active UI locale (if set).
+     */
+    getLocale(): string | undefined;
     /**
      * Authentication Services
      */

package/dist/index.d.ts

@@ -271,6 +271,17 @@ interface ClientConfig {
      * @see docs/adr/0002-project-database-isolation.md
      */
     environmentId?: string;
+    /**
+     * Active UI locale (BCP-47, e.g. `'zh-CN'`). When set, the client sends
+     * it as an `Accept-Language` header on every request so the server
+     * resolves metadata translations (object/field labels, view headers,
+     * action text) for the *in-app* language rather than the browser default.
+     *
+     * Apps should keep this in sync with their language switcher via
+     * {@link ObjectStackClient.setLocale} so switching language re-fetches
+     * localized metadata without a page refresh (issue #1319).
+     */
+    locale?: string;
 }
 /**
  * Discovery Result
@@ -375,6 +386,7 @@ declare class ObjectStackClient {
     private baseUrl;
     private token?;
     private environmentId?;
+    private locale?;
     private fetchImpl;
     private discoveryInfo?;
     private logger;
@@ -1246,6 +1258,18 @@ declare class ObjectStackClient {
      * Current active project id (if set).
      */
     getProjectId(): string | undefined;
+    /**
+     * Update the active UI locale used for subsequent requests. Apps should
+     * call this from their language switcher so server-translated metadata
+     * (object/field labels, view headers, action text) follows the in-app
+     * language without a page refresh. Pass `undefined` to clear and fall
+     * back to the browser's `Accept-Language` (issue #1319).
+     */
+    setLocale(locale: string | undefined): void;
+    /**
+     * Current active UI locale (if set).
+     */
+    getLocale(): string | undefined;
     /**
      * Authentication Services
      */

package/dist/index.js

@@ -2744,6 +2744,7 @@ var ObjectStackClient = class {
     this.baseUrl = config.baseUrl.replace(/\/$/, "");
     this.token = config.token;
     this.environmentId = config.environmentId;
+    this.locale = config.locale;
     this.fetchImpl = config.fetch || globalThis.fetch.bind(globalThis);
     this.logger = config.logger || (0, import_logger.createLogger)({
       level: config.debug ? "debug" : "info",
@@ -2878,6 +2879,23 @@ var ObjectStackClient = class {
   getProjectId() {
     return this.environmentId;
   }
+  /**
+   * Update the active UI locale used for subsequent requests. Apps should
+   * call this from their language switcher so server-translated metadata
+   * (object/field labels, view headers, action text) follows the in-app
+   * language without a page refresh. Pass `undefined` to clear and fall
+   * back to the browser's `Accept-Language` (issue #1319).
+   */
+  setLocale(locale) {
+    this.locale = locale;
+    this.logger.debug("Active locale changed", { locale });
+  }
+  /**
+   * Current active UI locale (if set).
+   */
+  getLocale() {
+    return this.locale;
+  }
   /**
    * Event Subscription API
    * Provides real-time event subscriptions for metadata and data changes
@@ -2921,6 +2939,9 @@ var ObjectStackClient = class {
     if (this.environmentId) {
       headers["X-Environment-Id"] = this.environmentId;
     }
+    if (this.locale && !Object.keys(headers).some((h) => h.toLowerCase() === "accept-language")) {
+      headers["Accept-Language"] = this.locale;
+    }
     const res = await this.fetchImpl(url, { ...options, headers });
     this.logger.debug("HTTP response", {
       method: options.method || "GET",