quickbase-js 0.1.0-beta.12 → 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.
- package/README.md +48 -18
- package/dist/esm/quickbase.d.ts +13 -3
- package/dist/esm/quickbase.js +416 -49
- package/dist/esm/quickbase.js.map +1 -1
- package/dist/esm/quickbase.min.js +1 -1
- package/dist/esm/quickbase.min.js.map +1 -1
- package/dist/umd/quickbase.umd.js +416 -49
- package/dist/umd/quickbase.umd.js.map +1 -1
- package/dist/umd/quickbase.umd.min.js +1 -1
- package/dist/umd/quickbase.umd.min.js.map +1 -1
- package/package.json +11 -4
- package/CHANGELOG.md +0 -227
- package/build-common.js +0 -131
- package/build-esm.js +0 -71
- package/build-umd.js +0 -69
- package/docs/.vitepress/cache/deps/@theme_index.js +0 -275
- package/docs/.vitepress/cache/deps/@theme_index.js.map +0 -7
- package/docs/.vitepress/cache/deps/_metadata.json +0 -40
- package/docs/.vitepress/cache/deps/chunk-5A67QEFC.js +0 -12542
- package/docs/.vitepress/cache/deps/chunk-5A67QEFC.js.map +0 -7
- package/docs/.vitepress/cache/deps/chunk-7D4P4MMP.js +0 -9719
- package/docs/.vitepress/cache/deps/chunk-7D4P4MMP.js.map +0 -7
- package/docs/.vitepress/cache/deps/package.json +0 -3
- package/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +0 -4504
- package/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +0 -7
- package/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +0 -583
- package/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +0 -7
- package/docs/.vitepress/cache/deps/vue.js +0 -343
- package/docs/.vitepress/cache/deps/vue.js.map +0 -7
- package/docs/.vitepress/config.mts +0 -26
- package/docs/api-examples.md +0 -49
- package/docs/index.md +0 -59
- package/docs/markdown-examples.md +0 -85
- package/docs-data/api-docs.json +0 -4143
- package/examples/quicbase-jsCDN.html +0 -36
- package/examples/react.js +0 -48
- package/examples/vanillajs.html +0 -47
- package/index.md +0 -25
- package/open-api/fix-spec-main.ts +0 -133
- package/open-api/generate-unified-interface.ts +0 -104
- package/open-api/generateDocsJson.ts +0 -24
- package/open-api/output/quickbase-fixed.json +0 -11191
- package/open-api/post-process-generated.ts +0 -226
- package/open-api/regenerate-client.ts +0 -117
- package/open-api/schema/enhance-general.ts +0 -111
- package/open-api/schema/fix-arrays.ts +0 -68
- package/open-api/schema/tags/apps.ts +0 -90
- package/open-api/schema/tags/fields.ts +0 -471
- package/open-api/schema/tags/groups.ts +0 -51
- package/open-api/schema/tags/index.ts +0 -66
- package/open-api/schema/tags/records.ts +0 -115
- package/open-api/schema/tags/tables.ts +0 -211
- package/open-api/schema/tags/users.ts +0 -47
- package/open-api/types/spec.ts +0 -42
- package/open-api/utils/common.ts +0 -29
- package/open-api/utils/generateJsDoc.ts +0 -74
- package/open-api/utils/infer-schema.ts +0 -40
- package/open-api/utils/naming.ts +0 -10
- package/open-api/utils/sharedUtils.ts +0 -352
- package/playwright.config.ts +0 -37
- package/rollup.config.js +0 -114
- package/specs/QuickBase_RESTful_API_2025-03-04T06_22_39.725Z.json +0 -46878
- package/specs/split/apps.json +0 -1315
- package/specs/split/auth.json +0 -191
- package/specs/split/fields.json +0 -3869
- package/specs/split/records.json +0 -754
- package/specs/split/reports.json +0 -619
- package/specs/split/tables.json +0 -1605
- package/src/RateLimitError.ts +0 -12
- package/src/ThrottleBucket.ts +0 -77
- package/src/authorizationStrategy.ts +0 -310
- package/src/generated-unified/QuickbaseClient.ts +0 -1135
- package/src/generated-unified/missing-types-report.json +0 -3
- package/src/index.ts +0 -1
- package/src/invokeMethod.ts +0 -212
- package/src/quickbaseClient.ts +0 -199
- package/src/rateLimiter.ts +0 -30
- package/src/tokenCache.ts +0 -39
- package/src/utils.ts +0 -50
- package/tests/playwright/qb/auth/cacheSwitching.test.ts +0 -159
- package/tests/playwright/qb/auth/fetchTempToken401.test.ts +0 -219
- package/tests/playwright/qb/auth/getAppWithTempToken.test.ts +0 -162
- package/tests/playwright/qb/auth/getAppWithTempTokenConcurrency.test.ts +0 -208
- package/tests/playwright/qb/auth/getAppWithUserToken.test.ts +0 -153
- package/tests/playwright/qb/auth/getTempToken.test.ts +0 -152
- package/tests/playwright/qb/auth/tempTokenPrefetch.test.ts +0 -179
- package/tests/playwright/qb/auth/tempTokenRenewal.test.ts +0 -133
- package/tests/setup.ts +0 -53
- package/tests/vitest/qb/ThrottleBucket.test.ts +0 -77
- package/tests/vitest/qb/apps/copyApp.test.ts +0 -76
- package/tests/vitest/qb/apps/createApp.test.ts +0 -64
- package/tests/vitest/qb/apps/deleteApp.test.ts +0 -76
- package/tests/vitest/qb/apps/getApp.test.ts +0 -44
- package/tests/vitest/qb/apps/getAppEvents.test.ts +0 -67
- package/tests/vitest/qb/apps/updateApp.test.ts +0 -58
- package/tests/vitest/qb/auth/mockQuickbaseServer.ts +0 -60
- package/tests/vitest/qb/auth/retryUserToken401.test.ts +0 -73
- package/tests/vitest/qb/auth/ssoTokenConcurrency.test.ts +0 -68
- package/tests/vitest/qb/auth/ssoTokenIntegrationWithServer.test.ts +0 -65
- package/tests/vitest/qb/auth/userTokenConcurrency.test.ts +0 -63
- package/tests/vitest/qb/fields/createField.test.ts +0 -77
- package/tests/vitest/qb/fields/deleteFields.test.ts +0 -83
- package/tests/vitest/qb/fields/getField.test.ts +0 -85
- package/tests/vitest/qb/fields/getFieldUsage.test.ts +0 -82
- package/tests/vitest/qb/fields/getFields.test.ts +0 -232
- package/tests/vitest/qb/fields/getFieldsUsage.test.ts +0 -77
- package/tests/vitest/qb/fields/updateField.test.ts +0 -93
- package/tests/vitest/qb/formulas/runFormula.test.ts +0 -96
- package/tests/vitest/qb/index.ts +0 -29
- package/tests/vitest/qb/records/deleteRecords.test.ts +0 -110
- package/tests/vitest/qb/records/runQuery.test.ts +0 -146
- package/tests/vitest/qb/records/upsert.test.ts +0 -102
- package/tests/vitest/qb/tables/createRelationship.test.ts +0 -102
- package/tests/vitest/qb/tables/createTable.test.ts +0 -55
- package/tests/vitest/qb/tables/deleteRelationship.test.ts +0 -143
- package/tests/vitest/qb/tables/deleteTable.test.ts +0 -50
- package/tests/vitest/qb/tables/getAppTables.test.ts +0 -46
- package/tests/vitest/qb/tables/getRelationships.test.ts +0 -80
- package/tests/vitest/qb/tables/getTable.test.ts +0 -26
- package/tests/vitest/qb/tables/updateRelationship.test.ts +0 -250
- package/tests/vitest/qb/tables/updateTable.test.ts +0 -48
- package/tests/vitest/unit/ThrottleBucket.test.ts +0 -101
- package/tests/vitest/unit/apps/copyApp.test.ts +0 -581
- package/tests/vitest/unit/apps/createApp.test.ts +0 -186
- package/tests/vitest/unit/apps/deleteApp.test.ts +0 -216
- package/tests/vitest/unit/apps/getApp.test.ts +0 -128
- package/tests/vitest/unit/apps/getAppConcurrency.test.ts +0 -151
- package/tests/vitest/unit/apps/getAppEvents.test.ts +0 -193
- package/tests/vitest/unit/apps/updateApp.test.ts +0 -412
- package/tests/vitest/unit/auth/fetchTempToken401.test.ts +0 -81
- package/tests/vitest/unit/auth/getTempToken.test.ts +0 -119
- package/tests/vitest/unit/auth/retryTempToken401.test.ts +0 -95
- package/tests/vitest/unit/auth/retryTempTokenMaxRetries.test.ts +0 -206
- package/tests/vitest/unit/auth/retryUserToken401.test.ts +0 -69
- package/tests/vitest/unit/auth/ssoTokenRefresh.test.ts +0 -325
- package/tests/vitest/unit/auth/userTokenConcurrency.test.ts +0 -62
- package/tests/vitest/unit/fields/createField.test.ts +0 -451
- package/tests/vitest/unit/fields/deleteFields.test.ts +0 -141
- package/tests/vitest/unit/fields/getField.test.ts +0 -189
- package/tests/vitest/unit/fields/getFieldUsage.test.ts +0 -180
- package/tests/vitest/unit/fields/getFields.test.ts +0 -122
- package/tests/vitest/unit/fields/getFieldsUsage.test.ts +0 -160
- package/tests/vitest/unit/fields/updateField.test.ts +0 -285
- package/tests/vitest/unit/formulas/runFormula.test.ts +0 -205
- package/tests/vitest/unit/index.ts +0 -34
- package/tests/vitest/unit/quickbaseClientHttpMethods.test.ts +0 -139
- package/tests/vitest/unit/rateLimit.test.ts +0 -191
- package/tests/vitest/unit/records/deleteRecords.test.ts +0 -112
- package/tests/vitest/unit/records/runQuery.test.ts +0 -102
- package/tests/vitest/unit/records/upsert.test.ts +0 -234
- package/tests/vitest/unit/tables/createRelationship.test.ts +0 -212
- package/tests/vitest/unit/tables/createTable.test.ts +0 -70
- package/tests/vitest/unit/tables/deleteRelationship.test.ts +0 -97
- package/tests/vitest/unit/tables/deleteTable.test.ts +0 -77
- package/tests/vitest/unit/tables/getAppTables.test.ts +0 -85
- package/tests/vitest/unit/tables/getRelationships.test.ts +0 -259
- package/tests/vitest/unit/tables/getTable.test.ts +0 -233
- package/tests/vitest/unit/tables/updateRelationship.test.ts +0 -307
- package/tests/vitest/unit/tables/updateTable.test.ts +0 -80
- package/tests/vitest/unit/tokenLifespan.test.ts +0 -204
- package/tests/vitest/unit/umd.test.ts +0 -8
- package/tools/log-gen.ts +0 -251
- package/tools/log-gen.yaml +0 -4829
- package/tools/openapi-jars/openapi-generator-cli-7.12.0.jar +0 -0
- package/tsconfig.build.json +0 -17
- package/tsconfig.json +0 -32
- package/versionrc.json +0 -9
- package/vitest.config.ts +0 -27
|
@@ -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
|
-
});
|
|
@@ -1,133 +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
|
-
appUrl: string
|
|
13
|
-
): Promise<void> => {
|
|
14
|
-
console.log("Logging in to QuickBase");
|
|
15
|
-
await page.goto(quickbaseUrl, { timeout: 60000 });
|
|
16
|
-
await page.waitForSelector("input[name='loginid']", { timeout: 60000 });
|
|
17
|
-
await page.fill("input[name='loginid']", username);
|
|
18
|
-
await page.fill("input[name='password']", password);
|
|
19
|
-
await page.click("#signin");
|
|
20
|
-
await page.waitForURL(`https://*.quickbase.com/**`, {
|
|
21
|
-
waitUntil: "networkidle",
|
|
22
|
-
timeout: 60000,
|
|
23
|
-
});
|
|
24
|
-
console.log("Signed In to QuickBase.");
|
|
25
|
-
await page.goto(appUrl, { waitUntil: "networkidle", timeout: 60000 });
|
|
26
|
-
console.log("Navigated to app URL:", page.url());
|
|
27
|
-
};
|
|
28
|
-
|
|
29
|
-
test.describe("QuickbaseClient Integration - Temp Token Renewal", () => {
|
|
30
|
-
test("renews temp token after 5 minutes with getApp → wait → getApp sequence", async ({
|
|
31
|
-
page,
|
|
32
|
-
}) => {
|
|
33
|
-
const realm = process.env.QB_REALM ?? "";
|
|
34
|
-
const appId = process.env.QB_APP_ID ?? "";
|
|
35
|
-
const username = process.env.QB_USERNAME ?? "";
|
|
36
|
-
const password = process.env.QB_PASSWORD ?? "";
|
|
37
|
-
|
|
38
|
-
if (!realm || !appId || !username || !password) {
|
|
39
|
-
throw new Error(
|
|
40
|
-
"Required QuickBase environment variables are not defined"
|
|
41
|
-
);
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
|
|
45
|
-
const appUrl = `https://${realm}.quickbase.com/db/${appId}`;
|
|
46
|
-
|
|
47
|
-
await loginToQuickbase(page, quickbaseUrl, username, password, appUrl);
|
|
48
|
-
|
|
49
|
-
const client = quickbase({
|
|
50
|
-
realm,
|
|
51
|
-
useTempTokens: true,
|
|
52
|
-
debug: true,
|
|
53
|
-
fetchApi: async (input: RequestInfo | URL, init?: RequestInit) => {
|
|
54
|
-
const url = input.toString();
|
|
55
|
-
console.log(`Fetching ${url} with init:`, init);
|
|
56
|
-
const effectiveInit = init || {};
|
|
57
|
-
const response = await page.evaluate(
|
|
58
|
-
async ([fetchUrl, fetchInit]: [string, RequestInit]) => {
|
|
59
|
-
const res = await fetch(fetchUrl, fetchInit); // Rely on quickbaseClient.ts for credentials
|
|
60
|
-
const body = await res.text();
|
|
61
|
-
const headersObj: Record<string, string> = {};
|
|
62
|
-
res.headers.forEach((value, key) => {
|
|
63
|
-
headersObj[key] = value;
|
|
64
|
-
});
|
|
65
|
-
return {
|
|
66
|
-
ok: res.ok,
|
|
67
|
-
status: res.status,
|
|
68
|
-
statusText: res.statusText,
|
|
69
|
-
headers: headersObj,
|
|
70
|
-
body,
|
|
71
|
-
};
|
|
72
|
-
},
|
|
73
|
-
[url, effectiveInit] as [string, RequestInit]
|
|
74
|
-
);
|
|
75
|
-
|
|
76
|
-
console.log(`Raw response from ${url}:`, {
|
|
77
|
-
status: response.status,
|
|
78
|
-
statusText: response.statusText,
|
|
79
|
-
body: response.body,
|
|
80
|
-
});
|
|
81
|
-
|
|
82
|
-
const fetchResponse = new Response(response.body || null, {
|
|
83
|
-
status: response.status,
|
|
84
|
-
statusText: response.statusText,
|
|
85
|
-
headers: new Headers(response.headers),
|
|
86
|
-
});
|
|
87
|
-
|
|
88
|
-
fetchResponse.json = async () => {
|
|
89
|
-
if (!response.body) {
|
|
90
|
-
throw new Error("Empty response body from API");
|
|
91
|
-
}
|
|
92
|
-
try {
|
|
93
|
-
return JSON.parse(response.body);
|
|
94
|
-
} catch (e) {
|
|
95
|
-
throw new SyntaxError(`Invalid JSON response: ${response.body}`);
|
|
96
|
-
}
|
|
97
|
-
};
|
|
98
|
-
|
|
99
|
-
return fetchResponse;
|
|
100
|
-
},
|
|
101
|
-
}) as QuickbaseClient;
|
|
102
|
-
|
|
103
|
-
console.log("Checking session state before getApp...");
|
|
104
|
-
const cookies = await page.context().cookies();
|
|
105
|
-
const sessionCookie = cookies.find(
|
|
106
|
-
(c) => c.name === "TICKET" || c.name.startsWith("TICKET_")
|
|
107
|
-
);
|
|
108
|
-
console.log(
|
|
109
|
-
"Session cookie present:",
|
|
110
|
-
!!sessionCookie,
|
|
111
|
-
"Cookies:",
|
|
112
|
-
cookies
|
|
113
|
-
);
|
|
114
|
-
if (!sessionCookie) throw new Error("TICKET session cookie not found");
|
|
115
|
-
|
|
116
|
-
await page.waitForTimeout(5000); // Debug delay
|
|
117
|
-
console.log("Cookies after delay:", await page.context().cookies());
|
|
118
|
-
|
|
119
|
-
const appResult1 = await client.getApp({ appId });
|
|
120
|
-
console.log("First getApp response:", appResult1);
|
|
121
|
-
expect(appResult1).toHaveProperty("id", appId);
|
|
122
|
-
|
|
123
|
-
console.log("Waiting 5 minutes to test token expiration...");
|
|
124
|
-
await new Promise((resolve) => setTimeout(resolve, 5 * 60 * 1000));
|
|
125
|
-
|
|
126
|
-
await page.reload({ waitUntil: "load", timeout: 60000 });
|
|
127
|
-
console.log("Refreshed page after 5 minutes, URL:", page.url());
|
|
128
|
-
|
|
129
|
-
const appResult2 = await client.getApp({ appId });
|
|
130
|
-
console.log("Second getApp response:", appResult2);
|
|
131
|
-
expect(appResult2).toHaveProperty("id", appId);
|
|
132
|
-
});
|
|
133
|
-
});
|
package/tests/setup.ts
DELETED
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
// @tests/setup.ts
|
|
2
|
-
import { vi } from "vitest";
|
|
3
|
-
import { quickbase } from "../src/quickbaseClient.ts";
|
|
4
|
-
import type { QuickbaseConfig } from "../src/quickbaseClient.ts";
|
|
5
|
-
import dotenv from "dotenv";
|
|
6
|
-
|
|
7
|
-
// Load environment variables from .env file
|
|
8
|
-
dotenv.config({ path: "./.env" }); // Assumes .env is at project root
|
|
9
|
-
|
|
10
|
-
export const mockFetch = vi.fn();
|
|
11
|
-
|
|
12
|
-
export const QB_REALM = process.env.QB_REALM || "test-realm";
|
|
13
|
-
export const QB_USER_TOKEN =
|
|
14
|
-
process.env.QB_USER_TOKEN || "user-token-1234567890";
|
|
15
|
-
export const QB_APP_ID = process.env.QB_APP_ID || "app-id-1234567890";
|
|
16
|
-
export const QB_TABLE_ID_1 =
|
|
17
|
-
process.env.QB_TABLE_ID_1 || "table-id-1-1234567890";
|
|
18
|
-
export const QB_TABLE_ID_2 =
|
|
19
|
-
process.env.QB_TABLE_ID_2 || "table-id-2-1234567890";
|
|
20
|
-
|
|
21
|
-
// Mock env variables for consistency, using .env values if available
|
|
22
|
-
vi.stubEnv("QB_REALM", QB_REALM);
|
|
23
|
-
vi.stubEnv("QB_USER_TOKEN", QB_USER_TOKEN);
|
|
24
|
-
vi.stubEnv("QB_APP_ID", QB_APP_ID);
|
|
25
|
-
vi.stubEnv("QB_TABLE_ID_1", QB_TABLE_ID_1);
|
|
26
|
-
vi.stubEnv("QB_TABLE_ID_2", QB_TABLE_ID_2);
|
|
27
|
-
|
|
28
|
-
export const createClient = (
|
|
29
|
-
fetchApi?: any,
|
|
30
|
-
config: Partial<QuickbaseConfig> = {}
|
|
31
|
-
) => {
|
|
32
|
-
// Use loaded env vars with fallbacks for safety
|
|
33
|
-
const realm = QB_REALM;
|
|
34
|
-
const userToken = QB_USER_TOKEN;
|
|
35
|
-
|
|
36
|
-
const client = quickbase({
|
|
37
|
-
realm,
|
|
38
|
-
userToken,
|
|
39
|
-
debug: true,
|
|
40
|
-
fetchApi,
|
|
41
|
-
throttle: { rate: 10, burst: 10 }, // Throttle at 10 req/s with 10 burst capacity
|
|
42
|
-
...config, // Allow overrides if provided
|
|
43
|
-
});
|
|
44
|
-
console.log("[createClient] Config:", {
|
|
45
|
-
realm,
|
|
46
|
-
userToken,
|
|
47
|
-
debug: true,
|
|
48
|
-
throttle: { rate: 10, burst: 10 },
|
|
49
|
-
...config,
|
|
50
|
-
});
|
|
51
|
-
console.log("[createClient] Returning:", client);
|
|
52
|
-
return client;
|
|
53
|
-
};
|