@malloydata/malloy 0.0.334 → 0.0.336

package/dist/api/foundation/result.d.ts

@@ -0,0 +1,185 @@
+import type { QueryData, QueryDataRow, QueryResult, QueryRunStats, ModelDef } from '../../model';
+import type { Explore, Field, AtomicField, StringField, NumberField, BooleanField, DateField, TimestampField, JSONField, UnsupportedField } from './core';
+import { PreparedResult } from './core';
+export type ResultJSON = {
+    queryResult: QueryResult;
+    modelDef: ModelDef;
+};
+/**
+ * The result of running a Malloy query.
+ *
+ * A `Result` is a `PreparedResult` along with the data retrieved from running the query.
+ */
+export declare class Result extends PreparedResult {
+    protected inner: QueryResult;
+    constructor(queryResult: QueryResult, modelDef: ModelDef);
+    get _queryResult(): QueryResult;
+    /**
+     * @return The result data.
+     */
+    get data(): DataArray;
+    get totalRows(): number;
+    get runStats(): QueryRunStats | undefined;
+    get profilingUrl(): string | undefined;
+    toJSON(): ResultJSON;
+    static fromJSON({ queryResult, modelDef }: ResultJSON): Result;
+}
+export type DataColumn = DataArray | DataRecord | DataString | DataBoolean | DataNumber | DataDate | DataTimestamp | DataNull | DataBytes | DataJSON | DataUnsupported;
+export type DataArrayOrRecord = DataArray | DataRecord;
+declare abstract class Data<T> {
+    readonly parent: DataArrayOrRecord | undefined;
+    readonly parentRecord: DataRecord | undefined;
+    protected _field: Field | Explore;
+    constructor(field: Field | Explore, parent: DataArrayOrRecord | undefined, parentRecord: DataRecord | undefined);
+    get field(): Field | Explore;
+    abstract get value(): T;
+    isString(): this is DataString;
+    get string(): DataString;
+    isBoolean(): this is DataBoolean;
+    get boolean(): DataBoolean;
+    isNumber(): this is DataNumber;
+    get number(): DataNumber;
+    isTimestamp(): this is DataTimestamp;
+    get timestamp(): DataTimestamp;
+    isDate(): this is DataDate;
+    get date(): DataDate;
+    isNull(): this is DataNull;
+    isBytes(): this is DataBytes;
+    get bytes(): DataBytes;
+    isRecord(): this is DataRecord;
+    get record(): DataRecord;
+    isUnsupported(): this is DataUnsupported;
+    get unsupported(): DataUnsupported;
+    isArray(): this is DataArray;
+    get array(): DataArray;
+    isArrayOrRecord(): DataArrayOrRecord;
+    isScalar(): this is ScalarData<T>;
+}
+declare abstract class ScalarData<T> extends Data<T> {
+    protected _value: T;
+    protected _field: AtomicField;
+    constructor(value: T, field: AtomicField, parent: DataArrayOrRecord | undefined, parentRecord: DataRecord | undefined);
+    get value(): T;
+    get field(): AtomicField;
+    abstract get key(): string;
+    isScalar(): this is ScalarData<T>;
+    abstract compareTo(other: ScalarData<T>): number;
+}
+declare class DataString extends ScalarData<string> {
+    protected _field: StringField;
+    constructor(value: string, field: StringField, parent: DataArrayOrRecord | undefined, parentRecord: DataRecord | undefined);
+    get field(): StringField;
+    get key(): string;
+    compareTo(other: ScalarData<string>): number;
+}
+declare class DataUnsupported extends ScalarData<unknown> {
+    protected _field: UnsupportedField;
+    constructor(value: unknown, field: UnsupportedField, parent: DataArrayOrRecord | undefined, parentRecord: DataRecord | undefined);
+    get field(): UnsupportedField;
+    get key(): string;
+    compareTo(_other: ScalarData<unknown>): number;
+}
+declare class DataBoolean extends ScalarData<boolean> {
+    protected _field: BooleanField;
+    constructor(value: boolean, field: BooleanField, parent: DataArrayOrRecord | undefined, parentRecord: DataRecord | undefined);
+    get field(): BooleanField;
+    get key(): string;
+    compareTo(other: ScalarData<boolean>): 0 | 1 | -1;
+}
+declare class DataJSON extends ScalarData<string> {
+    protected _field: JSONField;
+    constructor(value: string, field: JSONField, parent: DataArrayOrRecord | undefined, parentRecord: DataRecord | undefined);
+    get field(): JSONField;
+    get key(): string;
+    compareTo(other: ScalarData<string>): 0 | 1 | -1;
+}
+declare class DataNumber extends ScalarData<number> {
+    protected _field: NumberField;
+    constructor(value: unknown, field: NumberField, parent: DataArrayOrRecord | undefined, parentRecord: DataRecord | undefined);
+    get field(): NumberField;
+    get key(): string;
+    compareTo(other: ScalarData<number>): 0 | 1 | -1;
+}
+declare class DataTimestamp extends ScalarData<Date> {
+    protected _field: TimestampField;
+    constructor(value: Date, field: TimestampField, parent: DataArrayOrRecord | undefined, parentRecord: DataRecord | undefined);
+    get value(): Date;
+    get field(): TimestampField;
+    get key(): string;
+    compareTo(other: ScalarData<Date>): 0 | 1 | -1;
+}
+declare class DataDate extends ScalarData<Date> {
+    protected _field: DateField;
+    constructor(value: Date, field: DateField, parent: DataArrayOrRecord | undefined, parentRecord: DataRecord | undefined);
+    get value(): Date;
+    get field(): DateField;
+    get key(): string;
+    compareTo(other: ScalarData<Date>): 0 | 1 | -1;
+}
+declare class DataBytes extends ScalarData<Buffer> {
+    get key(): string;
+    compareTo(other: ScalarData<Buffer>): 0 | 1 | -1;
+}
+declare class DataNull extends Data<null> {
+    get value(): null;
+    get key(): string;
+}
+export declare class DataArray extends Data<QueryData> implements Iterable<DataRecord> {
+    private queryData;
+    protected _field: Explore;
+    private rowCache;
+    constructor(queryData: QueryData, field: Explore, parent: DataArrayOrRecord | undefined, parentRecord: DataRecord | undefined);
+    /**
+     * @return The `Explore` that describes the structure of this data.
+     */
+    get field(): Explore;
+    /**
+     * @return The raw query data as returned by the database driver.
+     * Values may be in various formats depending on the driver (wrapper objects, strings, etc.).
+     * Use this for passing to mapData() which handles normalization itself.
+     */
+    get rawData(): QueryData;
+    /**
+     * @return Normalized data with JS native types (number | bigint, Date).
+     * Use this for CSV output, tests, and general programmatic access.
+     */
+    toObject(): QueryData;
+    /**
+     * @return Normalized data with JSON-safe types (numbers as number | string, dates as ISO strings).
+     * Use this for JSON serialization.
+     */
+    toJSON(): QueryData;
+    path(...path: (number | string)[]): DataColumn;
+    row(index: number): DataRecord;
+    get rowCount(): number;
+    get value(): QueryData;
+    [Symbol.iterator](): Iterator<DataRecord>;
+    inMemoryStream(): AsyncIterableIterator<DataRecord>;
+}
+export declare class DataRecord extends Data<{
+    [fieldName: string]: DataColumn;
+}> {
+    private queryDataRow;
+    protected _field: Explore;
+    readonly index: number | undefined;
+    private cellCache;
+    constructor(queryDataRow: QueryDataRow, index: number | undefined, field: Explore, parent: DataArrayOrRecord | undefined, parentRecord: DataRecord | undefined);
+    /**
+     * @return Normalized data with JS native types (number | bigint, Date).
+     * Use this for CSV output, tests, and general programmatic access.
+     */
+    toObject(): QueryDataRow;
+    /**
+     * @return Normalized data with JSON-safe types (numbers as number | string, dates as ISO strings).
+     * Use this for JSON serialization.
+     */
+    toJSON(): QueryDataRow;
+    path(...path: (number | string)[]): DataColumn;
+    cell(fieldOrName: string | Field): DataColumn;
+    get value(): {
+        [fieldName: string]: DataColumn;
+    };
+    get field(): Explore;
+    [Symbol.iterator](): Iterator<DataRecord>;
+}
+export {};