@huloglobal/vendure-plugin-visitor-analytics 0.2.0

package/dist/visitor-event.entity.js

@@ -0,0 +1,163 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisitorEvent = void 0;
+const core_1 = require("@vendure/core");
+const typeorm_1 = require("typeorm");
+/**
+ * Stores a single visitor analytics event — used to map the customer
+ * journey across the storefront, including for visitors who never log in.
+ *
+ *   type='pageview' — a new page was opened (one row per navigation)
+ *   type='unload'   — a page was closed / hidden; `timeOnPageMs` is the
+ *                     time the visitor spent on it before leaving
+ *   type='event'    — a custom event raised by the frontend (e.g. an
+ *                     add-to-cart click); the payload lives in `meta`
+ *
+ * `visitorId` is a long-lived cookie UUID (2 years) — identifies the
+ * device across sessions. `sessionId` is a short-lived cookie UUID
+ * (30-minute idle expiry) — identifies a single browsing burst.
+ *
+ * `customerId` is set when the visitor is logged in; the same
+ * `visitorId` can carry guest events first and then customer events
+ * once the visitor signs in / signs up — that's what makes the funnel
+ * analysis work.
+ */
+let VisitorEvent = class VisitorEvent extends core_1.VendureEntity {
+    constructor(input) { super(input); }
+};
+exports.VisitorEvent = VisitorEvent;
+__decorate([
+    (0, typeorm_1.Column)({ length: 64 }),
+    __metadata("design:type", String)
+], VisitorEvent.prototype, "visitorId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ length: 64 }),
+    __metadata("design:type", String)
+], VisitorEvent.prototype, "sessionId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'int', nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "customerId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'int', default: 1 }),
+    __metadata("design:type", Number)
+], VisitorEvent.prototype, "channelId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ length: 32 }),
+    __metadata("design:type", String)
+], VisitorEvent.prototype, "type", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ length: 2048 }),
+    __metadata("design:type", String)
+], VisitorEvent.prototype, "url", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 500, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "title", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 2048, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "referrer", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'int', nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "timeOnPageMs", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 64, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "ipHash", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 45, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "ip", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 1000, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "userAgent", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 64, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "browser", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 64, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "browserVersion", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 64, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "os", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 64, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "osVersion", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 32, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "device", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 200, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "acceptLanguage", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 16, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "country", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 16, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "region", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 100, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "city", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 64, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "timezone", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'text', nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "meta", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 100, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "utmSource", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 100, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "utmMedium", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 200, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "utmCampaign", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 100, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "utmTerm", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 200, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "utmContent", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 200, nullable: true }),
+    __metadata("design:type", Object)
+], VisitorEvent.prototype, "referrerDomain", void 0);
+exports.VisitorEvent = VisitorEvent = __decorate([
+    (0, typeorm_1.Entity)(),
+    (0, typeorm_1.Index)('visitor_event_visitor_idx', ['visitorId', 'createdAt']),
+    (0, typeorm_1.Index)('visitor_event_session_idx', ['sessionId', 'createdAt']),
+    (0, typeorm_1.Index)('visitor_event_customer_idx', ['customerId']),
+    (0, typeorm_1.Index)('visitor_event_type_idx', ['type', 'createdAt']),
+    (0, typeorm_1.Index)('visitor_event_url_idx', ['url']),
+    __metadata("design:paramtypes", [Object])
+], VisitorEvent);
+//# sourceMappingURL=visitor-event.entity.js.map

package/dist/visitor-event.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"visitor-event.entity.js","sourceRoot":"","sources":["../src/visitor-event.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wCAA2D;AAC3D,qCAAgD;AAEhD;;;;;;;;;;;;;;;;;;GAkBG;AAOI,IAAM,YAAY,GAAlB,MAAM,YAAa,SAAQ,oBAAa;IAC3C,YAAY,KAAiC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;CA8GnE,CAAA;AA/GY,oCAAY;AAIrB;IADC,IAAA,gBAAM,EAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;;+CACJ;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;;+CACJ;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACb;AAG3B;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;+CACjB;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;;0CACyB;AAIhD;IADC,IAAA,gBAAM,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;;yCACZ;AAMb;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACnC;AAGtB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACjC;AAKzB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACX;AAK7B;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACjC;AAIvB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wCACrC;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CAChC;AAI1B;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CAChC;AAGxB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACzB;AAG/B;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wCACrC;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CAC9B;AAG1B;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACjC;AAIvB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDAC1B;AAG/B;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CAChC;AAGxB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACjC;AAGvB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0CACpC;AAGrB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CAC/B;AAIzB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0CACpB;AAUrB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CAC/B;AAG1B;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CAC/B;AAG1B;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDAC7B;AAG5B;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CACjC;AAGxB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDAC9B;AAM3B;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDAC1B;uBA9GtB,YAAY;IANxB,IAAA,gBAAM,GAAE;IACR,IAAA,eAAK,EAAC,2BAA2B,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAC9D,IAAA,eAAK,EAAC,2BAA2B,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAC9D,IAAA,eAAK,EAAC,4BAA4B,EAAE,CAAC,YAAY,CAAC,CAAC;IACnD,IAAA,eAAK,EAAC,wBAAwB,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACtD,IAAA,eAAK,EAAC,uBAAuB,EAAE,CAAC,KAAK,CAAC,CAAC;;GAC3B,YAAY,CA+GxB"}

package/dist/visitor-tracking.controller.d.ts

@@ -0,0 +1,66 @@
+import { RequestContext, TransactionalConnection } from '@vendure/core';
+import { Request, Response } from 'express';
+import { VisitorTrackingService } from './visitor-tracking.service';
+export declare class VisitorTrackingController {
+    private connection;
+    private tracking;
+    constructor(connection: TransactionalConnection, tracking: VisitorTrackingService);
+    /**
+     * Ingest endpoint hit by the storefront tracker. Anonymous, takes
+     * a small JSON batch via fetch() or navigator.sendBeacon() (which
+     * uses text/plain). CORS is open because the storefront is on a
+     * different origin from the API.
+     *
+     *   POST /ees/track
+     *   body: {
+     *     channelId?: number,
+     *     customerId?: number | null,
+     *     events: [
+     *       { type, url, title?, referrer?, timeOnPageMs?, meta?, clientTs? }
+     *     ]
+     *   }
+     *
+     * Cookies `ees_vid` (visitor) and `ees_sid` (session) are issued
+     * on the first request and refreshed on every subsequent one.
+     */
+    track(body: any, req: Request, res: Response): Promise<Response<any, Record<string, any>>>;
+    /** Top-line counters + daily series for the dashboard header. */
+    summary(ctx: RequestContext, req: Request, res: Response): Promise<Response<any, Record<string, any>> | undefined>;
+    /** Traffic sources — UTM source breakdown + organic referrer
+     *  domains. Visitors are attributed by their first-pageview's UTM
+     *  / referrer combo per session. */
+    sources(ctx: RequestContext, req: Request, res: Response): Promise<Response<any, Record<string, any>> | undefined>;
+    /** Top pages by view count. Paginated via take + skip. */
+    topPages(ctx: RequestContext, req: Request, res: Response): Promise<Response<any, Record<string, any>> | undefined>;
+    /** Funnel: visitors → product views → cart → checkout completed. */
+    funnel(ctx: RequestContext, req: Request, res: Response): Promise<Response<any, Record<string, any>> | undefined>;
+    /** Exit pages — pages where the last event in the session was a
+     *  pageview. Paginated via take + skip. */
+    exitPages(ctx: RequestContext, req: Request, res: Response): Promise<Response<any, Record<string, any>> | undefined>;
+    /** Top custom events — `type` other than pageview / unload. Useful
+     *  for tracking add-to-cart / search / quote-request / signup
+     *  conversion rates. Paginated. */
+    topEvents(ctx: RequestContext, req: Request, res: Response): Promise<Response<any, Record<string, any>> | undefined>;
+    /**
+     * Live-now widget — Server-Sent Events stream pushing the current
+     * active-visitor count + their most recent URLs every 5 seconds.
+     * "Active" = at least one event in the last 5 minutes. SSE keeps
+     * the connection open; the admin UI consumes it via `EventSource`.
+     *
+     * Each event payload:
+     *   data: { ts, activeCount, recent: [{ visitorId, url, country, secondsAgo }] }
+     */
+    live(ctx: RequestContext, req: Request, res: Response): Promise<void>;
+    /** Journey timeline for one visitor — every event in order. */
+    journey(ctx: RequestContext, visitorId: string, res: Response): Promise<Response<any, Record<string, any>> | undefined>;
+    /** Recent visitors — paginated via take + skip. */
+    recent(ctx: RequestContext, req: Request, res: Response): Promise<Response<any, Record<string, any>> | undefined>;
+    /** Full visitor profile — every available signal we have on this
+     *  visitor, plus the most-recent IP / UA / location / locale,
+     *  customer link, and per-session breakdown. Drives the clickable
+     *  detail drawer in the admin UI. */
+    profile(ctx: RequestContext, visitorIdRaw: string, res: Response): Promise<Response<any, Record<string, any>> | undefined>;
+    private applyCors;
+    private parseCookies;
+}
+//# sourceMappingURL=visitor-tracking.controller.d.ts.map

package/dist/visitor-tracking.controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visitor-tracking.controller.d.ts","sourceRoot":"","sources":["../src/visitor-tracking.controller.ts"],"names":[],"mappings":"AACA,OAAO,EAAmB,cAAc,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AACzF,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AA4BpE,qBACa,yBAAyB;IAE9B,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,QAAQ;gBADR,UAAU,EAAE,uBAAuB,EACnC,QAAQ,EAAE,sBAAsB;IAG5C;;;;;;;;;;;;;;;;;OAiBG;IAEG,KAAK,CAAS,IAAI,EAAE,GAAG,EAAS,GAAG,EAAE,OAAO,EAAS,GAAG,EAAE,QAAQ;IA2DxE,iEAAiE;IAE3D,OAAO,CAAQ,GAAG,EAAE,cAAc,EAAS,GAAG,EAAE,OAAO,EAAS,GAAG,EAAE,QAAQ;IA0CnF;;wCAEoC;IAE9B,OAAO,CAAQ,GAAG,EAAE,cAAc,EAAS,GAAG,EAAE,OAAO,EAAS,GAAG,EAAE,QAAQ;IAuDnF,0DAA0D;IAEpD,QAAQ,CAAQ,GAAG,EAAE,cAAc,EAAS,GAAG,EAAE,OAAO,EAAS,GAAG,EAAE,QAAQ;IAoCpF,oEAAoE;IAE9D,MAAM,CAAQ,GAAG,EAAE,cAAc,EAAS,GAAG,EAAE,OAAO,EAAS,GAAG,EAAE,QAAQ;IAsBlF;+CAC2C;IAErC,SAAS,CAAQ,GAAG,EAAE,cAAc,EAAS,GAAG,EAAE,OAAO,EAAS,GAAG,EAAE,QAAQ;IAuCrF;;uCAEmC;IAE7B,SAAS,CAAQ,GAAG,EAAE,cAAc,EAAS,GAAG,EAAE,OAAO,EAAS,GAAG,EAAE,QAAQ;IAmCrF;;;;;;;;OAQG;IAEG,IAAI,CAAQ,GAAG,EAAE,cAAc,EAAS,GAAG,EAAE,OAAO,EAAS,GAAG,EAAE,QAAQ;IAgDhF,+DAA+D;IAEzD,OAAO,CAAQ,GAAG,EAAE,cAAc,EAAsB,SAAS,EAAE,MAAM,EAAS,GAAG,EAAE,QAAQ;IAUrG,mDAAmD;IAE7C,MAAM,CAAQ,GAAG,EAAE,cAAc,EAAS,GAAG,EAAE,OAAO,EAAS,GAAG,EAAE,QAAQ;IA+ClF;;;yCAGqC;IAE/B,OAAO,CAAQ,GAAG,EAAE,cAAc,EAAsB,YAAY,EAAE,MAAM,EAAS,GAAG,EAAE,QAAQ;IAyGxG,OAAO,CAAC,SAAS;IAYjB,OAAO,CAAC,YAAY;CAYvB"}