@fonderie/client 1.2.0 → 1.4.0

package/brain/signatures.md

@@ -49,6 +49,7 @@ new FonderieClient(opts: IFonderieClientOptions): FonderieClient
   .webhooks: WebhooksClient
   .customers: CustomersClient
   .media: MediaClient
+  .config: ConfigClient
   .setAccessToken(token: string | undefined): void
   .clearCache(): void
   .setWorkspaceId(workspaceId: string | undefined): void
@@ -1592,4 +1593,39 @@ type SubscriberType = 'user' | 'workspace';
 function isMfaRequired(result: ILoginResult | IMfaRequiredResult): result is IMfaRequiredResult
 
 function describeLocation(loc: IRequestLocationDTO | null | undefined, countryName?: ((code: string) => string | undefined) | undefined): string | null
+
+const CONFIG_KEY_PATTERN: RegExp
+
+const CONFIG_VALUE_TYPES: readonly ConfigValueType[]
+
+function castConfigValue(type: ConfigValueType, raw: string): CastResult
+
+function configKeyProblem(key: string): string | null
+
+function configValueType(value: unknown): ConfigValueType
+
+function formatConfigValue(value: unknown, type?: ConfigValueType): string
+
+type CastResult = {
+    ok: true;
+    value: unknown;
+} | {
+    ok: false;
+    error: string;
+};
+
+type ConfigValueType = 'string' | 'number' | 'boolean' | 'json';
+
+new ConfigClient(http: HttpClient, tokens: TokenStore): ConfigClient
+  .load(): Promise<IRemoteConfigState>
+  .get<T>(key: string, fallback: T): T
+  .snapshot(): IRemoteConfigState
+  .subscribe(listener: Listener): () => void
+
+interface IRemoteConfigState {
+    values: Readonly<Record<string, unknown>>;
+    loadedAt: Date | null;
+    isLoading: boolean;
+    error: unknown;
+}
 ```

package/dist/index.cjs

@@ -27,7 +27,10 @@ __export(index_exports, {
   AuthClient: () => AuthClient,
   BillingAdminClient: () => BillingAdminClient,
   BillingClient: () => BillingClient,
+  CONFIG_KEY_PATTERN: () => CONFIG_KEY_PATTERN,
+  CONFIG_VALUE_TYPES: () => CONFIG_VALUE_TYPES,
   ConfigAdminClient: () => ConfigAdminClient,
+  ConfigClient: () => ConfigClient,
   CourierAdminClient: () => CourierAdminClient,
   CustomersClient: () => CustomersClient,
   FonderieApiError: () => FonderieApiError,
@@ -35,8 +38,12 @@ __export(index_exports, {
   MediaClient: () => MediaClient,
   WebhooksClient: () => WebhooksClient,
   WorkspacesClient: () => WorkspacesClient,
+  castConfigValue: () => castConfigValue,
+  configKeyProblem: () => configKeyProblem,
+  configValueType: () => configValueType,
   createMemoryCache: () => createMemoryCache,
   describeLocation: () => describeLocation,
+  formatConfigValue: () => formatConfigValue,
   isMfaRequired: () => isMfaRequired
 });
 module.exports = __toCommonJS(index_exports);
@@ -1139,6 +1146,62 @@ var MediaClient = class {
   }
 };
 
+// src/modules/config.ts
+var ConfigClient = class {
+  constructor(http, tokens) {
+    this.http = http;
+    this.tokens = tokens;
+  }
+  http;
+  tokens;
+  state = { values: {}, loadedAt: null, isLoading: false, error: null };
+  listeners = /* @__PURE__ */ new Set();
+  inFlight = null;
+  // GET /config/public — fetch the public values into the shared snapshot.
+  // Concurrent calls share one request. A failure keeps the previous values
+  // (a flag that was on does not flicker off because one refresh failed) and
+  // is reported in `error`; before any success, reads fall back to defaults.
+  load() {
+    if (this.inFlight) return this.inFlight;
+    this.set({ isLoading: true });
+    this.inFlight = this.http.request({
+      method: "GET",
+      path: "/config/public",
+      // Sent when signed in, so per-user values can be served later
+      // without a client change; the route itself is public.
+      token: this.tokens.get()
+    }).then(
+      (res) => this.set({ values: res.result?.values ?? {}, loadedAt: /* @__PURE__ */ new Date(), isLoading: false, error: null }),
+      (error) => this.set({ isLoading: false, error })
+    ).finally(() => {
+      this.inFlight = null;
+    });
+    return this.inFlight;
+  }
+  // One value, with the fallback used when the key is absent — before the
+  // first load, when it failed, or when the server does not expose the key.
+  // Pick the SAFE fallback (feature off), not the optimistic one.
+  get(key, fallback) {
+    return Object.hasOwn(this.state.values, key) ? this.state.values[key] : fallback;
+  }
+  // The whole current state (values, loadedAt, isLoading, error).
+  snapshot() {
+    return this.state;
+  }
+  // Called with the new state after every change; returns an unsubscribe.
+  subscribe(listener) {
+    this.listeners.add(listener);
+    return () => {
+      this.listeners.delete(listener);
+    };
+  }
+  set(patch) {
+    this.state = { ...this.state, ...patch };
+    for (const listener of this.listeners) listener(this.state);
+    return this.state;
+  }
+};
+
 // src/modules/webhooks.ts
 var WebhooksClient = class {
   constructor(http, tokens) {
@@ -1475,6 +1538,8 @@ var FonderieClient = class {
   webhooks;
   customers;
   media;
+  /** Public remote config: flags and settings the server exposes to frontends. */
+  config;
   http;
   tokens;
   workspaceId;
@@ -1498,6 +1563,7 @@ var FonderieClient = class {
     this.webhooks = new WebhooksClient(this.http, this.tokens);
     this.customers = new CustomersClient(this.http, this.tokens);
     this.media = new MediaClient(this.http, this.tokens);
+    this.config = new ConfigClient(this.http, this.tokens);
     if (opts.workspaceId !== void 0) this.setWorkspaceId(opts.workspaceId);
   }
   // Single-flight refresh: POST /auth/refresh with the app-supplied refresh
@@ -2124,6 +2190,46 @@ function describeLocation(loc, countryName) {
   );
   return parts.length > 0 ? parts.join(", ") : null;
 }
+
+// src/config-value.ts
+var CONFIG_VALUE_TYPES = ["string", "number", "boolean", "json"];
+function configValueType(value) {
+  if (typeof value === "string") return "string";
+  if (typeof value === "number") return "number";
+  if (typeof value === "boolean") return "boolean";
+  return "json";
+}
+function formatConfigValue(value, type = configValueType(value)) {
+  if (type === "string") return typeof value === "string" ? value : String(value ?? "");
+  if (type === "number") return typeof value === "number" ? String(value) : "";
+  if (type === "boolean") return value === true ? "true" : "false";
+  return JSON.stringify(value ?? null, null, 2);
+}
+function castConfigValue(type, raw) {
+  if (type === "string") return { ok: true, value: raw };
+  const t = raw.trim();
+  if (type === "number") {
+    if (t === "") return { ok: false, error: "Enter a number." };
+    const n = Number(t);
+    return Number.isFinite(n) ? { ok: true, value: n } : { ok: false, error: `"${raw}" is not a number.` };
+  }
+  if (type === "boolean") {
+    const v = t.toLowerCase();
+    if (["true", "1", "yes", "on"].includes(v)) return { ok: true, value: true };
+    if (["false", "0", "no", "off"].includes(v)) return { ok: true, value: false };
+    return { ok: false, error: "Use true or false." };
+  }
+  try {
+    return { ok: true, value: JSON.parse(t) };
+  } catch (err) {
+    return { ok: false, error: `Not valid JSON: ${err.message}` };
+  }
+}
+var CONFIG_KEY_PATTERN = /^[A-Za-z][A-Za-z0-9._-]{0,127}$/;
+function configKeyProblem(key) {
+  if (!key) return "Enter a key.";
+  return CONFIG_KEY_PATTERN.test(key) ? null : 'Start with a letter; use letters, digits, ".", "_" or "-" (max 128).';
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AdminClient,
@@ -2133,7 +2239,10 @@ function describeLocation(loc, countryName) {
   AuthClient,
   BillingAdminClient,
   BillingClient,
+  CONFIG_KEY_PATTERN,
+  CONFIG_VALUE_TYPES,
   ConfigAdminClient,
+  ConfigClient,
   CourierAdminClient,
   CustomersClient,
   FonderieApiError,
@@ -2141,8 +2250,12 @@ function describeLocation(loc, countryName) {
   MediaClient,
   WebhooksClient,
   WorkspacesClient,
+  castConfigValue,
+  configKeyProblem,
+  configValueType,
   createMemoryCache,
   describeLocation,
+  formatConfigValue,
   isMfaRequired
 });
 //# sourceMappingURL=index.cjs.map