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,73 +0,0 @@
1
- import { describe, it, vi, expect, beforeEach } from "vitest";
2
- import { quickbase, QuickbaseClient } from "../../../../src/quickbaseClient";
3
-
4
- describe("QuickbaseClient Integration - User Token Retry on 401", () => {
5
- let client: QuickbaseClient;
6
-
7
- beforeEach(() => {
8
- const userToken = process.env.QB_USER_TOKEN;
9
- const realm = process.env.QB_REALM;
10
- const tableId = process.env.QB_TABLE_ID_1; // Consistent env var name
11
-
12
- if (!userToken) {
13
- throw new Error(
14
- "QB_USER_TOKEN environment variable is required for integration test"
15
- );
16
- }
17
- if (!tableId) {
18
- throw new Error(
19
- "QB_TABLE_ID_1 environment variable is required for integration test"
20
- );
21
- }
22
-
23
- const config = {
24
- realm,
25
- userToken,
26
- debug: true,
27
- };
28
- console.log("[quickbaseTest] Config:", {
29
- realm,
30
- userToken: userToken.substring(0, 10) + "...",
31
- tableId, // Log to confirm
32
- debug: true,
33
- });
34
- client = quickbase(config);
35
- });
36
-
37
- it(
38
- "successfully retrieves fields with user token, retrying on transient 401 if needed",
39
- async () => {
40
- const consoleSpy = vi.spyOn(console, "log");
41
-
42
- const tableId = process.env.QB_TABLE_ID_1!; // Match beforeEach
43
- let fields;
44
- try {
45
- fields = await client.getFields({ tableId });
46
- } catch (error) {
47
- console.error("[integrationTest] Failed to retrieve fields:", error);
48
- throw error;
49
- }
50
-
51
- expect(fields).toBeInstanceOf(Array);
52
- expect(fields.length).toBeGreaterThan(0);
53
- expect(fields[0]).toHaveProperty("id");
54
- expect(fields[0]).toHaveProperty("label");
55
-
56
- console.log("[integrationTest] Fields retrieved:", fields.length);
57
-
58
- const retryLog = consoleSpy.mock.calls.some((call) =>
59
- call[0].includes("Retrying getFields with existing user token")
60
- );
61
- if (retryLog) {
62
- console.log("[integrationTest] Retry on 401 detected");
63
- } else {
64
- console.log(
65
- "[integrationTest] No 401 retries observed (expected if no transient failure)"
66
- );
67
- }
68
-
69
- consoleSpy.mockRestore();
70
- },
71
- { timeout: 10000 }
72
- );
73
- });
@@ -1,68 +0,0 @@
1
- // tests/vitest/qb/auth/ssoTokenConcurrency.test.ts
2
- import { test, expect, vi } from "vitest";
3
- import { quickbase } from "../../../../src/quickbaseClient";
4
- import { startMockQuickbaseServer } from "./mockQuickbaseServer";
5
- import { QB_APP_ID, QB_REALM } from "@tests/setup.ts";
6
-
7
- test(
8
- "QuickbaseClient Integration - getApp with SsoTokenStrategy Concurrency",
9
- async () => {
10
- const mockServer = startMockQuickbaseServer(3000);
11
-
12
- // Spy on console.log before any actions
13
- const consoleSpy = vi.spyOn(console, "log");
14
-
15
- try {
16
- const client = quickbase({
17
- realm: QB_REALM,
18
- useSso: true,
19
- samlToken: "mock-saml-token",
20
- debug: true,
21
- baseUrl: "http://localhost:3000/v1",
22
- });
23
-
24
- const concurrentRequests = [
25
- client.getApp({ appId: QB_APP_ID }),
26
- client.getApp({ appId: QB_APP_ID }),
27
- client.getApp({ appId: QB_APP_ID }),
28
- ];
29
-
30
- const results = await Promise.all(concurrentRequests);
31
-
32
- expect(results).toHaveLength(3);
33
- results.forEach((result) =>
34
- expect(result).toEqual({
35
- id: QB_APP_ID,
36
- name: "Mock App",
37
- created: expect.any(Date),
38
- updated: expect.any(Date),
39
- })
40
- );
41
-
42
- // Verify token fetch and waits using console logs
43
- const logs = consoleSpy.mock.calls;
44
- const tokenFetchLogs = logs.filter((call) =>
45
- call[0].includes("[fetchSsoToken] Fetched token")
46
- );
47
- expect(tokenFetchLogs).toHaveLength(1); // Single fetch with synchronization
48
-
49
- const waitLogs = logs.filter((call) =>
50
- call[0].includes("Waiting for existing SSO fetch")
51
- );
52
- expect(waitLogs.length).toBeGreaterThanOrEqual(2); // At least two waits
53
-
54
- const appRequestLogs = logs.filter((call) =>
55
- call[0].includes("Received getApp request")
56
- );
57
- expect(appRequestLogs).toHaveLength(3);
58
-
59
- console.log(
60
- "SsoTokenStrategy: Single token fetch with concurrent waits confirmed."
61
- );
62
- } finally {
63
- mockServer.close();
64
- consoleSpy.mockRestore();
65
- }
66
- },
67
- { timeout: 20000 }
68
- );
@@ -1,65 +0,0 @@
1
- // tests/vitest/qb/auth/ssoTokenIntegrationWithServer.test.ts
2
-
3
- import { describe, it, expect, beforeAll, afterAll, vi } from "vitest"; // Add 'vi' to imports
4
- import { quickbase } from "../../../../src/quickbaseClient";
5
- import { startMockQuickbaseServer } from "./mockQuickbaseServer";
6
-
7
- describe("QuickbaseClient Integration - SSO with Mock Server", () => {
8
- let mockServer: ReturnType<typeof startMockQuickbaseServer>;
9
- const mockBaseUrl = "http://localhost:3000";
10
-
11
- beforeAll(async () => {
12
- mockServer = startMockQuickbaseServer(3000);
13
- await new Promise((resolve) => setTimeout(resolve, 500));
14
- console.log("Server setup complete, port 3000 should be listening");
15
- });
16
-
17
- afterAll(() => {
18
- mockServer.close();
19
- console.log("Server closed");
20
- });
21
-
22
- it(
23
- "uses SSO token from mock server and retries on 401",
24
- { timeout: 10000 }, // Move timeout to second argument
25
- async () => {
26
- const consoleSpy = vi.spyOn(console, "log"); // Spy on console.log to capture logs
27
- const client = quickbase({
28
- realm: "testrealm",
29
- samlToken: "mock-saml-token",
30
- useSso: true,
31
- fetchApi: (url, options) => {
32
- const rewrittenUrl = url.replace(
33
- "https://api.quickbase.com/v1",
34
- mockBaseUrl + "/v1"
35
- );
36
- console.log(
37
- "[fetchApi] Requesting:",
38
- rewrittenUrl,
39
- "Options:",
40
- options
41
- );
42
- return fetch(rewrittenUrl, options);
43
- },
44
- debug: true,
45
- });
46
-
47
- await mockServer.toggleFail();
48
- const response = await client.getApp({ appId: "mockappid" });
49
-
50
- expect(response).toBeDefined();
51
- expect(response.id).toBe("mockappid");
52
- expect(response.name).toBe("Mock App");
53
-
54
- // Verify retry happened
55
- const retryLog = consoleSpy.mock.calls.some((call) =>
56
- call[0].includes(
57
- "Authorization error for getApp (SSO), refreshing token"
58
- )
59
- );
60
- expect(retryLog).toBe(true); // Ensure retry logic was triggered
61
-
62
- consoleSpy.mockRestore();
63
- }
64
- );
65
- });
@@ -1,63 +0,0 @@
1
- // tests/vitest/qb/auth/userTokenConcurrency.test.ts
2
- import { test, expect } from "vitest";
3
- import { quickbase } from "../../../../src/quickbaseClient";
4
-
5
- test(
6
- "QuickbaseClient Integration - getApp with UserToken Concurrency",
7
- async () => {
8
- const realm = process.env.QB_REALM || "";
9
- const appId = process.env.QB_APP_ID || "";
10
- const userToken = process.env.QB_USER_TOKEN || "";
11
-
12
- if (!realm || !appId || !userToken) {
13
- throw new Error(
14
- "QB_REALM, QB_APP_ID, and QB_USER_TOKEN must be set in .env"
15
- );
16
- }
17
-
18
- const client = quickbase({
19
- realm,
20
- userToken,
21
- debug: true,
22
- });
23
-
24
- const concurrentRequests = [
25
- client.getApp({ appId }),
26
- client.getApp({ appId }),
27
- client.getApp({ appId }),
28
- ];
29
-
30
- const results = await Promise.all(concurrentRequests);
31
-
32
- const expectedAppData = {
33
- id: appId,
34
- name: "qb-copy",
35
- created: expect.any(Date),
36
- updated: expect.any(Date),
37
- description: "",
38
- timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
39
- dateFormat: "MM-DD-YYYY",
40
- hasEveryoneOnTheInternet: false,
41
- memoryInfo: { estMemory: 0, estMemoryInclDependentApps: 0 },
42
- securityProperties: {
43
- allowClone: false,
44
- allowExport: true,
45
- enableAppTokens: true,
46
- hideFromPublic: false,
47
- mustBeRealmApproved: false,
48
- useIPFilter: false,
49
- },
50
- ancestorId: undefined,
51
- dataClassification: undefined,
52
- variables: [{ name: "TestVar", value: "TestValue" }],
53
- };
54
-
55
- expect(results).toHaveLength(3);
56
- results.forEach((result) => expect(result).toEqual(expectedAppData));
57
-
58
- console.log(
59
- "UserTokenStrategy: All concurrent requests used static token."
60
- );
61
- },
62
- { timeout: 20000 }
63
- );
@@ -1,77 +0,0 @@
1
- import { describe, it, expect, afterAll } from "vitest";
2
- import { createClient, QB_TABLE_ID_1 } from "../../../setup.ts";
3
-
4
- describe("QuickbaseClient Integration - createField", () => {
5
- const client = createClient();
6
-
7
- const createdFieldIds: number[] = [];
8
-
9
- afterAll(async () => {
10
- if (createdFieldIds.length > 0) {
11
- try {
12
- const response = await client.deleteFields({
13
- tableId: QB_TABLE_ID_1,
14
- body: { fieldIds: createdFieldIds },
15
- });
16
- console.log(
17
- `Cleaned up fields: ${JSON.stringify(response.deletedFieldIds)}`,
18
- response.errors && response.errors.length > 0
19
- ? `Errors: ${response.errors}`
20
- : ""
21
- );
22
- } catch (error) {
23
- console.error("Cleanup failed:", error);
24
- console.log(`Fields left in table: ${createdFieldIds}`);
25
- }
26
- } else {
27
- console.log("No fields to clean up.");
28
- }
29
- });
30
-
31
- it("creates a field with user token", async () => {
32
- const uniqueLabel = `TestField_${Date.now()}`;
33
- const response = await client.createField({
34
- tableId: QB_TABLE_ID_1,
35
- body: {
36
- label: uniqueLabel,
37
- fieldType: "text",
38
- fieldHelp: "Created via integration test",
39
- addToForms: true,
40
- },
41
- });
42
-
43
- expect(response.id).toBeDefined();
44
- expect(response.label).toBe(uniqueLabel);
45
- expect(response.fieldType).toBe("text");
46
- expect(response.fieldHelp).toBe("Created via integration test");
47
-
48
- createdFieldIds.push(response.id);
49
- console.log(`Created field ${uniqueLabel} with ID ${response.id}`);
50
- });
51
-
52
- it("fails with invalid field type", async () => {
53
- const uniqueLabel = `InvalidField_${Date.now()}`;
54
- await expect(
55
- client.createField({
56
- tableId: QB_TABLE_ID_1,
57
- body: {
58
- label: uniqueLabel,
59
- fieldType: "invalid_type" as "text", // Type assertion to bypass compile-time check
60
- fieldHelp: "Should fail",
61
- },
62
- })
63
- ).rejects.toThrow("API Error: Bad Request (Status: 400)");
64
- }, 10000); // Increased timeout to 10 seconds
65
-
66
- it("fails with missing label", async () => {
67
- await expect(
68
- client.createField({
69
- tableId: QB_TABLE_ID_1,
70
- body: {
71
- label: "",
72
- fieldType: "text",
73
- },
74
- })
75
- ).rejects.toThrow("API Error: Invalid input (Status: 400)");
76
- });
77
- });
@@ -1,83 +0,0 @@
1
- // tests/vitest/qb/fields/deleteFields.test.ts
2
- import { describe, it, expect, beforeAll } from "vitest";
3
- import { createClient, QB_TABLE_ID_1 } from "../../../setup.ts";
4
-
5
- describe("QuickbaseClient Integration - deleteFields", () => {
6
- const client = createClient();
7
- let fieldIdsToDelete: number[] = [];
8
-
9
- beforeAll(async () => {
10
- try {
11
- const fieldLabels = ["DeleteTest1", "DeleteTest2"];
12
- for (const label of fieldLabels) {
13
- const response = await client.createField({
14
- tableId: QB_TABLE_ID_1,
15
- body: {
16
- label,
17
- fieldType: "text",
18
- fieldHelp: "Test field for deletion",
19
- },
20
- });
21
- fieldIdsToDelete.push(response.id);
22
- console.log(`Created field ${label} with ID ${response.id}`);
23
- }
24
- if (fieldIdsToDelete.length !== 2) {
25
- throw new Error("Failed to create all test fields");
26
- }
27
- } catch (error) {
28
- console.error("beforeAll failed:", error);
29
- throw error;
30
- }
31
- });
32
-
33
- it("deletes fields successfully with user token", async () => {
34
- try {
35
- const response = await client.deleteFields({
36
- tableId: QB_TABLE_ID_1,
37
- body: { fieldIds: fieldIdsToDelete },
38
- });
39
- console.log("deleteFields response:", JSON.stringify(response, null, 2));
40
- expect(response).toBeDefined();
41
- expect(response.deletedFieldIds).toEqual(
42
- expect.arrayContaining(fieldIdsToDelete)
43
- );
44
- expect(response.errors ?? []).toHaveLength(0);
45
- } catch (error) {
46
- console.error("deleteFields failed:", error);
47
- throw error;
48
- }
49
- });
50
-
51
- it("handles partial success with errors", { timeout: 10000 }, async () => {
52
- const newField = await client.createField({
53
- tableId: QB_TABLE_ID_1,
54
- body: { label: "DeleteTest3", fieldType: "text" },
55
- });
56
- console.log(`Created field DeleteTest3 with ID ${newField.id}`);
57
-
58
- const invalidFieldId = 999999;
59
- const fieldIds = [newField.id, invalidFieldId];
60
-
61
- console.log("Sending deleteFields request at:", new Date());
62
- const response = await client.deleteFields({
63
- tableId: QB_TABLE_ID_1,
64
- body: { fieldIds },
65
- });
66
- console.log("deleteFields response received at:", new Date());
67
- console.log("Response:", JSON.stringify(response, null, 2));
68
-
69
- expect(response.deletedFieldIds).toContain(newField.id);
70
- expect(response.deletedFieldIds).not.toContain(invalidFieldId);
71
- expect(response.errors).toHaveLength(1);
72
- expect(response.errors[0]).toMatch(/Field: 999999 was not found/i);
73
- });
74
-
75
- it("fails with invalid request (empty fieldIds)", async () => {
76
- await expect(
77
- client.deleteFields({
78
- tableId: QB_TABLE_ID_1,
79
- body: { fieldIds: [] },
80
- })
81
- ).rejects.toThrow("API Error: Bad Request (Status: 400)");
82
- });
83
- });
@@ -1,85 +0,0 @@
1
- // tests/vitest/qb/fields/getField.test.ts
2
- import { describe, it, expect } from "vitest";
3
- import { createClient, QB_TABLE_ID_1 } from "../../../setup.ts";
4
-
5
- describe("QuickbaseClient Integration - getField", () => {
6
- const client = createClient();
7
-
8
- it("retrieves an existing field with user token", async () => {
9
- // Create a field to ensure we have a known field ID to retrieve
10
- const uniqueLabel = `TestField_${Date.now()}`;
11
- const createResponse = await client.createField({
12
- tableId: QB_TABLE_ID_1,
13
- body: {
14
- label: uniqueLabel,
15
- fieldType: "text",
16
- fieldHelp: "Created for getField integration test",
17
- addToForms: true,
18
- },
19
- });
20
-
21
- expect(createResponse.id).toBeDefined();
22
- const fieldId = createResponse.id;
23
- console.log(`Created field ${uniqueLabel} with ID ${fieldId} for testing`);
24
-
25
- // Test getField with the created field
26
- const response = await client.getField({
27
- fieldId: fieldId,
28
- tableId: QB_TABLE_ID_1,
29
- includeFieldPerms: true,
30
- });
31
-
32
- expect(response.id).toBe(fieldId);
33
- expect(response.label).toBe(uniqueLabel);
34
- expect(response.fieldType).toBe("text");
35
- expect(response.fieldHelp).toBe("Created for getField integration test");
36
- expect(response.permissions).toBeDefined();
37
- expect(Array.isArray(response.permissions)).toBe(true);
38
- console.log(`Retrieved field ${response.label} with ID ${response.id}`);
39
-
40
- // Clean up the created field
41
- try {
42
- const deleteResponse = await client.deleteFields({
43
- tableId: QB_TABLE_ID_1,
44
- body: { fieldIds: [fieldId] },
45
- });
46
- console.log(
47
- `Cleaned up field ${fieldId}: ${JSON.stringify(deleteResponse)}`
48
- );
49
- } catch (error) {
50
- console.error(`Failed to clean up field ${fieldId}:`, error);
51
- }
52
- }, 10000); // Increase timeout to 10 seconds
53
-
54
- it("fails with non-existent field ID", async () => {
55
- const nonExistentFieldId = 999999; // Assuming this ID doesn’t exist
56
- await expect(
57
- client.getField({
58
- fieldId: nonExistentFieldId,
59
- tableId: QB_TABLE_ID_1,
60
- })
61
- ).rejects.toMatchObject({
62
- message: expect.stringContaining(
63
- "API Error: No such field (Status: 404)"
64
- ),
65
- });
66
- console.log(
67
- `Confirmed 404 for non-existent field ID ${nonExistentFieldId}`
68
- );
69
- });
70
-
71
- it("fails with invalid table ID", async () => {
72
- const invalidTableId = "invalid_dbid";
73
- await expect(
74
- client.getField({
75
- fieldId: 1, // Arbitrary field ID
76
- tableId: invalidTableId,
77
- })
78
- ).rejects.toMatchObject({
79
- message: expect.stringContaining(
80
- "API Error: Invalid request (Status: 400)"
81
- ),
82
- });
83
- console.log(`Confirmed 400 for invalid table ID ${invalidTableId}`);
84
- });
85
- });
@@ -1,82 +0,0 @@
1
- // tests/vitest/qb/fields/getFieldsUsage.test.ts
2
-
3
- import { describe, it, expect } from "vitest";
4
- import { createClient, QB_TABLE_ID_1 } from "../../../setup.ts";
5
- import { FieldUsage } from "@/generated/models";
6
-
7
- describe("QuickbaseClient Integration - getFieldsUsage", () => {
8
- const client = createClient();
9
-
10
- it("retrieves field usage statistics for a valid table", async () => {
11
- console.log("Starting retrieval of full field usage list");
12
- const response = await client.getFieldsUsage({
13
- tableId: QB_TABLE_ID_1,
14
- });
15
-
16
- expect(response).toBeInstanceOf(Array);
17
- expect(response.length).toBeGreaterThan(0); // Assumes the table has fields
18
- response.forEach((usage: FieldUsage) => {
19
- expect(usage.field).toHaveProperty("id");
20
- expect(usage.field).toHaveProperty("name");
21
- expect(usage.field).toHaveProperty("type");
22
- expect(usage.usage).toHaveProperty("actions");
23
- expect(usage.usage.actions).toHaveProperty("count");
24
- expect(typeof usage.usage.actions.count).toBe("number");
25
- expect(usage.usage).toHaveProperty("dashboards");
26
- expect(usage.usage).toHaveProperty("forms");
27
- expect(usage.usage).toHaveProperty("reports");
28
- });
29
- console.log(
30
- `Retrieved ${response.length} field usage entries for table ${QB_TABLE_ID_1}`
31
- );
32
- }, 15000); // 15-second timeout
33
-
34
- it("retrieves field usage with skip and top parameters", async () => {
35
- console.log(
36
- "Starting retrieval of full field usage list for skip/top test"
37
- );
38
- const fullResponse = await client.getFieldsUsage({
39
- tableId: QB_TABLE_ID_1,
40
- });
41
- console.log(`Full list retrieved: ${fullResponse.length} fields`);
42
-
43
- const totalFields = fullResponse.length;
44
- if (totalFields <= 1) {
45
- console.log("Skipping skip/top test: table has too few fields");
46
- return; // Skip if not enough fields to test pagination
47
- }
48
-
49
- console.log("Starting retrieval with skip=1 and top=1");
50
- const response = await client.getFieldsUsage({
51
- tableId: QB_TABLE_ID_1,
52
- skip: 1,
53
- top: 1,
54
- });
55
-
56
- expect(response).toBeInstanceOf(Array);
57
- expect(response.length).toBe(1); // Should return exactly 1 field
58
- expect(response[0].field.id).not.toBe(fullResponse[0].field.id); // Should skip the first field
59
- console.log(
60
- `Retrieved ${response.length} field usage entries with skip=1 and top=1`
61
- );
62
- }, 15000); // 15-second timeout
63
-
64
- it("fails with invalid table ID", async () => {
65
- const invalidTableId = "invalid_dbid";
66
- console.log(`Starting retrieval with invalid table ID ${invalidTableId}`);
67
- const startTime = Date.now();
68
- await expect(
69
- client.getFieldsUsage({
70
- tableId: invalidTableId,
71
- })
72
- ).rejects.toMatchObject({
73
- message: expect.stringContaining(
74
- "API Error: Access denied (Status: 401)"
75
- ),
76
- });
77
- const duration = Date.now() - startTime;
78
- console.log(
79
- `Confirmed 401 for invalid table ID ${invalidTableId} in ${duration}ms`
80
- );
81
- }, 30000); // Increased to 30-second timeout
82
- });