quickbase-js 1.1.0-beta.1 → 1.1.0-beta.3

package/package.json

@@ -2,7 +2,7 @@
   "name": "quickbase-js",
   "main": "dist/quickbase.js",
   "types": "dist/quickbase.d.ts",
-  "version": "1.1.0-beta.1",
+  "version": "1.1.0-beta.3",
   "publishConfig": {
     "access": "public"
   },

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

@@ -308,9 +308,18 @@ export const definitions = {
       type: "object",
       properties: {
         value: {
-          type: ["string", "number", "boolean", "object", "array", "null"],
+          anyOf: [
+            { type: "string" },
+            { type: "number" },
+            { type: "boolean" },
+            { type: "object" },
+            { type: "array" },
+            { type: "null" },
+          ],
+          description: "The value of the field.",
         },
       },
+      required: ["value"],
       description: "The value object for a field ID key.",
     },
     description:
@@ -346,7 +355,20 @@ export const definitions = {
           type: "object",
           additionalProperties: {
             type: "object",
-            properties: { value: { type: "any" } },
+            properties: {
+              value: {
+                anyOf: [
+                  { type: "string" },
+                  { type: "number" },
+                  { type: "boolean" },
+                  { type: "object" },
+                  { type: "array" },
+                  { type: "null" },
+                ],
+                description: "The value of the field.",
+              },
+            },
+            required: ["value"],
           },
         },
         description: "Array of upserted records with field IDs and values.",
@@ -387,7 +409,20 @@ export const definitions = {
           type: "object",
           additionalProperties: {
             type: "object",
-            properties: { value: { type: "any" } },
+            properties: {
+              value: {
+                anyOf: [
+                  { type: "string" },
+                  { type: "number" },
+                  { type: "boolean" },
+                  { type: "object" },
+                  { type: "array" },
+                  { type: "null" },
+                ],
+                description: "The value of the field.",
+              },
+            },
+            required: ["value"],
           },
         },
         description: "Array of successfully upserted records (may be empty).",
@@ -540,4 +575,235 @@ export const definitions = {
       },
     },
   },
+  GetRelationships200Response: {
+    type: "object",
+    properties: {
+      metadata: {
+        type: "object",
+        properties: {
+          numRelationships: {
+            type: "integer",
+            description:
+              "The number of relationships in the current response object.",
+          },
+          skip: {
+            type: "integer",
+            description: "The number of relationships skipped.",
+          },
+          totalRelationships: {
+            type: "integer",
+            description: "The total number of relationships.",
+          },
+        },
+        required: ["numRelationships", "skip", "totalRelationships"],
+        description:
+          "Additional information about the results that may be helpful.",
+      },
+      relationships: {
+        type: "array",
+        items: { $ref: "#/definitions/Relationship" },
+        description: "The relationships in a table.",
+      },
+    },
+    required: ["metadata", "relationships"],
+    description: "Response containing relationships for a table.",
+  },
+  Relationship: {
+    type: "object",
+    properties: {
+      id: {
+        type: "integer",
+        description: "The relationship id (foreign key field id).",
+      },
+      parentTableId: {
+        type: "string",
+        description: "The parent table id of the relationship.",
+      },
+      childTableId: {
+        type: "string",
+        description: "The child table id of the relationship.",
+      },
+      foreignKeyField: {
+        $ref: "#/definitions/RelationshipField",
+        description: "The foreign key field information.",
+      },
+      isCrossApp: {
+        type: "boolean",
+        description: "Whether this is a cross-app relationship.",
+      },
+      lookupFields: {
+        type: "array",
+        items: { $ref: "#/definitions/RelationshipField" },
+        description: "The lookup fields array.",
+      },
+      summaryFields: {
+        type: "array",
+        items: { $ref: "#/definitions/RelationshipField" },
+        description: "The summary fields array.",
+      },
+    },
+    required: [
+      "id",
+      "parentTableId",
+      "childTableId",
+      "foreignKeyField",
+      "isCrossApp",
+    ],
+    description: "A relationship between tables.",
+  },
+  RelationshipField: {
+    type: "object",
+    properties: {
+      id: {
+        type: "integer",
+        description: "Field id.",
+      },
+      label: {
+        type: "string",
+        description: "Field label.",
+      },
+      type: {
+        type: "string",
+        description: "Field type.",
+      },
+    },
+    required: ["id", "label", "type"],
+    description:
+      "A field involved in a relationship (foreign key, lookup, or summary).",
+  },
+  CopyAppRequest: {
+    type: "object",
+    required: ["name"],
+    properties: {
+      name: {
+        type: "string",
+        description: "The name of the newly copied app.",
+      },
+      description: {
+        type: "string",
+        description: "The description of the newly copied app.",
+      },
+      properties: {
+        type: "object",
+        properties: {
+          keepData: {
+            type: "boolean",
+            description:
+              "Whether to copy the app's data along with the schema.",
+          },
+          excludeFiles: {
+            type: "boolean",
+            description:
+              "If keepData is true, whether to copy file attachments. Ignored if keepData is false.",
+          },
+          usersAndRoles: {
+            type: "boolean",
+            description:
+              "If true, users will be copied along with their assigned roles. If false, users and roles will be copied but roles will not be assigned.",
+          },
+          assignUserToken: {
+            type: "boolean",
+            description:
+              "Whether to add the user token used to make this request to the new app.",
+          },
+        },
+        description:
+          "The configuration properties for performing the app copy.",
+      },
+    },
+    description: "Request body for copying an existing application.",
+  },
+  CopyApp200Response: {
+    type: "object",
+    required: ["id", "name"],
+    properties: {
+      id: {
+        type: "string",
+        description: "The unique identifier for the copied application.",
+      },
+      name: {
+        type: "string",
+        description:
+          "The app name. Multiple apps with the same name are allowed in the same realm.",
+      },
+      description: {
+        type: "string",
+        description: "The description for the app.",
+      },
+      created: {
+        type: "string",
+        format: "date-time",
+        description: "The time and date the app was created (ISO 8601, UTC).",
+      },
+      updated: {
+        type: "string",
+        format: "date-time",
+        description:
+          "The time and date the app was last updated (ISO 8601, UTC).",
+      },
+      dateFormat: {
+        type: "string",
+        description:
+          "The format used for displaying dates in the app (e.g., MM-DD-YYYY).",
+      },
+      timeZone: {
+        type: "string",
+        description:
+          "The time zone used for displaying time values (e.g., (UTC-08:00) Pacific Time).",
+      },
+      hasEveryoneOnTheInternet: {
+        type: "boolean",
+        description:
+          "Indicates if the app includes Everyone On The Internet access.",
+      },
+      variables: {
+        type: "array",
+        items: {
+          type: "object",
+          properties: {
+            name: { type: "string" },
+            value: { type: "string" },
+          },
+          required: ["name", "value"],
+        },
+        description: "The app variables.",
+      },
+      ancestorId: {
+        type: "string",
+        description: "The id of the app from which this app was copied.",
+      },
+      dataClassification: {
+        type: "string",
+        description:
+          "The Data Classification label assigned to the app (optional, may be 'None').",
+      },
+    },
+    description: "Response body for successful app copy operation.",
+  },
+  DeleteAppRequest: {
+    // New definition for deleteApp request
+    type: "object",
+    required: ["name"],
+    properties: {
+      name: {
+        type: "string",
+        description:
+          "The name of the application to delete, required for confirmation.",
+      },
+    },
+    description:
+      "Request body for deleting an application, requiring the app name for confirmation.",
+  },
+  DeleteApp200Response: {
+    // New definition for deleteApp response
+    type: "object",
+    properties: {
+      deletedAppId: {
+        type: "string",
+        description: "The ID of the deleted application.",
+      },
+    },
+    required: ["deletedAppId"],
+    description: "Response body for successful deletion of an application.",
+  },
 };

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

@@ -42,6 +42,61 @@ export const paths = {
         },
       },
     },
+    delete: {
+      // New DELETE method for deleteApp
+      operationId: "deleteApp",
+      summary: "Delete an application by ID",
+      tags: ["Apps"],
+      parameters: [
+        {
+          name: "appId",
+          in: "path",
+          required: true,
+          type: "string",
+          description: "The unique identifier of the app to delete.",
+        },
+        {
+          name: "body",
+          in: "body",
+          required: true,
+          schema: { $ref: "#/definitions/DeleteAppRequest" },
+        },
+      ],
+      responses: {
+        200: {
+          description: "Success - application deleted",
+          schema: { $ref: "#/definitions/DeleteApp200Response" },
+        },
+      },
+    },
+  },
+  "/apps/{appId}/copy": {
+    post: {
+      operationId: "copyApp",
+      summary: "Copy an existing application",
+      tags: ["Apps"],
+      parameters: [
+        {
+          name: "appId",
+          in: "path",
+          required: true,
+          type: "string",
+          description: "The unique identifier of the app to copy.",
+        },
+        {
+          name: "body",
+          in: "body",
+          required: true,
+          schema: { $ref: "#/definitions/CopyAppRequest" },
+        },
+      ],
+      responses: {
+        200: {
+          description: "Success - application copied",
+          schema: { $ref: "#/definitions/CopyApp200Response" },
+        },
+      },
+    },
   },
   "/fields": {
     get: {
@@ -234,6 +289,35 @@ export const paths = {
       },
     },
   },
+  "/tables/{tableId}/relationships": {
+    get: {
+      operationId: "getRelationships",
+      summary: "Get relationships for a table",
+      tags: ["Relationships"],
+      parameters: [
+        {
+          name: "tableId",
+          in: "path",
+          required: true,
+          type: "string",
+          description: "The unique identifier (dbid) of the child table.",
+        },
+        {
+          name: "skip",
+          in: "query",
+          required: false,
+          type: "integer",
+          description: "The number of relationships to skip.",
+        },
+      ],
+      responses: {
+        200: {
+          description: "Success - relationships retrieved",
+          schema: { $ref: "#/definitions/GetRelationships200Response" },
+        },
+      },
+    },
+  },
   "/records": {
     post: {
       operationId: "upsert",