@layers/amba-react-native 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,719 @@
+//#region src/types.d.ts
+interface AmbaConfig {
+  apiKey: string;
+  baseUrl?: string;
+  consentRequired?: boolean;
+  debug?: boolean;
+  /** Override the AsyncStorage key prefix. Defaults to `"amba"`. */
+  storagePrefix?: string;
+}
+type SocialProvider = "apple" | "google";
+type PushPlatform = "apns" | "fcm" | "web";
+interface User {
+  id: string;
+  email?: string | null;
+  display_name?: string | null;
+  avatar_url?: string | null;
+  external_id?: string | null;
+  anonymous_id?: string | null;
+  auth_providers: string[];
+  properties: Record<string, unknown>;
+  first_seen_at?: string;
+  last_seen_at?: string;
+  created_at?: string;
+  updated_at?: string;
+}
+interface AuthResult {
+  session_token: string;
+  refresh_token: string;
+  user: User;
+  anonymous_id?: string | null;
+  expires_at?: string | null;
+}
+/**
+ * Snapshot of the current session. sessionToken/refreshToken/expiresAt
+ * are SDK-managed (held internally for the auto-refresh dance) — empty
+ * strings on the consumer side. Mirrors `@layers/amba-web::Session`.
+ */
+interface Session {
+  sessionToken: string;
+  refreshToken: string;
+  user: User;
+  expiresAt: string;
+}
+type FilterValue = string | number | boolean | null | unknown[];
+interface ConditionFilter {
+  column: string;
+  op: string;
+  value?: FilterValue;
+}
+interface AndFilter {
+  and: Filter[];
+}
+interface OrFilter {
+  or: Filter[];
+}
+interface NotFilter {
+  not: Filter;
+}
+type Filter = ConditionFilter | AndFilter | OrFilter | NotFilter;
+interface OrderBy {
+  column: string;
+  direction: "asc" | "desc";
+}
+interface FindOptions {
+  filter?: Filter;
+  order?: OrderBy[];
+  limit?: number;
+  cursor?: string;
+  select?: string[];
+  include_deleted?: boolean;
+}
+interface FindResponse<T> {
+  data: T[];
+  next_cursor?: string | null;
+  has_more: boolean;
+}
+interface MediaAsset {
+  id: string;
+  bucket: string;
+  key: string;
+  url: string;
+  mime_type: string;
+  size_bytes: number;
+  width?: number | null;
+  height?: number | null;
+  retention_days?: number | null;
+  created_at: string;
+}
+interface PresignData {
+  upload_id: string;
+  upload_url: string;
+  upload_headers: Array<[string, string]>;
+  asset_id: string;
+}
+interface PushToken {
+  id: string;
+  token: string;
+  platform: PushPlatform;
+  bundle_id?: string | null;
+  created_at: string;
+}
+type EntitlementSource = "revenue_cat" | "app_store" | "play_store" | "stripe" | "promo_code" | "manual";
+interface UserEntitlement {
+  id: string;
+  name: string;
+  is_active: boolean;
+  source: EntitlementSource;
+  expires_at?: string | null;
+  granted_at?: string | null;
+  metadata: Record<string, unknown>;
+}
+interface AiMessage {
+  role: string;
+  content: unknown;
+}
+interface AiMessageRequest {
+  prompt_slug: string;
+  variables?: Record<string, unknown>;
+  messages?: AiMessage[];
+  max_tokens?: number;
+  temperature?: number;
+  enable_prompt_cache?: boolean;
+}
+interface AiUsage {
+  input_tokens: number;
+  output_tokens: number;
+  cache_creation_input_tokens?: number;
+  cache_read_input_tokens?: number;
+}
+interface AiMessageResponse {
+  content: unknown[];
+  usage: AiUsage;
+  stop_reason?: string | null;
+  model: string;
+}
+/**
+ * Resolved remote config returned by `config.fetch()`.
+ *
+ * Server: `GET /v1/client/config` returns body `{ "data": { key → value, ... } }`
+ * plus an `ETag` response header carrying the version stamp. `version`
+ * is parsed from the ETag prefix; `null` when the server didn't send one.
+ */
+interface ConfigBundle {
+  version: string | null;
+  values: Record<string, unknown>;
+}
+interface FlagAssignment {
+  name: string;
+  enabled: boolean;
+  variant?: string | null;
+  payload?: unknown;
+}
+interface Achievement {
+  id: string;
+  key: string;
+  name: string;
+  description?: string | null;
+  icon_url?: string | null;
+  points: number;
+  criteria: unknown;
+}
+interface AchievementProgress {
+  achievement_id: string;
+  key: string;
+  progress: number;
+  unlocked: boolean;
+  unlocked_at?: string | null;
+}
+interface Challenge {
+  id: string;
+  key: string;
+  name: string;
+  description?: string | null;
+  starts_at: string;
+  ends_at: string;
+  criteria: unknown;
+  reward: unknown;
+}
+interface ChallengeProgress {
+  challenge_id: string;
+  progress: number;
+  completed: boolean;
+  claimed: boolean;
+  completed_at?: string | null;
+  claimed_at?: string | null;
+}
+interface CurrencyBalance {
+  currency_id: string;
+  key: string;
+  balance: number;
+  updated_at: string;
+}
+interface CurrencyTransaction {
+  id: string;
+  currency_id: string;
+  delta: number;
+  balance_after: number;
+  reason?: string | null;
+  created_at: string;
+}
+interface InventoryItem {
+  id: string;
+  catalog_item_id: string;
+  sku: string;
+  quantity: number;
+  acquired_at: string;
+  metadata: unknown;
+}
+interface PurchaseRequest {
+  sku: string;
+  quantity?: number;
+  currency_key?: string;
+}
+interface ConsumeRequest {
+  item_id: string;
+  quantity: number;
+}
+interface Leaderboard {
+  id: string;
+  key: string;
+  name: string;
+  period: string;
+  direction: string;
+  starts_at?: string | null;
+  ends_at?: string | null;
+}
+interface LeaderboardEntry {
+  rank: number;
+  user_id: string;
+  display_name?: string | null;
+  avatar_url?: string | null;
+  score: number;
+}
+interface Store {
+  id: string;
+  key: string;
+  name: string;
+}
+interface PurchaseOption {
+  id: string;
+  store_id: string;
+  sku: string;
+  name: string;
+  price_cents: number;
+  currency: string;
+  period?: string | null;
+  metadata: unknown;
+}
+interface PurchaseResult {
+  id: string;
+  user_id: string;
+  purchase_option_id: string;
+  status: string;
+  purchased_at: string;
+  receipt: unknown;
+}
+interface XpBalance {
+  user_id: string;
+  total_xp: number;
+  current_level: number;
+  xp_into_level: number;
+  xp_to_next_level: number;
+  updated_at: string;
+  /**
+   * XP earned in the current rolling window. Window defined by the
+   * project's XP rules; value comes straight from `user_xp.xp_this_period`.
+   * Older servers without the field decode as `0`.
+   */
+  xp_this_period: number;
+}
+interface XpTransaction {
+  id: string;
+  delta: number;
+  reason?: string | null;
+  source?: string | null;
+  created_at: string;
+}
+interface Streak {
+  id: string;
+  key: string;
+  name: string;
+  current_length: number;
+  longest_length: number;
+  last_qualified_on?: string | null;
+  updated_at: string;
+  /**
+   * Server-computed lifecycle state: `"active"`, `"qualified_today"`,
+   * `"broken"`, or `"frozen"`. Empty string when decoded against an older
+   * server that didn't emit it.
+   */
+  status: string;
+  /** Unused streak-freeze count (auto-granted per the streak definition). */
+  freezes_remaining: number;
+}
+interface FeedItem {
+  id: string;
+  actor_id: string;
+  verb: string;
+  object_type: string;
+  object_id: string;
+  target_type?: string | null;
+  target_id?: string | null;
+  data: unknown;
+  created_at: string;
+}
+interface FeedResponse {
+  data: FeedItem[];
+  next_cursor?: string | null;
+}
+type FriendshipState = "pending" | "accepted" | "blocked" | "declined";
+interface Friendship {
+  id: string;
+  user_id: string;
+  friend_id: string;
+  state: FriendshipState;
+  created_at: string;
+}
+interface Group {
+  id: string;
+  name: string;
+  description?: string | null;
+  avatar_url?: string | null;
+  created_by: string;
+  member_count: number;
+  created_at: string;
+  updated_at: string;
+  metadata: unknown;
+}
+interface GroupMember {
+  group_id: string;
+  user_id: string;
+  role: string;
+  joined_at: string;
+}
+interface GroupCreate {
+  name: string;
+  description?: string;
+  avatar_url?: string;
+  metadata?: unknown;
+}
+interface GroupUpdate {
+  name?: string;
+  description?: string;
+  avatar_url?: string;
+  metadata?: unknown;
+}
+interface Message {
+  id: string;
+  conversation_id: string;
+  sender_id: string;
+  body: string;
+  metadata: unknown;
+  created_at: string;
+}
+interface Conversation {
+  id: string;
+  participants: string[];
+  last_message?: Message | null;
+  created_at: string;
+  updated_at: string;
+}
+interface SendMessageRequest {
+  conversation_id?: string | null;
+  to_user_id?: string | null;
+  body: string;
+  metadata?: unknown;
+}
+interface Report {
+  id: string;
+  reporter_id: string;
+  target_type: string;
+  target_id: string;
+  reason: string;
+  status: string;
+  notes?: string | null;
+  created_at: string;
+  resolved_at?: string | null;
+}
+interface ReportRequest {
+  target_id: string;
+  reason: string;
+  notes?: string;
+}
+interface ReferralCode {
+  id: string;
+  code: string;
+  owner_id: string;
+  uses_count: number;
+  max_uses?: number | null;
+  expires_at?: string | null;
+  created_at: string;
+}
+interface ReferralClaim {
+  id: string;
+  code_id: string;
+  referrer_id: string;
+  referee_id: string;
+  reward: unknown;
+  claimed_at: string;
+}
+interface Review {
+  id: string;
+  author_id: string;
+  target_type: string;
+  target_id: string;
+  rating: number;
+  title?: string | null;
+  body?: string | null;
+  created_at: string;
+  updated_at: string;
+}
+interface ReviewCreate {
+  target_type: string;
+  target_id: string;
+  rating: number;
+  title?: string;
+  body?: string;
+}
+interface ReviewUpdate {
+  rating?: number;
+  title?: string;
+  body?: string;
+}
+interface Role {
+  id: string;
+  key: string;
+  name: string;
+  permissions: string[];
+}
+interface CatalogItem {
+  id: string;
+  sku: string;
+  name: string;
+  description?: string | null;
+  price_cents?: number | null;
+  currency?: string | null;
+  metadata: unknown;
+}
+interface ContentItem {
+  id: string;
+  channel: string;
+  title?: string | null;
+  body?: string | null;
+  data: unknown;
+  published_at: string;
+  user_state: unknown;
+}
+interface DeepLink {
+  id: string;
+  url: string;
+  short_code: string;
+  target_path?: string | null;
+  metadata: unknown;
+  created_at: string;
+}
+interface DeepLinkCreate {
+  target_path: string;
+  metadata?: unknown;
+  short_code?: string;
+}
+interface OnboardingStatus {
+  current_step: string | null;
+  completed_steps: string[];
+  remaining_steps: string[];
+  completed: boolean;
+  completed_at?: string | null;
+}
+//#endregion
+//#region src/error.d.ts
+/**
+ * Typed error class for the amba SDK + helper that converts arbitrary
+ * thrown values (WASM JsError, native Error, plain objects) into a
+ * stable `AmbaApiError` instance.
+ *
+ * Callers can `instanceof`-narrow safely, branch on `.code`, and pull
+ * extra payload from `.details` (raw HTTP body, validation field paths,
+ * etc.). The wrapper methods on `Amba` wrap every async call in
+ * `toAmbaApiError`, so consumers see one error shape regardless of
+ * which layer (network, FFI, validation) failed.
+ */
+/**
+ * Stable error codes surfaced by the SDK. Strings rather than an enum
+ * so customers can extend with custom codes by simply throwing
+ * `new AmbaApiError("MY_CODE", "...")` without coordinating with this
+ * package's TypeScript types.
+ */
+type AmbaApiErrorCode = "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "CONFLICT" | "RATE_LIMITED" | "VALIDATION_ERROR" | "NETWORK_ERROR" | "HTTP_ERROR" | "CIRCUIT_OPEN" | "CONSENT_NOT_GRANTED" | "NOT_INITIALIZED" | "INVALID_CONFIG" | "INVALID_ARGUMENT" | "PUSH_PERMISSION_DENIED" | "PUSH_REGISTRATION_FAILED" | "UNKNOWN_ERROR" | (string & {});
+declare class AmbaApiError extends Error {
+  readonly code: AmbaApiErrorCode;
+  readonly details?: unknown;
+  constructor(code: AmbaApiErrorCode, message: string, details?: unknown);
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * Top-level SDK namespace for React Native.
+ *
+ * Differences from `@layers/amba-web`:
+ * - `configure` is async (waits for WASM init AND AsyncStorage hydration).
+ * - Persistence is AsyncStorage-backed — identity survives app restarts.
+ */
+declare const Amba: {
+  configure: (config: AmbaConfig) => Promise<void>;
+  readonly anonymousId: string;
+  readonly appUserId: string | undefined;
+  readonly isAuthenticated: boolean;
+  setDebug: (enabled: boolean) => void;
+  events: {
+    track: (event: string, properties?: Record<string, unknown>) => Promise<void>;
+  };
+  auth: {
+    signInAnonymously: () => Promise<AuthResult>;
+    signInWithEmail: (email: string, password: string) => Promise<AuthResult>;
+    signUpWithEmail: (email: string, password: string) => Promise<AuthResult>;
+    /**
+     * Sign in with an Apple / Google identity token. The host app obtains
+     * the token via `expo-apple-authentication` or `expo-auth-session`.
+     */
+    signInWithSocial: (provider: SocialProvider, idToken: string) => Promise<AuthResult>;
+    signOut: (rotateAnonymousId?: boolean) => Promise<void>;
+    refresh: () => Promise<AuthResult>;
+    me: () => Promise<User>;
+    /** Snapshot the current session, or null if not authenticated. */
+    getSession: () => Promise<Session | null>;
+    /** Stable anonymous identifier. */
+    getAnonymousId: () => Promise<string>;
+    /**
+     * Subscribe to session changes. Fires after every signIn* / signUp* /
+     * refresh / signOut. Returns an unsubscribe function.
+     */
+    onAuthStateChange: (cb: (session: Session | null) => void) => (() => void);
+  };
+  collections: {
+    find: <T = unknown>(name: string, options?: FindOptions) => Promise<FindResponse<T>>;
+    findOne: <T = unknown>(name: string, id: string) => Promise<T>;
+    insert: <T = unknown>(name: string, row: Record<string, unknown>) => Promise<T>;
+    update: <T = unknown>(name: string, id: string, set: Record<string, unknown>) => Promise<T>;
+    delete: (name: string, id: string) => Promise<{
+      data: {
+        deleted: boolean;
+      };
+    }>;
+    where: {
+      eq: (column: string, value: FilterValue) => Filter;
+      ne: (column: string, value: FilterValue) => Filter;
+      gt: (column: string, value: FilterValue) => Filter;
+      gte: (column: string, value: FilterValue) => Filter;
+      lt: (column: string, value: FilterValue) => Filter;
+      lte: (column: string, value: FilterValue) => Filter;
+      in: (column: string, values: FilterValue[]) => Filter;
+      notIn: (column: string, values: FilterValue[]) => Filter;
+      like: (column: string, pattern: string) => Filter;
+      ilike: (column: string, pattern: string) => Filter;
+      isNull: (column: string) => Filter;
+      isNotNull: (column: string) => Filter;
+      and: (...filters: Filter[]) => Filter;
+      or: (...filters: Filter[]) => Filter;
+      not: (filter: Filter) => Filter;
+    };
+  };
+  storage: {
+    presign: (params: {
+      bucket: string;
+      filename: string;
+      mimeType: string;
+      sizeBytes: number;
+      retentionDays?: number;
+    }) => Promise<PresignData>;
+    commit: (uploadId: string, assetId: string) => Promise<MediaAsset>;
+  };
+  push: {
+    /**
+     * Register a native push token. On iOS, pass the APNs token from
+     * `expo-notifications` `getDevicePushTokenAsync()` with platform `'apns'`.
+     * On Android, pass the FCM token with platform `'fcm'`.
+     */
+    register: (token: string, platform: PushPlatform, bundleId?: string) => Promise<PushToken>;
+    unregister: (token: string) => Promise<void>;
+    getTokens: () => Promise<PushToken[]>;
+    subscribe: (topic: string) => Promise<void>;
+    unsubscribe: (topic: string) => Promise<void>;
+  };
+  entitlements: {
+    list: () => Promise<UserEntitlement[]>;
+    has: (name: string) => Promise<boolean>;
+  };
+  ai: {
+    anthropic: {
+      messages: {
+        create: (request: AiMessageRequest) => Promise<AiMessageResponse>;
+      };
+    };
+  };
+  config: {
+    fetch: () => Promise<ConfigBundle>;
+  };
+  flags: {
+    fetch: () => Promise<FlagAssignment[]>;
+  };
+  achievements: {
+    getAll: () => Promise<Achievement[]>;
+    getProgress: () => Promise<AchievementProgress[]>;
+  };
+  challenges: {
+    getActive: () => Promise<Challenge[]>;
+    get: (id: string) => Promise<Challenge>;
+    getProgress: (id: string) => Promise<ChallengeProgress>;
+    claim: (id: string) => Promise<ChallengeProgress>;
+  };
+  currencies: {
+    getBalance: () => Promise<CurrencyBalance[]>;
+    getTransactions: (currencyKey: string) => Promise<CurrencyTransaction[]>;
+  };
+  inventory: {
+    getItems: () => Promise<InventoryItem[]>;
+    getItem: (id: string) => Promise<InventoryItem>;
+    purchase: (request: PurchaseRequest) => Promise<InventoryItem>;
+    consume: (request: ConsumeRequest) => Promise<InventoryItem>;
+  };
+  leaderboards: {
+    get: (key: string) => Promise<Leaderboard>;
+    getEntries: (key: string, limit?: number) => Promise<LeaderboardEntry[]>;
+    getMyRank: (key: string) => Promise<LeaderboardEntry>;
+  };
+  stores: {
+    list: () => Promise<Store[]>;
+    getPurchaseOptions: (storeKey: string) => Promise<PurchaseOption[]>;
+    purchase: (storeKey: string, purchaseOptionId: string, receipt: unknown) => Promise<PurchaseResult>;
+  };
+  xp: {
+    getBalance: () => Promise<XpBalance>;
+    getHistory: (limit?: number) => Promise<XpTransaction[]>;
+    claim: (grantKey: string) => Promise<XpTransaction>;
+  };
+  streaks: {
+    getAll: () => Promise<Streak[]>;
+    qualify: (streakKey: string) => Promise<Streak>;
+  };
+  feeds: {
+    getActivity: (feed?: string, cursor?: string) => Promise<FeedResponse>;
+  };
+  friends: {
+    getList: () => Promise<Friendship[]>;
+    getFriends: () => Promise<Friendship[]>;
+    blockUser: (userId: string) => Promise<Friendship>;
+    unblockUser: (userId: string) => Promise<void>;
+    removeBlock: (friendshipId: string) => Promise<void>;
+  };
+  groups: {
+    create: (params: GroupCreate) => Promise<Group>;
+    get: (id: string) => Promise<Group>;
+    update: (id: string, patch: GroupUpdate) => Promise<Group>;
+    delete: (id: string) => Promise<void>;
+    getMembers: (id: string) => Promise<GroupMember[]>;
+    join: (id: string) => Promise<GroupMember>;
+    leave: (id: string) => Promise<void>;
+    invite: (id: string, userId: string) => Promise<GroupMember>;
+  };
+  messaging: {
+    getConversations: () => Promise<Conversation[]>;
+    getMessage: (id: string) => Promise<Message>;
+    sendMessage: (request: SendMessageRequest) => Promise<Message>;
+  };
+  moderation: {
+    reportUser: (request: ReportRequest) => Promise<Report>;
+    reportContent: (request: ReportRequest) => Promise<Report>;
+    getReportStatus: (id: string) => Promise<Report>;
+  };
+  reviews: {
+    list: (targetType: string, targetId: string) => Promise<Review[]>;
+    create: (params: ReviewCreate) => Promise<Review>;
+    update: (id: string, patch: ReviewUpdate) => Promise<Review>;
+    delete: (id: string) => Promise<void>;
+  };
+  roles: {
+    getMyRoles: () => Promise<Role[]>;
+    hasPermission: (permission: string) => Promise<boolean>;
+  };
+  referrals: {
+    getReferralCode: () => Promise<ReferralCode>;
+    claimReferral: (code: string) => Promise<ReferralClaim>;
+    create: (code?: string, maxUses?: number) => Promise<ReferralCode>;
+  };
+  catalog: {
+    list: () => Promise<CatalogItem[]>;
+  };
+  content: {
+    /**
+     * Get today's published item for `channel`. Defaults to `"default"`
+     * so single-channel apps can call `Amba.content.getToday()` bare.
+     */
+    getToday: (channel?: string) => Promise<ContentItem | null>;
+    /**
+     * Paginated library list for `channel`. `options.limit` caps page size;
+     * `options.cursor` is the opaque token returned by a prior page.
+     */
+    getLibrary: (channel?: string, options?: {
+      limit?: number;
+      cursor?: string;
+    }) => Promise<ContentItem[]>;
+    getItem: (id: string) => Promise<ContentItem>;
+    updateItem: (id: string, state: unknown) => Promise<ContentItem>;
+    createItem: (channel: string, item: unknown) => Promise<ContentItem>;
+  };
+  deepLinks: {
+    get: (shortCode: string) => Promise<DeepLink>;
+    create: (params: DeepLinkCreate) => Promise<DeepLink>;
+  };
+  onboarding: {
+    getStatus: () => Promise<OnboardingStatus>;
+    nextStep: (payload: unknown) => Promise<OnboardingStatus>;
+    skipStep: () => Promise<OnboardingStatus>;
+    complete: () => Promise<OnboardingStatus>;
+  };
+};
+declare const SDK_VERSION = "0.1.0";
+//#endregion
+export { Achievement, AchievementProgress, AiMessage, AiMessageRequest, AiMessageResponse, AiUsage, Amba, AmbaApiError, type AmbaApiErrorCode, AmbaConfig, AndFilter, AuthResult, CatalogItem, Challenge, ChallengeProgress, ConditionFilter, ConfigBundle, ConsumeRequest, ContentItem, Conversation, CurrencyBalance, CurrencyTransaction, DeepLink, DeepLinkCreate, EntitlementSource, FeedItem, FeedResponse, Filter, FilterValue, FindOptions, FindResponse, FlagAssignment, Friendship, FriendshipState, Group, GroupCreate, GroupMember, GroupUpdate, InventoryItem, Leaderboard, LeaderboardEntry, MediaAsset, Message, NotFilter, OnboardingStatus, OrFilter, OrderBy, PresignData, PurchaseOption, PurchaseRequest, PurchaseResult, PushPlatform, PushToken, ReferralClaim, ReferralCode, Report, ReportRequest, Review, ReviewCreate, ReviewUpdate, Role, SDK_VERSION, SendMessageRequest, Session, SocialProvider, Store, Streak, User, UserEntitlement, XpBalance, XpTransaction };
+//# sourceMappingURL=index.d.cts.map