quickbase-js 2.1.0 → 2.2.1

package/dist/xml/transform.js

@@ -0,0 +1,182 @@
+/**
+ * XML API Response Transformation
+ *
+ * Transforms XML API responses to use field and table aliases as keys
+ * when a schema is configured, similar to the JSON API transformation.
+ *
+ * Without schema: record.fields is an array accessed by index or id
+ * With schema: record.fields is keyed by alias (e.g., record.fields.name)
+ *
+ * XML-API: Remove this file when QuickBase discontinues the XML API.
+ * To find all XML API code, search for: XML-API
+ */
+import { getFieldAlias, getTableAlias } from '../core/schema.js';
+// =============================================================================
+// Transformation Functions
+// =============================================================================
+/**
+ * Convert a fields array to a keyed object.
+ * Keys are field aliases (if in schema) or field IDs (as strings).
+ */
+function fieldsArrayToMap(fields, schema, tableId) {
+    const result = {};
+    for (const field of fields) {
+        const alias = schema ? getFieldAlias(schema, tableId, field.id) : undefined;
+        const key = alias ?? String(field.id);
+        result[key] = alias ? { ...field, alias } : field;
+    }
+    return result;
+}
+/**
+ * Convert a databases array to a keyed object.
+ * Keys are table aliases (if in schema) or dbids.
+ */
+function databasesArrayToMap(databases, schema) {
+    const result = {};
+    for (const db of databases) {
+        const alias = schema ? getTableAlias(schema, db.dbid) : undefined;
+        const key = alias ?? db.dbid;
+        result[key] = alias ? { ...db, alias } : db;
+    }
+    return result;
+}
+/**
+ * Convert a tables array to a keyed object.
+ * Keys are table aliases (if in schema) or table IDs.
+ */
+function tablesArrayToMap(tables, schema) {
+    const result = {};
+    for (const table of tables) {
+        const alias = schema ? getTableAlias(schema, table.id) : undefined;
+        const key = alias ?? table.id;
+        result[key] = alias ? { ...table, alias } : table;
+    }
+    return result;
+}
+/**
+ * Transform a SchemaField to include extra alias properties
+ */
+function transformSchemaFieldAliases(field, schema, tableId) {
+    const result = { ...field };
+    const alias = getFieldAlias(schema, tableId, field.id);
+    if (alias)
+        result.alias = alias;
+    if (field.summaryReferenceFid !== undefined) {
+        const refAlias = getFieldAlias(schema, tableId, field.summaryReferenceFid);
+        if (refAlias)
+            result.summaryReferenceFidAlias = refAlias;
+    }
+    if (field.summaryTargetFid !== undefined) {
+        const targetAlias = getFieldAlias(schema, tableId, field.summaryTargetFid);
+        if (targetAlias)
+            result.summaryTargetFidAlias = targetAlias;
+    }
+    return result;
+}
+/**
+ * Transform GetRecordInfoResult to key fields by alias.
+ * Access: result.fields.name.value (instead of result.fields[0].value)
+ */
+export function transformGetRecordInfoResult(result, schema, tableId) {
+    return {
+        ...result,
+        fields: fieldsArrayToMap(result.fields, schema, tableId),
+    };
+}
+/**
+ * Transform GetSchemaResult to key fields and child tables by alias.
+ * Access: result.table.fields.name, result.table.childTables.tasks
+ */
+export function transformGetSchemaResult(result, schema, tableId) {
+    const transformedTable = {
+        ...result.table,
+        fields: undefined,
+        childTables: undefined,
+    };
+    // Transform fields to keyed object with extra alias properties
+    if (result.table.fields) {
+        const fieldsMap = {};
+        for (const field of result.table.fields) {
+            const transformed = schema
+                ? transformSchemaFieldAliases(field, schema, tableId)
+                : field;
+            const alias = schema ? getFieldAlias(schema, tableId, field.id) : undefined;
+            const key = alias ?? String(field.id);
+            fieldsMap[key] = alias ? { ...transformed, alias } : transformed;
+        }
+        transformedTable.fields = fieldsMap;
+    }
+    // Transform child tables to keyed object
+    if (result.table.childTables) {
+        const childTablesMap = {};
+        for (const ct of result.table.childTables) {
+            const alias = schema ? getTableAlias(schema, ct.dbid) : undefined;
+            const key = alias ?? ct.dbid;
+            childTablesMap[key] = alias ? { ...ct, alias } : ct;
+        }
+        transformedTable.childTables = childTablesMap;
+    }
+    return {
+        ...result,
+        table: transformedTable,
+    };
+}
+/**
+ * Transform FieldAddChoicesResult to include field alias
+ */
+export function transformFieldAddChoicesResult(result, schema, tableId) {
+    if (!schema)
+        return result;
+    const alias = getFieldAlias(schema, tableId, result.fieldId);
+    return alias ? { ...result, fieldAlias: alias } : result;
+}
+/**
+ * Transform FieldRemoveChoicesResult to include field alias
+ */
+export function transformFieldRemoveChoicesResult(result, schema, tableId) {
+    if (!schema)
+        return result;
+    const alias = getFieldAlias(schema, tableId, result.fieldId);
+    return alias ? { ...result, fieldAlias: alias } : result;
+}
+/**
+ * Transform GrantedDBsResult to key databases by alias.
+ * Access: result.databases.projects.dbname
+ */
+export function transformGrantedDBsResult(result, schema) {
+    return {
+        ...result,
+        databases: databasesArrayToMap(result.databases, schema),
+    };
+}
+/**
+ * Transform GrantedDBsForGroupResult to key databases by alias.
+ */
+export function transformGrantedDBsForGroupResult(result, schema) {
+    return {
+        ...result,
+        databases: databasesArrayToMap(result.databases, schema),
+    };
+}
+/**
+ * Transform GetAppDTMInfoResult to key tables by alias.
+ * Access: result.tables.projects.lastModifiedTime
+ */
+export function transformGetAppDTMInfoResult(result, schema) {
+    const appAlias = schema ? getTableAlias(schema, result.appId) : undefined;
+    return {
+        ...result,
+        appAlias,
+        tables: tablesArrayToMap(result.tables, schema),
+    };
+}
+/**
+ * Transform FindDBByNameResult to include table alias
+ */
+export function transformFindDBByNameResult(result, schema) {
+    if (!schema)
+        return result;
+    const alias = getTableAlias(schema, result.dbid);
+    return alias ? { ...result, alias } : result;
+}
+//# sourceMappingURL=transform.js.map

package/dist/xml/transform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.js","sourceRoot":"","sources":["../../src/xml/transform.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAGH,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAsIjE,gFAAgF;AAChF,2BAA2B;AAC3B,gFAAgF;AAEhF;;;GAGG;AACH,SAAS,gBAAgB,CACvB,MAAW,EACX,MAAkC,EAClC,OAAe;IAEf,MAAM,MAAM,GAA2C,EAAE,CAAC;IAE1D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5E,MAAM,GAAG,GAAG,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACtC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IACpD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAC1B,SAAc,EACd,MAAkC;IAElC,MAAM,MAAM,GAA2C,EAAE,CAAC;IAE1D,KAAK,MAAM,EAAE,IAAI,SAAS,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC;QAC7B,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9C,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB,CACvB,MAAW,EACX,MAAkC;IAElC,MAAM,MAAM,GAA2C,EAAE,CAAC;IAE1D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACnE,MAAM,GAAG,GAAG,KAAK,IAAI,KAAK,CAAC,EAAE,CAAC;QAC9B,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IACpD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAS,2BAA2B,CAClC,KAAkB,EAClB,MAAsB,EACtB,OAAe;IAEf,MAAM,MAAM,GAAyB,EAAE,GAAG,KAAK,EAAE,CAAC;IAElD,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;IACvD,IAAI,KAAK;QAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;IAEhC,IAAI,KAAK,CAAC,mBAAmB,KAAK,SAAS,EAAE,CAAC;QAC5C,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAC3E,IAAI,QAAQ;YAAE,MAAM,CAAC,wBAAwB,GAAG,QAAQ,CAAC;IAC3D,CAAC;IAED,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACzC,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAC3E,IAAI,WAAW;YAAE,MAAM,CAAC,qBAAqB,GAAG,WAAW,CAAC;IAC9D,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,4BAA4B,CAC1C,MAA2B,EAC3B,MAAkC,EAClC,OAAe;IAEf,OAAO;QACL,GAAG,MAAM;QACT,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;KACzD,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CACtC,MAAuB,EACvB,MAAkC,EAClC,OAAe;IAEf,MAAM,gBAAgB,GAAsC;QAC1D,GAAG,MAAM,CAAC,KAAK;QACf,MAAM,EAAE,SAAS;QACjB,WAAW,EAAE,SAAS;KACvB,CAAC;IAEF,+DAA+D;IAC/D,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QACxB,MAAM,SAAS,GAAyC,EAAE,CAAC;QAC3D,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACxC,MAAM,WAAW,GAAG,MAAM;gBACxB,CAAC,CAAC,2BAA2B,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC;gBACrD,CAAC,CAAC,KAAK,CAAC;YACV,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,MAAM,GAAG,GAAG,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACtC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;QACnE,CAAC;QACD,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC;IACtC,CAAC;IAED,yCAAyC;IACzC,IAAI,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAC7B,MAAM,cAAc,GAA8C,EAAE,CAAC;QACrE,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC;YAC7B,cAAc,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,CAAC;QACD,gBAAgB,CAAC,WAAW,GAAG,cAAc,CAAC;IAChD,CAAC;IAED,OAAO;QACL,GAAG,MAAM;QACT,KAAK,EAAE,gBAAgB;KACxB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAC5C,MAA6B,EAC7B,MAAkC,EAClC,OAAe;IAEf,IAAI,CAAC,MAAM;QAAE,OAAO,MAAM,CAAC;IAE3B,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAC7D,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;AAC3D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iCAAiC,CAC/C,MAAgC,EAChC,MAAkC,EAClC,OAAe;IAEf,IAAI,CAAC,MAAM;QAAE,OAAO,MAAM,CAAC;IAE3B,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAC7D,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;AAC3D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CACvC,MAAwB,EACxB,MAAkC;IAElC,OAAO;QACL,GAAG,MAAM;QACT,SAAS,EAAE,mBAAmB,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC;KACzD,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iCAAiC,CAC/C,MAAgC,EAChC,MAAkC;IAElC,OAAO;QACL,GAAG,MAAM;QACT,SAAS,EAAE,mBAAmB,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC;KACzD,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,4BAA4B,CAC1C,MAA2B,EAC3B,MAAkC;IAElC,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE1E,OAAO;QACL,GAAG,MAAM;QACT,QAAQ;QACR,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;KAChD,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,2BAA2B,CACzC,MAA0B,EAC1B,MAAkC;IAElC,IAAI,CAAC,MAAM;QAAE,OAAO,MAAM,CAAC;IAE3B,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACjD,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;AAC/C,CAAC"}