quickbase-js 2.1.0 → 2.2.0

package/dist/xml/codepages.d.ts

@@ -0,0 +1,60 @@
+/**
+ * XML API Code Pages
+ *
+ * Endpoints for managing stored code pages (HTML, XSL, etc.).
+ *
+ * XML-API: Remove this file when QuickBase discontinues the XML API.
+ * To find all XML API code, search for: XML-API
+ */
+import type { XmlCaller, PageType, AddReplaceDBPageResult } from './types.js';
+/**
+ * Get stored code page content.
+ *
+ * Returns the raw page content (HTML, XSL, etc.).
+ *
+ * @see https://help.quickbase.com/docs/api-getdbpage
+ *
+ * @param pageIdOrName - Page ID (number) or page name (string)
+ *
+ * @example
+ * ```typescript
+ * // By page ID
+ * const content = await getDBPage(caller, 'bqapp123', 3);
+ *
+ * // By page name
+ * const content = await getDBPage(caller, 'bqapp123', 'mystylesheet.xsl');
+ * ```
+ */
+export declare function getDBPage(caller: XmlCaller, appId: string, pageIdOrName: string | number): Promise<string>;
+/**
+ * Create or update a code page.
+ *
+ * Page types:
+ * - 1: XSL stylesheets or HTML pages
+ * - 3: Exact Forms (Word templates)
+ *
+ * @see https://help.quickbase.com/docs/api-addreplacedbpage
+ *
+ * @param pageId - Existing page ID to replace (undefined to create new)
+ * @param pageName - Name for the page (required when creating new)
+ *
+ * @example
+ * ```typescript
+ * // Create a new page
+ * const result = await addReplaceDBPage(
+ *   caller, 'bqapp123',
+ *   'mypage.html', undefined, 1,
+ *   '<html><body>Hello World</body></html>'
+ * );
+ * console.log(`Created page ID: ${result.pageId}`);
+ *
+ * // Update existing page
+ * await addReplaceDBPage(
+ *   caller, 'bqapp123',
+ *   'mypage.html', 6, 1,
+ *   '<html><body>Updated content</body></html>'
+ * );
+ * ```
+ */
+export declare function addReplaceDBPage(caller: XmlCaller, appId: string, pageName: string, pageId: number | undefined, pageType: PageType, pageBody: string): Promise<AddReplaceDBPageResult>;
+//# sourceMappingURL=codepages.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"codepages.d.ts","sourceRoot":"","sources":["../../src/xml/codepages.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,SAAS,EACT,QAAQ,EACR,sBAAsB,EACvB,MAAM,YAAY,CAAC;AAWpB;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,SAAS,EACjB,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,MAAM,GAAG,MAAM,GAC5B,OAAO,CAAC,MAAM,CAAC,CAejB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,SAAS,EACjB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,sBAAsB,CAAC,CAkBjC"}

package/dist/xml/codepages.js

@@ -0,0 +1,88 @@
+/**
+ * XML API Code Pages
+ *
+ * Endpoints for managing stored code pages (HTML, XSL, etc.).
+ *
+ * XML-API: Remove this file when QuickBase discontinues the XML API.
+ * To find all XML API code, search for: XML-API
+ */
+import { checkError } from './errors.js';
+import { buildRequest, escapeXml, parseBaseResponse, getTagContent, xmlElementCDATA, parseXmlNumber, } from './request.js';
+/**
+ * Get stored code page content.
+ *
+ * Returns the raw page content (HTML, XSL, etc.).
+ *
+ * @see https://help.quickbase.com/docs/api-getdbpage
+ *
+ * @param pageIdOrName - Page ID (number) or page name (string)
+ *
+ * @example
+ * ```typescript
+ * // By page ID
+ * const content = await getDBPage(caller, 'bqapp123', 3);
+ *
+ * // By page name
+ * const content = await getDBPage(caller, 'bqapp123', 'mystylesheet.xsl');
+ * ```
+ */
+export async function getDBPage(caller, appId, pageIdOrName) {
+    const inner = `<pageID>${escapeXml(String(pageIdOrName))}</pageID>`;
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(appId, 'API_GetDBPage', body);
+    // Note: GetDBPage returns raw HTML, not XML
+    // Check if it's an error response
+    if (xml.includes('<errcode>') && !xml.includes('<errcode>0</errcode>')) {
+        const base = parseBaseResponse(xml);
+        checkError(base);
+    }
+    // If not an error, return the raw content
+    // The response is the page content itself, not wrapped in XML
+    return xml;
+}
+/**
+ * Create or update a code page.
+ *
+ * Page types:
+ * - 1: XSL stylesheets or HTML pages
+ * - 3: Exact Forms (Word templates)
+ *
+ * @see https://help.quickbase.com/docs/api-addreplacedbpage
+ *
+ * @param pageId - Existing page ID to replace (undefined to create new)
+ * @param pageName - Name for the page (required when creating new)
+ *
+ * @example
+ * ```typescript
+ * // Create a new page
+ * const result = await addReplaceDBPage(
+ *   caller, 'bqapp123',
+ *   'mypage.html', undefined, 1,
+ *   '<html><body>Hello World</body></html>'
+ * );
+ * console.log(`Created page ID: ${result.pageId}`);
+ *
+ * // Update existing page
+ * await addReplaceDBPage(
+ *   caller, 'bqapp123',
+ *   'mypage.html', 6, 1,
+ *   '<html><body>Updated content</body></html>'
+ * );
+ * ```
+ */
+export async function addReplaceDBPage(caller, appId, pageName, pageId, pageType, pageBody) {
+    let inner = '';
+    if (pageId !== undefined) {
+        inner += `<pageid>${pageId}</pageid>`;
+    }
+    inner += `<pagename>${escapeXml(pageName)}</pagename>`;
+    inner += `<pagetype>${pageType}</pagetype>`;
+    inner += xmlElementCDATA('pagebody', pageBody);
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(appId, 'API_AddReplaceDBPage', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+    const resultPageId = parseXmlNumber(getTagContent(xml, 'pageID'));
+    return { pageId: resultPageId };
+}
+//# sourceMappingURL=codepages.js.map

package/dist/xml/codepages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codepages.js","sourceRoot":"","sources":["../../src/xml/codepages.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAOH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EACL,YAAY,EACZ,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,eAAe,EACf,cAAc,GACf,MAAM,cAAc,CAAC;AAEtB;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAiB,EACjB,KAAa,EACb,YAA6B;IAE7B,MAAM,KAAK,GAAG,WAAW,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,WAAW,CAAC;IACpE,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC;IAE7D,4CAA4C;IAC5C,kCAAkC;IAClC,IAAI,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,CAAC;QACvE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACpC,UAAU,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED,0CAA0C;IAC1C,8DAA8D;IAC9D,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAAiB,EACjB,KAAa,EACb,QAAgB,EAChB,MAA0B,EAC1B,QAAkB,EAClB,QAAgB;IAEhB,IAAI,KAAK,GAAG,EAAE,CAAC;IAEf,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,KAAK,IAAI,WAAW,MAAM,WAAW,CAAC;IACxC,CAAC;IACD,KAAK,IAAI,aAAa,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC;IACvD,KAAK,IAAI,aAAa,QAAQ,aAAa,CAAC;IAC5C,KAAK,IAAI,eAAe,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAE/C,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,sBAAsB,EAAE,IAAI,CAAC,CAAC;IAEpE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEjB,MAAM,YAAY,GAAG,cAAc,CAAC,aAAa,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;IAClE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;AAClC,CAAC"}

package/dist/xml/dbvars.d.ts

@@ -0,0 +1,39 @@
+/**
+ * XML API Application Variables (DBVars)
+ *
+ * Endpoints for managing application variables.
+ *
+ * XML-API: Remove this file when QuickBase discontinues the XML API.
+ * To find all XML API code, search for: XML-API
+ */
+import type { XmlCaller } from './types.js';
+/**
+ * Get an application variable value.
+ *
+ * DBVars are application-level variables that can be used in formulas
+ * and code pages.
+ *
+ * @see https://help.quickbase.com/docs/api-getdbvar
+ *
+ * @example
+ * ```typescript
+ * const value = await getDBVar(caller, 'bqapp123', 'myVariable');
+ * console.log(`Variable value: ${value}`);
+ * ```
+ */
+export declare function getDBVar(caller: XmlCaller, appId: string, varName: string): Promise<string>;
+/**
+ * Set an application variable value.
+ *
+ * Creates the variable if it doesn't exist, or overwrites if it does.
+ * Requires Full Administration rights on the application.
+ *
+ * @see https://help.quickbase.com/docs/api-setdbvar
+ *
+ * @example
+ * ```typescript
+ * await setDBVar(caller, 'bqapp123', 'myVariable', '42');
+ * ```
+ */
+export declare function setDBVar(caller: XmlCaller, appId: string, varName: string, value: string): Promise<void>;
+//# sourceMappingURL=dbvars.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dbvars.d.ts","sourceRoot":"","sources":["../../src/xml/dbvars.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAS5C;;;;;;;;;;;;;GAaG;AACH,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,SAAS,EACjB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC,CASjB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,SAAS,EACjB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC,CASf"}

package/dist/xml/dbvars.js

@@ -0,0 +1,54 @@
+/**
+ * XML API Application Variables (DBVars)
+ *
+ * Endpoints for managing application variables.
+ *
+ * XML-API: Remove this file when QuickBase discontinues the XML API.
+ * To find all XML API code, search for: XML-API
+ */
+import { checkError } from './errors.js';
+import { buildRequest, escapeXml, parseBaseResponse, getTagContent, } from './request.js';
+/**
+ * Get an application variable value.
+ *
+ * DBVars are application-level variables that can be used in formulas
+ * and code pages.
+ *
+ * @see https://help.quickbase.com/docs/api-getdbvar
+ *
+ * @example
+ * ```typescript
+ * const value = await getDBVar(caller, 'bqapp123', 'myVariable');
+ * console.log(`Variable value: ${value}`);
+ * ```
+ */
+export async function getDBVar(caller, appId, varName) {
+    const inner = `<varname>${escapeXml(varName)}</varname>`;
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(appId, 'API_GetDBVar', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+    return getTagContent(xml, 'value');
+}
+/**
+ * Set an application variable value.
+ *
+ * Creates the variable if it doesn't exist, or overwrites if it does.
+ * Requires Full Administration rights on the application.
+ *
+ * @see https://help.quickbase.com/docs/api-setdbvar
+ *
+ * @example
+ * ```typescript
+ * await setDBVar(caller, 'bqapp123', 'myVariable', '42');
+ * ```
+ */
+export async function setDBVar(caller, appId, varName, value) {
+    const inner = `<varname>${escapeXml(varName)}</varname>` +
+        `<value>${escapeXml(value)}</value>`;
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(appId, 'API_SetDBVar', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+}
+//# sourceMappingURL=dbvars.js.map

package/dist/xml/dbvars.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbvars.js","sourceRoot":"","sources":["../../src/xml/dbvars.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EACL,YAAY,EACZ,SAAS,EACT,iBAAiB,EACjB,aAAa,GACd,MAAM,cAAc,CAAC;AAEtB;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,MAAiB,EACjB,KAAa,EACb,OAAe;IAEf,MAAM,KAAK,GAAG,YAAY,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC;IACzD,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAE5D,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEjB,OAAO,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,MAAiB,EACjB,KAAa,EACb,OAAe,EACf,KAAa;IAEb,MAAM,KAAK,GACT,YAAY,SAAS,CAAC,OAAO,CAAC,YAAY;QAC1C,UAAU,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;IACvC,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAE5D,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;AACnB,CAAC"}

package/dist/xml/errors.d.ts

@@ -0,0 +1,64 @@
+/**
+ * XML API Errors
+ *
+ * Error handling 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
+ */
+import type { BaseResponse } from './types.js';
+/**
+ * Common QuickBase XML API error codes
+ */
+export declare const XmlErrorCode: {
+    /** No error (success) */
+    readonly Success: 0;
+    /** User is not authorized for this action */
+    readonly Unauthorized: 4;
+    /** Invalid input parameters */
+    readonly InvalidInput: 5;
+    /** Database/table does not exist */
+    readonly NoSuchDatabase: 6;
+    /** Access to the resource is denied */
+    readonly AccessDenied: 7;
+    /** Authentication ticket is invalid or expired */
+    readonly InvalidTicket: 8;
+    /** Record does not exist */
+    readonly NoSuchRecord: 30;
+    /** Field does not exist */
+    readonly NoSuchField: 31;
+    /** User does not exist */
+    readonly NoSuchUser: 33;
+};
+/**
+ * Error returned by the QuickBase XML API
+ */
+export declare class XmlError extends Error {
+    readonly code: number;
+    readonly text: string;
+    readonly detail?: string;
+    readonly action?: string;
+    constructor(code: number, text: string, detail?: string, action?: string);
+}
+/**
+ * Check if the response contains an error and throw if so.
+ * Returns void if successful (errcode === 0).
+ */
+export declare function checkError(resp: BaseResponse): void;
+/**
+ * Check if the error is an authorization error (code 4 or 7)
+ */
+export declare function isUnauthorized(err: unknown): boolean;
+/**
+ * Check if the error indicates a resource was not found
+ */
+export declare function isNotFound(err: unknown): boolean;
+/**
+ * Check if the error indicates an invalid or expired authentication ticket
+ */
+export declare function isInvalidTicket(err: unknown): boolean;
+/**
+ * Check if the error indicates invalid input parameters
+ */
+export declare function isInvalidInput(err: unknown): boolean;
+//# sourceMappingURL=errors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/xml/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,YAAY;IACvB,yBAAyB;;IAEzB,6CAA6C;;IAE7C,+BAA+B;;IAE/B,oCAAoC;;IAEpC,uCAAuC;;IAEvC,kDAAkD;;IAElD,4BAA4B;;IAE5B,2BAA2B;;IAE3B,0BAA0B;;CAElB,CAAC;AAEX;;GAEG;AACH,qBAAa,QAAS,SAAQ,KAAK;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEb,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;CAWzE;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI,CAKnD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAQpD;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAUhD;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAKrD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAKpD"}

package/dist/xml/errors.js

@@ -0,0 +1,102 @@
+/**
+ * XML API Errors
+ *
+ * Error handling 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
+ */
+/**
+ * Common QuickBase XML API error codes
+ */
+export const XmlErrorCode = {
+    /** No error (success) */
+    Success: 0,
+    /** User is not authorized for this action */
+    Unauthorized: 4,
+    /** Invalid input parameters */
+    InvalidInput: 5,
+    /** Database/table does not exist */
+    NoSuchDatabase: 6,
+    /** Access to the resource is denied */
+    AccessDenied: 7,
+    /** Authentication ticket is invalid or expired */
+    InvalidTicket: 8,
+    /** Record does not exist */
+    NoSuchRecord: 30,
+    /** Field does not exist */
+    NoSuchField: 31,
+    /** User does not exist */
+    NoSuchUser: 33,
+};
+/**
+ * Error returned by the QuickBase XML API
+ */
+export class XmlError extends Error {
+    code;
+    text;
+    detail;
+    action;
+    constructor(code, text, detail, action) {
+        const msg = detail
+            ? `XML API error ${code}: ${text} (${detail})`
+            : `XML API error ${code}: ${text}`;
+        super(msg);
+        this.name = 'XmlError';
+        this.code = code;
+        this.text = text;
+        this.detail = detail;
+        this.action = action;
+    }
+}
+/**
+ * Check if the response contains an error and throw if so.
+ * Returns void if successful (errcode === 0).
+ */
+export function checkError(resp) {
+    if (resp.errcode === 0) {
+        return;
+    }
+    throw new XmlError(resp.errcode, resp.errtext, resp.errdetail, resp.action);
+}
+/**
+ * Check if the error is an authorization error (code 4 or 7)
+ */
+export function isUnauthorized(err) {
+    if (err instanceof XmlError) {
+        return (err.code === XmlErrorCode.Unauthorized ||
+            err.code === XmlErrorCode.AccessDenied);
+    }
+    return false;
+}
+/**
+ * Check if the error indicates a resource was not found
+ */
+export function isNotFound(err) {
+    if (err instanceof XmlError) {
+        return (err.code === XmlErrorCode.NoSuchDatabase ||
+            err.code === XmlErrorCode.NoSuchRecord ||
+            err.code === XmlErrorCode.NoSuchField ||
+            err.code === XmlErrorCode.NoSuchUser);
+    }
+    return false;
+}
+/**
+ * Check if the error indicates an invalid or expired authentication ticket
+ */
+export function isInvalidTicket(err) {
+    if (err instanceof XmlError) {
+        return err.code === XmlErrorCode.InvalidTicket;
+    }
+    return false;
+}
+/**
+ * Check if the error indicates invalid input parameters
+ */
+export function isInvalidInput(err) {
+    if (err instanceof XmlError) {
+        return err.code === XmlErrorCode.InvalidInput;
+    }
+    return false;
+}
+//# sourceMappingURL=errors.js.map

package/dist/xml/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/xml/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,yBAAyB;IACzB,OAAO,EAAE,CAAC;IACV,6CAA6C;IAC7C,YAAY,EAAE,CAAC;IACf,+BAA+B;IAC/B,YAAY,EAAE,CAAC;IACf,oCAAoC;IACpC,cAAc,EAAE,CAAC;IACjB,uCAAuC;IACvC,YAAY,EAAE,CAAC;IACf,kDAAkD;IAClD,aAAa,EAAE,CAAC;IAChB,4BAA4B;IAC5B,YAAY,EAAE,EAAE;IAChB,2BAA2B;IAC3B,WAAW,EAAE,EAAE;IACf,0BAA0B;IAC1B,UAAU,EAAE,EAAE;CACN,CAAC;AAEX;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,KAAK;IACxB,IAAI,CAAS;IACb,IAAI,CAAS;IACb,MAAM,CAAU;IAChB,MAAM,CAAU;IAEzB,YAAY,IAAY,EAAE,IAAY,EAAE,MAAe,EAAE,MAAe;QACtE,MAAM,GAAG,GAAG,MAAM;YAChB,CAAC,CAAC,iBAAiB,IAAI,KAAK,IAAI,KAAK,MAAM,GAAG;YAC9C,CAAC,CAAC,iBAAiB,IAAI,KAAK,IAAI,EAAE,CAAC;QACrC,KAAK,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,IAAkB;IAC3C,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IACD,MAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;AAC9E,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,GAAY;IACzC,IAAI,GAAG,YAAY,QAAQ,EAAE,CAAC;QAC5B,OAAO,CACL,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,YAAY;YACtC,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,YAAY,CACvC,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,GAAY;IACrC,IAAI,GAAG,YAAY,QAAQ,EAAE,CAAC;QAC5B,OAAO,CACL,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,cAAc;YACxC,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,YAAY;YACtC,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,WAAW;YACrC,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,UAAU,CACrC,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,GAAY;IAC1C,IAAI,GAAG,YAAY,QAAQ,EAAE,CAAC;QAC5B,OAAO,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,aAAa,CAAC;IACjD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,GAAY;IACzC,IAAI,GAAG,YAAY,QAAQ,EAAE,CAAC;QAC5B,OAAO,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,YAAY,CAAC;IAChD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/xml/fields.d.ts

@@ -0,0 +1,45 @@
+/**
+ * XML API Field Management
+ *
+ * Endpoints for managing field properties.
+ *
+ * XML-API: Remove this file when QuickBase discontinues the XML API.
+ * To find all XML API code, search for: XML-API
+ */
+import type { XmlCaller, FieldAddChoicesResult, FieldRemoveChoicesResult } from './types.js';
+/**
+ * Add choices to a multiple-choice field.
+ *
+ * @see https://help.quickbase.com/docs/api-fieldaddchoices
+ *
+ * @example
+ * ```typescript
+ * const result = await fieldAddChoices(caller, 'bqtable123', 6, ['Option A', 'Option B']);
+ * console.log(`Added ${result.numAdded} choices`);
+ * ```
+ */
+export declare function fieldAddChoices(caller: XmlCaller, tableId: string, fieldId: number, choices: string[]): Promise<FieldAddChoicesResult>;
+/**
+ * Remove choices from a multiple-choice field.
+ *
+ * @see https://help.quickbase.com/docs/api-fieldremovechoices
+ *
+ * @example
+ * ```typescript
+ * const result = await fieldRemoveChoices(caller, 'bqtable123', 6, ['Option A']);
+ * console.log(`Removed ${result.numRemoved} choices`);
+ * ```
+ */
+export declare function fieldRemoveChoices(caller: XmlCaller, tableId: string, fieldId: number, choices: string[]): Promise<FieldRemoveChoicesResult>;
+/**
+ * Set the key field for a table.
+ *
+ * @see https://help.quickbase.com/docs/api-setkeyfield
+ *
+ * @example
+ * ```typescript
+ * await setKeyField(caller, 'bqtable123', 6);
+ * ```
+ */
+export declare function setKeyField(caller: XmlCaller, tableId: string, fieldId: number): Promise<void>;
+//# sourceMappingURL=fields.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../src/xml/fields.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,SAAS,EACT,qBAAqB,EACrB,wBAAwB,EACzB,MAAM,YAAY,CAAC;AAUpB;;;;;;;;;;GAUG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,qBAAqB,CAAC,CAoBhC;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,CAoBnC;AAED;;;;;;;;;GASG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CAOf"}

package/dist/xml/fields.js

@@ -0,0 +1,86 @@
+/**
+ * XML API Field Management
+ *
+ * Endpoints for managing field properties.
+ *
+ * XML-API: Remove this file when QuickBase discontinues the XML API.
+ * To find all XML API code, search for: XML-API
+ */
+import { checkError } from './errors.js';
+import { buildRequest, escapeXml, parseBaseResponse, getTagContent, parseXmlNumber, } from './request.js';
+/**
+ * Add choices to a multiple-choice field.
+ *
+ * @see https://help.quickbase.com/docs/api-fieldaddchoices
+ *
+ * @example
+ * ```typescript
+ * const result = await fieldAddChoices(caller, 'bqtable123', 6, ['Option A', 'Option B']);
+ * console.log(`Added ${result.numAdded} choices`);
+ * ```
+ */
+export async function fieldAddChoices(caller, tableId, fieldId, choices) {
+    if (choices.length === 0) {
+        throw new Error('choices array cannot be empty');
+    }
+    let inner = `<fid>${fieldId}</fid>`;
+    for (const choice of choices) {
+        inner += `<choice>${escapeXml(choice)}</choice>`;
+    }
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(tableId, 'API_FieldAddChoices', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+    return {
+        fieldId,
+        fieldName: getTagContent(xml, 'fname') || '',
+        numAdded: parseXmlNumber(getTagContent(xml, 'numadded')),
+    };
+}
+/**
+ * Remove choices from a multiple-choice field.
+ *
+ * @see https://help.quickbase.com/docs/api-fieldremovechoices
+ *
+ * @example
+ * ```typescript
+ * const result = await fieldRemoveChoices(caller, 'bqtable123', 6, ['Option A']);
+ * console.log(`Removed ${result.numRemoved} choices`);
+ * ```
+ */
+export async function fieldRemoveChoices(caller, tableId, fieldId, choices) {
+    if (choices.length === 0) {
+        throw new Error('choices array cannot be empty');
+    }
+    let inner = `<fid>${fieldId}</fid>`;
+    for (const choice of choices) {
+        inner += `<choice>${escapeXml(choice)}</choice>`;
+    }
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(tableId, 'API_FieldRemoveChoices', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+    return {
+        fieldId,
+        fieldName: getTagContent(xml, 'fname') || '',
+        numRemoved: parseXmlNumber(getTagContent(xml, 'numremoved')),
+    };
+}
+/**
+ * Set the key field for a table.
+ *
+ * @see https://help.quickbase.com/docs/api-setkeyfield
+ *
+ * @example
+ * ```typescript
+ * await setKeyField(caller, 'bqtable123', 6);
+ * ```
+ */
+export async function setKeyField(caller, tableId, fieldId) {
+    const inner = `<fid>${fieldId}</fid>`;
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(tableId, 'API_SetKeyField', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+}
+//# sourceMappingURL=fields.js.map

package/dist/xml/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../src/xml/fields.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAOH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EACL,YAAY,EACZ,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,cAAc,GACf,MAAM,cAAc,CAAC;AAEtB;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAiB,EACjB,OAAe,EACf,OAAe,EACf,OAAiB;IAEjB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,KAAK,GAAG,QAAQ,OAAO,QAAQ,CAAC;IACpC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,KAAK,IAAI,WAAW,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC;IACnD,CAAC;IAED,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,CAAC,CAAC;IAErE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEjB,OAAO;QACL,OAAO;QACP,SAAS,EAAE,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE;QAC5C,QAAQ,EAAE,cAAc,CAAC,aAAa,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;KACzD,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAiB,EACjB,OAAe,EACf,OAAe,EACf,OAAiB;IAEjB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,KAAK,GAAG,QAAQ,OAAO,QAAQ,CAAC;IACpC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,KAAK,IAAI,WAAW,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC;IACnD,CAAC;IAED,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,wBAAwB,EAAE,IAAI,CAAC,CAAC;IAExE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEjB,OAAO;QACL,OAAO;QACP,SAAS,EAAE,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE;QAC5C,UAAU,EAAE,cAAc,CAAC,aAAa,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;KAC7D,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAiB,EACjB,OAAe,EACf,OAAe;IAEf,MAAM,KAAK,GAAG,QAAQ,OAAO,QAAQ,CAAC;IACtC,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAEjE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;AACnB,CAAC"}