umami-api-js 0.1.0 → 0.1.1

package/README.md

@@ -1,5 +1,5 @@
 A package to interact with [the API of self-hosted instances of Umami v3.0.0](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.0**, 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.1**, 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.0**, 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,33 +11,27 @@ 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 ValueAndPrev {
-    /** The actual value for the given time period */
-    value: number;
-    /** The value for the same *timespan* for the time period that ends where the time period for value starts  */
-    prev: number;
-}
-export interface MinimalUser {
-    id: string;
-    username: string;
-}
 export interface GenericObject {
     id: string;
     createdAt: Date;
     updatedAt: Date | null;
     deletedAt: Date | null;
 }
+export interface DeletionResult {
+    ok: boolean;
+}
 export interface Website extends GenericObject {
     name: string;
     domain: string;
     shareId: string | null;
     resetAt: Date | null;
-    userId: string;
+    /** @remarks Is null if the website is under a team (has a `teamId`) */
+    userId: Users.User["id"] | null;
     teamId: string | null;
-    createdBy: string;
+    createdBy: Users.User["id"];
 }
 export interface Report extends Omit<GenericObject, "deletedAt"> {
-    userId: string;
+    userId: Users.User["id"];
     websiteId: string;
     type: string;
     name: string;
@@ -65,6 +59,7 @@ export interface Timestamps {
     /** Timestamp of end date */
     endAt: Date | number;
 }
+/** An object with the properties `x`, `t`, and `y`, where they're respectively a name, a date, and an amount */
 export interface XTY {
     /** Event name */
     x: string;
@@ -107,7 +102,6 @@ export interface Filters {
     /** UUID of cohort */
     cohort?: string;
 }
-export type Role = "admin" | "user" | "view-only";
 export type TeamRole = "team-manager" | "team-member" | "team-view-only";
 /** If the {@link API} throws an error, it should always be an {@link APIError}! */
 export declare class APIError extends Error {
@@ -169,20 +163,8 @@ export declare class API {
     });
     private _user;
     /** Information about the account that has been used to log in */
-    get user(): {
-        id: string;
-        username: string;
-        role: Role;
-        createdAt: Date;
-        isAdmin: boolean;
-    };
-    set user(user: {
-        id: string;
-        username: string;
-        role: Role;
-        createdAt: Date;
-        isAdmin: boolean;
-    });
+    get user(): Users.User;
+    set user(user: Users.User);
     private number_of_requests;
     /** Has {@link API.setNewToken} been called and not yet returned anything? */
     private is_setting_token;

package/dist/index.js

@@ -102,7 +102,7 @@ export class API {
     _user = {
         id: "",
         username: "",
-        role: "",
+        role: "view-only",
         createdAt: new Date(),
         isAdmin: false,
     };

package/dist/namespaces/Admin.d.ts

@@ -1,10 +1,10 @@
-import { API, GenericObject, GenericRequestParameters, MinimalUser, Role, Teams, Website } from "../index.js";
+import { API, GenericObject, GenericRequestParameters, Teams, Users, Website } 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: Role;
+        role: Users.Role;
         logoUrl: string | null;
         displayName: string | null;
         _count: {
@@ -13,7 +13,7 @@ export declare namespace Admin {
     })[]>;
     /** Returns all websites: https://umami.is/docs/api/admin#get-apiadminwebsites */
     function getWebsites(this: API, parameters?: GenericRequestParameters): Promise<(Website & {
-        user: MinimalUser;
+        user: Users.MinimalUser;
         /** @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;
     })[]>;

package/dist/namespaces/Links.d.ts

@@ -1,11 +1,11 @@
-import { API, GenericObject, GenericRequestParameters } from "../index.js";
+import { API, DeletionResult, GenericObject, GenericRequestParameters, Users } from "../index.js";
 /** Operations around Links management: https://umami.is/docs/api/links */
 export declare namespace Links {
     interface Link extends GenericObject {
         name: string;
         url: string;
         slug: string;
-        userId: string;
+        userId: Users.User["id"];
         teamid: string | null;
     }
     /** Returns all user links: https://umami.is/docs/api/links#get-apilinks (TODO UNTESTED) */
@@ -22,7 +22,5 @@ export declare namespace Links {
         slug?: string;
     }): Promise<Link>;
     /** Deletes a link: https://umami.is/docs/api/links#delete-apilinkslinkid (TODO UNTESTED) */
-    function delete_LINKID(this: API, linkId: Link["id"]): Promise<{
-        ok: boolean;
-    }>;
+    function delete_LINKID(this: API, linkId: Link["id"]): Promise<DeletionResult>;
 }

package/dist/namespaces/Me.d.ts

@@ -1,44 +1,38 @@
-import { API, GenericObject, MinimalUser, Role, TeamRole } from "../index.js";
+import { API, GenericObject, TeamRole, Users } 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 (TODO UNTESTED) */
+    /** Get information based on your auth token: https://umami.is/docs/api/me#get-apime */
     function get(this: API): Promise<{
         token: string;
         authKey: string;
         shareToken: string | null;
-        user: {
-            id: string;
-            username: string;
-            role: Role;
-            createdAt: Date;
-            isAdmin: boolean;
-        };
+        user: Users.User;
     }>;
-    /** Get all your teams: https://umami.is/docs/api/me#get-apimeteams (TODO UNTESTED) */
+    /** Get all your teams: https://umami.is/docs/api/me#get-apimeteams */
     function getTeams(this: API): Promise<(GenericObject & {
         name: string;
         accessCode: string;
         logoUrl: string | null;
         members: (Omit<GenericObject, "deletedAt"> & {
             teamId: string;
-            userId: string;
+            userId: Users.User["id"];
             role: TeamRole;
-            user: MinimalUser;
+            user: Users.MinimalUser;
         })[];
         _count: {
             websites: number;
             members: number;
         };
     })[]>;
-    /** Get all your websites: https://umami.is/docs/api/me#get-apimeteams (TODO UNTESTED) */
+    /** Get all your websites: https://umami.is/docs/api/me#get-apimeteams */
     function getWebsites(this: API): Promise<(GenericObject & {
         name: string;
         domain: string;
         shareId: string | null;
         resetAt: Date | null;
-        userId: string;
+        userId: Users.User["id"];
         teamId: string | null;
         createdBy: string;
-        user: MinimalUser;
+        user: Users.MinimalUser;
     })[]>;
 }

package/dist/namespaces/Me.js

@@ -1,18 +1,18 @@
 /** All information about your session: https://umami.is/docs/api/me */
 export var Me;
 (function (Me) {
-    /** Get information based on your auth token: https://umami.is/docs/api/me#get-apime (TODO UNTESTED) */
+    /** Get information based on your auth token: https://umami.is/docs/api/me#get-apime */
     async function get() {
         return await this.request("get", ["me"]);
     }
     Me.get = get;
-    /** Get all your teams: https://umami.is/docs/api/me#get-apimeteams (TODO UNTESTED) */
+    /** Get all your teams: https://umami.is/docs/api/me#get-apimeteams */
     async function getTeams() {
         const response = await this.request("get", ["me", "teams"]);
         return response.data;
     }
     Me.getTeams = getTeams;
-    /** Get all your websites: https://umami.is/docs/api/me#get-apimeteams (TODO UNTESTED) */
+    /** Get all your websites: https://umami.is/docs/api/me#get-apimeteams */
     async function getWebsites() {
         const response = await this.request("get", ["me", "websites"]);
         return response.data;

package/dist/namespaces/Pixels.d.ts

@@ -1,10 +1,10 @@
-import { API, GenericObject, GenericRequestParameters } from "../index.js";
+import { API, DeletionResult, GenericObject, GenericRequestParameters, Users } from "../index.js";
 /** Operations around Pixels management: https://umami.is/docs/api/pixels */
 export declare namespace Pixels {
     interface Pixel extends GenericObject {
         name: string;
         slug: string;
-        userId: string;
+        userId: Users.User["id"];
         teamid: string | null;
     }
     /** Returns all user pixels: https://umami.is/docs/api/pixels#get-apipixels (TODO UNTESTED) */
@@ -19,7 +19,5 @@ export declare namespace Pixels {
         slug?: string;
     }): Promise<Pixel>;
     /** Deletes a pixel: https://umami.is/docs/api/pixels#delete-apipixelspixelid (TODO UNTESTED) */
-    function delete_PIXELID(this: API, pixelId: Pixel["id"]): Promise<{
-        ok: boolean;
-    }>;
+    function delete_PIXELID(this: API, pixelId: Pixel["id"]): Promise<DeletionResult>;
 }

package/dist/namespaces/Reports.d.ts

@@ -1,4 +1,4 @@
-import { API, Filters, GenericRequestParameters, NameValue, Report, Timestamps, XTY } from "../index.js";
+import { API, DeletionResult, Filters, GenericRequestParameters, NameValue, Report, Timestamps, XTY } from "../index.js";
 /** Using reports throught the api: https://umami.is/docs/api/reports */
 export declare namespace Reports {
     type ReportType = {
@@ -31,9 +31,7 @@ export declare namespace Reports {
         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<{
-        ok: boolean;
-    }>;
+    function delete_REPORTID(this: API, reportId: string): 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: string, parameters: ReportType & Filters & Timestamps & {
         /** Attribution model */

package/dist/namespaces/Teams.d.ts

@@ -1,4 +1,4 @@
-import { API, GenericObject, GenericRequestParameters, TeamRole } from "../index.js";
+import { API, DeletionResult, GenericObject, GenericRequestParameters, TeamRole, Users } from "../index.js";
 /** Operations around Team management: https://umami.is/docs/api/teams */
 export declare namespace Teams {
     interface GenericTeam extends GenericObject {
@@ -8,7 +8,7 @@ export declare namespace Teams {
     }
     interface TeamMember extends Omit<GenericObject, "deletedAt"> {
         teamId: string;
-        userId: string;
+        userId: Users.User["id"];
         role: TeamRole;
         user: {
             id: string;
@@ -39,33 +39,29 @@ export declare namespace Teams {
         accessCode?: string;
     }): Promise<GenericTeam>;
     /** Delete a team: https://umami.is/docs/api/teams#delete-apiteamsteamid (TODO UNTESTED) */
-    function delete_TEAMID(this: API, teamId: string): Promise<{
-        ok: boolean;
-    }>;
+    function delete_TEAMID(this: API, teamId: string): Promise<DeletionResult>;
     /** Get all users that belong to a team: https://umami.is/docs/api/teams#get-apiteamsteamidusers (TODO UNTESTED) */
     function get_TEAMID_Users(this: API, teamId: string, parameters: GenericRequestParameters): Promise<TeamMember[]>;
     /** Add a user to a team: https://umami.is/docs/api/teams#post-apiteamsteamidusers (TODO UNTESTED) */
     function post_TEAMID_Users(this: API, teamId: string, parameters: {
         /** ID of user to be added */
-        userId: string;
+        userId: Users.User["id"];
         /** Team role for user */
         role: TeamRole;
     }): Promise<Omit<TeamMember, "user">>;
     /** Get a user belonging to a team: https://umami.is/docs/api/teams#get-apiteamsteamidusersuserid (TODO UNTESTED) */
-    function get_TEAMID_Users_USERID(this: API, teamId: string, userId: string): Promise<Omit<TeamMember, "user">>;
+    function get_TEAMID_Users_USERID(this: API, teamId: string, userId: Users.User["id"]): Promise<Omit<TeamMember, "user">>;
     /** Update a user's role on a team: https://umami.is/docs/api/teams#post-apiteamsteamidusersuserid (TODO UNTESTED) */
-    function post_TEAMID_Users_USERID(this: API, teamId: string, userId: string, role: TeamRole): Promise<Omit<TeamMember, "user">>;
+    function post_TEAMID_Users_USERID(this: API, teamId: string, userId: Users.User["id"], role: TeamRole): Promise<Omit<TeamMember, "user">>;
     /** Remove a user from a team: https://umami.is/docs/api/teams#delete-apiteamsteamidusersuserid (TODO UNTESTED) */
-    function delete_TEAMID_Users_USERID(this: API, teamId: string, userId: string): Promise<{
-        ok: boolean;
-    }>;
+    function delete_TEAMID_Users_USERID(this: API, teamId: string, userId: Users.User["id"]): Promise<DeletionResult>;
     /** Get all websites that belong to a team: https://umami.is/docs/api/teams#get-apiteamsteamidwebsites (TODO UNTESTED) */
     function get_TEAMID_Websites(this: API, teamId: string, parameters: GenericRequestParameters): Promise<(GenericObject & {
         name: string;
         domain: string;
         shareId: string;
         resetAt: Date | null;
-        userId: string | null;
+        userId: Users.User["id"] | null;
         teamId: string | null;
         createdBy: string;
         createUser: {

package/dist/namespaces/Users.d.ts

@@ -1,9 +1,22 @@
-import { API, GenericObject, GenericRequestParameters, MinimalUser, Role, TeamRole, Website } from "../index.js";
+import { API, DeletionResult, GenericObject, GenericRequestParameters, TeamRole, Website } from "../index.js";
 /** Operations around User management: https://umami.is/docs/api/users */
 export declare namespace Users {
-    interface GenericUser extends MinimalUser {
+    type Role = "admin" | "user" | "view-only";
+    interface MinimalUser {
+        id: string;
+        username: string;
+    }
+    interface MinimalUserWithRole extends MinimalUser {
         role: Role;
     }
+    interface MinimalUserWithCreatedAt extends MinimalUserWithRole {
+        createdAt: Date;
+    }
+    interface MinimalUserWithRoleCreatedAt extends MinimalUserWithRole, MinimalUserWithCreatedAt {
+    }
+    interface User extends MinimalUserWithCreatedAt {
+        isAdmin: boolean;
+    }
     /** Creates a user: https://umami.is/docs/api/users#post-apiusers */
     function post(this: API, parameters: {
         /** The user's username */
@@ -14,40 +27,34 @@ export declare namespace Users {
         role: Role;
         /** Force a UUID assignment to the user */
         id?: string;
-    }): Promise<GenericUser>;
+    }): Promise<MinimalUserWithRole>;
     /** Gets a user by ID: https://umami.is/docs/api/users#get-apiusersuserid */
-    function get_USERID(this: API, userId: string): Promise<GenericUser & {
-        createdAt: Date;
-    }>;
+    function get_USERID(this: API, userId: User["id"]): Promise<MinimalUserWithRoleCreatedAt>;
     /** Updates a user: https://umami.is/docs/api/users#post-apiusersuserid */
-    function post_USERID(this: API, userId: string, parameters?: {
+    function post_USERID(this: API, userId: User["id"], parameters?: {
         /** The user's username */
         username?: string;
         /** The user's password */
         password?: string;
         /** The user's role */
         role?: Role;
-    }): Promise<GenericUser & {
-        createdAt: Date;
-    }>;
+    }): Promise<MinimalUserWithRoleCreatedAt>;
     /** Deletes a user: https://umami.is/docs/api/users#delete-apiusersuserid */
-    function delete_USERID(this: API, userId: string): Promise<{
-        ok: boolean;
-    }>;
+    function delete_USERID(this: API, userId: User["id"]): Promise<DeletionResult>;
     /** Gets all websites that belong to a user: https://umami.is/docs/api/users#get-apiusersuseridwebsites */
-    function get_USERID_Websites(this: API, userId: string, parameters?: GenericRequestParameters & {
+    function get_USERID_Websites(this: API, userId: User["id"], parameters?: GenericRequestParameters & {
         includeTeams?: boolean;
     }): Promise<(Website & {
         user: MinimalUser;
     })[]>;
     /** Gets all teams that belong to a user: https://umami.is/docs/api/users#get-apiusersuseridteams */
-    function get_USERID_Teams(this: API, userId: string, parameters?: Omit<GenericRequestParameters, "search">): Promise<(GenericObject & {
+    function get_USERID_Teams(this: API, userId: User["id"], parameters?: Omit<GenericRequestParameters, "search">): Promise<(GenericObject & {
         name: string;
         accessCode: string;
         logoUrl: string | null;
         members: Omit<GenericObject, "deletedAt"> & {
             teamId: string;
-            userId: string;
+            userId: User["id"];
             role: TeamRole;
             user: MinimalUser;
         }[];

package/dist/namespaces/Websites.d.ts

@@ -1,13 +1,14 @@
-import { API, GenericRequestParameters, MinimalUser, Website } from "../index.js";
+import { API, DeletionResult, GenericRequestParameters, Users, Website } from "../index.js";
 /** Operations around Website management and statistics: https://umami.is/docs/api/websites */
 export declare namespace Websites {
-    /** Returns all user websites: https://umami.is/docs/api/websites#get-apiwebsites (TODO UNTESTED) */
-    function get(this: API, parameters: GenericRequestParameters & {
-        includeTeams: boolean;
+    /** Returns all user websites: https://umami.is/docs/api/websites#get-apiwebsites */
+    function get(this: API, parameters?: GenericRequestParameters & {
+        /** Set to true if you want to include websites where you are the team owner */
+        includeTeams?: boolean;
     }): Promise<(Website & {
-        user: MinimalUser;
+        user: Users.MinimalUser;
     })[]>;
-    /** Creates a website: https://umami.is/docs/api/websites#post-apiwebsites (TODO UNTESTED) */
+    /** Creates a website: https://umami.is/docs/api/websites#post-apiwebsites */
     function post(this: API, parameters: {
         /** The name of the website in Umami */
         name: string;
@@ -20,23 +21,19 @@ export declare namespace Websites {
         /** Force a UUID assignment to the website */
         id?: string;
     }): Promise<Website>;
-    /** Gets a website by ID: https://umami.is/docs/api/websites#get-apiwebsiteswebsiteid (TODO UNTESTED) */
+    /** Gets a website by ID: https://umami.is/docs/api/websites#get-apiwebsiteswebsiteid */
     function get_WEBSITEID(this: API, websiteId: string): Promise<Website>;
-    /** Updates a website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteid (TODO UNTESTED) */
+    /** Updates a website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteid */
     function post_WEBSITEID(this: API, websiteId: string, parameters: {
         /** The name of the website in Umami */
-        name: string;
+        name?: string;
         /** The full domain of the tracked website */
-        domain: string;
+        domain?: string;
         /** A unique string to enable a share url. Set `null` to unshare */
         shareId?: string | null;
     }): Promise<Website>;
-    /** Deletes a website: https://umami.is/docs/api/websites#delete-apiwebsiteswebsiteid (TODO UNTESTED) */
-    function delete_WEBSITEID(this: API, websiteId: string): Promise<{
-        ok: boolean;
-    }>;
-    /** Resets a website by removing all data related to the website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteidreset (TODO UNTESTED) */
-    function post_WEBSITEID_Reset(this: API, websiteId: string): Promise<{
-        ok: boolean;
-    }>;
+    /** Deletes a website: https://umami.is/docs/api/websites#delete-apiwebsiteswebsiteid */
+    function delete_WEBSITEID(this: API, websiteId: string): Promise<DeletionResult>;
+    /** Resets a website by removing all data related to the website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteidreset */
+    function post_WEBSITEID_Reset(this: API, websiteId: string): Promise<DeletionResult>;
 }

package/dist/namespaces/Websites.js

@@ -1,33 +1,33 @@
 /** Operations around Website management and statistics: https://umami.is/docs/api/websites */
 export var Websites;
 (function (Websites) {
-    /** Returns all user websites: https://umami.is/docs/api/websites#get-apiwebsites (TODO UNTESTED) */
+    /** Returns all user websites: https://umami.is/docs/api/websites#get-apiwebsites */
     async function get(parameters) {
         const response = await this.request("get", ["websites"], parameters);
         return response.data;
     }
     Websites.get = get;
-    /** Creates a website: https://umami.is/docs/api/websites#post-apiwebsites (TODO UNTESTED) */
+    /** Creates a website: https://umami.is/docs/api/websites#post-apiwebsites */
     async function post(parameters) {
         return await this.request("post", ["websites"], parameters);
     }
     Websites.post = post;
-    /** Gets a website by ID: https://umami.is/docs/api/websites#get-apiwebsiteswebsiteid (TODO UNTESTED) */
+    /** Gets a website by ID: https://umami.is/docs/api/websites#get-apiwebsiteswebsiteid */
     async function get_WEBSITEID(websiteId) {
         return await this.request("get", ["websites", websiteId]);
     }
     Websites.get_WEBSITEID = get_WEBSITEID;
-    /** Updates a website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteid (TODO UNTESTED) */
+    /** Updates a website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteid */
     async function post_WEBSITEID(websiteId, parameters) {
         return await this.request("post", ["websites", websiteId], parameters);
     }
     Websites.post_WEBSITEID = post_WEBSITEID;
-    /** Deletes a website: https://umami.is/docs/api/websites#delete-apiwebsiteswebsiteid (TODO UNTESTED) */
+    /** Deletes a website: https://umami.is/docs/api/websites#delete-apiwebsiteswebsiteid */
     async function delete_WEBSITEID(websiteId) {
         return await this.request("delete", ["websites", websiteId]);
     }
     Websites.delete_WEBSITEID = delete_WEBSITEID;
-    /** Resets a website by removing all data related to the website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteidreset (TODO UNTESTED) */
+    /** Resets a website by removing all data related to the website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteidreset */
     async function post_WEBSITEID_Reset(websiteId) {
         return await this.request("post", ["websites", websiteId, "reset"]);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umami-api-js",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Package to easily access the umami api!",
   "type": "module",
   "main": "dist/index.js",