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

package/package.json

@@ -1,33 +1,37 @@
 {
   "name": "quickbase-js",
-  "main": "dist/quickbaseClient.js",
-  "types": "dist/quickbaseClient.d.ts",
-  "version": "1.0.1-beta.0",
+  "main": "dist/quickbase.js",
+  "types": "dist/quickbase.d.ts",
+  "version": "1.1.0-beta.1",
   "publishConfig": {
     "access": "public"
   },
   "description": "QuickBase JavaScript client for frameworks and vanilla JS",
-  "module": "dist/quickbaseClient.js",
+  "module": "dist/quickbase.js",
   "type": "module",
   "exports": {
     ".": {
-      "import": "./dist/quickbaseClient.js",
-      "types": "./dist/quickbaseClient.d.ts"
+      "import": "./dist/quickbase.js",
+      "types": "./dist/quickbase.d.ts"
     }
   },
   "scripts": {
     "release": "standard-version",
     "release:beta": "standard-version --prerelease beta",
     "release:alpha": "standard-version --prerelease alpha",
+    "release:push": "npm run release:beta && git push --follow-tags origin main",
+    "release:publish": "npm run release:push && npm publish --tag beta",
     "fix-spec": "node --loader ts-node/esm src/code-generation/fix-spec-main.ts",
-    "regenerate": "node --loader ts-node/esm src/code-generation/regenerate-client.ts",
-    "generate-unified": "node --loader ts-node/esm src/code-generation/generate-unified-interface.ts",
+    "regenerate": "rimraf src/generated && node --loader ts-node/esm src/code-generation/regenerate-client.ts",
+    "regenerate-unified": "node --loader ts-node/esm src/code-generation/generate-unified-interface.ts",
+    "regenerate-all": "npm run fix-spec && npm run regenerate && npm run regenerate-unified",
     "log-gen": "node --loader ts-node/esm src/log-gen.ts",
     "build": "rimraf dist && rollup -c",
     "build:prod": "rm -rf dist/* && NODE_ENV=production rollup -c",
-    "test": "vitest run tests/vitest/**/**/*.test.ts",
     "test:pw:qb:all": "playwright test tests/playwright/qb --config playwright.config.ts",
+    "test:vitest:all": "vitest run tests/vitest/**/**/*.test.ts",
     "test:vitest:qb": "vitest run tests/vitest/qb/**/*.test.ts",
+    "test:vitest:unit": "vitest run tests/vitest/unit/**/*.test.ts",
     "test:vitest:qb:apps": "vitest run tests/vitest/qb/apps/**/*.test.ts",
     "test:vitest:qb:auth": "vitest run tests/vitest/qb/auth/**/*.test.ts",
     "test:vitest:qb:fields": "vitest run tests/vitest/qb/fields/**/*.test.ts",

package/rollup.config.js

@@ -14,7 +14,7 @@ export default [
       format: "esm",
       sourcemap: true,
       compact: isProd,
-      entryFileNames: "quickbaseClient.js",
+      entryFileNames: "quickbase.js",
     },
     external: [
       "node:http",
@@ -42,7 +42,7 @@ export default [
   {
     input: "src/quickbaseClient.ts",
     output: {
-      file: "dist/quickbaseClient.d.ts",
+      file: "dist/quickbase.d.ts",
       format: "esm",
       // Optional: sourcemap for .d.ts if needed for debugging
       // sourcemap: true,

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

@@ -1,6 +1,8 @@
+// src/code-generation/fix-spec-definitions.ts
 export const definitions = {
   App: {
     type: "object",
+    required: ["id", "name"],
     properties: {
       id: { type: "string" },
       name: { type: "string" },
@@ -10,31 +12,137 @@ export const definitions = {
       timeZone: { type: "string" },
       dateFormat: { type: "string" },
       hasEveryoneOnTheInternet: { type: "boolean" },
+      memoryInfo: { $ref: "#/definitions/AppMemoryInfo" },
+      securityProperties: { $ref: "#/definitions/AppSecurityProperties" },
+    },
+  },
+  AppMemoryInfo: {
+    type: "object",
+    properties: {
+      estMemory: { type: "number" },
+      estMemoryInclDependentApps: { type: "number" },
+    },
+  },
+  AppSecurityProperties: {
+    type: "object",
+    properties: {
+      allowClone: { type: "boolean" },
+      allowExport: { type: "boolean" },
+      enableAppTokens: { type: "boolean" },
+      hideFromPublic: { type: "boolean" },
+      mustBeRealmApproved: { type: "boolean" },
+      useIPFilter: { type: "boolean" },
+    },
+  },
+  CreateAppRequest: {
+    type: "object",
+    required: ["name"],
+    properties: {
+      name: {
+        type: "string",
+        description:
+          "The app name. Multiple apps with the same name are allowed in the same realm.",
+      },
+      assignToken: {
+        type: "boolean",
+        description:
+          "Set to true to assign the app to the user token used to create it. Default is false.",
+      },
+      description: {
+        type: "string",
+        description:
+          "The description for the app. Defaults to blank if omitted.",
+      },
+      securityProperties: {
+        $ref: "#/definitions/AppSecurityProperties",
+        description: "Application security properties.",
+      },
+      variables: {
+        type: "array",
+        items: {
+          type: "object",
+          properties: {
+            name: { type: "string" },
+            value: { type: "string" },
+          },
+          required: ["name", "value"],
+        },
+        description:
+          "App variables (max 10, optional). See About Application Variables.",
+      },
+    },
+  },
+  CreateApp200Response: {
+    type: "object",
+    properties: {
+      id: {
+        type: "string",
+        description: "The unique identifier for this application.",
+      },
+      name: { type: "string", description: "The app name." },
+      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).",
+      },
       memoryInfo: {
-        type: "object",
-        properties: {
-          estMemory: { type: "number" },
-          estMemoryInclDependentApps: { type: "number" },
+        $ref: "#/definitions/AppMemoryInfo",
+        description: "Application memory information.",
+      },
+      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.",
+      },
+      dataClassification: {
+        type: "string",
+        description:
+          "The Data Classification label assigned to the app (optional, may be 'None').",
       },
       securityProperties: {
-        type: "object",
-        properties: {
-          allowClone: { type: "boolean" },
-          allowExport: { type: "boolean" },
-          enableAppTokens: { type: "boolean" },
-          hideFromPublic: { type: "boolean" },
-          mustBeRealmApproved: { type: "boolean" },
-          useIPFilter: { type: "boolean" },
-        },
+        $ref: "#/definitions/AppSecurityProperties",
+        description: "Security properties of the application.",
       },
     },
     required: ["id", "name"],
   },
   Field: {
     type: "object",
+    required: ["id", "label", "fieldType"],
     properties: {
-      id: { type: "number" },
+      id: { type: "integer" },
       label: { type: "string" },
       fieldType: { type: "string" },
       noWrap: { type: "boolean" },
@@ -46,91 +154,390 @@ export const definitions = {
       doesDataCopy: { type: "boolean" },
       fieldHelp: { type: "string" },
       audited: { type: "boolean" },
+      properties: { $ref: "#/definitions/FieldProperties" },
+      permissions: {
+        type: "array",
+        items: { $ref: "#/definitions/FieldPermissionsInner" },
+      },
+    },
+  },
+  FieldProperties: {
+    type: "object",
+    properties: {
+      primaryKey: { type: "boolean" },
+      foreignKey: { type: "boolean" },
+      numLines: { type: "integer" },
+      maxLength: { type: "integer" },
+      appendOnly: { type: "boolean" },
+      allowHTML: { type: "boolean" },
+      allowMentions: { type: "boolean" },
+      sortAsGiven: { type: "boolean" },
+      carryChoices: { type: "boolean" },
+      allowNewChoices: { type: "boolean" },
+      formula: { type: "string" },
+      defaultValue: { type: "string" },
+    },
+  },
+  FieldPermissionsInner: {
+    type: "object",
+    properties: {
+      permissionType: { type: "string" },
+      role: { type: "string" },
+      roleId: { type: "integer" },
+    },
+  },
+  Table: {
+    type: "object",
+    required: ["id", "name"],
+    properties: {
+      id: {
+        type: "string",
+        description: "The unique identifier (dbid) of the table.",
+      },
+      name: { type: "string", description: "The name of the table." },
+      alias: {
+        type: "string",
+        description: "The automatically-created table alias for the table.",
+      },
+      description: {
+        type: "string",
+        description:
+          "The description of the table, as configured by an application administrator.",
+      },
+      created: {
+        type: "string",
+        format: "date-time",
+        description:
+          "The time and date when the table was created, in ISO 8601 format (UTC).",
+      },
+      updated: {
+        type: "string",
+        format: "date-time",
+        description:
+          "The time and date when the table schema or data was last updated, in ISO 8601 format (UTC).",
+      },
+      nextRecordId: {
+        type: "integer",
+        description:
+          "The incremental Record ID that will be used when the next record is created.",
+      },
+      nextFieldId: {
+        type: "integer",
+        description:
+          "The incremental Field ID that will be used when the next field is created.",
+      },
+      defaultSortFieldId: {
+        type: "integer",
+        description:
+          "The id of the field that is configured for default sorting.",
+      },
+      defaultSortOrder: {
+        type: "string",
+        enum: ["ASC", "DESC"],
+        description:
+          "The default sort order for the table, either ascending (ASC) or descending (DESC).",
+      },
+      keyFieldId: {
+        type: "integer",
+        description:
+          "The id of the field that is configured to be the key on this table, usually the Quickbase Record ID.",
+      },
+      singleRecordName: {
+        type: "string",
+        description: "The builder-configured singular noun of the table.",
+      },
+      pluralRecordName: {
+        type: "string",
+        description: "The builder-configured plural noun of the table.",
+      },
+      sizeLimit: {
+        type: "string",
+        description: "The size limit for the table (e.g., '150 MB').",
+      },
+      spaceUsed: {
+        type: "string",
+        description:
+          "The amount of space currently being used by the table (e.g., '17 MB').",
+      },
+      spaceRemaining: {
+        type: "string",
+        description:
+          "The amount of space remaining for use by the table (e.g., '133 MB').",
+      },
+    },
+  },
+  UpdateTableRequest: {
+    type: "object",
+    properties: {
+      name: { type: "string", description: "The new name for the table." },
+      singleRecordName: {
+        type: "string",
+        description:
+          "The new singular noun for records in the table. Defaults to 'Record' if not provided.",
+      },
+      pluralRecordName: {
+        type: "string",
+        description:
+          "The new plural noun for records in the table. Defaults to 'Records' if not provided.",
+      },
+      description: {
+        type: "string",
+        description:
+          "The new description for the table. Defaults to blank if not provided.",
+      },
+    },
+    description:
+      "Request body for updating table properties. At least one property must be provided.",
+  },
+  DeleteTableResponse: {
+    type: "object",
+    properties: {
+      deletedTableId: { type: "string", description: "The deleted table id." },
+    },
+  },
+  Record: {
+    type: "object",
+    properties: {
+      _dummy: {
+        type: "string",
+        description: "Unused dummy property to force model generation.",
+        nullable: true,
+      },
+    },
+    additionalProperties: {
+      type: "object",
       properties: {
+        value: {
+          type: ["string", "number", "boolean", "object", "array", "null"],
+        },
+      },
+      description: "The value object for a field ID key.",
+    },
+    description:
+      "A record with field ID keys (e.g., '6') and value objects (e.g., { value: 'data' }).",
+  },
+  UpsertRequest: {
+    type: "object",
+    required: ["to"],
+    properties: {
+      to: { type: "string", description: "The table identifier (dbid)." },
+      data: {
+        type: "array",
+        items: { $ref: "#/definitions/Record" },
+        description: "Array of records to upsert.",
+      },
+      mergeFieldId: {
+        type: "integer",
+        description: "The field ID to merge on (optional).",
+      },
+      fieldsToReturn: {
+        type: "array",
+        items: { type: "integer" },
+        description: "Field IDs to return in the response (optional).",
+      },
+    },
+  },
+  Upsert200Response: {
+    type: "object",
+    properties: {
+      data: {
+        type: "array",
+        items: {
+          type: "object",
+          additionalProperties: {
+            type: "object",
+            properties: { value: { type: "any" } },
+          },
+        },
+        description: "Array of upserted records with field IDs and values.",
+      },
+      metadata: {
         type: "object",
         properties: {
-          primaryKey: { type: "boolean" },
-          foreignKey: { type: "boolean" },
-          numLines: { type: "number" },
-          maxLength: { type: "number" },
-          appendOnly: { type: "boolean" },
-          allowHTML: { type: "boolean" },
-          allowMentions: { type: "boolean" },
-          sortAsGiven: { type: "boolean" },
-          carryChoices: { type: "boolean" },
-          allowNewChoices: { type: "boolean" },
-          formula: { type: "string" },
-          defaultValue: { type: "string" },
+          createdRecordIds: {
+            type: "array",
+            items: { type: "integer" },
+            description: "IDs of newly created records.",
+          },
+          updatedRecordIds: {
+            type: "array",
+            items: { type: "integer" },
+            description: "IDs of updated records.",
+          },
+          unchangedRecordIds: {
+            type: "array",
+            items: { type: "integer" },
+            description: "IDs of unchanged records.",
+          },
+          totalNumberOfRecordsProcessed: {
+            type: "integer",
+            description: "Total records processed.",
+          },
         },
+        required: ["totalNumberOfRecordsProcessed"],
       },
-      permissions: {
+    },
+  },
+  Upsert207Response: {
+    type: "object",
+    properties: {
+      data: {
         type: "array",
         items: {
           type: "object",
-          properties: {
-            permissionType: { type: "string" },
-            role: { type: "string" },
-            roleId: { type: "number" },
+          additionalProperties: {
+            type: "object",
+            properties: { value: { type: "any" } },
           },
         },
+        description: "Array of successfully upserted records (may be empty).",
+      },
+      metadata: {
+        type: "object",
+        properties: {
+          createdRecordIds: { type: "array", items: { type: "integer" } },
+          updatedRecordIds: { type: "array", items: { type: "integer" } },
+          unchangedRecordIds: { type: "array", items: { type: "integer" } },
+          lineErrors: {
+            type: "object",
+            additionalProperties: { type: "array", items: { type: "string" } },
+            description: "Errors by line number (1-based index).",
+          },
+          totalNumberOfRecordsProcessed: { type: "integer" },
+        },
+        required: ["totalNumberOfRecordsProcessed"],
       },
     },
-    required: ["id", "label", "fieldType"],
   },
-  Table: {
+  ReportRunResponse: {
     type: "object",
     properties: {
       id: { type: "string" },
-      name: { type: "string" },
-      alias: { type: "string" },
-      created: { type: "string", format: "date-time" },
-      defaultSortFieldId: { type: "number" },
-      defaultSortOrder: { type: "string" },
-      description: { type: "string" },
-      keyFieldId: { type: "number" },
-      nextFieldId: { type: "number" },
-      nextRecordId: { type: "number" },
-      pluralRecordName: { type: "string" },
-      singleRecordName: { type: "string" },
-      sizeLimit: { type: "string" },
-      spaceRemaining: { type: "string" },
-      spaceUsed: { type: "string" },
-      updated: { type: "string", format: "date-time" },
+      data: { type: "object" },
     },
-    required: ["id", "name"],
   },
-  Record: {
+  GetTempTokenDBID200Response: {
     type: "object",
+    required: ["temporaryAuthorization"],
     properties: {
-      id: { type: "number" },
-      fields: {
-        type: "object",
-        additionalProperties: { type: "string" },
+      temporaryAuthorization: { type: "string" },
+    },
+  },
+  DeleteRecordsRequest: {
+    type: "object",
+    required: ["from", "where"],
+    properties: {
+      from: {
+        type: "string",
+        description:
+          "The table identifier (dbid) from which to delete records.",
+      },
+      where: {
+        type: "string",
+        description:
+          "A QuickBase query string specifying which records to delete.",
       },
     },
-    required: ["id"],
+    description:
+      "Request body for deleting records from a table using a query.",
   },
-  Upsert200Response: {
+  DeleteRecords200Response: {
     type: "object",
     properties: {
-      id: { type: "number" },
-      status: { type: "string" },
+      numberDeleted: {
+        type: "integer",
+        description: "The number of records successfully deleted.",
+      },
     },
-    required: ["id"],
+    required: ["numberDeleted"],
+    description: "Response body for successful deletion of records.",
   },
-  ReportRunResponse: {
+  RunQueryRequest: {
     type: "object",
+    required: ["from"],
     properties: {
-      id: { type: "string" },
-      data: { type: "object" }, // Placeholder
+      from: { type: "string", description: "Table ID (dbid)" },
+      select: {
+        type: "array",
+        items: { type: "integer" },
+        description: "Field IDs to return",
+      },
+      where: { type: "string", description: "Query string" },
+      sortBy: {
+        type: "array",
+        items: {
+          type: "object",
+          properties: {
+            fieldId: { type: "integer" },
+            order: { type: "string", enum: ["ASC", "DESC"] },
+          },
+        },
+        description: "Sort criteria",
+      },
+      groupBy: {
+        type: "array",
+        items: {
+          type: "object",
+          properties: {
+            fieldId: { type: "integer" },
+            grouping: { type: "string", enum: ["equal-values"] },
+          },
+        },
+        description: "Grouping criteria",
+      },
+      options: {
+        type: "object",
+        properties: {
+          skip: { type: "integer", description: "Number of records to skip" },
+          top: {
+            type: "integer",
+            description: "Max number of records to return",
+          },
+          compareWithAppLocalTime: {
+            type: "boolean",
+            description: "Compare times with app local time",
+          },
+        },
+      },
     },
-    required: ["id"],
   },
-  GetTempTokenDBID200Response: {
+  RunQueryResponse: {
     type: "object",
     properties: {
-      temporaryAuthorization: { type: "string" },
+      data: {
+        type: "array",
+        items: {
+          type: "object",
+          additionalProperties: {
+            type: "object",
+            properties: { value: { type: "any" } },
+          },
+        },
+        description: "Array of record data with field IDs as keys",
+      },
+      fields: {
+        type: "array",
+        items: {
+          type: "object",
+          properties: {
+            id: { type: "integer" },
+            label: { type: "string" },
+            type: { type: "string" },
+          },
+        },
+        description: "Field metadata",
+      },
+      metadata: {
+        type: "object",
+        properties: {
+          numFields: { type: "integer" },
+          numRecords: { type: "integer" },
+          skip: { type: "integer" },
+          top: { type: "integer" },
+          totalRecords: { type: "integer" },
+        },
+        description: "Query metadata",
+      },
     },
-    required: ["temporaryAuthorization"],
   },
 };