umami-api-js 0.0.2 → 0.0.3

package/.forgejo/workflows/release.yaml

@@ -0,0 +1,33 @@
+on:
+  release:
+    types: [published]
+
+jobs:
+  docs:
+    runs-on: codeberg-tiny-lazy
+    steps:
+      - name: Checkout this very app
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        run: npm install
+      - name: Generate documentation through the command defined in package.json
+        run: npm run docs
+      - name: Move the docs up and get rid of the rest (this preserves files that start with a dot)
+        run: |
+          mv docs/ ..
+          rm -rf *
+          mv ../docs/* .
+      - name: Add the .domains file
+        run: echo "umami-api-js.taevas.xyz" > .domains
+      - name: Configure our git client
+        run: |
+          git config user.name "forgejo-actions[bot]"
+          git config user.email "code@taevas.xyz"
+      - name: Create or switch to the "pages" branch
+        run: git switch -C pages
+      - name: Add and commit the changes
+        run: |
+          git add .
+          git commit -m "Automatically generated documentation"
+      - name: Send the changes to Codeberg, let Codeberg Pages do its magic~
+        run: git push

package/dist/index.d.ts

@@ -1,9 +1,11 @@
 import { Admin } from "./namespaces/Admin.js";
 import { Events } from "./namespaces/Events.js";
 import { Realtime } from "./namespaces/Realtime.js";
+import { Sessions } from "./namespaces/Sessions.js";
 import { Teams } from "./namespaces/Teams.js";
 import { Users } from "./namespaces/Users.js";
-export { Admin, Users, Teams, Events, Realtime };
+import { Websites } from "./namespaces/Websites.js";
+export { Admin, Users, Teams, Events, Sessions, Websites, Realtime };
 export interface ValueAndPrev {
     /** The actual value for the given time period */
     value: number;
@@ -24,6 +26,46 @@ export interface GenericRequestParameters {
     /** Determines how many results to return **(default: 20)** */
     pageSize?: number;
 }
+export interface Timestamps {
+    /** Timestamp of starting date */
+    startAt: Date | number;
+    /** Timestamp of end date */
+    endAt: Date | number;
+}
+/**
+ * Many endpoints can make use of the filters in this interface
+ * @remarks As defined in the server documentation for the Endpoints in: Events, Sessions, Website stats
+ */
+export interface Filters {
+    /** Name of URL */
+    path?: string;
+    /** Name of referrer */
+    referrer?: string;
+    /** Name of page title */
+    title?: string;
+    /** Name of query parameter */
+    query?: string;
+    /** Name of browser */
+    browser?: string;
+    /** Name of operating system */
+    os?: string;
+    /** Name of device (ex. Mobile) */
+    device?: string;
+    /** Name of country */
+    country?: string;
+    /** Name of region/state/province */
+    region?: string;
+    /** Name of city */
+    city?: string;
+    /** Name of hostname */
+    hostname?: string;
+    /** Name of tag */
+    tag?: string;
+    /** UUID of segment */
+    segment?: string;
+    /** 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}! */
@@ -186,7 +228,6 @@ export declare class API {
      * @param method The type of request, each endpoint uses a specific one (if it uses multiple, the intent and parameters become different)
      * @param endpoint What comes in the URL after `api/`, **DO NOT USE TEMPLATE LITERALS (\`) OR THE ADDITION OPERATOR (+), put everything separately for type safety**
      * @param parameters The things to specify in the request, such as the beatmap_id when looking for a beatmap
-     * @param settings Additional settings **to add** to the current settings of the `fetch()` request
      * @returns A Promise with the API's response
      */
     request(method: "get" | "post" | "put" | "delete", endpoint: Array<string | number>, parameters?: {
@@ -227,5 +268,19 @@ export declare class API {
     readonly getWebsiteEventsDataProperties: typeof Events.getWebsiteEventsDataProperties;
     readonly getWebsiteEventsDataValues: typeof Events.getWebsiteEventsDataValues;
     readonly getWebsiteEventsDataStats: typeof Events.getWebsiteEventsDataStats;
+    readonly getWebsiteSessions: typeof Sessions.getWebsiteSessions;
+    readonly getWebsiteSessionsStats: typeof Sessions.getWebsiteSessionsStats;
+    readonly getWebsiteSessionsWeekly: typeof Sessions.getWebsiteSessionsWeekly;
+    readonly getWebsiteSession: typeof Sessions.getWebsiteSession;
+    readonly getWebsiteSessionActivity: typeof Sessions.getWebsiteSessionActivity;
+    readonly getWebsiteSessionProperties: typeof Sessions.getWebsiteSessionProperties;
+    readonly getWebsiteSessionDataProperties: typeof Sessions.getWebsiteSessionDataProperties;
+    readonly getWebsiteSessionDataValues: typeof Sessions.getWebsiteSessionDataValues;
+    readonly getWebsites: typeof Websites.getWebsites;
+    readonly createWebsite: typeof Websites.createWebsite;
+    readonly getWebsite: typeof Websites.getWebsite;
+    readonly updateWebsite: typeof Websites.updateWebsite;
+    readonly deleteWebsite: typeof Websites.deleteWebsite;
+    readonly resetWebsite: typeof Websites.resetWebsite;
     readonly getRealtime: typeof Realtime.getRealtime;
 }

package/dist/index.js

@@ -1,10 +1,12 @@
 import { Admin } from "./namespaces/Admin.js";
 import { Events } from "./namespaces/Events.js";
 import { Realtime } from "./namespaces/Realtime.js";
+import { Sessions } from "./namespaces/Sessions.js";
 import { Teams } from "./namespaces/Teams.js";
 import { Users } from "./namespaces/Users.js";
+import { Websites } from "./namespaces/Websites.js";
 import { adaptParametersForGETRequests, correctType } from "./utilities.js";
-export { Admin, Users, Teams, Events, Realtime };
+export { Admin, Users, Teams, Events, Sessions, Websites, Realtime };
 /** If the {@link API} throws an error, it should always be an {@link APIError}! */
 export class APIError extends Error {
     message;
@@ -265,6 +267,9 @@ export class API {
         let error_message = "no error message available";
         if (!is_token_related)
             await this.token_promise.catch(() => this.token_promise = new Promise(r => r));
+        for (const [p, v] of Object.entries(parameters)) {
+            parameters[p] = v instanceof Date ? Number(v) : v; // Convert Dates to ms
+        }
         let url = `${this.server}`;
         if (url.slice(-1) !== "/")
             url += "/";
@@ -346,7 +351,6 @@ export class API {
      * @param method The type of request, each endpoint uses a specific one (if it uses multiple, the intent and parameters become different)
      * @param endpoint What comes in the URL after `api/`, **DO NOT USE TEMPLATE LITERALS (\`) OR THE ADDITION OPERATOR (+), put everything separately for type safety**
      * @param parameters The things to specify in the request, such as the beatmap_id when looking for a beatmap
-     * @param settings Additional settings **to add** to the current settings of the `fetch()` request
      * @returns A Promise with the API's response
      */
     async request(method, endpoint, parameters = {}) {
@@ -373,7 +377,7 @@ export class API {
         }
     }
     async getWebsiteStats(website_id, startAt, endAt) {
-        return await this.request("get", ["websites", website_id, "stats"], { startAt: Number(startAt), endAt: Number(endAt) });
+        return await this.request("get", ["websites", website_id, "stats"], { startAt, endAt });
     }
     // ADMIN
     getUsersAsAdmin = Admin.getUsers;
@@ -407,6 +411,22 @@ export class API {
     getWebsiteEventsDataProperties = Events.getWebsiteEventsDataProperties;
     getWebsiteEventsDataValues = Events.getWebsiteEventsDataValues;
     getWebsiteEventsDataStats = Events.getWebsiteEventsDataStats;
+    // SESSIONS
+    getWebsiteSessions = Sessions.getWebsiteSessions;
+    getWebsiteSessionsStats = Sessions.getWebsiteSessionsStats;
+    getWebsiteSessionsWeekly = Sessions.getWebsiteSessionsWeekly;
+    getWebsiteSession = Sessions.getWebsiteSession;
+    getWebsiteSessionActivity = Sessions.getWebsiteSessionActivity;
+    getWebsiteSessionProperties = Sessions.getWebsiteSessionProperties;
+    getWebsiteSessionDataProperties = Sessions.getWebsiteSessionDataProperties;
+    getWebsiteSessionDataValues = Sessions.getWebsiteSessionDataValues;
+    // WEBSITES
+    getWebsites = Websites.getWebsites;
+    createWebsite = Websites.createWebsite;
+    getWebsite = Websites.getWebsite;
+    updateWebsite = Websites.updateWebsite;
+    deleteWebsite = Websites.deleteWebsite;
+    resetWebsite = Websites.resetWebsite;
     // REALTIME
     getRealtime = Realtime.getRealtime;
 }

package/dist/namespaces/Events.d.ts

@@ -1,45 +1,8 @@
-import { API, GenericRequestParameters } from "../index.js";
+import { API, Filters, GenericRequestParameters, Timestamps } from "../index.js";
 /** For endpoints listed on: https://umami.is/docs/api/events-api */
 export declare namespace Events {
-    interface Timestamps {
-        /** Timestamp of starting date */
-        startAt: Date | number;
-        /** Timestamp of end date */
-        endAt: Date | number;
-    }
-    /** Many endpoints can make use of the filters in this interface: https://umami.is/docs/api/events-api#filters */
-    interface FiltersAndTimestamps extends Timestamps {
-        /** Name of URL */
-        path?: string;
-        /** Name of referrer */
-        referrer?: string;
-        /** Name of page title */
-        title?: string;
-        /** Name of query parameter */
-        query?: string;
-        /** Name of browser */
-        browser?: string;
-        /** Name of operating system */
-        os?: string;
-        /** Name of device (ex. Mobile) */
-        device?: string;
-        /** Name of country */
-        country?: string;
-        /** Name of region/state/province */
-        region?: string;
-        /** Name of city */
-        city?: string;
-        /** Name of hostname */
-        hostname?: string;
-        /** Name of tag */
-        tag?: string;
-        /** UUID of segment */
-        segment?: string;
-        /** UUID of cohort */
-        cohort?: string;
-    }
     /** Gets website event details within a given time range: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevents (TODO UNTESTED) */
-    function getWebsiteEvents(this: API, websiteId: string, parameters: FiltersAndTimestamps & GenericRequestParameters): Promise<{
+    function getWebsiteEvents(this: API, websiteId: string, parameters: Filters & Timestamps & GenericRequestParameters): Promise<{
         id: string;
         websiteId: string;
         sessionId: string;
@@ -75,7 +38,7 @@ export declare namespace Events {
         createdAt: Date;
     }[]>;
     /** Gets event data names, properties, and counts: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataevents (TODO UNTESTED) */
-    function getWebsiteEventsData(this: API, websiteId: string, parameters: FiltersAndTimestamps & {
+    function getWebsiteEventsData(this: API, websiteId: string, parameters: Filters & Timestamps & {
         /** Event name filter */
         event?: string;
     }): Promise<{
@@ -85,20 +48,20 @@ export declare namespace Events {
         total: number;
     }[]>;
     /** Gets event data property and value counts within a given time range: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datafields (TODO UNTESTED) */
-    function getWebsiteEventsDataFields(this: API, websiteId: string, parameters: FiltersAndTimestamps): Promise<{
+    function getWebsiteEventsDataFields(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
         propertyName: string;
         dataType: number;
         value: string;
         total: number;
     }[]>;
     /** Gets event name and property counts for a website: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataproperties (TODO UNTESTED) */
-    function getWebsiteEventsDataProperties(this: API, websiteId: string, parameters: FiltersAndTimestamps): Promise<{
+    function getWebsiteEventsDataProperties(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
         eventName: string;
         propertyName: string;
         total: number;
     }[]>;
     /** Gets event data counts for a given event and property: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datavalues (TODO UNTESTED) */
-    function getWebsiteEventsDataValues(this: API, websiteId: string, parameters: FiltersAndTimestamps & {
+    function getWebsiteEventsDataValues(this: API, websiteId: string, parameters: Filters & Timestamps & {
         /** Event name filter */
         event: string;
         /** Property name */
@@ -108,7 +71,7 @@ export declare namespace Events {
         total: number;
     }>;
     /** Gets aggregated website events, properties, and records within a given time range https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datastats (TODO UNTESTED) */
-    function getWebsiteEventsDataStats(this: API, websiteId: string, parameters: FiltersAndTimestamps): Promise<{
+    function getWebsiteEventsDataStats(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
         events: number;
         properties: number;
         records: number;

package/dist/namespaces/Events.js

@@ -3,10 +3,6 @@ export var Events;
 (function (Events) {
     /** Gets website event details within a given time range: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevents (TODO UNTESTED) */
     async function getWebsiteEvents(websiteId, parameters) {
-        if (parameters.startAt instanceof Date)
-            parameters.startAt = Number(parameters.startAt);
-        if (parameters.endAt instanceof Date)
-            parameters.endAt = Number(parameters.endAt);
         const response = await this.request("get", ["websites", websiteId, "events"], parameters);
         return response.data;
     }

package/dist/namespaces/Sessions.d.ts

@@ -0,0 +1,93 @@
+import { API, Filters, GenericRequestParameters, Timestamps } from "../index.js";
+/** For endpoints listed on: https://umami.is/docs/api/sessions-api */
+export declare namespace Sessions {
+    interface GenericSession {
+        id: string;
+        websiteId: string;
+        browser: string;
+        os: string;
+        device: string;
+        screen: string;
+        language: string;
+        country: string;
+        region: string;
+        city: string;
+        firstAt: Date;
+        lastAt: Date;
+        visits: number;
+        views: number;
+    }
+    /** Gets website session details within a given time range: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessions (TODO UNTESTED) */
+    function getWebsiteSessions(this: API, websiteId: string, parameters: Filters & Timestamps & GenericRequestParameters): Promise<(GenericSession & {
+        hostname: string;
+        createdAt: Date;
+    })[]>;
+    /** Gets summarized website session statistics: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionsstats (TODO UNTESTED) */
+    function getWebsiteSessionsStats(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
+        /** Pages hits */
+        pageviews: {
+            value: number;
+        };
+        /** Number of unique visitors */
+        visitors: {
+            value: number;
+        };
+        /** Number of unique visits */
+        visits: {
+            value: number;
+        };
+        /** Number of visitors who only visit a single page */
+        bounces: {
+            value: number;
+        };
+        /** Time spent on the website */
+        totaltime: {
+            value: number;
+        };
+    }>;
+    /** Get collected count of sessions by hour of weekday: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionsweekly (TODO UNTESTED) */
+    function getWebsiteSessionsWeekly(this: API, websiteId: string, parameters: Filters & Timestamps & {
+        timezone: string;
+    }): Promise<number[][]>;
+    /** Gets session details for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionid (TODO UNTESTED) */
+    function getWebsiteSession(this: API, websiteId: string, sessionId: string): Promise<GenericSession & {
+        distinctId: string;
+        events: number;
+        totaltime: number;
+    }>;
+    /** Gets session activity for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionidactivity (TODO UNTESTED) */
+    function getWebsiteSessionActivity(this: API, websiteId: string, sessionId: string, parameters: Timestamps): Promise<{
+        createdAt: Date;
+        urlPath: string;
+        urlQuery: string;
+        referrerDomain: string;
+        eventId: string;
+        eventType: number;
+        eventName: string;
+        visitId: string;
+        hasData: number;
+    }[]>;
+    /** Gets session properties for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionidproperties (TODO UNTESTED) */
+    function getWebsiteSessionProperties(this: API, websiteId: string, sessionId: string): Promise<{
+        websiteId: string;
+        sessionid: string;
+        dataKey: string;
+        dataType: number;
+        stringValue: string;
+        numberValue: number | null;
+        dateValue: Date | null;
+        createdAt: Date;
+    }[]>;
+    /** Gets session data counts by property name: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsession-dataproperties (TODO UNTESTED) */
+    function getWebsiteSessionDataProperties(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
+        propertyName: string;
+        total: number;
+    }[]>;
+    /** Gets session data counts for a given property: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsession-datavalues (TODO UNTESTED) */
+    function getWebsiteSessionDataValues(this: API, websiteId: string, parameters: Filters & Timestamps & {
+        propertyName: string;
+    }): Promise<{
+        value: string;
+        total: number;
+    }[]>;
+}

package/dist/namespaces/Sessions.js

@@ -0,0 +1,45 @@
+/** For endpoints listed on: https://umami.is/docs/api/sessions-api */
+export var Sessions;
+(function (Sessions) {
+    /** Gets website session details within a given time range: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessions (TODO UNTESTED) */
+    async function getWebsiteSessions(websiteId, parameters) {
+        const response = await this.request("get", ["websites", websiteId, "sessions"], parameters);
+        return response.data;
+    }
+    Sessions.getWebsiteSessions = getWebsiteSessions;
+    /** Gets summarized website session statistics: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionsstats (TODO UNTESTED) */
+    async function getWebsiteSessionsStats(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "sessions"], parameters);
+    }
+    Sessions.getWebsiteSessionsStats = getWebsiteSessionsStats;
+    /** Get collected count of sessions by hour of weekday: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionsweekly (TODO UNTESTED) */
+    async function getWebsiteSessionsWeekly(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "sessions", "weekly"], parameters);
+    }
+    Sessions.getWebsiteSessionsWeekly = getWebsiteSessionsWeekly;
+    /** Gets session details for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionid (TODO UNTESTED) */
+    async function getWebsiteSession(websiteId, sessionId) {
+        return await this.request("get", ["websites", websiteId, "sessions", sessionId]);
+    }
+    Sessions.getWebsiteSession = getWebsiteSession;
+    /** Gets session activity for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionidactivity (TODO UNTESTED) */
+    async function getWebsiteSessionActivity(websiteId, sessionId, parameters) {
+        return await this.request("get", ["websites", websiteId, "sessions", sessionId, "activity"], parameters);
+    }
+    Sessions.getWebsiteSessionActivity = getWebsiteSessionActivity;
+    /** Gets session properties for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionidproperties (TODO UNTESTED) */
+    async function getWebsiteSessionProperties(websiteId, sessionId) {
+        return await this.request("get", ["websites", websiteId, "sessions", sessionId, "activity", "properties"]);
+    }
+    Sessions.getWebsiteSessionProperties = getWebsiteSessionProperties;
+    /** Gets session data counts by property name: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsession-dataproperties (TODO UNTESTED) */
+    async function getWebsiteSessionDataProperties(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "session-data", "properties"], parameters);
+    }
+    Sessions.getWebsiteSessionDataProperties = getWebsiteSessionDataProperties;
+    /** Gets session data counts for a given property: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsession-datavalues (TODO UNTESTED) */
+    async function getWebsiteSessionDataValues(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "session-data", "values"], parameters);
+    }
+    Sessions.getWebsiteSessionDataValues = getWebsiteSessionDataValues;
+})(Sessions || (Sessions = {}));

package/dist/namespaces/Websites.d.ts

@@ -0,0 +1,40 @@
+import { API, GenericRequestParameters } from "../index.js";
+/** For endpoints listed on: https://umami.is/docs/api/websites-api */
+export declare namespace Websites {
+    /** Returns all user websites: https://umami.is/docs/api/websites-api#get-apiwebsites (TODO UNTESTED) */
+    function getWebsites(this: API, parameters: GenericRequestParameters & {
+        includeTeams: boolean;
+    }): Promise<any[]>;
+    /** Creates a website: https://umami.is/docs/api/websites-api#post-apiwebsites (TODO UNTESTED) */
+    function createWebsite(this: API, parameters: {
+        /** The name of the website in Umami */
+        name: string;
+        /** The full domain of the tracked website */
+        domain: string;
+        /** A unique string to enable a share url. Set `null` to unshare */
+        shareId?: string | null;
+        /** The ID of the team the website will be created under */
+        teamId?: string;
+        /** Force a UUID assignment to the website */
+        id?: string;
+    }): Promise<any>;
+    /** Gets a website by ID: https://umami.is/docs/api/websites-api#get-apiwebsiteswebsiteid (TODO UNTESTED) */
+    function getWebsite(this: API, websiteId: string): Promise<any>;
+    /** Updates a website: https://umami.is/docs/api/websites-api#post-apiwebsiteswebsiteid (TODO UNTESTED) */
+    function updateWebsite(this: API, websiteId: string, parameters: {
+        /** The name of the website in Umami */
+        name: string;
+        /** The full domain of the tracked website */
+        domain: string;
+        /** A unique string to enable a share url. Set `null` to unshare */
+        shareId?: string | null;
+    }): Promise<any>;
+    /** Deletes a website: https://umami.is/docs/api/websites-api#delete-apiwebsiteswebsiteid (TODO UNTESTED) */
+    function deleteWebsite(this: API, websiteId: string): Promise<{
+        ok: boolean;
+    }>;
+    /** Resets a website by removing all data related to the website: https://umami.is/docs/api/websites-api#post-apiwebsiteswebsiteidreset (TODO UNTESTED) */
+    function resetWebsite(this: API, websiteId: string): Promise<{
+        ok: boolean;
+    }>;
+}

package/dist/namespaces/Websites.js

@@ -0,0 +1,35 @@
+/** For endpoints listed on: https://umami.is/docs/api/websites-api */
+export var Websites;
+(function (Websites) {
+    /** Returns all user websites: https://umami.is/docs/api/websites-api#get-apiwebsites (TODO UNTESTED) */
+    async function getWebsites(parameters) {
+        const response = await this.request("get", ["websites"], parameters);
+        return response.data;
+    }
+    Websites.getWebsites = getWebsites;
+    /** Creates a website: https://umami.is/docs/api/websites-api#post-apiwebsites (TODO UNTESTED) */
+    async function createWebsite(parameters) {
+        return await this.request("post", ["websites"], parameters);
+    }
+    Websites.createWebsite = createWebsite;
+    /** Gets a website by ID: https://umami.is/docs/api/websites-api#get-apiwebsiteswebsiteid (TODO UNTESTED) */
+    async function getWebsite(websiteId) {
+        return await this.request("get", ["websites", websiteId]);
+    }
+    Websites.getWebsite = getWebsite;
+    /** Updates a website: https://umami.is/docs/api/websites-api#post-apiwebsiteswebsiteid (TODO UNTESTED) */
+    async function updateWebsite(websiteId, parameters) {
+        return await this.request("post", ["websites", websiteId], parameters);
+    }
+    Websites.updateWebsite = updateWebsite;
+    /** Deletes a website: https://umami.is/docs/api/websites-api#delete-apiwebsiteswebsiteid (TODO UNTESTED) */
+    async function deleteWebsite(websiteId) {
+        return await this.request("delete", ["websites", websiteId]);
+    }
+    Websites.deleteWebsite = deleteWebsite;
+    /** Resets a website by removing all data related to the website: https://umami.is/docs/api/websites-api#post-apiwebsiteswebsiteidreset (TODO UNTESTED) */
+    async function resetWebsite(websiteId) {
+        return await this.request("post", ["websites", websiteId, "reset"]);
+    }
+    Websites.resetWebsite = resetWebsite;
+})(Websites || (Websites = {}));

package/dist/utilities.js

@@ -58,7 +58,7 @@ export function correctType(x, force_string) {
         const unconvertables = ["value"];
         const unconvertables_substrings = ["string", "name"]; // or if the key contains any of those substrings
         for (let i = 0; i < keys.length; i++) {
-            x[keys[i]] = correctType(vals[i], unconvertables.some((u) => keys[i] === u) ?? unconvertables_substrings.some((s) => keys[i].toLowerCase().includes(s)));
+            x[keys[i]] = correctType(vals[i], unconvertables.some((u) => keys[i] === u) || unconvertables_substrings.some((s) => keys[i].toLowerCase().includes(s)));
         }
         return x;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umami-api-js",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Package to easily access the umami api!",
   "type": "module",
   "main": "dist/index.js",
@@ -8,7 +8,8 @@
   "scripts": {
     "prepublish": "npm run build",
     "build": "tsc",
-    "test": "npm run build && node ./dist/test.js"
+    "test": "npm run build && node ./dist/test.js",
+    "docs": "npx typedoc lib/index.ts"
   },
   "engines": {
     "node": ">=20.0.0"
@@ -27,9 +28,9 @@
   ],
   "license": "Unlicense",
   "devDependencies": {
-    "@types/chai": "^5.2.2",
     "@types/node": "^24.3.1",
     "dotenv": "^17.2.2",
+    "typedoc": "^0.28.14",
     "typescript": "^5.9.2"
   }
 }