@faiber/faiber-profile

@faiber/faiber-profile

Typed, framework-neutral TypeScript client for Faiber profiles, custom properties, locations, personal records, avatars, and profile media.

Install

npm install @faiber/faiber-profile

Create a client

import { FaiberClient, MemoryTokenProvider } from "@faiber/sdk-core";
import { ProfileApi } from "@faiber/faiber-profile";

const tokens = new MemoryTokenProvider();
const client = new FaiberClient("profile", {
  domains: { profile: process.env.FAIBER_PROFILE_URL! },
  tokenProvider: tokens,
  axios: { timeout: 15_000, withCredentials: true },
});
const api = new ProfileApi(client);

const profile = await api.full(userId);
await api.setProperties(userId, { specialty: "Cardiology" });

All methods return a full Axios AxiosResponse. Entities, named request inputs, response envelopes, pagination models, and shared core types are exported from the package. Use client.request<TResponse, TBody>() for project-specific endpoints.

Authentication

Pass a TokenProvider for bearer authentication, or set withCredentials: true for secure cookie sessions. The SDK never reads browser storage or environment variables implicitly.

Errors and cancellation

Axios errors are preserved so callers can inspect response.status, structured API error bodies, headers, and request IDs. Pass normal Axios options as the final argument:

await api.full(userId , { signal: AbortSignal.timeout(5_000) });

Complete SDK

Install @faiber/faiber-ts-sdk when an application uses multiple Faiber services. The complete package provides shared configuration, authentication, uploads, and error handling across services.