@theholocron/clerk-client 0.3.2 → 0.5.0

package/dist/index.d.mts

@@ -3,10 +3,19 @@ import "@theholocron/http-client";
 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;
 }
 //#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;
@@ -132,8 +141,21 @@ interface UpdateClerkUserInput {
   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>;
@@ -146,7 +168,11 @@ declare function createClerkClient(opts: ClerkClientOptions): {
     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 ClerkPhoneNumber, type ClerkUser, type ClerkUserCount, type ClerkUsersListParams, type CreateClerkUserInput, type UpdateClerkUserInput, createClerkClient };
+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

@@ -2,15 +2,20 @@ import { createRestClient } from "@theholocron/http-client";
 //#region src/utils.ts
 function createClerkRestClient(opts) {
 	return createRestClient({
-		baseUrl: "https://api.clerk.com/v1",
+		baseUrl: opts.baseUrl ?? "https://api.clerk.com/v1",
 		token: opts.token,
 		vendor: "Clerk",
 		fetch: opts.fetch
 	});
 }
 //#endregion
+//#region src/instance/instance.ts
+function instance(rest) {
+	return { get: () => rest.request("/instance") };
+}
+//#endregion
 //#region src/users/users.ts
-const PATH = "/users";
+const PATH$1 = "/users";
 function buildUsersQuery(params) {
 	const qs = new URLSearchParams();
 	if (params.limit !== void 0) qs.set("limit", String(params.limit));
@@ -29,32 +34,46 @@ function users(rest) {
 	return {
 		list: (params = {}) => {
 			const q = buildUsersQuery(params);
-			return rest.request(q ? `${PATH}?${q}` : PATH);
+			return rest.request(q ? `${PATH$1}?${q}` : PATH$1);
 		},
 		count: (params = {}) => {
 			const q = buildUsersQuery(params);
-			return rest.request(q ? `${PATH}/count?${q}` : `${PATH}/count`);
+			return rest.request(q ? `${PATH$1}/count?${q}` : `${PATH$1}/count`);
 		},
-		get: (id) => rest.request(`${PATH}/${id}`),
-		create: (data) => rest.request(PATH, {
+		get: (id) => rest.request(`${PATH$1}/${id}`),
+		create: (data) => rest.request(PATH$1, {
 			method: "POST",
 			body: data
 		}),
-		update: (id, data) => rest.request(`${PATH}/${id}`, {
+		update: (id, data) => rest.request(`${PATH$1}/${id}`, {
 			method: "PATCH",
 			body: data
 		}),
-		delete: (id) => rest.request(`${PATH}/${id}`, { method: "DELETE" }),
-		ban: (id) => rest.request(`${PATH}/${id}/ban`, { method: "POST" }),
-		unban: (id) => rest.request(`${PATH}/${id}/unban`, { method: "POST" }),
-		lock: (id) => rest.request(`${PATH}/${id}/lock`, { method: "POST" }),
-		unlock: (id) => rest.request(`${PATH}/${id}/unlock`, { method: "POST" })
+		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/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) {
-	return { users: users(createClerkRestClient(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": "0.3.2",
+  "version": "0.5.0",
   "description": "A TypeScript client for the Clerk Backend API",
   "homepage": "https://github.com/theholocron/clients/tree/main/packages/clerk-client#readme",
   "bugs": "https://github.com/theholocron/clients/issues",