gscdump 1.3.2 → 1.4.1

package/dist/_chunks/plan.d.mts

@@ -1,175 +0,0 @@
-import { TableName } from "./contracts.mjs";
-import { Result } from "./result.mjs";
-import { BuilderState, Dimension, FilterOperator, Metric, MetricOperator, QueryParamName } from "./types.mjs";
-type QueryErrorKind = 'missing-date-range' | 'invalid-row-limit' | 'invalid-start-row' | 'invalid-data-state' | 'invalid-aggregation-type' | 'invalid-builder-state' | 'invalid-filter' | 'unsupported-capability' | 'unresolvable-dataset';
-type QueryError = {
-  kind: 'missing-date-range';
-  message: string;
-} | {
-  kind: 'invalid-row-limit';
-  value: unknown;
-  message: string;
-} | {
-  kind: 'invalid-start-row';
-  value: unknown;
-  message: string;
-} | {
-  kind: 'invalid-data-state';
-  message: string;
-} | {
-  kind: 'invalid-aggregation-type';
-  message: string;
-} | {
-  kind: 'invalid-builder-state';
-  message: string;
-  cause?: unknown;
-} | {
-  kind: 'invalid-filter';
-  message: string;
-} | {
-  kind: 'unsupported-capability';
-  capability: string;
-  context: string;
-  message: string;
-} | {
-  kind: 'unresolvable-dataset';
-  dimensions: readonly Dimension[];
-  filterDims: readonly Dimension[];
-  message: string;
-};
-declare const queryErrors: {
-  readonly missingDateRange: () => QueryError;
-  readonly invalidRowLimit: (value: unknown) => QueryError;
-  readonly invalidStartRow: (value: unknown) => QueryError;
-  readonly hourDimensionRequiresHourlyState: () => QueryError;
-  readonly hourlyStateRequiresHourDimension: () => QueryError;
-  readonly byPropertyUnsupportedSearchType: () => QueryError;
-  readonly byPropertyNotAllowedWithPage: () => QueryError;
-  readonly byNewsShowcaseRequiresSearchType: () => QueryError;
-  readonly byNewsShowcaseNotAllowedWithPage: () => QueryError;
-  readonly byNewsShowcaseRequiresShowcaseFilter: () => QueryError;
-  readonly invalidBuilderState: (cause?: unknown) => QueryError;
-  readonly malformedFilterLeaf: () => QueryError;
-  readonly unsupportedCapability: (capability: string, context: string) => QueryError;
-  readonly unresolvableDataset: (dimensions: readonly Dimension[], filterDims?: readonly Dimension[]) => QueryError;
-};
-declare function isQueryError(value: unknown): value is QueryError;
-/**
- * Thrown when a query needs a planner capability (regex pushdown, comparison
- * joins, multi-dataset reads) the target engine lacks. Engines catch it to fall
- * back to the live GSC API. Carries the typed `queryError` value so a caller can
- * read the modelled failure instead of parsing the message.
- */
-declare class UnsupportedLogicalCapabilityError extends Error {
-  readonly queryError: Extract<QueryError, {
-    kind: 'unsupported-capability';
-  }>;
-  constructor(capability: string, context: string);
-}
-/**
- * Thrown when a query's grouped + filtered dimensions span more than one stored
- * dataset. Replaces the resolver's raw "unknown column" error so hosts can map
- * it to a 4xx instead of leaking an opaque 500. Carries the typed `queryError`.
- */
-declare class UnresolvableDatasetError extends Error {
-  readonly queryError: Extract<QueryError, {
-    kind: 'unresolvable-dataset';
-  }>;
-  constructor(dimensions: readonly Dimension[], filterDims?: readonly Dimension[]);
-}
-/**
- * Re-raises a `QueryError` value as an `Error`, preserving the historical class
- * identity for the two errors engines match on by name (`UnresolvableDatasetError`,
- * `UnsupportedLogicalCapabilityError`). Pairs with `unwrapResult` so a
- * `fooResult(): Result<A, QueryError>` core can back a throwing `foo()`.
- */
-declare function queryErrorToException(error: QueryError): Error;
-type LogicalDataset = TableName;
-type ComparisonFilter = 'new' | 'lost' | 'improving' | 'declining';
-interface PlannerCapabilities {
-  regex?: boolean;
-  multiDataset?: boolean;
-  comparisonJoin?: boolean;
-  windowTotals?: boolean;
-}
-interface LogicalDimensionFilter {
-  dimension: Dimension;
-  operator: FilterOperator;
-  expression: string;
-  expression2?: string;
-}
-interface LogicalMetricFilter {
-  metric: Metric;
-  operator: MetricOperator;
-  expression: number;
-  expression2?: number;
-}
-interface LogicalFilterLeaf {
-  kind: 'leaf';
-  filter: LogicalDimensionFilter;
-}
-interface LogicalFilterGroup {
-  kind: 'group';
-  groupType: 'and' | 'or';
-  children: LogicalFilterNode[];
-}
-type LogicalFilterNode = LogicalFilterLeaf | LogicalFilterGroup;
-interface LogicalQueryPlan {
-  dataset: LogicalDataset;
-  dimensions: Dimension[];
-  groupByDimensions: Dimension[];
-  hasDate: boolean;
-  metrics: Metric[];
-  dateRange: {
-    startDate: string;
-    endDate: string;
-  };
-  dimensionFilters: LogicalDimensionFilter[];
-  dimensionFilterTree?: LogicalFilterNode;
-  metricFilters: LogicalMetricFilter[];
-  prefilters: LogicalMetricFilter[];
-  specialFilters: {
-    topLevel: boolean;
-  };
-  queryParams: Partial<Record<QueryParamName, string>>;
-  orderBy?: BuilderState['orderBy'];
-  rowLimit?: number;
-  startRow?: number;
-}
-interface LogicalComparisonPlan {
-  current: LogicalQueryPlan;
-  previous: LogicalQueryPlan;
-  comparisonFilter?: ComparisonFilter;
-}
-declare function inferDataset(dimensions: readonly Dimension[], filterDims?: readonly Dimension[]): LogicalDataset;
-/**
- * True when every grouped + filtered dimension fits inside one stored dataset,
- * i.e. the query is answerable from stored Parquet/D1 tables without a live
- * GSC call. `inferDataset` always returns *some* dataset; this predicate is
- * how callers tell a genuine match from one that will fail at column-resolve
- * time.
- */
-declare function isDatasetResolvable(dimensions: readonly Dimension[], filterDims?: readonly Dimension[]): boolean;
-/**
- * `BuilderState`-level convenience for {@link isDatasetResolvable}: extracts
- * the state's dimension filters (the same way `buildLogicalPlan` does) and
- * checks them against the grouped dimensions. Lets routing code (e.g. the
- * composite source) detect a cross-dimension query without rebuilding a plan.
- */
-declare function isStateResolvable(state: BuilderState): boolean;
-/**
- * Errors-as-values core: builds the logical plan or returns a typed `QueryError`
- * for every modelled failure (missing date range, a regex filter on an engine
- * without regex pushdown, a cross-dimension query with no stored home).
- * `buildLogicalPlan` is the throwing wrapper for call sites that prefer exceptions.
- */
-declare function buildLogicalPlanResult(state: BuilderState, capabilities?: PlannerCapabilities): Result<LogicalQueryPlan, QueryError>;
-declare function buildLogicalPlan(state: BuilderState, capabilities?: PlannerCapabilities): LogicalQueryPlan;
-/**
- * Errors-as-values core for the comparison plan: returns a typed `QueryError`
- * when the engine lacks the comparison-join or multi-dataset capability the
- * paired queries need, or when either side fails to plan.
- */
-declare function buildLogicalComparisonPlanResult(current: BuilderState, previous: BuilderState, capabilities?: PlannerCapabilities, comparisonFilter?: ComparisonFilter): Result<LogicalComparisonPlan, QueryError>;
-declare function buildLogicalComparisonPlan(current: BuilderState, previous: BuilderState, capabilities?: PlannerCapabilities, comparisonFilter?: ComparisonFilter): LogicalComparisonPlan;
-export { ComparisonFilter, LogicalComparisonPlan, LogicalDataset, LogicalDimensionFilter, LogicalFilterGroup, LogicalFilterLeaf, LogicalFilterNode, LogicalMetricFilter, LogicalQueryPlan, PlannerCapabilities, QueryError, QueryErrorKind, UnresolvableDatasetError, UnsupportedLogicalCapabilityError, buildLogicalComparisonPlan, buildLogicalComparisonPlanResult, buildLogicalPlan, buildLogicalPlanResult, inferDataset, isDatasetResolvable, isQueryError, isStateResolvable, queryErrorToException, queryErrors };

package/dist/_chunks/result.d.mts

@@ -1,20 +0,0 @@
-interface Ok<A> {
-  readonly ok: true;
-  readonly value: A;
-}
-interface Err<E> {
-  readonly ok: false;
-  readonly error: E;
-}
-type Result<A, E> = Ok<A> | Err<E>;
-declare function ok<A>(value: A): Ok<A>;
-declare function err<E>(error: E): Err<E>;
-declare function isOk<A, E>(result: Result<A, E>): result is Ok<A>;
-declare function isErr<A, E>(result: Result<A, E>): result is Err<E>;
-/**
- * Collapses a `Result` back into the throwing world: returns the value or throws
- * via `toError`. Used by the throwing wrappers that sit over the `Result` core so
- * existing call sites keep their `await`/`throw` ergonomics.
- */
-declare function unwrapResult<A, E>(result: Result<A, E>, toError: (error: E) => unknown): A;
-export { Err, Ok, Result, err, isErr, isOk, ok, unwrapResult };