umami-api-js 0.1.4 → 0.2.0

package/README.md

@@ -1,5 +1,5 @@
 A package to interact with [the API of self-hosted instances of Umami](https://umami.is/docs/api). It is a lightweight alternative to [@umami/api-client](https://github.com/umami-software/api-client), forked from [osu-api-v2-js](https://github.com/TTTaevas/osu-api-v2-js).
 
-If you are reading this from the [package's documentation](https://umami-api-js.taevas.xyz/), please be aware that the documentation is for **umami-api-js@0.1.4**, so make sure your package is up to date! Report any bug on [Codeberg](https://codeberg.org/Taevas/umami-api-js/issues).
+If you are reading this from the [package's documentation](https://umami-api-js.taevas.xyz/), please be aware that the documentation is for **umami-api-js@0.2.0**, so make sure your package is up to date! Report any bug on [Codeberg](https://codeberg.org/Taevas/umami-api-js/issues).
 
 Please note that this package is expected to work with self-hosted instances of **Umami v3.0.3**, and is *not* expected to work with [Umami Cloud](https://umami.is/docs/cloud), the instance of Umami hosted by its creators.

package/dist/namespaces/Admin.d.ts

@@ -4,10 +4,7 @@ export declare namespace Admin {
     /** Returns all users: https://umami.is/docs/api/admin#get-apiadminusers */
     function getUsers(this: API, parameters?: GenericRequestParameters): Promise<Users.DetailedUser[]>;
     /** Returns all websites: https://umami.is/docs/api/admin#get-apiadminwebsites */
-    function getWebsites(this: API, parameters?: GenericRequestParameters): Promise<(Websites.WebsiteWithUser & {
-        /** @remarks TODO Documentation says it can be null but doesn't actually say what else it can be, ***presumed* to be string**, check */
-        team: string | null;
-    })[]>;
+    function getWebsites(this: API, parameters?: GenericRequestParameters): Promise<Websites.WebsiteWithUserTeam[]>;
     /** Returns all teams: https://umami.is/docs/api/admin#get-apiadminteams */
     function getTeams(this: API, parameters?: GenericRequestParameters): Promise<Teams.TeamWithMembersCount[]>;
 }

package/dist/namespaces/Events.d.ts

@@ -20,12 +20,11 @@ export declare namespace Events {
         pageTitle: string | null;
         eventType: number;
         eventName: string;
-        hasData?: number;
+        hasData?: boolean;
     }
     /** Gets website event details within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevents */
     function get_WEBSITEID_Events(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & GenericRequestParameters): Promise<Event[]>;
-    /** Gets event-data for a individual event: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataeventid */
-    function get_WEBSITEID_Eventdata_EVENTID(this: API, websiteId: Websites.Website["id"], eventId: Event["id"]): Promise<{
+    interface Data {
         websiteId: Websites.Website["id"];
         sessionId?: Sessions.Session["id"];
         eventId: Event["id"];
@@ -37,44 +36,51 @@ export declare namespace Events {
         dateValue: Date | null;
         dataType: number;
         createdAt: Date;
-    }[]>;
+    }
+    /** Gets event-data for a individual event: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataeventid */
+    function get_WEBSITEID_Eventdata_EVENTID(this: API, websiteId: Websites.Website["id"], eventId: Event["id"]): Promise<Data[]>;
+    interface DataMultiple {
+        eventName: Event["eventName"];
+        propertyName: string;
+        dataType: number;
+        total: number;
+    }
     /** Gets event data names, properties, and counts: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataevents (TODO Server returns a 500) */
     function get_WEBSITEID_EventdataEvents(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & {
         /** Event name filter */
         event?: Event["eventName"];
-    }): Promise<{
-        eventName: Event["eventName"];
+    }): Promise<DataMultiple[]>;
+    interface DataFields {
         propertyName: string;
         dataType: number;
+        value: string;
         total: number;
-    }[]>;
+    }
     /** Gets event data property and value counts within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datafields */
-    function get_WEBSITEID_EventdataFields(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<{
+    function get_WEBSITEID_EventdataFields(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<DataFields[]>;
+    interface DataProperties {
+        eventName: Event["eventName"] | null;
         propertyName: string;
-        dataType: number;
-        value: string;
         total: number;
-    }[]>;
+    }
     /** Gets event name and property counts for a website: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataproperties */
-    function get_WEBSITEID_EventdataProperties(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<{
-        eventName: Event["eventName"] | null;
-        propertyName: string;
+    function get_WEBSITEID_EventdataProperties(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<DataProperties[]>;
+    interface DataValues {
+        value: string;
         total: number;
-    }[]>;
+    }
     /** Gets event data counts for a given event and property: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datavalues */
     function get_WEBSITEID_EventdataValues(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & {
         /** Event name filter */
         event: Event["eventName"];
         /** Property name */
         propertyName: string;
-    }): Promise<{
-        value: string;
-        total: number;
-    }[]>;
-    /** Gets aggregated website events, properties, and records within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datastats */
-    function get_WEBSITEID_EventdataStats(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<{
+    }): Promise<DataValues[]>;
+    interface DataStats {
         events: number;
         properties: number;
         records: number;
-    }>;
+    }
+    /** Gets aggregated website events, properties, and records within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datastats */
+    function get_WEBSITEID_EventdataStats(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<DataStats>;
 }

package/dist/namespaces/Links.d.ts

@@ -12,11 +12,11 @@ export declare namespace Links {
         updatedAt: Date;
         deletedAt: Date | null;
     }
-    /** Returns all user links: https://umami.is/docs/api/links#get-apilinks (TODO UNTESTED) */
+    /** Returns all user links: https://umami.is/docs/api/links#get-apilinks */
     function get(this: API, parameters?: GenericRequestParameters): Promise<Link[]>;
-    /** Gets a link by ID: https://umami.is/docs/api/links#get-apilinkslinkid (TODO UNTESTED) */
+    /** Gets a link by ID: https://umami.is/docs/api/links#get-apilinkslinkid */
     function get_LINKID(this: API, linkId: Link["id"]): Promise<Link>;
-    /** Updates a link: https://umami.is/docs/api/links#post-apilinkslinkid (TODO UNTESTED) */
+    /** Updates a link: https://umami.is/docs/api/links#post-apilinkslinkid */
     function post_LINKID(this: API, linkId: Link["id"], parameters: {
         /** The link's name */
         name?: Link["name"];
@@ -25,6 +25,6 @@ export declare namespace Links {
         /** The link's URL slug, **with a minimum of 8 characters** */
         slug?: Link["slug"];
     }): Promise<Link>;
-    /** Deletes a link: https://umami.is/docs/api/links#delete-apilinkslinkid (TODO UNTESTED) */
+    /** Deletes a link: https://umami.is/docs/api/links#delete-apilinkslinkid */
     function delete_LINKID(this: API, linkId: Link["id"]): Promise<DeletionResult>;
 }

package/dist/namespaces/Links.js

@@ -1,23 +1,23 @@
 /** Operations around Links management: https://umami.is/docs/api/links */
 export var Links;
 (function (Links) {
-    /** Returns all user links: https://umami.is/docs/api/links#get-apilinks (TODO UNTESTED) */
+    /** Returns all user links: https://umami.is/docs/api/links#get-apilinks */
     async function get(parameters) {
         const response = await this.request("get", ["links"], parameters);
         return response.data;
     }
     Links.get = get;
-    /** Gets a link by ID: https://umami.is/docs/api/links#get-apilinkslinkid (TODO UNTESTED) */
+    /** Gets a link by ID: https://umami.is/docs/api/links#get-apilinkslinkid */
     async function get_LINKID(linkId) {
         return await this.request("get", ["links", linkId]);
     }
     Links.get_LINKID = get_LINKID;
-    /** Updates a link: https://umami.is/docs/api/links#post-apilinkslinkid (TODO UNTESTED) */
+    /** Updates a link: https://umami.is/docs/api/links#post-apilinkslinkid */
     async function post_LINKID(linkId, parameters) {
         return await this.request("post", ["links", linkId], parameters);
     }
     Links.post_LINKID = post_LINKID;
-    /** Deletes a link: https://umami.is/docs/api/links#delete-apilinkslinkid (TODO UNTESTED) */
+    /** Deletes a link: https://umami.is/docs/api/links#delete-apilinkslinkid */
     async function delete_LINKID(linkId) {
         return await this.request("delete", ["links", linkId]);
     }

package/dist/namespaces/Me.d.ts

@@ -2,9 +2,9 @@ import { API, Teams, Users, Websites } from "../index.js";
 /** All information about your session: https://umami.is/docs/api/me */
 export declare namespace Me {
     interface TokenInformation {
-        token: API["token"];
-        authKey: string;
+        token: string;
         shareToken: string | null;
+        authKey?: string;
         user: Users.User;
     }
     /** Get information based on your auth token: https://umami.is/docs/api/me#get-apime */

package/dist/namespaces/Pixels.d.ts

@@ -11,17 +11,17 @@ export declare namespace Pixels {
         updatedAt: Date;
         deletedAt: Date | null;
     }
-    /** Returns all user pixels: https://umami.is/docs/api/pixels#get-apipixels (TODO UNTESTED) */
+    /** Returns all user pixels: https://umami.is/docs/api/pixels#get-apipixels */
     function get(this: API, parameters?: GenericRequestParameters): Promise<Pixel[]>;
-    /** Gets a pixel by ID: https://umami.is/docs/api/pixels#get-apipixelspixelid (TODO UNTESTED) */
+    /** Gets a pixel by ID: https://umami.is/docs/api/pixels#get-apipixelspixelid */
     function get_PIXELID(this: API, pixelId: Pixel["id"]): Promise<Pixel>;
-    /** Updates a pixel: https://umami.is/docs/api/pixels#post-apipixelspixelid (TODO UNTESTED) */
+    /** Updates a pixel: https://umami.is/docs/api/pixels#post-apipixelspixelid */
     function post_PIXELID(this: API, pixelId: Pixel["id"], parameters: {
         /** The pixel's name */
         name?: Pixel["name"];
         /** The pixel's URL slug, **with a minimum of 8 characters** */
         slug?: Pixel["slug"];
     }): Promise<Pixel>;
-    /** Deletes a pixel: https://umami.is/docs/api/pixels#delete-apipixelspixelid (TODO UNTESTED) */
+    /** Deletes a pixel: https://umami.is/docs/api/pixels#delete-apipixelspixelid */
     function delete_PIXELID(this: API, pixelId: Pixel["id"]): Promise<DeletionResult>;
 }

package/dist/namespaces/Pixels.js

@@ -1,23 +1,23 @@
 /** Operations around Pixels management: https://umami.is/docs/api/pixels */
 export var Pixels;
 (function (Pixels) {
-    /** Returns all user pixels: https://umami.is/docs/api/pixels#get-apipixels (TODO UNTESTED) */
+    /** Returns all user pixels: https://umami.is/docs/api/pixels#get-apipixels */
     async function get(parameters) {
         const response = await this.request("get", ["pixels"], parameters);
         return response.data;
     }
     Pixels.get = get;
-    /** Gets a pixel by ID: https://umami.is/docs/api/pixels#get-apipixelspixelid (TODO UNTESTED) */
+    /** Gets a pixel by ID: https://umami.is/docs/api/pixels#get-apipixelspixelid */
     async function get_PIXELID(pixelId) {
         return await this.request("get", ["pixels", pixelId]);
     }
     Pixels.get_PIXELID = get_PIXELID;
-    /** Updates a pixel: https://umami.is/docs/api/pixels#post-apipixelspixelid (TODO UNTESTED) */
+    /** Updates a pixel: https://umami.is/docs/api/pixels#post-apipixelspixelid */
     async function post_PIXELID(pixelId, parameters) {
         return await this.request("post", ["pixels", pixelId], parameters);
     }
     Pixels.post_PIXELID = post_PIXELID;
-    /** Deletes a pixel: https://umami.is/docs/api/pixels#delete-apipixelspixelid (TODO UNTESTED) */
+    /** Deletes a pixel: https://umami.is/docs/api/pixels#delete-apipixelspixelid */
     async function delete_PIXELID(pixelId) {
         return await this.request("delete", ["pixels", pixelId]);
     }

package/dist/namespaces/Realtime.d.ts

@@ -1,8 +1,7 @@
 import { API, Sessions, Websites } from "../index.js";
 /** Realtime data for your website: https://umami.is/docs/api/realtime */
 export declare namespace Realtime {
-    /** Realtime stats within the last 30 minutes: https://umami.is/docs/api/realtime#get-apirealtimewebsiteid */
-    function get_WEBSITEID(this: API, websiteId: Websites.Website["id"]): Promise<{
+    interface Stats {
         countries: {
             [k: string]: number;
         };
@@ -17,12 +16,12 @@ export declare namespace Realtime {
             sessionId: Sessions.Session["id"];
             eventName: string;
             createdAt: Date;
-            browser: string;
-            os: string;
+            browser: string | null;
+            os: string | null;
             device: string;
             country: string;
             urlPath: string;
-            referrerDomain: string;
+            referrerDomain: string | null;
         }[];
         series: {
             views: {
@@ -41,5 +40,7 @@ export declare namespace Realtime {
             countries: number;
         };
         timestamp: number;
-    }>;
+    }
+    /** Realtime stats within the last 30 minutes: https://umami.is/docs/api/realtime#get-apirealtimewebsiteid */
+    function get_WEBSITEID(this: API, websiteId: Websites.Website["id"]): Promise<Stats>;
 }

package/dist/namespaces/Sessions.d.ts

@@ -17,19 +17,13 @@ export declare namespace Sessions {
         visits: number;
         views: number;
     }
-    interface SessionWithHostnameCreatedat extends Session {
+    interface SessionWithHostnameCreatedate extends Session {
         hostname: string;
         createdAt: Date;
     }
-    interface SessionWithDistinctidEventsTotaltime extends Session {
-        distinctId: string | null;
-        events: number;
-        totaltime: number;
-    }
     /** Gets website session details within a given time range: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessions */
-    function get_WEBSITEID_Sessions(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & GenericRequestParameters): Promise<SessionWithHostnameCreatedat[]>;
-    /** Gets summarized website session statistics: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionsstats */
-    function get_WEBSITEID_SessionsStats(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<{
+    function get_WEBSITEID_Sessions(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & GenericRequestParameters): Promise<SessionWithHostnameCreatedate[]>;
+    interface Stats {
         /** Pages hits */
         pageviews: {
             value: number;
@@ -50,29 +44,29 @@ export declare namespace Sessions {
         events: {
             value: number;
         };
-        /**
-         * Number of visitors who only visit a single page
-         * @remarks While featured in the documentation, it doesn't seem to exist
-         */
+        /** Number of visitors who only visit a single page */
         bounces?: {
             value: number;
         };
-        /**
-         * Time spent on the website
-         * @remarks While featured in the documentation, it doesn't seem to exist
-         */
+        /** Time spent on the website */
         totaltime?: {
             value: number;
         };
-    }>;
+    }
+    /** Gets summarized website session statistics: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionsstats */
+    function get_WEBSITEID_SessionsStats(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<Stats>;
     /** Get collected count of sessions by hour of weekday: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionsweekly */
     function get_WEBSITEID_SessionsWeekly(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & {
         timezone: string;
     }): Promise<number[][]>;
+    interface SessionWithDistinctidEventsTotaltime extends Session {
+        distinctId: string | null;
+        events: number;
+        totaltime: number;
+    }
     /** Gets session details for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionid */
     function get_WEBSITEID_Sessions_SESSIONID(this: API, websiteId: Websites.Website["id"], sessionId: Session["id"]): Promise<SessionWithDistinctidEventsTotaltime>;
-    /** Gets session activity for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionidactivity */
-    function get_WEBSITEID_Sessions_SESSIONID_Activity(this: API, websiteId: Websites.Website["id"], sessionId: Session["id"], parameters: Timestamps): Promise<{
+    interface Activity {
         createdAt: Date;
         urlPath: string;
         urlQuery: string;
@@ -82,9 +76,10 @@ export declare namespace Sessions {
         eventName: Events.Event["eventName"] | null;
         visitId: string;
         hasData: boolean;
-    }[]>;
-    /** Gets session properties for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionidproperties (TODO Server returns empty array) */
-    function get_WEBSITEID_Sessions_SESSIONID_Properties(this: API, websiteId: Websites.Website["id"], sessionId: Session["id"]): Promise<{
+    }
+    /** Gets session activity for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionidactivity */
+    function get_WEBSITEID_Sessions_SESSIONID_Activity(this: API, websiteId: Websites.Website["id"], sessionId: Session["id"], parameters: Timestamps): Promise<Activity[]>;
+    interface Properties {
         websiteId: Websites.Website["id"];
         sessionId: Session["id"];
         dataKey: string;
@@ -93,17 +88,21 @@ export declare namespace Sessions {
         numberValue: number | null;
         dateValue: Date | null;
         createdAt: Date;
-    }[]>;
-    /** Gets session data counts by property name: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsession-dataproperties (TODO Server returns empty array) */
-    function get_WEBSITEID_SessiondataProperties(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<{
+    }
+    /** Gets session properties for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionidproperties (TODO Server returns empty array) */
+    function get_WEBSITEID_Sessions_SESSIONID_Properties(this: API, websiteId: Websites.Website["id"], sessionId: Session["id"]): Promise<Properties[]>;
+    interface DataProperties {
         propertyName: string;
         total: number;
-    }[]>;
+    }
+    /** Gets session data counts by property name: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsession-dataproperties (TODO Server returns empty array) */
+    function get_WEBSITEID_SessiondataProperties(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<DataProperties[]>;
+    interface DataValues {
+        value: string;
+        total: number;
+    }
     /** Gets session data counts for a given property: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsession-datavalues (TODO Server returns empty array) */
     function get_WEBSITEID_SessiondataValues(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & {
         propertyName: string;
-    }): Promise<{
-        value: string;
-        total: number;
-    }[]>;
+    }): Promise<DataValues[]>;
 }

package/dist/namespaces/Teams.d.ts

@@ -22,9 +22,12 @@ export declare namespace Teams {
         user: Users.MinimalUser;
     }
     interface TeamWithMembers extends Team {
+        members: TeamMember[];
+    }
+    interface TeamWithMembersWithUser extends Team {
         members: TeamMemberWithUser[];
     }
-    interface TeamWithMembersCount extends TeamWithMembers {
+    interface TeamWithMembersCount extends TeamWithMembersWithUser {
         _count: {
             websites: number;
             members: number;

package/dist/namespaces/Users.d.ts

@@ -14,7 +14,7 @@ export declare namespace Users {
     }
     interface MinimalUserWithRoleCreatedAt extends MinimalUserWithRole, MinimalUserWithCreatedAt {
     }
-    interface User extends MinimalUserWithCreatedAt {
+    interface User extends MinimalUserWithRoleCreatedAt {
         isAdmin: boolean;
     }
     interface DetailedUser extends MinimalUserWithRole, MinimalUserWithCreatedAt {

package/dist/namespaces/WebsiteStats.js

@@ -8,9 +8,7 @@ export var WebsiteStats;
     WebsiteStats.get_WEBSITEID_Active = get_WEBSITEID_Active;
     /** Gets events within a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteideventsseries */
     async function get_WEBSITEID_EventsSeries(websiteId, parameters) {
-        const response = await this.request("get", ["websites", websiteId, "events", "series"], parameters);
-        response.t = new Date(response.t);
-        return response;
+        return await this.request("get", ["websites", websiteId, "events", "series"], parameters);
     }
     WebsiteStats.get_WEBSITEID_EventsSeries = get_WEBSITEID_EventsSeries;
     /** Gets metrics for a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidmetrics (TODO UNTESTED) */
@@ -25,10 +23,7 @@ export var WebsiteStats;
     WebsiteStats.get_WEBSITEID_MetricsExpanded = get_WEBSITEID_MetricsExpanded;
     /** Gets pageviews within a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidpageviews (TODO UNTESTED) */
     async function get_WEBSITEID_Pageviews(websiteId, parameters) {
-        const response = await this.request("get", ["websites", websiteId, "pageviews"], parameters);
-        response.pageviews = response.pageviews.map((v) => { v.x = new Date(v.x); return v; });
-        response.sessions = response.sessions.map((s) => { s.x = new Date(s.x); return s; });
-        return response;
+        return await this.request("get", ["websites", websiteId, "pageviews"], parameters);
     }
     WebsiteStats.get_WEBSITEID_Pageviews = get_WEBSITEID_Pageviews;
     /** Gets summarized website statistics: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidstats (TODO UNTESTED) */

package/dist/namespaces/Websites.d.ts

@@ -19,7 +19,12 @@ export declare namespace Websites {
         createUser: Users.MinimalUser;
     }
     interface WebsiteWithUser extends Website {
-        user: Users.MinimalUser;
+        /** @remarks Might be undefined if owned by a team? */
+        user?: Users.MinimalUser;
+    }
+    interface WebsiteWithUserTeam extends Website {
+        user: Users.MinimalUser | null;
+        team: Teams.TeamWithMembers | null;
     }
     /** Returns all user websites: https://umami.is/docs/api/websites#get-apiwebsites */
     function get(this: API, parameters?: GenericRequestParameters & {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "umami-api-js",
-  "version": "0.1.4",
-  "description": "Package to easily access the umami api!",
+  "version": "0.2.0",
+  "description": "Package to easily access the Umami api!",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,6 +23,7 @@
   "keywords": [
     "umami",
     "api",
+    "analytics",
     "wrapper",
     "api-wrapper"
   ],
@@ -30,8 +31,10 @@
   "devDependencies": {
     "@types/chai": "^5.2.3",
     "@types/node": "^24.9.2",
+    "ajv": "^8.17.1",
     "chai": "^6.2.2",
     "dotenv": "^17.2.3",
+    "ts-json-schema-generator": "^2.4.0",
     "typedoc": "^0.28.16",
     "typescript": "^5.9.3"
   }