@miguelmorales13/nestkit 0.5.0 → 0.6.0

package/dist/umami/index.cjs

@@ -0,0 +1,109 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
+
+
+var _chunk2REOCMUDcjs = require('../chunk-2REOCMUD.cjs');
+
+// src/umami/umami.module.ts
+var _common = require('@nestjs/common');
+
+// src/umami/umami.service.ts
+
+
+// src/umami/umami.options.ts
+var UMAMI_OPTIONS = /* @__PURE__ */ Symbol("UMAMI_OPTIONS");
+
+// src/umami/umami.service.ts
+var CLOUD = "https://api.umami.is/v1";
+var DAY_MS = 24 * 60 * 60 * 1e3;
+var UmamiService = class {
+  constructor(options) {
+    this.options = options;
+    this.logger = new (0, _common.Logger)(UmamiService.name);
+  }
+  /** Whether there is enough configuration to make a call at all. */
+  get configured() {
+    return Boolean(this.options.apiKey && this.options.websiteId);
+  }
+  /** A range covering the last `days` days, ending now. */
+  static lastDays(days) {
+    const endAt = Date.now();
+    return { startAt: endAt - days * DAY_MS, endAt };
+  }
+  /** Visitors, pageviews, visits and bounces for a range. */
+  stats(range) {
+    return this.request("stats", range);
+  }
+  /**
+   * A breakdown by one dimension: top pages, referrers, countries, or —
+   * with `'event'` — how many times each custom event fired.
+   */
+  metrics(type, range, limit) {
+    return this.request("metrics", range, {
+      type,
+      ...limit ? { limit: String(limit) } : {}
+    });
+  }
+  /**
+   * How many times one named event fired. Returns 0 when the event exists but
+   * never fired, and `null` when the call itself failed — the difference
+   * matters: one is "nobody did it", the other is "we don't know".
+   */
+  async eventCount(name, range) {
+    const rows = await this.metrics("event", range);
+    if (rows === null) return null;
+    return _nullishCoalesce(_optionalChain([rows, 'access', _ => _.find, 'call', _2 => _2((row) => row.x === name), 'optionalAccess', _3 => _3.y]), () => ( 0));
+  }
+  async request(resource, range, extra = {}) {
+    if (!this.configured) {
+      this.logger.warn("Umami is not configured: apiKey and websiteId are required.");
+      return null;
+    }
+    const params = new URLSearchParams({
+      startAt: String(range.startAt),
+      endAt: String(range.endAt),
+      ...this.options.timezone ? { timezone: this.options.timezone } : {},
+      ...extra
+    });
+    const base = _nullishCoalesce(this.options.baseUrl, () => ( CLOUD));
+    try {
+      const response = await fetch(
+        `${base}/websites/${this.options.websiteId}/${resource}?${params}`,
+        { headers: { "x-umami-api-key": this.options.apiKey } }
+      );
+      if (!response.ok) {
+        this.logger.warn(`Umami ${resource}: HTTP ${response.status}`);
+        return null;
+      }
+      return await response.json();
+    } catch (error) {
+      this.logger.warn(`Umami ${resource}: ${error.message}`);
+      return null;
+    }
+  }
+};
+UmamiService = exports.UmamiService = _chunk2REOCMUDcjs.__decorateClass.call(void 0, [
+  _common.Injectable.call(void 0, ),
+  _chunk2REOCMUDcjs.__decorateParam.call(void 0, 0, _common.Inject.call(void 0, UMAMI_OPTIONS))
+], UmamiService);
+
+// src/umami/umami.module.ts
+var UmamiModule = class {
+  static forRoot(options) {
+    return {
+      module: UmamiModule,
+      providers: [
+        { provide: UMAMI_OPTIONS, useValue: options },
+        UmamiService
+      ],
+      exports: [UmamiService]
+    };
+  }
+};
+UmamiModule = exports.UmamiModule = _chunk2REOCMUDcjs.__decorateClass.call(void 0, [
+  _common.Module.call(void 0, {})
+], UmamiModule);
+
+
+
+
+exports.UMAMI_OPTIONS = UMAMI_OPTIONS; exports.UmamiModule = UmamiModule; exports.UmamiService = UmamiService;

package/dist/umami/index.d.ts

@@ -0,0 +1,4 @@
+export { UmamiModule } from './umami.module.js';
+export { UmamiService } from './umami.service.js';
+export { UMAMI_OPTIONS, type UmamiOptions } from './umami.options.js';
+export type { UmamiStats, UmamiMetric, UmamiMetricType, UmamiRange, } from './umami.types.js';

package/dist/umami/index.js

@@ -0,0 +1,109 @@
+import {
+  __decorateClass,
+  __decorateParam
+} from "../chunk-4MGIQFAJ.js";
+
+// src/umami/umami.module.ts
+import { Module } from "@nestjs/common";
+
+// src/umami/umami.service.ts
+import { Inject, Injectable, Logger } from "@nestjs/common";
+
+// src/umami/umami.options.ts
+var UMAMI_OPTIONS = /* @__PURE__ */ Symbol("UMAMI_OPTIONS");
+
+// src/umami/umami.service.ts
+var CLOUD = "https://api.umami.is/v1";
+var DAY_MS = 24 * 60 * 60 * 1e3;
+var UmamiService = class {
+  constructor(options) {
+    this.options = options;
+    this.logger = new Logger(UmamiService.name);
+  }
+  /** Whether there is enough configuration to make a call at all. */
+  get configured() {
+    return Boolean(this.options.apiKey && this.options.websiteId);
+  }
+  /** A range covering the last `days` days, ending now. */
+  static lastDays(days) {
+    const endAt = Date.now();
+    return { startAt: endAt - days * DAY_MS, endAt };
+  }
+  /** Visitors, pageviews, visits and bounces for a range. */
+  stats(range) {
+    return this.request("stats", range);
+  }
+  /**
+   * A breakdown by one dimension: top pages, referrers, countries, or —
+   * with `'event'` — how many times each custom event fired.
+   */
+  metrics(type, range, limit) {
+    return this.request("metrics", range, {
+      type,
+      ...limit ? { limit: String(limit) } : {}
+    });
+  }
+  /**
+   * How many times one named event fired. Returns 0 when the event exists but
+   * never fired, and `null` when the call itself failed — the difference
+   * matters: one is "nobody did it", the other is "we don't know".
+   */
+  async eventCount(name, range) {
+    const rows = await this.metrics("event", range);
+    if (rows === null) return null;
+    return rows.find((row) => row.x === name)?.y ?? 0;
+  }
+  async request(resource, range, extra = {}) {
+    if (!this.configured) {
+      this.logger.warn("Umami is not configured: apiKey and websiteId are required.");
+      return null;
+    }
+    const params = new URLSearchParams({
+      startAt: String(range.startAt),
+      endAt: String(range.endAt),
+      ...this.options.timezone ? { timezone: this.options.timezone } : {},
+      ...extra
+    });
+    const base = this.options.baseUrl ?? CLOUD;
+    try {
+      const response = await fetch(
+        `${base}/websites/${this.options.websiteId}/${resource}?${params}`,
+        { headers: { "x-umami-api-key": this.options.apiKey } }
+      );
+      if (!response.ok) {
+        this.logger.warn(`Umami ${resource}: HTTP ${response.status}`);
+        return null;
+      }
+      return await response.json();
+    } catch (error) {
+      this.logger.warn(`Umami ${resource}: ${error.message}`);
+      return null;
+    }
+  }
+};
+UmamiService = __decorateClass([
+  Injectable(),
+  __decorateParam(0, Inject(UMAMI_OPTIONS))
+], UmamiService);
+
+// src/umami/umami.module.ts
+var UmamiModule = class {
+  static forRoot(options) {
+    return {
+      module: UmamiModule,
+      providers: [
+        { provide: UMAMI_OPTIONS, useValue: options },
+        UmamiService
+      ],
+      exports: [UmamiService]
+    };
+  }
+};
+UmamiModule = __decorateClass([
+  Module({})
+], UmamiModule);
+export {
+  UMAMI_OPTIONS,
+  UmamiModule,
+  UmamiService
+};

package/dist/umami/umami.module.d.ts

@@ -0,0 +1,6 @@
+import { type DynamicModule } from '@nestjs/common';
+import { type UmamiOptions } from './umami.options.js';
+/** Read-only access to the Umami analytics API. See `UmamiService`. */
+export declare class UmamiModule {
+    static forRoot(options: UmamiOptions): DynamicModule;
+}

package/dist/umami/umami.options.d.ts

@@ -0,0 +1,20 @@
+export declare const UMAMI_OPTIONS: unique symbol;
+export interface UmamiOptions {
+    /** API key from Umami Cloud (Settings → API Keys), or a self-hosted token. */
+    apiKey?: string;
+    /** The website's UUID, shown next to its name in the dashboard. */
+    websiteId?: string;
+    /**
+     * API base URL. Defaults to Umami Cloud.
+     *
+     * Self-hosted instances serve the same endpoints under `/api`, so pass
+     * `https://your-host/api` there.
+     */
+    baseUrl?: string;
+    /**
+     * Timezone for the queries, as an IANA name. Umami buckets by day in this
+     * zone, so leaving it unset silently reports UTC days — which for anything
+     * outside UTC means a "day" that starts in the middle of the afternoon.
+     */
+    timezone?: string;
+}

package/dist/umami/umami.service.d.ts

@@ -0,0 +1,40 @@
+import { type UmamiOptions } from './umami.options.js';
+import type { UmamiMetric, UmamiMetricType, UmamiRange, UmamiStats } from './umami.types.js';
+/**
+ * Read-only client for the Umami analytics API.
+ *
+ * Only reads. Events are sent by the browser script; a backend writing them
+ * would be reporting traffic that never happened.
+ *
+ * Every method returns `null` instead of throwing when a call fails. A summary
+ * usually asks for several things at once, and one endpoint being down should
+ * not take the rest of the report with it — the caller decides what a missing
+ * block means. Failures are logged, so a persistent one is still visible.
+ *
+ * Deliberately has no opinion about what the numbers mean. Which events form
+ * a funnel, what to call them and how to phrase a report are product
+ * decisions that differ per app; this only fetches.
+ */
+export declare class UmamiService {
+    private readonly options;
+    private readonly logger;
+    constructor(options: UmamiOptions);
+    /** Whether there is enough configuration to make a call at all. */
+    get configured(): boolean;
+    /** A range covering the last `days` days, ending now. */
+    static lastDays(days: number): UmamiRange;
+    /** Visitors, pageviews, visits and bounces for a range. */
+    stats(range: UmamiRange): Promise<UmamiStats | null>;
+    /**
+     * A breakdown by one dimension: top pages, referrers, countries, or —
+     * with `'event'` — how many times each custom event fired.
+     */
+    metrics(type: UmamiMetricType, range: UmamiRange, limit?: number): Promise<UmamiMetric[] | null>;
+    /**
+     * How many times one named event fired. Returns 0 when the event exists but
+     * never fired, and `null` when the call itself failed — the difference
+     * matters: one is "nobody did it", the other is "we don't know".
+     */
+    eventCount(name: string, range: UmamiRange): Promise<number | null>;
+    private request;
+}

package/dist/umami/umami.types.d.ts

@@ -0,0 +1,24 @@
+/** What `GET /websites/:id/stats` returns. */
+export interface UmamiStats {
+    pageviews: number;
+    visitors: number;
+    visits: number;
+    bounces: number;
+    totaltime: number;
+}
+/**
+ * A single metric row. Umami names these `x` and `y` across every metric type,
+ * so the meaning of `x` depends on what was asked for: a URL, a referrer, a
+ * country, an event name.
+ */
+export interface UmamiMetric {
+    x: string | null;
+    y: number;
+}
+/** What `type=` accepts on the metrics endpoint. */
+export type UmamiMetricType = 'url' | 'path' | 'entry' | 'exit' | 'referrer' | 'title' | 'query' | 'browser' | 'os' | 'device' | 'country' | 'region' | 'city' | 'language' | 'event';
+/** A window of time, as milliseconds since the epoch. */
+export interface UmamiRange {
+    startAt: number;
+    endAt: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@miguelmorales13/nestkit",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "private": false,
   "license": "MIT",
   "type": "module",
@@ -81,6 +81,11 @@
       "import": "./dist/auth/index.js",
       "require": "./dist/auth/index.cjs"
     },
+    "./auth/oauth": {
+      "types": "./dist/auth/oauth/index.d.ts",
+      "import": "./dist/auth/oauth/index.js",
+      "require": "./dist/auth/oauth/index.cjs"
+    },
     "./email/resend": {
       "types": "./dist/email/resend/index.d.ts",
       "import": "./dist/email/resend/index.js",
@@ -111,6 +116,11 @@
       "import": "./dist/media/index.js",
       "require": "./dist/media/index.cjs"
     },
+    "./umami": {
+      "types": "./dist/umami/index.d.ts",
+      "import": "./dist/umami/index.js",
+      "require": "./dist/umami/index.cjs"
+    },
     "./storage": {
       "types": "./dist/storage/index.d.ts",
       "import": "./dist/storage/index.js",
@@ -213,5 +223,9 @@
     "telegraf": "^4.16.3",
     "tsup": "^8.5.1",
     "typescript": "^5.6.0"
+  },
+  "overrides": {
+    "@nestjs/common": "11.2.3",
+    "@nestjs/core": "11.2.3"
   }
 }