data-finder-ts 0.1.3 → 0.1.4

package/dist/datafinder/attribute.d.cts

@@ -5,39 +5,80 @@ declare abstract class Attribute {
     private readonly _column;
     private readonly _owner;
     private readonly _parent?;
-    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation);
+    private readonly _embedded?;
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute);
     column(): Column;
     owner(): string;
     parent(): JoinTreeNodeOperation | undefined;
     displayName(): string;
+    /** Alternate attribute on a flat column of the owning table, used in place of this one when its join is elided. */
+    embedded(): Attribute | undefined;
     cwj(): ColumnWithJoin;
+    /** Count the number of non-null values. Use in a projection with `groupByOp` to aggregate per group. */
     count(): AggregateOperation;
+    /** Sort this attribute in ascending order. Pass to `orderByOp` or a window function's `orderBy`. */
     ascending(): SortOperation;
+    /** Sort this attribute in descending order. Pass to `orderByOp` or a window function's `orderBy`. */
     descending(): SortOperation;
+    /** Filter to rows where this attribute has no value. */
     isNull(): IsNullOperation;
+    /** Filter to rows where this attribute has a value. */
     isNotNull(): IsNotNullOperation;
     private _windowSpec;
+    /**
+     * Assign a rank to each row within the ordered window, following pandas `Series.rank` conventions.
+     *
+     * `method` controls tie-breaking (default `'min'`):
+     * - `'min'`   — tied rows share the lowest rank; the next rank skips.
+     * - `'dense'` — like `'min'` but ranks are contiguous (no gaps).
+     * - `'first'` — each row gets a unique sequential integer (no ties).
+     * - `'max'`   — only meaningful with `pct: true` (see below).
+     *
+     * When `pct: true` the result is a relative rank between 0 and 1:
+     * - `method: 'min'` (default) → fraction of values strictly below this row (PERCENT_RANK).
+     * - `method: 'max'` → fraction of values at or below this row (cumulative distribution).
+     *
+     * `partitionBy` restarts the ranking within each group of distinct values.
+     */
     rank(opts?: {
-        method?: 'min' | 'dense' | 'first';
+        method?: 'min' | 'dense' | 'first' | 'max';
         pct?: boolean;
-        partitionBy?: ColumnWithJoin | ColumnWithJoin[];
+        partitionBy?: Attribute | ColumnWithJoin | (Attribute | ColumnWithJoin)[];
         orderBy?: SortOperation | SortOperation[];
     }): WindowFunctionOperation;
+    /**
+     * Split rows into `buckets` equal-sized quantile bins ordered by `orderBy`.
+     * Each row receives a bucket number from 1 (lowest) to `buckets` (highest).
+     * Named after `pandas.qcut`.
+     */
     qcut(buckets: number, opts?: {
-        partitionBy?: ColumnWithJoin | ColumnWithJoin[];
+        partitionBy?: Attribute | ColumnWithJoin | (Attribute | ColumnWithJoin)[];
         orderBy?: SortOperation | SortOperation[];
     }): WindowFunctionOperation;
+    /**
+     * Return the value of this attribute from `periods` rows earlier (positive) or later (negative)
+     * within the ordered window, following `pandas.Series.shift`.
+     * Rows with no neighbour at the given offset return `null` (or `fillValue` if provided).
+     */
     shift(periods?: number, opts?: {
         fillValue?: string | number;
-        partitionBy?: ColumnWithJoin | ColumnWithJoin[];
+        partitionBy?: Attribute | ColumnWithJoin | (Attribute | ColumnWithJoin)[];
         orderBy?: SortOperation | SortOperation[];
     }): WindowFunctionOperation;
+    /**
+     * Return the first value of this attribute in the window frame.
+     * Use `partitionBy` to restart the frame for each group.
+     */
     first(opts?: {
-        partitionBy?: ColumnWithJoin | ColumnWithJoin[];
+        partitionBy?: Attribute | ColumnWithJoin | (Attribute | ColumnWithJoin)[];
         orderBy?: SortOperation | SortOperation[];
     }): WindowFunctionOperation;
+    /**
+     * Return the last value of this attribute in the window frame.
+     * Use `partitionBy` to restart the frame for each group.
+     */
     last(opts?: {
-        partitionBy?: ColumnWithJoin | ColumnWithJoin[];
+        partitionBy?: Attribute | ColumnWithJoin | (Attribute | ColumnWithJoin)[];
         orderBy?: SortOperation | SortOperation[];
     }): WindowFunctionOperation;
 }

package/dist/datafinder/attribute.d.ts

@@ -5,39 +5,80 @@ declare abstract class Attribute {
     private readonly _column;
     private readonly _owner;
     private readonly _parent?;
-    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation);
+    private readonly _embedded?;
+    constructor(displayName: string, columnName: string, columnDbType: string, owner: string, parent?: JoinTreeNodeOperation, embedded?: Attribute);
     column(): Column;
     owner(): string;
     parent(): JoinTreeNodeOperation | undefined;
     displayName(): string;
+    /** Alternate attribute on a flat column of the owning table, used in place of this one when its join is elided. */
+    embedded(): Attribute | undefined;
     cwj(): ColumnWithJoin;
+    /** Count the number of non-null values. Use in a projection with `groupByOp` to aggregate per group. */
     count(): AggregateOperation;
+    /** Sort this attribute in ascending order. Pass to `orderByOp` or a window function's `orderBy`. */
     ascending(): SortOperation;
+    /** Sort this attribute in descending order. Pass to `orderByOp` or a window function's `orderBy`. */
     descending(): SortOperation;
+    /** Filter to rows where this attribute has no value. */
     isNull(): IsNullOperation;
+    /** Filter to rows where this attribute has a value. */
     isNotNull(): IsNotNullOperation;
     private _windowSpec;
+    /**
+     * Assign a rank to each row within the ordered window, following pandas `Series.rank` conventions.
+     *
+     * `method` controls tie-breaking (default `'min'`):
+     * - `'min'`   — tied rows share the lowest rank; the next rank skips.
+     * - `'dense'` — like `'min'` but ranks are contiguous (no gaps).
+     * - `'first'` — each row gets a unique sequential integer (no ties).
+     * - `'max'`   — only meaningful with `pct: true` (see below).
+     *
+     * When `pct: true` the result is a relative rank between 0 and 1:
+     * - `method: 'min'` (default) → fraction of values strictly below this row (PERCENT_RANK).
+     * - `method: 'max'` → fraction of values at or below this row (cumulative distribution).
+     *
+     * `partitionBy` restarts the ranking within each group of distinct values.
+     */
     rank(opts?: {
-        method?: 'min' | 'dense' | 'first';
+        method?: 'min' | 'dense' | 'first' | 'max';
         pct?: boolean;
-        partitionBy?: ColumnWithJoin | ColumnWithJoin[];
+        partitionBy?: Attribute | ColumnWithJoin | (Attribute | ColumnWithJoin)[];
         orderBy?: SortOperation | SortOperation[];
     }): WindowFunctionOperation;
+    /**
+     * Split rows into `buckets` equal-sized quantile bins ordered by `orderBy`.
+     * Each row receives a bucket number from 1 (lowest) to `buckets` (highest).
+     * Named after `pandas.qcut`.
+     */
     qcut(buckets: number, opts?: {
-        partitionBy?: ColumnWithJoin | ColumnWithJoin[];
+        partitionBy?: Attribute | ColumnWithJoin | (Attribute | ColumnWithJoin)[];
         orderBy?: SortOperation | SortOperation[];
     }): WindowFunctionOperation;
+    /**
+     * Return the value of this attribute from `periods` rows earlier (positive) or later (negative)
+     * within the ordered window, following `pandas.Series.shift`.
+     * Rows with no neighbour at the given offset return `null` (or `fillValue` if provided).
+     */
     shift(periods?: number, opts?: {
         fillValue?: string | number;
-        partitionBy?: ColumnWithJoin | ColumnWithJoin[];
+        partitionBy?: Attribute | ColumnWithJoin | (Attribute | ColumnWithJoin)[];
         orderBy?: SortOperation | SortOperation[];
     }): WindowFunctionOperation;
+    /**
+     * Return the first value of this attribute in the window frame.
+     * Use `partitionBy` to restart the frame for each group.
+     */
     first(opts?: {
-        partitionBy?: ColumnWithJoin | ColumnWithJoin[];
+        partitionBy?: Attribute | ColumnWithJoin | (Attribute | ColumnWithJoin)[];
         orderBy?: SortOperation | SortOperation[];
     }): WindowFunctionOperation;
+    /**
+     * Return the last value of this attribute in the window frame.
+     * Use `partitionBy` to restart the frame for each group.
+     */
     last(opts?: {
-        partitionBy?: ColumnWithJoin | ColumnWithJoin[];
+        partitionBy?: Attribute | ColumnWithJoin | (Attribute | ColumnWithJoin)[];
         orderBy?: SortOperation | SortOperation[];
     }): WindowFunctionOperation;
 }

package/dist/datafinder/attribute.js

@@ -1,7 +1,7 @@
 import {
   Attribute
-} from "../chunk-V647VNMY.js";
-import "../chunk-3SSWFES4.js";
+} from "../chunk-4JVW4TAB.js";
+import "../chunk-UYMOE6YU.js";
 export {
   Attribute
 };