quickbase-js 2.1.0 → 2.2.0

package/dist/xml/types.d.ts

@@ -0,0 +1,531 @@
+/**
+ * XML API Types
+ *
+ * Type definitions for the legacy QuickBase XML API.
+ *
+ * XML-API: Remove this file when QuickBase discontinues the XML API.
+ * To find all XML API code, search for: XML-API
+ */
+/**
+ * Minimal interface for making XML API calls.
+ * This interface avoids circular dependencies between the xml package
+ * and the main client.
+ */
+export interface XmlCaller {
+    /**
+     * Get the QuickBase realm name (e.g., "mycompany")
+     */
+    realm(): string;
+    /**
+     * Execute an XML API request
+     * @param dbid - The database ID to make the request against
+     * @param action - The QUICKBASE-ACTION header value (e.g., "API_GetRoleInfo")
+     * @param body - The XML request body (wrapped in <qdbapi> tags)
+     * @returns The raw XML response body as a string
+     */
+    doXml(dbid: string, action: string, body: string): Promise<string>;
+}
+/**
+ * Base structure for all XML API responses.
+ * Every XML response contains these fields.
+ */
+export interface BaseResponse {
+    action: string;
+    errcode: number;
+    errtext: string;
+    errdetail?: string;
+}
+/**
+ * Access level for a role
+ */
+export interface RoleAccess {
+    /** Access level ID: 1=Administrator, 2=Basic Access with Share, 3=Basic Access */
+    id: number;
+    /** Text description of the access level */
+    description: string;
+}
+/**
+ * A role defined in a QuickBase application
+ */
+export interface Role {
+    /** Unique role ID */
+    id: number;
+    /** Display name of the role */
+    name: string;
+    /** Access level granted by this role */
+    access: RoleAccess;
+}
+/**
+ * Role with membership information (from GetUserRole)
+ */
+export interface UserRole extends Role {
+    /** How this role was assigned (only present when includeGroups=true) */
+    member?: RoleMember;
+}
+/**
+ * Describes how a role was assigned to a user
+ */
+export interface RoleMember {
+    /** "user", "group", or "domainGroup" */
+    type: string;
+    /** Name of the user or group */
+    name: string;
+}
+/**
+ * User with their assigned roles
+ */
+export interface UserWithRoles {
+    /** QuickBase user ID (e.g., "112149.bhsv") */
+    id: string;
+    /** "user" for individual users or "group" for groups */
+    type: string;
+    /** Display name */
+    name: string;
+    /** First name (may be empty for groups) */
+    firstName?: string;
+    /** Last name (may be empty for groups) */
+    lastName?: string;
+    /** Timestamp of last access (milliseconds since epoch) */
+    lastAccess?: string;
+    /** Human-readable last access time */
+    lastAccessAppLocal?: string;
+    /** Roles assigned to this user */
+    roles: Role[];
+}
+/**
+ * A QuickBase group
+ */
+export interface Group {
+    /** Group ID (e.g., "1217.dgpt") */
+    id: string;
+    /** Group name */
+    name: string;
+    /** Group description */
+    description?: string;
+    /** Whether the group is managed by a user (vs. system) */
+    managedByUser?: boolean;
+}
+/**
+ * User within a group
+ */
+export interface GroupUser {
+    /** User ID */
+    id: string;
+    /** First name */
+    firstName: string;
+    /** Last name */
+    lastName: string;
+    /** Email address */
+    email: string;
+    /** Screen name */
+    screenName?: string;
+    /** Whether the user is an admin */
+    isAdmin?: boolean;
+}
+/**
+ * Manager of a group
+ */
+export interface GroupManager {
+    /** Manager ID */
+    id: string;
+    /** First name */
+    firstName: string;
+    /** Last name */
+    lastName: string;
+    /** Email address */
+    email: string;
+    /** Screen name */
+    screenName?: string;
+    /** Whether the manager is also a member */
+    isMember?: boolean;
+}
+/**
+ * Subgroup reference
+ */
+export interface Subgroup {
+    /** Subgroup ID */
+    id: string;
+}
+/**
+ * User information from GetUserInfo
+ */
+export interface UserInfo {
+    /** QuickBase user ID */
+    id: string;
+    /** First name */
+    firstName: string;
+    /** Last name */
+    lastName: string;
+    /** Login name (may be undefined for anonymous users or when email was provided) */
+    login?: string;
+    /** Email address (may be undefined for anonymous users) */
+    email?: string;
+    /** Screen name */
+    screenName?: string;
+    /** Whether the user's email is verified */
+    isVerified?: boolean;
+    /** Whether the user uses external authentication (SSO) */
+    externalAuth?: boolean;
+}
+/**
+ * Field definition from GetSchema
+ */
+export interface SchemaField {
+    /** Field ID */
+    id: number;
+    /** Field type (e.g., "text", "numeric", "date") */
+    fieldType: string;
+    /** Base type (e.g., "text", "int64") */
+    baseType?: string;
+    /** Field mode (e.g., "lookup", "formula") */
+    mode?: string;
+    /** Field label */
+    label: string;
+    /** Help text */
+    fieldHelp?: string;
+    /** Whether field is required */
+    required?: boolean;
+    /** Whether field must be unique */
+    unique?: boolean;
+    /** No text wrap */
+    nowrap?: boolean;
+    /** Bold text */
+    bold?: boolean;
+    /** Appears by default in reports */
+    appearsByDefault?: boolean;
+    /** Find enabled */
+    findEnabled?: boolean;
+    /** Allow new choices (for multi-choice fields) */
+    allowNewChoices?: boolean;
+    /** Sort choices as given */
+    sortAsGiven?: boolean;
+    /** Carry choices */
+    carryChoices?: boolean;
+    /** Is foreign key */
+    foreignKey?: boolean;
+    /** Does total */
+    doesTotal?: boolean;
+    /** Does average */
+    doesAverage?: boolean;
+    /** Default value kind */
+    defaultKind?: string;
+    /** Default value */
+    defaultValue?: string;
+    /** Choices for multi-choice fields */
+    choices?: string[];
+    /** Summary reference field ID */
+    summaryReferenceFid?: number;
+    /** Summary target field ID */
+    summaryTargetFid?: number;
+    /** Summary function (Total, Average, etc.) */
+    summaryFunction?: string;
+}
+/**
+ * Query/Report definition from GetSchema
+ */
+export interface SchemaQuery {
+    /** Query ID */
+    id: number;
+    /** Query name */
+    name: string;
+    /** Query type (e.g., "table", "calendar") */
+    type?: string;
+    /** Query description */
+    description?: string;
+    /** Query criteria */
+    criteria?: string;
+    /** Column list */
+    columnList?: string;
+    /** Sort list */
+    sortList?: string;
+    /** Query options */
+    options?: string;
+    /** Calculated fields list */
+    calcFields?: string;
+}
+/**
+ * Application variable from GetSchema
+ */
+export interface SchemaVariable {
+    /** Variable name */
+    name: string;
+    /** Variable value */
+    value: string;
+}
+/**
+ * Child table reference from GetSchema
+ */
+export interface SchemaChildTable {
+    /** Child table name reference */
+    name: string;
+    /** Child table DBID */
+    dbid: string;
+}
+/**
+ * Original info block from GetSchema
+ */
+export interface SchemaOriginal {
+    appId?: string;
+    tableId?: string;
+    /** Creation time (ms since epoch) */
+    createdTime?: string;
+    /** Modification time (ms since epoch) */
+    modifiedTime?: string;
+    nextRecordId?: number;
+    nextFieldId?: number;
+    nextQueryId?: number;
+    defaultSortFid?: number;
+    defaultSortOrder?: number;
+}
+/**
+ * Table/App schema from GetSchema
+ */
+export interface SchemaTable {
+    /** Table/App name */
+    name: string;
+    /** Description */
+    description?: string;
+    /** Original metadata */
+    original?: SchemaOriginal;
+    /** Application variables */
+    variables?: SchemaVariable[];
+    /** Child tables (for app-level schema) */
+    childTables?: SchemaChildTable[];
+    /** Fields (for table-level schema) */
+    fields?: SchemaField[];
+    /** Queries/Reports */
+    queries?: SchemaQuery[];
+}
+/**
+ * Database info from GrantedDBs
+ */
+export interface DatabaseInfo {
+    /** Database ID */
+    dbid: string;
+    /** Database name */
+    name: string;
+    /** Ancestor app ID (if copied from another app) */
+    ancestorAppId?: string;
+    /** Oldest ancestor app ID */
+    oldestAncestorAppId?: string;
+}
+/**
+ * Database info from GetDBInfo
+ */
+export interface DBInfo {
+    /** Database/table name */
+    name: string;
+    /** Number of records */
+    numRecords: number;
+    /** Manager's user ID */
+    managerId?: string;
+    /** Manager's name */
+    managerName?: string;
+    /** Last record modification time (ms since epoch) */
+    lastRecModTime?: string;
+    /** Last schema modification time (ms since epoch) */
+    lastModifiedTime?: string;
+    /** Creation time (ms since epoch) */
+    createdTime?: string;
+    /** Time zone */
+    timeZone?: string;
+    /** Version */
+    version?: string;
+}
+/**
+ * Field value from GetRecordInfo
+ */
+export interface RecordField {
+    /** Field ID */
+    id: number;
+    /** Field name */
+    name: string;
+    /** Field type */
+    type: string;
+    /** Raw value */
+    value: string;
+    /** Human-readable value (for dates, etc.) */
+    printable?: string;
+}
+/**
+ * Page type for AddReplaceDBPage
+ */
+export declare enum PageType {
+    /** XSL stylesheet or HTML page */
+    XSLOrHTML = 1,
+    /** Exact Form */
+    ExactForm = 3
+}
+/**
+ * Webhook trigger type.
+ * Can be combined, e.g., 'adm' for all triggers.
+ */
+export type WebhookTrigger = 'a' | 'd' | 'm' | 'ad' | 'am' | 'dm' | 'adm';
+/**
+ * Webhook message format
+ */
+export type WebhookMessageFormat = 'XML' | 'JSON' | 'RAW';
+/**
+ * Webhook HTTP verb
+ */
+export type WebhookHTTPVerb = 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE';
+/**
+ * Webhook header key-value pair
+ */
+export interface WebhookHeader {
+    key: string;
+    value: string;
+}
+/**
+ * Options for creating a webhook
+ */
+export interface WebhooksCreateOptions {
+    /** A unique name for the webhook (required) */
+    label: string;
+    /** Endpoint URL - must start with https:// (required) */
+    webhookUrl: string;
+    /** Description of the webhook */
+    description?: string;
+    /** Filter criteria to trigger the webhook */
+    query?: string;
+    /** When to trigger: 'a' (add), 'd' (delete), 'm' (modify), or combinations like 'adm' */
+    workflowWhen?: WebhookTrigger;
+    /** HTTP headers for the webhook request */
+    headers?: WebhookHeader[];
+    /** Payload of the webhook (empty by default) */
+    message?: string;
+    /** Format of the payload: XML (default), JSON, or RAW */
+    messageFormat?: WebhookMessageFormat;
+    /** HTTP method: POST (default), GET, PUT, PATCH, DELETE */
+    httpVerb?: WebhookHTTPVerb;
+    /** Field IDs - webhook fires only when these fields change. If empty, fires on any change. */
+    triggerFields?: number[];
+}
+/**
+ * Options for editing a webhook
+ */
+export interface WebhooksEditOptions extends WebhooksCreateOptions {
+    /** When true, clears the field trigger criteria (fires on any field) */
+    clearTriggerFields?: boolean;
+}
+/**
+ * Legacy webhook options (deprecated - use WebhooksCreateOptions)
+ * @deprecated Use WebhooksCreateOptions instead
+ */
+export interface WebhookOptions {
+    /** Webhook name */
+    name?: string;
+    /** URL to call */
+    url?: string;
+    /** Trigger type */
+    trigger?: string;
+}
+export interface GetRoleInfoResult {
+    roles: Role[];
+}
+export interface UserRolesResult {
+    users: UserWithRoles[];
+}
+export interface GetUserRoleResult {
+    userId: string;
+    userName: string;
+    roles: UserRole[];
+}
+export interface GetSchemaResult {
+    timeZone?: string;
+    dateFormat?: string;
+    table: SchemaTable;
+}
+export interface GrantedDBsResult {
+    databases: DatabaseInfo[];
+}
+export interface FindDBByNameResult {
+    dbid: string;
+    /** Echoed from request (may not always be present) */
+    name?: string;
+}
+export interface GetUsersInGroupResult {
+    id: string;
+    name: string;
+    description?: string;
+    users: GroupUser[];
+    managers: GroupManager[];
+    subgroups: Subgroup[];
+}
+export interface CreateGroupResult {
+    group: Group;
+}
+export interface GetGroupRoleResult {
+    roles: Array<{
+        id: number;
+        name: string;
+    }>;
+}
+export interface ProvisionUserResult {
+    userId: string;
+}
+export interface AddReplaceDBPageResult {
+    pageId: number;
+}
+export interface FieldAddChoicesResult {
+    fieldId: number;
+    fieldName: string;
+    numAdded: number;
+}
+export interface FieldRemoveChoicesResult {
+    fieldId: number;
+    fieldName: string;
+    numRemoved: number;
+}
+export interface DoQueryCountResult {
+    numMatches: number;
+}
+export interface GetRecordInfoResult {
+    recordId: number;
+    numFields: number;
+    updateId?: string;
+    fields: RecordField[];
+}
+export interface GrantedGroupsResult {
+    groups: Array<{
+        id: string;
+        name: string;
+    }>;
+}
+export interface GrantedDBsForGroupResult {
+    databases: Array<{
+        dbid: string;
+        name: string;
+    }>;
+}
+export interface GetAppDTMInfoResult {
+    appId: string;
+    lastModifiedTime?: string;
+    lastRecModTime?: string;
+    tables: Array<{
+        id: string;
+        lastModifiedTime?: string;
+        lastRecModTime?: string;
+    }>;
+}
+export interface GetAncestorInfoResult {
+    ancestorAppId?: string;
+    oldestAncestorAppId?: string;
+}
+export interface ImportFromCSVResult {
+    numRecsAdded: number;
+    numRecsUpdated: number;
+    numRecsInput: number;
+    recordIds: Array<{
+        recordId: number;
+        updateId?: string;
+    }>;
+}
+export interface CopyMasterDetailResult {
+    newRid: number;
+    numCreated: number;
+}
+export interface WebhookResult {
+    webhookId: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/xml/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/xml/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,KAAK,IAAI,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACpE;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,kFAAkF;IAClF,EAAE,EAAE,MAAM,CAAC;IACX,2CAA2C;IAC3C,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,qBAAqB;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,MAAM,EAAE,UAAU,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,IAAI;IACpC,wEAAwE;IACxE,MAAM,CAAC,EAAE,UAAU,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,8CAA8C;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sCAAsC;IACtC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kCAAkC;IAClC,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAMD;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,mCAAmC;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0DAA0D;IAC1D,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,cAAc;IACd,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;CACZ;AAMD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,mFAAmF;IACnF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,0DAA0D;IAC1D,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAMD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,eAAe;IACf,EAAE,EAAE,MAAM,CAAC;IACX,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gCAAgC;IAChC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,mCAAmC;IACnC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,mBAAmB;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gBAAgB;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,oCAAoC;IACpC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,mBAAmB;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,kDAAkD;IAClD,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,4BAA4B;IAC5B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oBAAoB;IACpB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,qBAAqB;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,mBAAmB;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,iCAAiC;IACjC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,8BAA8B;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,8CAA8C;IAC9C,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,eAAe;IACf,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yCAAyC;IACzC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wBAAwB;IACxB,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,4BAA4B;IAC5B,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;IAC7B,0CAA0C;IAC1C,WAAW,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACjC,sCAAsC;IACtC,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB,sBAAsB;IACtB,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;CACzB;AAMD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6BAA6B;IAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qBAAqB;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qDAAqD;IACrD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qDAAqD;IACrD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,qCAAqC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAMD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,eAAe;IACf,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD;;GAEG;AACH,oBAAY,QAAQ;IAClB,kCAAkC;IAClC,SAAS,IAAI;IACb,iBAAiB;IACjB,SAAS,IAAI;CACd;AAMD;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,UAAU,EAAE,MAAM,CAAC;IACnB,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yFAAyF;IACzF,YAAY,CAAC,EAAE,cAAc,CAAC;IAC9B,2CAA2C;IAC3C,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yDAAyD;IACzD,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,8FAA8F;IAC9F,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;IAChE,wEAAwE;IACxE,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAMD,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,aAAa,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,YAAY,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,sDAAsD;IACtD,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,KAAK,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACnF;AAED,MAAM,WAAW,qBAAqB;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC3D;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/dist/xml/types.js

@@ -0,0 +1,22 @@
+/**
+ * XML API Types
+ *
+ * Type definitions for the legacy QuickBase XML API.
+ *
+ * XML-API: Remove this file when QuickBase discontinues the XML API.
+ * To find all XML API code, search for: XML-API
+ */
+// ============================================================================
+// Code Page Types
+// ============================================================================
+/**
+ * Page type for AddReplaceDBPage
+ */
+export var PageType;
+(function (PageType) {
+    /** XSL stylesheet or HTML page */
+    PageType[PageType["XSLOrHTML"] = 1] = "XSLOrHTML";
+    /** Exact Form */
+    PageType[PageType["ExactForm"] = 3] = "ExactForm";
+})(PageType || (PageType = {}));
+//# sourceMappingURL=types.js.map

package/dist/xml/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/xml/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAqYH,+EAA+E;AAC/E,kBAAkB;AAClB,+EAA+E;AAE/E;;GAEG;AACH,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,kCAAkC;IAClC,iDAAa,CAAA;IACb,iBAAiB;IACjB,iDAAa,CAAA;AACf,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB"}

package/dist/xml/users.d.ts

@@ -0,0 +1,92 @@
+/**
+ * XML API User Management
+ *
+ * Endpoints for managing users and user-related operations.
+ *
+ * XML-API: Remove this file when QuickBase discontinues the XML API.
+ * To find all XML API code, search for: XML-API
+ */
+import type { XmlCaller, UserInfo, ProvisionUserResult } from './types.js';
+/**
+ * Get user information by email.
+ *
+ * Returns user ID, name, and other details for a registered QuickBase user.
+ * If no email is provided, returns info for the current user.
+ *
+ * @see https://help.quickbase.com/docs/api-getuserinfo
+ *
+ * @example
+ * ```typescript
+ * // Get info for specific user
+ * const user = await getUserInfo(caller, 'user@example.com');
+ * console.log(`User ID: ${user.id}, Name: ${user.firstName} ${user.lastName}`);
+ *
+ * // Get info for current user
+ * const me = await getUserInfo(caller);
+ * ```
+ */
+export declare function getUserInfo(caller: XmlCaller, email?: string): Promise<UserInfo>;
+/**
+ * Create a new unregistered user and add them to an application.
+ *
+ * This is for users who are NOT yet registered with QuickBase.
+ * For existing users, use getUserInfo + addUserToRole + sendInvitation.
+ *
+ * After provisioning, call sendInvitation to email the user.
+ *
+ * @see https://help.quickbase.com/docs/api-provisionuser
+ *
+ * @example
+ * ```typescript
+ * const result = await provisionUser(caller, 'bqxyz123', 'new@example.com', 'John', 'Doe', 11);
+ * console.log(`Created user: ${result.userId}`);
+ *
+ * // Now send invitation
+ * await sendInvitation(caller, 'bqxyz123', result.userId, 'Welcome to our app!');
+ * ```
+ */
+export declare function provisionUser(caller: XmlCaller, appId: string, email: string, firstName: string, lastName: string, roleId?: number): Promise<ProvisionUserResult>;
+/**
+ * Send an invitation email to a user.
+ *
+ * Use after adding a user to a role (via addUserToRole or provisionUser).
+ *
+ * @see https://help.quickbase.com/docs/api-sendinvitation
+ *
+ * @example
+ * ```typescript
+ * await sendInvitation(caller, 'bqxyz123', '112149.bhsv', 'Welcome to our team app!');
+ * ```
+ */
+export declare function sendInvitation(caller: XmlCaller, appId: string, userId: string, userText?: string): Promise<void>;
+/**
+ * Change the application manager.
+ *
+ * Requires account admin or realm admin permissions.
+ *
+ * @see https://help.quickbase.com/docs/api-changemanager
+ *
+ * @example
+ * ```typescript
+ * await changeManager(caller, 'bqxyz123', 'newmanager@example.com');
+ * ```
+ */
+export declare function changeManager(caller: XmlCaller, appId: string, newManagerEmail: string): Promise<void>;
+/**
+ * Change the owner of a record.
+ *
+ * Transfers ownership from the current record owner to another user.
+ * Requires Full Administration rights on the application.
+ *
+ * @see https://help.quickbase.com/docs/api-changerecordowner
+ *
+ * @param newOwner - The new owner's QuickBase username or email address
+ *
+ * @example
+ * ```typescript
+ * // By record ID
+ * await changeRecordOwner(caller, 'bqtable123', 42, 'newowner@example.com');
+ * ```
+ */
+export declare function changeRecordOwner(caller: XmlCaller, tableId: string, recordId: number, newOwner: string): Promise<void>;
+//# sourceMappingURL=users.d.ts.map

package/dist/xml/users.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/xml/users.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,SAAS,EACT,QAAQ,EACR,mBAAmB,EACpB,MAAM,YAAY,CAAC;AAUpB;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,SAAS,EACjB,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,QAAQ,CAAC,CAuCnB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,aAAa,CACjC,MAAM,EAAE,SAAS,EACjB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,mBAAmB,CAAC,CAsB9B;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,SAAS,EACjB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CAWf;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,aAAa,CACjC,MAAM,EAAE,SAAS,EACjB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,IAAI,CAAC,CAOf;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC,CASf"}