quickbase-js 0.1.0-beta.13 → 0.1.0-beta.14

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 (167) hide show
  1. package/README.md +1 -1
  2. package/dist/esm/quickbase.d.ts +2 -1
  3. package/package.json +9 -4
  4. package/CHANGELOG.md +0 -239
  5. package/build-common.js +0 -131
  6. package/build-esm.js +0 -71
  7. package/build-umd.js +0 -69
  8. package/docs/.vitepress/cache/deps/@theme_index.js +0 -275
  9. package/docs/.vitepress/cache/deps/@theme_index.js.map +0 -7
  10. package/docs/.vitepress/cache/deps/_metadata.json +0 -40
  11. package/docs/.vitepress/cache/deps/chunk-5A67QEFC.js +0 -12542
  12. package/docs/.vitepress/cache/deps/chunk-5A67QEFC.js.map +0 -7
  13. package/docs/.vitepress/cache/deps/chunk-7D4P4MMP.js +0 -9719
  14. package/docs/.vitepress/cache/deps/chunk-7D4P4MMP.js.map +0 -7
  15. package/docs/.vitepress/cache/deps/package.json +0 -3
  16. package/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +0 -4504
  17. package/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +0 -7
  18. package/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +0 -583
  19. package/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +0 -7
  20. package/docs/.vitepress/cache/deps/vue.js +0 -343
  21. package/docs/.vitepress/cache/deps/vue.js.map +0 -7
  22. package/docs/.vitepress/config.mts +0 -26
  23. package/docs/api-examples.md +0 -49
  24. package/docs/index.md +0 -59
  25. package/docs/markdown-examples.md +0 -85
  26. package/docs-data/api-docs.json +0 -4143
  27. package/examples/quicbase-jsCDN.html +0 -36
  28. package/examples/react.js +0 -48
  29. package/examples/vanillajs.html +0 -47
  30. package/index.md +0 -25
  31. package/open-api/fix-spec-main.ts +0 -133
  32. package/open-api/generate-unified-interface.ts +0 -104
  33. package/open-api/generateDocsJson.ts +0 -24
  34. package/open-api/output/quickbase-fixed.json +0 -11191
  35. package/open-api/post-process-generated.ts +0 -226
  36. package/open-api/regenerate-client.ts +0 -117
  37. package/open-api/schema/enhance-general.ts +0 -111
  38. package/open-api/schema/fix-arrays.ts +0 -68
  39. package/open-api/schema/tags/apps.ts +0 -90
  40. package/open-api/schema/tags/fields.ts +0 -471
  41. package/open-api/schema/tags/groups.ts +0 -51
  42. package/open-api/schema/tags/index.ts +0 -66
  43. package/open-api/schema/tags/records.ts +0 -115
  44. package/open-api/schema/tags/tables.ts +0 -211
  45. package/open-api/schema/tags/users.ts +0 -47
  46. package/open-api/types/spec.ts +0 -42
  47. package/open-api/utils/common.ts +0 -29
  48. package/open-api/utils/generateJsDoc.ts +0 -74
  49. package/open-api/utils/infer-schema.ts +0 -40
  50. package/open-api/utils/naming.ts +0 -10
  51. package/open-api/utils/sharedUtils.ts +0 -352
  52. package/playwright.config.ts +0 -37
  53. package/rollup.config.js +0 -114
  54. package/specs/QuickBase_RESTful_API_2025-03-04T06_22_39.725Z.json +0 -46878
  55. package/specs/split/apps.json +0 -1315
  56. package/specs/split/auth.json +0 -191
  57. package/specs/split/fields.json +0 -3869
  58. package/specs/split/records.json +0 -754
  59. package/specs/split/reports.json +0 -619
  60. package/specs/split/tables.json +0 -1605
  61. package/src/BurstAwareThrottleBucket.ts +0 -57
  62. package/src/FlowThrottleBucket.ts +0 -47
  63. package/src/RateLimitError.ts +0 -12
  64. package/src/RateThrottleBucket.ts +0 -5
  65. package/src/Semaphore.ts +0 -33
  66. package/src/authorizationStrategy.ts +0 -321
  67. package/src/generated-unified/QuickbaseClient.ts +0 -1135
  68. package/src/generated-unified/missing-types-report.json +0 -3
  69. package/src/index.ts +0 -1
  70. package/src/invokeMethod.ts +0 -290
  71. package/src/pagination.ts +0 -429
  72. package/src/quickbaseClient.ts +0 -227
  73. package/src/rateLimiter.ts +0 -30
  74. package/src/tokenCache.ts +0 -39
  75. package/src/utils.ts +0 -50
  76. package/tests/playwright/qb/auth/cacheSwitching.test.ts +0 -159
  77. package/tests/playwright/qb/auth/fetchTempToken401.test.ts +0 -219
  78. package/tests/playwright/qb/auth/getAppWithTempToken.test.ts +0 -162
  79. package/tests/playwright/qb/auth/getAppWithTempTokenConcurrency.test.ts +0 -208
  80. package/tests/playwright/qb/auth/getAppWithUserToken.test.ts +0 -153
  81. package/tests/playwright/qb/auth/getTempToken.test.ts +0 -152
  82. package/tests/playwright/qb/auth/tempTokenPrefetch.test.ts +0 -179
  83. package/tests/playwright/qb/auth/tempTokenRenewal.test.ts +0 -133
  84. package/tests/setup.ts +0 -53
  85. package/tests/vitest/qb/apps/copyApp.test.ts +0 -76
  86. package/tests/vitest/qb/apps/createApp.test.ts +0 -64
  87. package/tests/vitest/qb/apps/deleteApp.test.ts +0 -76
  88. package/tests/vitest/qb/apps/getApp.test.ts +0 -44
  89. package/tests/vitest/qb/apps/getAppEvents.test.ts +0 -67
  90. package/tests/vitest/qb/apps/updateApp.test.ts +0 -58
  91. package/tests/vitest/qb/auth/mockQuickbaseServer.ts +0 -60
  92. package/tests/vitest/qb/auth/retryUserToken401.test.ts +0 -73
  93. package/tests/vitest/qb/auth/ssoTokenConcurrency.test.ts +0 -68
  94. package/tests/vitest/qb/auth/ssoTokenIntegrationWithServer.test.ts +0 -65
  95. package/tests/vitest/qb/auth/userTokenConcurrency.test.ts +0 -63
  96. package/tests/vitest/qb/fields/createField.test.ts +0 -77
  97. package/tests/vitest/qb/fields/deleteFields.test.ts +0 -83
  98. package/tests/vitest/qb/fields/getField.test.ts +0 -85
  99. package/tests/vitest/qb/fields/getFieldUsage.test.ts +0 -82
  100. package/tests/vitest/qb/fields/getFields.test.ts +0 -232
  101. package/tests/vitest/qb/fields/getFieldsUsage.test.ts +0 -77
  102. package/tests/vitest/qb/fields/updateField.test.ts +0 -93
  103. package/tests/vitest/qb/formulas/runFormula.test.ts +0 -96
  104. package/tests/vitest/qb/index.ts +0 -29
  105. package/tests/vitest/qb/quickbase-js/BurstAwareThrottleBucket.test.ts +0 -125
  106. package/tests/vitest/qb/quickbase-js/FlowBucket.test.ts +0 -77
  107. package/tests/vitest/qb/quickbase-js/paginationSkip.test.ts +0 -111
  108. package/tests/vitest/qb/records/deleteRecords.test.ts +0 -110
  109. package/tests/vitest/qb/records/runQuery.test.ts +0 -145
  110. package/tests/vitest/qb/records/upsert.test.ts +0 -102
  111. package/tests/vitest/qb/tables/createRelationship.test.ts +0 -102
  112. package/tests/vitest/qb/tables/createTable.test.ts +0 -55
  113. package/tests/vitest/qb/tables/deleteRelationship.test.ts +0 -143
  114. package/tests/vitest/qb/tables/deleteTable.test.ts +0 -50
  115. package/tests/vitest/qb/tables/getAppTables.test.ts +0 -46
  116. package/tests/vitest/qb/tables/getRelationships.test.ts +0 -80
  117. package/tests/vitest/qb/tables/getTable.test.ts +0 -26
  118. package/tests/vitest/qb/tables/updateRelationship.test.ts +0 -250
  119. package/tests/vitest/qb/tables/updateTable.test.ts +0 -48
  120. package/tests/vitest/unit/apps/copyApp.test.ts +0 -581
  121. package/tests/vitest/unit/apps/createApp.test.ts +0 -186
  122. package/tests/vitest/unit/apps/deleteApp.test.ts +0 -216
  123. package/tests/vitest/unit/apps/getApp.test.ts +0 -128
  124. package/tests/vitest/unit/apps/getAppConcurrency.test.ts +0 -151
  125. package/tests/vitest/unit/apps/getAppEvents.test.ts +0 -193
  126. package/tests/vitest/unit/apps/updateApp.test.ts +0 -412
  127. package/tests/vitest/unit/auth/fetchTempToken401.test.ts +0 -81
  128. package/tests/vitest/unit/auth/getTempToken.test.ts +0 -119
  129. package/tests/vitest/unit/auth/retryTempToken401.test.ts +0 -95
  130. package/tests/vitest/unit/auth/retryTempTokenMaxRetries.test.ts +0 -206
  131. package/tests/vitest/unit/auth/retryUserToken401.test.ts +0 -66
  132. package/tests/vitest/unit/auth/ssoTokenRefresh.test.ts +0 -325
  133. package/tests/vitest/unit/auth/userTokenConcurrency.test.ts +0 -62
  134. package/tests/vitest/unit/fields/createField.test.ts +0 -451
  135. package/tests/vitest/unit/fields/deleteFields.test.ts +0 -141
  136. package/tests/vitest/unit/fields/getField.test.ts +0 -189
  137. package/tests/vitest/unit/fields/getFieldUsage.test.ts +0 -180
  138. package/tests/vitest/unit/fields/getFields.test.ts +0 -122
  139. package/tests/vitest/unit/fields/getFieldsUsage.test.ts +0 -160
  140. package/tests/vitest/unit/fields/updateField.test.ts +0 -285
  141. package/tests/vitest/unit/formulas/runFormula.test.ts +0 -205
  142. package/tests/vitest/unit/index.ts +0 -34
  143. package/tests/vitest/unit/quickbase-js/BurstAwareThrottleBucket.test.ts +0 -108
  144. package/tests/vitest/unit/quickbase-js/FlowBucket.test.ts +0 -101
  145. package/tests/vitest/unit/quickbase-js/pagination.test.ts +0 -251
  146. package/tests/vitest/unit/quickbase-js/quickbaseClientHttpMethods.test.ts +0 -141
  147. package/tests/vitest/unit/quickbase-js/rateLimit.test.ts +0 -191
  148. package/tests/vitest/unit/quickbase-js/tokenLifespan.test.ts +0 -204
  149. package/tests/vitest/unit/records/deleteRecords.test.ts +0 -112
  150. package/tests/vitest/unit/records/runQuery.test.ts +0 -101
  151. package/tests/vitest/unit/records/upsert.test.ts +0 -234
  152. package/tests/vitest/unit/tables/createRelationship.test.ts +0 -212
  153. package/tests/vitest/unit/tables/createTable.test.ts +0 -70
  154. package/tests/vitest/unit/tables/deleteRelationship.test.ts +0 -97
  155. package/tests/vitest/unit/tables/deleteTable.test.ts +0 -77
  156. package/tests/vitest/unit/tables/getAppTables.test.ts +0 -85
  157. package/tests/vitest/unit/tables/getRelationships.test.ts +0 -259
  158. package/tests/vitest/unit/tables/getTable.test.ts +0 -233
  159. package/tests/vitest/unit/tables/updateRelationship.test.ts +0 -307
  160. package/tests/vitest/unit/tables/updateTable.test.ts +0 -80
  161. package/tools/log-gen.ts +0 -251
  162. package/tools/log-gen.yaml +0 -4829
  163. package/tools/openapi-jars/openapi-generator-cli-7.12.0.jar +0 -0
  164. package/tsconfig.build.json +0 -17
  165. package/tsconfig.json +0 -32
  166. package/versionrc.json +0 -9
  167. package/vitest.config.ts +0 -27
@@ -1,208 +0,0 @@
1
- // tests/playwright/qb/auth/getAppWithTempTokenConcurrency.test.ts
2
- import { test, expect } from "@playwright/test";
3
- import { quickbase } from "../../../../src/quickbaseClient.ts"; // Keep .ts for now
4
- import dotenv from "dotenv";
5
-
6
- dotenv.config();
7
-
8
- const loginToQuickbase = async (
9
- page: import("@playwright/test").Page,
10
- quickbaseUrl: string,
11
- username: string,
12
- password: string
13
- ): Promise<boolean> => {
14
- let loginSuccess = false;
15
- const maxLoginAttempts = 3;
16
- let loginAttempt = 0;
17
-
18
- while (!loginSuccess && loginAttempt < maxLoginAttempts) {
19
- try {
20
- loginAttempt++;
21
- if (loginAttempt > 1) console.log(`Login attempt ${loginAttempt}`);
22
-
23
- await page.goto(quickbaseUrl, { timeout: 60000 });
24
- await page.waitForSelector("input[name='loginid']", { timeout: 60000 });
25
- await page.fill("input[name='loginid']", username);
26
- await page.fill("input[name='password']", password);
27
- await page.click("#signin");
28
- await page.waitForURL(`https://*.quickbase.com/**`, {
29
- waitUntil: "networkidle",
30
- timeout: 60000,
31
- });
32
-
33
- const loginError = await page.$(".login-error");
34
- if (loginError) {
35
- throw new Error("Login failed. Please check your credentials.");
36
- }
37
-
38
- console.log("Signed In to QuickBase.");
39
- loginSuccess = true;
40
- } catch (error) {
41
- console.error(
42
- `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
43
- );
44
- if (loginAttempt >= maxLoginAttempts) {
45
- console.error("Max login attempts reached. Exiting.");
46
- await page.context().browser()!.close();
47
- return false;
48
- }
49
- await new Promise((resolve) => setTimeout(resolve, 5000));
50
- }
51
- }
52
- return loginSuccess;
53
- };
54
-
55
- test.describe("QuickbaseClient Integration - getApp with Temporary Token Concurrency", () => {
56
- test("handles concurrent getApp requests with a single token fetch", async ({
57
- page,
58
- }) => {
59
- const realm = process.env.QB_REALM;
60
- const appId = process.env.QB_APP_ID;
61
- const username = process.env.QB_USERNAME;
62
- const password = process.env.QB_PASSWORD;
63
-
64
- if (!realm) throw new Error("QB_REALM is not defined in .env");
65
- if (!appId) throw new Error("QB_APP_ID is not defined in .env");
66
- if (!username) throw new Error("QB_USERNAME is not defined in .env");
67
- if (!password) throw new Error("QB_PASSWORD is not defined in .env");
68
-
69
- const fetchInits: { url: string; init: RequestInit }[] = [];
70
-
71
- const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
72
- const loginSuccess = await loginToQuickbase(
73
- page,
74
- quickbaseUrl,
75
- username,
76
- password
77
- );
78
- if (!loginSuccess) {
79
- throw new Error("Failed to log in to QuickBase after max attempts.");
80
- }
81
-
82
- await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
83
- waitUntil: "networkidle",
84
- timeout: 60000,
85
- });
86
-
87
- const client = quickbase({
88
- realm,
89
- useTempTokens: true,
90
- debug: true, // Enable debug logs to verify concurrency behavior
91
- fetchApi: async (url: RequestInfo | URL, init?: RequestInit) => {
92
- const effectiveInit = init || {};
93
- fetchInits.push({ url: String(url), init: effectiveInit });
94
- const response = await page.evaluate(
95
- async (args: [string, RequestInit]) => {
96
- const [fetchUrl, fetchInit] = args;
97
- const res = await fetch(fetchUrl, fetchInit);
98
- const body = await res.text();
99
- const headersObj: Record<string, string> = {};
100
- res.headers.forEach((value, key) => {
101
- headersObj[key] = value;
102
- });
103
- return {
104
- ok: res.ok,
105
- status: res.status,
106
- statusText: res.statusText,
107
- headers: headersObj,
108
- body,
109
- };
110
- },
111
- [String(url), effectiveInit] as [string, RequestInit]
112
- );
113
-
114
- const fetchResponse = new Response(response.body || null, {
115
- status: response.status,
116
- statusText: response.statusText,
117
- headers: new Headers(response.headers),
118
- });
119
-
120
- fetchResponse.json = async () => {
121
- if (!response.body) {
122
- throw new Error("Empty response body from API");
123
- }
124
- try {
125
- return JSON.parse(response.body);
126
- } catch (e) {
127
- throw new SyntaxError(`Invalid JSON response: ${response.body}`);
128
- }
129
- };
130
-
131
- return fetchResponse;
132
- },
133
- });
134
-
135
- // Make three concurrent getApp requests
136
- const concurrentRequests = [
137
- client.getApp({ appId }),
138
- client.getApp({ appId }),
139
- client.getApp({ appId }),
140
- ];
141
-
142
- // Wait for all responses to complete
143
- await Promise.all([
144
- page.waitForResponse(`https://api.quickbase.com/v1/apps/${appId}`, {
145
- timeout: 30000,
146
- }),
147
- page.waitForResponse(`https://api.quickbase.com/v1/apps/${appId}`, {
148
- timeout: 30000,
149
- }),
150
- page.waitForResponse(`https://api.quickbase.com/v1/apps/${appId}`, {
151
- timeout: 30000,
152
- }),
153
- ]);
154
-
155
- const results = await Promise.all(concurrentRequests);
156
-
157
- // Expected app data (based on your previous test)
158
- const expectedAppData = {
159
- id: appId,
160
- name: "qb-copy",
161
- created: expect.any(Date),
162
- updated: expect.any(Date),
163
- description: "",
164
- timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
165
- dateFormat: "MM-DD-YYYY",
166
- hasEveryoneOnTheInternet: false,
167
- memoryInfo: { estMemory: 0, estMemoryInclDependentApps: 0 },
168
- securityProperties: {
169
- allowClone: false,
170
- allowExport: true,
171
- enableAppTokens: true,
172
- hideFromPublic: false,
173
- mustBeRealmApproved: false,
174
- useIPFilter: false,
175
- },
176
- ancestorId: undefined,
177
- dataClassification: undefined,
178
- variables: [{ name: "TestVar", value: "TestValue" }],
179
- };
180
-
181
- // Assert all results match the expected data
182
- expect(results).toHaveLength(3);
183
- results.forEach((result) => {
184
- expect(result).toEqual(expectedAppData);
185
- });
186
-
187
- // Verify token fetch behavior
188
- const tokenFetchInits = fetchInits.filter((entry) =>
189
- entry.url.includes(`/auth/temporary/${appId}`)
190
- );
191
- expect(tokenFetchInits).toHaveLength(1); // Only one token fetch should occur
192
- expect(tokenFetchInits[0].init.credentials).toBe("include");
193
-
194
- const appFetchInits = fetchInits.filter((entry) =>
195
- entry.url.includes(`/apps/${appId}`)
196
- );
197
- expect(appFetchInits).toHaveLength(3); // Three getApp requests
198
- appFetchInits.forEach((init) => {
199
- expect(init.init.credentials).toBe("omit");
200
- expect(init.init.headers).toHaveProperty("Authorization");
201
- expect(
202
- (init.init.headers as Record<string, string>)["Authorization"]
203
- ).toMatch(/^QB-TEMP-TOKEN .+$/);
204
- });
205
-
206
- console.log("Test completed. Check debug logs for concurrency details.");
207
- });
208
- });
@@ -1,153 +0,0 @@
1
- import { test, expect } from "@playwright/test";
2
- import { quickbase, QuickbaseClient } from "../../../../src/quickbaseClient.ts";
3
- import dotenv from "dotenv";
4
-
5
- dotenv.config();
6
-
7
- const loginToQuickbase = async (
8
- page: import("@playwright/test").Page,
9
- quickbaseUrl: string,
10
- username: string,
11
- password: string
12
- ): Promise<boolean> => {
13
- console.log("Logging in to QuickBase");
14
- let loginSuccess = false;
15
- const maxLoginAttempts = 3;
16
- let loginAttempt = 0;
17
-
18
- while (!loginSuccess && loginAttempt < maxLoginAttempts) {
19
- try {
20
- loginAttempt++;
21
- if (loginAttempt > 1) console.log(`Login attempt ${loginAttempt}`);
22
-
23
- await page.goto(quickbaseUrl, { timeout: 60000 });
24
- await page.waitForSelector("input[name='loginid']", { timeout: 60000 });
25
- await page.fill("input[name='loginid']", username);
26
- await page.fill("input[name='password']", password);
27
- await page.click("#signin");
28
- await page.waitForURL(`https://*.quickbase.com/**`, {
29
- waitUntil: "networkidle",
30
- timeout: 60000,
31
- });
32
-
33
- const loginError = await page.$(".login-error");
34
- if (loginError) {
35
- throw new Error("Login failed. Please check your credentials.");
36
- }
37
-
38
- console.log("Signed In to QuickBase.");
39
- loginSuccess = true;
40
- } catch (error) {
41
- console.error(
42
- `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
43
- );
44
- if (loginAttempt >= maxLoginAttempts) {
45
- console.error("Max login attempts reached. Exiting.");
46
- await page.context().browser()!.close();
47
- return false;
48
- }
49
- await new Promise((resolve) => setTimeout(resolve, 5000));
50
- }
51
- }
52
- return loginSuccess;
53
- };
54
-
55
- test.describe("QuickbaseClient Integration - getApp with User Token", () => {
56
- test("uses user token for getApp in browser", async ({ page }) => {
57
- const realm = process.env.QB_REALM ?? "";
58
- const appId = process.env.QB_APP_ID ?? "";
59
- const username = process.env.QB_USERNAME ?? "";
60
- const password = process.env.QB_PASSWORD ?? "";
61
- const userToken = process.env.QB_USER_TOKEN ?? "";
62
-
63
- if (!realm || !appId || !username || !password || !userToken) {
64
- throw new Error(
65
- "Required QuickBase environment variables are not defined"
66
- );
67
- }
68
-
69
- // Login to Quickbase (optional, to mimic code page context)
70
- const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
71
- const loginSuccess = await loginToQuickbase(
72
- page,
73
- quickbaseUrl,
74
- username,
75
- password
76
- );
77
- if (!loginSuccess) {
78
- throw new Error("Failed to log in to QuickBase after max attempts.");
79
- }
80
-
81
- // Navigate to the app page to ensure session context (optional)
82
- await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
83
- waitUntil: "networkidle",
84
- timeout: 60000,
85
- });
86
-
87
- const currentUrl = page.url();
88
- console.log("Post-login URL after app navigation:", currentUrl);
89
-
90
- // Create Quickbase client with user token
91
- const client = quickbase({
92
- realm,
93
- userToken, // Use user token instead of temp tokens
94
- debug: true,
95
- fetchApi: async (input: RequestInfo | URL, init?: RequestInit) => {
96
- const url = input.toString();
97
- console.log(`Fetching ${url} with init:`, init);
98
- const effectiveInit = init || {};
99
- const response = await page.evaluate(
100
- async ([fetchUrl, fetchInit]: [string, RequestInit]) => {
101
- const res = await fetch(fetchUrl, fetchInit); // Rely on quickbaseClient.ts for credentials
102
- const body = await res.text();
103
- const headersObj: Record<string, string> = {};
104
- res.headers.forEach((value, key) => {
105
- headersObj[key] = value;
106
- });
107
- return {
108
- ok: res.ok,
109
- status: res.status,
110
- statusText: res.statusText,
111
- headers: headersObj,
112
- body,
113
- };
114
- },
115
- [url, effectiveInit] as [string, RequestInit]
116
- );
117
-
118
- console.log(`Raw response from ${url}:`, {
119
- status: response.status,
120
- statusText: response.statusText,
121
- body: response.body,
122
- });
123
-
124
- const fetchResponse = new Response(response.body || null, {
125
- status: response.status,
126
- statusText: response.statusText,
127
- headers: new Headers(response.headers),
128
- });
129
-
130
- fetchResponse.json = async () => {
131
- if (!response.body) {
132
- throw new Error("Empty response body from API");
133
- }
134
- try {
135
- return JSON.parse(response.body);
136
- } catch (e) {
137
- throw new SyntaxError(`Invalid JSON response: ${response.body}`);
138
- }
139
- };
140
-
141
- return fetchResponse;
142
- },
143
- }) as QuickbaseClient;
144
-
145
- // Call getApp directly
146
- const appResult = await client.getApp({ appId });
147
- console.log("App response using user token:", appResult);
148
-
149
- // Validate the app response
150
- expect(appResult).toHaveProperty("id", appId);
151
- expect(appResult).toHaveProperty("name");
152
- });
153
- });
@@ -1,152 +0,0 @@
1
- import { test, expect } from "@playwright/test";
2
- import { quickbase, QuickbaseClient } from "../../../../src/quickbaseClient.ts";
3
- import dotenv from "dotenv";
4
-
5
- dotenv.config();
6
-
7
- const loginToQuickbase = async (
8
- page: import("@playwright/test").Page,
9
- quickbaseUrl: string,
10
- username: string,
11
- password: string
12
- ): Promise<boolean> => {
13
- console.log("Logging in to QuickBase");
14
- let loginSuccess = false;
15
- const maxLoginAttempts = 3;
16
- let loginAttempt = 0;
17
-
18
- while (!loginSuccess && loginAttempt < maxLoginAttempts) {
19
- try {
20
- loginAttempt++;
21
- if (loginAttempt > 1) console.log(`Login attempt ${loginAttempt}`);
22
-
23
- await page.goto(quickbaseUrl, { timeout: 60000 });
24
- await page.waitForSelector("input[name='loginid']", { timeout: 60000 });
25
- await page.fill("input[name='loginid']", username);
26
- await page.fill("input[name='password']", password);
27
- await page.click("#signin");
28
- await page.waitForURL(`https://*.quickbase.com/**`, {
29
- waitUntil: "networkidle",
30
- timeout: 60000,
31
- });
32
-
33
- const loginError = await page.$(".login-error");
34
- if (loginError) {
35
- throw new Error("Login failed. Please check your credentials.");
36
- }
37
-
38
- console.log("Signed In to QuickBase.");
39
- loginSuccess = true;
40
- } catch (error) {
41
- console.error(
42
- `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
43
- );
44
- if (loginAttempt >= maxLoginAttempts) {
45
- console.error("Max login attempts reached. Exiting.");
46
- await page.context().browser()!.close();
47
- return false;
48
- }
49
- await new Promise((resolve) => setTimeout(resolve, 5000));
50
- }
51
- }
52
- return loginSuccess;
53
- };
54
-
55
- test.describe("QuickbaseClient Integration - getApp with Temp Tokens", () => {
56
- test("uses temp tokens automatically for getApp in browser", async ({
57
- page,
58
- }) => {
59
- const realm = process.env.QB_REALM ?? "";
60
- const appId = process.env.QB_APP_ID ?? "";
61
- const username = process.env.QB_USERNAME ?? "";
62
- const password = process.env.QB_PASSWORD ?? "";
63
-
64
- if (!realm || !appId || !username || !password) {
65
- throw new Error(
66
- "Required QuickBase environment variables are not defined"
67
- );
68
- }
69
-
70
- // Login to QuickBase
71
- const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
72
- const loginSuccess = await loginToQuickbase(
73
- page,
74
- quickbaseUrl,
75
- username,
76
- password
77
- );
78
- if (!loginSuccess) {
79
- throw new Error("Failed to log in to QuickBase after max attempts.");
80
- }
81
-
82
- // Navigate to the app page to ensure session context
83
- await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
84
- waitUntil: "networkidle",
85
- timeout: 60000,
86
- });
87
- console.log("Post-login URL after app navigation:", page.url());
88
-
89
- // Single client with browser-based fetch
90
- const client = quickbase({
91
- realm,
92
- useTempTokens: true,
93
- debug: true,
94
- fetchApi: async (input: RequestInfo | URL, init?: RequestInit) => {
95
- const url = input.toString();
96
- console.log(`Fetching ${url} with init:`, init);
97
- const effectiveInit = init || {};
98
- const response = await page.evaluate(
99
- async ([fetchUrl, fetchInit]: [string, RequestInit]) => {
100
- const res = await fetch(fetchUrl, fetchInit); // Rely on quickbaseClient.ts for credentials
101
- const body = await res.text();
102
- const headersObj: Record<string, string> = {};
103
- res.headers.forEach((value, key) => {
104
- headersObj[key] = value;
105
- });
106
- return {
107
- ok: res.ok,
108
- status: res.status,
109
- statusText: res.statusText,
110
- headers: headersObj,
111
- body,
112
- };
113
- },
114
- [url, effectiveInit] as [string, RequestInit]
115
- );
116
-
117
- console.log(`Raw response from ${url}:`, {
118
- status: response.status,
119
- statusText: response.statusText,
120
- body: response.body,
121
- });
122
-
123
- const fetchResponse = new Response(response.body || null, {
124
- status: response.status,
125
- statusText: response.statusText,
126
- headers: new Headers(response.headers),
127
- });
128
-
129
- fetchResponse.json = async () => {
130
- if (!response.body) {
131
- throw new Error("Empty response body from API");
132
- }
133
- try {
134
- return JSON.parse(response.body);
135
- } catch (e) {
136
- throw new SyntaxError(`Invalid JSON response: ${response.body}`);
137
- }
138
- };
139
-
140
- return fetchResponse;
141
- },
142
- }) as QuickbaseClient;
143
-
144
- // Call getApp directly, letting the library handle temp token logic
145
- const appResult = await client.getApp({ appId });
146
- console.log("App response using auto-fetched temp token:", appResult);
147
-
148
- // Validate the app response
149
- expect(appResult).toHaveProperty("id", appId);
150
- expect(appResult).toHaveProperty("name");
151
- });
152
- });
@@ -1,179 +0,0 @@
1
- import { test, expect } from "@playwright/test";
2
- import { quickbase, QuickbaseClient } from "../../../../src/quickbaseClient.ts";
3
- import dotenv from "dotenv";
4
-
5
- dotenv.config();
6
-
7
- const loginToQuickbase = async (
8
- page: import("@playwright/test").Page,
9
- quickbaseUrl: string,
10
- username: string,
11
- password: string
12
- ): Promise<boolean> => {
13
- console.log("Logging in to QuickBase");
14
- let loginSuccess = false;
15
- const maxLoginAttempts = 3;
16
- let loginAttempt = 0;
17
-
18
- while (!loginSuccess && loginAttempt < maxLoginAttempts) {
19
- try {
20
- loginAttempt++;
21
- if (loginAttempt > 1) console.log(`Login attempt ${loginAttempt}`);
22
-
23
- await page.goto(quickbaseUrl, { timeout: 60000 });
24
- await page.waitForSelector("input[name='loginid']", { timeout: 60000 });
25
- await page.fill("input[name='loginid']", username);
26
- await page.fill("input[name='password']", password);
27
- await page.click("#signin");
28
- await page.waitForURL(`https://*.quickbase.com/**`, {
29
- waitUntil: "networkidle",
30
- timeout: 60000,
31
- });
32
-
33
- const loginError = await page.$(".login-error");
34
- if (loginError) {
35
- throw new Error("Login failed. Please check your credentials.");
36
- }
37
-
38
- console.log("Signed In to QuickBase.");
39
- loginSuccess = true;
40
- } catch (error) {
41
- console.error(
42
- `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
43
- );
44
- if (loginAttempt >= maxLoginAttempts) {
45
- console.error("Max login attempts reached. Exiting.");
46
- await page.context().browser()!.close();
47
- return false;
48
- }
49
- await new Promise((resolve) => setTimeout(resolve, 5000));
50
- }
51
- }
52
- return loginSuccess;
53
- };
54
-
55
- test.describe("QuickbaseClient Integration - Token Pre-Fetch and Cache Reuse", () => {
56
- test("pre-fetches token and reuses it for subsequent API calls", async ({
57
- page,
58
- }) => {
59
- const realm = process.env.QB_REALM ?? "";
60
- const appId = process.env.QB_APP_ID ?? "";
61
- const username = process.env.QB_USERNAME ?? "";
62
- const password = process.env.QB_PASSWORD ?? "";
63
-
64
- if (!realm || !appId || !username || !password) {
65
- throw new Error(
66
- "Required QuickBase environment variables are not defined"
67
- );
68
- }
69
-
70
- // Login to QuickBase
71
- const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
72
- const loginSuccess = await loginToQuickbase(
73
- page,
74
- quickbaseUrl,
75
- username,
76
- password
77
- );
78
- if (!loginSuccess) {
79
- throw new Error("Failed to log in to QuickBase after max attempts.");
80
- }
81
-
82
- // Navigate to the app page to ensure session context
83
- await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
84
- waitUntil: "networkidle",
85
- timeout: 60000,
86
- });
87
- console.log("Post-login URL after app navigation:", page.url());
88
-
89
- // Track tokens and call counts
90
- let callCount = 0;
91
- let cachedToken: string | null = null;
92
-
93
- const client = quickbase({
94
- realm,
95
- useTempTokens: true,
96
- debug: true,
97
- fetchApi: async (input: RequestInfo | URL, init?: RequestInit) => {
98
- const url = input.toString();
99
- callCount++;
100
- console.log(`fetchApi called for ${url}, callCount: ${callCount}`);
101
-
102
- const effectiveInit = init || {};
103
- const response = await page.evaluate(
104
- async ([fetchUrl, fetchInit]: [string, RequestInit]) => {
105
- const res = await fetch(fetchUrl, fetchInit); // Rely on quickbaseClient.ts for credentials
106
- const body = await res.text();
107
- const headersObj: Record<string, string> = {};
108
- res.headers.forEach((value, key) => {
109
- headersObj[key] = value;
110
- });
111
- return {
112
- ok: res.ok,
113
- status: res.status,
114
- statusText: res.statusText,
115
- headers: headersObj,
116
- body,
117
- };
118
- },
119
- [url, effectiveInit] as [string, RequestInit]
120
- );
121
-
122
- console.log(`Raw response from ${url}:`, {
123
- status: response.status,
124
- statusText: response.statusText,
125
- body: response.body,
126
- });
127
-
128
- const fetchResponse = new Response(response.body || null, {
129
- status: response.status,
130
- statusText: response.statusText,
131
- headers: new Headers(response.headers),
132
- });
133
-
134
- fetchResponse.json = async () => {
135
- if (!response.body) {
136
- throw new Error("Empty response body from API");
137
- }
138
- try {
139
- return JSON.parse(response.body);
140
- } catch (e) {
141
- throw new SyntaxError(`Invalid JSON response: ${response.body}`);
142
- }
143
- };
144
-
145
- // Capture token from response
146
- if (url.includes("/auth/temporary/")) {
147
- const json = await fetchResponse.clone().json();
148
- const token = json.temporaryAuthorization;
149
- cachedToken = token; // Store the pre-fetched token
150
- console.log(`Captured pre-fetched token: ${cachedToken}`);
151
- }
152
-
153
- return fetchResponse;
154
- },
155
- }) as QuickbaseClient;
156
-
157
- // Step 1: Pre-fetch token
158
- console.log("Pre-fetching token...");
159
- const tokenResult = await client.getTempTokenDBID({ dbid: appId });
160
- console.log("Pre-fetched token result:", tokenResult);
161
- expect(tokenResult).toHaveProperty("temporaryAuthorization");
162
- expect(cachedToken).toBe(tokenResult.temporaryAuthorization);
163
-
164
- // Step 2: Call getApp, expecting it to reuse the cached token
165
- console.log("Calling getApp with pre-fetched token...");
166
- const appResult = await client.getApp({ appId });
167
- console.log("App response:", appResult);
168
-
169
- // Validate the app response
170
- expect(appResult).toHaveProperty("id", appId);
171
- expect(appResult).toHaveProperty("name");
172
-
173
- // Verify call count and token reuse
174
- console.log(`Final callCount: ${callCount}`);
175
- expect(callCount).toBe(2); // One for pre-fetch, one for getApp
176
- expect(cachedToken).toBeDefined();
177
- console.log(`Pre-fetched token: ${cachedToken}`);
178
- });
179
- });