quickbase-js 1.0.1-beta.0

package/tests/vitest/unit/fields/getFields.test.ts

@@ -0,0 +1,115 @@
+import { describe, it, expect } from "vitest";
+import { createClient, mockFetch } from "@/tests/setup.ts";
+
+describe("QuickbaseClient - getFields (Unit)", () => {
+  it("calls getFields successfully", async () => {
+    mockFetch.mockImplementation((url: string, options: any) => {
+      console.log("Mock fetch for getFields:", url, options);
+      return Promise.resolve({
+        ok: true,
+        status: 200,
+        json: () =>
+          Promise.resolve([
+            {
+              id: 1,
+              label: "Field1",
+              fieldType: "text",
+              noWrap: false,
+              bold: false,
+              required: false,
+              appearsByDefault: false,
+              findEnabled: false,
+              unique: false,
+              doesDataCopy: false,
+              fieldHelp: "field help",
+              audited: false,
+              properties: {
+                primaryKey: false,
+                foreignKey: false,
+                numLines: 1,
+                maxLength: 0,
+                appendOnly: false,
+                allowHTML: false,
+                allowMentions: false,
+                sortAsGiven: false,
+                carryChoices: true,
+                allowNewChoices: false,
+                formula: "",
+                defaultValue: "",
+              },
+              permissions: [
+                { permissionType: "View", role: "Viewer", roleId: 10 },
+                { permissionType: "None", role: "Participant", roleId: 11 },
+                { permissionType: "Modify", role: "Administrator", roleId: 12 },
+              ],
+            },
+          ]),
+      } as Response);
+    });
+
+    const client = createClient(mockFetch);
+    const result = await client.getFields({
+      tableId: "dummyTableId",
+      includeFieldPerms: true,
+    });
+    console.log("getFields response:", result);
+    expect(result).toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({
+          id: 1,
+          label: "Field1",
+          fieldType: "text",
+          noWrap: false,
+          bold: false,
+          required: false,
+          appearsByDefault: false,
+          findEnabled: false,
+          unique: false,
+          doesDataCopy: false,
+          fieldHelp: "field help",
+          audited: false,
+          properties: expect.objectContaining({
+            primaryKey: false,
+            foreignKey: false,
+            numLines: 1,
+            maxLength: 0,
+            appendOnly: false,
+            allowHTML: false,
+            allowMentions: false,
+            sortAsGiven: false,
+            carryChoices: true,
+            allowNewChoices: false,
+            formula: "",
+            defaultValue: "",
+          }),
+          permissions: expect.arrayContaining([
+            expect.objectContaining({
+              permissionType: "View",
+              role: "Viewer",
+              roleId: 10,
+            }),
+            expect.objectContaining({
+              permissionType: "None",
+              role: "Participant",
+              roleId: 11,
+            }),
+            expect.objectContaining({
+              permissionType: "Modify",
+              role: "Administrator",
+              roleId: 12,
+            }),
+          ]),
+        }),
+      ])
+    );
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/fields?tableId=dummyTableId&includeFieldPerms=true`,
+      expect.objectContaining({
+        headers: expect.objectContaining({
+          Authorization: `QB-USER-TOKEN ${process.env.QB_USER_TOKEN}`,
+          "QB-Realm-Hostname": `${process.env.QB_REALM}.quickbase.com`,
+        }),
+      })
+    );
+  });
+});

package/tests/vitest/unit/index.ts

@@ -0,0 +1,4 @@
+// tests/unit/index.ts
+export * from "./apps/getApp.test.ts";
+export * from "./fields/getFields.test.ts";
+export * from "./tables/getAppTables.test.ts";

package/tests/vitest/unit/tables/getAppTables.test.ts

@@ -0,0 +1,72 @@
+import { describe, it, expect } from "vitest";
+import { createClient, mockFetch } from "@/tests/setup.ts";
+
+describe("QuickbaseClient - getAppTables (Unit)", () => {
+  it("calls getAppTables successfully", async () => {
+    mockFetch.mockImplementation((url: string, options: any) => {
+      console.log("Mock fetch for getAppTables:", url, options);
+      return Promise.resolve({
+        ok: true,
+        status: 200,
+        json: () =>
+          Promise.resolve([
+            {
+              alias: "_DBID_ROOT",
+              created: "2025-02-13T18:22:33Z",
+              defaultSortFieldId: 2,
+              defaultSortOrder: "DESC",
+              description: "",
+              id: "buwai2zr4",
+              keyFieldId: 3,
+              name: "Root",
+              nextFieldId: 6,
+              nextRecordId: 1,
+              pluralRecordName: "Roots",
+              singleRecordName: "Root",
+              sizeLimit: "500 MB",
+              spaceRemaining: "500 MB",
+              spaceUsed: "0 KB",
+              updated: "2025-02-13T18:22:34Z",
+            },
+          ]),
+      } as Response);
+    });
+
+    const client = createClient(mockFetch);
+    const tablesAppId = process.env.QB_APP_ID;
+    if (!tablesAppId) throw new Error("QB_APP_ID is not defined in .env");
+    const result = await client.getAppTables({ appId: tablesAppId });
+    console.log("getAppTables response:", result);
+    expect(result).toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({
+          alias: "_DBID_ROOT",
+          created: new Date("2025-02-13T18:22:33Z"),
+          defaultSortFieldId: 2,
+          defaultSortOrder: "DESC",
+          description: "",
+          id: "buwai2zr4",
+          keyFieldId: 3,
+          name: "Root",
+          nextFieldId: 6,
+          nextRecordId: 1,
+          pluralRecordName: "Roots",
+          singleRecordName: "Root",
+          sizeLimit: "500 MB",
+          spaceRemaining: "500 MB",
+          spaceUsed: "0 KB",
+          updated: new Date("2025-02-13T18:22:34Z"),
+        }),
+      ])
+    );
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables?appId=${tablesAppId}`,
+      expect.objectContaining({
+        headers: expect.objectContaining({
+          Authorization: `QB-USER-TOKEN ${process.env.QB_USER_TOKEN}`,
+          "QB-Realm-Hostname": `${process.env.QB_REALM}.quickbase.com`,
+        }),
+      })
+    );
+  });
+});

package/text.txt

@@ -0,0 +1,104 @@
+What I’m Trying to Do
+My approach is to ensure AppsApi.ts is generated with getAppById so QuickbaseClient.ts can map it to client.getApp. Steps include:
+Fix fix-spec.ts:
+Add tags: ["Apps"] to /apps/* endpoints to group them into AppsApi.ts.
+
+Ensure all endpoints and models are correctly defined and typed.
+
+Debug regenerate-client.ts:
+Enhance logging to catch why AppsApi.ts isn’t generated.
+
+Test if getAppById appears in another file (e.g., DefaultApi.ts).
+
+Update QuickbaseClient.ts:
+Adjust imports to use the correct API class once generated.
+
+Test and Iterate:
+Run npm run fix-spec, npm run regenerate, and npm run test to verify AppsApi.ts exists and test.ts works.
+
+The latest fix-spec.ts with tags aims to force the generator to create AppsApi.ts, addressing the missing file issue.
+Relevant Project Files
+Here’s a list of files that would help understand and resolve this problem, along with their roles:
+src/code-generation/fix-spec.ts:
+Role: Modifies the original QuickBase spec (e.g., QuickBase_RESTful_*.json) to create quickbase-fixed.json with required endpoints (e.g., /apps/{appId}).
+
+Relevance: Defines the spec fed to the generator; errors here affect generation.
+
+src/code-generation/quickbase-fixed.json:
+Role: The processed OpenAPI spec used by regenerate-client.ts to generate code.
+
+Relevance: Confirms if /apps/{appId} is correctly structured with operationId: "getAppById".
+
+src/code-generation/regenerate-client.ts:
+Role: Runs OpenAPI Generator to produce src/generated/ files (APIs and models) and fixes .ts extensions with ts-morph.
+
+Relevance: Controls the generation process; logs reveal why AppsApi.ts is missing.
+
+src/generated/apis/AppsApi.ts (if exists):
+Role: Should contain getAppById method for /apps/{appId} GET.
+
+Relevance: Missing file is the core issue; its absence breaks QuickbaseClient.ts.
+
+src/generated/apis/DefaultApi.ts:
+Role: Default API class for untagged operations.
+
+Relevance: Might contain getAppById if tags are misconfigured.
+
+src/QuickbaseClient.ts:
+Role: Wraps generated API classes (e.g., AppsApi) in a Proxy for ergonomic calls (e.g., client.getApp).
+
+Relevance: Fails to import AppsApi.ts, causing the runtime error.
+
+src/test.ts:
+Role: Test script calling client.getApp({ appId }).
+
+Relevance: Final validation point; shows if the fix works.
+
+.env.development:
+Role: Stores QB_REALM, QB_USER_TOKEN, QB_APP_ID for API authentication.
+
+Relevance: Ensures the API call has valid credentials (not the current issue, but critical for success).
+
+src/specs/QuickBase_RESTful_API_2025-03-04T06_22_39.725Z.json (or similar):
+Role: Original QuickBase API spec before fix-spec.ts processing.
+
+Relevance: Shows how /apps/{appId} was originally defined, helping identify conflicts.
+
+package.json:
+Role: Defines scripts (fix-spec, regenerate, test) and dependencies (e.g., ts-node, openapi-generator-cli).
+
+Relevance: Confirms script commands and versions align with our process.
+
+
+
+
+What We Achieved
+Goal Met: You can now call client.getApp({ appId: "buwai2zpe" }) and get the app details { id: 'buwai2zpe', name: 'qb-copy' }.
+
+Fixes Applied:
+Added tags: ["Apps"] in fix-spec.ts to ensure AppsApi.ts is generated with getAppById.
+
+Updated QuickbaseClient.ts to:
+Use prototype methods via Object.getOwnPropertyNames.
+
+Bind methods to preserve context with .bind(api).
+
+Handle getAppById’s direct JSON return instead of a Response object.
+
+Result: The ergonomic API you wanted (client.getApp) works seamlessly with the generated AppsApi.ts.
+
+Why It Works Now
+fix-spec.ts:
+Correctly defined /apps/{appId} with operationId: "getAppById" and tags: ["Apps"], ensuring AppsApi.ts generation.
+
+regenerate-client.ts:
+Successfully ran OpenAPI Generator to produce AppsApi.ts with getAppById.
+
+QuickbaseClient.ts:
+buildMethodMap now captures getAppById and maps it to getApp.
+
+invokeMethod passes { appId: 'buwai2zpe' } as requestParameters and handles the JSON response directly.
+
+test.ts:
+Calls client.getApp and logs the result, proving the end-to-end flow.
+

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "lib": ["ES2015", "ESNext", "DOM"], // Explicitly include ES2015 for Record
+    "types": ["node", "playwright/test"],
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
+    "outDir": "dist",
+    "rootDir": ".",
+    "declaration": true,
+    "sourceMap": true,
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./*"]
+    }
+  },
+  "include": ["src/**/*", "tests/**/*"],
+  "exclude": ["node_modules", "dist", "src/generated-old"],
+  "ts-node": {
+    "esm": true,
+    "transpileOnly": true
+  }
+}

package/versionrc.json

@@ -0,0 +1,9 @@
+{
+  "types": [
+    { "type": "feat", "section": "Features" },
+    { "type": "fix", "section": "Bug Fixes" },
+    { "type": "docs", "section": "Documentation" },
+    { "type": "chore", "section": "Maintenance" }
+  ],
+  "prerelease": "beta"
+}

package/vitest.config.ts

@@ -0,0 +1,21 @@
+import { defineConfig } from "vitest/config";
+import path from "path";
+
+export default defineConfig({
+  test: {
+    environment: "jsdom",
+    include: ["tests/vitest/**/**/*.test.ts"],
+    setupFiles: ["tests/setup.ts"],
+    pool: "forks",
+    poolOptions: {
+      forks: {
+        singleFork: true, // Run tests sequentially
+      },
+    },
+  },
+  resolve: {
+    alias: {
+      "@": path.resolve(__dirname, "./"),
+    },
+  },
+});