data-finder-ts 0.1.4 → 0.1.5

package/dist/datafinder/attribute.cjs

@@ -25,12 +25,87 @@ __export(attribute_exports, {
 module.exports = __toCommonJS(attribute_exports);
 
 // src/model/relational.ts
+var LIKE_ESCAPE = "!";
+function escapeLike(value) {
+  return value.replaceAll(LIKE_ESCAPE, LIKE_ESCAPE + LIKE_ESCAPE).replaceAll("%", LIKE_ESCAPE + "%").replaceAll("_", LIKE_ESCAPE + "_");
+}
 var RelationalOperationElement = class {
 };
 var Operation = class extends RelationalOperationElement {
-  andOp(other) {
+  /** Name this column in the result: `f.price().sum().alias('Total')`, `f.age().gt(30).alias('Adult')`. */
+  alias(name) {
+    return new Alias(this, name);
+  }
+  and(other) {
     return new LogicalOperation(this, "AND" /* AND */, other);
   }
+  /** Combine with `other` using OR. A chain reads left to right: `a.or(b).and(c)` is `(a OR b) AND c`. */
+  or(other) {
+    return new LogicalOperation(this, "OR" /* OR */, other);
+  }
+};
+var ConstantOperation = class extends RelationalOperationElement {
+  /** Name this column in the result. */
+  alias(name) {
+    return new Alias(this, name);
+  }
+  /** Sort by this expression, smallest first. */
+  ascending() {
+    return new SortOperation(this, "ASC" /* ASC */);
+  }
+  /** Sort by this expression, largest first. */
+  descending() {
+    return new SortOperation(this, "DESC" /* DESC */);
+  }
+};
+var NumericConstantOperation = class extends ConstantOperation {
+  arithmeticOperand() {
+    return this;
+  }
+};
+var IntegerConstantOperation = class extends NumericConstantOperation {
+  constructor(value) {
+    super();
+    this.value = value;
+  }
+  value;
+};
+var FloatConstantOperation = class extends NumericConstantOperation {
+  constructor(value) {
+    super();
+    this.value = value;
+  }
+  value;
+};
+var StringConstantOperation = class extends ConstantOperation {
+  constructor(value) {
+    super();
+    this.value = value;
+  }
+  value;
+};
+var DateOnly = class extends Date {
+};
+var DateConstantOperation = class extends ConstantOperation {
+  constructor(value) {
+    super();
+    this.value = value;
+  }
+  value;
+};
+var DateTimeConstantOperation = class extends ConstantOperation {
+  constructor(value) {
+    super();
+    this.value = value;
+  }
+  value;
+};
+var BooleanConstantOperation = class extends ConstantOperation {
+  constructor(value) {
+    super();
+    this.value = value;
+  }
+  value;
 };
 var UnaryOperation = class extends Operation {
   constructor(element) {
@@ -52,6 +127,27 @@ var IsNullOperation = class extends UnaryOperation {
 };
 var IsNotNullOperation = class extends UnaryOperation {
 };
+var InOperation = class extends UnaryOperation {
+  constructor(element, values) {
+    super(element);
+    this.values = values;
+  }
+  values;
+};
+var NotInOperation = class extends UnaryOperation {
+  constructor(element, values) {
+    super(element);
+    this.values = values;
+  }
+  values;
+};
+var ComparisonOperation = class extends BinaryOperation {
+  constructor(left, operator, right) {
+    super(left, right);
+    this.operator = operator;
+  }
+  operator;
+};
 var LogicalOperation = class extends BinaryOperation {
   constructor(left, operator, right) {
     super(left, right);
@@ -68,21 +164,41 @@ var WindowSpecification = class {
   orderBy;
 };
 var AggregateOperation = class _AggregateOperation extends UnaryOperation {
-  constructor(element, operator, displayName, window) {
+  constructor(element, operator, displayName, window, separator, orderBy = []) {
     super(element);
     this.operator = operator;
     this.displayName = displayName;
     this.window = window;
+    this.separator = separator;
+    this.orderBy = orderBy;
   }
   operator;
   displayName;
   window;
+  separator;
+  orderBy;
+  /** Sort by this expression, smallest first. */
+  ascending() {
+    return new SortOperation(this, "ASC" /* ASC */);
+  }
+  /** Sort by this expression, largest first. */
+  descending() {
+    return new SortOperation(this, "DESC" /* DESC */);
+  }
+  arithmeticOperand() {
+    return this;
+  }
+  comparisonOperand() {
+    return this;
+  }
   over(partitionBy, orderBy) {
     return new _AggregateOperation(
       this.element,
       this.operator,
       this.displayName,
-      new WindowSpecification(partitionBy ?? [], orderBy ?? [])
+      new WindowSpecification(partitionBy ?? [], orderBy ?? []),
+      this.separator,
+      this.orderBy
     );
   }
 };
@@ -100,6 +216,14 @@ var WindowFunctionOperation = class _WindowFunctionOperation extends UnaryOperat
   secondArg;
   extraArgs;
   window;
+  /** Sort by this expression, smallest first. */
+  ascending() {
+    return new SortOperation(this, "ASC" /* ASC */);
+  }
+  /** Sort by this expression, largest first. */
+  descending() {
+    return new SortOperation(this, "DESC" /* DESC */);
+  }
   over(partitionBy, orderBy) {
     return new _WindowFunctionOperation(
       this.element,
@@ -111,34 +235,110 @@ var WindowFunctionOperation = class _WindowFunctionOperation extends UnaryOperat
     );
   }
 };
+var ScalarFunctionOperation = class extends UnaryOperation {
+  constructor(element, func, displayName, secondArg, extraArgs = []) {
+    super(element);
+    this.func = func;
+    this.displayName = displayName;
+    this.secondArg = secondArg;
+    this.extraArgs = extraArgs;
+  }
+  func;
+  displayName;
+  secondArg;
+  extraArgs;
+  /** Sort by this expression, smallest first. */
+  ascending() {
+    return new SortOperation(this, "ASC" /* ASC */);
+  }
+  /** Sort by this expression, largest first. */
+  descending() {
+    return new SortOperation(this, "DESC" /* DESC */);
+  }
+  /** This expression as an operand of a comparison. */
+  comparisonOperand() {
+    return this;
+  }
+  arithmeticOperand() {
+    return this;
+  }
+  /** Only a function that gives a number can be used in arithmetic. */
+  assertNumeric() {
+    if (!NUMERIC_FUNCTIONS.has(this.func)) {
+      throw new TypeError(`${this.func} does not give a number, so it cannot be used in arithmetic`);
+    }
+  }
+};
+var NUMERIC_FUNCTIONS = /* @__PURE__ */ new Set([
+  "ABS" /* ABS */,
+  "CEILING" /* CEILING */,
+  "FLOOR" /* FLOOR */,
+  "MOD" /* MOD */,
+  "POWER" /* POWER */,
+  "SQRT" /* SQRT */,
+  "ROUND" /* ROUND */,
+  "LENGTH" /* LENGTH */
+]);
+var DateTruncOperation = class extends UnaryOperation {
+  constructor(element, part, displayName) {
+    super(element);
+    this.part = part;
+    this.displayName = displayName;
+  }
+  part;
+  displayName;
+  /** Sort by this expression, earliest first. */
+  ascending() {
+    return new SortOperation(this, "ASC" /* ASC */);
+  }
+  /** Sort by this expression, latest first. */
+  descending() {
+    return new SortOperation(this, "DESC" /* DESC */);
+  }
+  comparisonOperand() {
+    return this;
+  }
+};
 var Column = class extends RelationalOperationElement {
-  constructor(name, type, owner, primaryKey = false) {
+  constructor(name, type, owner, primaryKey = false, nullable = true) {
     super();
     this.name = name;
     this.type = type;
     this.owner = owner;
     this.primaryKey = primaryKey;
+    this.nullable = nullable && !primaryKey;
   }
   name;
   type;
   owner;
   primaryKey;
   table;
+  /** Whether the column may hold NULL. As in Legend, a primary key is never null. */
+  nullable;
 };
 var ColumnWithJoin = class extends RelationalOperationElement {
   /**
    * `embedded` is an alternate reference to a flat (denormalized) column on the owning table that
    * holds the same value without the join; the SQL generator uses it when the join can be elided.
    */
-  constructor(column, parent, embedded) {
+  constructor(column, parent, embedded, _optional = false) {
     super();
     this.column = column;
     this.parent = parent;
     this.embedded = embedded;
+    this._optional = _optional;
   }
   column;
   parent;
   embedded;
+  _optional;
+  /** Whether the value can be missing: its property is optional, or a navigation on the way to it is. */
+  get optional() {
+    for (let node = this.parent; node !== void 0; node = node.parent) {
+      if (node.optional) return true;
+    }
+    return this._optional;
+  }
 };
 var SortOperation = class {
   constructor(column, direction) {
@@ -148,6 +348,286 @@ var SortOperation = class {
   column;
   direction;
 };
+var CountAllOperation = class extends RelationalOperationElement {
+  constructor(table) {
+    super();
+    this.table = table;
+  }
+  table;
+  /** Name this column in the result. */
+  alias(name) {
+    return new Alias(this, name);
+  }
+  /** Sort by this expression, smallest first. */
+  ascending() {
+    return new SortOperation(this, "ASC" /* ASC */);
+  }
+  /** Sort by this expression, largest first. */
+  descending() {
+    return new SortOperation(this, "DESC" /* DESC */);
+  }
+  comparisonOperand() {
+    return this;
+  }
+};
+var Alias = class _Alias extends RelationalOperationElement {
+  constructor(element, name) {
+    super();
+    this.element = element;
+    this.name = name;
+  }
+  element;
+  name;
+  alias(name) {
+    return new _Alias(this.element, name);
+  }
+  /** Sorts by the column the alias names. */
+  ascending() {
+    return new SortOperation(this.element, "ASC" /* ASC */);
+  }
+  /** Sorts by the column the alias names. */
+  descending() {
+    return new SortOperation(this.element, "DESC" /* DESC */);
+  }
+};
+var CaseOperation = class extends Operation {
+  constructor(condition, then, fallback, displayName) {
+    super();
+    this.condition = condition;
+    this.then = then;
+    this.fallback = fallback;
+    this.displayName = displayName;
+  }
+  condition;
+  then;
+  fallback;
+  displayName;
+};
+function valueOperand(value) {
+  if (typeof value === "boolean") return new BooleanConstantOperation(value);
+  if (typeof value === "number" && Number.isFinite(value)) {
+    return Number.isInteger(value) ? new IntegerConstantOperation(value) : new FloatConstantOperation(value);
+  }
+  if (typeof value === "string") return new StringConstantOperation(value);
+  if (value instanceof DateOnly) return new DateConstantOperation(value);
+  if (value instanceof Date) return new DateTimeConstantOperation(value);
+  throw new TypeError(`A value to compare with is a boolean, a finite number, a string or a date, not ${value === null ? "null" : typeof value}`);
+}
+function operandOf(other) {
+  if (other instanceof RelationalOperationElement) return other;
+  if (typeof other?.cwj === "function") return other.cwj();
+  return valueOperand(other);
+}
+var Comparable = class {
+  _compared(operator, other) {
+    return new ComparisonOperation(this.comparisonOperand(), operator, operandOf(other));
+  }
+  /** Filter to rows where this expression equals `other`. */
+  eq(other) {
+    return this._compared("EQUAL" /* EQUAL */, other);
+  }
+  /** Filter to rows where this expression does not equal `other`. */
+  ne(other) {
+    return this._compared("NOT_EQUAL" /* NOT_EQUAL */, other);
+  }
+  /** Filter to rows where this expression is less than `other`. */
+  lt(other) {
+    return this._compared("LESS_THAN" /* LESS_THAN */, other);
+  }
+  /** Filter to rows where this expression is at most `other`. */
+  lte(other) {
+    return this._compared("LESS_THAN_OR_EQUAL_TO" /* LESS_THAN_OR_EQUAL_TO */, other);
+  }
+  /** Filter to rows where this expression is greater than `other`. */
+  gt(other) {
+    return this._compared("GREATER_THAN" /* GREATER_THAN */, other);
+  }
+  /** Filter to rows where this expression is at least `other`. */
+  gte(other) {
+    return this._compared("GREATER_THAN_OR_EQUAL_TO" /* GREATER_THAN_OR_EQUAL_TO */, other);
+  }
+};
+function sample(ddof) {
+  if (ddof !== 0 && ddof !== 1) throw new RangeError(`ddof is 0 (population) or 1 (sample), not ${ddof}`);
+  return ddof === 1;
+}
+var StringPredicates = class {
+  _like(pattern) {
+    return new ComparisonOperation(this.comparisonOperand(), "LIKE" /* LIKE */, new StringConstantOperation(pattern));
+  }
+  /** Filter to rows where this text contains `value`. */
+  contains(value) {
+    return this._like(`%${escapeLike(value)}%`);
+  }
+  /** Filter to rows where this text starts with `prefix`. */
+  startsWith(prefix) {
+    return this._like(`${escapeLike(prefix)}%`);
+  }
+  /** Filter to rows where this text ends with `suffix`. */
+  endsWith(suffix) {
+    return this._like(`%${escapeLike(suffix)}`);
+  }
+};
+var Aggregates = class {
+  _aggregate(operator, label) {
+    return new AggregateOperation(this, operator, label + " Expression");
+  }
+  /** Sum of the values in the group. */
+  sum() {
+    return this._aggregate("SUM" /* SUM */, "Sum");
+  }
+  /** Smallest value in the group. */
+  min() {
+    return this._aggregate("MIN" /* MIN */, "Min");
+  }
+  /** Largest value in the group. */
+  max() {
+    return this._aggregate("MAX" /* MAX */, "Max");
+  }
+  /** Arithmetic mean of the values in the group. */
+  average() {
+    return this._aggregate("AVERAGE" /* AVERAGE */, "Average");
+  }
+  /** Number of non-null values in the group. */
+  count() {
+    return this._aggregate("COUNT" /* COUNT */, "Count");
+  }
+  /** Standard deviation of the values in the group: the sample one by default, `ddof = 0` for the population one. */
+  std(ddof = 1) {
+    return this._aggregate(sample(ddof) ? "STDDEV_SAMP" /* STDDEV_SAMP */ : "STDDEV_POP" /* STDDEV_POP */, "Std");
+  }
+  /** Variance of the values in the group: the sample one by default, `ddof = 0` for the population one. */
+  var(ddof = 1) {
+    return this._aggregate(sample(ddof) ? "VAR_SAMP" /* VAR_SAMP */ : "VAR_POP" /* VAR_POP */, "Var");
+  }
+};
+var BooleanAggregates = class {
+  /** True for a group where every row satisfies the condition. */
+  all() {
+    return new AggregateOperation(this, "BOOL_AND" /* BOOL_AND */, "All Expression");
+  }
+  /** True for a group where at least one row satisfies the condition. */
+  any() {
+    return new AggregateOperation(this, "BOOL_OR" /* BOOL_OR */, "Any Expression");
+  }
+};
+function applyMixins(derived, bases) {
+  for (const base of bases) {
+    for (const name of Object.getOwnPropertyNames(base.prototype)) {
+      if (name === "constructor" || Object.prototype.hasOwnProperty.call(derived.prototype, name)) continue;
+      Object.defineProperty(derived.prototype, name, Object.getOwnPropertyDescriptor(base.prototype, name));
+    }
+  }
+}
+var Arithmetic = class {
+  /** Raises if this expression is not a number. */
+  assertNumeric() {
+  }
+  _arithmetic(operator, other) {
+    this.assertNumeric();
+    let operand;
+    if (typeof other === "number") {
+      if (!Number.isFinite(other)) throw new TypeError("Arithmetic is between numbers and numeric columns, not a non-finite number");
+      operand = valueOperand(other);
+    } else if (other !== null && typeof other === "object" && typeof other.arithmeticOperand === "function") {
+      other.assertNumeric?.();
+      operand = other.arithmeticOperand();
+    } else {
+      throw new TypeError(`Arithmetic is between numbers and numeric columns, not ${other === null ? "null" : typeof other}`);
+    }
+    return new ArithmeticOperation(this.arithmeticOperand(), operator, operand);
+  }
+  /** `this + other`. */
+  plus(other) {
+    return this._arithmetic("+" /* ADD */, other);
+  }
+  /** `this - other`. */
+  minus(other) {
+    return this._arithmetic("-" /* SUBTRACT */, other);
+  }
+  /** `this * other`. */
+  times(other) {
+    return this._arithmetic("*" /* MULTIPLY */, other);
+  }
+  /** `this / other`. */
+  dividedBy(other) {
+    return this._arithmetic("/" /* DIVIDE */, other);
+  }
+};
+var ArithmeticOperation = class extends BinaryOperation {
+  constructor(left, operator, right, displayName) {
+    super(left, right);
+    this.operator = operator;
+    this.displayName = displayName;
+  }
+  operator;
+  displayName;
+  /** Sort by this expression, smallest first. */
+  ascending() {
+    return new SortOperation(this, "ASC" /* ASC */);
+  }
+  /** Sort by this expression, largest first. */
+  descending() {
+    return new SortOperation(this, "DESC" /* DESC */);
+  }
+  arithmeticOperand() {
+    return this;
+  }
+  comparisonOperand() {
+    return this;
+  }
+};
+var ConcatOperation = class extends Operation {
+  constructor(parts, displayName) {
+    super();
+    this.parts = parts;
+    this.displayName = displayName;
+  }
+  parts;
+  displayName;
+  /** Join more text on the end: `f.first().concat(' ', f.last())`. A concatenation joins into one. */
+  concat(...more) {
+    return concat(this, ...more);
+  }
+  /** Sort by this expression, smallest first. */
+  ascending() {
+    return new SortOperation(this, "ASC" /* ASC */);
+  }
+  /** Sort by this expression, largest first. */
+  descending() {
+    return new SortOperation(this, "DESC" /* DESC */);
+  }
+  comparisonOperand() {
+    return this;
+  }
+};
+function concat(...parts) {
+  const partsOf = (part) => {
+    if (part instanceof ConcatOperation) return part.parts;
+    if (typeof part === "string") return [new StringConstantOperation(part)];
+    if (part instanceof RelationalOperationElement) return [part];
+    if (part !== null && typeof part === "object" && typeof part.functionInput === "function") return [part.functionInput()];
+    throw new TypeError(`Text is joined with text, not ${part === null ? "null" : typeof part}`);
+  };
+  return new ConcatOperation(parts.flatMap(partsOf));
+}
+applyMixins(ConcatOperation, [Comparable, StringPredicates]);
+applyMixins(DateTruncOperation, [Comparable]);
+applyMixins(ArithmeticOperation, [Arithmetic, Comparable]);
+applyMixins(ScalarFunctionOperation, [Comparable, Arithmetic, StringPredicates]);
+applyMixins(AggregateOperation, [Arithmetic, Comparable, StringPredicates]);
+applyMixins(CountAllOperation, [Comparable]);
+applyMixins(NumericConstantOperation, [Arithmetic]);
+applyMixins(ConstantOperation, [Aggregates]);
+applyMixins(ArithmeticOperation, [Aggregates]);
+applyMixins(ScalarFunctionOperation, [Aggregates]);
+applyMixins(CaseOperation, [Aggregates]);
+applyMixins(IsNullOperation, [BooleanAggregates]);
+applyMixins(IsNotNullOperation, [BooleanAggregates]);
+applyMixins(InOperation, [BooleanAggregates]);
+applyMixins(NotInOperation, [BooleanAggregates]);
+applyMixins(ComparisonOperation, [BooleanAggregates]);
+applyMixins(LogicalOperation, [BooleanAggregates]);
 
 // src/datafinder/attribute.ts
 var Attribute = class _Attribute {
@@ -156,9 +636,11 @@ var Attribute = class _Attribute {
   _owner;
   _parent;
   _embedded;
-  constructor(displayName, columnName, columnDbType, owner, parent, embedded) {
+  _optional;
+  constructor(displayName, columnName, columnDbType, owner, parent, embedded, nullable = true, optional = false) {
+    this._optional = optional;
     this._displayName = displayName;
-    this._column = new Column(columnName, columnDbType, owner);
+    this._column = new Column(columnName, columnDbType, owner, false, nullable);
     this._owner = owner;
     this._parent = parent;
     this._embedded = embedded;
@@ -179,10 +661,22 @@ var Attribute = class _Attribute {
   embedded() {
     return this._embedded;
   }
+  /** @internal The expression a function of this attribute applies to: its column. */
+  functionInput() {
+    return this.cwj();
+  }
+  /** @internal What a function of this attribute is labelled after: its display name. */
+  functionLabel() {
+    return this._displayName;
+  }
+  /** @internal This attribute as an operand of arithmetic: its column. */
+  arithmeticOperand() {
+    return this.cwj();
+  }
   cwj() {
-    return new ColumnWithJoin(this._column, this._parent, this._embedded?.cwj());
+    return new ColumnWithJoin(this._column, this._parent, this._embedded?.cwj(), this._optional);
   }
-  /** Count the number of non-null values. Use in a projection with `groupByOp` to aggregate per group. */
+  /** Count the number of non-null values. Use in a projection with `groupBy` to aggregate per group. */
   count() {
     return new AggregateOperation(
       this.cwj(),
@@ -190,11 +684,26 @@ var Attribute = class _Attribute {
       this._displayName + " Count"
     );
   }
-  /** Sort this attribute in ascending order. Pass to `orderByOp` or a window function's `orderBy`. */
+  /** Name this column in the result: `f.price().sum().alias('Total')`. */
+  alias(name) {
+    return new Alias(this, name);
+  }
+  /** The number of different non-NULL values in the group: `COUNT(DISTINCT column)`. Use with `groupBy` to count per group. */
+  countDistinct() {
+    return new AggregateOperation(this.cwj(), "COUNT_DISTINCT" /* COUNT_DISTINCT */, this._displayName + " Count Distinct");
+  }
+  /** The value, or `defaultValue` when it is NULL: `name().orElse('N/A')`. Like `COALESCE` in SQL. */
+  orElse(defaultValue) {
+    if (!["string", "number", "boolean"].includes(typeof defaultValue)) {
+      throw new TypeError(`An orElse default is a string, number or boolean, not ${defaultValue === null ? "null" : typeof defaultValue}`);
+    }
+    return new ScalarFunctionOperation(this.cwj(), "COALESCE" /* COALESCE */, "Or Else " + this._displayName, void 0, [defaultValue]);
+  }
+  /** Sort this attribute in ascending order. Pass to `orderBy` or a window function's `orderBy`. */
   ascending() {
     return new SortOperation(this.cwj(), "ASC" /* ASC */);
   }
-  /** Sort this attribute in descending order. Pass to `orderByOp` or a window function's `orderBy`. */
+  /** Sort this attribute in descending order. Pass to `orderBy` or a window function's `orderBy`. */
   descending() {
     return new SortOperation(this.cwj(), "DESC" /* DESC */);
   }
@@ -206,6 +715,23 @@ var Attribute = class _Attribute {
   isNotNull() {
     return new IsNotNullOperation(this.cwj());
   }
+  /** Wrap a value as a constant of this attribute's type. Overridden by the typed attributes. */
+  toConstant(_value) {
+    throw new TypeError(`${this.constructor.name} does not support isIn / isNotIn`);
+  }
+  _constants(values) {
+    const constants = values.map((v) => this.toConstant(v));
+    if (constants.length === 0) throw new Error("isIn / isNotIn need at least one value");
+    return constants;
+  }
+  /** Filter to rows where this attribute equals any of `values`. */
+  isIn(values) {
+    return new InOperation(this.cwj(), this._constants(values));
+  }
+  /** Filter to rows where this attribute equals none of `values`. Rows with no value are excluded, as in SQL. */
+  isNotIn(values) {
+    return new NotInOperation(this.cwj(), this._constants(values));
+  }
   _windowSpec(partitionBy, orderBy) {
     const pbArr = partitionBy === void 0 ? [] : Array.isArray(partitionBy) ? partitionBy : [partitionBy];
     const pb = pbArr.map((x) => x instanceof _Attribute ? x.cwj() : x);