Skip to content
This repository was archived by the owner on Jul 2, 2025. It is now read-only.

Commit d9b5270

Browse files
authored
Update example API keys (#48)
1 parent 491ac3e commit d9b5270

File tree

2 files changed

+22
-16
lines changed

2 files changed

+22
-16
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55

66
The official [UserHub](https://userhub.com) JavaScript SDK.
77

8-
Stability: alpha
9-
108
### Requirements
119

1210
- Node 18 or later
@@ -26,7 +24,7 @@ Example
2624
```ts
2725
import { AdminApi } from "@userhub/sdk";
2826

29-
const adminApi = new AdminApi("sk_123");
27+
const adminApi = new AdminApi("userhub_admin_123");
3028

3129
const res = await adminApi.users.list({ pageSize: 5 });
3230

test/node/basics.test.ts

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ test("API GET", async () => {
6666
},
6767
});
6868

69-
const adminApi = new AdminApi("sk_test", { baseUrl });
69+
const adminApi = new AdminApi("userhub_admin_test", { baseUrl });
7070

7171
const res = await adminApi.users.get({ userId: "usr_1" });
7272
expect(res).toHaveProperty("id", "usr_1");
@@ -78,7 +78,9 @@ test("API GET", async () => {
7878
expect(requests[0].headers["userhub-api-version"]).equal(
7979
constants.API_VERSION,
8080
);
81-
expect(requests[0].headers["authorization"]).equal("Bearer sk_test");
81+
expect(requests[0].headers["authorization"]).equal(
82+
"Bearer userhub_admin_test",
83+
);
8284
expect(requests[0].headers["content-type"]).toBeUndefined();
8385
expect(requests[0].headers["user-agent"]).equal(constants.USER_AGENT);
8486

@@ -95,7 +97,7 @@ test("API POST", async () => {
9597
},
9698
});
9799

98-
const adminApi = new AdminApi("sk_test", { baseUrl });
100+
const adminApi = new AdminApi("userhub_admin_test", { baseUrl });
99101

100102
const res = await adminApi.users.create({ displayName: "Jane Doe" });
101103
expect(res).toHaveProperty("id", "usr_1");
@@ -107,7 +109,9 @@ test("API POST", async () => {
107109
expect(requests[0].headers["userhub-api-version"]).equal(
108110
constants.API_VERSION,
109111
);
110-
expect(requests[0].headers["authorization"]).equal("Bearer sk_test");
112+
expect(requests[0].headers["authorization"]).equal(
113+
"Bearer userhub_admin_test",
114+
);
111115
expect(requests[0].headers["content-type"]).equal("application/json");
112116
expect(requests[0].headers["user-agent"]).equal(constants.USER_AGENT);
113117
expect(JSON.parse(requests[0].body)).eql({ displayName: "Jane Doe" });
@@ -121,7 +125,7 @@ test("API PATCH", async () => {
121125
},
122126
});
123127

124-
const adminApi = new AdminApi("sk_test", { baseUrl });
128+
const adminApi = new AdminApi("userhub_admin_test", { baseUrl });
125129

126130
const res = await adminApi.users.update({
127131
userId: "usr_1",
@@ -137,7 +141,9 @@ test("API PATCH", async () => {
137141
expect(requests[0].headers["userhub-api-version"]).equal(
138142
constants.API_VERSION,
139143
);
140-
expect(requests[0].headers["authorization"]).equal("Bearer sk_test");
144+
expect(requests[0].headers["authorization"]).equal(
145+
"Bearer userhub_admin_test",
146+
);
141147
expect(requests[0].headers["content-type"]).equal("application/json");
142148
expect(requests[0].headers["user-agent"]).equal(constants.USER_AGENT);
143149
expect(JSON.parse(requests[0].body)).eql({ displayName: "" });
@@ -158,7 +164,7 @@ test("API DELETE", async () => {
158164
},
159165
});
160166

161-
const adminApi = new AdminApi("sk_test", { baseUrl });
167+
const adminApi = new AdminApi("userhub_admin_test", { baseUrl });
162168

163169
const res = await adminApi.users.delete({ userId: "usr_1" });
164170
expect(res).toHaveProperty("id", "usr_1");
@@ -170,7 +176,9 @@ test("API DELETE", async () => {
170176
expect(requests[0].headers["userhub-api-version"]).equal(
171177
constants.API_VERSION,
172178
);
173-
expect(requests[0].headers["authorization"]).equal("Bearer sk_test");
179+
expect(requests[0].headers["authorization"]).equal(
180+
"Bearer userhub_admin_test",
181+
);
174182
expect(requests[0].headers["content-type"]).toBeUndefined();
175183
expect(requests[0].headers["user-agent"]).equal(constants.USER_AGENT);
176184
expect(requests[0].body).equal("");
@@ -193,7 +201,7 @@ test("API error", async () => {
193201
statusCode: 404,
194202
});
195203

196-
const adminApi = new AdminApi("sk_test", { baseUrl });
204+
const adminApi = new AdminApi("userhub_admin_test", { baseUrl });
197205

198206
let error: unknown;
199207
try {
@@ -223,7 +231,7 @@ testSlow("API rate limited", async () => {
223231
statusCode: 429,
224232
});
225233

226-
const adminApi = new AdminApi("sk_test", { baseUrl });
234+
const adminApi = new AdminApi("userhub_admin_test", { baseUrl });
227235

228236
const startTime = Date.now();
229237

@@ -260,7 +268,7 @@ test("Abort retry", async () => {
260268
statusCode: 429,
261269
});
262270

263-
const adminApi = new AdminApi("sk_test", { baseUrl });
271+
const adminApi = new AdminApi("userhub_admin_test", { baseUrl });
264272
const signal = AbortSignal.timeout(50);
265273
const startTime = Date.now();
266274

@@ -291,7 +299,7 @@ test("Abort request", async () => {
291299
delay: 1000,
292300
});
293301

294-
const adminApi = new AdminApi("sk_test", { baseUrl });
302+
const adminApi = new AdminApi("userhub_admin_test", { baseUrl });
295303
const signal = AbortSignal.timeout(50);
296304

297305
let error: unknown;
@@ -314,7 +322,7 @@ test("Retry network error", async () => {
314322
closeImmediately: true,
315323
});
316324

317-
const adminApi = new AdminApi("sk_test", { baseUrl });
325+
const adminApi = new AdminApi("userhub_admin_test", { baseUrl });
318326

319327
const controller = new AbortController();
320328
const timeout = setTimeout(controller.abort.bind(controller), 200);

0 commit comments

Comments
 (0)