@proofkit/fmodata 0.1.0-alpha.3 → 0.1.0-alpha.6

package/dist/esm/client/query-builder.js

@@ -3,6 +3,8 @@ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { en
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 import buildQuery from "odata-query";
 import { validateSingleResponse, validateListResponse } from "../validation.js";
+import { RecordCountMismatchError } from "../errors.js";
+import { transformTableName, transformFieldName, transformOrderByField, transformFieldNamesArray, transformResponseFields } from "../transform.js";
 class QueryBuilder {
   constructor(config) {
     __publicField(this, "queryOptions", {});
@@ -33,6 +35,12 @@ class QueryBuilder {
     const { "@id": _id, "@editLink": _editLink, ...rest } = data;
     return rest;
   }
+  /**
+   * Gets the table ID (FMTID) if using entity IDs, otherwise returns the table name
+   */
+  getTableId() {
+    return this.occurrence ? transformTableName(this.occurrence) : this.tableName;
+  }
   select(...fields) {
     const uniqueFields = [...new Set(fields)];
     const newBuilder = new QueryBuilder({
@@ -62,6 +70,7 @@ class QueryBuilder {
    * - Shorthand values are handled by odata-query
    */
   transformFilter(filter) {
+    var _a;
     if (typeof filter === "string") {
       return filter;
     }
@@ -84,12 +93,13 @@ class QueryBuilder {
     const result = {};
     const andConditions = [];
     for (const [field, value] of Object.entries(filter)) {
+      const fieldId = ((_a = this.occurrence) == null ? void 0 : _a.baseTable) ? transformFieldName(field, this.occurrence.baseTable) : field;
       if (Array.isArray(value)) {
         if (value.length === 1) {
-          result[field] = value[0];
+          result[fieldId] = value[0];
         } else {
           for (const op of value) {
-            andConditions.push({ [field]: op });
+            andConditions.push({ [fieldId]: op });
           }
         }
       } else if (value && typeof value === "object" && !(value instanceof Date) && !Array.isArray(value)) {
@@ -107,12 +117,12 @@ class QueryBuilder {
         ];
         const isOperatorObject = operatorKeys.some((key) => key in value);
         if (isOperatorObject) {
-          result[field] = value;
+          result[fieldId] = value;
         } else {
-          result[field] = value;
+          result[fieldId] = value;
         }
       } else {
-        result[field] = value;
+        result[fieldId] = value;
       }
     }
     if (andConditions.length > 0) {
@@ -129,7 +139,21 @@ class QueryBuilder {
     return this;
   }
   orderBy(orderBy) {
-    this.queryOptions.orderBy = orderBy;
+    var _a;
+    if (((_a = this.occurrence) == null ? void 0 : _a.baseTable) && orderBy) {
+      if (Array.isArray(orderBy)) {
+        this.queryOptions.orderBy = orderBy.map(
+          (field) => transformOrderByField(String(field), this.occurrence.baseTable)
+        );
+      } else {
+        this.queryOptions.orderBy = transformOrderByField(
+          String(orderBy),
+          this.occurrence.baseTable
+        );
+      }
+    } else {
+      this.queryOptions.orderBy = orderBy;
+    }
     return this;
   }
   top(count) {
@@ -142,13 +166,18 @@ class QueryBuilder {
   }
   /**
    * Formats select fields for use in query strings.
+   * - Transforms field names to FMFIDs if using entity IDs
    * - Wraps "id" fields in double quotes
    * - URL-encodes special characters but preserves spaces
    */
-  formatSelectFields(select) {
+  formatSelectFields(select, baseTable) {
     if (!select) return "";
     const selectFieldsArray = Array.isArray(select) ? select : [select];
-    return selectFieldsArray.map((field) => {
+    const transformedFields = baseTable ? transformFieldNamesArray(
+      selectFieldsArray.map((f) => String(f)),
+      baseTable
+    ) : selectFieldsArray.map((f) => String(f));
+    return transformedFields.map((field) => {
       if (field === "id") return `"id"`;
       const encodedField = encodeURIComponent(String(field));
       return encodedField.replace(/%20/g, " ");
@@ -168,6 +197,9 @@ class QueryBuilder {
         relation: config.relation,
         targetSchema,
         targetOccurrence,
+        targetBaseTable: targetOccurrence == null ? void 0 : targetOccurrence.baseTable,
+        occurrence: targetOccurrence,
+        // Add occurrence for transformation
         selectedFields,
         nestedExpands: void 0
         // TODO: Handle nested expands if needed
@@ -177,18 +209,25 @@ class QueryBuilder {
   /**
    * Builds OData expand query string from expand configurations.
    * Handles nested expands recursively.
+   * Transforms relation names to FMTIDs if using entity IDs.
    */
   buildExpandString(configs) {
     if (configs.length === 0) {
       return "";
     }
     return configs.map((config) => {
+      var _a;
+      const targetOccurrence = (_a = this.occurrence) == null ? void 0 : _a.navigation[config.relation];
+      const relationName = targetOccurrence && targetOccurrence.isUsingTableId() ? targetOccurrence.getTableId() : config.relation;
       if (!config.options || Object.keys(config.options).length === 0) {
-        return config.relation;
+        return relationName;
       }
       const parts = [];
       if (config.options.select) {
-        const selectFields = this.formatSelectFields(config.options.select);
+        const selectFields = this.formatSelectFields(
+          config.options.select,
+          targetOccurrence == null ? void 0 : targetOccurrence.baseTable
+        );
         parts.push(`$select=${selectFields}`);
       }
       if (config.options.filter) {
@@ -214,9 +253,9 @@ class QueryBuilder {
         }
       }
       if (parts.length === 0) {
-        return config.relation;
+        return relationName;
       }
-      return `${config.relation}(${parts.join(";")})`;
+      return `${relationName}(${parts.join(";")})`;
     }).join(",");
   }
   expand(relation, callback) {
@@ -307,200 +346,141 @@ class QueryBuilder {
     return newBuilder;
   }
   async execute(options) {
-    var _a, _b, _c, _d, _e, _f;
-    try {
-      const queryOptionsWithoutExpand = { ...this.queryOptions };
-      delete queryOptionsWithoutExpand.expand;
-      if (queryOptionsWithoutExpand.select) {
-        queryOptionsWithoutExpand.select = this.formatSelectFields(
-          queryOptionsWithoutExpand.select
-        );
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
+    const queryOptionsWithoutExpand = { ...this.queryOptions };
+    delete queryOptionsWithoutExpand.expand;
+    if (queryOptionsWithoutExpand.select) {
+      queryOptionsWithoutExpand.select = this.formatSelectFields(
+        queryOptionsWithoutExpand.select,
+        (_a = this.occurrence) == null ? void 0 : _a.baseTable
+      );
+    }
+    let queryString = buildQuery(queryOptionsWithoutExpand);
+    const expandString = this.buildExpandString(this.expandConfigs);
+    if (expandString) {
+      const separator = queryString.includes("?") ? "&" : "?";
+      queryString = `${queryString}${separator}$expand=${expandString}`;
+    }
+    if (this.isNavigate && this.navigateRecordId && this.navigateRelation && this.navigateSourceTableName) {
+      let url;
+      if (this.navigateBaseRelation) {
+        url = `/${this.databaseName}/${this.navigateSourceTableName}/${this.navigateBaseRelation}('${this.navigateRecordId}')/${this.navigateRelation}${queryString}`;
+      } else {
+        url = `/${this.databaseName}/${this.navigateSourceTableName}('${this.navigateRecordId}')/${this.navigateRelation}${queryString}`;
       }
-      let queryString = buildQuery(queryOptionsWithoutExpand);
-      const expandString = this.buildExpandString(this.expandConfigs);
-      if (expandString) {
-        const separator = queryString.includes("?") ? "&" : "?";
-        queryString = `${queryString}${separator}$expand=${expandString}`;
+      const result2 = await this.context._makeRequest(url, options);
+      if (result2.error) {
+        return { data: void 0, error: result2.error };
       }
-      if (this.isNavigate && this.navigateRecordId && this.navigateRelation && this.navigateSourceTableName) {
-        let url;
-        if (this.navigateBaseRelation) {
-          url = `/${this.databaseName}/${this.navigateSourceTableName}/${this.navigateBaseRelation}('${this.navigateRecordId}')/${this.navigateRelation}${queryString}`;
-        } else {
-          url = `/${this.databaseName}/${this.navigateSourceTableName}('${this.navigateRecordId}')/${this.navigateRelation}${queryString}`;
-        }
-        const response2 = await this.context._makeRequest(url, options);
-        if ((options == null ? void 0 : options.skipValidation) === true) {
-          const resp = response2;
-          if (this.singleMode !== false) {
-            const records = resp.value ?? [resp];
-            const count = Array.isArray(records) ? records.length : 1;
-            if (count > 1) {
-              return {
-                data: void 0,
-                error: new Error(
-                  `Expected ${this.singleMode === "exact" ? "exactly one" : "at most one"} record, but received ${count}`
-                )
-              };
-            }
-            if (count === 0) {
-              if (this.singleMode === "exact") {
-                return {
-                  data: void 0,
-                  error: new Error(
-                    "Expected exactly one record, but received none"
-                  )
-                };
-              }
-              return { data: null, error: void 0 };
-            }
-            const record = Array.isArray(records) ? records[0] : records;
-            const stripped = this.stripODataAnnotationsIfNeeded(
-              record,
-              options
-            );
-            return { data: stripped, error: void 0 };
-          } else {
-            const records = resp.value ?? [];
-            const stripped = records.map(
-              (record) => this.stripODataAnnotationsIfNeeded(record, options)
-            );
-            return { data: stripped, error: void 0 };
-          }
-        }
-        const schema2 = (_b = (_a = this.occurrence) == null ? void 0 : _a.baseTable) == null ? void 0 : _b.schema;
-        const selectedFields2 = this.queryOptions.select;
-        const expandValidationConfigs2 = this.buildExpandValidationConfigs(
+      let response2 = result2.data;
+      if ((_b = this.occurrence) == null ? void 0 : _b.baseTable) {
+        const expandValidationConfigs3 = this.buildExpandValidationConfigs(
           this.expandConfigs
         );
+        response2 = transformResponseFields(
+          response2,
+          this.occurrence.baseTable,
+          expandValidationConfigs3
+        );
+      }
+      if ((options == null ? void 0 : options.skipValidation) === true) {
+        const resp = response2;
         if (this.singleMode !== false) {
-          const validation = await validateSingleResponse(
-            response2,
-            schema2,
-            selectedFields2,
-            expandValidationConfigs2,
-            this.singleMode
-          );
-          if (!validation.valid) {
-            return { data: void 0, error: validation.error };
-          }
-          const stripped = validation.data ? this.stripODataAnnotationsIfNeeded(validation.data, options) : null;
-          return { data: stripped, error: void 0 };
-        } else {
-          const validation = await validateListResponse(
-            response2,
-            schema2,
-            selectedFields2,
-            expandValidationConfigs2
-          );
-          if (!validation.valid) {
-            return { data: void 0, error: validation.error };
+          const records = resp.value ?? [resp];
+          const count = Array.isArray(records) ? records.length : 1;
+          if (count > 1) {
+            return {
+              data: void 0,
+              error: new RecordCountMismatchError(
+                this.singleMode === "exact" ? "one" : "at-most-one",
+                count
+              )
+            };
           }
-          const stripped = validation.data.map(
-            (record) => this.stripODataAnnotationsIfNeeded(record, options)
-          );
-          return { data: stripped, error: void 0 };
-        }
-      }
-      if (this.isNavigate && !this.navigateRecordId && this.navigateRelation && this.navigateSourceTableName) {
-        const response2 = await this.context._makeRequest(
-          `/${this.databaseName}/${this.navigateSourceTableName}/${this.navigateRelation}${queryString}`,
-          options
-        );
-        if ((options == null ? void 0 : options.skipValidation) === true) {
-          const resp = response2;
-          if (this.singleMode !== false) {
-            const records = resp.value ?? [resp];
-            const count = Array.isArray(records) ? records.length : 1;
-            if (count > 1) {
+          if (count === 0) {
+            if (this.singleMode === "exact") {
               return {
                 data: void 0,
-                error: new Error(
-                  `Expected ${this.singleMode === "exact" ? "exactly one" : "at most one"} record, but received ${count}`
-                )
+                error: new RecordCountMismatchError("one", 0)
               };
             }
-            if (count === 0) {
-              if (this.singleMode === "exact") {
-                return {
-                  data: void 0,
-                  error: new Error(
-                    "Expected exactly one record, but received none"
-                  )
-                };
-              }
-              return { data: null, error: void 0 };
-            }
-            const record = Array.isArray(records) ? records[0] : records;
-            const stripped = this.stripODataAnnotationsIfNeeded(
-              record,
-              options
-            );
-            return { data: stripped, error: void 0 };
-          } else {
-            const records = resp.value ?? [];
-            const stripped = records.map(
-              (record) => this.stripODataAnnotationsIfNeeded(record, options)
-            );
-            return { data: stripped, error: void 0 };
-          }
-        }
-        const schema2 = (_d = (_c = this.occurrence) == null ? void 0 : _c.baseTable) == null ? void 0 : _d.schema;
-        const selectedFields2 = this.queryOptions.select;
-        const expandValidationConfigs2 = this.buildExpandValidationConfigs(
-          this.expandConfigs
-        );
-        if (this.singleMode !== false) {
-          const validation = await validateSingleResponse(
-            response2,
-            schema2,
-            selectedFields2,
-            expandValidationConfigs2,
-            this.singleMode
-          );
-          if (!validation.valid) {
-            return { data: void 0, error: validation.error };
+            return { data: null, error: void 0 };
           }
-          const stripped = validation.data ? this.stripODataAnnotationsIfNeeded(validation.data, options) : null;
+          const record = Array.isArray(records) ? records[0] : records;
+          const stripped = this.stripODataAnnotationsIfNeeded(record, options);
           return { data: stripped, error: void 0 };
         } else {
-          const validation = await validateListResponse(
-            response2,
-            schema2,
-            selectedFields2,
-            expandValidationConfigs2
-          );
-          if (!validation.valid) {
-            return { data: void 0, error: validation.error };
-          }
-          const stripped = validation.data.map(
+          const records = resp.value ?? [];
+          const stripped = records.map(
             (record) => this.stripODataAnnotationsIfNeeded(record, options)
           );
           return { data: stripped, error: void 0 };
         }
       }
-      if (this.isCountMode) {
-        const result = await this.context._makeRequest(
-          `/${this.databaseName}/${this.tableName}/$count${queryString}`,
-          options
+      const schema2 = (_d = (_c = this.occurrence) == null ? void 0 : _c.baseTable) == null ? void 0 : _d.schema;
+      const selectedFields2 = this.queryOptions.select;
+      const expandValidationConfigs2 = this.buildExpandValidationConfigs(
+        this.expandConfigs
+      );
+      if (this.singleMode !== false) {
+        const validation = await validateSingleResponse(
+          response2,
+          schema2,
+          selectedFields2,
+          expandValidationConfigs2,
+          this.singleMode
+        );
+        if (!validation.valid) {
+          return { data: void 0, error: validation.error };
+        }
+        const stripped = validation.data ? this.stripODataAnnotationsIfNeeded(validation.data, options) : null;
+        return { data: stripped, error: void 0 };
+      } else {
+        const validation = await validateListResponse(
+          response2,
+          schema2,
+          selectedFields2,
+          expandValidationConfigs2
         );
-        const count = typeof result === "string" ? Number(result) : result;
-        return { data: count, error: void 0 };
+        if (!validation.valid) {
+          return { data: void 0, error: validation.error };
+        }
+        const stripped = validation.data.map(
+          (record) => this.stripODataAnnotationsIfNeeded(record, options)
+        );
+        return { data: stripped, error: void 0 };
       }
-      const response = await this.context._makeRequest(
-        `/${this.databaseName}/${this.tableName}${queryString}`,
+    }
+    if (this.isNavigate && !this.navigateRecordId && this.navigateRelation && this.navigateSourceTableName) {
+      const result2 = await this.context._makeRequest(
+        `/${this.databaseName}/${this.navigateSourceTableName}/${this.navigateRelation}${queryString}`,
         options
       );
+      if (result2.error) {
+        return { data: void 0, error: result2.error };
+      }
+      let response2 = result2.data;
+      if ((_e = this.occurrence) == null ? void 0 : _e.baseTable) {
+        const expandValidationConfigs3 = this.buildExpandValidationConfigs(
+          this.expandConfigs
+        );
+        response2 = transformResponseFields(
+          response2,
+          this.occurrence.baseTable,
+          expandValidationConfigs3
+        );
+      }
       if ((options == null ? void 0 : options.skipValidation) === true) {
-        const resp = response;
+        const resp = response2;
         if (this.singleMode !== false) {
           const records = resp.value ?? [resp];
           const count = Array.isArray(records) ? records.length : 1;
           if (count > 1) {
             return {
               data: void 0,
-              error: new Error(
-                `Expected ${this.singleMode === "exact" ? "exactly one" : "at most one"} record, but received ${count}`
+              error: new RecordCountMismatchError(
+                this.singleMode === "exact" ? "one" : "at-most-one",
+                count
               )
             };
           }
@@ -508,9 +488,7 @@ class QueryBuilder {
             if (this.singleMode === "exact") {
               return {
                 data: void 0,
-                error: new Error(
-                  "Expected exactly one record, but received none"
-                )
+                error: new RecordCountMismatchError("one", 0)
               };
             }
             return { data: null, error: void 0 };
@@ -526,33 +504,30 @@ class QueryBuilder {
           return { data: stripped, error: void 0 };
         }
       }
-      const schema = (_f = (_e = this.occurrence) == null ? void 0 : _e.baseTable) == null ? void 0 : _f.schema;
-      const selectedFields = this.queryOptions.select;
-      const expandValidationConfigs = this.buildExpandValidationConfigs(
+      const schema2 = (_g = (_f = this.occurrence) == null ? void 0 : _f.baseTable) == null ? void 0 : _g.schema;
+      const selectedFields2 = this.queryOptions.select;
+      const expandValidationConfigs2 = this.buildExpandValidationConfigs(
         this.expandConfigs
       );
       if (this.singleMode !== false) {
         const validation = await validateSingleResponse(
-          response,
-          schema,
-          selectedFields,
-          expandValidationConfigs,
+          response2,
+          schema2,
+          selectedFields2,
+          expandValidationConfigs2,
           this.singleMode
         );
         if (!validation.valid) {
           return { data: void 0, error: validation.error };
         }
         const stripped = validation.data ? this.stripODataAnnotationsIfNeeded(validation.data, options) : null;
-        return {
-          data: stripped,
-          error: void 0
-        };
+        return { data: stripped, error: void 0 };
       } else {
         const validation = await validateListResponse(
-          response,
-          schema,
-          selectedFields,
-          expandValidationConfigs
+          response2,
+          schema2,
+          selectedFields2,
+          expandValidationConfigs2
         );
         if (!validation.valid) {
           return { data: void 0, error: validation.error };
@@ -560,15 +535,111 @@ class QueryBuilder {
         const stripped = validation.data.map(
           (record) => this.stripODataAnnotationsIfNeeded(record, options)
         );
-        return {
-          data: stripped,
-          error: void 0
-        };
+        return { data: stripped, error: void 0 };
+      }
+    }
+    if (this.isCountMode) {
+      const tableId2 = this.getTableId();
+      const result2 = await this.context._makeRequest(
+        `/${this.databaseName}/${tableId2}/$count${queryString}`,
+        options
+      );
+      if (result2.error) {
+        return { data: void 0, error: result2.error };
       }
-    } catch (error) {
+      const count = typeof result2.data === "string" ? Number(result2.data) : result2.data;
+      return { data: count, error: void 0 };
+    }
+    const tableId = this.getTableId();
+    const result = await this.context._makeRequest(
+      `/${this.databaseName}/${tableId}${queryString}`,
+      options
+    );
+    if (result.error) {
+      return { data: void 0, error: result.error };
+    }
+    let response = result.data;
+    if ((_h = this.occurrence) == null ? void 0 : _h.baseTable) {
+      const expandValidationConfigs2 = this.buildExpandValidationConfigs(
+        this.expandConfigs
+      );
+      response = transformResponseFields(
+        response,
+        this.occurrence.baseTable,
+        expandValidationConfigs2
+      );
+    }
+    if ((options == null ? void 0 : options.skipValidation) === true) {
+      const resp = response;
+      if (this.singleMode !== false) {
+        const records = resp.value ?? [resp];
+        const count = Array.isArray(records) ? records.length : 1;
+        if (count > 1) {
+          return {
+            data: void 0,
+            error: new RecordCountMismatchError(
+              this.singleMode === "exact" ? "one" : "at-most-one",
+              count
+            )
+          };
+        }
+        if (count === 0) {
+          if (this.singleMode === "exact") {
+            return {
+              data: void 0,
+              error: new RecordCountMismatchError("one", 0)
+            };
+          }
+          return { data: null, error: void 0 };
+        }
+        const record = Array.isArray(records) ? records[0] : records;
+        const stripped = this.stripODataAnnotationsIfNeeded(record, options);
+        return { data: stripped, error: void 0 };
+      } else {
+        const records = resp.value ?? [];
+        const stripped = records.map(
+          (record) => this.stripODataAnnotationsIfNeeded(record, options)
+        );
+        return { data: stripped, error: void 0 };
+      }
+    }
+    const schema = (_j = (_i = this.occurrence) == null ? void 0 : _i.baseTable) == null ? void 0 : _j.schema;
+    const selectedFields = this.queryOptions.select;
+    const expandValidationConfigs = this.buildExpandValidationConfigs(
+      this.expandConfigs
+    );
+    if (this.singleMode !== false) {
+      const validation = await validateSingleResponse(
+        response,
+        schema,
+        selectedFields,
+        expandValidationConfigs,
+        this.singleMode
+      );
+      if (!validation.valid) {
+        return { data: void 0, error: validation.error };
+      }
+      const stripped = validation.data ? this.stripODataAnnotationsIfNeeded(validation.data, options) : null;
+      return {
+        data: stripped,
+        error: void 0
+      };
+    } else {
+      const validation = await validateListResponse(
+        response,
+        schema,
+        selectedFields,
+        expandValidationConfigs
+      );
+      if (!validation.valid) {
+        return { data: void 0, error: validation.error };
+      }
+      const stripped = validation.data.map(
+        (record) => this.stripODataAnnotationsIfNeeded(record, options)
+      );
       return {
-        data: void 0,
-        error: error instanceof Error ? error : new Error(String(error))
+        data: stripped,
+        error: void 0
       };
     }
   }