data-finder-ts 0.1.3 → 0.1.5

package/dist/model/relational.js

@@ -1,14 +1,24 @@
 import {
   AggregateOperation,
   AggregateOperator,
+  Aggregates,
+  Alias,
+  Arithmetic,
+  ArithmeticOperation,
+  ArithmeticOperator,
   BinaryOperation,
+  BooleanAggregates,
   BooleanConstantOperation,
+  CaseOperation,
   Column,
   ColumnWithJoin,
+  Comparable,
   ComparisonOperation,
   ComparisonOperator,
+  ConcatOperation,
   ConstantOperation,
   CountAllOperation,
+  DATE_ONLY_PATTERN,
   DataCatalog,
   DataStore,
   Database,
@@ -16,44 +26,73 @@ import {
   DateConstantOperation,
   DateDiffOperation,
   DateExtractOperation,
+  DateOnly,
   DatePart,
   DateTimeConstantOperation,
+  DateTruncOperation,
   DecimalConstantOperation,
+  ExistsOperation,
   FloatConstantOperation,
   ForeignKey,
+  InOperation,
   IntegerConstantOperation,
   IsNotNullOperation,
   IsNullOperation,
   JoinOperation,
   JoinTreeNodeOperation,
+  LIKE_ESCAPE,
   LogicalOperation,
   LogicalOperator,
+  NUMERIC_FUNCTIONS,
   NoOperation,
+  NotExistsOperation,
+  NotInOperation,
+  NumericConstantOperation,
   Operation,
   RelationalOperationElement,
   ScalarFunction,
   ScalarFunctionOperation,
   Schema,
+  SelectOperation,
   SortDirection,
   SortOperation,
   StringConstantOperation,
+  StringPredicates,
   Table,
   UnaryOperation,
   WindowFunction,
   WindowFunctionOperation,
-  WindowSpecification
-} from "../chunk-3SSWFES4.js";
+  WindowSpecification,
+  applyMixins,
+  concat,
+  containsAggregate,
+  containsAggregateOrWindow,
+  escapeLike,
+  operandOf,
+  sample,
+  valueOperand
+} from "../chunk-PF6EJZHB.js";
 export {
   AggregateOperation,
   AggregateOperator,
+  Aggregates,
+  Alias,
+  Arithmetic,
+  ArithmeticOperation,
+  ArithmeticOperator,
   BinaryOperation,
+  BooleanAggregates,
   BooleanConstantOperation,
+  CaseOperation,
   Column,
   ColumnWithJoin,
+  Comparable,
   ComparisonOperation,
   ComparisonOperator,
+  ConcatOperation,
   ConstantOperation,
   CountAllOperation,
+  DATE_ONLY_PATTERN,
   DataCatalog,
   DataStore,
   Database,
@@ -61,31 +100,50 @@ export {
   DateConstantOperation,
   DateDiffOperation,
   DateExtractOperation,
+  DateOnly,
   DatePart,
   DateTimeConstantOperation,
+  DateTruncOperation,
   DecimalConstantOperation,
+  ExistsOperation,
   FloatConstantOperation,
   ForeignKey,
+  InOperation,
   IntegerConstantOperation,
   IsNotNullOperation,
   IsNullOperation,
   JoinOperation,
   JoinTreeNodeOperation,
+  LIKE_ESCAPE,
   LogicalOperation,
   LogicalOperator,
+  NUMERIC_FUNCTIONS,
   NoOperation,
+  NotExistsOperation,
+  NotInOperation,
+  NumericConstantOperation,
   Operation,
   RelationalOperationElement,
   ScalarFunction,
   ScalarFunctionOperation,
   Schema,
+  SelectOperation,
   SortDirection,
   SortOperation,
   StringConstantOperation,
+  StringPredicates,
   Table,
   UnaryOperation,
   WindowFunction,
   WindowFunctionOperation,
-  WindowSpecification
+  WindowSpecification,
+  applyMixins,
+  concat,
+  containsAggregate,
+  containsAggregateOrWindow,
+  escapeLike,
+  operandOf,
+  sample,
+  valueOperand
 };
 //# sourceMappingURL=relational.js.map

package/dist/typed-attributes-CUTf_6Ru.d.ts

@@ -0,0 +1,328 @@
+import { Attribute, AttributeValue } from './datafinder/attribute.js';
+import { RelationalOperationElement, ScalarFunctionOperation, ConcatPart, ConcatOperation, JoinTreeNodeOperation, ConstantOperation, ComparisonOperation, DateExtractOperation, DateTruncOperation, DateArithmeticOperation, DateDiffOperation, ColumnWithJoin, AggregateOperation, Arithmetic, SortOperation } from './model/relational.js';
+
+/**
+ * Scalar functions as methods, shared by attributes and by the results of other functions, so they chain:
+ * `f.name().toUpperCase().length()`.
+ *
+ * TypeScript has no multiple inheritance, so each group of functions is a class whose methods are mixed into
+ * every host with `applyMixins` (the handbook's pattern), the type side being an `interface Host extends Group {}`
+ * beside the host. A host provides `functionInput()` and `functionLabel()`: an attribute reads its column and is
+ * labelled by its display name; a function result is itself the input and is labelled by its own name.
+ */
+
+/** Functions of text. */
+declare abstract class StringFunctions {
+    /** @internal The expression the function applies to. */
+    abstract functionInput(): RelationalOperationElement;
+    /** @internal What a function of this is labelled after. */
+    abstract functionLabel(): string;
+    /** Join text on the end: `f.first().concat(' ', f.last())`. A NULL part makes the whole NULL. */
+    concat(...more: ConcatPart[]): ConcatOperation;
+    /** Convert every character to uppercase. */
+    toUpperCase(): StringFunctionOperation;
+    /** Convert every character to lowercase. */
+    toLowerCase(): StringFunctionOperation;
+    /** Remove leading and trailing whitespace. */
+    trim(): StringFunctionOperation;
+    /** Remove leading whitespace. */
+    trimStart(): StringFunctionOperation;
+    /** Remove trailing whitespace. */
+    trimEnd(): StringFunctionOperation;
+    /** Return the number of characters in the string. */
+    length(): NumericFunctionOperation;
+    /** Return the string with characters in reverse order. */
+    reverse(): StringFunctionOperation;
+    /** Return the first `n` characters. */
+    left(n: number): StringFunctionOperation;
+    /** Return the last `n` characters. */
+    right(n: number): StringFunctionOperation;
+    /** Return the string repeated `n` times. */
+    repeat(n: number): StringFunctionOperation;
+    /** Replace all occurrences of `fromStr` with `toStr`. */
+    replace(fromStr: string, toStr: string): StringFunctionOperation;
+    /**
+     * Extract a portion of the string.
+     * `start` is zero-based (following Python convention); `length` is optional.
+     */
+    substring(start: number, length?: number): StringFunctionOperation;
+}
+/** Functions of a number. */
+declare abstract class NumericFunctions {
+    /** @internal The expression the function applies to. */
+    abstract functionInput(): RelationalOperationElement;
+    /** @internal What a function of this is labelled after. */
+    abstract functionLabel(): string;
+    /** Absolute value (distance from zero, always non-negative). */
+    abs(): NumericFunctionOperation;
+    /** Round up to the nearest integer. */
+    ceil(): NumericFunctionOperation;
+    /** Round down to the nearest integer. */
+    floor(): NumericFunctionOperation;
+    /** Square root. */
+    sqrt(): NumericFunctionOperation;
+    /** Remainder after dividing by `n`. */
+    mod(n: number): NumericFunctionOperation;
+    /** Raise to the power of `n`. */
+    power(n: number): NumericFunctionOperation;
+    /** Round to `d` decimal places, or to the nearest integer when `d` is omitted. */
+    round(d?: number): NumericFunctionOperation;
+}
+/** A function result that gives text, which has the string functions too: `f.name().toUpperCase().length()`. */
+declare class StringFunctionOperation extends ScalarFunctionOperation {
+    functionInput(): RelationalOperationElement;
+    functionLabel(): string;
+}
+interface StringFunctionOperation extends StringFunctions {
+}
+/** A function result that gives a number, which has the numeric functions too. */
+declare class NumericFunctionOperation extends ScalarFunctionOperation {
+    functionInput(): RelationalOperationElement;
+    functionLabel(): string;
+}
+interface NumericFunctionOperation extends NumericFunctions {
+}
+
+/** The smallest and largest value of a group, for a column that can be ordered but not summed. */
+declare abstract class MinMax {
+    abstract cwj(): ColumnWithJoin;
+    abstract displayName(): string;
+    /** Smallest value in the group. */
+    min(): AggregateOperation;
+    /** Largest value in the group. */
+    max(): AggregateOperation;
+}
+declare class StringAttribute extends Attribute {
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute, nullable?: boolean, optional?: boolean);
+    protected toConstant(value: AttributeValue): ConstantOperation;
+    /**
+     * Join the values of a group into one text with `separator` between them. `orderBy` is the order they are
+     * joined in (`[f.name().ascending()]`); without it the order is not defined. Missing values are skipped.
+     */
+    join(separator?: string, orderBy?: SortOperation[]): AggregateOperation;
+    /** Filter to rows where this attribute equals `value`. */
+    eq(value: string): ComparisonOperation;
+    /** Filter to rows where this attribute does not equal `value`. */
+    ne(value: string): ComparisonOperation;
+    /** Filter to rows where this attribute contains `value` as a substring. */
+    contains(value: string): ComparisonOperation;
+    /** Filter to rows where this attribute begins with `prefix`. */
+    startsWith(prefix: string): ComparisonOperation;
+    /** Filter to rows where this attribute ends with `suffix`. */
+    endsWith(suffix: string): ComparisonOperation;
+    /** Filter to rows where this attribute does not contain `value` as a substring. */
+    notContains(value: string): ComparisonOperation;
+}
+interface StringAttribute extends MinMax, StringFunctions {
+}
+declare abstract class NumericAttribute extends Attribute {
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute, nullable?: boolean, optional?: boolean);
+    /** Sum of all values in the group. */
+    sum(): AggregateOperation;
+    /** Arithmetic mean of all values in the group. */
+    average(): AggregateOperation;
+    /** Standard deviation of the values in the group: the sample one by default, `ddof = 0` for the population one, as `Series.std`. */
+    std(ddof?: number): AggregateOperation;
+    /** Variance of the values in the group: the sample one by default, `ddof = 0` for the population one, as `Series.var`. */
+    var(ddof?: number): AggregateOperation;
+}
+interface NumericAttribute extends MinMax, NumericFunctions, Arithmetic {
+}
+declare class DoubleAttribute extends NumericAttribute {
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute, nullable?: boolean, optional?: boolean);
+    protected toConstant(value: AttributeValue): ConstantOperation;
+    /** Filter to rows where this attribute equals `value`. */
+    eq(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute does not equal `value`. */
+    ne(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute is greater than `value`. */
+    gt(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute is less than `value`. */
+    lt(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute is greater than or equal to `value`. */
+    gte(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute is less than or equal to `value`. */
+    lte(value: number): ComparisonOperation;
+}
+declare const FloatAttribute: typeof DoubleAttribute;
+type FloatAttribute = DoubleAttribute;
+declare class DecimalAttribute extends NumericAttribute {
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute, nullable?: boolean, optional?: boolean);
+    protected toConstant(value: AttributeValue): ConstantOperation;
+    /** Filter to rows where this attribute equals `value`. */
+    eq(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute does not equal `value`. */
+    ne(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute is greater than `value`. */
+    gt(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute is less than `value`. */
+    lt(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute is greater than or equal to `value`. */
+    gte(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute is less than or equal to `value`. */
+    lte(value: number): ComparisonOperation;
+}
+declare class IntegerAttribute extends NumericAttribute {
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute, nullable?: boolean, optional?: boolean);
+    protected toConstant(value: AttributeValue): ConstantOperation;
+    /** Filter to rows where this attribute equals `value`. */
+    eq(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute does not equal `value`. */
+    ne(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute is greater than `value`. */
+    gt(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute is less than `value`. */
+    lt(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute is greater than or equal to `value`. */
+    gte(value: number): ComparisonOperation;
+    /** Filter to rows where this attribute is less than or equal to `value`. */
+    lte(value: number): ComparisonOperation;
+}
+declare class BooleanAttribute extends Attribute {
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute, nullable?: boolean, optional?: boolean);
+    protected toConstant(value: AttributeValue): ConstantOperation;
+    /** Filter to rows where this attribute equals `value`. */
+    eq(value: boolean): ComparisonOperation;
+    /** Filter to rows where this attribute is true. */
+    isTrue(): ComparisonOperation;
+    /** Filter to rows where this attribute is false. */
+    isFalse(): ComparisonOperation;
+}
+declare class DateAttribute extends Attribute {
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute, nullable?: boolean, optional?: boolean);
+    protected toConstant(value: AttributeValue): ConstantOperation;
+    /** Filter to rows where this date equals `value`. */
+    eq(value: Date | string): ComparisonOperation;
+    /** Filter to rows where this date does not equal `value`. */
+    ne(value: Date | string): ComparisonOperation;
+    /** Filter to rows where this date is after `value`. */
+    gt(value: Date | string): ComparisonOperation;
+    /** Filter to rows where this date is before `value`. */
+    lt(value: Date | string): ComparisonOperation;
+    /** Filter to rows where this date is on or after `value`. */
+    gte(value: Date | string): ComparisonOperation;
+    /** Filter to rows where this date is on or before `value`. */
+    lte(value: Date | string): ComparisonOperation;
+    /** Extract the four-digit calendar year. */
+    year(): DateExtractOperation;
+    /** Extract the month number (1–12). */
+    month(): DateExtractOperation;
+    /** Extract the day of the month (1–31). */
+    day(): DateExtractOperation;
+    /** Extract the quarter (1–4). */
+    quarter(): DateExtractOperation;
+    /** Extract the ISO week number (1–53). */
+    week(): DateExtractOperation;
+    /** Extract the day of the week (0 = Sunday through 6 = Saturday). */
+    dayOfWeek(): DateExtractOperation;
+    /** The date of the first day of the week the date falls in (a Monday). */
+    firstDayOfWeek(): DateTruncOperation;
+    /** The date of the first day of the month the date falls in. */
+    firstDayOfMonth(): DateTruncOperation;
+    /** The date of the first day of the quarter the date falls in. */
+    firstDayOfQuarter(): DateTruncOperation;
+    /** The date of the first day of the year the date falls in. */
+    firstDayOfYear(): DateTruncOperation;
+    /** Add `n` days to this date. */
+    addDays(n: number): DateArithmeticOperation;
+    /** Add `n` months to this date. */
+    addMonths(n: number): DateArithmeticOperation;
+    /** Add `n` years to this date. */
+    addYears(n: number): DateArithmeticOperation;
+    /** Subtract `n` days from this date. */
+    subtractDays(n: number): DateArithmeticOperation;
+    /** Subtract `n` months from this date. */
+    subtractMonths(n: number): DateArithmeticOperation;
+    /** Subtract `n` years from this date. */
+    subtractYears(n: number): DateArithmeticOperation;
+    /** Number of whole days between this date and `other`. */
+    diffDays(other: Date): DateDiffOperation;
+    /** Number of whole months between this date and `other`. */
+    diffMonths(other: Date): DateDiffOperation;
+    /** Number of whole years between this date and `other`. */
+    diffYears(other: Date): DateDiffOperation;
+}
+interface DateAttribute extends MinMax {
+}
+declare class DateTimeAttribute extends Attribute {
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute, nullable?: boolean, optional?: boolean);
+    protected toConstant(value: AttributeValue): ConstantOperation;
+    /** Filter to rows where this timestamp equals `value`. */
+    eq(value: Date | string): ComparisonOperation;
+    /** Filter to rows where this timestamp does not equal `value`. */
+    ne(value: Date | string): ComparisonOperation;
+    /** Filter to rows where this timestamp is after `value`. */
+    gt(value: Date | string): ComparisonOperation;
+    /** Filter to rows where this timestamp is before `value`. */
+    lt(value: Date | string): ComparisonOperation;
+    /** Filter to rows where this timestamp is on or after `value`. */
+    gte(value: Date | string): ComparisonOperation;
+    /** Filter to rows where this timestamp is on or before `value`. */
+    lte(value: Date | string): ComparisonOperation;
+    /** Extract the four-digit calendar year. */
+    year(): DateExtractOperation;
+    /** Extract the month number (1–12). */
+    month(): DateExtractOperation;
+    /** Extract the day of the month (1–31). */
+    day(): DateExtractOperation;
+    /** Extract the hour (0–23). */
+    hour(): DateExtractOperation;
+    /** Extract the minute (0–59). */
+    minute(): DateExtractOperation;
+    /** Extract the second (0–59). */
+    second(): DateExtractOperation;
+    /** Extract the quarter (1–4). */
+    quarter(): DateExtractOperation;
+    /** Extract the ISO week number (1–53). */
+    week(): DateExtractOperation;
+    /** Extract the day of the week (0 = Sunday through 6 = Saturday). */
+    dayOfWeek(): DateExtractOperation;
+    /** The date of the first day of the week the date falls in (a Monday). */
+    firstDayOfWeek(): DateTruncOperation;
+    /** The date of the first day of the month the date falls in. */
+    firstDayOfMonth(): DateTruncOperation;
+    /** The date of the first day of the quarter the date falls in. */
+    firstDayOfQuarter(): DateTruncOperation;
+    /** The date of the first day of the year the date falls in. */
+    firstDayOfYear(): DateTruncOperation;
+    /** Add `n` days to this timestamp. */
+    addDays(n: number): DateArithmeticOperation;
+    /** Add `n` months to this timestamp. */
+    addMonths(n: number): DateArithmeticOperation;
+    /** Add `n` years to this timestamp. */
+    addYears(n: number): DateArithmeticOperation;
+    /** Add `n` hours to this timestamp. */
+    addHours(n: number): DateArithmeticOperation;
+    /** Add `n` minutes to this timestamp. */
+    addMinutes(n: number): DateArithmeticOperation;
+    /** Add `n` seconds to this timestamp. */
+    addSeconds(n: number): DateArithmeticOperation;
+    /** Subtract `n` days from this timestamp. */
+    subtractDays(n: number): DateArithmeticOperation;
+    /** Subtract `n` months from this timestamp. */
+    subtractMonths(n: number): DateArithmeticOperation;
+    /** Subtract `n` years from this timestamp. */
+    subtractYears(n: number): DateArithmeticOperation;
+    /** Subtract `n` hours from this timestamp. */
+    subtractHours(n: number): DateArithmeticOperation;
+    /** Subtract `n` minutes from this timestamp. */
+    subtractMinutes(n: number): DateArithmeticOperation;
+    /** Subtract `n` seconds from this timestamp. */
+    subtractSeconds(n: number): DateArithmeticOperation;
+    /** Number of whole days between this timestamp and `other`. */
+    diffDays(other: Date): DateDiffOperation;
+    /** Number of whole months between this timestamp and `other`. */
+    diffMonths(other: Date): DateDiffOperation;
+    /** Number of whole years between this timestamp and `other`. */
+    diffYears(other: Date): DateDiffOperation;
+    /** Number of whole hours between this timestamp and `other`. */
+    diffHours(other: Date): DateDiffOperation;
+    /** Number of whole minutes between this timestamp and `other`. */
+    diffMinutes(other: Date): DateDiffOperation;
+    /** Number of whole seconds between this timestamp and `other`. */
+    diffSeconds(other: Date): DateDiffOperation;
+}
+interface DateTimeAttribute extends MinMax {
+}
+
+export { BooleanAttribute as B, DateAttribute as D, FloatAttribute as F, IntegerAttribute as I, NumericAttribute as N, StringAttribute as S, DateTimeAttribute as a, DecimalAttribute as b, DoubleAttribute as c, NumericFunctionOperation as d, StringFunctionOperation as e };