gscdump 0.4.0 → 0.6.0

package/dist/normalize.d.mts

@@ -0,0 +1,2 @@
+declare function normalizeUrl(input: string): string;
+export { normalizeUrl };

package/dist/normalize.mjs

@@ -0,0 +1,16 @@
+const URL_PROTOCOL_RE = /^[a-z][a-z0-9+.-]*:\/\//i;
+function normalizeUrl(input) {
+	if (!input) return input;
+	if (!URL_PROTOCOL_RE.test(input)) return input.startsWith("/") ? input : `/${input}`;
+	const parsed = safeParse(input);
+	if (!parsed) return input;
+	return `${parsed.pathname}${parsed.search}${parsed.hash}`;
+}
+function safeParse(input) {
+	try {
+		return new URL(input);
+	} catch {
+		return null;
+	}
+}
+export { normalizeUrl };

package/dist/query/index.d.mts

@@ -1,19 +1,12 @@
 import _dayjs, { Dayjs } from "dayjs";
-import { searchconsole_v1 } from "@googleapis/searchconsole/v1";
-
-//#region src/core/types.d.ts
-
+import { searchconsole_v1 } from "@googleapis/searchconsole/build/v1";
 type SearchAnalyticsQuery = searchconsole_v1.Schema$SearchAnalyticsQueryRequest;
-//#endregion
-//#region src/query/utils/countries.d.ts
 declare const _default: {
   name: string;
   'alpha-2': string;
   'alpha-3': string;
   'country-code': string;
 }[];
-//#endregion
-//#region src/query/constants.d.ts
 declare const Devices: {
   readonly MOBILE: "MOBILE";
   readonly DESKTOP: "DESKTOP";
@@ -25,12 +18,12 @@ declare const SearchTypes: {
   readonly IMAGE: "image";
   readonly VIDEO: "video";
   readonly NEWS: "news";
+  readonly DISCOVER: "discover";
+  readonly GOOGLE_NEWS: "googleNews";
 };
 type SearchType = typeof SearchTypes[keyof typeof SearchTypes];
 declare const Countries: { [K in (typeof _default)[number]["alpha-3"]]: Lowercase<K> };
 type Country = typeof Countries[keyof typeof Countries];
-//#endregion
-//#region src/query/types.d.ts
 interface DimensionValueMap {
   query: string;
   queryCanonical: string;
@@ -45,14 +38,12 @@ interface QueryParamValueMap {
   searchType: SearchType;
 }
 type QueryParamName = keyof QueryParamValueMap;
-declare const ColumnBrand: unique symbol;
 interface Column<D extends Dimension> {
-  readonly [ColumnBrand]: D;
+  readonly __columnBrand: 'gscdump.Column';
   readonly dimension: D;
 }
-declare const QueryParamBrand: unique symbol;
 interface QueryParam<P extends QueryParamName> {
-  readonly [QueryParamBrand]: P;
+  readonly __queryParamBrand: 'gscdump.QueryParam';
   readonly param: P;
 }
 type FilterOperator = 'equals' | 'notEquals' | 'contains' | 'notContains' | 'includingRegex' | 'excludingRegex';
@@ -65,16 +56,15 @@ interface InternalFilter {
   expression: string;
   expression2?: string;
 }
-declare const FilterBrand: unique symbol;
 interface Filter<C = object> {
-  readonly [FilterBrand]: true;
+  readonly __filterBrand: 'gscdump.Filter';
   readonly _constraints: C;
   readonly _filters: InternalFilter[];
   readonly _nestedGroups?: Filter<any>[];
   readonly _groupType?: 'and' | 'or';
 }
 type MergeConstraints<F extends Filter<any>[]> = UnionToIntersection<F[number]['_constraints']>;
-type UnionToIntersection<U$1> = (U$1 extends any ? (k: U$1) => void : never) extends ((k: infer I) => void) ? I : never;
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
 interface GSCResult<D extends Dimension[], C> {
   rows: Array<GSCRow<D, C>>;
 }
@@ -85,9 +75,8 @@ type GSCRow<D extends Dimension[], C> = { [K in D[number]]: K extends keyof C ?
   position: number;
 };
 type Metric = 'clicks' | 'impressions' | 'ctr' | 'position';
-declare const MetricColumnBrand: unique symbol;
 interface MetricColumn<M extends Metric> {
-  readonly [MetricColumnBrand]: M;
+  readonly __metricColumnBrand: 'gscdump.MetricColumn';
   readonly metric: M;
 }
 interface BuilderState {
@@ -113,8 +102,6 @@ interface JsonFilter {
   _groupType?: 'and' | 'or';
 }
 type FilterInput = Filter<any> | JsonFilter;
-//#endregion
-//#region src/query/builder.d.ts
 type SelectableColumn = Column<Dimension> | MetricColumn<Metric>;
 type OrderableColumn = MetricColumn<Metric> | Column<'date'>;
 type ExtractDimensions<T extends SelectableColumn[]> = { [K in keyof T]: T[K] extends Column<infer D> ? D : never }[number] extends infer U ? Exclude<U, never>[] : never;
@@ -131,8 +118,6 @@ interface GSCQueryBuilder<D extends Dimension[] = [], C = object> {
   getState: () => BuilderState;
 }
 declare const gsc: GSCQueryBuilder<[], object>;
-//#endregion
-//#region src/query/columns.d.ts
 declare const page: Column<"page">;
 declare const query: Column<"query">;
 declare const queryCanonical: Column<"queryCanonical">;
@@ -145,8 +130,6 @@ declare const impressions: MetricColumn<"impressions">;
 declare const ctr: MetricColumn<"ctr">;
 declare const position: MetricColumn<"position">;
 declare const searchType: QueryParam<"searchType">;
-//#endregion
-//#region src/query/operators.d.ts
 declare function eq<D extends Dimension, V extends DimensionValueMap[D]>(column: Column<D>, value: V): Filter<Record<D, V>>;
 declare function eq<P extends QueryParamName, V extends QueryParamValueMap[P]>(param: QueryParam<P>, value: V): Filter<Record<P, V>>;
 declare function ne<D extends Dimension>(column: Column<D>, value: DimensionValueMap[D]): Filter<object>;
@@ -169,24 +152,81 @@ declare function lt<D extends Dimension>(column: Column<D>, value: DimensionValu
 declare function between<M extends Metric>(column: MetricColumn<M>, start: number, end: number): Filter<object>;
 declare function between<D extends Dimension>(column: Column<D>, start: DimensionValueMap[D], end: DimensionValueMap[D]): Filter<object>;
 declare function topLevel(column: Column<'page'>): Filter<object>;
-//#endregion
-//#region src/query/resolver.d.ts
+/** Logical table / dataset identifier. Canonical across query builder + storage engine. */
+type TableName = 'pages' | 'keywords' | 'countries' | 'devices' | 'page_keywords' | 'search_appearance';
+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[];
+  specialFilters: {
+    topLevel: boolean;
+  };
+  queryParams: Partial<Record<QueryParamName, string>>;
+  orderBy?: BuilderState['orderBy'];
+  rowLimit?: number;
+  startRow?: number;
+}
+interface LogicalComparisonPlan {
+  current: LogicalQueryPlan;
+  previous: LogicalQueryPlan;
+  comparisonFilter?: ComparisonFilter;
+}
+declare class UnsupportedLogicalCapabilityError extends Error {
+  constructor(capability: keyof PlannerCapabilities, context: string);
+}
+declare function buildLogicalPlan(state: BuilderState, capabilities?: PlannerCapabilities): LogicalQueryPlan;
+declare function buildLogicalComparisonPlan(current: BuilderState, previous: BuilderState, capabilities?: PlannerCapabilities, comparisonFilter?: ComparisonFilter): LogicalComparisonPlan;
 declare function isJsonFilter(value: unknown): value is JsonFilter;
 declare function parseJsonFilter(json: JsonFilter): Filter<any>;
+declare function normalizeFilter(input?: FilterInput): Filter<any> | undefined;
 declare function extractDateRange(input?: FilterInput): {
   startDate?: string;
   endDate?: string;
 };
 declare function extractMetricFilters(input?: FilterInput): InternalFilter[];
 declare function extractSpecialOperatorFilters(input?: FilterInput): InternalFilter[];
-//#endregion
-//#region src/query/utils/dayjs.d.ts
 declare function dayjs(date?: _dayjs.ConfigType): Dayjs;
 declare function currentPstDate(): string;
 declare function dayjsPst(): Dayjs;
-//#endregion
-//#region src/query/index.d.ts
 declare function today(): string;
 declare function daysAgo(n: number): string;
-//#endregion
-export { type BuilderState, type Column, Countries, type Country, type Device, Devices, type Dimension, type DimensionValueMap, type Filter, type FilterInput, type GSCQueryBuilder, type GSCResult, type GSCRow, type InternalFilter, type JsonFilter, type JsonInternalFilter, type Metric, type MetricColumn, type QueryParam, type QueryParamName, type QueryParamValueMap, type SearchType, SearchTypes, and, between, clicks, contains, country, ctr, currentPstDate, date, dayjs, dayjsPst, daysAgo, device, eq, extractDateRange, extractMetricFilters, extractSpecialOperatorFilters, gsc, gt, gte, impressions, inArray, isJsonFilter, like, lt, lte, ne, not, notRegex, or, page, parseJsonFilter, position, query, queryCanonical, regex, searchAppearance, searchType, today, topLevel };
+export { type BuilderState, type Column, type ComparisonFilter, Countries, type Country, type Device, Devices, type Dimension, type DimensionValueMap, type Filter, type FilterInput, type GSCQueryBuilder, type GSCResult, type GSCRow, type InternalFilter, type JsonFilter, type JsonInternalFilter, type LogicalComparisonPlan, type LogicalDataset, type LogicalDimensionFilter, type LogicalMetricFilter, type LogicalQueryPlan, type Metric, type MetricColumn, type PlannerCapabilities, type QueryParam, type QueryParamName, type QueryParamValueMap, type SearchType, SearchTypes, UnsupportedLogicalCapabilityError, and, between, buildLogicalComparisonPlan, buildLogicalPlan, clicks, contains, country, ctr, currentPstDate, date, dayjs, dayjsPst, daysAgo, device, eq, extractDateRange, extractMetricFilters, extractSpecialOperatorFilters, gsc, gt, gte, impressions, inArray, isJsonFilter, like, lt, lte, ne, normalizeFilter, not, notRegex, or, page, parseJsonFilter, position, query, queryCanonical, regex, searchAppearance, searchType, today, topLevel };