quickbase-js 0.1.0-beta.9 → 1.0.0

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 (146) hide show
  1. package/README.md +270 -60
  2. package/dist/esm/quickbase.d.ts +2553 -3220
  3. package/dist/esm/quickbase.js +1545 -3443
  4. package/dist/esm/quickbase.js.map +1 -1
  5. package/dist/esm/quickbase.min.js +1 -1
  6. package/dist/esm/quickbase.min.js.map +1 -1
  7. package/dist/umd/quickbase.umd.js +1544 -3625
  8. package/dist/umd/quickbase.umd.js.map +1 -1
  9. package/dist/umd/quickbase.umd.min.js +1 -1
  10. package/dist/umd/quickbase.umd.min.js.map +1 -1
  11. package/package.json +25 -12
  12. package/CHANGELOG.md +0 -184
  13. package/build-common.js +0 -131
  14. package/build-esm.js +0 -71
  15. package/build-umd.js +0 -69
  16. package/examples/quicbase-jsCDN.html +0 -36
  17. package/examples/react.js +0 -48
  18. package/examples/vanillajs.html +0 -47
  19. package/open-api/fix-spec-main.ts +0 -97
  20. package/open-api/generate-override-report.ts +0 -214
  21. package/open-api/generate-unified-interface.ts +0 -336
  22. package/open-api/output/override-report.html +0 -11
  23. package/open-api/output/override-report.json +0 -14395
  24. package/open-api/output/quickbase-fixed.json +0 -11191
  25. package/open-api/regenerate-client.ts +0 -116
  26. package/open-api/schema/enhance-general.ts +0 -100
  27. package/open-api/schema/fix-arrays.ts +0 -69
  28. package/open-api/schema/tags/apps.ts +0 -90
  29. package/open-api/schema/tags/fields.ts +0 -471
  30. package/open-api/schema/tags/groups.ts +0 -51
  31. package/open-api/schema/tags/index.ts +0 -66
  32. package/open-api/schema/tags/records.ts +0 -115
  33. package/open-api/schema/tags/tables.ts +0 -211
  34. package/open-api/schema/tags/users.ts +0 -47
  35. package/open-api/types/spec.ts +0 -42
  36. package/open-api/utils/generateJsDoc.ts +0 -96
  37. package/open-api/utils/infer-schema.ts +0 -40
  38. package/open-api/utils/naming.ts +0 -10
  39. package/playwright.config.ts +0 -37
  40. package/rollup.config.js +0 -114
  41. package/specs/QuickBase_RESTful_API_2025-03-04T06_22_39.725Z.json +0 -46878
  42. package/specs/split/apps.json +0 -1315
  43. package/specs/split/auth.json +0 -191
  44. package/specs/split/fields.json +0 -3869
  45. package/specs/split/records.json +0 -754
  46. package/specs/split/reports.json +0 -619
  47. package/specs/split/tables.json +0 -1605
  48. package/src/RateLimitError.ts +0 -12
  49. package/src/ThrottleBucket.ts +0 -41
  50. package/src/authorizationStrategy.ts +0 -246
  51. package/src/generated-unified/QuickbaseClient.ts +0 -1049
  52. package/src/generated-unified/missing-types-report.json +0 -3
  53. package/src/index.ts +0 -1
  54. package/src/invokeMethod.ts +0 -242
  55. package/src/quickbaseClient.ts +0 -271
  56. package/src/rateLimiter.ts +0 -25
  57. package/src/tokenCache.ts +0 -35
  58. package/src/utils.ts +0 -7
  59. package/test-esm.js +0 -1
  60. package/test-results.json +0 -2050
  61. package/test-umd.js +0 -1
  62. package/test.ts +0 -1
  63. package/tests/playwright/qb/auth/cacheSwitching.test.ts +0 -159
  64. package/tests/playwright/qb/auth/fetchTempToken401.test.ts +0 -219
  65. package/tests/playwright/qb/auth/getAppWithTempToken.test.ts +0 -162
  66. package/tests/playwright/qb/auth/getAppWithUserToken.test.ts +0 -153
  67. package/tests/playwright/qb/auth/getTempToken.test.ts +0 -152
  68. package/tests/playwright/qb/auth/tempTokenPrefetch.test.ts +0 -179
  69. package/tests/playwright/qb/auth/tempTokenRenewal.test.ts +0 -133
  70. package/tests/setup.ts +0 -53
  71. package/tests/vitest/qb/apps/copyApp.test.ts +0 -76
  72. package/tests/vitest/qb/apps/createApp.test.ts +0 -64
  73. package/tests/vitest/qb/apps/deleteApp.test.ts +0 -76
  74. package/tests/vitest/qb/apps/getApp.test.ts +0 -44
  75. package/tests/vitest/qb/apps/getAppEvents.test.ts +0 -67
  76. package/tests/vitest/qb/apps/updateApp.test.ts +0 -58
  77. package/tests/vitest/qb/auth/mockQuickbaseServer.ts +0 -60
  78. package/tests/vitest/qb/auth/retryUserToken401.test.ts +0 -73
  79. package/tests/vitest/qb/auth/ssoTokenIntegrationWithServer.test.ts +0 -65
  80. package/tests/vitest/qb/fields/createField.test.ts +0 -77
  81. package/tests/vitest/qb/fields/deleteFields.test.ts +0 -83
  82. package/tests/vitest/qb/fields/getField.test.ts +0 -85
  83. package/tests/vitest/qb/fields/getFieldUsage.test.ts +0 -82
  84. package/tests/vitest/qb/fields/getFields.test.ts +0 -232
  85. package/tests/vitest/qb/fields/getFieldsUsage.test.ts +0 -77
  86. package/tests/vitest/qb/fields/updateField.test.ts +0 -93
  87. package/tests/vitest/qb/formulas/runFormula.test.ts +0 -96
  88. package/tests/vitest/qb/index.ts +0 -29
  89. package/tests/vitest/qb/records/deleteRecords.test.ts +0 -110
  90. package/tests/vitest/qb/records/runQuery.test.ts +0 -146
  91. package/tests/vitest/qb/records/upsert.test.ts +0 -102
  92. package/tests/vitest/qb/tables/createRelationship.test.ts +0 -102
  93. package/tests/vitest/qb/tables/createTable.test.ts +0 -55
  94. package/tests/vitest/qb/tables/deleteRelationship.test.ts +0 -143
  95. package/tests/vitest/qb/tables/deleteTable.test.ts +0 -50
  96. package/tests/vitest/qb/tables/getAppTables.test.ts +0 -46
  97. package/tests/vitest/qb/tables/getRelationships.test.ts +0 -80
  98. package/tests/vitest/qb/tables/getTable.test.ts +0 -26
  99. package/tests/vitest/qb/tables/updateRelationship.test.ts +0 -250
  100. package/tests/vitest/qb/tables/updateTable.test.ts +0 -48
  101. package/tests/vitest/unit/ThrottleBucket.test.ts +0 -95
  102. package/tests/vitest/unit/apps/copyApp.test.ts +0 -581
  103. package/tests/vitest/unit/apps/createApp.test.ts +0 -186
  104. package/tests/vitest/unit/apps/deleteApp.test.ts +0 -216
  105. package/tests/vitest/unit/apps/getApp.test.ts +0 -128
  106. package/tests/vitest/unit/apps/getAppEvents.test.ts +0 -193
  107. package/tests/vitest/unit/apps/updateApp.test.ts +0 -412
  108. package/tests/vitest/unit/auth/fetchTempToken401.test.ts +0 -63
  109. package/tests/vitest/unit/auth/getTempToken.test.ts +0 -119
  110. package/tests/vitest/unit/auth/retryTempToken401.test.ts +0 -95
  111. package/tests/vitest/unit/auth/retryTempTokenMaxRetries.test.ts +0 -235
  112. package/tests/vitest/unit/auth/retryUserToken401.test.ts +0 -69
  113. package/tests/vitest/unit/auth/ssoTokenRefresh.test.ts +0 -325
  114. package/tests/vitest/unit/fields/createField.test.ts +0 -451
  115. package/tests/vitest/unit/fields/deleteFields.test.ts +0 -141
  116. package/tests/vitest/unit/fields/getField.test.ts +0 -189
  117. package/tests/vitest/unit/fields/getFieldUsage.test.ts +0 -180
  118. package/tests/vitest/unit/fields/getFields.test.ts +0 -122
  119. package/tests/vitest/unit/fields/getFieldsUsage.test.ts +0 -160
  120. package/tests/vitest/unit/fields/updateField.test.ts +0 -285
  121. package/tests/vitest/unit/formulas/runFormula.test.ts +0 -205
  122. package/tests/vitest/unit/index.ts +0 -34
  123. package/tests/vitest/unit/inferHttpMethod.test.ts +0 -131
  124. package/tests/vitest/unit/rateLimit.test.ts +0 -191
  125. package/tests/vitest/unit/records/deleteRecords.test.ts +0 -112
  126. package/tests/vitest/unit/records/runQuery.test.ts +0 -102
  127. package/tests/vitest/unit/records/upsert.test.ts +0 -234
  128. package/tests/vitest/unit/tables/createRelationship.test.ts +0 -212
  129. package/tests/vitest/unit/tables/createTable.test.ts +0 -70
  130. package/tests/vitest/unit/tables/deleteRelationship.test.ts +0 -97
  131. package/tests/vitest/unit/tables/deleteTable.test.ts +0 -77
  132. package/tests/vitest/unit/tables/getAppTables.test.ts +0 -85
  133. package/tests/vitest/unit/tables/getRelationships.test.ts +0 -259
  134. package/tests/vitest/unit/tables/getTable.test.ts +0 -233
  135. package/tests/vitest/unit/tables/updateRelationship.test.ts +0 -307
  136. package/tests/vitest/unit/tables/updateTable.test.ts +0 -80
  137. package/tests/vitest/unit/tokenLifespan.test.ts +0 -204
  138. package/tests/vitest/unit/umd.test.ts +0 -8
  139. package/text.txt +0 -104
  140. package/tools/log-gen.ts +0 -244
  141. package/tools/log-gen.yaml +0 -5424
  142. package/tools/openapi-jars/openapi-generator-cli-7.12.0.jar +0 -0
  143. package/tsconfig.build.json +0 -17
  144. package/tsconfig.json +0 -32
  145. package/versionrc.json +0 -9
  146. package/vitest.config.ts +0 -27
package/test-umd.js DELETED
@@ -1 +0,0 @@
1
- const quickbase = require('./dist/umd/quickbase.umd.js'); const qb = quickbase({ realm: 'example', userToken: 'your-token' }); console.log(qb);
package/test.ts DELETED
@@ -1 +0,0 @@
1
- console.log('Hello from TypeScript');
@@ -1,159 +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
- console.log("Navigating to login page");
24
- await page.goto(quickbaseUrl, { timeout: 30000 });
25
- console.log("Waiting for loginid selector");
26
- await page.waitForSelector("input[name='loginid']", { timeout: 30000 });
27
- await page.fill("input[name='loginid']", username);
28
- await page.fill("input[name='password']", password);
29
- console.log("Clicking signin");
30
- await page.click("#signin");
31
- console.log("Waiting for navigation");
32
- await page.waitForURL(`https://*.quickbase.com/**`, {
33
- waitUntil: "networkidle",
34
- timeout: 30000,
35
- });
36
-
37
- const loginError = await page.$(".login-error");
38
- if (loginError) {
39
- throw new Error("Login failed. Please check your credentials.");
40
- }
41
-
42
- console.log("Signed In to QuickBase.");
43
- loginSuccess = true;
44
- } catch (error) {
45
- console.error(
46
- `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
47
- );
48
- if (loginAttempt >= maxLoginAttempts) {
49
- console.error("Max login attempts reached. Exiting.");
50
- await page.context().browser()!.close();
51
- return false;
52
- }
53
- await new Promise((resolve) => setTimeout(resolve, 5000));
54
- }
55
- }
56
- return loginSuccess;
57
- };
58
-
59
- test.describe("QuickbaseClient Integration - Cache Switching with Temp Tokens", () => {
60
- test("caches and switches tokens for different DBIDs with getApp → getFields → getApp sequence", async ({
61
- page,
62
- }) => {
63
- console.log("Starting cacheSwitching test");
64
- const realm = process.env.QB_REALM ?? "";
65
- const appId = process.env.QB_APP_ID ?? "";
66
- const tableId = process.env.QB_TABLE_ID_1 ?? "";
67
- const username = process.env.QB_USERNAME ?? "";
68
- const password = process.env.QB_PASSWORD ?? "";
69
-
70
- if (!realm || !appId || !tableId || !username || !password) {
71
- throw new Error(
72
- "Required QuickBase environment variables are not defined"
73
- );
74
- }
75
-
76
- const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
77
- const loginSuccess = await loginToQuickbase(
78
- page,
79
- quickbaseUrl,
80
- username,
81
- password
82
- );
83
- if (!loginSuccess) {
84
- throw new Error("Failed to log in to QuickBase after max attempts.");
85
- }
86
-
87
- await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
88
- waitUntil: "networkidle",
89
- timeout: 30000,
90
- });
91
- console.log("Post-login URL after app navigation:", page.url());
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
- console.log(`Fetching ${url} with init:`, init);
100
- const effectiveInit = init || {};
101
- const response = await page.evaluate(
102
- async ([fetchUrl, fetchInit]: [string, RequestInit]) => {
103
- const res = await fetch(fetchUrl, fetchInit); // Rely on quickbaseClient.ts for credentials
104
- const body = await res.text();
105
- const headersObj: Record<string, string> = {};
106
- res.headers.forEach((value, key) => {
107
- headersObj[key] = value;
108
- });
109
- return {
110
- ok: res.ok,
111
- status: res.status,
112
- statusText: res.statusText,
113
- headers: headersObj,
114
- body,
115
- };
116
- },
117
- [url, effectiveInit] as [string, RequestInit]
118
- );
119
-
120
- console.log(`Raw response from ${url}:`, {
121
- status: response.status,
122
- statusText: response.statusText,
123
- body: response.body,
124
- });
125
-
126
- const fetchResponse = new Response(response.body || null, {
127
- status: response.status,
128
- statusText: response.statusText,
129
- headers: new Headers(response.headers),
130
- });
131
-
132
- fetchResponse.json = async () => {
133
- if (!response.body) {
134
- throw new Error("Empty response body from API");
135
- }
136
- try {
137
- return JSON.parse(response.body);
138
- } catch (e) {
139
- throw new SyntaxError(`Invalid JSON response: ${response.body}`);
140
- }
141
- };
142
-
143
- return fetchResponse;
144
- },
145
- }) as QuickbaseClient;
146
-
147
- const appResult1 = await client.getApp({ appId });
148
- console.log("First getApp response:", appResult1);
149
- expect(appResult1).toHaveProperty("id", appId);
150
-
151
- const fieldsResult = await client.getFields({ tableId });
152
- console.log("getFields response:", fieldsResult);
153
- expect(fieldsResult.length).toBeGreaterThan(0);
154
-
155
- const appResult2 = await client.getApp({ appId });
156
- console.log("Second getApp response:", appResult2);
157
- expect(appResult2).toHaveProperty("id", appId);
158
- });
159
- });
@@ -1,219 +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 Invalidation with Cached Token", () => {
56
- test("retries with new token when cached token is unexpectedly invalidated", async ({
57
- page,
58
- }) => {
59
- // Type-safe environment variables
60
- const realm = process.env.QB_REALM ?? "";
61
- const appId = process.env.QB_APP_ID ?? "";
62
- const username = process.env.QB_USERNAME ?? "";
63
- const password = process.env.QB_PASSWORD ?? "";
64
-
65
- if (!realm || !appId || !username || !password) {
66
- throw new Error(
67
- "Required QuickBase environment variables are not defined"
68
- );
69
- }
70
-
71
- // Login to QuickBase
72
- const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
73
- const loginSuccess = await loginToQuickbase(
74
- page,
75
- quickbaseUrl,
76
- username,
77
- password
78
- );
79
- if (!loginSuccess) {
80
- throw new Error("Failed to log in to QuickBase after max attempts.");
81
- }
82
-
83
- // Navigate to the app page to ensure session context
84
- await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
85
- waitUntil: "networkidle",
86
- timeout: 60000,
87
- });
88
- console.log("Post-login URL after app navigation:", page.url());
89
-
90
- // Track tokens and call counts
91
- let callCount = 0;
92
- let getAppCallCount = 0;
93
- let initialToken: string | null = null;
94
- let retryToken: string | null = null;
95
- const fetchInits: { url: string; init: RequestInit }[] = [];
96
-
97
- const client = quickbase({
98
- realm,
99
- useTempTokens: true,
100
- debug: true,
101
- fetchApi: async (input: RequestInfo | URL, init?: RequestInit) => {
102
- const url = input.toString();
103
- callCount++;
104
- console.log(`fetchApi called for ${url}, callCount: ${callCount}`);
105
-
106
- const effectiveInit = init || {};
107
- fetchInits.push({ url, init: effectiveInit });
108
-
109
- const response = await page.evaluate(
110
- async ([fetchUrl, fetchInit]: [string, RequestInit]) => {
111
- const res = await fetch(fetchUrl, fetchInit);
112
- const body = await res.text();
113
- const headersObj: Record<string, string> = {};
114
- res.headers.forEach((value, key) => {
115
- headersObj[key] = value;
116
- });
117
- return {
118
- ok: res.ok,
119
- status: res.status,
120
- statusText: res.statusText,
121
- headers: headersObj,
122
- body,
123
- };
124
- },
125
- [url, effectiveInit] as [string, RequestInit]
126
- );
127
-
128
- // Simulate 401 for the first getApp call
129
- if (url.includes(`/apps/${appId}`)) {
130
- getAppCallCount++;
131
- console.log(`getApp call count: ${getAppCallCount}`);
132
- if (getAppCallCount === 1) {
133
- console.log("Simulating 401 Unauthorized for first getApp call");
134
- return new Response(JSON.stringify({ message: "Unauthorized" }), {
135
- status: 401,
136
- statusText: "Unauthorized",
137
- headers: { "Content-Type": "application/json" },
138
- });
139
- }
140
- }
141
-
142
- const fetchResponse = new Response(response.body || null, {
143
- status: response.status,
144
- statusText: response.statusText,
145
- headers: new Headers(response.headers),
146
- });
147
-
148
- // Override json() to parse the body correctly
149
- fetchResponse.json = async () => {
150
- if (!response.body) {
151
- throw new Error("Empty response body from API");
152
- }
153
- try {
154
- return JSON.parse(response.body);
155
- } catch (e) {
156
- throw new SyntaxError(`Invalid JSON response: ${response.body}`);
157
- }
158
- };
159
-
160
- // Capture tokens for validation
161
- if (url.includes("/auth/temporary/")) {
162
- try {
163
- const json = await fetchResponse.clone().json();
164
- const token = json.temporaryAuthorization;
165
- if (!initialToken) {
166
- initialToken = token;
167
- console.log(`Captured initial token: ${initialToken}`);
168
- } else if (!retryToken) {
169
- retryToken = token;
170
- console.log(`Captured retry token: ${retryToken}`);
171
- }
172
- } catch (error) {
173
- console.error("Failed to parse token response:", error);
174
- }
175
- }
176
-
177
- console.log(`Raw response from ${url}:`, {
178
- status: response.status,
179
- statusText: response.statusText,
180
- body: response.body,
181
- });
182
-
183
- return fetchResponse;
184
- },
185
- }) as QuickbaseClient;
186
-
187
- // Pre-fetch token to simulate cached token
188
- console.log("Pre-fetching initial token...");
189
- const preFetchResult = await client.getTempTokenDBID({ dbid: appId });
190
- console.log("Initial token pre-fetched and cached:", preFetchResult);
191
-
192
- // Call getApp, expecting a 401 followed by a retry with a new token
193
- const appPromise = client.getApp({ appId });
194
- await page.waitForResponse(`https://api.quickbase.com/v1/apps/${appId}`, {
195
- timeout: 30000,
196
- });
197
- const appResult = await appPromise;
198
- console.log("App response after token invalidation and retry:", appResult);
199
-
200
- // Validate the app response
201
- expect(appResult).toHaveProperty("id", appId);
202
- expect(appResult).toHaveProperty("name");
203
-
204
- // Verify call counts and token behavior
205
- console.log(
206
- `Final callCount: ${callCount}, Final getAppCallCount: ${getAppCallCount}`
207
- );
208
- expect(callCount).toBe(4); // Pre-fetch, 401, token retry, getApp success
209
- expect(getAppCallCount).toBe(2); // Initial 401, retry success
210
-
211
- // Validate pre-fetch and retry tokens
212
- console.log(`Initial token: ${initialToken}`);
213
- console.log(`Retry token: ${retryToken}`);
214
- expect(initialToken).toBeDefined();
215
- expect(initialToken).toBe(preFetchResult.temporaryAuthorization); // Confirm pre-fetch token was used
216
- expect(retryToken).toBeDefined();
217
- expect(initialToken).not.toBe(retryToken); // Confirm retry used a new token
218
- });
219
- });
@@ -1,162 +0,0 @@
1
- // tests/playwright/qb/auth/getAppWithTempToken.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", () => {
56
- test("uses temporary token with correct credentials settings 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) 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
- fetchApi: async (url: RequestInfo | URL, init?: RequestInit) => {
91
- // Use optional init and provide default empty object if undefined
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
- const appPromise = client.getApp({ appId });
136
- await page.waitForResponse(`https://api.quickbase.com/v1/apps/${appId}`, {
137
- timeout: 30000,
138
- });
139
- const appResult = await appPromise;
140
-
141
- expect(appResult).toHaveProperty("id", appId);
142
- expect(appResult).toHaveProperty("name");
143
-
144
- const tokenFetchInit = fetchInits.find((entry) =>
145
- entry.url.includes(`/auth/temporary/${appId}`)
146
- );
147
- expect(
148
- tokenFetchInit,
149
- "No fetch init captured for token request"
150
- ).toBeDefined();
151
- expect(tokenFetchInit!.init.credentials).toBe("include");
152
-
153
- const appFetchInit = fetchInits.find((entry) =>
154
- entry.url.includes(`/apps/${appId}`)
155
- );
156
- expect(
157
- appFetchInit,
158
- "No fetch init captured for getApp request"
159
- ).toBeDefined();
160
- expect(appFetchInit!.init.credentials).toBe("omit");
161
- });
162
- });
@@ -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
- });