umami-api-js 1.0.1 → 1.1.0

package/dist/index.d.ts

@@ -6,11 +6,12 @@ import { Pixels } from "./namespaces/Pixels.js";
 import { Realtime } from "./namespaces/Realtime.js";
 import { Reports } from "./namespaces/Reports.js";
 import { Sessions } from "./namespaces/Sessions.js";
+import { Share } from "./namespaces/Share.js";
 import { Teams } from "./namespaces/Teams.js";
 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 { Admin, Events, Links, Me, Pixels, Websites, WebsiteStats, Realtime, Reports, Sessions, Share, Teams, Users, };
 export interface DeletionResult {
     ok: boolean;
 }
@@ -157,8 +158,8 @@ export declare class API {
     });
     private _user;
     /** Information about the account that has been used to log in */
-    get user(): Users.User;
-    set user(user: Users.User);
+    get user(): Users.UserWithTeams;
+    set user(user: Users.UserWithTeams);
     private number_of_requests;
     /** Has {@link API.setNewToken} been called and not yet returned anything? */
     private is_setting_token;
@@ -192,8 +193,8 @@ export declare class API {
     private updateTokenTimer;
     private _verbose?;
     /** Which events should be logged (defaults to **none**) */
-    get verbose(): "none" | "errors" | "all" | undefined;
-    set verbose(verbose: "none" | "errors" | "all" | undefined);
+    get verbose(): "all" | "none" | "errors" | undefined;
+    set verbose(verbose: "all" | "none" | "errors" | undefined);
     private _timeout;
     /**
      * The maximum **amount of seconds** requests should take before returning an answer (defaults to **20**)
@@ -309,6 +310,8 @@ export declare class API {
     /** @group Links endpoints */
     readonly getLinks: typeof Links.get;
     /** @group Links endpoints */
+    readonly createLink: typeof Links.post;
+    /** @group Links endpoints */
     readonly getLink: typeof Links.get_LINKID;
     /** @group Links endpoints */
     readonly updateLink: typeof Links.post_LINKID;
@@ -320,13 +323,15 @@ export declare class API {
     readonly getMyTeams: typeof Me.getTeams;
     /** @group Me endpoints */
     readonly getMyWebsites: typeof Me.getWebsites;
-    /** @group Links endpoints */
+    /** @group Pixels endpoints */
     readonly getPixels: typeof Pixels.get;
-    /** @group Links endpoints */
+    /** @group Pixels endpoints */
+    readonly createPixel: typeof Pixels.post;
+    /** @group Pixels endpoints */
     readonly getPixel: typeof Pixels.get_PIXELID;
-    /** @group Links endpoints */
+    /** @group Pixels endpoints */
     readonly updatePixel: typeof Pixels.post_PIXELID;
-    /** @group Links endpoints */
+    /** @group Pixels endpoints */
     readonly deletePixel: typeof Pixels.delete_PIXELID;
     /** @group Websites endpoints */
     readonly getWebsites: typeof Websites.get;
@@ -396,6 +401,18 @@ export declare class API {
     readonly getWebsiteSessionDataProperties: typeof Sessions.get_WEBSITEID_SessiondataProperties;
     /** @group Sessions endpoints */
     readonly getWebsiteSessionDataValues: typeof Sessions.get_WEBSITEID_SessiondataValues;
+    /** @group Share endpoints */
+    readonly createShare: typeof Share.post;
+    /** @group Share endpoints */
+    readonly getShare: typeof Share.get_SHAREID;
+    /** @group Share endpoints */
+    readonly updateShare: typeof Share.post_SHAREID;
+    /** @group Share endpoints */
+    readonly deleteShare: typeof Share.delete_SHAREID;
+    /** @group Share endpoints */
+    readonly getWebsiteShares: typeof Share.get_WEBSITEID_Shares;
+    /** @group Share endpoints */
+    readonly createWebsiteShare: typeof Share.post_WEBSITEID_Shares;
     /** @group Teams endpoints */
     readonly getTeams: typeof Teams.get;
     /** @group Teams endpoints */

package/dist/index.js

@@ -6,12 +6,13 @@ import { Pixels } from "./namespaces/Pixels.js";
 import { Realtime } from "./namespaces/Realtime.js";
 import { Reports } from "./namespaces/Reports.js";
 import { Sessions } from "./namespaces/Sessions.js";
+import { Share } from "./namespaces/Share.js";
 import { Teams } from "./namespaces/Teams.js";
 import { Users } from "./namespaces/Users.js";
 import { Websites } from "./namespaces/Websites.js";
 import { WebsiteStats } from "./namespaces/WebsiteStats.js";
 import { adaptParametersForGETRequests, correctType } from "./utilities.js";
-export { Admin, Events, Links, Me, Pixels, Websites, WebsiteStats, Realtime, Reports, Sessions, Teams, Users, };
+export { Admin, Events, Links, Me, Pixels, Websites, WebsiteStats, Realtime, Reports, Sessions, Share, Teams, Users, };
 /** If the {@link API} throws an error, it should always be an {@link APIError}! */
 export class APIError extends Error {
     message;
@@ -173,12 +174,14 @@ export class API {
         role: "view-only",
         createdAt: new Date(),
         isAdmin: false,
+        teams: [],
     };
     /** Information about the account that has been used to log in */
     get user() {
         return this._user;
     }
     set user(user) {
+        user.createdAt = new Date(user.createdAt);
         this._user = user;
     }
     number_of_requests = 0;
@@ -428,6 +431,10 @@ export class API {
                     })
                         .join("&");
         }
+        const headers = new Headers(this.headers);
+        if (!is_token_related) {
+            headers.append("Authorization", `${this.token_type} ${this.token}`);
+        }
         const signals = [];
         if (this.timeout > 0)
             signals.push(AbortSignal.timeout(this.timeout * 1000));
@@ -435,12 +442,7 @@ export class API {
             signals.push(this.signal);
         const response = await fetch(url, {
             method,
-            headers: {
-                Authorization: is_token_related
-                    ? undefined
-                    : `${this.token_type} ${this.token}`,
-                ...this.headers,
-            },
+            headers,
             body: method !== "get" ? JSON.stringify(parameters) : undefined, // parameters are here if method is NOT GET
             signal: AbortSignal.any(signals),
         })
@@ -486,6 +488,9 @@ export class API {
         if (to_retry === true && info.number_try <= this.retry_maximum_amount) {
             this.log(true, `Will request again in ${this.retry_delay} seconds...`, `(retry #${info.number_try}/${this.retry_maximum_amount})`, request_id);
             await new Promise((res) => setTimeout(res, this.retry_delay * 1000));
+            if (response) {
+                void response.text(); // Consume the response to avoid connection pool exhaustion
+            }
             return await this.fetch(is_token_related, method, endpoint, parameters, {
                 number_try: info.number_try + 1,
                 has_new_token: info.has_new_token,
@@ -512,9 +517,7 @@ export class API {
     async request(method, endpoint, parameters = {}) {
         try {
             const response = await this.fetch(false, method, endpoint, parameters);
-            if (response.status === 204)
-                return undefined; // 204 means the request worked as intended and did not give us anything, so just return nothing
-            const arrBuff = await response.arrayBuffer();
+            const arrBuff = await response.arrayBuffer(); // note: immediately consume the response to prevent connection pool leaks
             const buff = Buffer.from(arrBuff);
             try {
                 // Assume the response is in JSON format as it often is, it'll fail into the catch block if it isn't anyway
@@ -571,6 +574,8 @@ export class API {
     /** @group Links endpoints */
     getLinks = Links.get;
     /** @group Links endpoints */
+    createLink = Links.post;
+    /** @group Links endpoints */
     getLink = Links.get_LINKID;
     /** @group Links endpoints */
     updateLink = Links.post_LINKID;
@@ -584,13 +589,15 @@ export class API {
     /** @group Me endpoints */
     getMyWebsites = Me.getWebsites;
     // PIXELS
-    /** @group Links endpoints */
+    /** @group Pixels endpoints */
     getPixels = Pixels.get;
-    /** @group Links endpoints */
+    /** @group Pixels endpoints */
+    createPixel = Pixels.post;
+    /** @group Pixels endpoints */
     getPixel = Pixels.get_PIXELID;
-    /** @group Links endpoints */
+    /** @group Pixels endpoints */
     updatePixel = Pixels.post_PIXELID;
-    /** @group Links endpoints */
+    /** @group Pixels endpoints */
     deletePixel = Pixels.delete_PIXELID;
     // WEBSITES
     /** @group Websites endpoints */
@@ -665,6 +672,19 @@ export class API {
     getWebsiteSessionDataProperties = Sessions.get_WEBSITEID_SessiondataProperties;
     /** @group Sessions endpoints */
     getWebsiteSessionDataValues = Sessions.get_WEBSITEID_SessiondataValues;
+    // SHARE
+    /** @group Share endpoints */
+    createShare = Share.post;
+    /** @group Share endpoints */
+    getShare = Share.get_SHAREID;
+    /** @group Share endpoints */
+    updateShare = Share.post_SHAREID;
+    /** @group Share endpoints */
+    deleteShare = Share.delete_SHAREID;
+    /** @group Share endpoints */
+    getWebsiteShares = Share.get_WEBSITEID_Shares;
+    /** @group Share endpoints */
+    createWebsiteShare = Share.post_WEBSITEID_Shares;
     // TEAMS
     /** @group Teams endpoints */
     getTeams = Teams.get;

package/dist/namespaces/Links.d.ts

@@ -1,4 +1,4 @@
-import { API, DeletionResult, GenericRequestParameters, Users } from "../index.js";
+import { API, DeletionResult, GenericRequestParameters, Teams, Users } from "../index.js";
 /** Operations around Links management: https://umami.is/docs/api/links */
 export declare namespace Links {
     interface Link {
@@ -14,6 +14,17 @@ export declare namespace Links {
     }
     /** Returns all user links: https://umami.is/docs/api/links#get-apilinks */
     function get(this: API, parameters?: GenericRequestParameters): Promise<Link[]>;
+    /** Creates a link: https://docs.umami.is/docs/api/links#post-apilinks */
+    function post(this: API, parameters: {
+        /** The link's name */
+        name: Link["name"];
+        /** The link's destination URL */
+        url: Link["url"];
+        /** The link's URL slug, **with a minimum of 8 characters** */
+        slug: Link["slug"];
+        /** The ID of the team the link will be created under */
+        teamId?: Teams.Team["id"];
+    }): Promise<Link>;
     /** 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 */

package/dist/namespaces/Links.js

@@ -7,6 +7,11 @@ export var Links;
         return response.data;
     }
     Links.get = get;
+    /** Creates a link: https://docs.umami.is/docs/api/links#post-apilinks */
+    async function post(parameters) {
+        return await this.request("post", ["links"], parameters);
+    }
+    Links.post = post;
     /** 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]);

package/dist/namespaces/Pixels.d.ts

@@ -1,4 +1,4 @@
-import { API, DeletionResult, GenericRequestParameters, Users } from "../index.js";
+import { API, DeletionResult, GenericRequestParameters, Teams, Users } from "../index.js";
 /** Operations around Pixels management: https://umami.is/docs/api/pixels */
 export declare namespace Pixels {
     interface Pixel {
@@ -13,6 +13,15 @@ export declare namespace Pixels {
     }
     /** Returns all user pixels: https://umami.is/docs/api/pixels#get-apipixels */
     function get(this: API, parameters?: GenericRequestParameters): Promise<Pixel[]>;
+    /** Creates a pixel: https://docs.umami.is/docs/api/pixels#post-apipixels */
+    function post(this: API, parameters: {
+        /** The pixel's name */
+        name: Pixel["name"];
+        /** The pixel's URL slug, **with a minimum of 8 characters** */
+        slug: Pixel["slug"];
+        /** The ID of the team the pixel will be created under */
+        teamId?: Teams.Team["id"];
+    }): Promise<Pixel>;
     /** 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 */

package/dist/namespaces/Pixels.js

@@ -7,6 +7,11 @@ export var Pixels;
         return response.data;
     }
     Pixels.get = get;
+    /** Creates a pixel: https://docs.umami.is/docs/api/pixels#post-apipixels */
+    async function post(parameters) {
+        return await this.request("post", ["pixels"], parameters);
+    }
+    Pixels.post = post;
     /** 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]);

package/dist/namespaces/Share.d.ts

@@ -0,0 +1,70 @@
+import { API, DeletionResult, Websites } from "../index.js";
+/** Operations around Share page management: https://docs.umami.is/docs/api/share */
+export declare namespace Share {
+    enum ShareType {
+        website = 1,
+        link = 2,
+        pixel = 3,
+        board = 4
+    }
+    interface Share {
+        id: string;
+        entityId: string;
+        name: string;
+        shareType: ShareType;
+        slug: string;
+        parameters: Parameters;
+        createdAt: Date;
+        updatedAt: Date;
+    }
+    interface Parameters {
+        overview?: boolean;
+        events?: boolean;
+        sessions?: boolean;
+        realtime?: boolean;
+        performance?: boolean;
+        compare?: boolean;
+        breakdown?: boolean;
+        goals?: boolean;
+        funnels?: boolean;
+        journeys?: boolean;
+        retention?: boolean;
+        utm?: boolean;
+        revenue?: boolean;
+        attribution?: boolean;
+    }
+    /** Creates a share page: https://docs.umami.is/docs/api/share#post-apishare */
+    function post(this: API, parameters: {
+        /** ID of entity to be added (websiteId, pixelId, linkId, etc.) */
+        entityId: Share["entityId"];
+        shareType: ShareType;
+        /** Name of the share page */
+        name: Share["name"];
+        /** Slug of the share page */
+        slug: Share["slug"];
+        /** Parameters for share page */
+        parameters: Parameters;
+    }): Promise<Share>;
+    /** Gets a share page by ID: https://docs.umami.is/docs/api/share#get-apishareidshareid */
+    function get_SHAREID(this: API, share_id: Share["id"]): Promise<Share>;
+    /** Updates a share page: https://docs.umami.is/docs/api/share#post-apishareidshareid */
+    function post_SHAREID(this: API, share_id: Share["id"], parameters: {
+        /** Name of the share page */
+        name: Share["name"];
+        /** Slug of the share page */
+        slug: Share["slug"];
+        /** Parameters for share page */
+        parameters: Parameters;
+    }): Promise<Share>;
+    /** Deletes a share page: https://docs.umami.is/docs/api/share#delete-apishareidshareid */
+    function delete_SHAREID(this: API, share_id: Share["id"]): Promise<DeletionResult>;
+    /** Gets all share pages that belong to a website: https://docs.umami.is/docs/api/share#get-apiwebsiteswebsiteidshares */
+    function get_WEBSITEID_Shares(this: API, website_id: Websites.Website["id"]): Promise<Share[]>;
+    /** Creates a share page belonging to a website: https://docs.umami.is/docs/api/share#post-apiwebsiteswebsiteidshares */
+    function post_WEBSITEID_Shares(this: API, website_id: Websites.Website["id"], parameters: {
+        /** Name of the share page */
+        name: Share["name"];
+        /** Parameters for share page */
+        parameters: Parameters;
+    }): Promise<Share>;
+}

package/dist/namespaces/Share.js

@@ -0,0 +1,46 @@
+/** Operations around Share page management: https://docs.umami.is/docs/api/share */
+export var Share;
+(function (Share) {
+    let ShareType;
+    (function (ShareType) {
+        ShareType[ShareType["website"] = 1] = "website";
+        ShareType[ShareType["link"] = 2] = "link";
+        ShareType[ShareType["pixel"] = 3] = "pixel";
+        ShareType[ShareType["board"] = 4] = "board";
+    })(ShareType = Share.ShareType || (Share.ShareType = {}));
+    /** Creates a share page: https://docs.umami.is/docs/api/share#post-apishare */
+    async function post(parameters) {
+        return await this.request("post", ["share"], parameters);
+    }
+    Share.post = post;
+    /** Gets a share page by ID: https://docs.umami.is/docs/api/share#get-apishareidshareid */
+    async function get_SHAREID(share_id) {
+        return await this.request("get", ["share", "id", share_id]);
+    }
+    Share.get_SHAREID = get_SHAREID;
+    /** Updates a share page: https://docs.umami.is/docs/api/share#post-apishareidshareid */
+    async function post_SHAREID(share_id, parameters) {
+        return await this.request("post", ["share", "id", share_id], parameters);
+    }
+    Share.post_SHAREID = post_SHAREID;
+    /** Deletes a share page: https://docs.umami.is/docs/api/share#delete-apishareidshareid */
+    async function delete_SHAREID(share_id) {
+        return await this.request("delete", ["share", "id", share_id]);
+    }
+    Share.delete_SHAREID = delete_SHAREID;
+    /** Gets all share pages that belong to a website: https://docs.umami.is/docs/api/share#get-apiwebsiteswebsiteidshares */
+    async function get_WEBSITEID_Shares(website_id) {
+        const response = await this.request("get", [
+            "websites",
+            website_id,
+            "shares",
+        ]);
+        return response.data;
+    }
+    Share.get_WEBSITEID_Shares = get_WEBSITEID_Shares;
+    /** Creates a share page belonging to a website: https://docs.umami.is/docs/api/share#post-apiwebsiteswebsiteidshares */
+    async function post_WEBSITEID_Shares(website_id, parameters) {
+        return await this.request("post", ["websites", website_id, "shares"], parameters);
+    }
+    Share.post_WEBSITEID_Shares = post_WEBSITEID_Shares;
+})(Share || (Share = {}));

package/dist/namespaces/Teams.d.ts

@@ -1,11 +1,13 @@
 import { API, DeletionResult, GenericRequestParameters, Users, Websites } from "../index.js";
 /** Operations around Team management: https://umami.is/docs/api/teams */
 export declare namespace Teams {
-    interface Team {
+    interface MinimalTeam {
         id: string;
         name: string;
-        accessCode: string;
         logoUrl: string | null;
+    }
+    interface Team extends MinimalTeam {
+        accessCode: string;
         createdAt: Date;
         updatedAt: Date;
         deletedAt: Date | null;

package/dist/namespaces/Users.d.ts

@@ -9,15 +9,16 @@ export declare namespace Users {
     interface MinimalUserWithRole extends MinimalUser {
         role: Role;
     }
-    interface MinimalUserWithCreatedAt extends MinimalUserWithRole {
+    interface MinimalUserWithRoleCreatedAt extends MinimalUserWithRole {
         createdAt: Date;
     }
-    interface MinimalUserWithRoleCreatedAt extends MinimalUserWithRole, MinimalUserWithCreatedAt {
-    }
     interface User extends MinimalUserWithRoleCreatedAt {
         isAdmin: boolean;
     }
-    interface DetailedUser extends MinimalUserWithRole, MinimalUserWithCreatedAt {
+    interface UserWithTeams extends User {
+        teams: Teams.MinimalTeam[];
+    }
+    interface DetailedUser extends MinimalUserWithRoleCreatedAt {
         logoUrl: string | null;
         displayName: string | null;
         updatedAt: Date;

package/dist/namespaces/Websites.d.ts

@@ -1,11 +1,11 @@
-import { API, DeletionResult, GenericRequestParameters, Teams, Users } from "../index.js";
+import { API, DeletionResult, GenericRequestParameters, Share, Teams, Users } from "../index.js";
 /** Operations around Website management and statistics: https://umami.is/docs/api/websites */
 export declare namespace Websites {
     interface Website {
         id: string;
         name: string;
         domain: string;
-        shareId: string | null;
+        shareId: Share.Share["id"] | null;
         resetAt: Date | null;
         /** @remarks Is null if the website is under a team (has a `teamId`) */
         userId: Users.User["id"] | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umami-api-js",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Package to easily access the Umami api!",
   "type": "module",
   "main": "dist/index.js",
@@ -31,13 +31,13 @@
   "license": "Unlicense",
   "devDependencies": {
     "@types/chai": "^5.2.3",
-    "@types/node": "^24.9.2",
-    "ajv": "^8.18.0",
+    "@types/node": "^25.6.0",
+    "ajv": "^8.20.0",
     "chai": "^6.2.2",
-    "dotenv": "^17.2.3",
-    "prettier": "3.8.1",
-    "ts-json-schema-generator": "^2.4.0",
-    "typedoc": "^0.28.17",
-    "typescript": "^5.9.3"
+    "dotenv": "^17.4.2",
+    "prettier": "3.8.3",
+    "ts-json-schema-generator": "^2.9.0",
+    "typedoc": "^0.28.19",
+    "typescript": "^6.0.3"
   }
 }