@gscdump/sdk 0.25.13 → 0.25.14

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 +16 -1
  2. package/package.json +6 -6
package/dist/index.d.mts CHANGED
@@ -225,6 +225,15 @@ interface TopNBreakdownQuery extends ArchetypeQueryBase {
225
225
  limit: number;
226
226
  /** Pagination offset. Non-zero may force `duckdb` execution. */
227
227
  offset?: number;
228
+ /**
229
+ * Request the full unwindowed group count (`meta.totalRows`) so paginated /
230
+ * load-more tables know how many rows exist beyond the current `limit`.
231
+ * Computed as `COUNT(*) OVER()` over the grouped result, which requires a
232
+ * window function — so a query with `includeTotal` is escalated to `duckdb`
233
+ * on the server tail (R2 SQL cannot express it). Not honoured for the
234
+ * `device` dimension, which has at most a handful of rows.
235
+ */
236
+ includeTotal?: boolean;
228
237
  }
229
238
  /** One aggregated row for a fully-specified filter. `WHERE` + `GROUP BY`. */
230
239
  interface SingleRowLookupQuery extends ArchetypeQueryBase {
@@ -299,7 +308,13 @@ interface ArchetypeResult<R extends ArchetypeResultRow = ArchetypeResultRow> {
299
308
  source: ArchetypeResultSource;
300
309
  meta?: {
301
310
  rowCount: number;
302
- queryMs: number; /** Set when `compareRange` was supplied — the comparison-period rows. */
311
+ queryMs: number;
312
+ /**
313
+ * Full unwindowed group count for a `top-n-breakdown` requested with
314
+ * `includeTotal`. Independent of `limit`/`offset`; lets paginated tables
315
+ * show "X of Y" and stop loading. Undefined when not requested.
316
+ */
317
+ totalRows?: number; /** Set when `compareRange` was supplied — the comparison-period rows. */
303
318
  compareRows?: R[];
304
319
  truncated?: boolean;
305
320
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@gscdump/sdk",
3
3
  "type": "module",
4
- "version": "0.25.13",
4
+ "version": "0.25.14",
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.25.13"
44
+ "gscdump": "0.25.14"
45
45
  },
46
46
  "peerDependenciesMeta": {
47
47
  "gscdump": {
@@ -52,13 +52,13 @@
52
52
  "date-fns": "^4.4.0",
53
53
  "ofetch": "^1.5.1",
54
54
  "zod": "^4.4.3",
55
- "@gscdump/analysis": "0.25.13",
56
- "@gscdump/contracts": "0.25.13",
57
- "@gscdump/engine": "0.25.13"
55
+ "@gscdump/analysis": "0.25.14",
56
+ "@gscdump/contracts": "0.25.14",
57
+ "@gscdump/engine": "0.25.14"
58
58
  },
59
59
  "devDependencies": {
60
60
  "typescript": "^6.0.3",
61
- "vitest": "^4.1.7"
61
+ "vitest": "^4.1.8"
62
62
  },
63
63
  "scripts": {
64
64
  "build": "obuild",