@theholocron/clerk-client 1.32.0 → 1.33.0

package/dist/index.d.mts

@@ -0,0 +1,183 @@
+import "@theholocron/http-client";
+import { ErrorSink, Logger } from "@theholocron/observability/core";
+//#region ../../../../../src/utils.d.ts
+interface ClerkClientOptions {
+  /** Clerk secret key (sk_live_... or sk_test_...). */
+  token: string;
+  /** Override base URL for testing. Defaults to https://api.clerk.com/v1. */
+  baseUrl?: string;
+  /** Override fetch for testing. Defaults to globalThis.fetch. */
+  fetch?: typeof fetch;
+  /** Structured logger for request/response diagnostics. Defaults to a no-op. */
+  logger?: Logger;
+  /** Reports transport failures and unexpected 5xx. Defaults to a no-op. */
+  errors?: ErrorSink;
+}
+//#endregion
+//#region ../../../../../src/instance/instance.d.ts
+interface ClerkInstance {
+  id?: string;
+  object?: string;
+  environment_type?: "development" | "production" | "staging" | string;
+}
+//#endregion
+//#region ../../../../../src/users/users.d.ts
+interface ClerkEmailAddress {
+  id: string;
+  object: "email_address";
+  email_address: string;
+  verification: {
+    status: string;
+    strategy: string;
+  } | null;
+  linked_to: Array<{
+    id: string;
+    type: string;
+  }>;
+  created_at: number;
+  updated_at: number;
+}
+interface ClerkPhoneNumber {
+  id: string;
+  object: "phone_number";
+  phone_number: string;
+  reserved_for_second_factor: boolean;
+  default_second_factor: boolean;
+  verification: {
+    status: string;
+    strategy: string;
+  } | null;
+  linked_to: Array<{
+    id: string;
+    type: string;
+  }>;
+  created_at: number;
+  updated_at: number;
+}
+interface ClerkUser {
+  id: string;
+  object: "user";
+  external_id: string | null;
+  primary_email_address_id: string | null;
+  primary_phone_number_id: string | null;
+  primary_web3_wallet_id: string | null;
+  username: string | null;
+  first_name: string | null;
+  last_name: string | null;
+  profile_image_url: string;
+  image_url: string;
+  has_image: boolean;
+  public_metadata: Record<string, unknown>;
+  private_metadata: Record<string, unknown>;
+  unsafe_metadata: Record<string, unknown>;
+  email_addresses: ClerkEmailAddress[];
+  phone_numbers: ClerkPhoneNumber[];
+  last_sign_in_at: number | null;
+  banned: boolean;
+  locked: boolean;
+  lockout_expires_in_seconds: number | null;
+  verification_attempts_remaining: number | null;
+  created_at: number;
+  updated_at: number;
+  password_enabled: boolean;
+  two_factor_enabled: boolean;
+  totp_enabled: boolean;
+  backup_code_enabled: boolean;
+}
+interface ClerkUserCount {
+  object: "total_count";
+  total_count: number;
+}
+interface ClerkDeletedObject {
+  object: string;
+  id: string;
+  slug?: string;
+  deleted: boolean;
+}
+interface ClerkUsersListParams {
+  limit?: number;
+  offset?: number;
+  email_address?: string[];
+  phone_number?: string[];
+  username?: string[];
+  external_id?: string[];
+  user_id?: string[];
+  query?: string;
+  last_active_at_since?: number;
+  order_by?: string;
+}
+interface CreateClerkUserInput {
+  external_id?: string;
+  first_name?: string;
+  last_name?: string;
+  email_address?: string[];
+  phone_number?: string[];
+  web3_wallet?: string[];
+  username?: string;
+  password?: string;
+  password_digest?: string;
+  password_hasher?: string;
+  skip_password_checks?: boolean;
+  skip_password_requirement?: boolean;
+  totp_secret?: string;
+  backup_codes?: string[];
+  public_metadata?: Record<string, unknown>;
+  private_metadata?: Record<string, unknown>;
+  unsafe_metadata?: Record<string, unknown>;
+  created_at?: string;
+}
+interface UpdateClerkUserInput {
+  external_id?: string;
+  first_name?: string;
+  last_name?: string;
+  username?: string;
+  password?: string;
+  primary_email_address_id?: string;
+  notify_primary_email_address_changed?: boolean;
+  primary_phone_number_id?: string;
+  primary_web3_wallet_id?: string;
+  profile_image_id?: string;
+  public_metadata?: Record<string, unknown>;
+  private_metadata?: Record<string, unknown>;
+  unsafe_metadata?: Record<string, unknown>;
+  totp_secret?: string;
+  backup_codes?: string[];
+  delete_self_enabled?: boolean;
+  create_organization_enabled?: boolean;
+}
+//#endregion
+//#region ../../../../../src/webhooks/webhooks.d.ts
+interface ClerkSvixApp {
+  svix_app_id?: string;
+}
+/** Older Clerk instances return `svix_url`; newer return `url`. */
+interface ClerkSvixUrl {
+  url?: string;
+  svix_url?: string;
+}
+//#endregion
+//#region ../../../../../src/index.d.ts
+declare function createClerkClient(opts: ClerkClientOptions): {
+  instance: {
+    get: () => Promise<ClerkInstance>;
+  };
+  users: {
+    list: (params?: ClerkUsersListParams) => Promise<ClerkUser[]>;
+    count: (params?: Pick<ClerkUsersListParams, "email_address" | "phone_number" | "username" | "external_id" | "user_id" | "query">) => Promise<ClerkUserCount>;
+    get: (id: string) => Promise<ClerkUser>;
+    create: (data: CreateClerkUserInput) => Promise<ClerkUser>;
+    update: (id: string, data: UpdateClerkUserInput) => Promise<ClerkUser>;
+    delete: (id: string) => Promise<ClerkDeletedObject>;
+    ban: (id: string) => Promise<ClerkUser>;
+    unban: (id: string) => Promise<ClerkUser>;
+    lock: (id: string) => Promise<ClerkUser>;
+    unlock: (id: string) => Promise<ClerkUser>;
+  };
+  webhooks: {
+    ensureSvixApp: () => Promise<ClerkSvixApp>;
+    getSvixUrl: () => Promise<ClerkSvixUrl>;
+  };
+};
+type ClerkClient = ReturnType<typeof createClerkClient>;
+//#endregion
+export { ClerkClient, type ClerkClientOptions, type ClerkDeletedObject, type ClerkEmailAddress, type ClerkInstance, type ClerkPhoneNumber, type ClerkSvixApp, type ClerkSvixUrl, type ClerkUser, type ClerkUserCount, type ClerkUsersListParams, type CreateClerkUserInput, type UpdateClerkUserInput, createClerkClient };

package/dist/index.mjs

@@ -0,0 +1,81 @@
+import { createRestClient } from "@theholocron/http-client";
+//#region ../../../../../src/instance/instance.ts
+function instance(rest) {
+	return { get: () => rest.request("/instance") };
+}
+//#endregion
+//#region ../../../../../src/users/users.ts
+const PATH$1 = "/users";
+function buildUsersQuery(params) {
+	const qs = new URLSearchParams();
+	if (params.limit !== void 0) qs.set("limit", String(params.limit));
+	if (params.offset !== void 0) qs.set("offset", String(params.offset));
+	if (params.query) qs.set("query", params.query);
+	if (params.order_by) qs.set("order_by", params.order_by);
+	if (params.last_active_at_since !== void 0) qs.set("last_active_at_since", String(params.last_active_at_since));
+	for (const v of params.email_address ?? []) qs.append("email_address", v);
+	for (const v of params.phone_number ?? []) qs.append("phone_number", v);
+	for (const v of params.username ?? []) qs.append("username", v);
+	for (const v of params.external_id ?? []) qs.append("external_id", v);
+	for (const v of params.user_id ?? []) qs.append("user_id", v);
+	return qs.toString();
+}
+function users(rest) {
+	return {
+		list: (params = {}) => {
+			const q = buildUsersQuery(params);
+			return rest.request(q ? `${PATH$1}?${q}` : PATH$1);
+		},
+		count: (params = {}) => {
+			const q = buildUsersQuery(params);
+			return rest.request(q ? `${PATH$1}/count?${q}` : `${PATH$1}/count`);
+		},
+		get: (id) => rest.request(`${PATH$1}/${id}`),
+		create: (data) => rest.request(PATH$1, {
+			method: "POST",
+			body: data
+		}),
+		update: (id, data) => rest.request(`${PATH$1}/${id}`, {
+			method: "PATCH",
+			body: data
+		}),
+		delete: (id) => rest.request(`${PATH$1}/${id}`, { method: "DELETE" }),
+		ban: (id) => rest.request(`${PATH$1}/${id}/ban`, { method: "POST" }),
+		unban: (id) => rest.request(`${PATH$1}/${id}/unban`, { method: "POST" }),
+		lock: (id) => rest.request(`${PATH$1}/${id}/lock`, { method: "POST" }),
+		unlock: (id) => rest.request(`${PATH$1}/${id}/unlock`, { method: "POST" })
+	};
+}
+//#endregion
+//#region ../../../../../src/utils.ts
+function createClerkRestClient(opts) {
+	return createRestClient({
+		baseUrl: opts.baseUrl ?? "https://api.clerk.com/v1",
+		token: opts.token,
+		vendor: "Clerk",
+		fetch: opts.fetch,
+		logger: opts.logger,
+		errors: opts.errors
+	});
+}
+//#endregion
+//#region ../../../../../src/webhooks/webhooks.ts
+const PATH = "/webhooks";
+function webhooks(rest) {
+	return {
+		ensureSvixApp: () => rest.request(`${PATH}/svix`, { method: "POST" }),
+		getSvixUrl: () => rest.request(`${PATH}/svix_url`, { method: "POST" })
+	};
+}
+//#endregion
+//#region ../../../../../src/index.ts
+function createClerkClient(opts) {
+	const rest = createClerkRestClient(opts);
+	return {
+		instance: instance(rest),
+		users: users(rest),
+		webhooks: webhooks(rest)
+	};
+}
+//#endregion
+export { createClerkClient };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/clerk-client",
-  "version": "1.32.0",
+  "version": "1.33.0",
   "description": "A TypeScript client for the Clerk Backend API",
   "keywords": [
     "clerk",
@@ -33,13 +33,13 @@
   ],
   "dependencies": {
     "@theholocron/observability": "^0.3.0",
-    "@theholocron/http-client": "^1.32.0"
+    "@theholocron/http-client": "^1.33.0"
   },
   "devDependencies": {
     "@theholocron/cli": "5.0.0-alpha.79",
     "@theholocron/eslint-config": "^8.4.3",
     "@theholocron/tsconfig": "^8.2.0",
-    "@theholocron/tsdown-config": "^8.5.2",
+    "@theholocron/tsdown-config": "^8.6.1",
     "@theholocron/vitest-config": "^8.2.0",
     "@types/node": "^26.4.1",
     "@vitest/coverage-v8": "^5.0.0",