quickbase-js 1.0.1-beta.0 → 1.1.0-beta.1

package/src/code-generation/fix-spec-paths.ts

@@ -1,5 +1,26 @@
 // src/code-generation/fix-spec-paths.ts
 export const paths = {
+  "/apps": {
+    post: {
+      operationId: "createApp",
+      summary: "Create a new application",
+      tags: ["Apps"],
+      parameters: [
+        {
+          name: "body",
+          in: "body",
+          required: true,
+          schema: { $ref: "#/definitions/CreateAppRequest" },
+        },
+      ],
+      responses: {
+        200: {
+          description: "Success - application created",
+          schema: { $ref: "#/definitions/CreateApp200Response" },
+        },
+      },
+    },
+  },
   "/apps/{appId}": {
     get: {
       operationId: "getApp",
@@ -11,6 +32,7 @@ export const paths = {
           in: "path",
           required: true,
           type: "string",
+          description: "The application identifier.",
         },
       ],
       responses: {
@@ -32,12 +54,14 @@ export const paths = {
           in: "query",
           required: true,
           type: "string",
+          description: "The table identifier (dbid).",
         },
         {
           name: "includeFieldPerms",
           in: "query",
           required: false,
           type: "boolean",
+          description: "Whether to include field permissions.",
         },
       ],
       responses: {
@@ -62,6 +86,7 @@ export const paths = {
           in: "query",
           required: true,
           type: "string",
+          description: "The application identifier.",
         },
       ],
       responses: {
@@ -74,37 +99,202 @@ export const paths = {
         },
       },
     },
-  },
-  "/records/query": {
     post: {
-      operationId: "upsertRecords",
-      summary: "Upsert records",
-      tags: ["Records"],
+      operationId: "createTable",
+      summary: "Create a new table in an app",
+      tags: ["Tables"],
       parameters: [
         {
-          name: "generated",
+          name: "appId",
+          in: "query",
+          required: true,
+          type: "string",
+          description:
+            "The unique identifier of the app where the table will be created.",
+        },
+        {
+          name: "body",
           in: "body",
           required: true,
           schema: {
-            type: "array",
-            items: { $ref: "#/definitions/Record" },
+            type: "object",
+            properties: {
+              name: { type: "string", description: "The name of the table." },
+              description: {
+                type: "string",
+                description: "The description of the table.",
+              },
+              singleRecordName: {
+                type: "string",
+                description: "Singular noun for records.",
+              },
+              pluralRecordName: {
+                type: "string",
+                description: "Plural noun for records.",
+              },
+            },
+            required: ["name"],
           },
         },
       ],
       responses: {
         200: {
-          description: "Success",
-          schema: {
-            type: "array",
-            items: { $ref: "#/definitions/Upsert200Response" },
-          },
+          description: "Success - table created",
+          schema: { $ref: "#/definitions/Table" },
+        },
+      },
+    },
+  },
+  "/tables/{tableId}": {
+    get: {
+      operationId: "getTable",
+      summary: "Get a table by ID",
+      tags: ["Tables"],
+      parameters: [
+        {
+          name: "tableId",
+          in: "path",
+          required: true,
+          type: "string",
+          description: "The table identifier (dbid).",
+        },
+        {
+          name: "appId",
+          in: "query",
+          required: true,
+          type: "string",
+          description: "The unique identifier of the app containing the table.",
+        },
+      ],
+      responses: {
+        200: {
+          description: "Success - table retrieved",
+          schema: { $ref: "#/definitions/Table" },
+        },
+      },
+    },
+    post: {
+      operationId: "updateTable",
+      summary: "Update a table by ID",
+      tags: ["Tables"],
+      parameters: [
+        {
+          name: "tableId",
+          in: "path",
+          required: true,
+          type: "string",
+          description: "The table identifier (dbid).",
+        },
+        {
+          name: "appId",
+          in: "query",
+          required: true,
+          type: "string",
+          description: "The unique identifier of the app containing the table.",
+        },
+        {
+          name: "body",
+          in: "body",
+          required: true,
+          schema: { $ref: "#/definitions/UpdateTableRequest" },
+        },
+      ],
+      responses: {
+        200: {
+          description: "Success - table updated",
+          schema: { $ref: "#/definitions/Table" },
+        },
+      },
+    },
+    delete: {
+      operationId: "deleteTable",
+      summary: "Delete a table by ID",
+      tags: ["Tables"],
+      parameters: [
+        {
+          name: "tableId",
+          in: "path",
+          required: true,
+          type: "string",
+          description: "The table identifier (dbid).",
+        },
+        {
+          name: "appId",
+          in: "query",
+          required: true,
+          type: "string",
+          description: "The unique identifier of the app containing the table.",
+        },
+      ],
+      responses: {
+        200: {
+          description: "Success - table deleted",
+          schema: { $ref: "#/definitions/DeleteTableResponse" },
+        },
+      },
+    },
+  },
+  "/records": {
+    post: {
+      operationId: "upsert",
+      summary: "Upsert records in a table",
+      tags: ["Records"],
+      parameters: [
+        {
+          name: "body",
+          in: "body",
+          required: true,
+          schema: { $ref: "#/definitions/UpsertRequest" },
+        },
+      ],
+      responses: {
+        200: {
+          description: "Success - all records processed successfully",
+          schema: { $ref: "#/definitions/Upsert200Response" },
         },
         207: {
-          description: "Multi-Status (partial success)",
-          schema: {
-            type: "array",
-            items: { $ref: "#/definitions/Upsert207Response" }, // Corrected from Upsert200Response
-          },
+          description: "Multi-Status - partial success with some errors",
+          schema: { $ref: "#/definitions/Upsert207Response" },
+        },
+      },
+    },
+    delete: {
+      operationId: "deleteRecords",
+      summary: "Delete records in a table",
+      tags: ["Records"],
+      parameters: [
+        {
+          name: "body",
+          in: "body",
+          required: true,
+          schema: { $ref: "#/definitions/DeleteRecordsRequest" },
+        },
+      ],
+      responses: {
+        200: {
+          description: "Success - records deleted",
+          schema: { $ref: "#/definitions/DeleteRecords200Response" },
+        },
+      },
+    },
+  },
+  "/records/query": {
+    post: {
+      operationId: "runQuery",
+      summary: "Query records in a table",
+      tags: ["Records"],
+      parameters: [
+        {
+          name: "body",
+          in: "body",
+          required: true,
+          schema: { $ref: "#/definitions/RunQueryRequest" },
+        },
+      ],
+      responses: {
+        200: {
+          description: "Success - records returned",
+          schema: { $ref: "#/definitions/RunQueryResponse" },
         },
       },
     },
@@ -120,6 +310,7 @@ export const paths = {
           in: "path",
           required: true,
           type: "string",
+          description: "The report identifier.",
         },
         {
           name: "generated",
@@ -150,6 +341,7 @@ export const paths = {
           in: "path",
           required: true,
           type: "string",
+          description: "The database identifier (dbid).",
         },
       ],
       responses: {

package/src/code-generation/generate-unified-interface.ts

@@ -48,20 +48,15 @@ function generateInterface() {
         })
         .map((p) => {
           const param = p as OpenAPIV2.ParameterObject;
-          let type = param.type
+          const type = param.type
             ? mapOpenApiTypeToTs(param.type)
             : param.schema
             ? mapRefToType(param.schema, modelImports)
             : "any";
-          // Special handling for upsertRecords 'generated' parameter
-          if (opId === "upsertRecords" && param.name === "generated") {
-            type = "{ [key: string]: string }[]";
-          }
           return `${param.name}${param.required ? "" : "?"}: ${type}`;
         })
         .join("; ");
 
-      // Handle responses, ensuring distinct types for 200 and 207
       const successResponses = ["200", "207"]
         .map((code) => ({
           code,
@@ -73,7 +68,6 @@ function generateInterface() {
       const returnTypes = successResponses.map(({ response }) =>
         mapRefToType(response!.schema, modelImports)
       );
-      // Deduplicate return types and join with " | ", default to "void" if empty
       const uniqueReturnTypes = [...new Set(returnTypes)];
       const returnType =
         uniqueReturnTypes.length > 0 ? uniqueReturnTypes.join(" | ") : "void";
@@ -84,7 +78,6 @@ function generateInterface() {
     }
   }
 
-  // Generate import statements for all model types
   const importStatement =
     modelImports.size > 0
       ? `import { ${Array.from(modelImports)