@gscdump/sdk 0.21.0 → 0.21.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/index.d.mts +15 -4
  2. package/package.json +3 -3
package/dist/index.d.mts CHANGED
@@ -72,7 +72,11 @@ interface ArchetypeQueryBase {
72
72
  */
73
73
  compareRange?: DateRange;
74
74
  }
75
- /** Whole-site metrics grouped by date. R2 SQL: `GROUP BY date`. */
75
+ /**
76
+ * Whole-site metrics grouped by date. Reads `dates`, the authoritative daily
77
+ * total table (site totals + anonymized impressions + device pivot).
78
+ * R2 SQL: `GROUP BY date`.
79
+ */
76
80
  interface SiteDailyTimeseriesQuery extends ArchetypeQueryBase {
77
81
  archetype: 'site-daily-timeseries';
78
82
  metrics: readonly Metric[];
@@ -103,6 +107,8 @@ interface EntityDailySparklineQuery extends ArchetypeQueryBase {
103
107
  }
104
108
  /**
105
109
  * Ranked breakdown over one dimension. `GROUP BY` + `ORDER BY` + `LIMIT`.
110
+ * Device breakdowns read the wide `dates` table and unpivot its device columns
111
+ * (`clicks_desktop`, `impressions_mobile`, etc.) at query time.
106
112
  * `offset` pagination is UNVERIFIED in R2 SQL (POC) — when set, the router
107
113
  * may escalate to `duckdb`.
108
114
  */
@@ -126,7 +132,10 @@ interface SingleRowLookupQuery extends ArchetypeQueryBase {
126
132
  match: Partial<Record<Dimension, string>>;
127
133
  metrics: readonly Metric[];
128
134
  }
129
- /** Daily metrics split by a secondary dimension. `GROUP BY date, <dim>`. */
135
+ /**
136
+ * Daily metrics split by a secondary dimension. `GROUP BY date, <dim>`.
137
+ * Device split charts read `dates` and unpivot the wide device columns.
138
+ */
130
139
  interface MultiSeriesStackedDailyQuery extends ArchetypeQueryBase {
131
140
  archetype: 'multi-series-stacked-daily';
132
141
  /** The series dimension, e.g. `device` or `country`. */
@@ -146,8 +155,10 @@ interface PresetAnalyzerQuery extends ArchetypeQueryBase {
146
155
  params?: Record<string, unknown>;
147
156
  }
148
157
  /**
149
- * The whale archetype — `page_queries` grouped by `(url, query)`. The reason
150
- * the server tail exists. R2-SQL-expressible (`GROUP BY url, query`).
158
+ * The whale archetype — `page_queries` grouped by `(url, query)`. The query ×
159
+ * page cross no longer reads the retired `page_keywords` table name. This is
160
+ * the reason the server tail exists. R2-SQL-expressible
161
+ * (`GROUP BY url, query`).
151
162
  */
152
163
  interface TwoDimensionDetailQuery extends ArchetypeQueryBase {
153
164
  archetype: 'two-dimension-detail';
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@gscdump/sdk",
3
3
  "type": "module",
4
- "version": "0.21.0",
4
+ "version": "0.21.1",
5
5
  "description": "Consumer SDK for hosted gscdump.com integrations.",
6
6
  "author": {
7
7
  "name": "Harlan Wilton",
@@ -41,7 +41,7 @@
41
41
  "node": ">=18"
42
42
  },
43
43
  "peerDependencies": {
44
- "gscdump": "0.21.0"
44
+ "gscdump": "0.21.1"
45
45
  },
46
46
  "peerDependenciesMeta": {
47
47
  "gscdump": {
@@ -51,7 +51,7 @@
51
51
  "dependencies": {
52
52
  "ofetch": "^1.5.1",
53
53
  "zod": "^4.4.3",
54
- "@gscdump/contracts": "0.21.0"
54
+ "@gscdump/contracts": "0.21.1"
55
55
  },
56
56
  "devDependencies": {
57
57
  "typescript": "^6.0.3",