@sermonshots/analytics 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import type { UserEventReq } from './types.js';
+export type { paths, webhooks, components, $defs, operations, DateTime, Date, UserEventReq, EventCountByDayRes, EventTotalRes, Ping, ProblemDetail, } from './types.js';
+export { EventType } from './types.js';
+export type AnalyticsClientConfig = {
+    baseUrl: string;
+    timeout?: number;
+};
+export declare class AnalyticsClient {
+    private readonly baseUrl;
+    private readonly timeout;
+    readonly ingest: {
+        event(req: UserEventReq): Promise<void>;
+    };
+    constructor(config: AnalyticsClientConfig);
+    private request;
+}

package/dist/index.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalyticsClient = exports.EventType = void 0;
+var types_js_1 = require("./types.js");
+Object.defineProperty(exports, "EventType", { enumerable: true, get: function () { return types_js_1.EventType; } });
+class AnalyticsClient {
+    constructor(config) {
+        this.baseUrl = config.baseUrl.replace(/\/$/, '');
+        this.timeout = config.timeout ?? 30000;
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const self = this;
+        this.ingest = {
+            async event(req) {
+                await self.request('POST', '/v1/events', { body: req });
+            }
+        };
+    }
+    async request(method, path, opts = {}) {
+        const controller = new AbortController();
+        const timer = setTimeout(() => controller.abort(), this.timeout);
+        try {
+            const res = await fetch(`${this.baseUrl}${path}`, {
+                method,
+                headers: { 'Content-Type': 'application/json' },
+                body: opts.body != null ? JSON.stringify(opts.body) : undefined,
+                signal: controller.signal
+            });
+            if (!res.ok) {
+                throw new Error(`Analytics API ${method} ${path} failed with ${res.status}`);
+            }
+            const text = await res.text();
+            return (text ? JSON.parse(text) : undefined);
+        }
+        finally {
+            clearTimeout(timer);
+        }
+    }
+}
+exports.AnalyticsClient = AnalyticsClient;

package/dist/types.d.ts

@@ -0,0 +1,272 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export type paths = {
+    "/ping": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Health check */
+        get: operations["get-ping"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/events": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Ingest user analytics event */
+        post: operations["post-v1-events"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/dashboard/events/daily": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get event counts by day */
+        get: operations["get-v1-dashboard-events-daily"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/dashboard/events/totals": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get total event counts */
+        get: operations["get-v1-dashboard-events-totals"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+};
+export type webhooks = Record<string, never>;
+export type components = {
+    schemas: {
+        /**
+         * @description Analytics user-event type. Kept in sync with the event package.
+         * @enum {string}
+         */
+        EventType: EventType;
+        UserEventReq: {
+            event: components["schemas"]["EventType"];
+            video_id: number;
+            user_id: number;
+            owner_id: number;
+            membership: string;
+            start_time: components["schemas"]["DateTime"];
+            end_time?: components["schemas"]["DateTime"];
+            metadata?: {
+                [key: string]: unknown;
+            };
+        };
+        EventCountByDayRes: {
+            date: string;
+            event: string;
+            count: number;
+        };
+        EventTotalRes: {
+            event: string;
+            total: number;
+        };
+        Ping: {
+            message: string;
+        };
+        /** Format: date-time */
+        DateTime: string;
+        ProblemDetail: {
+            instance: string;
+            title: string;
+            status: number;
+            detail: string;
+        };
+        /** Format: date */
+        Date: string;
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+};
+export type UserEventReq = components['schemas']['UserEventReq'];
+export type EventCountByDayRes = components['schemas']['EventCountByDayRes'];
+export type EventTotalRes = components['schemas']['EventTotalRes'];
+export type Ping = components['schemas']['Ping'];
+export type DateTime = components['schemas']['DateTime'];
+export type ProblemDetail = components['schemas']['ProblemDetail'];
+export type Date = components['schemas']['Date'];
+export type $defs = Record<string, never>;
+export interface operations {
+    "get-ping": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description pong */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Ping"];
+                };
+            };
+        };
+    };
+    "post-v1-events": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UserEventReq"];
+            };
+        };
+        responses: {
+            /** @description event accepted for processing */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProblemDetail"];
+                };
+            };
+        };
+    };
+    "get-v1-dashboard-events-daily": {
+        parameters: {
+            query: {
+                /** @description Start date in YYYY-MM-DD format */
+                from_date: components["schemas"]["Date"];
+                /** @description End date in YYYY-MM-DD format */
+                to_date: components["schemas"]["Date"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description event counts grouped by day and event type */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data?: components["schemas"]["EventCountByDayRes"][];
+                    };
+                };
+            };
+            /** @description internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProblemDetail"];
+                };
+            };
+        };
+    };
+    "get-v1-dashboard-events-totals": {
+        parameters: {
+            query: {
+                /** @description Start date in YYYY-MM-DD format */
+                from_date: components["schemas"]["Date"];
+                /** @description End date in YYYY-MM-DD format */
+                to_date: components["schemas"]["Date"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description total event counts per event type */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data?: components["schemas"]["EventTotalRes"][];
+                    };
+                };
+            };
+            /** @description internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProblemDetail"];
+                };
+            };
+        };
+    };
+}
+export declare enum EventType {
+    video_upload = "video.upload",
+    video_clip_generate = "video.clip.generate",
+    video_clip_download = "video.clip.download",
+    video_compile_time = "video.compile.time",
+    image_download = "image.download",
+    aicontent_download = "aicontent.download",
+    aicontent_socialcarousel_download = "aicontent.socialcarousel.download",
+    aicontent_quotesandverses_download = "aicontent.quotesandverses.download",
+    aicontent_discussionguide_download = "aicontent.discussionguide.download",
+    aicontent_devotional_download = "aicontent.devotional.download",
+    aicontent_transcription_download = "aicontent.transcription.download",
+    aicontent_blog_download = "aicontent.blog.download",
+    aicontent_audio_download = "aicontent.audio.download",
+    aicontent_summary_download = "aicontent.summary.download"
+}

package/dist/types.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventType = void 0;
+var EventType;
+(function (EventType) {
+    EventType["video_upload"] = "video.upload";
+    EventType["video_clip_generate"] = "video.clip.generate";
+    EventType["video_clip_download"] = "video.clip.download";
+    EventType["video_compile_time"] = "video.compile.time";
+    EventType["image_download"] = "image.download";
+    EventType["aicontent_download"] = "aicontent.download";
+    EventType["aicontent_socialcarousel_download"] = "aicontent.socialcarousel.download";
+    EventType["aicontent_quotesandverses_download"] = "aicontent.quotesandverses.download";
+    EventType["aicontent_discussionguide_download"] = "aicontent.discussionguide.download";
+    EventType["aicontent_devotional_download"] = "aicontent.devotional.download";
+    EventType["aicontent_transcription_download"] = "aicontent.transcription.download";
+    EventType["aicontent_blog_download"] = "aicontent.blog.download";
+    EventType["aicontent_audio_download"] = "aicontent.audio.download";
+    EventType["aicontent_summary_download"] = "aicontent.summary.download";
+})(EventType || (exports.EventType = EventType = {}));

package/package.json

@@ -0,0 +1,17 @@
+{
+	"name": "@sermonshots/analytics",
+	"version": "1.0.0",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc",
+		"dev": "tsc --watch"
+	},
+	"devDependencies": {
+		"@types/node": "^22.0.0",
+		"typescript": "^5.8.0"
+	}
+}