quickbase-js 1.0.1-beta.0 → 1.1.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/dist/{quickbaseClient.d.ts → quickbase.d.ts} +344 -339
  3. package/dist/{quickbaseClient.js → quickbase.js} +350 -266
  4. package/dist/quickbase.js.map +1 -0
  5. package/examples/react.js +42 -16
  6. package/examples/vanillajs.html +32 -8
  7. package/log-gen.yaml +3513 -0
  8. package/package.json +13 -9
  9. package/rollup.config.js +2 -2
  10. package/src/code-generation/fix-spec-definitions.ts +473 -66
  11. package/src/code-generation/fix-spec-paths.ts +210 -18
  12. package/src/code-generation/generate-unified-interface.ts +1 -8
  13. package/src/code-generation/output/quickbase-fixed.json +783 -1138
  14. package/src/generated-unified/QuickbaseClient.ts +10 -9
  15. package/src/log-gen.ts +82 -35
  16. package/src/quickbaseClient.ts +39 -42
  17. package/test-artifacts/test-results.json +173 -1145
  18. package/tests/playwright/qb/auth/cacheSwitching.test.ts +4 -4
  19. package/tests/playwright/qb/auth/fetchTempToken401.test.ts +2 -2
  20. package/tests/playwright/qb/auth/getAppWithUserToken.test.ts +2 -2
  21. package/tests/playwright/qb/auth/getTempToken.test.ts +2 -2
  22. package/tests/playwright/qb/auth/tokenPrefetch.test.ts +2 -2
  23. package/tests/playwright/qb/auth/tokenRenewal.test.ts +2 -2
  24. package/tests/setup.ts +37 -9
  25. package/tests/vitest/qb/apps/getApp.test.ts +37 -43
  26. package/tests/vitest/qb/fields/getFields.test.ts +3 -5
  27. package/tests/vitest/qb/records/deleteRecords.test.ts +78 -0
  28. package/tests/vitest/qb/records/runQuery.test.ts +82 -0
  29. package/tests/vitest/qb/records/upsert.test.ts +72 -0
  30. package/tests/vitest/qb/tables/createTable.test.ts +55 -0
  31. package/tests/vitest/qb/tables/deleteTable.test.ts +50 -0
  32. package/tests/vitest/qb/tables/getAppTables.test.ts +43 -64
  33. package/tests/vitest/qb/tables/getTable.test.ts +26 -0
  34. package/tests/vitest/qb/tables/updateTable.test.ts +48 -0
  35. package/tests/vitest/unit/apps/getApp.test.ts +17 -12
  36. package/tests/vitest/unit/auth/fetchTempToken401.test.ts +32 -6
  37. package/tests/vitest/unit/auth/getTempToken.test.ts +36 -24
  38. package/tests/vitest/unit/auth/retryOn401.test.ts +39 -5
  39. package/tests/vitest/unit/auth/two401s.test.ts +1 -1
  40. package/tests/vitest/unit/fields/getFields.test.ts +14 -7
  41. package/tests/vitest/unit/records/deleteRecords.test.ts +112 -0
  42. package/tests/vitest/unit/records/runQuery.test.ts +102 -0
  43. package/tests/vitest/unit/records/upsert.test.ts +218 -0
  44. package/tests/vitest/unit/tables/createTable.test.ts +70 -0
  45. package/tests/vitest/unit/tables/deleteTable.test.ts +77 -0
  46. package/tests/vitest/unit/tables/getAppTables.test.ts +41 -28
  47. package/tests/vitest/unit/tables/getTable.test.ts +233 -0
  48. package/tests/vitest/unit/tables/updateTable.test.ts +80 -0
  49. package/tsconfig.json +3 -2
  50. package/vitest.config.ts +8 -2
  51. package/dist/quickbaseClient.js.map +0 -1
  52. package/logGen.yaml +0 -1820
  53. package/src/utils.ts +0 -5
package/log-gen.yaml ADDED
@@ -0,0 +1,3513 @@
1
+ project: quickbase-js
2
+ date: 3/11/2025
3
+ root: /home/drew/Projects/quickbase-js
4
+ goals:
5
+ - A library for interacting with the QuickBase RESTful API.
6
+ - Use OpenAPI to generate types and methods using a proxy. Validate with tests.
7
+ - Provide robust and intuitive temporary token support for browser environments.
8
+ - User Tokens support both Node.js and browser environments.
9
+ - 'Use case: JS frameworks like React, Vue, and Angular hosted in QuickBase code pages.'
10
+ - Enable a flexible or native fetch in the browser.
11
+ - Enable a flexible fetch framework in Node.js.
12
+ - '#'
13
+ - No manual updating methods when the QuickBase API changes.
14
+ - The proxy magic dynamically maps generated methods and types.
15
+ - '#'
16
+ - TokenCache is defined per quickbaseClient call, so each instance has its own isolated TokenCache.
17
+ - Each quickbase client instance has an isolated and individual token cache.
18
+ pipelineOverview:
19
+ - 'fix-spec-main.ts: Input: Reads the latest QuickBase_RESTful*.json file from the specs/ folder and applies fixes to the parameters and paths.'
20
+ - filters out the QB-Realm-Hostname, Authorization, and User-Agent parameters.
21
+ - Converts parameter names to camelCase.
22
+ - Fixes array schemas and applies custom paths.
23
+ - Merges paths from fix-spec-paths.ts and definitions from fix-spec-definitions.ts.
24
+ - 'Output: writes quickbase-fixed.json to src/code-generation/output/.'
25
+ - 'Key Behavior: The merge (spec.paths = { ...spec.paths, ...paths }) preserves all origional endpoints, only overriding those defined in fix-spec-paths.ts.'
26
+ - '#'
27
+ - 'regenerate-client.ts: Uses quickbase-fixed.json to generate raw TypeScript-fetch files (src/generated/). including models and APIs.'
28
+ - '#'
29
+ - 'generate-unified-interface.ts: Uses quickbase-fixed.json to generate a unified QuickbaseClient.ts interface in src/generated-unified/.'
30
+ - QuickbaseClient.ts includes all endpoints from src/code-generation/output/quickbase-fixed, and types from src/generated.
31
+ - '#'
32
+ - /specs/QuickBase_RESTful_API_*.json is over 46k lines of JSON, so it's not included in the snapshot, its too large to give to an AI.
33
+ - which creates difficulties in understanding the structure of the API.
34
+ - It makes it difficult to model the src/code-generation/fix-spec-*.ts files in the snapshot.
35
+ - '#'
36
+ - vitest unit and integration tests. Integration tests use the real QuickBase API with user token auth.
37
+ - playwright is used to test the real QuickBase API in a browser enviornment with temporary token auth.
38
+ - temp tokens can only be generated in a browser enviornment and can not be fetched with a user token.
39
+ - '#'
40
+ - getTempTokenDBID() method is wrapped to enhance temporary token generation reuse interacting with a token cache.
41
+ - '#'
42
+ - 'npm run fix-spec: Generates quickbase-fixed.json from the latest QuickBase_RESTful*.json file.'
43
+ - 'npm run regenerate: Generates raw TypeScript-fetch files in src/generated/.'
44
+ - 'npm run generate-unified: Generates a unified QuickbaseClient.ts interface in src/generated-unified/.'
45
+ tree:
46
+ name: .
47
+ type: directory
48
+ children:
49
+ - name: .env
50
+ type: file
51
+ - name: .gitignore
52
+ type: file
53
+ - name: CHANGELOG.md
54
+ type: file
55
+ - name: LICENSE
56
+ type: file
57
+ - name: README.md
58
+ type: file
59
+ - name: build.js
60
+ type: file
61
+ - name: dist
62
+ type: directory
63
+ children:
64
+ - name: quickbase.d.ts
65
+ type: file
66
+ - name: quickbase.js
67
+ type: file
68
+ - name: quickbase.js.map
69
+ type: file
70
+ - name: examples
71
+ type: directory
72
+ children:
73
+ - name: react.js
74
+ type: file
75
+ - name: vanillajs.html
76
+ type: file
77
+ - name: log-gen.yaml
78
+ type: file
79
+ - name: openapitools.json
80
+ type: file
81
+ - name: package-lock.json
82
+ type: file
83
+ - name: package.json
84
+ type: file
85
+ - name: playwright.config.ts
86
+ type: file
87
+ - name: rollup.config.js
88
+ type: file
89
+ - name: src
90
+ type: directory
91
+ children:
92
+ - name: code-generation
93
+ type: directory
94
+ children:
95
+ - name: fix-spec-definitions.ts
96
+ type: file
97
+ - name: fix-spec-main.ts
98
+ type: file
99
+ - name: fix-spec-paths.ts
100
+ type: file
101
+ - name: generate-unified-interface.ts
102
+ type: file
103
+ - name: output
104
+ type: directory
105
+ children:
106
+ - name: quickbase-fixed.json
107
+ type: file
108
+ - name: regenerate-client.ts
109
+ type: file
110
+ - name: generated
111
+ type: directory
112
+ children:
113
+ - name: .openapi-generator
114
+ type: directory
115
+ children:
116
+ - name: FILES
117
+ type: file
118
+ - name: VERSION
119
+ type: file
120
+ - name: .openapi-generator-ignore
121
+ type: file
122
+ - name: apis
123
+ type: directory
124
+ children:
125
+ - name: AppsApi.ts
126
+ type: file
127
+ - name: AuditApi.ts
128
+ type: file
129
+ - name: AuthApi.ts
130
+ type: file
131
+ - name: DocumentTemplatesApi.ts
132
+ type: file
133
+ - name: FieldsApi.ts
134
+ type: file
135
+ - name: FilesApi.ts
136
+ type: file
137
+ - name: FormulasApi.ts
138
+ type: file
139
+ - name: PlatformAnalyticsApi.ts
140
+ type: file
141
+ - name: RecordsApi.ts
142
+ type: file
143
+ - name: ReportsApi.ts
144
+ type: file
145
+ - name: SolutionsApi.ts
146
+ type: file
147
+ - name: TablesApi.ts
148
+ type: file
149
+ - name: UserTokenApi.ts
150
+ type: file
151
+ - name: UsersApi.ts
152
+ type: file
153
+ - name: index.ts
154
+ type: file
155
+ - name: index.ts
156
+ type: file
157
+ - name: models
158
+ type: directory
159
+ children:
160
+ - name: AddMembersToGroup200Response.ts
161
+ type: file
162
+ - name: AddSubgroupsToGroup200Response.ts
163
+ type: file
164
+ - name: App.ts
165
+ type: file
166
+ - name: AppMemoryInfo.ts
167
+ type: file
168
+ - name: AppSecurityProperties.ts
169
+ type: file
170
+ - name: Audit200Response.ts
171
+ type: file
172
+ - name: Audit202Response.ts
173
+ type: file
174
+ - name: AuditRequest.ts
175
+ type: file
176
+ - name: CloneUserToken200Response.ts
177
+ type: file
178
+ - name: CloneUserTokenRequest.ts
179
+ type: file
180
+ - name: CopyApp200Response.ts
181
+ type: file
182
+ - name: CopyAppRequest.ts
183
+ type: file
184
+ - name: CreateApp200Response.ts
185
+ type: file
186
+ - name: CreateAppRequest.ts
187
+ type: file
188
+ - name: CreateAppRequestVariablesInner.ts
189
+ type: file
190
+ - name: CreateRelationship200Response.ts
191
+ type: file
192
+ - name: CreateRelationshipRequest.ts
193
+ type: file
194
+ - name: CreateTableRequest.ts
195
+ type: file
196
+ - name: DeactivateUserToken200Response.ts
197
+ type: file
198
+ - name: DeleteFile200Response.ts
199
+ type: file
200
+ - name: DeleteRecords200Response.ts
201
+ type: file
202
+ - name: DeleteRecordsRequest.ts
203
+ type: file
204
+ - name: DeleteRelationship200Response.ts
205
+ type: file
206
+ - name: DeleteTableResponse.ts
207
+ type: file
208
+ - name: DenyUsers200Response.ts
209
+ type: file
210
+ - name: ExchangeSsoToken200Response.ts
211
+ type: file
212
+ - name: ExchangeSsoTokenRequest.ts
213
+ type: file
214
+ - name: Field.ts
215
+ type: file
216
+ - name: FieldPermissionsInner.ts
217
+ type: file
218
+ - name: FieldProperties.ts
219
+ type: file
220
+ - name: GenerateDocument200Response.ts
221
+ type: file
222
+ - name: GetField200Response.ts
223
+ type: file
224
+ - name: GetRelationships200Response.ts
225
+ type: file
226
+ - name: GetReport200Response.ts
227
+ type: file
228
+ - name: GetTempTokenDBID200Response.ts
229
+ type: file
230
+ - name: GetUsers200Response.ts
231
+ type: file
232
+ - name: GetUsersRequest.ts
233
+ type: file
234
+ - name: PlatformAnalyticEventSummaries200Response.ts
235
+ type: file
236
+ - name: PlatformAnalyticEventSummaries200ResponseMetadata.ts
237
+ type: file
238
+ - name: PlatformAnalyticEventSummaries200ResponseResultsInner.ts
239
+ type: file
240
+ - name: PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner.ts
241
+ type: file
242
+ - name: PlatformAnalyticEventSummaries200ResponseResultsInnerTotals.ts
243
+ type: file
244
+ - name: PlatformAnalyticEventSummaries200ResponseTotals.ts
245
+ type: file
246
+ - name: PlatformAnalyticEventSummaries200ResponseWhereInner.ts
247
+ type: file
248
+ - name: PlatformAnalyticEventSummariesRequest.ts
249
+ type: file
250
+ - name: PlatformAnalyticEventSummariesRequestWhereInner.ts
251
+ type: file
252
+ - name: PlatformAnalyticReads200Response.ts
253
+ type: file
254
+ - name: Record.ts
255
+ type: file
256
+ - name: RemoveMembersFromGroup200Response.ts
257
+ type: file
258
+ - name: RemoveSubgroupsFromGroup200Response.ts
259
+ type: file
260
+ - name: ReportRunResponse.ts
261
+ type: file
262
+ - name: RunFormula200Response.ts
263
+ type: file
264
+ - name: RunFormulaRequest.ts
265
+ type: file
266
+ - name: Table.ts
267
+ type: file
268
+ - name: TransferUserToken200Response.ts
269
+ type: file
270
+ - name: TransferUserTokenRequest.ts
271
+ type: file
272
+ - name: UndenyUsers200Response.ts
273
+ type: file
274
+ - name: UpdateFieldRequest.ts
275
+ type: file
276
+ - name: UpdateRelationshipRequest.ts
277
+ type: file
278
+ - name: UpdateTableRequest.ts
279
+ type: file
280
+ - name: Upsert200Response.ts
281
+ type: file
282
+ - name: Upsert200ResponseMetadata.ts
283
+ type: file
284
+ - name: Upsert207Response.ts
285
+ type: file
286
+ - name: Upsert207ResponseMetadata.ts
287
+ type: file
288
+ - name: UpsertRequest.ts
289
+ type: file
290
+ - name: index.ts
291
+ type: file
292
+ - name: runtime.ts
293
+ type: file
294
+ - name: generated-unified
295
+ type: directory
296
+ children:
297
+ - name: QuickbaseClient.ts
298
+ type: file
299
+ - name: index.ts
300
+ type: file
301
+ - name: log-gen.ts
302
+ type: file
303
+ - name: openapi-jars
304
+ type: directory
305
+ children:
306
+ - name: openapi-generator-cli-7.12.0.jar
307
+ type: file
308
+ - name: quickbaseClient.ts
309
+ type: file
310
+ - name: tokenCache.ts
311
+ type: file
312
+ - name: test-artifacts
313
+ type: directory
314
+ children:
315
+ - name: .last-run.json
316
+ type: file
317
+ - name: test-results.json
318
+ type: file
319
+ - name: test-results.json
320
+ type: file
321
+ - name: tests
322
+ type: directory
323
+ children:
324
+ - name: playwright
325
+ type: directory
326
+ children:
327
+ - name: qb
328
+ type: directory
329
+ children:
330
+ - name: auth
331
+ type: directory
332
+ children:
333
+ - name: cacheSwitching.test.ts
334
+ type: file
335
+ contents: |
336
+ // tests/playwright/qb/auth/cacheSwitching.test.ts
337
+ import { test, expect } from "@playwright/test";
338
+ import { quickbase } from "../../../../src/quickbaseClient.ts";
339
+ import fetch from "node-fetch";
340
+ import dotenv from "dotenv";
341
+
342
+ dotenv.config();
343
+
344
+ const loginToQuickbase = async (
345
+ page: import("@playwright/test").Page,
346
+ quickbaseUrl: string,
347
+ username: string,
348
+ password: string
349
+ ): Promise<boolean> => {
350
+ console.log("Logging in to QuickBase");
351
+ let loginSuccess = false;
352
+ const maxLoginAttempts = 3;
353
+ let loginAttempt = 0;
354
+
355
+ while (!loginSuccess && loginAttempt < maxLoginAttempts) {
356
+ try {
357
+ loginAttempt++;
358
+ if (loginAttempt > 1) console.log(`Login attempt ${loginAttempt}`);
359
+
360
+ console.log("Navigating to login page");
361
+ await page.goto(quickbaseUrl, { timeout: 30000 });
362
+ console.log("Waiting for loginid selector");
363
+ await page.waitForSelector("input[name='loginid']", { timeout: 30000 });
364
+ await page.fill("input[name='loginid']", username);
365
+ await page.fill("input[name='password']", password);
366
+ console.log("Clicking signin");
367
+ await page.click("#signin");
368
+ console.log("Waiting for navigation");
369
+ await page.waitForURL(`https://*.quickbase.com/**`, {
370
+ waitUntil: "networkidle",
371
+ timeout: 30000,
372
+ });
373
+
374
+ const loginError = await page.$(".login-error");
375
+ if (loginError) {
376
+ throw new Error("Login failed. Please check your credentials.");
377
+ }
378
+
379
+ console.log("Signed In to QuickBase.");
380
+ loginSuccess = true;
381
+ } catch (error) {
382
+ console.error(
383
+ `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
384
+ );
385
+ if (loginAttempt >= maxLoginAttempts) {
386
+ console.error("Max login attempts reached. Exiting.");
387
+ await page.context().browser()!.close();
388
+ return false;
389
+ }
390
+ await new Promise((resolve) => setTimeout(resolve, 5000));
391
+ }
392
+ }
393
+ return loginSuccess;
394
+ };
395
+
396
+ test.describe("QuickbaseClient Integration - Cache Switching with Temp Tokens", () => {
397
+ // Removed test.use({ context: ... })
398
+
399
+ test("caches and switches tokens for different DBIDs with getApp → getFields → getApp sequence", async ({
400
+ page,
401
+ }) => {
402
+ console.log("Starting cacheSwitching test");
403
+ const realm = process.env.QB_REALM;
404
+ const appId = process.env.QB_APP_ID;
405
+ const tableId = process.env.QB_TABLE_ID;
406
+ const username = process.env.QB_USERNAME;
407
+ const password = process.env.QB_PASSWORD;
408
+
409
+ if (!realm) throw new Error("QB_REALM is not defined in .env");
410
+ if (!appId) throw new Error("QB_APP_ID is not defined in .env");
411
+ if (!tableId) throw new Error("QB_TABLE_ID is not defined in .env");
412
+ if (!username) throw new Error("QB_USERNAME is not defined in .env");
413
+ if (!password) throw new Error("QB_PASSWORD is not defined in .env");
414
+
415
+ const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
416
+ const loginSuccess = await loginToQuickbase(
417
+ page,
418
+ quickbaseUrl,
419
+ username,
420
+ password
421
+ );
422
+ if (!loginSuccess) {
423
+ throw new Error("Failed to log in to QuickBase after max attempts.");
424
+ }
425
+
426
+ await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
427
+ waitUntil: "networkidle",
428
+ timeout: 30000,
429
+ });
430
+ console.log("Post-login URL after app navigation:", page.url());
431
+
432
+ const browserFetch = async (url: string, init?: RequestInit) => {
433
+ const response = await page.evaluate(
434
+ async ([fetchUrl, fetchInit]) => {
435
+ const res = await fetch(fetchUrl, {
436
+ ...fetchInit,
437
+ credentials: "include",
438
+ });
439
+ const body = await res.text();
440
+ return {
441
+ ok: res.ok,
442
+ status: res.status,
443
+ statusText: res.statusText,
444
+ headers: Object.fromEntries(res.headers.entries()),
445
+ body,
446
+ };
447
+ },
448
+ [url, init] as [string, RequestInit]
449
+ );
450
+
451
+ console.log(`Raw response from ${url}:`, {
452
+ status: response.status,
453
+ statusText: response.statusText,
454
+ body: response.body,
455
+ });
456
+
457
+ const fetchResponse = new Response(response.body || null, {
458
+ status: response.status,
459
+ statusText: response.statusText,
460
+ headers: response.headers,
461
+ });
462
+
463
+ fetchResponse.json = async () => {
464
+ if (!response.body) throw new Error("Empty response body from API");
465
+ try {
466
+ return JSON.parse(response.body);
467
+ } catch (e) {
468
+ throw new SyntaxError(`Invalid JSON response: ${response.body}`);
469
+ }
470
+ };
471
+
472
+ return fetchResponse;
473
+ };
474
+
475
+ const client = quickbase({
476
+ realm,
477
+ useTempTokens: true,
478
+ debug: true,
479
+ fetchApi: async (url, init) => {
480
+ if (url.includes("/auth/temporary/")) {
481
+ return browserFetch(url, init);
482
+ }
483
+ console.log(`Fetching ${url} with init:`, init);
484
+ const response = await fetch(url, init as RequestInit);
485
+ const body = await response.text();
486
+
487
+ console.log(`Raw response from ${url}:`, {
488
+ status: response.status,
489
+ statusText: response.statusText,
490
+ body,
491
+ });
492
+
493
+ const fetchResponse = new Response(body || null, {
494
+ status: response.status,
495
+ statusText: response.statusText,
496
+ headers: Object.fromEntries(response.headers.entries()),
497
+ });
498
+
499
+ fetchResponse.json = async () => {
500
+ if (!body) throw new Error("Empty response body from API");
501
+ try {
502
+ return JSON.parse(body);
503
+ } catch (e) {
504
+ throw new SyntaxError(`Invalid JSON response: ${body}`);
505
+ }
506
+ };
507
+
508
+ return fetchResponse;
509
+ },
510
+ });
511
+
512
+ const appResult1 = await client.getApp({ appId });
513
+ console.log("First getApp response:", appResult1);
514
+ expect(appResult1.id).toBe(appId);
515
+
516
+ const fieldsResult = await client.getFields({ tableId });
517
+ console.log("getFields response:", fieldsResult);
518
+ expect(fieldsResult.length).toBeGreaterThan(0);
519
+
520
+ const appResult2 = await client.getApp({ appId });
521
+ console.log("Second getApp response:", appResult2);
522
+ expect(appResult2.id).toBe(appId);
523
+ });
524
+ });
525
+ - name: fetchTempToken401.test.ts
526
+ type: file
527
+ contents: |
528
+ // tests/playwright/qb/auth/tokenInvalidation.test.ts
529
+ import { test, expect } from "@playwright/test";
530
+ import { quickbase } from "../../../../src/quickbaseClient.ts";
531
+ import fetch from "node-fetch";
532
+ import dotenv from "dotenv";
533
+
534
+ dotenv.config();
535
+
536
+ const loginToQuickbase = async (
537
+ page: import("@playwright/test").Page,
538
+ quickbaseUrl: string,
539
+ username: string,
540
+ password: string
541
+ ): Promise<boolean> => {
542
+ console.log("Logging in to QuickBase");
543
+ let loginSuccess = false;
544
+ const maxLoginAttempts = 3;
545
+ let loginAttempt = 0;
546
+
547
+ while (!loginSuccess && loginAttempt < maxLoginAttempts) {
548
+ try {
549
+ loginAttempt++;
550
+ if (loginAttempt > 1) console.log(`Login attempt ${loginAttempt}`);
551
+
552
+ await page.goto(quickbaseUrl, { timeout: 60000 });
553
+ await page.waitForSelector("input[name='loginid']", { timeout: 60000 });
554
+ await page.fill("input[name='loginid']", username);
555
+ await page.fill("input[name='password']", password);
556
+ await page.click("#signin");
557
+ await page.waitForURL(`https://*.quickbase.com/**`, {
558
+ waitUntil: "networkidle",
559
+ timeout: 60000,
560
+ });
561
+
562
+ const loginError = await page.$(".login-error");
563
+ if (loginError) {
564
+ throw new Error("Login failed. Please check your credentials.");
565
+ }
566
+
567
+ console.log("Signed In to QuickBase.");
568
+ loginSuccess = true;
569
+ } catch (error) {
570
+ console.error(
571
+ `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
572
+ );
573
+ if (loginAttempt >= maxLoginAttempts) {
574
+ console.error("Max login attempts reached. Exiting.");
575
+ await page.context().browser()!.close();
576
+ return false;
577
+ }
578
+ await new Promise((resolve) => setTimeout(resolve, 5000));
579
+ }
580
+ }
581
+ return loginSuccess;
582
+ };
583
+
584
+ test.describe("QuickbaseClient Integration - Token Invalidation with Cached Token", () => {
585
+ test("retries with new token when cached token is unexpectedly invalidated", async ({
586
+ page,
587
+ }) => {
588
+ const realm = process.env.QB_REALM;
589
+ const appId = process.env.QB_APP_ID;
590
+ const username = process.env.QB_USERNAME;
591
+ const password = process.env.QB_PASSWORD;
592
+
593
+ if (!realm) throw new Error("QB_REALM is not defined in .env");
594
+ if (!appId) throw new Error("QB_APP_ID is not defined in .env");
595
+ if (!username) throw new Error("QB_USERNAME is not defined in .env");
596
+ if (!password) throw new Error("QB_PASSWORD is not defined in .env");
597
+
598
+ // Login to QuickBase
599
+ const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
600
+ const loginSuccess = await loginToQuickbase(
601
+ page,
602
+ quickbaseUrl,
603
+ username,
604
+ password
605
+ );
606
+ if (!loginSuccess) {
607
+ throw new Error("Failed to log in to QuickBase after max attempts.");
608
+ }
609
+
610
+ // Navigate to the app page to ensure session context
611
+ await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
612
+ waitUntil: "networkidle",
613
+ timeout: 60000,
614
+ });
615
+ console.log("Post-login URL after app navigation:", page.url());
616
+
617
+ // Track tokens and call counts
618
+ let callCount = 0;
619
+ let getAppCallCount = 0;
620
+ let initialToken: string | null = null;
621
+ let retryToken: string | null = null;
622
+
623
+ const browserFetch = async (url: string, init?: RequestInit) => {
624
+ console.log(`browserFetch called for ${url}, callCount: ${callCount}`);
625
+ const response = await page.evaluate(
626
+ async ([fetchUrl, fetchInit]) => {
627
+ const res = await fetch(fetchUrl, {
628
+ ...fetchInit,
629
+ credentials: "include",
630
+ });
631
+ const body = await res.text();
632
+ return {
633
+ ok: res.ok,
634
+ status: res.status,
635
+ statusText: res.statusText,
636
+ headers: Object.fromEntries(res.headers.entries()),
637
+ body,
638
+ };
639
+ },
640
+ [url, init] as [string, RequestInit]
641
+ );
642
+
643
+ console.log(`Raw response from ${url}:`, {
644
+ status: response.status,
645
+ statusText: response.statusText,
646
+ body: response.body,
647
+ });
648
+
649
+ const fetchResponse = new Response(response.body || null, {
650
+ status: response.status,
651
+ statusText: response.statusText,
652
+ headers: response.headers,
653
+ });
654
+
655
+ // Capture token from response
656
+ if (url.includes("/auth/temporary/")) {
657
+ const json = await fetchResponse.clone().json();
658
+ const token = json.temporaryAuthorization;
659
+ if (!initialToken) {
660
+ initialToken = token;
661
+ console.log(`Captured initial token: ${initialToken}`);
662
+ } else if (!retryToken) {
663
+ retryToken = token;
664
+ console.log(`Captured retry token: ${retryToken}`);
665
+ }
666
+ }
667
+
668
+ return fetchResponse;
669
+ };
670
+
671
+ const client = quickbase({
672
+ realm,
673
+ useTempTokens: true,
674
+ debug: true,
675
+ fetchApi: async (url, init) => {
676
+ callCount++;
677
+ console.log(`fetchApi called for ${url}, callCount: ${callCount}`);
678
+
679
+ if (url.includes("/auth/temporary/")) {
680
+ return browserFetch(url, init); // Use browser fetch for temp tokens
681
+ }
682
+
683
+ if (url.includes(`/apps/${appId}`)) {
684
+ getAppCallCount++;
685
+ console.log(`getApp call count: ${getAppCallCount}`);
686
+ // Simulate 401 on the first getApp call to trigger retry
687
+ if (getAppCallCount === 1) {
688
+ console.log("Simulating 401 Unauthorized for first getApp call");
689
+ return new Response(JSON.stringify({ message: "Unauthorized" }), {
690
+ status: 401,
691
+ statusText: "Unauthorized",
692
+ headers: { "Content-Type": "application/json" },
693
+ });
694
+ }
695
+ }
696
+
697
+ // Use node-fetch for subsequent calls (including retries)
698
+ console.log(`Fetching ${url} with init:`, init);
699
+ const response = await fetch(url, init as RequestInit);
700
+ const body = await response.text();
701
+
702
+ console.log(`Raw response from ${url}:`, {
703
+ status: response.status,
704
+ statusText: response.statusText,
705
+ body,
706
+ });
707
+
708
+ return new Response(body || null, {
709
+ status: response.status,
710
+ statusText: response.statusText,
711
+ headers: Object.fromEntries(response.headers.entries()),
712
+ });
713
+ },
714
+ });
715
+
716
+ // Pre-fetch token to simulate cached token
717
+ console.log("Pre-fetching initial token...");
718
+ const preFetchResult = await client.getTempTokenDBID({ dbid: appId });
719
+ console.log("Initial token pre-fetched and cached:", preFetchResult);
720
+
721
+ // Call getApp, expecting a 401 followed by a retry with a new token
722
+ const appResult = await client.getApp({ appId });
723
+ console.log("App response after token invalidation and retry:", appResult);
724
+
725
+ // Validate the app response
726
+ expect(appResult).toHaveProperty("id", appId);
727
+ expect(appResult).toHaveProperty("name");
728
+
729
+ // Verify call counts and token behavior
730
+ console.log(
731
+ `Final callCount: ${callCount}, Final getAppCallCount: ${getAppCallCount}`
732
+ );
733
+ expect(callCount).toBe(4); // Pre-fetch, 401, token retry, getApp success
734
+ expect(getAppCallCount).toBe(2); // Initial 401, retry success
735
+
736
+ // Validate pre-fetch and retry tokens
737
+ console.log(`Initial token: ${initialToken}`);
738
+ console.log(`Retry token: ${retryToken}`);
739
+ expect(initialToken).toBeDefined();
740
+ expect(initialToken).toBe(preFetchResult.temporaryAuthorization); // Confirm pre-fetch token was used
741
+ expect(retryToken).toBeDefined();
742
+ expect(initialToken).not.toBe(retryToken); // Confirm retry used a new token
743
+ });
744
+ });
745
+ - name: getAppWithUserToken.test.ts
746
+ type: file
747
+ contents: |
748
+ // tests/integration/auth/getAppWithUserToken.test.ts
749
+ import { test, expect } from "@playwright/test";
750
+ import { quickbase } from "../../../../src/quickbaseClient.ts";
751
+ import dotenv from "dotenv";
752
+
753
+ dotenv.config();
754
+
755
+ const loginToQuickbase = async (
756
+ page: import("@playwright/test").Page,
757
+ quickbaseUrl: string,
758
+ username: string,
759
+ password: string
760
+ ): Promise<boolean> => {
761
+ console.log("Logging in to QuickBase");
762
+ let loginSuccess = false;
763
+ const maxLoginAttempts = 3;
764
+ let loginAttempt = 0;
765
+
766
+ while (!loginSuccess && loginAttempt < maxLoginAttempts) {
767
+ try {
768
+ loginAttempt++;
769
+ if (loginAttempt > 1) console.log(`Login attempt ${loginAttempt}`);
770
+
771
+ await page.goto(quickbaseUrl, { timeout: 60000 });
772
+ await page.waitForSelector("input[name='loginid']", { timeout: 60000 });
773
+ await page.fill("input[name='loginid']", username);
774
+ await page.fill("input[name='password']", password);
775
+ await page.click("#signin");
776
+ await page.waitForURL(`https://*.quickbase.com/**`, {
777
+ waitUntil: "networkidle",
778
+ timeout: 60000,
779
+ });
780
+
781
+ const loginError = await page.$(".login-error");
782
+ if (loginError) {
783
+ throw new Error("Login failed. Please check your credentials.");
784
+ }
785
+
786
+ console.log("Signed In to QuickBase.");
787
+ loginSuccess = true;
788
+ } catch (error) {
789
+ console.error(
790
+ `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
791
+ );
792
+ if (loginAttempt >= maxLoginAttempts) {
793
+ console.error("Max login attempts reached. Exiting.");
794
+ await page.context().browser()!.close();
795
+ return false;
796
+ }
797
+ await new Promise((resolve) => setTimeout(resolve, 5000));
798
+ }
799
+ }
800
+ return loginSuccess;
801
+ };
802
+
803
+ test.describe("QuickbaseClient Integration - getApp with User Token", () => {
804
+ test("uses user token for getApp in browser", async ({ page }) => {
805
+ const realm = process.env.QB_REALM;
806
+ const appId = process.env.QB_APP_ID;
807
+ const username = process.env.QB_USERNAME;
808
+ const password = process.env.QB_PASSWORD;
809
+ const userToken = process.env.QB_USER_TOKEN;
810
+
811
+ if (!realm) throw new Error("QB_REALM is not defined in .env");
812
+ if (!appId) throw new Error("QB_APP_ID is not defined in .env");
813
+ if (!username) throw new Error("QB_USERNAME is not defined in .env");
814
+ if (!password) throw new Error("QB_PASSWORD is not defined in .env");
815
+ if (!userToken) throw new Error("QB_USER_TOKEN is not defined in .env");
816
+
817
+ // Login to Quickbase (optional, to mimic code page context)
818
+ const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
819
+ const loginSuccess = await loginToQuickbase(
820
+ page,
821
+ quickbaseUrl,
822
+ username,
823
+ password
824
+ );
825
+ if (!loginSuccess) {
826
+ throw new Error("Failed to log in to QuickBase after max attempts.");
827
+ }
828
+
829
+ // Navigate to the app page to ensure session context (optional)
830
+ await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
831
+ waitUntil: "networkidle",
832
+ timeout: 60000,
833
+ });
834
+
835
+ const currentUrl = page.url();
836
+ console.log("Post-login URL after app navigation:", currentUrl);
837
+
838
+ // Create Quickbase client with user token
839
+ const client = quickbase({
840
+ realm,
841
+ userToken, // Use user token instead of temp tokens
842
+ debug: true,
843
+ fetchApi: async (url, init) => {
844
+ console.log(`Fetching ${url} with init:`, init);
845
+ const response = await page.evaluate(
846
+ async ([fetchUrl, fetchInit]) => {
847
+ const res = await fetch(fetchUrl, {
848
+ ...fetchInit,
849
+ credentials: "omit", // No cookies needed with user token
850
+ });
851
+ const body = await res.text();
852
+ return {
853
+ ok: res.ok,
854
+ status: res.status,
855
+ statusText: res.statusText,
856
+ headers: Object.fromEntries(res.headers.entries()),
857
+ body,
858
+ };
859
+ },
860
+ [url, init] as [string, RequestInit]
861
+ );
862
+
863
+ console.log(`Raw response from ${url}:`, {
864
+ status: response.status,
865
+ statusText: response.statusText,
866
+ body: response.body,
867
+ });
868
+
869
+ const fetchResponse = new Response(response.body || null, {
870
+ status: response.status,
871
+ statusText: response.statusText,
872
+ headers: response.headers,
873
+ });
874
+
875
+ fetchResponse.json = async () => {
876
+ if (!response.body) {
877
+ throw new Error("Empty response body from API");
878
+ }
879
+ try {
880
+ return JSON.parse(response.body);
881
+ } catch (e) {
882
+ throw new SyntaxError(`Invalid JSON response: ${response.body}`);
883
+ }
884
+ };
885
+
886
+ return fetchResponse;
887
+ },
888
+ });
889
+
890
+ // Call getApp directly
891
+ const appResult = await client.getApp({ appId });
892
+ console.log("App response using user token:", appResult);
893
+
894
+ // Validate the app response
895
+ expect(appResult).toHaveProperty("id", appId);
896
+ expect(appResult).toHaveProperty("name");
897
+ });
898
+ });
899
+ - name: getTempToken.test.ts
900
+ type: file
901
+ contents: |
902
+ // tests/integration/auth/getTempToken.test.ts
903
+ import { test, expect } from "@playwright/test";
904
+ import { quickbase } from "../../../../src/quickbaseClient.ts";
905
+ import fetch from "node-fetch";
906
+ import dotenv from "dotenv";
907
+
908
+ dotenv.config();
909
+
910
+ const loginToQuickbase = async (
911
+ page: import("@playwright/test").Page,
912
+ quickbaseUrl: string,
913
+ username: string,
914
+ password: string
915
+ ): Promise<boolean> => {
916
+ console.log("Logging in to QuickBase");
917
+ let loginSuccess = false;
918
+ const maxLoginAttempts = 3;
919
+ let loginAttempt = 0;
920
+
921
+ while (!loginSuccess && loginAttempt < maxLoginAttempts) {
922
+ try {
923
+ loginAttempt++;
924
+ if (loginAttempt > 1) console.log(`Login attempt ${loginAttempt}`);
925
+
926
+ await page.goto(quickbaseUrl, { timeout: 60000 });
927
+ await page.waitForSelector("input[name='loginid']", { timeout: 60000 });
928
+ await page.fill("input[name='loginid']", username);
929
+ await page.fill("input[name='password']", password);
930
+ await page.click("#signin");
931
+ await page.waitForURL(`https://*.quickbase.com/**`, {
932
+ waitUntil: "networkidle",
933
+ timeout: 60000,
934
+ });
935
+
936
+ const loginError = await page.$(".login-error");
937
+ if (loginError) {
938
+ throw new Error("Login failed. Please check your credentials.");
939
+ }
940
+
941
+ console.log("Signed In to QuickBase.");
942
+ loginSuccess = true;
943
+ } catch (error) {
944
+ console.error(
945
+ `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
946
+ );
947
+ if (loginAttempt >= maxLoginAttempts) {
948
+ console.error("Max login attempts reached. Exiting.");
949
+ await page.context().browser()!.close();
950
+ return false;
951
+ }
952
+ await new Promise((resolve) => setTimeout(resolve, 5000));
953
+ }
954
+ }
955
+ return loginSuccess;
956
+ };
957
+
958
+ test.describe("QuickbaseClient Integration - getApp with Temp Tokens", () => {
959
+ test("uses temp tokens automatically for getApp in browser", async ({
960
+ page,
961
+ }) => {
962
+ const realm = process.env.QB_REALM;
963
+ const appId = process.env.QB_APP_ID;
964
+ const username = process.env.QB_USERNAME;
965
+ const password = process.env.QB_PASSWORD;
966
+
967
+ if (!realm) throw new Error("QB_REALM is not defined in .env");
968
+ if (!appId) throw new Error("QB_APP_ID is not defined in .env");
969
+ if (!username) throw new Error("QB_USERNAME is not defined in .env");
970
+ if (!password) throw new Error("QB_PASSWORD is not defined in .env");
971
+
972
+ // Login to QuickBase
973
+ const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
974
+ const loginSuccess = await loginToQuickbase(
975
+ page,
976
+ quickbaseUrl,
977
+ username,
978
+ password
979
+ );
980
+ if (!loginSuccess) {
981
+ throw new Error("Failed to log in to QuickBase after max attempts.");
982
+ }
983
+
984
+ // Navigate to the app page to ensure session context
985
+ await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
986
+ waitUntil: "networkidle",
987
+ timeout: 60000,
988
+ });
989
+ console.log("Post-login URL after app navigation:", page.url());
990
+
991
+ // Define browser fetch function
992
+ const browserFetch = async (url: string, init?: RequestInit) => {
993
+ const response = await page.evaluate(
994
+ async ([fetchUrl, fetchInit]) => {
995
+ const res = await fetch(fetchUrl, {
996
+ ...fetchInit,
997
+ credentials: "include",
998
+ });
999
+ const body = await res.text();
1000
+ return {
1001
+ ok: res.ok,
1002
+ status: res.status,
1003
+ statusText: res.statusText,
1004
+ headers: Object.fromEntries(res.headers.entries()),
1005
+ body,
1006
+ };
1007
+ },
1008
+ [url, init] as [string, RequestInit]
1009
+ );
1010
+
1011
+ console.log(`Raw response from ${url}:`, {
1012
+ status: response.status,
1013
+ statusText: response.statusText,
1014
+ body: response.body,
1015
+ });
1016
+
1017
+ const fetchResponse = new Response(response.body || null, {
1018
+ status: response.status,
1019
+ statusText: response.statusText,
1020
+ headers: response.headers,
1021
+ });
1022
+
1023
+ fetchResponse.json = async () => {
1024
+ if (!response.body) throw new Error("Empty response body from API");
1025
+ try {
1026
+ return JSON.parse(response.body);
1027
+ } catch (e) {
1028
+ throw new SyntaxError(`Invalid JSON response: ${response.body}`);
1029
+ }
1030
+ };
1031
+
1032
+ return fetchResponse;
1033
+ };
1034
+
1035
+ // Single client with conditional fetch
1036
+ const client = quickbase({
1037
+ realm,
1038
+ useTempTokens: true,
1039
+ debug: true,
1040
+ fetchApi: async (url, init) => {
1041
+ if (url.includes("/auth/temporary/")) {
1042
+ return browserFetch(url, init); // Use browser context for temp token
1043
+ }
1044
+ console.log(`Fetching ${url} with init:`, init);
1045
+ const response = await fetch(url, init as RequestInit); // Node-fetch for API calls
1046
+ const body = await response.text();
1047
+
1048
+ console.log(`Raw response from ${url}:`, {
1049
+ status: response.status,
1050
+ statusText: response.statusText,
1051
+ body,
1052
+ });
1053
+
1054
+ const fetchResponse = new Response(body || null, {
1055
+ status: response.status,
1056
+ statusText: response.statusText,
1057
+ headers: Object.fromEntries(response.headers.entries()),
1058
+ });
1059
+
1060
+ fetchResponse.json = async () => {
1061
+ if (!body) throw new Error("Empty response body from API");
1062
+ try {
1063
+ return JSON.parse(body);
1064
+ } catch (e) {
1065
+ throw new SyntaxError(`Invalid JSON response: ${body}`);
1066
+ }
1067
+ };
1068
+
1069
+ return fetchResponse;
1070
+ },
1071
+ });
1072
+
1073
+ // Call getApp directly, letting the library handle temp token logic
1074
+ const appResult = await client.getApp({ appId });
1075
+ console.log("App response using auto-fetched temp token:", appResult);
1076
+
1077
+ // Validate the app response
1078
+ expect(appResult).toHaveProperty("id", appId);
1079
+ expect(appResult).toHaveProperty("name");
1080
+ });
1081
+ });
1082
+ - name: tokenPrefetch.test.ts
1083
+ type: file
1084
+ contents: |
1085
+ // tests/playwright/qb/auth/tokenPrefetch.test.ts
1086
+ import { test, expect } from "@playwright/test";
1087
+ import { quickbase } from "../../../../src/quickbaseClient.ts";
1088
+ import fetch from "node-fetch";
1089
+ import dotenv from "dotenv";
1090
+
1091
+ dotenv.config();
1092
+
1093
+ const loginToQuickbase = async (
1094
+ page: import("@playwright/test").Page,
1095
+ quickbaseUrl: string,
1096
+ username: string,
1097
+ password: string
1098
+ ): Promise<boolean> => {
1099
+ console.log("Logging in to QuickBase");
1100
+ let loginSuccess = false;
1101
+ const maxLoginAttempts = 3;
1102
+ let loginAttempt = 0;
1103
+
1104
+ while (!loginSuccess && loginAttempt < maxLoginAttempts) {
1105
+ try {
1106
+ loginAttempt++;
1107
+ if (loginAttempt > 1) console.log(`Login attempt ${loginAttempt}`);
1108
+
1109
+ await page.goto(quickbaseUrl, { timeout: 60000 });
1110
+ await page.waitForSelector("input[name='loginid']", { timeout: 60000 });
1111
+ await page.fill("input[name='loginid']", username);
1112
+ await page.fill("input[name='password']", password);
1113
+ await page.click("#signin");
1114
+ await page.waitForURL(`https://*.quickbase.com/**`, {
1115
+ waitUntil: "networkidle",
1116
+ timeout: 60000,
1117
+ });
1118
+
1119
+ const loginError = await page.$(".login-error");
1120
+ if (loginError) {
1121
+ throw new Error("Login failed. Please check your credentials.");
1122
+ }
1123
+
1124
+ console.log("Signed In to QuickBase.");
1125
+ loginSuccess = true;
1126
+ } catch (error) {
1127
+ console.error(
1128
+ `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
1129
+ );
1130
+ if (loginAttempt >= maxLoginAttempts) {
1131
+ console.error("Max login attempts reached. Exiting.");
1132
+ await page.context().browser()!.close();
1133
+ return false;
1134
+ }
1135
+ await new Promise((resolve) => setTimeout(resolve, 5000));
1136
+ }
1137
+ }
1138
+ return loginSuccess;
1139
+ };
1140
+
1141
+ test.describe("QuickbaseClient Integration - Token Pre-Fetch and Cache Reuse", () => {
1142
+ test("pre-fetches token and reuses it for subsequent API calls", async ({
1143
+ page,
1144
+ }) => {
1145
+ const realm = process.env.QB_REALM;
1146
+ const appId = process.env.QB_APP_ID;
1147
+ const username = process.env.QB_USERNAME;
1148
+ const password = process.env.QB_PASSWORD;
1149
+
1150
+ if (!realm) throw new Error("QB_REALM is not defined in .env");
1151
+ if (!appId) throw new Error("QB_APP_ID is not defined in .env");
1152
+ if (!username) throw new Error("QB_USERNAME is not defined in .env");
1153
+ if (!password) throw new Error("QB_PASSWORD is not defined in .env");
1154
+
1155
+ // Login to QuickBase
1156
+ const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
1157
+ const loginSuccess = await loginToQuickbase(
1158
+ page,
1159
+ quickbaseUrl,
1160
+ username,
1161
+ password
1162
+ );
1163
+ if (!loginSuccess) {
1164
+ throw new Error("Failed to log in to QuickBase after max attempts.");
1165
+ }
1166
+
1167
+ // Navigate to the app page to ensure session context
1168
+ await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
1169
+ waitUntil: "networkidle",
1170
+ timeout: 60000,
1171
+ });
1172
+ console.log("Post-login URL after app navigation:", page.url());
1173
+
1174
+ // Track tokens and call counts
1175
+ let callCount = 0;
1176
+ let cachedToken: string | null = null;
1177
+
1178
+ const browserFetch = async (url: string, init?: RequestInit) => {
1179
+ console.log(`browserFetch called for ${url}, callCount: ${callCount}`);
1180
+ const response = await page.evaluate(
1181
+ async ([fetchUrl, fetchInit]) => {
1182
+ const res = await fetch(fetchUrl, {
1183
+ ...fetchInit,
1184
+ credentials: "include",
1185
+ });
1186
+ const body = await res.text();
1187
+ return {
1188
+ ok: res.ok,
1189
+ status: res.status,
1190
+ statusText: res.statusText,
1191
+ headers: Object.fromEntries(res.headers.entries()),
1192
+ body,
1193
+ };
1194
+ },
1195
+ [url, init] as [string, RequestInit]
1196
+ );
1197
+
1198
+ console.log(`Raw response from ${url}:`, {
1199
+ status: response.status,
1200
+ statusText: response.statusText,
1201
+ body: response.body,
1202
+ });
1203
+
1204
+ const fetchResponse = new Response(response.body || null, {
1205
+ status: response.status,
1206
+ statusText: response.statusText,
1207
+ headers: response.headers,
1208
+ });
1209
+
1210
+ // Capture token from response
1211
+ if (url.includes("/auth/temporary/")) {
1212
+ const json = await fetchResponse.clone().json();
1213
+ const token = json.temporaryAuthorization;
1214
+ cachedToken = token; // Store the pre-fetched token
1215
+ console.log(`Captured pre-fetched token: ${cachedToken}`);
1216
+ }
1217
+
1218
+ return fetchResponse;
1219
+ };
1220
+
1221
+ const client = quickbase({
1222
+ realm,
1223
+ useTempTokens: true,
1224
+ debug: true,
1225
+ fetchApi: async (url, init) => {
1226
+ callCount++;
1227
+ console.log(`fetchApi called for ${url}, callCount: ${callCount}`);
1228
+
1229
+ if (url.includes("/auth/temporary/")) {
1230
+ return browserFetch(url, init); // Use browser fetch for temp tokens
1231
+ }
1232
+
1233
+ // Use node-fetch for app calls, ensuring we track reuse
1234
+ console.log(`Fetching ${url} with init:`, init);
1235
+ const response = await fetch(url, init as RequestInit);
1236
+ const body = await response.text();
1237
+
1238
+ console.log(`Raw response from ${url}:`, {
1239
+ status: response.status,
1240
+ statusText: response.statusText,
1241
+ body,
1242
+ });
1243
+
1244
+ return new Response(body || null, {
1245
+ status: response.status,
1246
+ statusText: response.statusText,
1247
+ headers: Object.fromEntries(response.headers.entries()),
1248
+ });
1249
+ },
1250
+ });
1251
+
1252
+ // Step 1: Pre-fetch token
1253
+ console.log("Pre-fetching token...");
1254
+ const tokenResult = await client.getTempTokenDBID({ dbid: appId });
1255
+ console.log("Pre-fetched token result:", tokenResult);
1256
+ expect(tokenResult).toHaveProperty("temporaryAuthorization");
1257
+ expect(cachedToken).toBe(tokenResult.temporaryAuthorization);
1258
+
1259
+ // Step 2: Call getApp, expecting it to reuse the cached token
1260
+ console.log("Calling getApp with pre-fetched token...");
1261
+ const appResult = await client.getApp({ appId });
1262
+ console.log("App response:", appResult);
1263
+
1264
+ // Validate the app response
1265
+ expect(appResult).toHaveProperty("id", appId);
1266
+ expect(appResult).toHaveProperty("name");
1267
+
1268
+ // Verify call count and token reuse
1269
+ console.log(`Final callCount: ${callCount}`);
1270
+ expect(callCount).toBe(2); // One for pre-fetch, one for getApp
1271
+ expect(cachedToken).toBeDefined();
1272
+
1273
+ // Check that getApp reused the token by inspecting logs manually or adding a header check if needed
1274
+ console.log(`Pre-fetched token: ${cachedToken}`);
1275
+ });
1276
+ });
1277
+ - name: tokenRenewal.test.ts
1278
+ type: file
1279
+ contents: |
1280
+ // tests/playwright/qb/auth/tokenRenewal.test.ts
1281
+ import { test, expect } from "@playwright/test";
1282
+ import { quickbase } from "../../../../src/quickbaseClient.ts";
1283
+ import dotenv from "dotenv";
1284
+
1285
+ dotenv.config();
1286
+
1287
+ const loginToQuickbase = async (
1288
+ page,
1289
+ quickbaseUrl,
1290
+ username,
1291
+ password,
1292
+ appUrl
1293
+ ) => {
1294
+ console.log("Logging in to QuickBase");
1295
+ await page.goto(quickbaseUrl, { timeout: 60000 });
1296
+ await page.waitForSelector("input[name='loginid']", { timeout: 60000 });
1297
+ await page.fill("input[name='loginid']", username);
1298
+ await page.fill("input[name='password']", password);
1299
+ await page.click("#signin");
1300
+ await page.waitForURL(`https://*.quickbase.com/**`, {
1301
+ waitUntil: "networkidle",
1302
+ timeout: 60000,
1303
+ });
1304
+ console.log("Signed In to QuickBase.");
1305
+ await page.goto(appUrl, { waitUntil: "networkidle", timeout: 60000 });
1306
+ console.log("Navigated to app URL:", page.url());
1307
+ };
1308
+
1309
+ test.describe("QuickbaseClient Integration - Temp Token Renewal", () => {
1310
+ test("renews temp token after 5 minutes with getApp → wait → getApp sequence", async ({
1311
+ page,
1312
+ }) => {
1313
+ const realm = process.env.QB_REALM!;
1314
+ const appId = process.env.QB_APP_ID!;
1315
+ const username = process.env.QB_USERNAME!;
1316
+ const password = process.env.QB_PASSWORD!;
1317
+ const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
1318
+ const appUrl = `https://${realm}.quickbase.com/db/${appId}`;
1319
+
1320
+ await loginToQuickbase(page, quickbaseUrl, username, password, appUrl);
1321
+
1322
+ const browserFetch = async (
1323
+ url: string,
1324
+ init: RequestInit
1325
+ ): Promise<Response> => {
1326
+ const response = await page.request.fetch(url, {
1327
+ method: init.method || "GET",
1328
+ headers: {
1329
+ ...init.headers,
1330
+ Referer: `https://${realm}.quickbase.com/db/${appId}`,
1331
+ Origin: `https://${realm}.quickbase.com`,
1332
+ },
1333
+ data: init.body,
1334
+ credentials: "include",
1335
+ });
1336
+ const body = await response.text();
1337
+ console.log(
1338
+ "Response from:",
1339
+ url,
1340
+ "status:",
1341
+ response.status(),
1342
+ "body:",
1343
+ body
1344
+ );
1345
+ return new Response(body, {
1346
+ status: response.status(),
1347
+ statusText: response.statusText(),
1348
+ headers: response.headers(),
1349
+ });
1350
+ };
1351
+
1352
+ const client = quickbase({
1353
+ realm,
1354
+ useTempTokens: true,
1355
+ debug: true,
1356
+ fetchApi: browserFetch,
1357
+ });
1358
+
1359
+ console.log("Checking session state before getApp...");
1360
+ const cookies = await page.context().cookies();
1361
+ const sessionCookie = cookies.find(
1362
+ (c) => c.name === "TICKET" || c.name.startsWith("TICKET_")
1363
+ );
1364
+ console.log(
1365
+ "Session cookie present:",
1366
+ !!sessionCookie,
1367
+ "Cookies:",
1368
+ cookies
1369
+ );
1370
+ if (!sessionCookie) throw new Error("TICKET session cookie not found");
1371
+
1372
+ await page.waitForTimeout(5000); // Debug delay
1373
+ console.log("Cookies after delay:", await page.context().cookies());
1374
+
1375
+ const appResult1 = await client.getApp({ appId });
1376
+ console.log("First getApp response:", appResult1);
1377
+ expect(appResult1.id).toBe(appId);
1378
+
1379
+ console.log("Waiting 5 minutes to test token expiration...");
1380
+ await new Promise((resolve) => setTimeout(resolve, 5 * 60 * 1000));
1381
+
1382
+ await page.reload({ waitUntil: "load", timeout: 60000 });
1383
+ console.log("Refreshed page after 5 minutes, URL:", page.url());
1384
+
1385
+ const appResult2 = await client.getApp({ appId });
1386
+ console.log("Second getApp response:", appResult2);
1387
+ expect(appResult2.id).toBe(appId);
1388
+ });
1389
+ });
1390
+ - name: setup.ts
1391
+ type: file
1392
+ contents: |
1393
+ // @tests/setup.ts
1394
+ import { vi } from "vitest";
1395
+ import { quickbase } from "../src/quickbaseClient.ts";
1396
+ import type { QuickbaseConfig } from "../src/quickbaseClient.ts";
1397
+
1398
+ export const mockFetch = vi.fn();
1399
+
1400
+ export const createClient = (
1401
+ fetchApi?: any,
1402
+ config: Partial<QuickbaseConfig> = {}
1403
+ ) => {
1404
+ const client = quickbase({
1405
+ realm: process.env.QB_REALM || "test-realm", // Match upsert.test.ts
1406
+ userToken: process.env.QB_USER_TOKEN || "test-token", // Match upsert.test.ts
1407
+ debug: true,
1408
+ fetchApi,
1409
+ ...config,
1410
+ });
1411
+ console.log("[createClient] Config:", config); // Debug config
1412
+ console.log("[createClient] Returning:", client); // Debug client
1413
+ return client;
1414
+ };
1415
+
1416
+ // Mock env variables for consistency
1417
+ vi.stubEnv("QB_REALM", "builderprogram-dbradford6815");
1418
+ vi.stubEnv("QB_USER_TOKEN", "b9f3pk_q4jd_0_b4qu5eebyvuix3xs57ysd7zn3");
1419
+ vi.stubEnv("QB_APP_ID", "buwai2zpe");
1420
+ - name: vitest
1421
+ type: directory
1422
+ children:
1423
+ - name: qb
1424
+ type: directory
1425
+ children:
1426
+ - name: apps
1427
+ type: directory
1428
+ children:
1429
+ - name: getApp.test.ts
1430
+ type: file
1431
+ contents: |
1432
+ import { test, expect } from "vitest";
1433
+ import { quickbase } from "../../../../src/quickbaseClient";
1434
+
1435
+ test(
1436
+ "QuickbaseClient Integration - getApp > fetches real app data from QuickBase",
1437
+ { timeout: 10000 },
1438
+ async () => {
1439
+ const config = {
1440
+ realm: process.env.QB_REALM || "",
1441
+ userToken: process.env.QB_USER_TOKEN || "",
1442
+ debug: true,
1443
+ };
1444
+ const client = quickbase(config);
1445
+ const getAppId = "buwai2zpe";
1446
+
1447
+ console.log("Config used:", config);
1448
+ const result = await client.getApp({ appId: getAppId });
1449
+ console.log("Real API response:", result);
1450
+
1451
+ expect(result).toEqual({
1452
+ id: getAppId,
1453
+ name: "qb-copy",
1454
+ created: expect.any(Date), // Matches Date object from client
1455
+ updated: expect.any(Date), // Matches Date object from client
1456
+ description: "",
1457
+ timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
1458
+ dateFormat: "MM-DD-YYYY",
1459
+ hasEveryoneOnTheInternet: false,
1460
+ memoryInfo: { estMemory: 0, estMemoryInclDependentApps: 0 },
1461
+ securityProperties: {
1462
+ allowClone: false,
1463
+ allowExport: true,
1464
+ enableAppTokens: true,
1465
+ hideFromPublic: false,
1466
+ mustBeRealmApproved: false,
1467
+ useIPFilter: false,
1468
+ },
1469
+ });
1470
+ }
1471
+ );
1472
+ - name: fields
1473
+ type: directory
1474
+ children:
1475
+ - name: getFields.test.ts
1476
+ type: file
1477
+ contents: |
1478
+ import { describe, it, expect } from "vitest";
1479
+ import { createClient } from "../../../setup.ts";
1480
+
1481
+ describe("QuickbaseClient Integration - getFields", () => {
1482
+ const client = createClient();
1483
+
1484
+ it(
1485
+ "fetches real field data from QuickBase",
1486
+ async () => {
1487
+ const tableId = "buwai2z3s";
1488
+ if (!tableId) throw new Error("Table ID is not defined");
1489
+ if (!process.env.QB_REALM)
1490
+ throw new Error("QB_REALM is not defined in .env");
1491
+ if (!process.env.QB_USER_TOKEN)
1492
+ throw new Error("QB_USER_TOKEN is not defined in .env");
1493
+
1494
+ console.log("Config used:", {
1495
+ realm: process.env.QB_REALM,
1496
+ userToken: process.env.QB_USER_TOKEN,
1497
+ tableId,
1498
+ });
1499
+ const result = await client.getFields({
1500
+ tableId,
1501
+ includeFieldPerms: true,
1502
+ });
1503
+ console.log("Real API response:", result);
1504
+ expect(result).toEqual(
1505
+ expect.arrayContaining([
1506
+ expect.objectContaining({
1507
+ id: 1,
1508
+ label: "Date Created",
1509
+ fieldType: "timestamp",
1510
+ noWrap: true,
1511
+ bold: false,
1512
+ required: false,
1513
+ appearsByDefault: false,
1514
+ findEnabled: false,
1515
+ unique: false,
1516
+ doesDataCopy: false,
1517
+ fieldHelp: "",
1518
+ audited: false,
1519
+ properties: expect.objectContaining({
1520
+ primaryKey: false,
1521
+ foreignKey: false,
1522
+ sortAsGiven: true,
1523
+ carryChoices: true,
1524
+ allowNewChoices: false,
1525
+ formula: "",
1526
+ defaultValue: "",
1527
+ }),
1528
+ permissions: expect.arrayContaining([
1529
+ expect.objectContaining({
1530
+ permissionType: "Modify",
1531
+ role: "Viewer",
1532
+ roleId: 10,
1533
+ }),
1534
+ expect.objectContaining({
1535
+ permissionType: "Modify",
1536
+ role: "Participant",
1537
+ roleId: 11,
1538
+ }),
1539
+ expect.objectContaining({
1540
+ permissionType: "Modify",
1541
+ role: "Administrator",
1542
+ roleId: 12,
1543
+ }),
1544
+ ]),
1545
+ }),
1546
+ expect.objectContaining({
1547
+ id: 2,
1548
+ label: "Date Modified",
1549
+ fieldType: "timestamp",
1550
+ noWrap: true,
1551
+ bold: false,
1552
+ required: false,
1553
+ appearsByDefault: false,
1554
+ findEnabled: false,
1555
+ unique: false,
1556
+ doesDataCopy: false,
1557
+ fieldHelp: "",
1558
+ audited: false,
1559
+ properties: expect.objectContaining({
1560
+ primaryKey: false,
1561
+ foreignKey: false,
1562
+ sortAsGiven: true,
1563
+ carryChoices: true,
1564
+ allowNewChoices: false,
1565
+ formula: "",
1566
+ defaultValue: "",
1567
+ }),
1568
+ permissions: expect.arrayContaining([
1569
+ expect.objectContaining({
1570
+ permissionType: "Modify",
1571
+ role: "Viewer",
1572
+ roleId: 10,
1573
+ }),
1574
+ expect.objectContaining({
1575
+ permissionType: "Modify",
1576
+ role: "Participant",
1577
+ roleId: 11,
1578
+ }),
1579
+ expect.objectContaining({
1580
+ permissionType: "Modify",
1581
+ role: "Administrator",
1582
+ roleId: 12,
1583
+ }),
1584
+ ]),
1585
+ }),
1586
+ expect.objectContaining({
1587
+ id: 3,
1588
+ label: "Record ID#",
1589
+ fieldType: "recordid",
1590
+ noWrap: true,
1591
+ bold: false,
1592
+ required: false,
1593
+ appearsByDefault: false,
1594
+ findEnabled: false,
1595
+ unique: true,
1596
+ doesDataCopy: false,
1597
+ fieldHelp: "",
1598
+ audited: false,
1599
+ properties: expect.objectContaining({
1600
+ primaryKey: true,
1601
+ foreignKey: false,
1602
+ sortAsGiven: true,
1603
+ carryChoices: true,
1604
+ allowNewChoices: false,
1605
+ formula: "",
1606
+ defaultValue: "",
1607
+ }),
1608
+ permissions: expect.arrayContaining([
1609
+ expect.objectContaining({
1610
+ permissionType: "Modify",
1611
+ role: "Viewer",
1612
+ roleId: 10,
1613
+ }),
1614
+ expect.objectContaining({
1615
+ permissionType: "Modify",
1616
+ role: "Participant",
1617
+ roleId: 11,
1618
+ }),
1619
+ expect.objectContaining({
1620
+ permissionType: "Modify",
1621
+ role: "Administrator",
1622
+ roleId: 12,
1623
+ }),
1624
+ ]),
1625
+ }),
1626
+ expect.objectContaining({
1627
+ id: 4,
1628
+ label: "Record Owner",
1629
+ fieldType: "user",
1630
+ noWrap: true,
1631
+ bold: false,
1632
+ required: false,
1633
+ appearsByDefault: false,
1634
+ findEnabled: true,
1635
+ unique: false,
1636
+ doesDataCopy: false,
1637
+ fieldHelp: "",
1638
+ audited: false,
1639
+ properties: expect.objectContaining({
1640
+ primaryKey: false,
1641
+ foreignKey: false,
1642
+ sortAsGiven: true,
1643
+ carryChoices: true,
1644
+ allowNewChoices: true,
1645
+ formula: "",
1646
+ defaultValue: "",
1647
+ }),
1648
+ permissions: expect.arrayContaining([
1649
+ expect.objectContaining({
1650
+ permissionType: "Modify",
1651
+ role: "Viewer",
1652
+ roleId: 10,
1653
+ }),
1654
+ expect.objectContaining({
1655
+ permissionType: "Modify",
1656
+ role: "Participant",
1657
+ roleId: 11,
1658
+ }),
1659
+ expect.objectContaining({
1660
+ permissionType: "Modify",
1661
+ role: "Administrator",
1662
+ roleId: 12,
1663
+ }),
1664
+ ]),
1665
+ }),
1666
+ expect.objectContaining({
1667
+ id: 5,
1668
+ label: "Last Modified By",
1669
+ fieldType: "user",
1670
+ noWrap: true,
1671
+ bold: false,
1672
+ required: false,
1673
+ appearsByDefault: false,
1674
+ findEnabled: true,
1675
+ unique: false,
1676
+ doesDataCopy: false,
1677
+ fieldHelp: "",
1678
+ audited: false,
1679
+ properties: expect.objectContaining({
1680
+ primaryKey: false,
1681
+ foreignKey: false,
1682
+ sortAsGiven: true,
1683
+ carryChoices: true,
1684
+ allowNewChoices: true,
1685
+ formula: "",
1686
+ defaultValue: "",
1687
+ }),
1688
+ permissions: expect.arrayContaining([
1689
+ expect.objectContaining({
1690
+ permissionType: "Modify",
1691
+ role: "Viewer",
1692
+ roleId: 10,
1693
+ }),
1694
+ expect.objectContaining({
1695
+ permissionType: "Modify",
1696
+ role: "Participant",
1697
+ roleId: 11,
1698
+ }),
1699
+ expect.objectContaining({
1700
+ permissionType: "Modify",
1701
+ role: "Administrator",
1702
+ roleId: 12,
1703
+ }),
1704
+ ]),
1705
+ }),
1706
+ ])
1707
+ );
1708
+ },
1709
+ { timeout: 10000 }
1710
+ );
1711
+ });
1712
+ - name: index.ts
1713
+ type: file
1714
+ contents: |
1715
+ // Optional: Only add if you need to export tests
1716
+ export * from "./apps/getApp.test.ts";
1717
+ export * from "./fields/getFields.test.ts";
1718
+ export * from "./tables/getAppTables.test.ts";
1719
+ - name: records
1720
+ type: directory
1721
+ children:
1722
+ - name: deleteRecords.test.ts
1723
+ type: file
1724
+ contents: |
1725
+ // tests/vitest/qb/records/deleteRecords.test.ts
1726
+ import { describe, test, expect, beforeEach, afterEach } from "vitest";
1727
+ import { quickbase } from "@/quickbaseClient.ts";
1728
+
1729
+ const TABLE_ID = "buwai2zws";
1730
+ const UNIQUE_FIELD_ID = 3; // Record ID field
1731
+ const MARKER_FIELD_ID = 6; // Text field for marking test records
1732
+
1733
+ describe("QuickbaseClient - DeleteRecords Integration", () => {
1734
+ const qb = quickbase({
1735
+ realm: "builderprogram-dbradford6815",
1736
+ userToken: process.env.QB_USER_TOKEN,
1737
+ debug: true,
1738
+ });
1739
+
1740
+ beforeEach(async () => {
1741
+ try {
1742
+ await qb.deleteRecords({
1743
+ body: {
1744
+ from: TABLE_ID,
1745
+ where: `{${MARKER_FIELD_ID}.CT.'test-marker-delete'}`,
1746
+ },
1747
+ });
1748
+ } catch (e) {
1749
+ // Ignore if no records exist
1750
+ }
1751
+ });
1752
+
1753
+ afterEach(async () => {
1754
+ try {
1755
+ await qb.deleteRecords({
1756
+ body: {
1757
+ from: TABLE_ID,
1758
+ where: `{${MARKER_FIELD_ID}.CT.'test-marker-delete'}`,
1759
+ },
1760
+ });
1761
+ } catch (e) {}
1762
+ });
1763
+
1764
+ test(
1765
+ "deletes a newly upserted record",
1766
+ async () => {
1767
+ const upsertResponse = await qb.upsert({
1768
+ body: {
1769
+ to: TABLE_ID,
1770
+ data: [{ [MARKER_FIELD_ID]: { value: "test-marker-delete" } }],
1771
+ fieldsToReturn: [UNIQUE_FIELD_ID], // Return record ID
1772
+ },
1773
+ });
1774
+ const recordId = upsertResponse.metadata.createdRecordIds[0];
1775
+ expect(recordId).toBeDefined();
1776
+ expect(upsertResponse.data[0][UNIQUE_FIELD_ID].value).toBe(recordId);
1777
+
1778
+ const deleteResponse = await qb.deleteRecords({
1779
+ body: { from: TABLE_ID, where: `{${UNIQUE_FIELD_ID}.EX.${recordId}}` },
1780
+ });
1781
+
1782
+ expect(deleteResponse).toEqual({ numberDeleted: 1 });
1783
+
1784
+ const checkResponse = await qb.deleteRecords({
1785
+ body: { from: TABLE_ID, where: `{${UNIQUE_FIELD_ID}.EX.${recordId}}` },
1786
+ });
1787
+ expect(checkResponse.numberDeleted).toBe(0);
1788
+ },
1789
+ { timeout: 10000 }
1790
+ );
1791
+
1792
+ test(
1793
+ "handles empty result when no records match",
1794
+ async () => {
1795
+ const response = await qb.deleteRecords({
1796
+ body: { from: TABLE_ID, where: "{3.EX.'999999'}" },
1797
+ });
1798
+ expect(response).toEqual({ numberDeleted: 0 });
1799
+ },
1800
+ { timeout: 10000 }
1801
+ );
1802
+ });
1803
+ - name: upsert.test.ts
1804
+ type: file
1805
+ contents: |
1806
+ // tests/vitest/qb/records/upsert.test.ts
1807
+ import { describe, test, expect, beforeEach, afterEach } from "vitest";
1808
+ import { quickbase } from "@/quickbaseClient.ts";
1809
+
1810
+ const TABLE_ID = "buwai2zws";
1811
+ const MARKER_FIELD_ID = 6; // Text field for marking test records
1812
+
1813
+ describe("QuickbaseClient - Upsert Integration", () => {
1814
+ const qb = quickbase({
1815
+ realm: "builderprogram-dbradford6815",
1816
+ userToken: process.env.QB_USER_TOKEN,
1817
+ debug: true,
1818
+ });
1819
+
1820
+ beforeEach(async () => {
1821
+ try {
1822
+ await qb.deleteRecords({
1823
+ body: {
1824
+ from: TABLE_ID,
1825
+ where: `{${MARKER_FIELD_ID}.CT.'test-marker-upsert'}`,
1826
+ },
1827
+ });
1828
+ } catch (e) {
1829
+ // Ignore if no records exist
1830
+ }
1831
+ });
1832
+
1833
+ afterEach(async () => {
1834
+ try {
1835
+ await qb.deleteRecords({
1836
+ body: {
1837
+ from: TABLE_ID,
1838
+ where: `{${MARKER_FIELD_ID}.CT.'test-marker-upsert'}`,
1839
+ },
1840
+ });
1841
+ } catch (e) {}
1842
+ });
1843
+
1844
+ test(
1845
+ "creates a new record successfully",
1846
+ async () => {
1847
+ const response = await qb.upsert({
1848
+ body: {
1849
+ to: TABLE_ID,
1850
+ data: [{ [MARKER_FIELD_ID]: { value: "test-marker-upsert" } }],
1851
+ fieldsToReturn: [MARKER_FIELD_ID, 3], // Return marker and record ID
1852
+ },
1853
+ });
1854
+
1855
+ expect(response.metadata.createdRecordIds.length).toBe(1);
1856
+ expect(response.data).toHaveLength(1);
1857
+ expect(response.data[0][MARKER_FIELD_ID].value).toBe(
1858
+ "test-marker-upsert"
1859
+ );
1860
+ expect(response.data[0][3].value).toBeDefined(); // Record ID assigned by QuickBase
1861
+ expect(response.metadata.totalNumberOfRecordsProcessed).toBe(1);
1862
+ },
1863
+ { timeout: 10000 }
1864
+ );
1865
+
1866
+ test(
1867
+ "handles empty data gracefully",
1868
+ async () => {
1869
+ await expect(
1870
+ qb.upsert({
1871
+ body: { to: TABLE_ID, data: [] },
1872
+ })
1873
+ ).rejects.toThrow("API Error: Bad Request (Status: 400)");
1874
+ },
1875
+ { timeout: 10000 }
1876
+ );
1877
+ });
1878
+ - name: tables
1879
+ type: directory
1880
+ children:
1881
+ - name: createTable.test.ts
1882
+ type: file
1883
+ contents: |
1884
+ import { test, expect } from "vitest";
1885
+ import { quickbase } from "../../../../src/quickbaseClient";
1886
+
1887
+ test(
1888
+ "QuickbaseClient Integration - createTable > creates a new table in QuickBase",
1889
+ { timeout: 10000 },
1890
+ async () => {
1891
+ const config = {
1892
+ realm: process.env.QB_REALM || "",
1893
+ userToken: process.env.QB_USER_TOKEN || "",
1894
+ debug: true,
1895
+ };
1896
+ const client = quickbase(config);
1897
+ const appId = "buwai2zpe";
1898
+
1899
+ const tableName = `TestTable_${Date.now()}`;
1900
+ const createBody = {
1901
+ name: tableName,
1902
+ description: "Test table creation",
1903
+ singleRecordName: "TestRecord",
1904
+ pluralRecordName: "TestRecords",
1905
+ };
1906
+
1907
+ console.log("Config used:", config);
1908
+ console.log("Creating table with:", createBody);
1909
+ const response = await client.createTable({ appId, body: createBody });
1910
+
1911
+ expect(response).toBeDefined();
1912
+ expect(response.id).toBeDefined();
1913
+ expect(response.name).toBe(tableName);
1914
+ expect(response.description).toBe(createBody.description);
1915
+ expect(response.singleRecordName).toBe(createBody.singleRecordName);
1916
+ expect(response.pluralRecordName).toBe(createBody.pluralRecordName);
1917
+ expect(response.alias).toMatch(/^_DBID_/);
1918
+ expect(response.created).toBeInstanceOf(Date);
1919
+ expect(response.updated).toBeInstanceOf(Date);
1920
+ expect(response.nextRecordId).toBeGreaterThanOrEqual(1);
1921
+ expect(response.nextFieldId).toBeGreaterThanOrEqual(1);
1922
+ expect(response.defaultSortFieldId).toBeGreaterThanOrEqual(0);
1923
+ expect(response.keyFieldId).toBeGreaterThanOrEqual(1);
1924
+ expect(response.sizeLimit).toMatch(/^\d+\sMB$/); // e.g., "500 MB"
1925
+ expect(response.spaceUsed).toMatch(/^\d+\s(KB|MB)$/); // e.g., "0 KB"
1926
+ expect(response.spaceRemaining).toMatch(/^\d+\sMB$/); // e.g., "500 MB"
1927
+
1928
+ console.log("Real API response:", response);
1929
+
1930
+ // Cleanup: Delete the table to avoid clutter
1931
+ const deleteResponse = await client.deleteTable({
1932
+ tableId: response.id,
1933
+ appId,
1934
+ });
1935
+ expect(deleteResponse.deletedTableId).toBe(response.id);
1936
+ console.log("Cleanup - Deleted table:", deleteResponse);
1937
+ }
1938
+ );
1939
+ - name: deleteTable.test.ts
1940
+ type: file
1941
+ contents: |
1942
+ import { test, expect } from "vitest";
1943
+ import { quickbase } from "../../../../src/quickbaseClient";
1944
+
1945
+ test(
1946
+ "QuickbaseClient Integration - deleteTable > deletes a table in QuickBase",
1947
+ { timeout: 20000 },
1948
+ async () => {
1949
+ const config = {
1950
+ realm: process.env.QB_REALM || "",
1951
+ userToken: process.env.QB_USER_TOKEN || "",
1952
+ debug: true,
1953
+ };
1954
+ const client = quickbase(config);
1955
+ const appId = "buwai2zpe";
1956
+
1957
+ // Step 1: Create a temporary table to delete
1958
+ const tableName = `DeleteTest_${Date.now()}`;
1959
+ const createBody = {
1960
+ name: tableName,
1961
+ description: "Temporary table for delete test",
1962
+ singleRecordName: "DeleteTest",
1963
+ pluralRecordName: "DeleteTests",
1964
+ };
1965
+ console.log("Creating temporary table with:", createBody);
1966
+ const createResponse = await client.createTable({
1967
+ appId,
1968
+ body: createBody,
1969
+ });
1970
+ expect(createResponse.id).toBeDefined();
1971
+ expect(createResponse.name).toBe(tableName);
1972
+ console.log("Created table:", createResponse);
1973
+ const tableId = createResponse.id;
1974
+
1975
+ // Step 2: Delete the table
1976
+ console.log("Deleting table:", { tableId, appId });
1977
+ const deleteResponse = await client.deleteTable({ tableId, appId });
1978
+ expect(deleteResponse).toBeDefined();
1979
+ expect(deleteResponse.deletedTableId).toBe(tableId);
1980
+ console.log("Delete API response:", deleteResponse);
1981
+
1982
+ // Step 3: Verify the table is gone
1983
+ try {
1984
+ await client.getTable({ tableId, appId });
1985
+ throw new Error("Table should not exist after deletion");
1986
+ } catch (error) {
1987
+ expect(error.message).toMatch(/404|not found/i); // Expect a 404 error
1988
+ console.log("Verified table deletion:", error.message);
1989
+ }
1990
+ }
1991
+ );
1992
+ - name: getAppTables.test.ts
1993
+ type: file
1994
+ contents: |
1995
+ import { test, expect } from "vitest";
1996
+ import { quickbase } from "../../../../src/quickbaseClient";
1997
+
1998
+ test(
1999
+ "QuickbaseClient Integration - getAppTables > fetches real table data from QuickBase",
2000
+ { timeout: 10000 },
2001
+ async () => {
2002
+ const config = {
2003
+ realm: process.env.QB_REALM || "",
2004
+ userToken: process.env.QB_USER_TOKEN || "",
2005
+ debug: true,
2006
+ };
2007
+ const client = quickbase(config);
2008
+ const tablesAppId = "buwai2zpe";
2009
+
2010
+ console.log("Config used:", config);
2011
+ const result = await client.getAppTables({ appId: tablesAppId });
2012
+ console.log("Real API response:", result);
2013
+
2014
+ expect(result).toBeDefined();
2015
+ expect(result).toBeInstanceOf(Array);
2016
+ expect(result.length).toBeGreaterThan(0);
2017
+ expect(result).toEqual(
2018
+ expect.arrayContaining([
2019
+ expect.objectContaining({
2020
+ id: "buwai2zr4",
2021
+ alias: "_DBID_ROOT",
2022
+ name: expect.any(String), // Allow dynamic name due to updateTable
2023
+ description: expect.any(String), // Allow dynamic description
2024
+ created: expect.any(Date),
2025
+ updated: expect.any(Date), // Allow varying timestamps
2026
+ nextRecordId: expect.any(Number),
2027
+ nextFieldId: expect.any(Number),
2028
+ defaultSortFieldId: expect.any(Number),
2029
+ defaultSortOrder: "DESC",
2030
+ keyFieldId: expect.any(Number),
2031
+ singleRecordName: "Root",
2032
+ pluralRecordName: "Roots",
2033
+ sizeLimit: "500 MB",
2034
+ spaceUsed: expect.any(String),
2035
+ spaceRemaining: "500 MB",
2036
+ }),
2037
+ ])
2038
+ );
2039
+ }
2040
+ );
2041
+ - name: getTable.test.ts
2042
+ type: file
2043
+ contents: |
2044
+ import { test, expect } from "vitest";
2045
+ import { quickbase } from "../../../../src/quickbaseClient";
2046
+
2047
+ test(
2048
+ "QuickbaseClient Integration - getTable > fetches real table data from QuickBase",
2049
+ { timeout: 10000 },
2050
+ async () => {
2051
+ const config = {
2052
+ realm: process.env.QB_REALM || "",
2053
+ userToken: process.env.QB_USER_TOKEN || "",
2054
+ debug: true,
2055
+ };
2056
+ const client = quickbase(config);
2057
+ const tableId = "buwai2zr4";
2058
+ const appId = "buwai2zpe";
2059
+
2060
+ console.log("Config used:", config);
2061
+ const response = await client.getTable({ tableId, appId });
2062
+ expect(response).toBeDefined();
2063
+ expect(response.id).toBe(tableId);
2064
+ expect(response.name).toBe("Root"); // Expect original name
2065
+ expect(response.alias).toBe("_DBID_ROOT");
2066
+ expect(response.created).toBeInstanceOf(Date);
2067
+ console.log("Real API response:", response);
2068
+ }
2069
+ );
2070
+ - name: updateTable.test.ts
2071
+ type: file
2072
+ contents: |
2073
+ import { test, expect } from "vitest";
2074
+ import { quickbase } from "../../../../src/quickbaseClient";
2075
+
2076
+ test(
2077
+ "QuickbaseClient Integration - updateTable > updates real table data in QuickBase",
2078
+ { timeout: 10000 },
2079
+ async () => {
2080
+ const config = {
2081
+ realm: process.env.QB_REALM || "",
2082
+ userToken: process.env.QB_USER_TOKEN || "",
2083
+ debug: true,
2084
+ };
2085
+ const client = quickbase(config);
2086
+ const appId = "buwai2zpe";
2087
+ const tableId = "buwai2zr4";
2088
+ const updatedBody = {
2089
+ name: "Root Updated " + Date.now(),
2090
+ description: "Integration test update",
2091
+ };
2092
+ const originalBody = {
2093
+ name: "Root",
2094
+ description: "",
2095
+ };
2096
+
2097
+ console.log("Config used:", config);
2098
+ // Update the table
2099
+ const response = await client.updateTable({
2100
+ tableId,
2101
+ appId,
2102
+ body: updatedBody,
2103
+ });
2104
+ expect(response).toBeDefined();
2105
+ expect(response.id).toBe(tableId);
2106
+ expect(response.name).toBe(updatedBody.name);
2107
+ expect(response.description).toBe(updatedBody.description);
2108
+ console.log("Real API response:", response);
2109
+
2110
+ // Cleanup: Revert the table to original state
2111
+ const cleanupResponse = await client.updateTable({
2112
+ tableId,
2113
+ appId,
2114
+ body: originalBody,
2115
+ });
2116
+ expect(cleanupResponse.name).toBe(originalBody.name);
2117
+ expect(cleanupResponse.description).toBe(originalBody.description);
2118
+ console.log("Cleanup API response:", cleanupResponse);
2119
+ }
2120
+ );
2121
+ - name: unit
2122
+ type: directory
2123
+ children:
2124
+ - name: apps
2125
+ type: directory
2126
+ children:
2127
+ - name: getApp.test.ts
2128
+ type: file
2129
+ contents: |
2130
+ import { describe, it, expect, beforeEach } from "vitest";
2131
+ import { createClient, mockFetch } from "@tests/setup.ts";
2132
+
2133
+ describe("QuickbaseClient - getApp (Unit)", () => {
2134
+ const client = createClient(mockFetch);
2135
+
2136
+ beforeEach(() => {
2137
+ mockFetch.mockClear();
2138
+ });
2139
+
2140
+ it("initializes without errors", () => {
2141
+ expect(client).toBeDefined();
2142
+ });
2143
+
2144
+ it("has getApp method", () => {
2145
+ expect(typeof client.getApp).toBe("function");
2146
+ });
2147
+
2148
+ it("calls getApp successfully", async () => {
2149
+ mockFetch.mockImplementation((url: string, options: any) => {
2150
+ console.log("Mock fetch:", url, options);
2151
+ return Promise.resolve({
2152
+ ok: true,
2153
+ status: 200,
2154
+ json: () =>
2155
+ Promise.resolve({
2156
+ id: process.env.QB_APP_ID,
2157
+ name: "qb-copy",
2158
+ created: "2025-02-13T18:22:33Z",
2159
+ updated: "2025-03-04T04:25:51Z",
2160
+ description: "",
2161
+ timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
2162
+ dateFormat: "MM-DD-YYYY",
2163
+ hasEveryoneOnTheInternet: false,
2164
+ memoryInfo: { estMemory: 0, estMemoryInclDependentApps: 0 },
2165
+ securityProperties: {
2166
+ allowClone: false,
2167
+ allowExport: true,
2168
+ enableAppTokens: true,
2169
+ hideFromPublic: false,
2170
+ mustBeRealmApproved: false,
2171
+ useIPFilter: false,
2172
+ },
2173
+ }),
2174
+ } as Response);
2175
+ });
2176
+
2177
+ const getAppId = process.env.QB_APP_ID;
2178
+ if (!getAppId) throw new Error("QB_APP_ID is not defined in .env");
2179
+ console.log("Test appId:", getAppId);
2180
+ const result = await client.getApp({ appId: getAppId });
2181
+ expect(result).toEqual({
2182
+ id: getAppId,
2183
+ name: "qb-copy",
2184
+ created: new Date("2025-02-13T18:22:33Z"),
2185
+ updated: new Date("2025-03-04T04:25:51Z"),
2186
+ description: "",
2187
+ timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
2188
+ dateFormat: "MM-DD-YYYY",
2189
+ hasEveryoneOnTheInternet: false,
2190
+ memoryInfo: { estMemory: 0, estMemoryInclDependentApps: 0 },
2191
+ securityProperties: {
2192
+ allowClone: false,
2193
+ allowExport: true,
2194
+ enableAppTokens: true,
2195
+ hideFromPublic: false,
2196
+ mustBeRealmApproved: false,
2197
+ useIPFilter: false,
2198
+ },
2199
+ });
2200
+ expect(mockFetch).toHaveBeenCalledWith(
2201
+ `https://api.quickbase.com/v1/apps/${getAppId}`,
2202
+ expect.objectContaining({
2203
+ headers: expect.objectContaining({
2204
+ Authorization: `QB-USER-TOKEN ${process.env.QB_USER_TOKEN}`,
2205
+ "QB-Realm-Hostname": `${process.env.QB_REALM}.quickbase.com`,
2206
+ }),
2207
+ })
2208
+ );
2209
+ });
2210
+ });
2211
+ - name: auth
2212
+ type: directory
2213
+ children:
2214
+ - name: fetchTempToken401.test.ts
2215
+ type: file
2216
+ contents: |
2217
+ import { describe, it, expect, beforeEach, vi } from "vitest";
2218
+ import { createClient, mockFetch } from "@tests/setup.ts";
2219
+
2220
+ describe("QuickbaseClient - 401 with fetchTempToken 401", () => {
2221
+ let client: ReturnType<typeof createClient>;
2222
+
2223
+ beforeEach(() => {
2224
+ mockFetch.mockClear();
2225
+ client = createClient(mockFetch, { useTempTokens: true, debug: true });
2226
+ });
2227
+
2228
+ it("fails without infinite loop when fetchTempToken returns 401 after initial 401", async () => {
2229
+ const mockDbid = "mockDbid123";
2230
+ let callCount = 0;
2231
+
2232
+ mockFetch.mockImplementation((url) => {
2233
+ callCount++;
2234
+ console.log(`Mock fetch call ${callCount}: ${url}`);
2235
+ if (url.includes("auth/temporary") && callCount === 1) {
2236
+ return Promise.resolve({
2237
+ ok: true,
2238
+ status: 200,
2239
+ json: () =>
2240
+ Promise.resolve({ temporaryAuthorization: "initial_token" }),
2241
+ });
2242
+ }
2243
+ if (url.includes("fields") && callCount === 2) {
2244
+ return Promise.resolve({
2245
+ ok: false,
2246
+ status: 401,
2247
+ json: () => Promise.resolve({ message: "Unauthorized" }),
2248
+ });
2249
+ }
2250
+ if (url.includes("auth/temporary") && callCount === 3) {
2251
+ return Promise.resolve({
2252
+ ok: false,
2253
+ status: 401,
2254
+ json: () =>
2255
+ Promise.resolve({ message: "Unauthorized in fetchTempToken" }),
2256
+ });
2257
+ }
2258
+ return Promise.reject(new Error(`Unexpected fetch call: ${url}`));
2259
+ });
2260
+
2261
+ const consoleSpy = vi.spyOn(console, "log");
2262
+ await expect(client.getFields({ tableId: mockDbid })).rejects.toThrow(
2263
+ "API Error: Unauthorized in fetchTempToken (Status: 401)"
2264
+ );
2265
+
2266
+ expect(mockFetch).toHaveBeenCalledTimes(3);
2267
+ expect(consoleSpy).toHaveBeenCalledWith(
2268
+ "Authorization error for getFields, refreshing token:",
2269
+ expect.any(String)
2270
+ );
2271
+ expect(consoleSpy).not.toHaveBeenCalledWith(
2272
+ "Retrying getFields with new token"
2273
+ );
2274
+ consoleSpy.mockRestore();
2275
+ });
2276
+ });
2277
+ - name: getTempToken.test.ts
2278
+ type: file
2279
+ contents: |
2280
+ import { describe, it, expect, beforeEach } from "vitest";
2281
+ import { createClient, mockFetch } from "@tests/setup.ts";
2282
+
2283
+ describe("QuickbaseClient - getTempTokenDBID (Unit)", () => {
2284
+ let client: ReturnType<typeof createClient>;
2285
+
2286
+ beforeEach(() => {
2287
+ mockFetch.mockClear();
2288
+ client = createClient(mockFetch, { useTempTokens: true, debug: false });
2289
+ });
2290
+
2291
+ it("initializes without errors", () => {
2292
+ expect(client).toBeDefined();
2293
+ });
2294
+
2295
+ it("has getTempTokenDBID method", () => {
2296
+ expect(typeof client.getTempTokenDBID).toBe("function");
2297
+ });
2298
+
2299
+ it("fetches and caches temp token on first call", async () => {
2300
+ const mockDbid = "mockDbid123";
2301
+ const mockToken = "b123xyz_temp_token";
2302
+
2303
+ mockFetch.mockResolvedValueOnce({
2304
+ ok: true,
2305
+ status: 200,
2306
+ json: () => Promise.resolve({ temporaryAuthorization: mockToken }),
2307
+ });
2308
+
2309
+ const result = await client.getTempTokenDBID({ dbid: mockDbid });
2310
+ expect(result).toEqual({ temporaryAuthorization: mockToken });
2311
+ expect(mockFetch).toHaveBeenCalledWith(
2312
+ `https://api.quickbase.com/v1/auth/temporary/${mockDbid}`,
2313
+ expect.objectContaining({
2314
+ method: "GET",
2315
+ headers: expect.objectContaining({
2316
+ "QB-Realm-Hostname": `${process.env.QB_REALM}.quickbase.com`,
2317
+ "Content-Type": "application/json",
2318
+ }),
2319
+ credentials: "include",
2320
+ })
2321
+ );
2322
+ });
2323
+
2324
+ it("reuses cached temp token on second call", async () => {
2325
+ const mockDbid = "mockDbid123";
2326
+ const mockToken = "b123xyz_temp_token";
2327
+
2328
+ mockFetch.mockResolvedValueOnce({
2329
+ ok: true,
2330
+ status: 200,
2331
+ json: () => Promise.resolve({ temporaryAuthorization: mockToken }),
2332
+ });
2333
+
2334
+ const firstResult = await client.getTempTokenDBID({ dbid: mockDbid });
2335
+ expect(firstResult).toEqual({ temporaryAuthorization: mockToken });
2336
+ expect(mockFetch).toHaveBeenCalledTimes(1);
2337
+
2338
+ mockFetch.mockClear();
2339
+ const secondResult = await client.getTempTokenDBID({ dbid: mockDbid });
2340
+ expect(secondResult).toEqual({ temporaryAuthorization: mockToken });
2341
+ expect(mockFetch).not.toHaveBeenCalled();
2342
+ });
2343
+
2344
+ it("handles API error", async () => {
2345
+ const mockDbid = "mockDbid123";
2346
+
2347
+ mockFetch.mockResolvedValueOnce({
2348
+ ok: false,
2349
+ status: 401,
2350
+ json: () => Promise.resolve({ message: "Unauthorized" }),
2351
+ });
2352
+
2353
+ await expect(client.getTempTokenDBID({ dbid: mockDbid })).rejects.toSatisfy(
2354
+ (error: Error) => {
2355
+ expect(error).toBeInstanceOf(Error);
2356
+ expect(error.message).toBe("API Error: Unauthorized (Status: 401)");
2357
+ return true;
2358
+ }
2359
+ );
2360
+ });
2361
+ });
2362
+ - name: retryOn401.test.ts
2363
+ type: file
2364
+ contents: |
2365
+ import { describe, it, expect, beforeEach, vi } from "vitest";
2366
+ import { createClient, mockFetch } from "@tests/setup.ts";
2367
+
2368
+ describe("QuickbaseClient - 401 Retry Creates New Token", () => {
2369
+ let client: ReturnType<typeof createClient>;
2370
+
2371
+ beforeEach(() => {
2372
+ mockFetch.mockClear();
2373
+ client = createClient(mockFetch, { useTempTokens: true, debug: true });
2374
+ });
2375
+
2376
+ it("creates a new token on 401 and retries successfully", async () => {
2377
+ const mockDbid = "mockDbid123";
2378
+ const mockToken = "new_token_456";
2379
+ const mockFields = [{ id: 1, label: "Field1" }];
2380
+ let callCount = 0;
2381
+
2382
+ mockFetch.mockImplementation((url) => {
2383
+ callCount++;
2384
+ console.log(`Mock fetch call ${callCount}: ${url}`);
2385
+ if (url.includes("auth/temporary") && callCount === 1) {
2386
+ return Promise.resolve({
2387
+ ok: true,
2388
+ status: 200,
2389
+ json: () => Promise.resolve({ temporaryAuthorization: mockToken }),
2390
+ });
2391
+ }
2392
+ if (url.includes("fields") && callCount === 2) {
2393
+ return Promise.resolve({
2394
+ ok: false,
2395
+ status: 401,
2396
+ text: () => Promise.resolve("Unauthorized"),
2397
+ });
2398
+ }
2399
+ if (url.includes("auth/temporary") && callCount === 3) {
2400
+ return Promise.resolve({
2401
+ ok: true,
2402
+ status: 200,
2403
+ json: () =>
2404
+ Promise.resolve({ temporaryAuthorization: mockToken + "_retry" }),
2405
+ });
2406
+ }
2407
+ if (url.includes("fields") && callCount === 4) {
2408
+ return Promise.resolve({
2409
+ ok: true,
2410
+ status: 200,
2411
+ json: () => Promise.resolve(mockFields),
2412
+ });
2413
+ }
2414
+ return Promise.reject(new Error(`Unexpected fetch call: ${url}`));
2415
+ });
2416
+
2417
+ const consoleSpy = vi.spyOn(console, "log");
2418
+ const result = await client.getFields({ tableId: mockDbid });
2419
+
2420
+ expect(result).toEqual(mockFields);
2421
+ expect(mockFetch).toHaveBeenCalledTimes(4);
2422
+ expect(consoleSpy).toHaveBeenCalledWith(
2423
+ "Authorization error for getFields, refreshing token:",
2424
+ expect.any(String)
2425
+ );
2426
+ expect(consoleSpy).toHaveBeenCalledWith(
2427
+ "Fetched and cached new token for dbid: mockDbid123",
2428
+ mockToken + "_retry",
2429
+ expect.any(String)
2430
+ );
2431
+ expect(consoleSpy).toHaveBeenCalledWith(
2432
+ "Retrying getFields with new token"
2433
+ );
2434
+ consoleSpy.mockRestore();
2435
+ });
2436
+ });
2437
+ - name: two401s.test.ts
2438
+ type: file
2439
+ contents: |
2440
+ import { describe, it, expect, beforeEach, vi } from "vitest";
2441
+ import { createClient, mockFetch } from "@tests/setup.ts";
2442
+
2443
+ describe("QuickbaseClient - Two 401s in a Row", () => {
2444
+ let client: ReturnType<typeof createClient>;
2445
+
2446
+ beforeEach(() => {
2447
+ mockFetch.mockClear();
2448
+ client = createClient(mockFetch, { useTempTokens: true, debug: true });
2449
+ });
2450
+
2451
+ it("logs an error after two 401s in a row", async () => {
2452
+ const mockDbid = "mockDbid123";
2453
+ const mockToken = "new_token_456";
2454
+ let callCount = 0;
2455
+
2456
+ mockFetch.mockImplementation((url) => {
2457
+ callCount++;
2458
+ console.log(`Mock fetch call ${callCount}: ${url}`);
2459
+ if (url.includes("auth/temporary") && callCount === 1) {
2460
+ return Promise.resolve({
2461
+ ok: true,
2462
+ status: 200,
2463
+ json: () => Promise.resolve({ temporaryAuthorization: mockToken }),
2464
+ });
2465
+ }
2466
+ if (url.includes("fields") && callCount === 2) {
2467
+ return Promise.resolve({
2468
+ ok: false,
2469
+ status: 401,
2470
+ text: () => Promise.resolve("Unauthorized"),
2471
+ });
2472
+ }
2473
+ if (url.includes("auth/temporary") && callCount === 3) {
2474
+ return Promise.resolve({
2475
+ ok: true,
2476
+ status: 200,
2477
+ json: () =>
2478
+ Promise.resolve({ temporaryAuthorization: mockToken + "_retry" }),
2479
+ });
2480
+ }
2481
+ if (url.includes("fields") && callCount === 4) {
2482
+ return Promise.resolve({
2483
+ ok: false,
2484
+ status: 401,
2485
+ json: () => Promise.resolve({ message: "Unauthorized again" }), // Changed to json()
2486
+ text: () => Promise.resolve("Unauthorized again"), // Keep text() for fallback
2487
+ });
2488
+ }
2489
+ return Promise.reject(new Error(`Unexpected fetch call: ${url}`));
2490
+ });
2491
+
2492
+ const consoleSpy = vi.spyOn(console, "log");
2493
+ await expect(client.getFields({ tableId: mockDbid })).rejects.toThrow(
2494
+ "API Error: Unauthorized again (Status: 401)"
2495
+ );
2496
+
2497
+ expect(mockFetch).toHaveBeenCalledTimes(4);
2498
+ expect(consoleSpy).toHaveBeenCalledWith(
2499
+ "Authorization error for getFields, refreshing token:",
2500
+ expect.any(String)
2501
+ );
2502
+ expect(consoleSpy).toHaveBeenCalledWith(
2503
+ "Fetched and cached new token for dbid: mockDbid123",
2504
+ mockToken + "_retry",
2505
+ expect.any(String)
2506
+ );
2507
+ expect(consoleSpy).toHaveBeenCalledWith(
2508
+ "Retrying getFields with new token"
2509
+ );
2510
+ expect(consoleSpy).toHaveBeenCalledWith(
2511
+ "Error response body for getFields:",
2512
+ { message: "Unauthorized again" }
2513
+ );
2514
+ consoleSpy.mockRestore();
2515
+ });
2516
+ });
2517
+ - name: fields
2518
+ type: directory
2519
+ children:
2520
+ - name: getFields.test.ts
2521
+ type: file
2522
+ contents: |
2523
+ import { describe, it, expect } from "vitest";
2524
+ import { createClient, mockFetch } from "@tests/setup.ts";
2525
+
2526
+ describe("QuickbaseClient - getFields (Unit)", () => {
2527
+ it("calls getFields successfully", async () => {
2528
+ mockFetch.mockImplementation((url: string, options: any) => {
2529
+ console.log("Mock fetch for getFields:", url, options);
2530
+ return Promise.resolve({
2531
+ ok: true,
2532
+ status: 200,
2533
+ json: () =>
2534
+ Promise.resolve([
2535
+ {
2536
+ id: 1,
2537
+ label: "Field1",
2538
+ fieldType: "text",
2539
+ noWrap: false,
2540
+ bold: false,
2541
+ required: false,
2542
+ appearsByDefault: false,
2543
+ findEnabled: false,
2544
+ unique: false,
2545
+ doesDataCopy: false,
2546
+ fieldHelp: "field help",
2547
+ audited: false,
2548
+ properties: {
2549
+ primaryKey: false,
2550
+ foreignKey: false,
2551
+ numLines: 1,
2552
+ maxLength: 0,
2553
+ appendOnly: false,
2554
+ allowHTML: false,
2555
+ allowMentions: false,
2556
+ sortAsGiven: false,
2557
+ carryChoices: true,
2558
+ allowNewChoices: false,
2559
+ formula: "",
2560
+ defaultValue: "",
2561
+ },
2562
+ permissions: [
2563
+ { permissionType: "View", role: "Viewer", roleId: 10 },
2564
+ { permissionType: "None", role: "Participant", roleId: 11 },
2565
+ { permissionType: "Modify", role: "Administrator", roleId: 12 },
2566
+ ],
2567
+ },
2568
+ ]),
2569
+ } as Response);
2570
+ });
2571
+
2572
+ const client = createClient(mockFetch);
2573
+ const result = await client.getFields({
2574
+ tableId: "dummyTableId",
2575
+ includeFieldPerms: true,
2576
+ });
2577
+ console.log("getFields response:", result);
2578
+ expect(result).toEqual(
2579
+ expect.arrayContaining([
2580
+ expect.objectContaining({
2581
+ id: 1,
2582
+ label: "Field1",
2583
+ fieldType: "text",
2584
+ noWrap: false,
2585
+ bold: false,
2586
+ required: false,
2587
+ appearsByDefault: false,
2588
+ findEnabled: false,
2589
+ unique: false,
2590
+ doesDataCopy: false,
2591
+ fieldHelp: "field help",
2592
+ audited: false,
2593
+ properties: expect.objectContaining({
2594
+ primaryKey: false,
2595
+ foreignKey: false,
2596
+ numLines: 1,
2597
+ maxLength: 0,
2598
+ appendOnly: false,
2599
+ allowHTML: false,
2600
+ allowMentions: false,
2601
+ sortAsGiven: false,
2602
+ carryChoices: true,
2603
+ allowNewChoices: false,
2604
+ formula: "",
2605
+ defaultValue: "",
2606
+ }),
2607
+ permissions: expect.arrayContaining([
2608
+ expect.objectContaining({
2609
+ permissionType: "View",
2610
+ role: "Viewer",
2611
+ roleId: 10,
2612
+ }),
2613
+ expect.objectContaining({
2614
+ permissionType: "None",
2615
+ role: "Participant",
2616
+ roleId: 11,
2617
+ }),
2618
+ expect.objectContaining({
2619
+ permissionType: "Modify",
2620
+ role: "Administrator",
2621
+ roleId: 12,
2622
+ }),
2623
+ ]),
2624
+ }),
2625
+ ])
2626
+ );
2627
+ expect(mockFetch).toHaveBeenCalledWith(
2628
+ `https://api.quickbase.com/v1/fields?tableId=dummyTableId&includeFieldPerms=true`,
2629
+ expect.objectContaining({
2630
+ headers: expect.objectContaining({
2631
+ Authorization: `QB-USER-TOKEN ${process.env.QB_USER_TOKEN}`,
2632
+ "QB-Realm-Hostname": `${process.env.QB_REALM}.quickbase.com`,
2633
+ }),
2634
+ })
2635
+ );
2636
+ });
2637
+ });
2638
+ - name: index.ts
2639
+ type: file
2640
+ contents: |
2641
+ // tests/unit/index.ts
2642
+ export * from "./apps/getApp.test.ts";
2643
+ export * from "./fields/getFields.test.ts";
2644
+ export * from "./tables/getAppTables.test.ts";
2645
+ - name: records
2646
+ type: directory
2647
+ children:
2648
+ - name: deleteRecords.test.ts
2649
+ type: file
2650
+ contents: |
2651
+ // tests/vitest/unit/records/deleteRecords.test.ts
2652
+ import { describe, expect, test, beforeEach } from "vitest"; // Added 'describe'
2653
+ import { createClient, mockFetch } from "@tests/setup.ts";
2654
+
2655
+ describe("QuickbaseClient - deleteRecords (Unit)", () => {
2656
+ beforeEach(() => {
2657
+ mockFetch.mockClear(); // Clear mock state between tests
2658
+ });
2659
+
2660
+ test("deleteRecords - sends correct DELETE request and handles success", async () => {
2661
+ const qb = createClient(mockFetch, {
2662
+ realm: "test-realm",
2663
+ userToken: "test-token",
2664
+ });
2665
+
2666
+ mockFetch.mockResolvedValueOnce({
2667
+ ok: true,
2668
+ status: 200,
2669
+ json: () => Promise.resolve({ numberDeleted: 1 }),
2670
+ });
2671
+
2672
+ const result = await qb.deleteRecords({
2673
+ body: {
2674
+ from: "test-table-id",
2675
+ where: "{3.EX.'5'}", // Simulate deleting Record ID 5
2676
+ },
2677
+ });
2678
+
2679
+ expect(mockFetch).toHaveBeenCalledWith(
2680
+ "https://api.quickbase.com/v1/records",
2681
+ expect.objectContaining({
2682
+ method: "DELETE",
2683
+ headers: expect.objectContaining({
2684
+ "QB-Realm-Hostname": "test-realm.quickbase.com",
2685
+ Authorization: "QB-USER-TOKEN test-token",
2686
+ "Content-Type": "application/json",
2687
+ }),
2688
+ body: JSON.stringify({ from: "test-table-id", where: "{3.EX.'5'}" }),
2689
+ })
2690
+ );
2691
+ expect(result).toEqual({ numberDeleted: 1 });
2692
+ });
2693
+
2694
+ test("deleteRecords - handles no records deleted", async () => {
2695
+ const qb = createClient(mockFetch, {
2696
+ realm: "test-realm",
2697
+ userToken: "test-token",
2698
+ });
2699
+
2700
+ mockFetch.mockResolvedValueOnce({
2701
+ ok: true,
2702
+ status: 200,
2703
+ json: () => Promise.resolve({ numberDeleted: 0 }),
2704
+ });
2705
+
2706
+ const result = await qb.deleteRecords({
2707
+ body: {
2708
+ from: "test-table-id",
2709
+ where: "{3.EX.'999999'}", // Non-existent Record ID
2710
+ },
2711
+ });
2712
+
2713
+ expect(mockFetch).toHaveBeenCalledWith(
2714
+ "https://api.quickbase.com/v1/records",
2715
+ expect.objectContaining({
2716
+ method: "DELETE",
2717
+ headers: expect.objectContaining({
2718
+ "QB-Realm-Hostname": "test-realm.quickbase.com",
2719
+ Authorization: "QB-USER-TOKEN test-token",
2720
+ "Content-Type": "application/json",
2721
+ }),
2722
+ body: JSON.stringify({
2723
+ from: "test-table-id",
2724
+ where: "{3.EX.'999999'}",
2725
+ }),
2726
+ })
2727
+ );
2728
+ expect(result).toEqual({ numberDeleted: 0 });
2729
+ });
2730
+
2731
+ test("deleteRecords - throws error on API failure", async () => {
2732
+ const qb = createClient(mockFetch, {
2733
+ realm: "test-realm",
2734
+ userToken: "test-token",
2735
+ });
2736
+
2737
+ mockFetch.mockResolvedValueOnce({
2738
+ ok: false,
2739
+ status: 400,
2740
+ json: () => Promise.resolve({ message: "Invalid query" }),
2741
+ });
2742
+
2743
+ await expect(() =>
2744
+ qb.deleteRecords({
2745
+ body: {
2746
+ from: "test-table-id",
2747
+ where: "{3.EX.'invalid'}",
2748
+ },
2749
+ })
2750
+ ).rejects.toThrow("API Error: Invalid query (Status: 400)");
2751
+
2752
+ expect(mockFetch).toHaveBeenCalledWith(
2753
+ "https://api.quickbase.com/v1/records",
2754
+ expect.objectContaining({
2755
+ method: "DELETE",
2756
+ headers: expect.objectContaining({
2757
+ "QB-Realm-Hostname": "test-realm.quickbase.com",
2758
+ Authorization: "QB-USER-TOKEN test-token",
2759
+ "Content-Type": "application/json",
2760
+ }),
2761
+ body: JSON.stringify({
2762
+ from: "test-table-id",
2763
+ where: "{3.EX.'invalid'}",
2764
+ }),
2765
+ })
2766
+ );
2767
+ });
2768
+ });
2769
+ - name: upsert.test.ts
2770
+ type: file
2771
+ contents: |
2772
+ // tests/vitest/unit/records/upsert.test.ts
2773
+ import { describe, expect, test, beforeEach } from "vitest";
2774
+ import { createClient, mockFetch } from "@tests/setup.ts";
2775
+ import { vi } from "vitest";
2776
+
2777
+ // Note: Type augmentation moved to src/types.d.ts
2778
+ describe("QuickbaseClient - upsert (Unit)", () => {
2779
+ beforeEach(() => {
2780
+ vi.resetModules(); // Reset module cache
2781
+ mockFetch.mockClear();
2782
+ });
2783
+
2784
+ test("sends correct POST request and handles successful upsert", async () => {
2785
+ const qb = createClient(mockFetch, {
2786
+ realm: "test-realm",
2787
+ userToken: "test-token",
2788
+ debug: true,
2789
+ });
2790
+
2791
+ mockFetch.mockResolvedValueOnce({
2792
+ ok: true,
2793
+ status: 200,
2794
+ json: () =>
2795
+ Promise.resolve({
2796
+ data: [{ id: 1, "6": { value: "value1" } }],
2797
+ metadata: {
2798
+ createdRecordIds: [1],
2799
+ updatedRecordIds: [],
2800
+ unchangedRecordIds: [],
2801
+ totalNumberOfRecordsProcessed: 1,
2802
+ },
2803
+ }),
2804
+ });
2805
+
2806
+ console.log("[Test] Calling qb.upsert with:", {
2807
+ body: { to: "test-table-id", data: [{ "6": { value: "value1" } }] },
2808
+ });
2809
+ const result = await qb.upsert({
2810
+ body: { to: "test-table-id", data: [{ "6": { value: "value1" } }] },
2811
+ });
2812
+
2813
+ console.log("[Test] mockFetch calls:", mockFetch.mock.calls);
2814
+ expect(mockFetch).toHaveBeenCalledWith(
2815
+ "https://api.quickbase.com/v1/records",
2816
+ expect.objectContaining({
2817
+ method: "POST",
2818
+ headers: expect.objectContaining({
2819
+ "QB-Realm-Hostname": "test-realm.quickbase.com",
2820
+ Authorization: "QB-USER-TOKEN test-token",
2821
+ "Content-Type": "application/json",
2822
+ }),
2823
+ body: JSON.stringify({
2824
+ to: "test-table-id",
2825
+ data: [{ "6": { value: "value1" } }],
2826
+ }),
2827
+ })
2828
+ );
2829
+
2830
+ expect(result).toEqual({
2831
+ data: [{ id: 1, "6": { value: "value1" } }],
2832
+ metadata: {
2833
+ createdRecordIds: [1],
2834
+ updatedRecordIds: [],
2835
+ unchangedRecordIds: [],
2836
+ totalNumberOfRecordsProcessed: 1,
2837
+ },
2838
+ });
2839
+ });
2840
+
2841
+ test("handles API error with invalid data", async () => {
2842
+ const qb = createClient(mockFetch, {
2843
+ realm: "test-realm",
2844
+ userToken: "test-token",
2845
+ debug: true,
2846
+ });
2847
+
2848
+ mockFetch.mockResolvedValueOnce({
2849
+ ok: false,
2850
+ status: 400,
2851
+ json: () => Promise.resolve({ message: "Invalid data format" }),
2852
+ });
2853
+
2854
+ await expect(
2855
+ qb.upsert({
2856
+ body: { to: "test-table-id", data: [{ "999": { value: "invalid" } }] },
2857
+ })
2858
+ ).rejects.toThrow("API Error: Invalid data format (Status: 400)");
2859
+
2860
+ expect(mockFetch).toHaveBeenCalledWith(
2861
+ "https://api.quickbase.com/v1/records",
2862
+ expect.objectContaining({
2863
+ method: "POST",
2864
+ headers: expect.objectContaining({
2865
+ "QB-Realm-Hostname": "test-realm.quickbase.com",
2866
+ Authorization: "QB-USER-TOKEN test-token",
2867
+ "Content-Type": "application/json",
2868
+ }),
2869
+ body: JSON.stringify({
2870
+ to: "test-table-id",
2871
+ data: [{ "999": { value: "invalid" } }],
2872
+ }),
2873
+ })
2874
+ );
2875
+ });
2876
+
2877
+ test("handles upsert with temp token", async () => {
2878
+ const qb = createClient(mockFetch, {
2879
+ realm: "test-realm",
2880
+ useTempTokens: true,
2881
+ debug: true,
2882
+ });
2883
+
2884
+ mockFetch
2885
+ .mockResolvedValueOnce({
2886
+ ok: true,
2887
+ status: 200,
2888
+ json: () => Promise.resolve({ temporaryAuthorization: "temp-token" }),
2889
+ })
2890
+ .mockResolvedValueOnce({
2891
+ ok: true,
2892
+ status: 200,
2893
+ json: () =>
2894
+ Promise.resolve({
2895
+ data: [{ id: 2, "7": { value: "value2" } }],
2896
+ metadata: {
2897
+ createdRecordIds: [2],
2898
+ updatedRecordIds: [],
2899
+ unchangedRecordIds: [],
2900
+ totalNumberOfRecordsProcessed: 1,
2901
+ },
2902
+ }),
2903
+ });
2904
+
2905
+ const result = await qb.upsert({
2906
+ body: { to: "test-table-id", data: [{ "7": { value: "value2" } }] },
2907
+ dbid: "test-dbid",
2908
+ } as any); // Temporary type assertion until types.d.ts is applied
2909
+
2910
+ expect(mockFetch).toHaveBeenCalledTimes(2);
2911
+ expect(mockFetch).toHaveBeenNthCalledWith(
2912
+ 1,
2913
+ "https://api.quickbase.com/v1/auth/temporary/test-dbid",
2914
+ expect.objectContaining({
2915
+ method: "GET",
2916
+ headers: expect.objectContaining({
2917
+ "QB-Realm-Hostname": "test-realm.quickbase.com",
2918
+ "Content-Type": "application/json",
2919
+ }),
2920
+ credentials: "include",
2921
+ })
2922
+ );
2923
+ expect(mockFetch).toHaveBeenNthCalledWith(
2924
+ 2,
2925
+ "https://api.quickbase.com/v1/records",
2926
+ expect.objectContaining({
2927
+ method: "POST",
2928
+ headers: expect.objectContaining({
2929
+ "QB-Realm-Hostname": "test-realm.quickbase.com",
2930
+ Authorization: "QB-TEMP-TOKEN temp-token",
2931
+ "Content-Type": "application/json",
2932
+ }),
2933
+ body: JSON.stringify({
2934
+ to: "test-table-id",
2935
+ data: [{ "7": { value: "value2" } }],
2936
+ }),
2937
+ })
2938
+ );
2939
+
2940
+ expect(result).toEqual({
2941
+ data: [{ id: 2, "7": { value: "value2" } }],
2942
+ metadata: {
2943
+ createdRecordIds: [2],
2944
+ updatedRecordIds: [],
2945
+ unchangedRecordIds: [],
2946
+ totalNumberOfRecordsProcessed: 1,
2947
+ },
2948
+ });
2949
+ });
2950
+
2951
+ test("sends correct POST request with data fields", async () => {
2952
+ const qb = createClient(mockFetch, {
2953
+ realm: "test-realm",
2954
+ userToken: "test-token",
2955
+ debug: true,
2956
+ });
2957
+
2958
+ mockFetch.mockResolvedValueOnce({
2959
+ ok: true,
2960
+ status: 200,
2961
+ json: () =>
2962
+ Promise.resolve({
2963
+ data: [{ id: 1, "6": { value: "value1" } }],
2964
+ metadata: {
2965
+ createdRecordIds: [1],
2966
+ updatedRecordIds: [],
2967
+ unchangedRecordIds: [],
2968
+ totalNumberOfRecordsProcessed: 1,
2969
+ },
2970
+ }),
2971
+ });
2972
+
2973
+ const result = await qb.upsert({
2974
+ body: { to: "test-table-id", data: [{ "6": { value: "value1" } }] },
2975
+ });
2976
+
2977
+ expect(mockFetch).toHaveBeenCalledWith(
2978
+ "https://api.quickbase.com/v1/records",
2979
+ expect.objectContaining({
2980
+ method: "POST",
2981
+ headers: expect.objectContaining({
2982
+ "QB-Realm-Hostname": "test-realm.quickbase.com",
2983
+ Authorization: "QB-USER-TOKEN test-token",
2984
+ "Content-Type": "application/json",
2985
+ }),
2986
+ body: JSON.stringify({
2987
+ to: "test-table-id",
2988
+ data: [{ "6": { value: "value1" } }],
2989
+ }),
2990
+ })
2991
+ );
2992
+
2993
+ if (result.data && result.data.length > 0) {
2994
+ expect((result.data[0]["6"] as { value: any }).value).toBe("value1");
2995
+ } else {
2996
+ throw new Error("Expected data array to have at least one element");
2997
+ }
2998
+ });
2999
+ });
3000
+ - name: tables
3001
+ type: directory
3002
+ children:
3003
+ - name: createTable.test.ts
3004
+ type: file
3005
+ contents: |
3006
+ import { describe, it, expect, beforeEach, vi } from "vitest";
3007
+ import { createClient, mockFetch } from "@tests/setup.ts";
3008
+
3009
+ describe("QuickbaseClient - createTable (Unit)", () => {
3010
+ let client: ReturnType<typeof createClient>;
3011
+
3012
+ beforeEach(() => {
3013
+ mockFetch.mockClear();
3014
+ client = createClient(mockFetch, { debug: true });
3015
+ });
3016
+
3017
+ it("calls createTable successfully with user token", async () => {
3018
+ const appId = "buwai2zpe";
3019
+ const mockBody = {
3020
+ name: "TestTable",
3021
+ description: "Unit test table",
3022
+ singleRecordName: "Test",
3023
+ pluralRecordName: "Tests",
3024
+ };
3025
+ const mockResponse = {
3026
+ id: "buya8h9iz",
3027
+ name: "TestTable",
3028
+ alias: "_DBID_TESTTABLE",
3029
+ description: "Unit test table",
3030
+ created: new Date("2025-03-10T21:00:00.000Z"),
3031
+ updated: new Date("2025-03-10T21:00:00.000Z"),
3032
+ nextRecordId: 1,
3033
+ nextFieldId: 6,
3034
+ defaultSortFieldId: 2,
3035
+ defaultSortOrder: "DESC",
3036
+ keyFieldId: 3,
3037
+ singleRecordName: "Test",
3038
+ pluralRecordName: "Tests",
3039
+ sizeLimit: "500 MB",
3040
+ spaceUsed: "0 KB",
3041
+ spaceRemaining: "500 MB",
3042
+ };
3043
+
3044
+ mockFetch.mockResolvedValueOnce({
3045
+ ok: true,
3046
+ status: 200,
3047
+ json: () => Promise.resolve(mockResponse),
3048
+ });
3049
+
3050
+ const response = await client.createTable({ appId, body: mockBody });
3051
+ expect(response).toEqual(mockResponse);
3052
+ expect(mockFetch).toHaveBeenCalledTimes(1);
3053
+ expect(mockFetch).toHaveBeenCalledWith(
3054
+ `https://api.quickbase.com/v1/tables?appId=${appId}`,
3055
+ expect.objectContaining({
3056
+ method: "POST",
3057
+ headers: expect.objectContaining({
3058
+ "Content-Type": "application/json",
3059
+ "QB-Realm-Hostname": "builderprogram-dbradford6815.quickbase.com",
3060
+ Authorization:
3061
+ "QB-USER-TOKEN b9f3pk_q4jd_0_b4qu5eebyvuix3xs57ysd7zn3",
3062
+ }),
3063
+ body: JSON.stringify(mockBody),
3064
+ })
3065
+ );
3066
+ });
3067
+ });
3068
+ - name: deleteTable.test.ts
3069
+ type: file
3070
+ contents: |
3071
+ import { describe, it, expect, beforeEach, vi } from "vitest";
3072
+ import { createClient, mockFetch } from "@tests/setup.ts";
3073
+
3074
+ describe("QuickbaseClient - deleteTable (Unit)", () => {
3075
+ let client: ReturnType<typeof createClient>;
3076
+
3077
+ beforeEach(() => {
3078
+ mockFetch.mockClear();
3079
+ client = createClient(mockFetch, { debug: true });
3080
+ });
3081
+
3082
+ it("calls deleteTable successfully with user token", async () => {
3083
+ const appId = "buwai2zpe";
3084
+ const tableId = "buya8h9iz";
3085
+ const mockResponse = {
3086
+ deletedTableId: tableId,
3087
+ };
3088
+
3089
+ mockFetch.mockResolvedValueOnce({
3090
+ ok: true,
3091
+ status: 200,
3092
+ json: () => Promise.resolve(mockResponse),
3093
+ });
3094
+
3095
+ const response = await client.deleteTable({ tableId, appId });
3096
+ expect(response).toEqual(mockResponse);
3097
+ expect(mockFetch).toHaveBeenCalledTimes(1);
3098
+ expect(mockFetch).toHaveBeenCalledWith(
3099
+ `https://api.quickbase.com/v1/tables/${tableId}?appId=${appId}`,
3100
+ expect.objectContaining({
3101
+ method: "DELETE",
3102
+ headers: expect.objectContaining({
3103
+ "Content-Type": "application/json",
3104
+ "QB-Realm-Hostname": "builderprogram-dbradford6815.quickbase.com",
3105
+ Authorization:
3106
+ "QB-USER-TOKEN b9f3pk_q4jd_0_b4qu5eebyvuix3xs57ysd7zn3",
3107
+ }),
3108
+ })
3109
+ );
3110
+ });
3111
+
3112
+ it("handles 404 error for non-existent table", async () => {
3113
+ const appId = "buwai2zpe";
3114
+ const tableId = "nonexistent";
3115
+
3116
+ mockFetch.mockResolvedValueOnce({
3117
+ ok: false,
3118
+ status: 404,
3119
+ json: () =>
3120
+ Promise.resolve({
3121
+ message: "Invalid DBID",
3122
+ description: "Table not found in app.",
3123
+ }),
3124
+ });
3125
+
3126
+ await expect(client.deleteTable({ tableId, appId })).rejects.toThrow(
3127
+ "API Error: Invalid DBID (Status: 404)"
3128
+ );
3129
+ expect(mockFetch).toHaveBeenCalledTimes(1);
3130
+ expect(mockFetch).toHaveBeenCalledWith(
3131
+ `https://api.quickbase.com/v1/tables/${tableId}?appId=${appId}`,
3132
+ expect.objectContaining({
3133
+ method: "DELETE",
3134
+ headers: expect.any(Object),
3135
+ })
3136
+ );
3137
+ });
3138
+ });
3139
+ - name: getAppTables.test.ts
3140
+ type: file
3141
+ contents: |
3142
+ import { describe, it, expect } from "vitest";
3143
+ import { createClient, mockFetch } from "@tests/setup.ts";
3144
+
3145
+ describe("QuickbaseClient - getAppTables (Unit)", () => {
3146
+ it("calls getAppTables successfully", async () => {
3147
+ mockFetch.mockImplementation((url: string, options: any) => {
3148
+ console.log("Mock fetch for getAppTables:", url, options);
3149
+ return Promise.resolve({
3150
+ ok: true,
3151
+ status: 200,
3152
+ json: () =>
3153
+ Promise.resolve([
3154
+ {
3155
+ alias: "_DBID_ROOT",
3156
+ created: "2025-02-13T18:22:33Z",
3157
+ defaultSortFieldId: 2,
3158
+ defaultSortOrder: "DESC",
3159
+ description: "",
3160
+ id: "buwai2zr4",
3161
+ keyFieldId: 3,
3162
+ name: "Root",
3163
+ nextFieldId: 6,
3164
+ nextRecordId: 1,
3165
+ pluralRecordName: "Roots",
3166
+ singleRecordName: "Root",
3167
+ sizeLimit: "500 MB",
3168
+ spaceRemaining: "500 MB",
3169
+ spaceUsed: "0 KB",
3170
+ updated: "2025-02-13T18:22:34Z",
3171
+ },
3172
+ ]),
3173
+ } as Response);
3174
+ });
3175
+
3176
+ const client = createClient(mockFetch);
3177
+ const tablesAppId = process.env.QB_APP_ID;
3178
+ if (!tablesAppId) throw new Error("QB_APP_ID is not defined in .env");
3179
+ const result = await client.getAppTables({ appId: tablesAppId });
3180
+ console.log("getAppTables response:", result);
3181
+ expect(result).toEqual(
3182
+ expect.arrayContaining([
3183
+ expect.objectContaining({
3184
+ alias: "_DBID_ROOT",
3185
+ created: new Date("2025-02-13T18:22:33Z"),
3186
+ defaultSortFieldId: 2,
3187
+ defaultSortOrder: "DESC",
3188
+ description: "",
3189
+ id: "buwai2zr4",
3190
+ keyFieldId: 3,
3191
+ name: "Root",
3192
+ nextFieldId: 6,
3193
+ nextRecordId: 1,
3194
+ pluralRecordName: "Roots",
3195
+ singleRecordName: "Root",
3196
+ sizeLimit: "500 MB",
3197
+ spaceRemaining: "500 MB",
3198
+ spaceUsed: "0 KB",
3199
+ updated: new Date("2025-02-13T18:22:34Z"),
3200
+ }),
3201
+ ])
3202
+ );
3203
+ expect(mockFetch).toHaveBeenCalledWith(
3204
+ `https://api.quickbase.com/v1/tables?appId=${tablesAppId}`,
3205
+ expect.objectContaining({
3206
+ headers: expect.objectContaining({
3207
+ Authorization: `QB-USER-TOKEN ${process.env.QB_USER_TOKEN}`,
3208
+ "QB-Realm-Hostname": `${process.env.QB_REALM}.quickbase.com`,
3209
+ }),
3210
+ })
3211
+ );
3212
+ });
3213
+ });
3214
+ - name: getTable.test.ts
3215
+ type: file
3216
+ contents: |
3217
+ import { describe, it, expect, beforeEach, vi } from "vitest";
3218
+ import { createClient, mockFetch } from "@tests/setup.ts";
3219
+
3220
+ describe("QuickbaseClient - getTable (Unit)", () => {
3221
+ let client: ReturnType<typeof createClient>;
3222
+
3223
+ beforeEach(() => {
3224
+ mockFetch.mockClear();
3225
+ client = createClient(mockFetch, { debug: true });
3226
+ });
3227
+
3228
+ it("calls getTable successfully with user token", async () => {
3229
+ const mockAppId = "buwai2zpe";
3230
+ const mockTableId = "buwai2zr4";
3231
+ const mockResponse = {
3232
+ id: mockTableId,
3233
+ name: "Root",
3234
+ alias: "_DBID_ROOT",
3235
+ description: "",
3236
+ created: new Date("2025-02-13T18:22:33.000Z"),
3237
+ updated: new Date("2025-02-13T18:22:34.000Z"),
3238
+ nextRecordId: 1,
3239
+ nextFieldId: 6,
3240
+ defaultSortFieldId: 2,
3241
+ defaultSortOrder: "DESC",
3242
+ keyFieldId: 3,
3243
+ singleRecordName: "Root",
3244
+ pluralRecordName: "Roots",
3245
+ sizeLimit: "500 MB",
3246
+ spaceUsed: "0 KB",
3247
+ spaceRemaining: "500 MB",
3248
+ };
3249
+
3250
+ mockFetch.mockResolvedValueOnce({
3251
+ ok: true,
3252
+ status: 200,
3253
+ json: () => Promise.resolve(mockResponse),
3254
+ });
3255
+
3256
+ const response = await client.getTable({
3257
+ tableId: mockTableId,
3258
+ appId: mockAppId,
3259
+ });
3260
+ expect(response).toEqual(mockResponse);
3261
+ expect(mockFetch).toHaveBeenCalledWith(
3262
+ `https://api.quickbase.com/v1/tables/${mockTableId}?appId=${mockAppId}`,
3263
+ expect.objectContaining({
3264
+ method: "GET",
3265
+ headers: expect.objectContaining({
3266
+ Authorization:
3267
+ "QB-USER-TOKEN b9f3pk_q4jd_0_b4qu5eebyvuix3xs57ysd7zn3",
3268
+ }),
3269
+ })
3270
+ );
3271
+ });
3272
+
3273
+ it("calls getTable successfully with temp token", async () => {
3274
+ client = createClient(mockFetch, { debug: true, useTempTokens: true });
3275
+ const mockAppId = "buwai2zpe";
3276
+ const mockTableId = "buwai2zr4";
3277
+ const mockResponse = {
3278
+ id: mockTableId,
3279
+ name: "Root",
3280
+ alias: "_DBID_ROOT",
3281
+ description: "",
3282
+ created: new Date("2025-02-13T18:22:33.000Z"),
3283
+ updated: new Date("2025-02-13T18:22:34.000Z"),
3284
+ nextRecordId: 1,
3285
+ nextFieldId: 6,
3286
+ defaultSortFieldId: 2,
3287
+ defaultSortOrder: "DESC",
3288
+ keyFieldId: 3,
3289
+ singleRecordName: "Root",
3290
+ pluralRecordName: "Roots",
3291
+ sizeLimit: "500 MB",
3292
+ spaceUsed: "0 KB",
3293
+ spaceRemaining: "500 MB",
3294
+ };
3295
+
3296
+ mockFetch
3297
+ .mockResolvedValueOnce({
3298
+ ok: true,
3299
+ status: 200,
3300
+ json: () => Promise.resolve({ temporaryAuthorization: "temp_token" }),
3301
+ })
3302
+ .mockResolvedValueOnce({
3303
+ ok: true,
3304
+ status: 200,
3305
+ json: () => Promise.resolve(mockResponse),
3306
+ });
3307
+
3308
+ const response = await client.getTable({
3309
+ tableId: mockTableId,
3310
+ appId: mockAppId,
3311
+ });
3312
+ expect(response).toEqual(mockResponse);
3313
+ expect(mockFetch).toHaveBeenCalledTimes(2);
3314
+ expect(mockFetch).toHaveBeenCalledWith(
3315
+ `https://api.quickbase.com/v1/auth/temporary/${mockTableId}`,
3316
+ expect.any(Object)
3317
+ );
3318
+ expect(mockFetch).toHaveBeenCalledWith(
3319
+ `https://api.quickbase.com/v1/tables/${mockTableId}?appId=${mockAppId}`,
3320
+ expect.objectContaining({
3321
+ headers: expect.objectContaining({
3322
+ Authorization: "QB-TEMP-TOKEN temp_token",
3323
+ }),
3324
+ })
3325
+ );
3326
+ });
3327
+
3328
+ it("retries successfully after 401 with temp token", async () => {
3329
+ client = createClient(mockFetch, { debug: true, useTempTokens: true });
3330
+ const mockAppId = "buwai2zpe";
3331
+ const mockTableId = "buwai2zr4";
3332
+ const mockResponse = {
3333
+ id: mockTableId,
3334
+ name: "Root",
3335
+ alias: "_DBID_ROOT",
3336
+ description: "",
3337
+ created: new Date("2025-02-13T18:22:33.000Z"),
3338
+ updated: new Date("2025-02-13T18:22:34.000Z"),
3339
+ nextRecordId: 1,
3340
+ nextFieldId: 6,
3341
+ defaultSortFieldId: 2,
3342
+ defaultSortOrder: "DESC",
3343
+ keyFieldId: 3,
3344
+ singleRecordName: "Root",
3345
+ pluralRecordName: "Roots",
3346
+ sizeLimit: "500 MB",
3347
+ spaceUsed: "0 KB",
3348
+ spaceRemaining: "500 MB",
3349
+ };
3350
+
3351
+ mockFetch
3352
+ .mockResolvedValueOnce({
3353
+ ok: true,
3354
+ status: 200,
3355
+ json: () =>
3356
+ Promise.resolve({ temporaryAuthorization: "initial_token" }),
3357
+ })
3358
+ .mockResolvedValueOnce({
3359
+ ok: false,
3360
+ status: 401,
3361
+ json: () => Promise.resolve({ message: "Unauthorized" }),
3362
+ })
3363
+ .mockResolvedValueOnce({
3364
+ ok: true,
3365
+ status: 200,
3366
+ json: () => Promise.resolve({ temporaryAuthorization: "new_token" }),
3367
+ })
3368
+ .mockResolvedValueOnce({
3369
+ ok: true,
3370
+ status: 200,
3371
+ json: () => Promise.resolve(mockResponse),
3372
+ });
3373
+
3374
+ const response = await client.getTable({
3375
+ tableId: mockTableId,
3376
+ appId: mockAppId,
3377
+ });
3378
+ expect(response).toEqual(mockResponse);
3379
+ expect(mockFetch).toHaveBeenCalledTimes(4); // Initial token, 401, retry token, success
3380
+ });
3381
+
3382
+ it("handles 401 with failed temp token retry", async () => {
3383
+ client = createClient(mockFetch, { debug: true, useTempTokens: true });
3384
+ const mockAppId = "buwai2zpe";
3385
+ const mockTableId = "buwai2zr4";
3386
+
3387
+ mockFetch
3388
+ .mockResolvedValueOnce({
3389
+ ok: true,
3390
+ status: 200,
3391
+ json: () =>
3392
+ Promise.resolve({ temporaryAuthorization: "initial_token" }),
3393
+ })
3394
+ .mockResolvedValueOnce({
3395
+ ok: false,
3396
+ status: 401,
3397
+ json: () => Promise.resolve({ message: "Unauthorized" }),
3398
+ })
3399
+ .mockResolvedValueOnce({
3400
+ ok: false,
3401
+ status: 401,
3402
+ json: () =>
3403
+ Promise.resolve({ message: "Unauthorized in fetchTempToken" }),
3404
+ });
3405
+
3406
+ await expect(
3407
+ client.getTable({ tableId: mockTableId, appId: mockAppId })
3408
+ ).rejects.toThrow(
3409
+ "API Error: Unauthorized in fetchTempToken (Status: 401)"
3410
+ );
3411
+ expect(mockFetch).toHaveBeenCalledTimes(3);
3412
+ });
3413
+
3414
+ it("handles 404 Not Found", async () => {
3415
+ const mockAppId = "buwai2zpe";
3416
+ const mockTableId = "invalidTableId";
3417
+
3418
+ mockFetch.mockResolvedValueOnce({
3419
+ ok: false,
3420
+ status: 404,
3421
+ json: () => Promise.resolve({ message: "Table not found" }),
3422
+ });
3423
+
3424
+ await expect(
3425
+ client.getTable({ tableId: mockTableId, appId: mockAppId })
3426
+ ).rejects.toThrow("API Error: Table not found (Status: 404)");
3427
+ });
3428
+ });
3429
+ - name: updateTable.test.ts
3430
+ type: file
3431
+ contents: |
3432
+ import { describe, it, expect, beforeEach, vi } from "vitest";
3433
+ import { createClient, mockFetch } from "@tests/setup.ts";
3434
+
3435
+ describe("QuickbaseClient - updateTable (Unit)", () => {
3436
+ let client: ReturnType<typeof createClient>;
3437
+
3438
+ beforeEach(() => {
3439
+ mockFetch.mockClear();
3440
+ client = createClient(mockFetch, { debug: true });
3441
+ });
3442
+
3443
+ it("calls updateTable successfully with temp token", async () => {
3444
+ client = createClient(mockFetch, { debug: true, useTempTokens: true });
3445
+ const mockAppId = "buwai2zpe";
3446
+ const mockTableId = "buwai2zr4";
3447
+ const mockBody = {
3448
+ name: "Updated Root",
3449
+ description: "Updated description",
3450
+ };
3451
+ const mockResponse = {
3452
+ id: mockTableId,
3453
+ name: "Updated Root",
3454
+ alias: "_DBID_ROOT",
3455
+ description: "Updated description",
3456
+ created: new Date("2025-02-13T18:22:33.000Z"),
3457
+ updated: new Date("2025-03-10T12:00:00.000Z"),
3458
+ nextRecordId: 1,
3459
+ nextFieldId: 6,
3460
+ defaultSortFieldId: 2,
3461
+ defaultSortOrder: "DESC",
3462
+ keyFieldId: 3,
3463
+ singleRecordName: "Root",
3464
+ pluralRecordName: "Roots",
3465
+ sizeLimit: "500 MB",
3466
+ spaceUsed: "0 KB",
3467
+ spaceRemaining: "500 MB",
3468
+ };
3469
+
3470
+ mockFetch
3471
+ .mockResolvedValueOnce({
3472
+ ok: true,
3473
+ status: 200,
3474
+ json: () => Promise.resolve({ temporaryAuthorization: "temp_token" }),
3475
+ })
3476
+ .mockResolvedValueOnce({
3477
+ ok: true,
3478
+ status: 200,
3479
+ json: () => Promise.resolve(mockResponse),
3480
+ });
3481
+
3482
+ const response = await client.updateTable({
3483
+ tableId: mockTableId,
3484
+ appId: mockAppId,
3485
+ body: mockBody,
3486
+ });
3487
+ expect(response).toEqual(mockResponse);
3488
+ expect(mockFetch).toHaveBeenCalledTimes(2);
3489
+ expect(mockFetch).toHaveBeenCalledWith(
3490
+ `https://api.quickbase.com/v1/auth/temporary/${mockTableId}`,
3491
+ expect.any(Object)
3492
+ );
3493
+ expect(mockFetch).toHaveBeenCalledWith(
3494
+ `https://api.quickbase.com/v1/tables/${mockTableId}?appId=${mockAppId}`,
3495
+ expect.objectContaining({
3496
+ method: "POST", // Updated to match QuickBase API spec
3497
+ headers: expect.objectContaining({
3498
+ Authorization: "QB-TEMP-TOKEN temp_token",
3499
+ "Content-Type": "application/json",
3500
+ }),
3501
+ body: JSON.stringify(mockBody),
3502
+ })
3503
+ );
3504
+ });
3505
+ });
3506
+ - name: text.txt
3507
+ type: file
3508
+ - name: tsconfig.json
3509
+ type: file
3510
+ - name: versionrc.json
3511
+ type: file
3512
+ - name: vitest.config.ts
3513
+ type: file