umami-api-js 0.1.3 → 0.1.4

package/README.md

@@ -1,5 +1,5 @@
-A package to interact with [the API of self-hosted instances of Umami v3.0.1](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).
+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.3**, 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.1.4**, 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.1**, and is *not* expected to work with [Umami Cloud](https://umami.is/docs/cloud), the instance of Umami hosted by its creators.
+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/index.d.ts

@@ -11,26 +11,9 @@ import { Users } from "./namespaces/Users.js";
 import { Websites } from "./namespaces/Websites.js";
 import { WebsiteStats } from "./namespaces/WebsiteStats.js";
 export { Admin, Events, Links, Me, Pixels, Websites, WebsiteStats, Realtime, Reports, Sessions, Teams, Users };
-export interface GenericObject {
-    id: string;
-    createdAt: Date;
-    updatedAt: Date | null;
-    deletedAt: Date | null;
-}
 export interface DeletionResult {
     ok: boolean;
 }
-export interface Report extends Omit<GenericObject, "deletedAt"> {
-    userId: Users.User["id"];
-    websiteId: Websites.Website["id"];
-    type: string;
-    name: string;
-    description: string;
-    parameters: {
-        type: string;
-        value: string;
-    };
-}
 export interface NameValue {
     name: string;
     value: number;

package/dist/index.js

@@ -140,6 +140,7 @@ export class API {
                         this.log(true, "Unable to obtain a token! Here's what was received from the API:", json);
                         reject(new APIError(error_message, this.server, "post", ["auth", "login"], body, response.status));
                     }
+                    // Note: `json` currently only has `token` & `user`
                     this.token = json.token;
                     this.user = json.user;
                     const expiration_date = new Date();

package/dist/namespaces/Admin.d.ts

@@ -1,16 +1,8 @@
-import { API, GenericObject, GenericRequestParameters, Teams, Users, Websites } from "../index.js";
+import { API, GenericRequestParameters, Teams, Users, Websites } from "../index.js";
 /** Operations around admin management: https://umami.is/docs/api/admin */
 export declare namespace Admin {
     /** Returns all users: https://umami.is/docs/api/admin#get-apiadminusers */
-    function getUsers(this: API, parameters?: GenericRequestParameters): Promise<(GenericObject & {
-        username: string;
-        role: Users.Role;
-        logoUrl: string | null;
-        displayName: string | null;
-        _count: {
-            websites: number;
-        };
-    })[]>;
+    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 */

package/dist/namespaces/Links.d.ts

@@ -1,12 +1,16 @@
-import { API, DeletionResult, GenericObject, GenericRequestParameters, Users } from "../index.js";
+import { API, DeletionResult, GenericRequestParameters, Users } from "../index.js";
 /** Operations around Links management: https://umami.is/docs/api/links */
 export declare namespace Links {
-    interface Link extends GenericObject {
+    interface Link {
+        id: string;
         name: string;
         url: string;
         slug: string;
         userId: Users.User["id"];
-        teamid: string | null;
+        teamId: string | null;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
     }
     /** Returns all user links: https://umami.is/docs/api/links#get-apilinks (TODO UNTESTED) */
     function get(this: API, parameters?: GenericRequestParameters): Promise<Link[]>;

package/dist/namespaces/Me.d.ts

@@ -1,13 +1,14 @@
 import { API, Teams, Users, Websites } from "../index.js";
 /** All information about your session: https://umami.is/docs/api/me */
 export declare namespace Me {
-    /** Get information based on your auth token: https://umami.is/docs/api/me#get-apime */
-    function get(this: API): Promise<{
-        token: string;
+    interface TokenInformation {
+        token: API["token"];
         authKey: string;
         shareToken: string | null;
         user: Users.User;
-    }>;
+    }
+    /** Get information based on your auth token: https://umami.is/docs/api/me#get-apime */
+    function get(this: API): Promise<TokenInformation>;
     /** Get all your teams: https://umami.is/docs/api/me#get-apimeteams */
     function getTeams(this: API): Promise<Teams.TeamWithMembersCount[]>;
     /** Get all your websites: https://umami.is/docs/api/me#get-apimeteams */

package/dist/namespaces/Pixels.d.ts

@@ -1,11 +1,15 @@
-import { API, DeletionResult, GenericObject, GenericRequestParameters, Users } from "../index.js";
+import { API, DeletionResult, GenericRequestParameters, Users } from "../index.js";
 /** Operations around Pixels management: https://umami.is/docs/api/pixels */
 export declare namespace Pixels {
-    interface Pixel extends GenericObject {
+    interface Pixel {
+        id: string;
         name: string;
         slug: string;
         userId: Users.User["id"];
-        teamid: string | null;
+        teamId: string | null;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
     }
     /** Returns all user pixels: https://umami.is/docs/api/pixels#get-apipixels (TODO UNTESTED) */
     function get(this: API, parameters?: GenericRequestParameters): Promise<Pixel[]>;

package/dist/namespaces/Realtime.d.ts

@@ -1,7 +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 (TODO UNTESTED) */
+    /** 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<{
         countries: {
             [k: string]: number;

package/dist/namespaces/Realtime.js

@@ -1,9 +1,9 @@
 /** Realtime data for your website: https://umami.is/docs/api/realtime */
 export var Realtime;
 (function (Realtime) {
-    /** Realtime stats within the last 30 minutes: https://umami.is/docs/api/realtime#get-apirealtimewebsiteid (TODO UNTESTED) */
+    /** Realtime stats within the last 30 minutes: https://umami.is/docs/api/realtime#get-apirealtimewebsiteid */
     async function get_WEBSITEID(websiteId) {
-        return await this.request("post", ["realtime", websiteId]);
+        return await this.request("get", ["realtime", websiteId]);
     }
     Realtime.get_WEBSITEID = get_WEBSITEID;
 })(Realtime || (Realtime = {}));

package/dist/namespaces/Reports.d.ts

@@ -1,6 +1,20 @@
-import { API, DeletionResult, Filters, GenericRequestParameters, NameValue, Report, Timestamps, Websites, XTY } from "../index.js";
+import { API, DeletionResult, Filters, GenericRequestParameters, NameValue, Timestamps, Users, Websites, XTY } from "../index.js";
 /** Using reports throught the api: https://umami.is/docs/api/reports */
 export declare namespace Reports {
+    interface Report {
+        id: string;
+        userId: Users.User["id"];
+        websiteId: Websites.Website["id"];
+        type: ReportType;
+        name: string;
+        description: string;
+        parameters: {
+            type: string;
+            value: string;
+        };
+        createdAt: Date;
+        updatedAt: Date;
+    }
     type ReportType = {
         type: "attribution" | "breakdown" | "funnel" | "goal" | "journey" | "retention" | "revenue" | "utm";
     };
@@ -13,25 +27,25 @@ export declare namespace Reports {
     /** Creates a report: https://umami.is/docs/api/reports#post-apireports (TODO UNTESTED) */
     function post(this: API, websiteId: Websites.Website["id"], parameters: ReportType & {
         /** Name of report */
-        name: string;
+        name: Report["name"];
         /** Description of report */
-        description?: string;
+        description?: Report["description"];
         /** Parameters for report */
         parameters?: any;
     }): Promise<Report>;
     /** Gets a report by ID: https://umami.is/docs/api/reports#get-apireportsreportid (TODO UNTESTED) */
-    function get_REPORTID(this: API, reportId: string): Promise<Report>;
+    function get_REPORTID(this: API, reportId: Report["id"]): Promise<Report>;
     /** Updates a report: https://umami.is/docs/api/reports#post-apireportsreportid (TODO UNTESTED) */
-    function post_REPORTID(this: API, reportId: string, websiteId: Websites.Website["id"], parameters: ReportType & {
+    function post_REPORTID(this: API, reportId: Report["id"], websiteId: Websites.Website["id"], parameters: ReportType & {
         /** Name of report */
-        name: string;
+        name: Report["name"];
         /** Description of report */
-        description?: string;
+        description?: Report["description"];
         /** Parameters for report */
         parameters?: any;
     }): Promise<Report>;
     /** Deletes a report: https://umami.is/docs/api/reports#delete-apireportsreportid (TODO UNTESTED) */
-    function delete_REPORTID(this: API, reportId: string): Promise<DeletionResult>;
+    function delete_REPORTID(this: API, reportId: Report["id"]): Promise<DeletionResult>;
     /** See how users engage with your marketing and what drives conversions: https://umami.is/docs/api/reports#post-apireportsattribution (TODO UNTESTED) */
     function postAttribution(this: API, websiteId: Websites.Website["id"], parameters: ReportType & Filters & Timestamps & {
         /** Attribution model */

package/dist/namespaces/Users.d.ts

@@ -17,6 +17,15 @@ export declare namespace Users {
     interface User extends MinimalUserWithCreatedAt {
         isAdmin: boolean;
     }
+    interface DetailedUser extends MinimalUserWithRole, MinimalUserWithCreatedAt {
+        logoUrl: string | null;
+        displayName: string | null;
+        updatedAt: Date;
+        deletedAt: Date | null;
+        _count: {
+            websites: number;
+        };
+    }
     /** Creates a user: https://umami.is/docs/api/users#post-apiusers */
     function post(this: API, parameters: {
         /** The user's username */

package/dist/namespaces/WebsiteStats.d.ts

@@ -30,11 +30,11 @@ export declare namespace WebsiteStats {
         totaltime: number;
     }
     type MetricsTypes = "path" | "entry" | "exit" | "title" | "query" | "referrer" | "channel" | "domain" | "country" | "region" | "city" | "browser" | "os" | "device" | "language" | "screen" | "event" | "hostname" | "tag";
-    /** Gets the number of active users on a website: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidactive (TODO UNTESTED) */
+    /** Gets the number of active users on a website: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidactive */
     function get_WEBSITEID_Active(this: API, websiteId: Websites.Website["id"]): Promise<{
         visitors: number;
     }>;
-    /** Gets events within a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteideventsseries (TODO UNTESTED) */
+    /** Gets events within a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteideventsseries */
     function get_WEBSITEID_EventsSeries(this: API, websiteId: Websites.Website["id"], parameters: Timestamps & Units & Filters & {
         /** Timezone (ex. America/Los_Angeles) */
         timezone: string;

package/dist/namespaces/WebsiteStats.js

@@ -1,14 +1,16 @@
 /** Operations around Website statistics: https://umami.is/docs/api/website-stats */
 export var WebsiteStats;
 (function (WebsiteStats) {
-    /** Gets the number of active users on a website: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidactive (TODO UNTESTED) */
+    /** Gets the number of active users on a website: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidactive */
     async function get_WEBSITEID_Active(websiteId) {
         return await this.request("get", ["websites", websiteId, "active"]);
     }
     WebsiteStats.get_WEBSITEID_Active = get_WEBSITEID_Active;
-    /** Gets events within a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteideventsseries (TODO UNTESTED) */
+    /** Gets events within a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteideventsseries */
     async function get_WEBSITEID_EventsSeries(websiteId, parameters) {
-        return await this.request("get", ["websites", websiteId, "events", "series"], parameters);
+        const response = await this.request("get", ["websites", websiteId, "events", "series"], parameters);
+        response.t = new Date(response.t);
+        return response;
     }
     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) */
@@ -23,7 +25,10 @@ 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) {
-        return await this.request("get", ["websites", websiteId, "pageviews"], 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;
     }
     WebsiteStats.get_WEBSITEID_Pageviews = get_WEBSITEID_Pageviews;
     /** Gets summarized website statistics: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidstats (TODO UNTESTED) */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umami-api-js",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Package to easily access the umami api!",
   "type": "module",
   "main": "dist/index.js",
@@ -30,9 +30,9 @@
   "devDependencies": {
     "@types/chai": "^5.2.3",
     "@types/node": "^24.9.2",
-    "chai": "^6.2.0",
+    "chai": "^6.2.2",
     "dotenv": "^17.2.3",
-    "typedoc": "^0.28.14",
+    "typedoc": "^0.28.16",
     "typescript": "^5.9.3"
   }
 }