@emuanalytics/flow-rdf-ui 0.0.29 → 0.0.30

package/dist/index.d.ts

@@ -2640,8 +2640,7 @@ interface FlowQueryBuilderFieldBase<ValueType = any> {
     operators?: string[];
     defaultValue?: ValueType | (() => ValueType);
     defaultOperator?: string;
-    toDisplayValue?: (value: ValueType) => ValueType;
-    fromDisplayValue?: (value: ValueType) => ValueType;
+    convertValue?: (value: ValueType) => any;
     validator?: (rule: FlowQueryBuilderRule<ValueType>) => string;
 }
 interface FlowQueryBuilderStringField extends FlowQueryBuilderFieldBase<string> {
@@ -2686,7 +2685,7 @@ interface FlowQueryBuilderFieldTypeMap {
 }
 type FlowQueryBuilderFieldType = keyof FlowQueryBuilderFieldTypeMap;
 type FlowQueryBuilderField = FlowQueryBuilderFieldTypeMap[keyof FlowQueryBuilderFieldTypeMap];
-type FlowQueryBuilderTemplateFn<T extends FlowQueryBuilderFieldType> = (rule: FlowQueryBuilderRule<T>, field: FlowQueryBuilderFieldTypeMap[T], qb: FlowQueryBuilder, update: () => void) => TemplateResult;
+type FlowQueryBuilderTemplateFn<FieldType extends FlowQueryBuilderFieldType> = (rule: FlowQueryBuilderRule<FlowQueryBuilderFieldTypeMap[FieldType]['value']>, field: FlowQueryBuilderFieldTypeMap[FieldType], qb: FlowQueryBuilder, update: () => void) => TemplateResult;
 interface FlowQueryBuilderConfig {
     fields: FlowQueryBuilderFieldMap;
 }
@@ -2694,6 +2693,12 @@ interface FlowQueryBuilderFieldDefinition<Field extends FlowQueryBuilderFieldTyp
     operators: string[];
     template: FlowQueryBuilderTemplateFn<Field>;
 }
+interface FlowQueryBuilderConverterOptions {
+    includeFields?: string[];
+    excludeFields?: string[];
+    renameFields?: Record<string, string>;
+}
+type FlowQueryBuilderConverter = (ruleSet: FlowQueryBuilderRuleSet, config: FlowQueryBuilderConfig, options?: FlowQueryBuilderConverterOptions) => any;
 
 type NoUnion<T, U = T> = T extends U ? ([U] extends [T] ? T : never) : never;
 /**
@@ -2718,6 +2723,62 @@ declare class FlowQueryBuilder extends FlowRdfElement {
      * @param fieldDefinition
      */
     static registerFieldDefinition<T extends FlowQueryBuilderFieldType>(type: T, fieldDefinition: FlowQueryBuilderFieldDefinition<NoUnion<T>>): void;
+    /**
+     *
+     */
+    static convertToFlowQuery: FlowQueryBuilderConverter;
+    /**
+     * Static helper method to determine if supplied argument is
+     * a `FlowQueryBuilderRule`.
+     *
+     * @param value A value to test
+     */
+    static isRule(value: unknown): value is FlowQueryBuilderRule;
+    /**
+     * Static helper method to determine if supplied argument is
+     * a `FlowQueryBuilderRuleSet`.
+     *
+     * @param value A value to test
+     * @returns `true` if supplied value is a FlowQueryBuilderRuleSet
+     */
+    static isRuleSet(value: unknown): value is FlowQueryBuilderRuleSet;
+    /**
+     * Static helper method to recursively filter a `FlowQueryBuilderRuleSet`.
+     *
+     * This can be used to sanitize user queries before they are executed.
+     *
+     * @param ruleset Rule set to filter
+     * @param options Fields to include or exclude
+     * @returns The filtered rule set
+     */
+    static filterRuleSet(ruleset: FlowQueryBuilderRuleSet, options: {
+        excludeFields?: string[];
+        includeFields?: string[];
+    }): FlowQueryBuilderRuleSet;
+    /**
+     * Static helper method to rename fields in a `FlowQueryBuilderRuleSet`.
+     *
+     * @param ruleSet A `FlowQueryBuilderRuleSet` to rename.
+     * @param replacements Mapping of string to string for renaming fields.
+     * @returns The renamed rule set.
+     */
+    static renameRuleSetFields(ruleset: FlowQueryBuilderRuleSet, replacements: Record<string, string>): FlowQueryBuilderRuleSet;
+    /**
+     * Static helper method to recursively apply  a transform function to each rule
+     * in a `FlowQueryBuilderRuleSet`.
+     *
+     * The transform fn should expect a single FlowQueryBuilderRule and return:
+     *
+     * - the same rule unmodifed or modified in place
+     * - `undefined` to exclude the rule from the rule set
+     *
+     * This can be used to sanitize rule sets before they are used to perform queries.
+     *
+     * @param ruleSet query builder rule set
+     * @param transformFn transform function
+     * @returns The modified rule set
+     */
+    static transformRuleSet(ruleSet: FlowQueryBuilderRuleSet, transformFn: (rule: FlowQueryBuilderRule) => FlowQueryBuilderRule | undefined): FlowQueryBuilderRuleSet;
     private readonly hasSlotController;
     /** The query builder's value object. */
     value: FlowQueryBuilderRuleSet;
@@ -2755,10 +2816,10 @@ declare class FlowQueryBuilder extends FlowRdfElement {
     private operatorsForField;
     private defaultOperatorsForFieldType;
     private toolbarTemplate;
-    ruleTemplate(rule: FlowQueryBuilderRule, fieldConfig: FlowQueryBuilderField | undefined, index: number): lit.TemplateResult<1>;
-    ruleValueTemplate(rule: FlowQueryBuilderRule, fieldConfig: FlowQueryBuilderField | undefined): lit.TemplateResult<1>;
-    subQueryBuilderTemplate(ruleSet: FlowQueryBuilderRuleSet, index: number): lit.TemplateResult<1>;
-    emptyRulesetTemplate(): lit.TemplateResult<1>;
+    private ruleTemplate;
+    private ruleValueTemplate;
+    private subQueryBuilderTemplate;
+    private emptyRulesetTemplate;
     render(): lit.TemplateResult<1>;
 }
 

package/dist/index.mjs

@@ -4153,6 +4153,8 @@ const isString = (val) => typeof val === "string";
 const hasLength = (val) => isDefined(val) && val.length > 0;
 const isStringFull = (val) => isString(val) && hasLength(val);
 const isArrayFull = (val) => Array.isArray(val) && hasLength(val);
+const isObject = (val) => typeof val === "object" && !isNull(val);
+const isObjectFull = (val) => isObject(val) && hasLength(Object.keys(val));
 const isNumber = (val) => typeof val === "number" && !Number.isNaN(val) && Number.isFinite(val);
 const isNumeric = (val) => isString(val) && /^[+-]?([0-9]*[.])?[0-9]+$/.test(val);
 const isFunction = (val) => typeof val === "function";
@@ -13066,6 +13068,149 @@ FlowProgressRing = __decorateClass$p([
   customElement("flow-ui-progress-ring")
 ], FlowProgressRing);
 
+function filterRuleSet(ruleset, options) {
+  return transformRuleSet(ruleset, (rule) => {
+    if (isDefined(rule.field)) {
+      if (isDefined(options.excludeFields) && options.excludeFields.includes(rule.field)) {
+        return;
+      }
+      if (isDefined(options.includeFields) && !options.includeFields.includes(rule.field)) {
+        return;
+      }
+      return rule;
+    }
+  });
+}
+function renameRuleSetFields(ruleset, replacements) {
+  return transformRuleSet(ruleset, (rule) => {
+    if (isDefined(rule.field)) {
+      rule.field = rule.field in replacements ? replacements[rule.field] : rule.field;
+      return rule;
+    }
+  });
+}
+function transformRuleSet(ruleSet, transformFn, clone = true) {
+  if (clone) {
+    ruleSet = cloneDeep(ruleSet);
+  }
+  ruleSet.rules = ruleSet.rules.map((r) => {
+    if (isRule(r)) {
+      return transformFn(r);
+    } else if (isRuleSet(r)) {
+      return transformRuleSet(r, transformFn, false);
+    }
+  }).filter(isRuleOrRuleset);
+  return ruleSet;
+}
+const isRule = (r) => isObjectFull(r) && "field" in r;
+const isRuleSet = (r) => isObjectFull(r) && "fields" in r;
+const isRuleOrRuleset = (r) => isRule(r) || isRuleSet(r);
+
+function whereClausesFromRuleSet(rule, config, options) {
+  if (isRule(rule)) {
+    if (!rule.enabled) {
+      return void 0;
+    }
+    if (isNil(rule.field) || isNil(rule.operator)) {
+      console.warn(`flowQueryConverter: Skipping rule with missing field or operator`, rule);
+      return void 0;
+    }
+    const field = config.fields[rule.field];
+    if (!field) {
+      console.warn(`flowQueryConverter: Skipping unknown field '${rule.field}' in rule`, rule);
+      return void 0;
+    }
+    if (isNil(rule.value) && field.nullable !== true) {
+      console.warn(`flowQueryConverter: Skipping nil field '${rule.field}' in rule (non-nullable)`, rule);
+      return void 0;
+    }
+    let fieldName = rule.field;
+    if (options?.renameFields && fieldName in options.renameFields) {
+      fieldName = options.renameFields[fieldName];
+    }
+    let clause = ["is null", "not null"].includes(rule.operator) || !isNil(rule.value) ? { [fieldName]: predicateFromRule(rule, config) } : {};
+    if ((rule.operator === "!=" || rule.operator === "not like") && isObjectFull(clause)) {
+      clause = { $or: [{ [fieldName]: { $is: null } }, clause] };
+    }
+    return clause;
+  } else {
+    const condition = rule.condition === "and" ? "$and" : "$or";
+    const rules = rule.rules.map((r) => whereClausesFromRuleSet(r, config, options)).filter((r) => isObjectFull(r));
+    return rules.length ? { [condition]: rules } : {};
+  }
+}
+function predicateFromRule(rule, config) {
+  const field = config.fields[rule.field];
+  let operator;
+  let value = rule.value;
+  if (isFunction(field.convertValue)) {
+    value = field.convertValue(value);
+  }
+  switch (rule.operator) {
+    case "=":
+      operator = "$eq";
+      break;
+    case "!=":
+      operator = "$ne";
+      break;
+    case "<":
+      operator = "$lt";
+      break;
+    case "<=":
+      operator = "$lte";
+      break;
+    case ">":
+      operator = "$gt";
+      break;
+    case ">=":
+      operator = "$gte";
+      break;
+    case "in":
+      operator = "$in";
+      break;
+    case "not in":
+      operator = "$notIn";
+      break;
+    case "like":
+      operator = "$iLike";
+      break;
+    case "not like":
+      operator = "$notILike";
+      break;
+    case "contains":
+      operator = "$iLike";
+      value = `%${value}%`;
+      break;
+    case "is null":
+      operator = "$is";
+      value = null;
+      break;
+    case "not null":
+      operator = "$not";
+      value = null;
+      break;
+    case "between":
+      operator = "$between";
+      break;
+    default:
+      throw new Error(`Unrecognized query operator '${rule.operator}'`);
+  }
+  if (config.fields?.[rule.field]?.type === "datetime") {
+    if (rule.operator === "between") {
+      value = [DateTime.fromISO(value[0] || 0).toISO(), DateTime.fromISO(value[1] || 0).toISO()];
+    } else {
+      value = DateTime.fromISO(value || 0).toISO();
+    }
+  }
+  return { [operator]: value };
+}
+const converter = (ruleset, config, options) => {
+  if (options) {
+    ruleset = filterRuleSet(ruleset, options);
+  }
+  return whereClausesFromRuleSet(ruleset, config, options);
+};
+
 function getDefault(defaultVal, fallback) {
   if (isFunction(defaultVal)) {
     return defaultVal();
@@ -13075,15 +13220,14 @@ function getDefault(defaultVal, fallback) {
 const defaultStringTemplate = (rule, field, qb, update) => {
   const handleChange = (ev) => {
     const target = ev.target;
-    rule.value = field.fromDisplayValue?.(target.value) ?? target.value;
+    rule.value = target.value === "" ? void 0 : target.value;
     target.setCustomValidity?.(field.validator?.(rule) ?? "");
     update();
   };
-  const value = rule.value && field.toDisplayValue ? field.toDisplayValue(rule.value) : rule.value;
   return html`
     <flow-ui-input
       class="query-builder__rule-value-control"
-      value=${ifDefined(value)}
+      value=${rule.value ?? ""}
       size=${qb.size}
       ?disabled=${!rule.enabled}
       @flow-ui-change=${handleChange}
@@ -13093,7 +13237,7 @@ const defaultStringTemplate = (rule, field, qb, update) => {
 const defaultNumberTemplate = (rule, field, qb, update) => {
   const handleChange = (ev) => {
     const target = ev.target;
-    rule.value = field.fromDisplayValue?.(+target.value) ?? target.value;
+    rule.value = target.value === "" ? void 0 : +target.value;
     target.setCustomValidity?.(field.validator?.(rule) ?? "");
     update();
   };
@@ -13101,7 +13245,7 @@ const defaultNumberTemplate = (rule, field, qb, update) => {
     <flow-ui-input
       class="query-builder__rule-value-control"
       type="number"
-      value=${field.toDisplayValue ? field.toDisplayValue(rule.value) : rule.value}
+      value=${rule.value ?? ""}
       size=${qb.size}
       min=${ifDefined(field.min)}
       max=${ifDefined(field.max)}
@@ -13114,7 +13258,7 @@ const defaultNumberTemplate = (rule, field, qb, update) => {
 const defaultDateTimeTemplate = (rule, field, qb, update) => {
   const handleChange = (ev) => {
     const target = ev.target;
-    rule.value = field.fromDisplayValue?.(target.value) ?? target.value;
+    rule.value = target.value === "" ? void 0 : target.value;
     target.setCustomValidity(field.validator?.(rule) ?? "");
     update();
   };
@@ -13124,8 +13268,9 @@ const defaultDateTimeTemplate = (rule, field, qb, update) => {
   return html`
     <flow-ui-date-time-picker
       class="query-builder__rule-value-control"
-      value=${rule.value}
+      value=${rule.value ?? ""}
       size=${qb.size}
+      placeholder="Enter a date/time"
       format=${ifDefined(format)}
       timezone=${ifDefined(timezone)}
       locale=${ifDefined(locale)}
@@ -13137,7 +13282,7 @@ const defaultDateTimeTemplate = (rule, field, qb, update) => {
 const defaultDateTemplate = (rule, field, qb, update) => {
   const handleChange = (ev) => {
     const target = ev.target;
-    rule.value = field.fromDisplayValue?.(target.value) ?? target.value;
+    rule.value = target.value === "" ? void 0 : target.value;
     target.setCustomValidity(field.validator?.(rule) ?? "");
     update();
   };
@@ -13147,9 +13292,10 @@ const defaultDateTemplate = (rule, field, qb, update) => {
   return html`
     <flow-ui-date-time-picker
       class="query-builder__rule-value-control"
-      value=${rule.value}
+      value=${rule.value ?? ""}
       display-mode="date"
       size=${qb.size}
+      placeholder="Enter a date"
       format=${ifDefined(format)}
       timezone=${ifDefined(timezone)}
       locale=${ifDefined(locale)}
@@ -13161,7 +13307,7 @@ const defaultDateTemplate = (rule, field, qb, update) => {
 const defaultTimeTemplate = (rule, field, qb, update) => {
   const handleChange = (ev) => {
     const target = ev.target;
-    rule.value = field.fromDisplayValue?.(target.value) ?? target.value;
+    rule.value = target.value === "" ? void 0 : target.value;
     target.setCustomValidity(field.validator?.(rule) ?? "");
     update();
   };
@@ -13171,9 +13317,10 @@ const defaultTimeTemplate = (rule, field, qb, update) => {
   return html`
     <flow-ui-date-time-picker
       class="query-builder__rule-value-control"
-      value=${rule.value}
+      value=${rule.value ?? ""}
       display-mode="time"
       size=${qb.size}
+      placeholder="Enter a time"
       format=${ifDefined(format)}
       timezone=${ifDefined(timezone)}
       locale=${ifDefined(locale)}
@@ -13185,14 +13332,14 @@ const defaultTimeTemplate = (rule, field, qb, update) => {
 const defaultSelectTemplate = (rule, field, qb, update) => {
   const handleChange = (ev) => {
     const target = ev.target;
-    rule.value = field.fromDisplayValue?.(target.value) ?? target.value;
+    rule.value = target.value === "" ? void 0 : target.value;
     target.setCustomValidity(field.validator?.(rule) ?? "");
     update();
   };
   return html`
     <flow-ui-select
       class="query-builder__rule-value-control"
-      value=${field.toDisplayValue ? field.toDisplayValue(rule.value) : rule.value}
+      value=${rule.value ?? ""}
       size=${qb.size}
       ?disabled=${!rule.enabled}
       @flow-ui-change=${handleChange}
@@ -13208,14 +13355,14 @@ const defaultSelectTemplate = (rule, field, qb, update) => {
 const defaultMultiSelectTemplate = (rule, field, qb, update) => {
   const handleChange = (ev) => {
     const target = ev.target;
-    rule.value = field.fromDisplayValue?.(target.value) ?? target.value;
+    rule.value = isArrayFull(target.value) ? target.value : void 0;
     target.setCustomValidity(field.validator?.(rule) ?? "");
     update();
   };
   return html`
     <flow-ui-select
       class="query-builder__rule-value-control"
-      value=${field.toDisplayValue ? field.toDisplayValue(rule.value) : rule.value}
+      .value=${rule.value ?? []}
       size=${qb.size}
       ?disabled=${!rule.enabled}
       @flow-ui-change=${handleChange}
@@ -13500,6 +13647,65 @@ const _FlowQueryBuilder = class _FlowQueryBuilder extends FlowRdfElement {
   static registerFieldDefinition(type, fieldDefinition) {
     _FlowQueryBuilder.fieldDefinitions.set(type, fieldDefinition);
   }
+  /**
+   * Static helper method to determine if supplied argument is
+   * a `FlowQueryBuilderRule`.
+   *
+   * @param value A value to test
+   */
+  static isRule(value) {
+    return isRule(value);
+  }
+  /**
+   * Static helper method to determine if supplied argument is
+   * a `FlowQueryBuilderRuleSet`.
+   *
+   * @param value A value to test
+   * @returns `true` if supplied value is a FlowQueryBuilderRuleSet
+   */
+  static isRuleSet(value) {
+    return isRuleSet(value);
+  }
+  /**
+   * Static helper method to recursively filter a `FlowQueryBuilderRuleSet`.
+   *
+   * This can be used to sanitize user queries before they are executed.
+   *
+   * @param ruleset Rule set to filter
+   * @param options Fields to include or exclude
+   * @returns The filtered rule set
+   */
+  static filterRuleSet(ruleset, options) {
+    return filterRuleSet(ruleset, options);
+  }
+  /**
+   * Static helper method to rename fields in a `FlowQueryBuilderRuleSet`.
+   *
+   * @param ruleSet A `FlowQueryBuilderRuleSet` to rename.
+   * @param replacements Mapping of string to string for renaming fields.
+   * @returns The renamed rule set.
+   */
+  static renameRuleSetFields(ruleset, replacements) {
+    return renameRuleSetFields(ruleset, replacements);
+  }
+  /**
+   * Static helper method to recursively apply  a transform function to each rule
+   * in a `FlowQueryBuilderRuleSet`.
+   *
+   * The transform fn should expect a single FlowQueryBuilderRule and return:
+   *
+   * - the same rule unmodifed or modified in place
+   * - `undefined` to exclude the rule from the rule set
+   *
+   * This can be used to sanitize rule sets before they are used to perform queries.
+   *
+   * @param ruleSet query builder rule set
+   * @param transformFn transform function
+   * @returns The modified rule set
+   */
+  static transformRuleSet(ruleSet, transformFn) {
+    return transformRuleSet(ruleSet, transformFn);
+  }
   valueTemplateForRule(_rule, field) {
     const fieldDef = field?.type && _FlowQueryBuilder.fieldDefinitions.get(field.type);
     if (fieldDef?.template) {
@@ -13595,7 +13801,6 @@ const _FlowQueryBuilder = class _FlowQueryBuilder extends FlowRdfElement {
   emitValueChange() {
     if (!this.subQueryBuilder) {
       this.value = cloneDeep(this.value);
-      console.log("top-level value", this.value);
     }
     this.emit("flow-ui-change");
   }
@@ -13758,7 +13963,9 @@ const _FlowQueryBuilder = class _FlowQueryBuilder extends FlowRdfElement {
   }
   emptyRulesetTemplate() {
     return html`
-      <div class="query-builder__empty-ruleset"><i>A rule set cannot be empty. Please add a rule or remove the set.</div>
+      <div class="query-builder__empty-ruleset">
+        <i>A rule set cannot be empty. Please add a rule or remove the set.</i>
+      </div>
     `;
   }
   render() {
@@ -13826,6 +14033,11 @@ const _FlowQueryBuilder = class _FlowQueryBuilder extends FlowRdfElement {
 };
 _FlowQueryBuilder.styles = styles$o;
 _FlowQueryBuilder.fieldDefinitions = /* @__PURE__ */ new Map();
+// Static converts and helpers
+/**
+ *
+ */
+_FlowQueryBuilder.convertToFlowQuery = converter;
 __decorateClass$o([
   property({ type: Object, reflect: false })
 ], _FlowQueryBuilder.prototype, "value", 2);
@@ -23146,7 +23358,7 @@ const translation = {
 };
 registerTranslation(translation);
 
-const version = "0.0.29";
+const version = "0.0.30";
 
 const CONSOLE_HIGHLIGHT_STYLE = `
   padding: 2px 4px;