RafikiDB JS / TypeScript SDK#

import { createClient } from "@rafikidb/sdk";

export const db = createClient({
  projectId: "5c73dab0-...",
  apiKey: "raf_live_...",
  baseUrl: "https://api.rafikidb.com/api/v1", // optional
  persistSession: true, // localStorage key: rafikidb_session.{projectId}
});

// Read with filters
const { data } = await db
  .from<Profile>("profiles")
  .select("id, nationality")
  .eq("nationality", "Tanzania")
  .gt("age", 18)
  .in("region", ["dar", "mba"])
  .order("created_at", { ascending: false })
  .limit(25)
  .execute();

// Filters: eq, neq, gt, gte, lt, lte, like, ilike, isNull, isNotNull, in
// Pagination: limit, offset, cursor(id) (keyset, for large tables)
// Single row: .get(id), first row: .single(), count: .head()

const { data } = await db
  .from("messages")
  .select("id, message, users.full_name")
  .join({
    type: "LEFT JOIN", // INNER | LEFT | RIGHT | FULL
    table: "users",
    from_column: "user_id",
    to_column: "id",
  })
  .limit(20)
  .execute();

await db.from("profiles").insert({ full_name: "Asha", nationality: "Tanzania" }); // single or array
await db.from("profiles").eq("id", id).update({ nationality: "Kenya" });
await db.from("profiles").eq("id", id).delete();

// Sign up / sign in (session auto-stored, sent with every request -> RLS)
const res = await db.auth.signup({ email, password, full_name, phone, metadata });
const session = await db.auth.login({ email, password }); // alias: signin

// OTP / reset
await db.auth.otpRequest("+255712345678");
await db.auth.otpVerify({ phone, code, full_name });
await db.auth.resetPassword(email);
await db.auth.confirmResetPassword({ email, code, new_password });

// Session
db.getSession();                 // Session { user, tokens } | null
db.setSession(session);          // manual restore/persist
db.subscribeSession((s) => {});  // unsubscribe fn returned
db.auth.signOut();               // clears + unpersists
db.auth.refresh(refreshToken);   // rotates tokens
db.auth.logout(refreshToken);

const sub = db.realtime.subscribe(
  "messages",
  (event) => {
    // event: { id, type: "INSERT"|"UPDATE"|"DELETE", table, project_id, record, old_record?, created_at }
    console.log(event.type, event.record);
  },
  { events: ["INSERT", "DELETE"], transport: "auto" } // auto | centrifugo | sse
);
sub.unsubscribe();

// Storage
await db.storage.createBucket({ name, slug, is_public, file_size_limit, allowed_mime_types });
await db.storage.listBuckets();
await db.storage.signedUploadUrl({ bucket_id, object_name, content_length });
await db.storage.signedDownloadUrl(objectId);
db.storage.publicUrl(bucketId, objectId);

// Env vars
await db.env.set("STRIPE_KEY", "sk_test_123", "production");
await db.env.bulkSet("development", { DEBUG: "true" });

// Secrets (write-only)
await db.secrets.set({ key: "API_SECRET", value: "s3cr3t", description });
await db.secrets.reveal(secretId);

// Webhooks
await db.webhooks.create({ name, url, events, secret });
await db.webhooks.listDeliveries(webhookId);

// Edge functions
await db.functions.create({ name, runtime: "javascript", code });
await db.functions.deploy(fnId);
await db.functions.invoke(fnId, { method: "POST", body: "{}" });

// Payments (Snippe + M-Pesa)
await db.payments.stkPush({ phone: "+255712345678", amount: 5000, description });
await db.payments.snippeSession({ amount, redirect_url, order_id });
await db.payments.snippeStatus(reference);

import { useAuth } from "@rafikidb/sdk/react";

const { user, session, signOut } = useAuth(); // reacts to db session changes