@clivly/sdk 0.1.0 → 0.2.0

package/dist/index.cjs

@@ -0,0 +1,494 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_drizzle_meta = require("./drizzle-meta-C0T6F3vL.cjs");
+//#region src/doctor.ts
+function configuredSources(config) {
+	const sources = [];
+	if (config.source?.contacts) sources.push(config.source.contacts);
+	if (config.source?.companies) sources.push(config.source.companies);
+	return sources;
+}
+/**
+* Run the six read-only setup checks and return a structured report. Every check
+* captures its own error into `detail` rather than throwing, so one failure never
+* hides the rest. `ok` is the AND of all non-skipped checks.
+*/
+async function runDoctor(args) {
+	const { config, connect } = args;
+	const checks = [];
+	const sources = configuredSources(config);
+	const hasKey = Boolean(config.apiKey);
+	checks.push({
+		name: "API key present",
+		ok: hasKey,
+		detail: hasKey ? "CLIVLY_API_KEY is set." : "apiKey is empty — set CLIVLY_API_KEY."
+	});
+	const entityCount = config.entities ? Object.keys(config.entities.entities).length : 0;
+	checks.push({
+		name: "Entities configured",
+		ok: entityCount > 0,
+		detail: entityCount > 0 ? `${entityCount} entit${entityCount === 1 ? "y" : "ies"} configured.` : "No `entities` config — pass defineClivlyConfig(...) as `entities`."
+	});
+	checks.push({
+		name: "Sources configured",
+		ok: sources.length > 0,
+		detail: sources.length > 0 ? `${sources.length} source(s) to mirror.` : "No `source.contacts` — nothing to sync."
+	});
+	for (const source of sources) {
+		const meta = source[require_drizzle_meta.DRIZZLE_META];
+		if (!meta) {
+			checks.push({
+				name: `Cursor/id columns exist (${source.entity})`,
+				ok: false,
+				skipped: true,
+				detail: `"${source.entity}" is a hand-written source — column check skipped.`
+			});
+			continue;
+		}
+		const idField = source.idField ?? "id";
+		const missing = [meta.cursorField, idField].filter((field) => !meta.columnKeys.includes(field));
+		checks.push({
+			name: `Cursor/id columns exist (${source.entity})`,
+			ok: missing.length === 0,
+			detail: missing.length === 0 ? `"${source.entity}": ${meta.cursorField} + ${idField} present.` : `"${source.entity}" missing column(s): ${missing.join(", ")}.`
+		});
+	}
+	for (const source of sources) try {
+		const rows = await source.fetchPage({
+			since: null,
+			limit: 1
+		});
+		const firstRow = rows[0];
+		const missingCursor = firstRow !== void 0 && !(source.cursorField in firstRow);
+		checks.push({
+			name: `Sample fetch (${source.entity})`,
+			ok: !missingCursor,
+			detail: missingCursor ? `"${source.entity}" rows lack the cursor key "${source.cursorField}".` : `"${source.entity}" returned ${rows.length} row(s).`
+		});
+	} catch (error) {
+		checks.push({
+			name: `Sample fetch (${source.entity})`,
+			ok: false,
+			detail: `"${source.entity}" fetchPage threw: ${error.message}`
+		});
+	}
+	const result = await connect();
+	checks.push({
+		name: "Heartbeat",
+		ok: result.ok,
+		detail: result.ok ? `Reached Clivly — org "${result.org?.name ?? "(unnamed)"}".` : `Could not connect (${result.reason}).`
+	});
+	return {
+		ok: checks.every((check) => check.skipped || check.ok),
+		checks
+	};
+}
+//#endregion
+//#region src/sync.ts
+const DEFAULT_ID_FIELD = "id";
+function isAfter(candidate, current) {
+	const ct = candidate.time.getTime();
+	const bt = current.time.getTime();
+	if (ct !== bt) return ct > bt;
+	return candidate.id > current.id;
+}
+function nextCursor(rows, cursorField, idField, current) {
+	let max = current;
+	for (const row of rows) {
+		const raw = row[cursorField];
+		if (raw === null || raw === void 0) continue;
+		const time = raw instanceof Date ? raw : new Date(String(raw));
+		if (Number.isNaN(time.getTime())) continue;
+		const idRaw = row[idField];
+		const candidate = {
+			time,
+			id: idRaw === null || idRaw === void 0 ? "" : String(idRaw)
+		};
+		if (!max || isAfter(candidate, max)) max = candidate;
+	}
+	return max;
+}
+async function syncSource(args) {
+	const { source, path, since, batchSize, push } = args;
+	const idField = source.idField ?? DEFAULT_ID_FIELD;
+	let cursor = since;
+	let pushed = 0;
+	for (;;) {
+		const rows = await source.fetchPage({
+			since: cursor,
+			limit: batchSize
+		});
+		if (rows.length === 0) break;
+		if (!await push(path, {
+			source: source.entity,
+			rows,
+			mode: "delta"
+		})) return {
+			pushed,
+			cursor,
+			ok: false
+		};
+		pushed += rows.length;
+		cursor = nextCursor(rows, source.cursorField, idField, cursor);
+		if (rows.length < batchSize) break;
+	}
+	return {
+		pushed,
+		cursor,
+		ok: true
+	};
+}
+async function fullSyncSource(args) {
+	const { source, path, batchSize, push } = args;
+	const idField = source.idField ?? DEFAULT_ID_FIELD;
+	const all = [];
+	let cursor = null;
+	for (;;) {
+		const rows = await source.fetchPage({
+			since: cursor,
+			limit: batchSize
+		});
+		if (rows.length === 0) break;
+		all.push(...rows);
+		const next = nextCursor(rows, source.cursorField, idField, cursor);
+		const stalled = next !== null && cursor !== null && next.time.getTime() === cursor.time.getTime() && next.id === cursor.id;
+		cursor = next;
+		if (rows.length < batchSize || stalled) break;
+	}
+	if (all.length === 0) return {
+		pushed: 0,
+		cursor: null,
+		ok: true
+	};
+	const ok = await push(path, {
+		source: source.entity,
+		rows: all,
+		mode: "full"
+	});
+	return {
+		pushed: ok ? all.length : 0,
+		cursor,
+		ok
+	};
+}
+//#endregion
+//#region src/errors.ts
+var ClivlyError = class ClivlyError extends Error {
+	/** HTTP status, or null when the request never completed (network error). */
+	status;
+	reason;
+	/** Whether a retry could plausibly succeed (network, 429, 5xx). */
+	retryable;
+	constructor(result, message) {
+		super(message ?? `Clivly connection failed: ${result.reason}`);
+		this.name = new.target.name;
+		this.status = result.status;
+		this.reason = result.reason;
+		this.retryable = result.retryable;
+	}
+	/**
+	* Build the error subclass matching a failed result's reason, or `null` when
+	* the result is `ok`.
+	*/
+	static from(result) {
+		if (result.ok) return null;
+		switch (result.reason) {
+			case "invalid_api_key":
+			case "forbidden": return new ClivlyAuthError(result);
+			case "rate_limited": return new ClivlyRateLimitError(result);
+			case "network_error": return new ClivlyNetworkError(result);
+			default: return new ClivlyError(result);
+		}
+	}
+};
+/** The API key was rejected (401) or lacks access (403). Not retryable. */
+var ClivlyAuthError = class extends ClivlyError {};
+/** Rate limited (429). Retryable after backoff / `Retry-After`. */
+var ClivlyRateLimitError = class extends ClivlyError {};
+/** The request never reached the server (network/DNS/TLS). Retryable. */
+var ClivlyNetworkError = class extends ClivlyError {};
+//#endregion
+//#region src/index.ts
+const DEFAULT_API_URL = "https://api.clivly.com";
+const DEFAULT_HEARTBEAT_MS = 6e4;
+const DEFAULT_BATCH_SIZE = 500;
+const DEFAULT_MAX_ATTEMPTS = 3;
+const DEFAULT_BASE_DELAY_MS = 500;
+const RETRYABLE_STATUS_FLOOR = 500;
+const RATE_LIMITED_STATUS = 429;
+const SYNC_CONTACTS_PATH = "/clivly/sdk/sync/contacts";
+const SYNC_COMPANIES_PATH = "/clivly/sdk/sync/companies";
+const TRAILING_SLASH = /\/$/;
+const BEARER_PREFIX = /^Bearer\s+/i;
+function entitiesToTables(entities, byName) {
+	if (!entities) return;
+	for (const entity of Object.values(entities.entities)) {
+		const columns = byName.get(entity.source) ?? /* @__PURE__ */ new Set();
+		for (const sourceColumn of Object.values(entity.fields)) columns.add(sourceColumn);
+		byName.set(entity.source, columns);
+	}
+}
+function resolveContactEntity(config) {
+	if (config.contactEntity) return config.contactEntity;
+	for (const entity of Object.values(config.entities?.entities ?? {})) if (entity.concept === "contact") return entity.source;
+}
+function buildSchema(config) {
+	const byName = /* @__PURE__ */ new Map();
+	for (const table of config.schema ?? []) {
+		const columns = byName.get(table.name) ?? /* @__PURE__ */ new Set();
+		for (const column of table.columns) columns.add(column);
+		byName.set(table.name, columns);
+	}
+	entitiesToTables(config.entities, byName);
+	if (config.contactEntity && !byName.has(config.contactEntity)) byName.set(config.contactEntity, new Set(config.contactFields ?? []));
+	return [...byName].map(([name, columns]) => ({
+		name,
+		columns: [...columns]
+	}));
+}
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+function createMemoryCursorStore() {
+	const cursors = /* @__PURE__ */ new Map();
+	return {
+		get: (entity) => cursors.get(entity) ?? null,
+		set: (entity, cursor) => {
+			cursors.set(entity, cursor);
+		}
+	};
+}
+function isLikelyServerless() {
+	const runtime = globalThis;
+	if (runtime.navigator?.userAgent === "Cloudflare-Workers") return true;
+	if (runtime.EdgeRuntime !== void 0) return true;
+	const env = runtime.process?.env;
+	return Boolean(env?.AWS_LAMBDA_FUNCTION_NAME || env?.VERCEL);
+}
+function jsonResponse(body, status) {
+	return new Response(JSON.stringify(body), {
+		status,
+		headers: { "content-type": "application/json" }
+	});
+}
+function timingSafeEqual(a, b) {
+	if (a.length !== b.length) return false;
+	let mismatch = 0;
+	for (let i = 0; i < a.length; i++) mismatch += a.charCodeAt(i) === b.charCodeAt(i) ? 0 : 1;
+	return mismatch === 0;
+}
+function bearerToken(req) {
+	const header = req.headers.get("authorization");
+	if (!(header && BEARER_PREFIX.test(header))) return null;
+	return header.replace(BEARER_PREFIX, "").trim();
+}
+function isRetryableStatus(status) {
+	return status === RATE_LIMITED_STATUS || status >= RETRYABLE_STATUS_FLOOR;
+}
+const UNAUTHORIZED_STATUS = 401;
+const FORBIDDEN_STATUS = 403;
+const CLIENT_ERROR_FLOOR = 400;
+const SERVICE_UNAVAILABLE_STATUS = 503;
+function connectReason(status) {
+	if (status === UNAUTHORIZED_STATUS) return "invalid_api_key";
+	if (status === FORBIDDEN_STATUS) return "forbidden";
+	if (status === RATE_LIMITED_STATUS) return "rate_limited";
+	if (status >= RETRYABLE_STATUS_FLOOR) return "server_error";
+	if (status >= CLIENT_ERROR_FLOOR) return "client_error";
+	return "server_error";
+}
+async function resolveOrg(response) {
+	try {
+		return (await response.json())?.org;
+	} catch {
+		return;
+	}
+}
+function retryAfterMs(res) {
+	const header = res.headers.get("retry-after");
+	if (!header) return null;
+	const seconds = Number(header);
+	if (!Number.isNaN(seconds)) return Math.max(0, seconds * 1e3);
+	const date = Date.parse(header);
+	return Number.isNaN(date) ? null : Math.max(0, date - Date.now());
+}
+function createFetcher(retry) {
+	const maxAttempts = Math.max(1, retry?.maxAttempts ?? DEFAULT_MAX_ATTEMPTS);
+	const baseDelayMs = retry?.baseDelayMs ?? DEFAULT_BASE_DELAY_MS;
+	return async (url, init) => {
+		for (let attempt = 1;; attempt++) {
+			let res = null;
+			try {
+				res = await fetch(url, init);
+			} catch {
+				res = null;
+			}
+			if (!(res === null || isRetryableStatus(res.status)) || attempt >= maxAttempts) return res;
+			const backoff = baseDelayMs * 2 ** (attempt - 1) + Math.random() * baseDelayMs;
+			await sleep(res ? retryAfterMs(res) ?? backoff : backoff);
+		}
+	};
+}
+/**
+* Create the Clivly SDK. The implemented surface — heartbeat/discovery reporting
+* and the auth-verify handler — connects a developer's app to a running Clivly
+* backend today. Tunnel management and CRM write-back are scaffolded (see the
+* clearly-marked TODOs) and land with the Cloudflare infrastructure.
+*/
+function createClivlySDK(config) {
+	const apiUrl = (config.apiUrl ?? DEFAULT_API_URL).replace(TRAILING_SLASH, "");
+	const heartbeatIntervalMs = config.heartbeatIntervalMs ?? DEFAULT_HEARTBEAT_MS;
+	const syncIntervalMs = config.sync?.intervalMs ?? heartbeatIntervalMs;
+	const timers = {
+		heartbeat: null,
+		sync: null
+	};
+	const batchSize = config.sync?.batchSize ?? DEFAULT_BATCH_SIZE;
+	const cursorStore = config.cursorStore ?? createMemoryCursorStore();
+	const fetcher = createFetcher(config.retry);
+	const push = async (path, body) => {
+		return (await fetcher(`${apiUrl}${path}`, {
+			method: "POST",
+			headers: {
+				"content-type": "application/json",
+				authorization: `Bearer ${config.apiKey}`
+			},
+			body: JSON.stringify(body)
+		}))?.ok ?? false;
+	};
+	const syncOne = async (source, path, mode) => {
+		const since = mode === "full" ? null : await cursorStore.get(source.entity) ?? null;
+		const result = mode === "full" ? await fullSyncSource({
+			source,
+			path,
+			batchSize,
+			push
+		}) : await syncSource({
+			source,
+			path,
+			since,
+			batchSize,
+			push
+		});
+		await cursorStore.set(source.entity, result.cursor);
+		return result.ok;
+	};
+	const runSync = async (options) => {
+		if (!config.source) return;
+		const mode = options?.mode ?? "delta";
+		const failed = [];
+		if (config.source.companies) {
+			if (!await syncOne(config.source.companies, SYNC_COMPANIES_PATH, mode)) failed.push(config.source.companies.entity);
+		}
+		if (!await syncOne(config.source.contacts, SYNC_CONTACTS_PATH, mode)) failed.push(config.source.contacts.entity);
+		if (failed.length > 0) throw new Error(`Clivly sync: push failed for ${failed.join(", ")}`);
+	};
+	const sendHeartbeat = () => fetcher(`${apiUrl}/clivly/sdk/heartbeat`, {
+		method: "POST",
+		headers: {
+			"content-type": "application/json",
+			authorization: `Bearer ${config.apiKey}`
+		},
+		body: JSON.stringify({
+			framework: config.framework,
+			orm: config.orm,
+			sdkVersion: config.sdkVersion,
+			contactEntity: resolveContactEntity(config),
+			namespaceReady: config.namespaceReady ?? false,
+			schema: buildSchema(config)
+		})
+	});
+	const heartbeat = async () => {
+		return (await sendHeartbeat())?.ok ?? false;
+	};
+	const connect = async () => {
+		const response = await sendHeartbeat();
+		if (response === null) return {
+			ok: false,
+			status: null,
+			reason: "network_error",
+			retryable: true
+		};
+		if (response.ok) return {
+			ok: true,
+			status: response.status,
+			reason: "ok",
+			retryable: false,
+			org: await resolveOrg(response)
+		};
+		return {
+			ok: false,
+			status: response.status,
+			reason: connectReason(response.status),
+			retryable: isRetryableStatus(response.status)
+		};
+	};
+	const doctor = () => runDoctor({
+		config,
+		connect
+	});
+	const runScheduled = async (options) => {
+		await heartbeat();
+		if (config.source) await runSync(options);
+	};
+	const createClivlyHandler = () => async (_req) => {
+		try {
+			await runScheduled();
+			return jsonResponse({ ok: true }, 200);
+		} catch (error) {
+			return jsonResponse({
+				ok: false,
+				error: error instanceof Error ? error.message : String(error)
+			}, 500);
+		}
+	};
+	const start = async () => {
+		if (isLikelyServerless()) console.warn("clivly.start() uses a setInterval keep-alive loop, which does not persist on serverless/edge runtimes — it will stop ticking after the first response. Call clivly.runScheduled() from a scheduled/cron trigger, or mount clivly.createClivlyHandler() at a route instead.");
+		await heartbeat();
+		if (config.sync?.onBoot !== false) await runSync().catch(() => {});
+		if (!timers.heartbeat) {
+			timers.heartbeat = setInterval(() => {
+				heartbeat().catch(() => {});
+			}, heartbeatIntervalMs);
+			timers.heartbeat.unref?.();
+		}
+		if (!timers.sync && config.source) {
+			timers.sync = setInterval(() => {
+				runSync().catch(() => {});
+			}, syncIntervalMs);
+			timers.sync.unref?.();
+		}
+	};
+	const stop = () => {
+		if (timers.heartbeat) {
+			clearInterval(timers.heartbeat);
+			timers.heartbeat = null;
+		}
+		if (timers.sync) {
+			clearInterval(timers.sync);
+			timers.sync = null;
+		}
+	};
+	const createAuthVerifyHandler = (resolveUser) => async (req) => {
+		if (!config.verifyToken) return jsonResponse({ error: "Clivly verifyToken is not configured on the host app" }, SERVICE_UNAVAILABLE_STATUS);
+		const token = bearerToken(req);
+		if (!(token && timingSafeEqual(token, config.verifyToken))) return jsonResponse({ error: "unauthorized" }, 401);
+		const user = await resolveUser(req);
+		if (!user) return jsonResponse({ error: "unauthorized" }, 401);
+		return jsonResponse(user, 200);
+	};
+	return {
+		start,
+		stop,
+		heartbeat,
+		connect,
+		doctor,
+		runScheduled,
+		createClivlyHandler,
+		sync: runSync,
+		createAuthVerifyHandler
+	};
+}
+//#endregion
+exports.ClivlyAuthError = ClivlyAuthError;
+exports.ClivlyError = ClivlyError;
+exports.ClivlyNetworkError = ClivlyNetworkError;
+exports.ClivlyRateLimitError = ClivlyRateLimitError;
+exports.createClivlySDK = createClivlySDK;

package/dist/index.d.cts

@@ -0,0 +1,33 @@
+import { a as ClivlyUser, c as DoctorCheck, i as ClivlySDKConfig, l as DoctorReport, n as ClivlyConnectResult, o as CursorStore, r as ClivlySDK, s as DiscoveredTable, t as ClivlyConnectReason } from "./types-B0aSxJ6V.cjs";
+
+//#region src/errors.d.ts
+declare class ClivlyError extends Error {
+  /** HTTP status, or null when the request never completed (network error). */
+  readonly status: number | null;
+  readonly reason: ClivlyConnectResult["reason"];
+  /** Whether a retry could plausibly succeed (network, 429, 5xx). */
+  readonly retryable: boolean;
+  constructor(result: ClivlyConnectResult, message?: string);
+  /**
+   * Build the error subclass matching a failed result's reason, or `null` when
+   * the result is `ok`.
+   */
+  static from(result: ClivlyConnectResult): ClivlyError | null;
+}
+/** The API key was rejected (401) or lacks access (403). Not retryable. */
+declare class ClivlyAuthError extends ClivlyError {}
+/** Rate limited (429). Retryable after backoff / `Retry-After`. */
+declare class ClivlyRateLimitError extends ClivlyError {}
+/** The request never reached the server (network/DNS/TLS). Retryable. */
+declare class ClivlyNetworkError extends ClivlyError {}
+//#endregion
+//#region src/index.d.ts
+/**
+ * Create the Clivly SDK. The implemented surface — heartbeat/discovery reporting
+ * and the auth-verify handler — connects a developer's app to a running Clivly
+ * backend today. Tunnel management and CRM write-back are scaffolded (see the
+ * clearly-marked TODOs) and land with the Cloudflare infrastructure.
+ */
+declare function createClivlySDK(config: ClivlySDKConfig): ClivlySDK;
+//#endregion
+export { ClivlyAuthError, type ClivlyConnectReason, type ClivlyConnectResult, ClivlyError, ClivlyNetworkError, ClivlyRateLimitError, type ClivlySDK, type ClivlySDKConfig, type ClivlyUser, type CursorStore, type DiscoveredTable, type DoctorCheck, type DoctorReport, createClivlySDK };

package/dist/index.d.mts

@@ -1,130 +1,25 @@
-import { ClivlyEntitiesConfig } from "@clivly/core";
+import { a as ClivlyUser, c as DoctorCheck, i as ClivlySDKConfig, l as DoctorReport, n as ClivlyConnectResult, o as CursorStore, r as ClivlySDK, s as DiscoveredTable, t as ClivlyConnectReason } from "./types-DWt-ytBQ.mjs";
 
-//#region src/types.d.ts
-interface DiscoveredTable {
-  columns: string[];
-  name: string;
-}
-interface ClivlySDKConfig {
-  /** Org-scoped API token (sk_live_…) from Settings → API keys. */
-  apiKey: string;
-  /** Clivly API base URL. Defaults to https://api.clivly.com. */
-  apiUrl?: string;
-  /**
-   * The host table Clivly treats as the contact entity.
-   * @deprecated Prefer `entities` — the same mapping-derived shape
-   * `crm_entity_mappings` (and `@clivly/core`'s `mappingsToEntitiesConfig`)
-   * produce, so the SDK, the mappings table, and the sync engine share one
-   * model. A bare `contactEntity` is treated as a single contact entity.
-   */
-  contactEntity?: string;
-  /** Which columns of the contact entity Clivly may read. */
-  contactFields?: string[];
-  /**
-   * Declarative entity config — the single source of truth shared with
-   * `crm_entity_mappings`. When set, discovery and heartbeat are derived from
-   * it (each entity's `source` table + mapped columns), superseding the flat
-   * `contactEntity`.
-   */
-  entities?: ClivlyEntitiesConfig;
-  /** Reported to the portal so it can show the detected stack. */
-  framework?: string;
-  /** Heartbeat cadence in ms. Defaults to 60s. */
-  heartbeatIntervalMs?: number;
-  /** Whether the crm_* namespace exists in the host DB (self-reported). */
-  namespaceReady?: boolean;
-  orm?: string;
-  /**
-   * Network retry policy for outbound calls (heartbeat + sync push). Transient
-   * failures (network errors, HTTP 429, HTTP 5xx) are retried with exponential
-   * backoff + jitter; a `Retry-After` header on a 429 is honoured. Non-transient
-   * responses (e.g. 4xx other than 429) are returned immediately, not retried.
-   */
-  retry?: {
-    /** Total attempts including the first. Defaults to 3. Min 1. */maxAttempts?: number; /** Base backoff in ms (doubled each attempt). Defaults to 500. */
-    baseDelayMs?: number;
-  };
-  /** Tables/columns to report for entity discovery + mapping. */
-  schema?: DiscoveredTable[];
-  sdkVersion?: string;
-  /** Host entities to mirror into Clivly Cloud. */
-  source?: {
-    contacts: SyncSource;
-    companies?: SyncSource;
-  };
-  sync?: {
-    onBoot?: boolean;
-    /**
-     * Sync cadence in ms for the background keep-alive loop. Defaults to
-     * `heartbeatIntervalMs` (60s) so sync and heartbeat share a tick unless you
-     * decouple them — e.g. a slow full-mirror alongside frequent heartbeats.
-     */
-    intervalMs?: number;
-    batchSize?: number;
-  };
-  /** Cloudflare Tunnel token — reserved for write-back/tunnel mode. */
-  tunnelToken?: string;
-  /**
-   * Shared secret Clivly Cloud presents (as `Authorization: Bearer <token>`) when
-   * calling the `/clivly/auth/verify` endpoint. Required for the verify handler to
-   * authenticate the caller; without it the handler fails closed (HTTP 500).
-   */
-  verifyToken?: string;
-  writeBack?: {
-    enabled?: boolean; /** Only crm_* tables are ever accepted; this narrows further. */
-    tables?: string[];
-  };
-}
-interface ClivlyUser {
-  email: string;
-  id: string;
-  name?: string;
-}
-interface SyncCursor {
-  /** The row's id, breaking ties when timestamps collide. */
-  id: string;
-  /** The row's cursor-field value (typically `updated_at`). */
-  time: Date;
-}
-interface SyncSource {
-  cursorField: string;
-  entity: string;
-  fetchPage(args: {
-    since: SyncCursor | null;
-    limit: number;
-  }): Promise<Record<string, unknown>[]>;
-  /** Stable, unique tie-breaker column for keyset paging. Defaults to "id". */
-  idField?: string;
-}
-type SyncMode = "delta" | "full";
-interface ClivlySDK {
-  /**
-   * Build the `/clivly/auth/verify` handler the developer mounts in their app.
-   * Clivly's cloud calls it to validate a CRM user's identity against the host
-   * app's session. Pass a resolver that reads the host session from the request.
-   *
-   * The handler authenticates the caller against `config.verifyToken` (presented
-   * as `Authorization: Bearer <token>`) before invoking the resolver, so the
-   * endpoint can't be used by third parties to probe host sessions. It fails
-   * closed with HTTP 500 if `verifyToken` is unset.
-   */
-  createAuthVerifyHandler(resolveUser: (req: Request) => Promise<ClivlyUser | null> | ClivlyUser | null): (req: Request) => Promise<Response>;
-  /** Send a single heartbeat now. Returns true on success. */
-  heartbeat(): Promise<boolean>;
-  /** Connect: send the initial heartbeat and start the keep-alive loop. */
-  start(): Promise<void>;
-  /** Stop the keep-alive loop. */
-  stop(): void;
+//#region src/errors.d.ts
+declare class ClivlyError extends Error {
+  /** HTTP status, or null when the request never completed (network error). */
+  readonly status: number | null;
+  readonly reason: ClivlyConnectResult["reason"];
+  /** Whether a retry could plausibly succeed (network, 429, 5xx). */
+  readonly retryable: boolean;
+  constructor(result: ClivlyConnectResult, message?: string);
   /**
-   * Sync all configured sources now. `delta` (default) pages changed rows since
-   * the last cursor; `full` pushes each complete entity so the server can
-   * reconcile leavers (archive-on-leave). Throws if a push fails, so callers see
-   * the failure — the background keep-alive loop swallows and retries instead.
+   * Build the error subclass matching a failed result's reason, or `null` when
+   * the result is `ok`.
    */
-  sync(options?: {
-    mode?: SyncMode;
-  }): Promise<void>;
+  static from(result: ClivlyConnectResult): ClivlyError | null;
 }
+/** The API key was rejected (401) or lacks access (403). Not retryable. */
+declare class ClivlyAuthError extends ClivlyError {}
+/** Rate limited (429). Retryable after backoff / `Retry-After`. */
+declare class ClivlyRateLimitError extends ClivlyError {}
+/** The request never reached the server (network/DNS/TLS). Retryable. */
+declare class ClivlyNetworkError extends ClivlyError {}
 //#endregion
 //#region src/index.d.ts
 /**
@@ -135,4 +30,4 @@ interface ClivlySDK {
  */
 declare function createClivlySDK(config: ClivlySDKConfig): ClivlySDK;
 //#endregion
-export { type ClivlySDK, type ClivlySDKConfig, type ClivlyUser, type DiscoveredTable, createClivlySDK };
+export { ClivlyAuthError, type ClivlyConnectReason, type ClivlyConnectResult, ClivlyError, ClivlyNetworkError, ClivlyRateLimitError, type ClivlySDK, type ClivlySDKConfig, type ClivlyUser, type CursorStore, type DiscoveredTable, type DoctorCheck, type DoctorReport, createClivlySDK };