quickbase-js 0.1.0-beta.8 → 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 (132) hide show
  1. package/README.md +252 -126
  2. package/dist/esm/quickbase.d.ts +2725 -2689
  3. package/dist/esm/quickbase.js +1763 -3524
  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 +1762 -3706
  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 +27 -12
  12. package/CHANGELOG.md +0 -155
  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 -256
  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/infer-schema.ts +0 -40
  37. package/open-api/utils/naming.ts +0 -10
  38. package/playwright.config.ts +0 -37
  39. package/rollup.config.js +0 -114
  40. package/specs/QuickBase_RESTful_API_2025-03-04T06_22_39.725Z.json +0 -46878
  41. package/specs/split/apps.json +0 -1315
  42. package/specs/split/auth.json +0 -191
  43. package/specs/split/fields.json +0 -3869
  44. package/specs/split/records.json +0 -754
  45. package/specs/split/reports.json +0 -619
  46. package/specs/split/tables.json +0 -1605
  47. package/src/RateLimitError.ts +0 -12
  48. package/src/ThrottleBucket.ts +0 -36
  49. package/src/generated-unified/QuickbaseClient.ts +0 -359
  50. package/src/generated-unified/missing-types-report.json +0 -3
  51. package/src/index.ts +0 -1
  52. package/src/invokeMethod.ts +0 -357
  53. package/src/quickbaseClient.ts +0 -244
  54. package/src/tokenCache.ts +0 -51
  55. package/src/utils.ts +0 -7
  56. package/test-esm.js +0 -1
  57. package/test-results.json +0 -2050
  58. package/test-umd.js +0 -1
  59. package/test.ts +0 -1
  60. package/tests/playwright/qb/auth/cacheSwitching.test.ts +0 -159
  61. package/tests/playwright/qb/auth/fetchTempToken401.test.ts +0 -219
  62. package/tests/playwright/qb/auth/getAppWithTempToken.test.ts +0 -162
  63. package/tests/playwright/qb/auth/getAppWithUserToken.test.ts +0 -153
  64. package/tests/playwright/qb/auth/getTempToken.test.ts +0 -152
  65. package/tests/playwright/qb/auth/tempTokenPrefetch.test.ts +0 -179
  66. package/tests/playwright/qb/auth/tempTokenRenewal.test.ts +0 -133
  67. package/tests/setup.ts +0 -53
  68. package/tests/vitest/qb/apps/copyApp.test.ts +0 -76
  69. package/tests/vitest/qb/apps/createApp.test.ts +0 -64
  70. package/tests/vitest/qb/apps/deleteApp.test.ts +0 -76
  71. package/tests/vitest/qb/apps/getApp.test.ts +0 -44
  72. package/tests/vitest/qb/apps/getAppEvents.test.ts +0 -67
  73. package/tests/vitest/qb/apps/updateApp.test.ts +0 -58
  74. package/tests/vitest/qb/auth/retryUserToken401.test.ts +0 -56
  75. package/tests/vitest/qb/fields/createField.test.ts +0 -77
  76. package/tests/vitest/qb/fields/deleteFields.test.ts +0 -83
  77. package/tests/vitest/qb/fields/getField.test.ts +0 -85
  78. package/tests/vitest/qb/fields/getFieldUsage.test.ts +0 -174
  79. package/tests/vitest/qb/fields/getFields.test.ts +0 -232
  80. package/tests/vitest/qb/fields/getFieldsUsage.test.ts +0 -77
  81. package/tests/vitest/qb/fields/updateField.test.ts +0 -93
  82. package/tests/vitest/qb/index.ts +0 -29
  83. package/tests/vitest/qb/records/deleteRecords.test.ts +0 -110
  84. package/tests/vitest/qb/records/runQuery.test.ts +0 -146
  85. package/tests/vitest/qb/records/upsert.test.ts +0 -102
  86. package/tests/vitest/qb/tables/createTable.test.ts +0 -55
  87. package/tests/vitest/qb/tables/deleteTable.test.ts +0 -50
  88. package/tests/vitest/qb/tables/getAppTables.test.ts +0 -46
  89. package/tests/vitest/qb/tables/getRelationships.test.ts +0 -80
  90. package/tests/vitest/qb/tables/getTable.test.ts +0 -26
  91. package/tests/vitest/qb/tables/updateRelationship.test.ts +0 -277
  92. package/tests/vitest/qb/tables/updateTable.test.ts +0 -48
  93. package/tests/vitest/unit/apps/copyApp.test.ts +0 -488
  94. package/tests/vitest/unit/apps/createApp.test.ts +0 -186
  95. package/tests/vitest/unit/apps/deleteApp.test.ts +0 -216
  96. package/tests/vitest/unit/apps/getApp.test.ts +0 -128
  97. package/tests/vitest/unit/apps/getAppEvents.test.ts +0 -193
  98. package/tests/vitest/unit/apps/updateApp.test.ts +0 -381
  99. package/tests/vitest/unit/auth/fetchTempToken401.test.ts +0 -62
  100. package/tests/vitest/unit/auth/getTempToken.test.ts +0 -95
  101. package/tests/vitest/unit/auth/retryTempToken401.test.ts +0 -113
  102. package/tests/vitest/unit/auth/retryTempTokenTwo401.test.ts +0 -81
  103. package/tests/vitest/unit/auth/retryUserToken401.test.ts +0 -56
  104. package/tests/vitest/unit/fields/createField.test.ts +0 -387
  105. package/tests/vitest/unit/fields/deleteFields.test.ts +0 -141
  106. package/tests/vitest/unit/fields/getField.test.ts +0 -189
  107. package/tests/vitest/unit/fields/getFieldUsage.test.ts +0 -166
  108. package/tests/vitest/unit/fields/getFields.test.ts +0 -122
  109. package/tests/vitest/unit/fields/getFieldsUsage.test.ts +0 -160
  110. package/tests/vitest/unit/fields/updateField.test.ts +0 -280
  111. package/tests/vitest/unit/index.ts +0 -33
  112. package/tests/vitest/unit/rateLimit.test.ts +0 -189
  113. package/tests/vitest/unit/records/deleteRecords.test.ts +0 -112
  114. package/tests/vitest/unit/records/runQuery.test.ts +0 -102
  115. package/tests/vitest/unit/records/upsert.test.ts +0 -234
  116. package/tests/vitest/unit/tables/createTable.test.ts +0 -70
  117. package/tests/vitest/unit/tables/deleteTable.test.ts +0 -77
  118. package/tests/vitest/unit/tables/getAppTables.test.ts +0 -85
  119. package/tests/vitest/unit/tables/getRelationships.test.ts +0 -259
  120. package/tests/vitest/unit/tables/getTable.test.ts +0 -233
  121. package/tests/vitest/unit/tables/updateRelationship.test.ts +0 -305
  122. package/tests/vitest/unit/tables/updateTable.test.ts +0 -80
  123. package/tests/vitest/unit/tokenLifespan.test.ts +0 -138
  124. package/tests/vitest/unit/umd.test.ts +0 -8
  125. package/text.txt +0 -104
  126. package/tools/log-gen.ts +0 -235
  127. package/tools/log-gen.yaml +0 -4982
  128. package/tools/openapi-jars/openapi-generator-cli-7.12.0.jar +0 -0
  129. package/tsconfig.build.json +0 -17
  130. package/tsconfig.json +0 -32
  131. package/versionrc.json +0 -9
  132. package/vitest.config.ts +0 -27
@@ -1,76 +0,0 @@
1
- // tests/vitest/qb/apps/deleteApp.test.ts
2
- import { test, expect } from "vitest";
3
- import { quickbase } from "../../../../src/quickbaseClient";
4
-
5
- test(
6
- "QuickbaseClient Integration - deleteApp > deletes an app in QuickBase",
7
- { timeout: 30000 },
8
- async () => {
9
- const config = {
10
- realm: process.env.QB_REALM || "",
11
- userToken: process.env.QB_USER_TOKEN || "",
12
- debug: true,
13
- useTempTokens: false,
14
- };
15
- const client = quickbase(config);
16
-
17
- const appName = `TempApp_${Date.now()}`;
18
- const createBody = {
19
- name: appName,
20
- description: "Temporary app for deleteApp test",
21
- assignToken: true, // Match createApp.test.ts
22
- };
23
-
24
- console.log("Config used:", {
25
- ...config,
26
- userToken: config.userToken ? "[REDACTED]" : "",
27
- });
28
- console.log("Creating temporary app with:", createBody);
29
- const createStartTime = Date.now();
30
- let createResponse;
31
- try {
32
- createResponse = await client.createApp({ body: createBody });
33
- const createDuration = Date.now() - createStartTime;
34
- console.log(`createApp completed in ${createDuration}ms`);
35
- console.log("Created app response:", createResponse);
36
-
37
- expect(createResponse).toBeDefined();
38
- expect(createResponse.id).toBeDefined();
39
- expect(createResponse.name).toBe(appName);
40
- } catch (error) {
41
- const createDuration = Date.now() - createStartTime;
42
- console.error(`createApp failed after ${createDuration}ms:`, error);
43
- throw error;
44
- }
45
-
46
- const deleteBody = {
47
- name: appName,
48
- };
49
- console.log("Deleting app with:", deleteBody);
50
- const deleteStartTime = Date.now();
51
- try {
52
- const deleteResponse = await client.deleteApp({
53
- appId: createResponse.id,
54
- body: deleteBody,
55
- });
56
- const deleteDuration = Date.now() - deleteStartTime;
57
- console.log(`deleteApp completed in ${deleteDuration}ms`);
58
- console.log("Delete app response:", deleteResponse);
59
-
60
- expect(deleteResponse).toBeDefined();
61
- expect(deleteResponse.deletedAppId).toBe(createResponse.id);
62
- } catch (error) {
63
- const deleteDuration = Date.now() - deleteStartTime;
64
- console.error(`deleteApp failed after ${deleteDuration}ms:`, error);
65
- if (error instanceof Error && "response" in error) {
66
- try {
67
- const errorBody = await (error as any).response.json();
68
- console.error("Full deleteApp error response:", errorBody);
69
- } catch (e) {
70
- console.error("Could not parse error response:", e);
71
- }
72
- }
73
- throw error;
74
- }
75
- }
76
- );
@@ -1,44 +0,0 @@
1
- // tests/vitest/qb/apps/getApp.test.ts
2
- import { test, expect } from "vitest";
3
- import { quickbase } from "../../../../src/quickbaseClient";
4
-
5
- test(
6
- "QuickbaseClient Integration - getApp > fetches real app data from QuickBase",
7
- { timeout: 10000 },
8
- async () => {
9
- const config = {
10
- realm: process.env.QB_REALM || "",
11
- userToken: process.env.QB_USER_TOKEN || "",
12
- debug: true,
13
- };
14
- const client = quickbase(config);
15
- const getAppId = "buwai2zpe";
16
-
17
- console.log("Config used:", config);
18
- const result = await client.getApp({ appId: getAppId });
19
- console.log("Real API response:", result);
20
-
21
- expect(result).toEqual({
22
- id: getAppId,
23
- name: "qb-copy",
24
- created: expect.any(Date),
25
- updated: expect.any(Date),
26
- description: "",
27
- timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
28
- dateFormat: "MM-DD-YYYY",
29
- hasEveryoneOnTheInternet: false,
30
- memoryInfo: { estMemory: 0, estMemoryInclDependentApps: 0 },
31
- securityProperties: {
32
- allowClone: false,
33
- allowExport: true,
34
- enableAppTokens: true,
35
- hideFromPublic: false,
36
- mustBeRealmApproved: false,
37
- useIPFilter: false,
38
- },
39
- ancestorId: undefined,
40
- dataClassification: undefined,
41
- variables: [{ name: "TestVar", value: "TestValue" }],
42
- });
43
- }
44
- );
@@ -1,67 +0,0 @@
1
- import { test, expect } from "vitest";
2
- import { quickbase } from "../../../../src/quickbaseClient";
3
-
4
- test(
5
- "QuickbaseClient Integration - getAppEvents > fetches real app events from QuickBase",
6
- { timeout: 10000 },
7
- async () => {
8
- const config = {
9
- realm: process.env.QB_REALM || "",
10
- userToken: process.env.QB_USER_TOKEN || "",
11
- debug: true,
12
- };
13
- const client = quickbase(config);
14
- const appId = "buwai2zpe"; // Same app ID as getApp test
15
-
16
- console.log("Config used:", config);
17
- const result = await client.getAppEvents({ appId });
18
- console.log("Real API response:", result);
19
-
20
- // Validate the response is an array of events
21
- expect(result).toBeInstanceOf(Array);
22
-
23
- // Check that each event has the required properties
24
- result.forEach((event) => {
25
- expect(event).toHaveProperty("type");
26
- expect([
27
- "qb-action",
28
- "webhook",
29
- "email-notification",
30
- "subscription",
31
- "reminder",
32
- "automation",
33
- ]).toContain(event.type);
34
-
35
- expect(event).toHaveProperty("owner");
36
- expect(event.owner).toHaveProperty("email");
37
- expect(typeof event.owner.email).toBe("string");
38
- expect(event.owner).toHaveProperty("id");
39
- expect(typeof event.owner.id).toBe("string");
40
- expect(event.owner).toHaveProperty("name");
41
- expect(typeof event.owner.name).toBe("string");
42
- // userName is optional, so we don't enforce it
43
-
44
- expect(event).toHaveProperty("isActive");
45
- expect(typeof event.isActive).toBe("boolean");
46
-
47
- expect(event).toHaveProperty("tableId");
48
- expect(typeof event.tableId).toBe("string");
49
-
50
- // Name is present for all types except automation
51
- if (event.type !== "automation") {
52
- expect(event).toHaveProperty("name");
53
- expect(typeof event.name).toBe("string");
54
- } else {
55
- expect(event.name).toBeUndefined();
56
- }
57
-
58
- // URL is only present for automation
59
- if (event.type === "automation") {
60
- expect(event).toHaveProperty("url");
61
- expect(typeof event.url).toBe("string");
62
- } else {
63
- expect(event.url).toBeUndefined();
64
- }
65
- });
66
- }
67
- );
@@ -1,58 +0,0 @@
1
- import { test, expect } from "vitest";
2
- import { quickbase } from "../../../../src/quickbaseClient";
3
-
4
- test(
5
- "QuickbaseClient Integration - updateApp > updates real app data in QuickBase",
6
- { timeout: 10000 },
7
- async () => {
8
- const config = {
9
- realm: process.env.QB_REALM || "",
10
- userToken: process.env.QB_USER_TOKEN || "",
11
- debug: true,
12
- };
13
- const client = quickbase(config);
14
- const appId = "buwai2zpe"; // Same app ID as before
15
-
16
- // Original app data (to restore later if needed)
17
- const originalApp = await client.getApp({ appId });
18
- console.log("Original app data:", originalApp);
19
-
20
- // Update request
21
- const updateRequest = {
22
- name: "qb-copy-updated",
23
- description: "Updated via integration test",
24
- variables: [{ name: "TestVar", value: "TestValue" }],
25
- };
26
-
27
- console.log("Config used:", config);
28
- console.log("Update request:", updateRequest);
29
- const result = await client.updateApp({ appId, body: updateRequest });
30
- console.log("Real API response:", result);
31
-
32
- // Validate the response
33
- expect(result).toHaveProperty("id", appId);
34
- expect(result).toHaveProperty("name", "qb-copy-updated");
35
- expect(result).toHaveProperty(
36
- "description",
37
- "Updated via integration test"
38
- );
39
- expect(result).toHaveProperty("variables");
40
- expect(result.variables).toContainEqual({
41
- name: "TestVar",
42
- value: "TestValue",
43
- });
44
- expect(result).toHaveProperty("created");
45
- expect(result.created).toBeInstanceOf(Date);
46
- expect(result).toHaveProperty("updated");
47
- expect(result.updated).toBeInstanceOf(Date);
48
-
49
- // Optional: Restore original name to avoid permanent changes
50
- const restoreRequest = {
51
- name: originalApp.name,
52
- description: originalApp.description,
53
- variables: originalApp.variables,
54
- };
55
- await client.updateApp({ appId, body: restoreRequest });
56
- console.log("Restored app to:", originalApp.name);
57
- }
58
- );
@@ -1,56 +0,0 @@
1
- import { describe, it, vi, expect, beforeEach } from "vitest";
2
- import { quickbase, QuickbaseClient } from "../../../../src/quickbaseClient";
3
- import { ResponseError } from "../../../../src/generated/runtime";
4
-
5
- describe("QuickbaseClient Integration - User Token Retry on 401", () => {
6
- let client: QuickbaseClient;
7
- const mockFetch = vi.fn();
8
-
9
- beforeEach(() => {
10
- const config = {
11
- realm: process.env.QB_REALM || "builderprogram-dbradford6815",
12
- userToken: "mock-user-token",
13
- debug: true,
14
- fetchApi: mockFetch,
15
- };
16
- console.log("[quickbaseTest] Config:", config);
17
- client = quickbase(config);
18
- });
19
-
20
- it("retries on transient 401 with user token and succeeds", async () => {
21
- const consoleSpy = vi.spyOn(console, "log");
22
-
23
- mockFetch
24
- .mockImplementationOnce(() => {
25
- const response = new Response(null, {
26
- status: 401,
27
- statusText: "Unauthorized",
28
- });
29
- console.log("[mockFetch] Throwing 401 ResponseError");
30
- return Promise.reject(new ResponseError(response));
31
- })
32
- .mockResolvedValueOnce({
33
- ok: true,
34
- status: 200,
35
- json: async () => [{ id: 1, label: "Mock Field", fieldType: "text" }],
36
- });
37
-
38
- const fields = await client.getFields({ tableId: "mock-table-id" });
39
-
40
- expect(fields).toBeInstanceOf(Array);
41
- expect(fields.length).toBeGreaterThan(0);
42
- expect(fields[0]).toHaveProperty("id");
43
- expect(fields[0]).toHaveProperty("label");
44
-
45
- expect(consoleSpy).toHaveBeenCalledWith(
46
- "Authorization error for getFields (user token), retrying with same token:",
47
- "" // Matches empty ResponseError message from mock
48
- );
49
- expect(consoleSpy).toHaveBeenCalledWith(
50
- "Retrying getFields with user token"
51
- );
52
- expect(mockFetch).toHaveBeenCalledTimes(2);
53
-
54
- consoleSpy.mockRestore();
55
- });
56
- });
@@ -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
- });