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,55 +0,0 @@
1
- import { test, expect } from "vitest";
2
- import { quickbase } from "../../../../src/quickbaseClient";
3
-
4
- test(
5
- "QuickbaseClient Integration - createTable > creates a new table 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";
15
-
16
- const tableName = `TestTable_${Date.now()}`;
17
- const createBody = {
18
- name: tableName,
19
- description: "Test table creation",
20
- singleRecordName: "TestRecord",
21
- pluralRecordName: "TestRecords",
22
- };
23
-
24
- console.log("Config used:", config);
25
- console.log("Creating table with:", createBody);
26
- const response = await client.createTable({ appId, body: createBody });
27
-
28
- expect(response).toBeDefined();
29
- expect(response.id).toBeDefined();
30
- expect(response.name).toBe(tableName);
31
- expect(response.description).toBe(createBody.description);
32
- expect(response.singleRecordName).toBe(createBody.singleRecordName);
33
- expect(response.pluralRecordName).toBe(createBody.pluralRecordName);
34
- expect(response.alias).toMatch(/^_DBID_/);
35
- expect(response.created).toBeInstanceOf(Date);
36
- expect(response.updated).toBeInstanceOf(Date);
37
- expect(response.nextRecordId).toBeGreaterThanOrEqual(1);
38
- expect(response.nextFieldId).toBeGreaterThanOrEqual(1);
39
- expect(response.defaultSortFieldId).toBeGreaterThanOrEqual(0);
40
- expect(response.keyFieldId).toBeGreaterThanOrEqual(1);
41
- expect(response.sizeLimit).toMatch(/^\d+\sMB$/); // e.g., "500 MB"
42
- expect(response.spaceUsed).toMatch(/^\d+\s(KB|MB)$/); // e.g., "0 KB"
43
- expect(response.spaceRemaining).toMatch(/^\d+\sMB$/); // e.g., "500 MB"
44
-
45
- console.log("Real API response:", response);
46
-
47
- // Cleanup: Delete the table to avoid clutter
48
- const deleteResponse = await client.deleteTable({
49
- tableId: response.id,
50
- appId,
51
- });
52
- expect(deleteResponse.deletedTableId).toBe(response.id);
53
- console.log("Cleanup - Deleted table:", deleteResponse);
54
- }
55
- );
@@ -1,143 +0,0 @@
1
- // tests/vitest/qb/tables/deleteRelationship.test.ts
2
-
3
- import { test, expect } from "vitest";
4
- import { quickbase } from "/home/drew/Projects/quickbase-js/src/quickbaseClient";
5
- import {
6
- QB_REALM,
7
- QB_USER_TOKEN,
8
- QB_TABLE_ID_1,
9
- QB_TABLE_ID_2,
10
- } from "/home/drew/Projects/quickbase-js/tests/setup.ts";
11
-
12
- test(
13
- "QuickbaseClient Integration - deleteRelationship > creates and deletes a relationship in QuickBase",
14
- { timeout: 60000 }, // 60 seconds for two API calls
15
- async () => {
16
- // Validate environment variables
17
- if (!QB_REALM) throw new Error("QB_REALM is not defined in .env");
18
- if (!QB_USER_TOKEN) throw new Error("QB_USER_TOKEN is not defined in .env");
19
- if (!QB_TABLE_ID_1) throw new Error("QB_TABLE_ID_1 is not defined in .env");
20
- if (!QB_TABLE_ID_2) throw new Error("QB_TABLE_ID_2 is not defined in .env");
21
-
22
- // Initialize client
23
- const client = quickbase({
24
- realm: QB_REALM,
25
- userToken: QB_USER_TOKEN,
26
- debug: true,
27
- });
28
-
29
- // Step 1: Create a relationship
30
- const uniqueLabel = `TestRelationship_${Date.now()}`;
31
- const createRequestBody = {
32
- parentTableId: QB_TABLE_ID_1,
33
- foreignKeyField: { label: uniqueLabel },
34
- lookupFieldIds: [6], // Assuming field 6 exists in QB_TABLE_ID_1
35
- summaryFields: [
36
- {
37
- summaryFid: 6, // Assuming field 6 in QB_TABLE_ID_2 is numeric
38
- label: `Sum_${uniqueLabel}`,
39
- accumulationType: "SUM",
40
- },
41
- ],
42
- };
43
-
44
- console.log("Config used:", {
45
- realm: QB_REALM,
46
- userToken: "[REDACTED]",
47
- parentTableId: QB_TABLE_ID_1,
48
- childTableId: QB_TABLE_ID_2,
49
- });
50
- console.log("Creating relationship with:", createRequestBody);
51
-
52
- const createResponse = await client.createRelationship({
53
- tableId: QB_TABLE_ID_2,
54
- body: createRequestBody,
55
- });
56
-
57
- console.log(
58
- "Created relationship response:",
59
- JSON.stringify(createResponse, null, 2)
60
- );
61
-
62
- // Verify creation
63
- expect(createResponse).toBeDefined();
64
- expect(createResponse.id).toBeDefined();
65
- expect(createResponse.parentTableId).toBe(QB_TABLE_ID_1);
66
- expect(createResponse.childTableId).toBe(QB_TABLE_ID_2);
67
- expect(createResponse.foreignKeyField).toBeDefined();
68
- expect(createResponse.foreignKeyField?.label).toBe(uniqueLabel);
69
-
70
- const relationshipId = createResponse.id;
71
- const foreignKeyFieldId = createResponse.foreignKeyField?.id;
72
-
73
- // Step 2: Delete the relationship
74
- console.log("Deleting relationship with ID:", relationshipId);
75
- const deleteResponse = await client.deleteRelationship({
76
- tableId: QB_TABLE_ID_2,
77
- relationshipId,
78
- });
79
-
80
- console.log(
81
- "Delete relationship response:",
82
- JSON.stringify(deleteResponse, null, 2)
83
- );
84
-
85
- // Verify deletion (adjusted to match actual response)
86
- expect(deleteResponse).toBeDefined();
87
- expect(deleteResponse.relationshipId).toBe(relationshipId); // Updated to use "relationshipId"
88
-
89
- // Step 3: Confirm relationship is gone (or non-functional)
90
- try {
91
- const relationships = await client.getRelationships({
92
- tableId: QB_TABLE_ID_2,
93
- });
94
- console.log(
95
- "Relationships after deletion:",
96
- JSON.stringify(relationships, null, 2)
97
- );
98
- // Check if the relationship is still listed (metadata might persist)
99
- const deletedRelationship = relationships.relationships.find(
100
- (r) => r.id === relationshipId
101
- );
102
- if (deletedRelationship) {
103
- console.log("Relationship metadata persists:", deletedRelationship);
104
- expect(deletedRelationship.foreignKeyField).toBeUndefined(); // Should lack fields
105
- }
106
- } catch (error) {
107
- console.error("Error fetching relationships post-deletion:", error);
108
- expect(error.message).toMatch(/404|not found/i); // Optional stricter check
109
- }
110
-
111
- // Cleanup remaining fields
112
- const lookupFieldId = createResponse.lookupFields[0]?.id;
113
- const summaryFieldId = createResponse.summaryFields[0]?.id;
114
-
115
- if (foreignKeyFieldId) {
116
- await client.deleteFields({
117
- tableId: QB_TABLE_ID_2,
118
- body: { fieldIds: [foreignKeyFieldId] },
119
- });
120
- console.log(
121
- `Deleted foreign key field ${foreignKeyFieldId} from ${QB_TABLE_ID_2}`
122
- );
123
- }
124
- if (lookupFieldId) {
125
- await client.deleteFields({
126
- tableId: QB_TABLE_ID_2,
127
- body: { fieldIds: [lookupFieldId] },
128
- });
129
- console.log(
130
- `Deleted lookup field ${lookupFieldId} from ${QB_TABLE_ID_2}`
131
- );
132
- }
133
- if (summaryFieldId) {
134
- await client.deleteFields({
135
- tableId: QB_TABLE_ID_1,
136
- body: { fieldIds: [summaryFieldId] },
137
- });
138
- console.log(
139
- `Deleted summary field ${summaryFieldId} from ${QB_TABLE_ID_1}`
140
- );
141
- }
142
- }
143
- );
@@ -1,50 +0,0 @@
1
- import { test, expect } from "vitest";
2
- import { quickbase } from "../../../../src/quickbaseClient";
3
-
4
- test(
5
- "QuickbaseClient Integration - deleteTable > deletes a table in QuickBase",
6
- { timeout: 20000 },
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";
15
-
16
- // Step 1: Create a temporary table to delete
17
- const tableName = `DeleteTest_${Date.now()}`;
18
- const createBody = {
19
- name: tableName,
20
- description: "Temporary table for delete test",
21
- singleRecordName: "DeleteTest",
22
- pluralRecordName: "DeleteTests",
23
- };
24
- console.log("Creating temporary table with:", createBody);
25
- const createResponse = await client.createTable({
26
- appId,
27
- body: createBody,
28
- });
29
- expect(createResponse.id).toBeDefined();
30
- expect(createResponse.name).toBe(tableName);
31
- console.log("Created table:", createResponse);
32
- const tableId = createResponse.id;
33
-
34
- // Step 2: Delete the table
35
- console.log("Deleting table:", { tableId, appId });
36
- const deleteResponse = await client.deleteTable({ tableId, appId });
37
- expect(deleteResponse).toBeDefined();
38
- expect(deleteResponse.deletedTableId).toBe(tableId);
39
- console.log("Delete API response:", deleteResponse);
40
-
41
- // Step 3: Verify the table is gone
42
- try {
43
- await client.getTable({ tableId, appId });
44
- throw new Error("Table should not exist after deletion");
45
- } catch (error) {
46
- expect(error.message).toMatch(/404|not found/i); // Expect a 404 error
47
- console.log("Verified table deletion:", error.message);
48
- }
49
- }
50
- );
@@ -1,46 +0,0 @@
1
- import { test, expect } from "vitest";
2
- import { quickbase } from "../../../../src/quickbaseClient";
3
-
4
- test(
5
- "QuickbaseClient Integration - getAppTables > fetches real table data 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 tablesAppId = "buwai2zpe";
15
-
16
- console.log("Config used:", config);
17
- const result = await client.getAppTables({ appId: tablesAppId });
18
- console.log("Real API response:", result);
19
-
20
- expect(result).toBeDefined();
21
- expect(result).toBeInstanceOf(Array);
22
- expect(result.length).toBeGreaterThan(0);
23
- expect(result).toEqual(
24
- expect.arrayContaining([
25
- expect.objectContaining({
26
- id: "buwai2zr4",
27
- alias: "_DBID_ROOT",
28
- name: expect.any(String), // Allow dynamic name due to updateTable
29
- description: expect.any(String), // Allow dynamic description
30
- created: expect.any(Date),
31
- updated: expect.any(Date), // Allow varying timestamps
32
- nextRecordId: expect.any(Number),
33
- nextFieldId: expect.any(Number),
34
- defaultSortFieldId: expect.any(Number),
35
- defaultSortOrder: "DESC",
36
- keyFieldId: expect.any(Number),
37
- singleRecordName: "Root",
38
- pluralRecordName: "Roots",
39
- sizeLimit: "500 MB",
40
- spaceUsed: expect.any(String),
41
- spaceRemaining: "500 MB",
42
- }),
43
- ])
44
- );
45
- }
46
- );
@@ -1,80 +0,0 @@
1
- // tests/vitest/qb/tables/getRelationships.test.ts
2
- import { describe, test, expect } from "vitest";
3
- import { quickbase } from "/home/drew/Projects/quickbase-js/src/quickbaseClient.ts";
4
- import { QB_TABLE_ID_1 } from "/home/drew/Projects/quickbase-js/tests/setup.ts";
5
- import { GetRelationships200Response } from "/home/drew/Projects/quickbase-js/src/generated/models";
6
-
7
- describe("QuickbaseClient Integration - getRelationships", () => {
8
- const qb = quickbase({
9
- realm: process.env.QB_REALM || "builderprogram-dbradford6815",
10
- userToken: process.env.QB_USER_TOKEN || "",
11
- debug: true,
12
- });
13
-
14
- test("fetches real relationships from QuickBase", async () => {
15
- // Ensure environment variables are set
16
- if (!process.env.QB_REALM)
17
- throw new Error("QB_REALM is not defined in .env");
18
- if (!process.env.QB_USER_TOKEN)
19
- throw new Error("QB_USER_TOKEN is not defined in .env");
20
-
21
- console.log("Config used:", {
22
- realm: process.env.QB_REALM,
23
- userToken: process.env.QB_USER_TOKEN,
24
- tableId: QB_TABLE_ID_1,
25
- });
26
-
27
- const response: GetRelationships200Response = await qb.getRelationships({
28
- tableId: QB_TABLE_ID_1, // Query relationships for QB_TABLE_ID_1 (e.g., "buwai2zws")
29
- skip: 0,
30
- });
31
-
32
- console.log("Real API response:", JSON.stringify(response, null, 2));
33
-
34
- // Basic structure validation
35
- expect(response).toBeDefined();
36
- expect(response.metadata).toBeDefined();
37
- expect(response.metadata).toHaveProperty(
38
- "numRelationships",
39
- expect.any(Number)
40
- );
41
- expect(response.metadata).toHaveProperty("skip", 0);
42
- expect(response.metadata).toHaveProperty(
43
- "totalRelationships",
44
- expect.any(Number)
45
- );
46
- expect(response.relationships).toBeDefined();
47
- expect(Array.isArray(response.relationships)).toBe(true);
48
-
49
- // If relationships exist, validate the first one
50
- if (response.relationships.length > 0) {
51
- const relationship = response.relationships[0];
52
- expect(relationship).toHaveProperty("id", expect.any(Number));
53
- expect(relationship).toHaveProperty("parentTableId", expect.any(String));
54
- expect(relationship).toHaveProperty("childTableId", QB_TABLE_ID_1);
55
- expect(relationship).toHaveProperty("foreignKeyField");
56
- expect(relationship.foreignKeyField).toHaveProperty(
57
- "id",
58
- expect.any(Number)
59
- );
60
- expect(relationship.foreignKeyField).toHaveProperty(
61
- "label",
62
- expect.any(String)
63
- );
64
- expect(relationship.foreignKeyField).toHaveProperty(
65
- "type",
66
- expect.any(String)
67
- );
68
- expect(relationship).toHaveProperty("isCrossApp", expect.any(Boolean));
69
- expect(relationship).toHaveProperty("lookupFields", expect.any(Array));
70
-
71
- // summaryFields is optional; only validate if present
72
- if (
73
- "summaryFields" in relationship &&
74
- relationship.summaryFields !== undefined
75
- ) {
76
- expect(Array.isArray(relationship.summaryFields)).toBe(true);
77
- }
78
- }
79
- }, 10000); // Timeout as second argument
80
- });
@@ -1,26 +0,0 @@
1
- import { test, expect } from "vitest";
2
- import { quickbase } from "../../../../src/quickbaseClient";
3
-
4
- test(
5
- "QuickbaseClient Integration - getTable > fetches real table data 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 tableId = "buwai2zr4";
15
- const appId = "buwai2zpe";
16
-
17
- console.log("Config used:", config);
18
- const response = await client.getTable({ tableId, appId });
19
- expect(response).toBeDefined();
20
- expect(response.id).toBe(tableId);
21
- expect(response.name).toBe("Root"); // Expect original name
22
- expect(response.alias).toBe("_DBID_ROOT");
23
- expect(response.created).toBeInstanceOf(Date);
24
- console.log("Real API response:", response);
25
- }
26
- );
@@ -1,250 +0,0 @@
1
- // tests/vitest/qb/tables/updateRelationship.test.ts
2
-
3
- import { describe, it, expect } from "vitest";
4
- import {
5
- createClient,
6
- QB_REALM,
7
- QB_USER_TOKEN,
8
- QB_TABLE_ID_1,
9
- QB_TABLE_ID_2,
10
- } from "@tests/setup.ts";
11
- import {
12
- UpdateRelationshipRequest,
13
- CreateFieldRequest,
14
- } from "@/generated/models";
15
-
16
- describe("QuickbaseClient Integration - updateRelationship", () => {
17
- let client: ReturnType<typeof createClient>;
18
- let relationshipId: number;
19
- let newLookupFieldId: number | undefined;
20
- let newChildFieldId: number | undefined;
21
- let generatedLookupFieldId: number | undefined;
22
- let generatedSummaryFieldId: number | undefined;
23
-
24
- // No beforeAll/afterAll since we'll create and delete within the test
25
-
26
- it("creates, updates, deletes, and verifies a relationship", async () => {
27
- // Validate environment variables
28
- if (!QB_REALM) throw new Error("QB_REALM is not defined in .env");
29
- if (!QB_USER_TOKEN) throw new Error("QB_USER_TOKEN is not defined in .env");
30
- if (!QB_TABLE_ID_1) throw new Error("QB_TABLE_ID_1 is not defined in .env");
31
- if (!QB_TABLE_ID_2) throw new Error("QB_TABLE_ID_2 is not defined in .env");
32
-
33
- // Initialize client
34
- client = createClient(fetch, {
35
- realm: QB_REALM,
36
- userToken: QB_USER_TOKEN,
37
- debug: true,
38
- });
39
-
40
- // Step 1: Create fields for the relationship update
41
- const lookupFieldRequest: CreateFieldRequest = {
42
- label: `Test Lookup Field_${Date.now()}`,
43
- fieldType: "text",
44
- };
45
- const lookupResponse = await client.createField({
46
- tableId: QB_TABLE_ID_1,
47
- body: lookupFieldRequest,
48
- });
49
- newLookupFieldId = lookupResponse.id;
50
- if (!newLookupFieldId) {
51
- throw new Error("Failed to retrieve ID for newly created lookup field");
52
- }
53
- console.log(
54
- `Created lookup field with ID ${newLookupFieldId} in parent table ${QB_TABLE_ID_1}`
55
- );
56
-
57
- const childFieldRequest: CreateFieldRequest = {
58
- label: `Test Child Numeric_${Date.now()}`,
59
- fieldType: "numeric",
60
- };
61
- const childResponse = await client.createField({
62
- tableId: QB_TABLE_ID_2,
63
- body: childFieldRequest,
64
- });
65
- newChildFieldId = childResponse.id;
66
- if (!newChildFieldId) {
67
- throw new Error("Failed to retrieve ID for newly created child field");
68
- }
69
- console.log(
70
- `Created child field with ID ${newChildFieldId} in child table ${QB_TABLE_ID_2}`
71
- );
72
-
73
- // Step 2: Create a new relationship
74
- const uniqueLabel = `TestRelationship_${Date.now()}`;
75
- const createRequestBody = {
76
- parentTableId: QB_TABLE_ID_1,
77
- foreignKeyField: { label: uniqueLabel },
78
- lookupFieldIds: [6], // Assuming field 6 exists in QB_TABLE_ID_1
79
- summaryFields: [
80
- {
81
- summaryFid: 6, // Assuming field 6 in QB_TABLE_ID_2 is numeric
82
- label: `Sum_${uniqueLabel}`,
83
- accumulationType: "SUM",
84
- },
85
- ],
86
- };
87
-
88
- console.log("Creating relationship with:", createRequestBody);
89
- const createResponse = await client.createRelationship({
90
- tableId: QB_TABLE_ID_2,
91
- body: createRequestBody,
92
- });
93
- console.log(
94
- "Created relationship response:",
95
- JSON.stringify(createResponse, null, 2)
96
- );
97
-
98
- expect(createResponse).toBeDefined();
99
- expect(createResponse.id).toBeDefined();
100
- expect(createResponse.parentTableId).toBe(QB_TABLE_ID_1);
101
- expect(createResponse.childTableId).toBe(QB_TABLE_ID_2);
102
- expect(createResponse.foreignKeyField?.label).toBe(uniqueLabel);
103
-
104
- relationshipId = createResponse.id;
105
-
106
- // Step 3: Update the relationship - Add a lookup field
107
- const tableId = QB_TABLE_ID_2;
108
- const initialResponse = await client.getRelationships({ tableId });
109
- const initialRelationship = initialResponse.relationships.find(
110
- (r) => r.id === relationshipId
111
- );
112
- const currentLookupFields = (initialRelationship?.lookupFields || []).map(
113
- (f) => f.id
114
- );
115
- console.log("Current lookupFields before update:", currentLookupFields);
116
-
117
- const updateLookupRequest: UpdateRelationshipRequest = {
118
- lookupFieldIds: [newLookupFieldId!],
119
- };
120
- console.log(
121
- "Adding lookup field request:",
122
- JSON.stringify(updateLookupRequest, null, 2)
123
- );
124
-
125
- const updateLookupResponse = await client.updateRelationship({
126
- tableId,
127
- relationshipId,
128
- body: updateLookupRequest,
129
- });
130
- console.log(
131
- "Update lookup response:",
132
- JSON.stringify(updateLookupResponse, null, 2)
133
- );
134
-
135
- const newLookup = updateLookupResponse.lookupFields.find(
136
- (f) =>
137
- f.label.includes("Test Lookup Field") &&
138
- !currentLookupFields.includes(f.id)
139
- );
140
- generatedLookupFieldId = newLookup?.id;
141
- console.log(
142
- `Captured generated lookup field ID: ${generatedLookupFieldId}`
143
- );
144
-
145
- expect(updateLookupResponse.id).toBe(relationshipId);
146
- expect(updateLookupResponse.childTableId).toBe(QB_TABLE_ID_2);
147
- expect(updateLookupResponse.parentTableId).toBe(QB_TABLE_ID_1);
148
- expect(
149
- updateLookupResponse.lookupFields.some((f) =>
150
- f.label.includes("Test Lookup Field")
151
- )
152
- ).toBe(true);
153
-
154
- // Step 4: Update the relationship - Add a summary field
155
- const currentSummaryFields = (updateLookupResponse.summaryFields || []).map(
156
- (f) => f.id
157
- );
158
- console.log("Current summaryFields before update:", currentSummaryFields);
159
-
160
- const updateSummaryRequest: UpdateRelationshipRequest = {
161
- summaryFields: [
162
- {
163
- summaryFid: newChildFieldId!,
164
- label: "Test Summary Field",
165
- accumulationType: "SUM",
166
- },
167
- ],
168
- };
169
- console.log(
170
- "Adding summary field request:",
171
- JSON.stringify(updateSummaryRequest, null, 2)
172
- );
173
-
174
- const updateSummaryResponse = await client.updateRelationship({
175
- tableId,
176
- relationshipId,
177
- body: updateSummaryRequest,
178
- });
179
- console.log(
180
- "Update summary response:",
181
- JSON.stringify(updateSummaryResponse, null, 2)
182
- );
183
-
184
- const newSummary = updateSummaryResponse.summaryFields.find(
185
- (f) =>
186
- f.label.includes("Test Summary Field") &&
187
- !currentSummaryFields.includes(f.id)
188
- );
189
- generatedSummaryFieldId = newSummary?.id;
190
- console.log(
191
- `Captured generated summary field ID: ${generatedSummaryFieldId}`
192
- );
193
-
194
- expect(updateSummaryResponse.id).toBe(relationshipId);
195
- expect(updateSummaryResponse.childTableId).toBe(QB_TABLE_ID_2);
196
- expect(updateSummaryResponse.parentTableId).toBe(QB_TABLE_ID_1);
197
- expect(
198
- updateSummaryResponse.summaryFields.some((f) =>
199
- f.label.includes("Test Summary Field")
200
- )
201
- ).toBe(true);
202
-
203
- // Step 5: Delete the relationship
204
- console.log("Deleting relationship with ID:", relationshipId);
205
- const deleteResponse = await client.deleteRelationship({
206
- tableId: QB_TABLE_ID_2,
207
- relationshipId,
208
- });
209
- console.log(
210
- "Delete relationship response:",
211
- JSON.stringify(deleteResponse, null, 2)
212
- );
213
-
214
- expect(deleteResponse).toBeDefined();
215
- expect(deleteResponse.relationshipId).toBe(relationshipId);
216
-
217
- // Step 6: Verify deletion
218
- const relationships = await client.getRelationships({
219
- tableId: QB_TABLE_ID_2,
220
- });
221
- console.log(
222
- "Relationships after deletion:",
223
- JSON.stringify(relationships, null, 2)
224
- );
225
- const deletedRelationship = relationships.relationships.find(
226
- (r) => r.id === relationshipId
227
- );
228
- expect(deletedRelationship).toBeUndefined(); // Confirm relationship is gone
229
-
230
- // Cleanup remaining fields from setup
231
- if (newLookupFieldId) {
232
- await client.deleteFields({
233
- tableId: QB_TABLE_ID_1,
234
- body: { fieldIds: [newLookupFieldId] },
235
- });
236
- console.log(
237
- `Deleted lookup field ${newLookupFieldId} from ${QB_TABLE_ID_1}`
238
- );
239
- }
240
- if (newChildFieldId) {
241
- await client.deleteFields({
242
- tableId: QB_TABLE_ID_2,
243
- body: { fieldIds: [newChildFieldId] },
244
- });
245
- console.log(
246
- `Deleted child field ${newChildFieldId} from ${QB_TABLE_ID_2}`
247
- );
248
- }
249
- }, 60000);
250
- });