data-finder-ts 0.1.3 → 0.1.4

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

@@ -2,133 +2,240 @@ import { Attribute } from './attribute.js';
 import { JoinTreeNodeOperation, Operation, DateExtractOperation, DateArithmeticOperation, DateDiffOperation, AggregateOperation, ScalarFunctionOperation } from '../model/relational.js';
 
 declare class StringAttribute extends Attribute {
-    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation);
-    upper(): ScalarFunctionOperation;
-    lower(): ScalarFunctionOperation;
-    strip(): ScalarFunctionOperation;
-    lstrip(): ScalarFunctionOperation;
-    rstrip(): ScalarFunctionOperation;
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute);
+    /** Convert every character to uppercase. */
+    toUpperCase(): ScalarFunctionOperation;
+    /** Convert every character to lowercase. */
+    toLowerCase(): ScalarFunctionOperation;
+    /** Remove leading and trailing whitespace. */
+    trim(): ScalarFunctionOperation;
+    /** Remove leading whitespace. */
+    trimStart(): ScalarFunctionOperation;
+    /** Remove trailing whitespace. */
+    trimEnd(): ScalarFunctionOperation;
+    /** Return the number of characters in the string. */
     length(): ScalarFunctionOperation;
+    /** Return the string with characters in reverse order. */
     reverse(): ScalarFunctionOperation;
+    /** Return the first `n` characters. */
     left(n: number): ScalarFunctionOperation;
+    /** Return the last `n` characters. */
     right(n: number): ScalarFunctionOperation;
+    /** Return the string repeated `n` times. */
     repeat(n: number): ScalarFunctionOperation;
+    /** Replace all occurrences of `fromStr` with `toStr`. */
     replace(fromStr: string, toStr: string): ScalarFunctionOperation;
+    /**
+     * Extract a portion of the string.
+     * `start` is zero-based (following Python convention); `length` is optional.
+     */
     substring(start: number, length?: number): ScalarFunctionOperation;
+    /** Filter to rows where this attribute equals `value`. */
     eq(value: string): Operation;
+    /** Filter to rows where this attribute does not equal `value`. */
     ne(value: string): Operation;
+    /** Filter to rows where this attribute contains `value` as a substring. */
     contains(value: string): Operation;
+    /** Filter to rows where this attribute begins with `prefix`. */
     startsWith(prefix: string): Operation;
+    /** Filter to rows where this attribute ends with `suffix`. */
     endsWith(suffix: string): Operation;
+    /** Filter to rows where this attribute does not contain `value` as a substring. */
     notContains(value: string): Operation;
 }
 declare abstract class NumericAttribute extends Attribute {
-    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation);
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute);
+    /** Sum of all values in the group. */
     sum(): AggregateOperation;
+    /** Smallest value in the group. */
     min(): AggregateOperation;
+    /** Largest value in the group. */
     max(): AggregateOperation;
+    /** Arithmetic mean of all values in the group. */
     average(): AggregateOperation;
+    /** Absolute value (distance from zero, always non-negative). */
     abs(): ScalarFunctionOperation;
+    /** Round up to the nearest integer. */
     ceil(): ScalarFunctionOperation;
+    /** Round down to the nearest integer. */
     floor(): ScalarFunctionOperation;
+    /** Square root. */
     sqrt(): ScalarFunctionOperation;
+    /** Remainder after dividing by `n`. */
     mod(n: number): ScalarFunctionOperation;
+    /** Raise to the power of `n`. */
     power(n: number): ScalarFunctionOperation;
+    /** Round to `d` decimal places, or to the nearest integer when `d` is omitted. */
     round(d?: number): ScalarFunctionOperation;
 }
 declare class DoubleAttribute extends NumericAttribute {
-    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation);
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute);
+    /** Filter to rows where this attribute equals `value`. */
     eq(value: number): Operation;
+    /** Filter to rows where this attribute does not equal `value`. */
     ne(value: number): Operation;
+    /** Filter to rows where this attribute is greater than `value`. */
     gt(value: number): Operation;
+    /** Filter to rows where this attribute is less than `value`. */
     lt(value: number): Operation;
+    /** Filter to rows where this attribute is greater than or equal to `value`. */
     gte(value: number): Operation;
+    /** Filter to rows where this attribute is less than or equal to `value`. */
     lte(value: number): Operation;
 }
 declare const FloatAttribute: typeof DoubleAttribute;
 type FloatAttribute = DoubleAttribute;
 declare class DecimalAttribute extends NumericAttribute {
-    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation);
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute);
+    /** Filter to rows where this attribute equals `value`. */
     eq(value: number): Operation;
+    /** Filter to rows where this attribute does not equal `value`. */
     ne(value: number): Operation;
+    /** Filter to rows where this attribute is greater than `value`. */
     gt(value: number): Operation;
+    /** Filter to rows where this attribute is less than `value`. */
     lt(value: number): Operation;
+    /** Filter to rows where this attribute is greater than or equal to `value`. */
     gte(value: number): Operation;
+    /** Filter to rows where this attribute is less than or equal to `value`. */
     lte(value: number): Operation;
 }
 declare class IntegerAttribute extends NumericAttribute {
-    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation);
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute);
+    /** Filter to rows where this attribute equals `value`. */
     eq(value: number): Operation;
+    /** Filter to rows where this attribute does not equal `value`. */
     ne(value: number): Operation;
+    /** Filter to rows where this attribute is greater than `value`. */
     gt(value: number): Operation;
+    /** Filter to rows where this attribute is less than `value`. */
     lt(value: number): Operation;
+    /** Filter to rows where this attribute is greater than or equal to `value`. */
     gte(value: number): Operation;
+    /** Filter to rows where this attribute is less than or equal to `value`. */
     lte(value: number): Operation;
 }
 declare class BooleanAttribute extends Attribute {
-    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation);
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute);
+    /** Filter to rows where this attribute equals `value`. */
     eq(value: boolean): Operation;
+    /** Filter to rows where this attribute is true. */
     isTrue(): Operation;
+    /** Filter to rows where this attribute is false. */
     isFalse(): Operation;
 }
 declare class DateAttribute extends Attribute {
-    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation);
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute);
+    /** Filter to rows where this date equals `value`. */
     eq(value: Date | string): Operation;
+    /** Filter to rows where this date does not equal `value`. */
     ne(value: Date | string): Operation;
+    /** Filter to rows where this date is after `value`. */
     gt(value: Date | string): Operation;
+    /** Filter to rows where this date is before `value`. */
     lt(value: Date | string): Operation;
+    /** Filter to rows where this date is on or after `value`. */
     gte(value: Date | string): Operation;
+    /** Filter to rows where this date is on or before `value`. */
     lte(value: Date | string): Operation;
+    /** 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;
+    /** 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;
 }
 declare class DateTimeAttribute extends Attribute {
-    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation);
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute);
+    /** Filter to rows where this timestamp equals `value`. */
     eq(value: Date | string): Operation;
+    /** Filter to rows where this timestamp does not equal `value`. */
     ne(value: Date | string): Operation;
+    /** Filter to rows where this timestamp is after `value`. */
     gt(value: Date | string): Operation;
+    /** Filter to rows where this timestamp is before `value`. */
     lt(value: Date | string): Operation;
+    /** Filter to rows where this timestamp is on or after `value`. */
     gte(value: Date | string): Operation;
+    /** Filter to rows where this timestamp is on or before `value`. */
     lte(value: Date | string): Operation;
+    /** 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;
+    /** 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;
 }
 

package/dist/datafinder/typed-attributes.js

@@ -8,9 +8,9 @@ import {
   IntegerAttribute,
   NumericAttribute,
   StringAttribute
-} from "../chunk-5K2Z3YDY.js";
-import "../chunk-V647VNMY.js";
-import "../chunk-3SSWFES4.js";
+} from "../chunk-4LNZV6EN.js";
+import "../chunk-4JVW4TAB.js";
+import "../chunk-UYMOE6YU.js";
 export {
   BooleanAttribute,
   DateAttribute,