@proofkit/fmodata 0.1.0-alpha.0

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

@@ -0,0 +1,649 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+import buildQuery from "odata-query";
+import { validateSingleResponse, validateListResponse } from "../validation.js";
+class QueryBuilder {
+  constructor(config) {
+    __publicField(this, "queryOptions", {});
+    __publicField(this, "expandConfigs", []);
+    __publicField(this, "singleMode", false);
+    __publicField(this, "isCountMode", false);
+    __publicField(this, "occurrence");
+    __publicField(this, "tableName");
+    __publicField(this, "databaseName");
+    __publicField(this, "context");
+    __publicField(this, "isNavigate");
+    __publicField(this, "navigateRecordId");
+    __publicField(this, "navigateRelation");
+    __publicField(this, "navigateSourceTableName");
+    __publicField(this, "navigateBaseRelation");
+    this.occurrence = config.occurrence;
+    this.tableName = config.tableName;
+    this.databaseName = config.databaseName;
+    this.context = config.context;
+  }
+  /**
+   * Helper to conditionally strip OData annotations based on options
+   */
+  stripODataAnnotationsIfNeeded(data, options) {
+    if ((options == null ? void 0 : options.includeODataAnnotations) === true) {
+      return data;
+    }
+    const { "@id": _id, "@editLink": _editLink, ...rest } = data;
+    return rest;
+  }
+  select(...fields) {
+    const uniqueFields = [...new Set(fields)];
+    const newBuilder = new QueryBuilder({
+      occurrence: this.occurrence,
+      tableName: this.tableName,
+      databaseName: this.databaseName,
+      context: this.context
+    });
+    newBuilder.queryOptions = {
+      ...this.queryOptions,
+      select: uniqueFields
+    };
+    newBuilder.expandConfigs = [...this.expandConfigs];
+    newBuilder.singleMode = this.singleMode;
+    newBuilder.isCountMode = this.isCountMode;
+    newBuilder.isNavigate = this.isNavigate;
+    newBuilder.navigateRecordId = this.navigateRecordId;
+    newBuilder.navigateRelation = this.navigateRelation;
+    newBuilder.navigateSourceTableName = this.navigateSourceTableName;
+    newBuilder.navigateBaseRelation = this.navigateBaseRelation;
+    return newBuilder;
+  }
+  /**
+   * Transforms our filter format to odata-query's expected format
+   * - Arrays of operators are converted to AND conditions
+   * - Single operator objects pass through as-is
+   * - Shorthand values are handled by odata-query
+   */
+  transformFilter(filter) {
+    if (typeof filter === "string") {
+      return filter;
+    }
+    if (Array.isArray(filter)) {
+      return filter.map((f) => this.transformFilter(f));
+    }
+    if ("and" in filter || "or" in filter || "not" in filter) {
+      const result2 = {};
+      if ("and" in filter && Array.isArray(filter.and)) {
+        result2.and = filter.and.map((f) => this.transformFilter(f));
+      }
+      if ("or" in filter && Array.isArray(filter.or)) {
+        result2.or = filter.or.map((f) => this.transformFilter(f));
+      }
+      if ("not" in filter && filter.not) {
+        result2.not = this.transformFilter(filter.not);
+      }
+      return result2;
+    }
+    const result = {};
+    const andConditions = [];
+    for (const [field, value] of Object.entries(filter)) {
+      if (Array.isArray(value)) {
+        if (value.length === 1) {
+          result[field] = value[0];
+        } else {
+          for (const op of value) {
+            andConditions.push({ [field]: op });
+          }
+        }
+      } else if (value && typeof value === "object" && !(value instanceof Date) && !Array.isArray(value)) {
+        const operatorKeys = [
+          "eq",
+          "ne",
+          "gt",
+          "ge",
+          "lt",
+          "le",
+          "contains",
+          "startswith",
+          "endswith",
+          "in"
+        ];
+        const isOperatorObject = operatorKeys.some((key) => key in value);
+        if (isOperatorObject) {
+          result[field] = value;
+        } else {
+          result[field] = value;
+        }
+      } else {
+        result[field] = value;
+      }
+    }
+    if (andConditions.length > 0) {
+      if (Object.keys(result).length > 0) {
+        return { and: [...andConditions, result] };
+      } else {
+        return { and: andConditions };
+      }
+    }
+    return result;
+  }
+  filter(filter) {
+    this.queryOptions.filter = this.transformFilter(filter);
+    return this;
+  }
+  orderBy(orderBy) {
+    this.queryOptions.orderBy = orderBy;
+    return this;
+  }
+  top(count) {
+    this.queryOptions.top = count;
+    return this;
+  }
+  skip(count) {
+    this.queryOptions.skip = count;
+    return this;
+  }
+  /**
+   * Formats select fields for use in query strings.
+   * - Wraps "id" fields in double quotes
+   * - URL-encodes special characters but preserves spaces
+   */
+  formatSelectFields(select) {
+    if (!select) return "";
+    const selectFieldsArray = Array.isArray(select) ? select : [select];
+    return selectFieldsArray.map((field) => {
+      if (field === "id") return `"id"`;
+      const encodedField = encodeURIComponent(String(field));
+      return encodedField.replace(/%20/g, " ");
+    }).join(",");
+  }
+  /**
+   * Builds expand validation configs from internal expand configurations.
+   * These are used to validate expanded navigation properties.
+   */
+  buildExpandValidationConfigs(configs) {
+    return configs.map((config) => {
+      var _a, _b, _c;
+      const targetOccurrence = (_a = this.occurrence) == null ? void 0 : _a.navigation[config.relation];
+      const targetSchema = (_b = targetOccurrence == null ? void 0 : targetOccurrence.baseTable) == null ? void 0 : _b.schema;
+      const selectedFields = ((_c = config.options) == null ? void 0 : _c.select) ? Array.isArray(config.options.select) ? config.options.select.map((f) => String(f)) : [String(config.options.select)] : void 0;
+      return {
+        relation: config.relation,
+        targetSchema,
+        targetOccurrence,
+        selectedFields,
+        nestedExpands: void 0
+        // TODO: Handle nested expands if needed
+      };
+    });
+  }
+  /**
+   * Builds OData expand query string from expand configurations.
+   * Handles nested expands recursively.
+   */
+  buildExpandString(configs) {
+    if (configs.length === 0) {
+      return "";
+    }
+    return configs.map((config) => {
+      if (!config.options || Object.keys(config.options).length === 0) {
+        return config.relation;
+      }
+      const parts = [];
+      if (config.options.select) {
+        const selectFields = this.formatSelectFields(config.options.select);
+        parts.push(`$select=${selectFields}`);
+      }
+      if (config.options.filter) {
+        const filterQuery = buildQuery({ filter: config.options.filter });
+        const filterMatch = filterQuery.match(/\$filter=([^&]+)/);
+        if (filterMatch) {
+          parts.push(`$filter=${filterMatch[1]}`);
+        }
+      }
+      if (config.options.orderBy) {
+        const orderByValue = Array.isArray(config.options.orderBy) ? config.options.orderBy.join(",") : config.options.orderBy;
+        parts.push(`$orderby=${String(orderByValue)}`);
+      }
+      if (config.options.top !== void 0) {
+        parts.push(`$top=${config.options.top}`);
+      }
+      if (config.options.skip !== void 0) {
+        parts.push(`$skip=${config.options.skip}`);
+      }
+      if (config.options.expand) {
+        if (typeof config.options.expand === "string") {
+          parts.push(`$expand=${config.options.expand}`);
+        }
+      }
+      if (parts.length === 0) {
+        return config.relation;
+      }
+      return `${config.relation}(${parts.join(";")})`;
+    }).join(",");
+  }
+  expand(relation, callback) {
+    var _a;
+    const targetOccurrence = (_a = this.occurrence) == null ? void 0 : _a.navigation[relation];
+    if (callback) {
+      const targetBuilder = new QueryBuilder({
+        occurrence: targetOccurrence,
+        tableName: (targetOccurrence == null ? void 0 : targetOccurrence.name) ?? relation,
+        databaseName: this.databaseName,
+        context: this.context
+      });
+      const typedBuilder = targetBuilder;
+      const configuredBuilder = callback(typedBuilder);
+      const expandOptions = {
+        ...configuredBuilder.queryOptions
+      };
+      if (configuredBuilder.expandConfigs.length > 0) {
+        const nestedExpandString = this.buildExpandString(
+          configuredBuilder.expandConfigs
+        );
+        if (nestedExpandString) {
+          expandOptions.expand = nestedExpandString;
+        }
+      }
+      const expandConfig = {
+        relation,
+        options: expandOptions
+      };
+      this.expandConfigs.push(expandConfig);
+    } else {
+      this.expandConfigs.push({ relation });
+    }
+    return this;
+  }
+  single() {
+    const newBuilder = new QueryBuilder({
+      occurrence: this.occurrence,
+      tableName: this.tableName,
+      databaseName: this.databaseName,
+      context: this.context
+    });
+    newBuilder.queryOptions = { ...this.queryOptions };
+    newBuilder.expandConfigs = [...this.expandConfigs];
+    newBuilder.singleMode = "exact";
+    newBuilder.isCountMode = this.isCountMode;
+    newBuilder.isNavigate = this.isNavigate;
+    newBuilder.navigateRecordId = this.navigateRecordId;
+    newBuilder.navigateRelation = this.navigateRelation;
+    newBuilder.navigateSourceTableName = this.navigateSourceTableName;
+    newBuilder.navigateBaseRelation = this.navigateBaseRelation;
+    return newBuilder;
+  }
+  maybeSingle() {
+    const newBuilder = new QueryBuilder({
+      occurrence: this.occurrence,
+      tableName: this.tableName,
+      databaseName: this.databaseName,
+      context: this.context
+    });
+    newBuilder.queryOptions = { ...this.queryOptions };
+    newBuilder.expandConfigs = [...this.expandConfigs];
+    newBuilder.singleMode = "maybe";
+    newBuilder.isCountMode = this.isCountMode;
+    newBuilder.isNavigate = this.isNavigate;
+    newBuilder.navigateRecordId = this.navigateRecordId;
+    newBuilder.navigateRelation = this.navigateRelation;
+    newBuilder.navigateSourceTableName = this.navigateSourceTableName;
+    newBuilder.navigateBaseRelation = this.navigateBaseRelation;
+    return newBuilder;
+  }
+  count() {
+    const newBuilder = new QueryBuilder({
+      occurrence: this.occurrence,
+      tableName: this.tableName,
+      databaseName: this.databaseName,
+      context: this.context
+    });
+    newBuilder.queryOptions = { ...this.queryOptions, count: true };
+    newBuilder.expandConfigs = [...this.expandConfigs];
+    newBuilder.singleMode = this.singleMode;
+    newBuilder.isCountMode = true;
+    newBuilder.isNavigate = this.isNavigate;
+    newBuilder.navigateRecordId = this.navigateRecordId;
+    newBuilder.navigateRelation = this.navigateRelation;
+    newBuilder.navigateSourceTableName = this.navigateSourceTableName;
+    newBuilder.navigateBaseRelation = this.navigateBaseRelation;
+    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
+        );
+      }
+      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}`;
+        }
+        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(
+          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
+          );
+          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 };
+        }
+      }
+      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) {
+              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 = (_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
+          );
+          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 };
+        }
+      }
+      if (this.isCountMode) {
+        const result = await this.context._makeRequest(
+          `/${this.databaseName}/${this.tableName}/$count${queryString}`,
+          options
+        );
+        const count = typeof result === "string" ? Number(result) : result;
+        return { data: count, error: void 0 };
+      }
+      const response = await this.context._makeRequest(
+        `/${this.databaseName}/${this.tableName}${queryString}`,
+        options
+      );
+      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 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 schema = (_f = (_e = this.occurrence) == null ? void 0 : _e.baseTable) == null ? void 0 : _f.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: stripped,
+          error: void 0
+        };
+      }
+    } catch (error) {
+      return {
+        data: void 0,
+        error: error instanceof Error ? error : new Error(String(error))
+      };
+    }
+  }
+  getQueryString() {
+    const queryOptionsWithoutExpand = { ...this.queryOptions };
+    delete queryOptionsWithoutExpand.expand;
+    if (queryOptionsWithoutExpand.select) {
+      queryOptionsWithoutExpand.select = this.formatSelectFields(
+        queryOptionsWithoutExpand.select
+      );
+    }
+    let queryParams = buildQuery(queryOptionsWithoutExpand);
+    if (this.queryOptions.select) {
+      queryParams = queryParams.replace(
+        /\$select=([^&]*)/,
+        (match, selectValue) => {
+          return `$select=${selectValue.replace(/%20/g, " ")}`;
+        }
+      );
+    }
+    const expandString = this.buildExpandString(this.expandConfigs);
+    if (expandString) {
+      const separator = queryParams.includes("?") ? "&" : "?";
+      queryParams = `${queryParams}${separator}$expand=${expandString}`;
+    }
+    if (this.isNavigate && this.navigateRecordId && this.navigateRelation && this.navigateSourceTableName) {
+      let path;
+      if (this.navigateBaseRelation) {
+        path = `/${this.navigateSourceTableName}/${this.navigateBaseRelation}('${this.navigateRecordId}')/${this.navigateRelation}`;
+      } else {
+        path = `/${this.navigateSourceTableName}('${this.navigateRecordId}')/${this.navigateRelation}`;
+      }
+      return queryParams ? `${path}${queryParams}` : path;
+    }
+    if (this.isNavigate && !this.navigateRecordId && this.navigateRelation && this.navigateSourceTableName) {
+      const path = `/${this.navigateSourceTableName}/${this.navigateRelation}`;
+      return queryParams ? `${path}${queryParams}` : path;
+    }
+    return `/${this.tableName}${queryParams}`;
+  }
+  getRequestConfig() {
+    const queryOptionsWithoutExpand = { ...this.queryOptions };
+    delete queryOptionsWithoutExpand.expand;
+    if (queryOptionsWithoutExpand.select) {
+      queryOptionsWithoutExpand.select = this.formatSelectFields(
+        queryOptionsWithoutExpand.select
+      );
+    }
+    let queryString = buildQuery(queryOptionsWithoutExpand);
+    const expandString = this.buildExpandString(this.expandConfigs);
+    if (expandString) {
+      const separator = queryString.includes("?") ? "&" : "?";
+      queryString = `${queryString}${separator}$expand=${expandString}`;
+    }
+    let url;
+    if (this.isNavigate && this.navigateRecordId && this.navigateRelation && this.navigateSourceTableName) {
+      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}`;
+      }
+    } else if (this.isNavigate && !this.navigateRecordId && this.navigateRelation && this.navigateSourceTableName) {
+      url = `/${this.databaseName}/${this.navigateSourceTableName}/${this.navigateRelation}${queryString}`;
+    } else if (this.isCountMode) {
+      url = `/${this.databaseName}/${this.tableName}/$count${queryString}`;
+    } else {
+      url = `/${this.databaseName}/${this.tableName}${queryString}`;
+    }
+    return {
+      method: "GET",
+      url
+    };
+  }
+}
+export {
+  QueryBuilder
+};
+//# sourceMappingURL=query-builder.js.map