@fonderie/client 0.2.0 → 0.4.0

package/dist/index.d.ts

@@ -1,3 +1,17 @@
+interface ICache {
+    get<T>(key: string): T | undefined;
+    set<T>(key: string, value: T, ttlMs: number): void;
+    dedupe<T>(key: string, fn: () => Promise<T>): Promise<T>;
+    invalidate(fragment: string): void;
+    clear(): void;
+}
+interface IMemoryCacheOptions {
+    defaultTtlMs?: number;
+}
+declare function createMemoryCache(opts?: IMemoryCacheOptions): ICache & {
+    defaultTtlMs: number;
+};
+
 declare class FonderieApiError extends Error {
     readonly reason: string;
     readonly explanation: string;
@@ -12,11 +26,23 @@ interface IRequestOptions {
     token?: string | undefined;
     cookie?: string | undefined;
     workspaceId?: string | undefined;
+    cache?: number | false | undefined;
+    bust?: boolean | undefined;
+    invalidate?: string[] | undefined;
+}
+interface IHttpDeps {
+    cache?: ICache | undefined;
+    defaultTtlMs?: number | undefined;
+    refresh?: (() => Promise<string | undefined>) | undefined;
 }
 declare class HttpClient {
     private baseUrl;
-    constructor(baseUrl: string);
+    private cache;
+    private defaultTtlMs;
+    private refresh;
+    constructor(baseUrl: string, deps?: IHttpDeps);
     request<T>(opts: IRequestOptions): Promise<T>;
+    private exec;
 }
 
 declare class TokenStore {
@@ -834,9 +860,23 @@ declare class WorkspacesClient {
     updateSettings(input: IUpdateSettingsInput): Promise<IApiResponse<IWorkspaceSettingsResult>>;
 }
 
+interface IClientAuthConfig {
+    getRefreshToken?: () => string | undefined;
+    onTokensChanged?: (tokens: ITokens) => void;
+    onAuthError?: () => void;
+}
 interface IFonderieClientOptions {
     baseUrl: string;
     accessToken?: string;
+    workspaceId?: string;
+    cache?: ICache;
+    auth?: IClientAuthConfig;
+}
+interface IRequestConfig {
+    workspaceId?: string;
+    cache?: number | false;
+    bust?: boolean;
+    invalidate?: string[];
 }
 declare class FonderieClient {
     readonly auth: AuthClient;
@@ -846,7 +886,30 @@ declare class FonderieClient {
     readonly webhooks: WebhooksClient;
     readonly customers: CustomersClient;
     private http;
+    private tokens;
+    private workspaceId;
+    private cache;
+    private authConfig;
+    private refreshing;
     constructor(opts: IFonderieClientOptions);
+    private doRefresh;
+    setAccessToken(token: string | undefined): void;
+    clearCache(): void;
+    setWorkspaceId(workspaceId: string | undefined): void;
+    request<T = unknown>(opts: {
+        method: string;
+        path: string;
+        body?: unknown;
+        workspaceId?: string | undefined;
+        cache?: number | false | undefined;
+        bust?: boolean | undefined;
+        invalidate?: string[] | undefined;
+    }): Promise<IApiResponse<T>>;
+    get<T = unknown>(path: string, config?: IRequestConfig): Promise<IApiResponse<T>>;
+    post<T = unknown>(path: string, body?: unknown, config?: IRequestConfig): Promise<IApiResponse<T>>;
+    put<T = unknown>(path: string, body?: unknown, config?: IRequestConfig): Promise<IApiResponse<T>>;
+    patch<T = unknown>(path: string, body?: unknown, config?: IRequestConfig): Promise<IApiResponse<T>>;
+    delete<T = unknown>(path: string, config?: IRequestConfig): Promise<IApiResponse<T>>;
 }
 
 interface ISetConfigInput {
@@ -911,4 +974,4 @@ declare class CourierAdminClient {
     rollback(type: string, input: IRollbackTemplateInput, locale?: string | null): Promise<IApiResponse<ITemplateEntry>>;
 }
 
-export { AuditClient, AuthClient, BillingClient, ConfigAdminClient, CourierAdminClient, type CustomerLabelType, type CustomerSex, type CustomerType, CustomersClient, FonderieApiError, FonderieClient, type IAcceptInvitationResult, type IAddAddressInput, type IAddEmailInput, type IAddPhoneInput, type IAddRelationshipInput, type IAddressDTO, type IApiError, type IApiResponse, type IAuditEventDTO, type IAuditPageResult, type IBlacklistCustomerInput, type IChangePasswordInput, type ICheckoutInput, type ICheckoutUrlResult, type IConfigAdminClientOptions, type IConfigEntry, type IConfigRevision, type ICourierAdminClientOptions, type ICreateCustomerInput, type ICreatePlanInput, type ICreateRoleInput, type ICreateWebhookEndpointInput, type ICreateWorkspaceInput, type ICustomerAddressDTO, type ICustomerAddressListResult, type ICustomerAddressResult, type ICustomerDTO, type ICustomerDetailD2DTO, type ICustomerDetailDTO, type ICustomerEmailDTO, type ICustomerEmailListResult, type ICustomerEmailResult, type ICustomerLabelDTO, type ICustomerLabelListResult, type ICustomerListResult, type ICustomerNoteDTO, type ICustomerNoteListResult, type ICustomerNoteResult, type ICustomerPhoneDTO, type ICustomerPhoneListResult, type ICustomerPhoneResult, type ICustomerRelationshipDTO, type ICustomerRelationshipExpandedD2DTO, type ICustomerRelationshipExpandedDTO, type ICustomerRelationshipListResult, type ICustomerRelationshipResult, type ICustomerResult, type ICustomerShallowDTO, type ICustomerTagListResult, type IFonderieClientOptions, type IGetCustomerInput, type IInvitationDTO, type IInvitationListResult, type IInviteEntry, type IInviteResult, type IListAuditEventsInput, type IListCustomersInput, type ILoginInput, type ILoginResult, type IMeResult, type IMemberDTO, type IMemberListResult, type IMfaEnabledResult, type IMfaSetupResult, type IPlanDTO, type IPlanFeature, type IPlanListResult, type IPlanResult, type IPortalUrlResult, type IRecordUsageInput, type IRefreshResult, type IRegisterInput, type IRegisterResult, type IResendVerificationResult, type IResetPasswordInput, type IRevealSecretResult, type IRoleDTO, type IRoleListResult, type IRolePermission, type IRolePermissionInput, type IRolePermissionsResult, type IRoleResult, type IRollbackInput, type IRollbackTemplateInput, type ISecretEntry, type ISecretRevision, type ISetConfigInput, type ISetSecretInput, type ISetTemplateInput, type ISubscriptionDTO, type ISubscriptionResult, type ITemplateEntry, type ITemplateRevision, type ITestWebhookResult, type ITokens, type IUpdateCustomerInput, type IUpdatePlanInput, type IUpdatePreferencesInput, type IUpdateProfileInput, type IUpdateRoleInput, type IUpdateSettingsInput, type IUpdateWebhookEndpointInput, type IUpdateWorkspaceInput, type IUsageResult, type IUserDTO, type IUserPreferences, type IUserSkill, type IVerifyEmailResult, type IWebhookDeliveryDTO, type IWebhookDeliveryListResult, type IWebhookEndpointCreatedDTO, type IWebhookEndpointDTO, type IWebhookEndpointListResult, type IWorkspaceAddressDTO, type IWorkspaceDTO, type IWorkspaceListResult, type IWorkspaceResult, type IWorkspaceSettingsDTO, type IWorkspaceSettingsResult, type SubscriberType, WebhooksClient, WorkspacesClient };
+export { AuditClient, AuthClient, BillingClient, ConfigAdminClient, CourierAdminClient, type CustomerLabelType, type CustomerSex, type CustomerType, CustomersClient, FonderieApiError, FonderieClient, type IAcceptInvitationResult, type IAddAddressInput, type IAddEmailInput, type IAddPhoneInput, type IAddRelationshipInput, type IAddressDTO, type IApiError, type IApiResponse, type IAuditEventDTO, type IAuditPageResult, type IBlacklistCustomerInput, type ICache, type IChangePasswordInput, type ICheckoutInput, type ICheckoutUrlResult, type IClientAuthConfig, type IConfigAdminClientOptions, type IConfigEntry, type IConfigRevision, type ICourierAdminClientOptions, type ICreateCustomerInput, type ICreatePlanInput, type ICreateRoleInput, type ICreateWebhookEndpointInput, type ICreateWorkspaceInput, type ICustomerAddressDTO, type ICustomerAddressListResult, type ICustomerAddressResult, type ICustomerDTO, type ICustomerDetailD2DTO, type ICustomerDetailDTO, type ICustomerEmailDTO, type ICustomerEmailListResult, type ICustomerEmailResult, type ICustomerLabelDTO, type ICustomerLabelListResult, type ICustomerListResult, type ICustomerNoteDTO, type ICustomerNoteListResult, type ICustomerNoteResult, type ICustomerPhoneDTO, type ICustomerPhoneListResult, type ICustomerPhoneResult, type ICustomerRelationshipDTO, type ICustomerRelationshipExpandedD2DTO, type ICustomerRelationshipExpandedDTO, type ICustomerRelationshipListResult, type ICustomerRelationshipResult, type ICustomerResult, type ICustomerShallowDTO, type ICustomerTagListResult, type IFonderieClientOptions, type IGetCustomerInput, type IInvitationDTO, type IInvitationListResult, type IInviteEntry, type IInviteResult, type IListAuditEventsInput, type IListCustomersInput, type ILoginInput, type ILoginResult, type IMeResult, type IMemberDTO, type IMemberListResult, type IMemoryCacheOptions, type IMfaEnabledResult, type IMfaSetupResult, type IPlanDTO, type IPlanFeature, type IPlanListResult, type IPlanResult, type IPortalUrlResult, type IRecordUsageInput, type IRefreshResult, type IRegisterInput, type IRegisterResult, type IRequestConfig, type IResendVerificationResult, type IResetPasswordInput, type IRevealSecretResult, type IRoleDTO, type IRoleListResult, type IRolePermission, type IRolePermissionInput, type IRolePermissionsResult, type IRoleResult, type IRollbackInput, type IRollbackTemplateInput, type ISecretEntry, type ISecretRevision, type ISetConfigInput, type ISetSecretInput, type ISetTemplateInput, type ISubscriptionDTO, type ISubscriptionResult, type ITemplateEntry, type ITemplateRevision, type ITestWebhookResult, type ITokens, type IUpdateCustomerInput, type IUpdatePlanInput, type IUpdatePreferencesInput, type IUpdateProfileInput, type IUpdateRoleInput, type IUpdateSettingsInput, type IUpdateWebhookEndpointInput, type IUpdateWorkspaceInput, type IUsageResult, type IUserDTO, type IUserPreferences, type IUserSkill, type IVerifyEmailResult, type IWebhookDeliveryDTO, type IWebhookDeliveryListResult, type IWebhookEndpointCreatedDTO, type IWebhookEndpointDTO, type IWebhookEndpointListResult, type IWorkspaceAddressDTO, type IWorkspaceDTO, type IWorkspaceListResult, type IWorkspaceResult, type IWorkspaceSettingsDTO, type IWorkspaceSettingsResult, type SubscriberType, WebhooksClient, WorkspacesClient, createMemoryCache };

package/dist/index.js

@@ -1,3 +1,40 @@
+// src/cache.ts
+function createMemoryCache(opts = {}) {
+  const store = /* @__PURE__ */ new Map();
+  const inflight = /* @__PURE__ */ new Map();
+  const defaultTtlMs = opts.defaultTtlMs ?? 6e4;
+  return {
+    defaultTtlMs,
+    get(key) {
+      const entry = store.get(key);
+      if (!entry) return void 0;
+      if (Date.now() > entry.expiresAt) {
+        store.delete(key);
+        return void 0;
+      }
+      return entry.value;
+    },
+    set(key, value, ttlMs) {
+      store.set(key, { value, expiresAt: Date.now() + ttlMs });
+    },
+    dedupe(key, fn) {
+      const existing = inflight.get(key);
+      if (existing) return existing;
+      const req = fn().finally(() => inflight.delete(key));
+      inflight.set(key, req);
+      return req;
+    },
+    invalidate(fragment) {
+      for (const key of store.keys()) if (key.includes(fragment)) store.delete(key);
+      for (const key of inflight.keys()) if (key.includes(fragment)) inflight.delete(key);
+    },
+    clear() {
+      store.clear();
+      inflight.clear();
+    }
+  };
+}
+
 // src/http.ts
 var FonderieApiError = class extends Error {
   constructor(reason, explanation, status, details) {
@@ -14,24 +51,52 @@ var FonderieApiError = class extends Error {
   details;
 };
 var HttpClient = class {
-  constructor(baseUrl) {
+  constructor(baseUrl, deps = {}) {
     this.baseUrl = baseUrl;
+    this.cache = deps.cache;
+    this.defaultTtlMs = deps.defaultTtlMs ?? 6e4;
+    this.refresh = deps.refresh;
   }
   baseUrl;
+  cache;
+  defaultTtlMs;
+  refresh;
   async request(opts) {
-    const headers = {
-      "Content-Type": "application/json"
-    };
+    const method = opts.method.toUpperCase();
+    const cache = this.cache;
+    if (cache && method === "GET" && opts.cache !== false) {
+      const key = `GET ${opts.path}::ws=${opts.workspaceId ?? ""}`;
+      if (!opts.bust) {
+        const hit = cache.get(key);
+        if (hit !== void 0) return hit;
+      }
+      const ttl = typeof opts.cache === "number" ? opts.cache : this.defaultTtlMs;
+      return cache.dedupe(key, async () => {
+        const data2 = await this.exec(opts);
+        cache.set(key, data2, ttl);
+        return data2;
+      });
+    }
+    const data = await this.exec(opts);
+    if (cache && method !== "GET") {
+      const resource = opts.path.split("?")[0]?.split("/").filter(Boolean)[0];
+      if (resource) cache.invalidate(`/${resource}`);
+      for (const fragment of opts.invalidate ?? []) cache.invalidate(fragment);
+    }
+    return data;
+  }
+  async exec(opts, retried = false) {
+    const headers = { "Content-Type": "application/json" };
     if (opts.token) headers["Authorization"] = `Bearer ${opts.token}`;
     if (opts.cookie) headers["Cookie"] = opts.cookie;
     if (opts.workspaceId) headers["X-Workspace-ID"] = opts.workspaceId;
-    const fetchInit = {
-      method: opts.method,
-      headers,
-      credentials: "include"
-    };
+    const fetchInit = { method: opts.method, headers, credentials: "include" };
     if (opts.body !== void 0) fetchInit.body = JSON.stringify(opts.body);
     const res = await fetch(`${this.baseUrl}${opts.path}`, fetchInit);
+    if (res.status === 401 && this.refresh && !retried && !opts.path.startsWith("/auth/")) {
+      const newToken = await this.refresh();
+      if (newToken) return this.exec({ ...opts, token: newToken }, true);
+    }
     if (res.status === 204) {
       if (!res.ok) throw new FonderieApiError("unknown", res.statusText, res.status);
       return void 0;
@@ -1027,15 +1092,110 @@ var FonderieClient = class {
   webhooks;
   customers;
   http;
+  tokens;
+  workspaceId;
+  cache;
+  authConfig;
+  refreshing = null;
   constructor(opts) {
-    this.http = new HttpClient(opts.baseUrl);
-    const tokens = new TokenStore(opts.accessToken);
-    this.auth = new AuthClient(this.http, tokens);
-    this.billing = new BillingClient(this.http, tokens);
-    this.workspaces = new WorkspacesClient(this.http, tokens);
-    this.audit = new AuditClient(this.http, tokens);
-    this.webhooks = new WebhooksClient(this.http, tokens);
-    this.customers = new CustomersClient(this.http, tokens);
+    this.tokens = new TokenStore(opts.accessToken);
+    this.workspaceId = opts.workspaceId;
+    this.cache = opts.cache;
+    this.authConfig = opts.auth;
+    this.http = new HttpClient(opts.baseUrl, {
+      cache: opts.cache,
+      defaultTtlMs: opts.cache?.defaultTtlMs,
+      refresh: opts.auth ? () => this.doRefresh() : void 0
+    });
+    this.auth = new AuthClient(this.http, this.tokens);
+    this.billing = new BillingClient(this.http, this.tokens);
+    this.workspaces = new WorkspacesClient(this.http, this.tokens);
+    this.audit = new AuditClient(this.http, this.tokens);
+    this.webhooks = new WebhooksClient(this.http, this.tokens);
+    this.customers = new CustomersClient(this.http, this.tokens);
+  }
+  // Single-flight refresh: POST /auth/refresh with the app-supplied refresh
+  // token, store the new access token, notify the app, return it for the retry.
+  doRefresh() {
+    if (this.refreshing) return this.refreshing;
+    this.refreshing = (async () => {
+      const refreshToken = this.authConfig?.getRefreshToken?.();
+      if (!refreshToken) {
+        this.authConfig?.onAuthError?.();
+        return void 0;
+      }
+      try {
+        const { result } = await this.auth.refreshTokens(refreshToken);
+        const tokens = result.tokens;
+        this.tokens.set(tokens.access);
+        this.authConfig?.onTokensChanged?.(tokens);
+        return tokens.access;
+      } catch {
+        this.tokens.set(void 0);
+        this.authConfig?.onAuthError?.();
+        return void 0;
+      } finally {
+        this.refreshing = null;
+      }
+    })();
+    return this.refreshing;
+  }
+  // The JWT used to authenticate every request — the typed modules and the
+  // generic transport share one token store. Passing undefined signs out and
+  // clears the cache (so no session's data survives a logout).
+  setAccessToken(token) {
+    this.tokens.set(token);
+    if (!token) this.clearCache();
+  }
+  // Drop all cached responses (e.g. on switching accounts).
+  clearCache() {
+    this.cache?.clear();
+  }
+  // Default X-Workspace-ID for the generic transport, also propagated to the
+  // workspace-scoped modules so one call configures the whole client.
+  setWorkspaceId(workspaceId) {
+    this.workspaceId = workspaceId;
+    this.billing.setWorkspaceId(workspaceId);
+    this.workspaces.setWorkspaceId(workspaceId);
+    this.customers.setWorkspaceId(workspaceId);
+  }
+  // ── Generic transport ──────────────────────────────────────────────────────
+  // A Fonderie-aware HTTP client for endpoints outside the typed modules (an
+  // app's own routes on the same backend). It attaches the shared JWT and
+  // X-Workspace-ID automatically and returns Fonderie's { reason, explanation,
+  // result } envelope — so you don't hand-roll auth for custom endpoints.
+  request(opts) {
+    return this.http.request({
+      method: opts.method,
+      path: opts.path,
+      body: opts.body,
+      token: this.tokens.get(),
+      workspaceId: opts.workspaceId ?? this.workspaceId,
+      cache: opts.cache,
+      bust: opts.bust,
+      invalidate: opts.invalidate
+    });
+  }
+  get(path, config) {
+    return this.request({
+      method: "GET",
+      path,
+      workspaceId: config?.workspaceId,
+      cache: config?.cache,
+      bust: config?.bust
+    });
+  }
+  post(path, body, config) {
+    return this.request({ method: "POST", path, body, workspaceId: config?.workspaceId, invalidate: config?.invalidate });
+  }
+  put(path, body, config) {
+    return this.request({ method: "PUT", path, body, workspaceId: config?.workspaceId, invalidate: config?.invalidate });
+  }
+  patch(path, body, config) {
+    return this.request({ method: "PATCH", path, body, workspaceId: config?.workspaceId, invalidate: config?.invalidate });
+  }
+  delete(path, config) {
+    return this.request({ method: "DELETE", path, workspaceId: config?.workspaceId, invalidate: config?.invalidate });
   }
 };
 
@@ -1218,6 +1378,7 @@ export {
   FonderieApiError,
   FonderieClient,
   WebhooksClient,
-  WorkspacesClient
+  WorkspacesClient,
+  createMemoryCache
 };
 //# sourceMappingURL=index.js.map