@guinetik/primitives-ts 0.10.0 → 0.11.0

package/dist/analytics.types.d.ts

@@ -48,4 +48,56 @@ export interface AnalyticsReport {
     totals: AnalyticsReportTotals;
     topPages: AnalyticsTopPageRow[];
 }
+/** Whether a dashboard card loaded. */
+export type AnalyticsCardStatus = 'ok' | 'error';
+/** Persisted card definition (no metrics). */
+export interface AnalyticsDashboardCardConfig {
+    /** Admin API resource name, e.g. `properties/123456`. */
+    propertyId: string;
+    displayName: string;
+    /** Admin API resource name, e.g. `accounts/123`. */
+    accountId: string;
+    order: number;
+}
+/** Percent change per metric versus the previous equal-length window. */
+export interface AnalyticsTotalsDelta {
+    activeUsers: number;
+    sessions: number;
+    screenPageViews: number;
+}
+/** One rendered card. Metrics are absent when `status` is `'error'`. */
+export interface AnalyticsDashboardCard extends AnalyticsDashboardCardConfig {
+    status: AnalyticsCardStatus;
+    totals?: AnalyticsReportTotals;
+    previous?: AnalyticsReportTotals;
+    delta?: AnalyticsTotalsDelta;
+    /** Sanitised reason; present only when `status` is `'error'`. */
+    reason?: string;
+}
+/**
+ * Daily `activeUsers` per property. `dates` is shared by every series;
+ * each array aligns to it index-for-index. A failed property has no entry.
+ */
+export interface AnalyticsDashboardSeries {
+    /** ISO `yyyy-mm-dd`, ascending. */
+    dates: string[];
+    byProperty: Record<string, number[]>;
+}
+/** Batch dashboard payload. */
+export interface AnalyticsDashboard {
+    dateRangePreset: AnalyticsDateRangePreset;
+    /** Resolved ISO date, not a GA relative token. */
+    startDate: string;
+    endDate: string;
+    cards: AnalyticsDashboardCard[];
+    series: AnalyticsDashboardSeries;
+}
+/**
+ * Percent change between two windows, rounded to one decimal.
+ * A zero previous window yields 0 when current is also 0, else 100.
+ *
+ * @param current - Metric total for the selected window.
+ * @param previous - Metric total for the preceding equal-length window.
+ */
+export declare function percentChange(current: number, previous: number): number;
 //# sourceMappingURL=analytics.types.d.ts.map

package/dist/analytics.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"analytics.types.d.ts","sourceRoot":"","sources":["../src/analytics.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,iEAAiE;AACjE,MAAM,MAAM,wBAAwB,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,CAAC;AAE5D,iEAAiE;AACjE,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,EAAE,wBAAwB,CAAC;CAC3C;AAED,yCAAyC;AACzC,MAAM,WAAW,iBAAiB;IAChC,yDAAyD;IACzD,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,4CAA4C;AAC5C,MAAM,WAAW,gBAAgB;IAC/B,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,iBAAiB,EAAE,CAAC;CACjC;AAED,qDAAqD;AACrD,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,sCAAsC;AACtC,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,yBAAyB;AACzB,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,wBAAwB,CAAC;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,qBAAqB,CAAC;IAC9B,QAAQ,EAAE,mBAAmB,EAAE,CAAC;CACjC"}
+{"version":3,"file":"analytics.types.d.ts","sourceRoot":"","sources":["../src/analytics.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,iEAAiE;AACjE,MAAM,MAAM,wBAAwB,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,CAAC;AAE5D,iEAAiE;AACjE,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,EAAE,wBAAwB,CAAC;CAC3C;AAED,yCAAyC;AACzC,MAAM,WAAW,iBAAiB;IAChC,yDAAyD;IACzD,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,4CAA4C;AAC5C,MAAM,WAAW,gBAAgB;IAC/B,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,iBAAiB,EAAE,CAAC;CACjC;AAED,qDAAqD;AACrD,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,sCAAsC;AACtC,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,yBAAyB;AACzB,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,wBAAwB,CAAC;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,qBAAqB,CAAC;IAC9B,QAAQ,EAAE,mBAAmB,EAAE,CAAC;CACjC;AAED,uCAAuC;AACvC,MAAM,MAAM,mBAAmB,GAAG,IAAI,GAAG,OAAO,CAAC;AAEjD,8CAA8C;AAC9C,MAAM,WAAW,4BAA4B;IAC3C,yDAAyD;IACzD,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yEAAyE;AACzE,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,wEAAwE;AACxE,MAAM,WAAW,sBAAuB,SAAQ,4BAA4B;IAC1E,MAAM,EAAE,mBAAmB,CAAC;IAC5B,MAAM,CAAC,EAAE,qBAAqB,CAAC;IAC/B,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IACjC,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,iEAAiE;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,mCAAmC;IACnC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;CACtC;AAED,+BAA+B;AAC/B,MAAM,WAAW,kBAAkB;IACjC,eAAe,EAAE,wBAAwB,CAAC;IAC1C,kDAAkD;IAClD,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC,MAAM,EAAE,wBAAwB,CAAC;CAClC;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAKvE"}

package/dist/analytics.types.js

@@ -4,3 +4,17 @@
  * Refresh tokens never appear in these types.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.percentChange = percentChange;
+/**
+ * Percent change between two windows, rounded to one decimal.
+ * A zero previous window yields 0 when current is also 0, else 100.
+ *
+ * @param current - Metric total for the selected window.
+ * @param previous - Metric total for the preceding equal-length window.
+ */
+function percentChange(current, previous) {
+    if (previous === 0) {
+        return current === 0 ? 0 : 100;
+    }
+    return Math.round(((current - previous) / previous) * 1000) / 10;
+}

package/dist/analytics.types.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=analytics.types.spec.d.ts.map

package/dist/analytics.types.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.types.spec.d.ts","sourceRoot":"","sources":["../src/analytics.types.spec.ts"],"names":[],"mappings":""}

package/dist/analytics.types.spec.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const analytics_types_1 = require("./analytics.types");
+describe('percentChange', () => {
+    it('computes a positive change', () => {
+        expect((0, analytics_types_1.percentChange)(110, 100)).toBe(10);
+    });
+    it('computes a negative change', () => {
+        expect((0, analytics_types_1.percentChange)(90, 100)).toBe(-10);
+    });
+    it('rounds to one decimal place', () => {
+        expect((0, analytics_types_1.percentChange)(103, 97)).toBe(6.2);
+    });
+    it('returns 0 when both windows are zero', () => {
+        expect((0, analytics_types_1.percentChange)(0, 0)).toBe(0);
+    });
+    it('returns 100 when the previous window was zero and there is now traffic', () => {
+        expect((0, analytics_types_1.percentChange)(5, 0)).toBe(100);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guinetik/primitives-ts",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Shared TypeScript primitives for Guinetik projects",
   "author": "Guinetik",
   "license": "MIT",