umami-api-js 0.0.1 → 0.0.2

package/README.md

@@ -1,5 +1,5 @@
-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 v2.19.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).
 
-Please note that this package expects self-hosted instances of Umami, it is not built to work with Umami Cloud
+Please note that this package is not expected to work with Umami Cloud, the instance of Umami hosted by its creators.
 
-Please also note that this is currently being built mainly to serve as a component to my [taevas.xyz](https://codeberg.org/Taevas/taevas.xyz) project
+Please also note that this is currently being built mainly to serve as a component to my [taevas.xyz](https://codeberg.org/Taevas/taevas.xyz) project, meaning it currently doesn't perfectly cover the API!

package/dist/index.d.ts

@@ -1,9 +1,31 @@
+import { Admin } from "./namespaces/Admin.js";
+import { Events } from "./namespaces/Events.js";
+import { Realtime } from "./namespaces/Realtime.js";
+import { Teams } from "./namespaces/Teams.js";
+import { Users } from "./namespaces/Users.js";
+export { Admin, Users, Teams, Events, Realtime };
 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 GenericObject {
+    id: string;
+    createdAt: Date;
+    updatedAt: Date | null;
+    deletedAt: Date | null;
+}
+export interface GenericRequestParameters {
+    /** Search text */
+    search?: string;
+    /** Determines page **(default: 1)** */
+    page?: number;
+    /** Determines how many results to return **(default: 20)** */
+    pageSize?: number;
+}
+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 {
     message: string;
@@ -160,7 +182,7 @@ export declare class API {
      */
     private fetch;
     /**
-     * The function that directly communicates with the API! Almost every functions of the API object uses this function!
+     * The function that directly communicates with the API! Almost all functions of the API object uses this function!
      * @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
@@ -177,4 +199,33 @@ export declare class API {
         bounces: ValueAndPrev;
         totaltime: ValueAndPrev;
     }>;
+    readonly getUsersAsAdmin: typeof Admin.getUsers;
+    readonly getWebsitesAsAdmin: typeof Admin.getWebsites;
+    readonly getTeamsAsAdmin: typeof Admin.getTeams;
+    readonly createUser: typeof Users.createUser;
+    readonly getUser: typeof Users.getUser;
+    readonly updateUser: typeof Users.updateUser;
+    readonly deleteUser: typeof Users.deleteUser;
+    readonly getUserTeams: typeof Users.getUserTeams;
+    readonly getUserWebsites: typeof Users.getUserWebsites;
+    readonly getTeams: typeof Teams.getTeams;
+    readonly createTeam: typeof Teams.createTeam;
+    readonly joinTeam: typeof Teams.joinTeam;
+    readonly getTeam: typeof Teams.getTeam;
+    readonly updateTeam: typeof Teams.updateTeam;
+    readonly deleteTeam: typeof Teams.deleteTeam;
+    readonly getTeamUsers: typeof Teams.getTeamUsers;
+    readonly addTeamUser: typeof Teams.addTeamUser;
+    readonly getTeamUser: typeof Teams.getTeamUser;
+    readonly updateTeamUser: typeof Teams.updateTeamUser;
+    readonly removeTeamUser: typeof Teams.removeTeamUser;
+    readonly getTeamWebsites: typeof Teams.getTeamWebsites;
+    readonly getWebsiteEvents: typeof Events.getWebsiteEvents;
+    readonly getWebsiteEventData: typeof Events.getWebsiteEventData;
+    readonly getWebsiteEventsData: typeof Events.getWebsiteEventsData;
+    readonly getWebsiteEventsDataFields: typeof Events.getWebsiteEventsDataFields;
+    readonly getWebsiteEventsDataProperties: typeof Events.getWebsiteEventsDataProperties;
+    readonly getWebsiteEventsDataValues: typeof Events.getWebsiteEventsDataValues;
+    readonly getWebsiteEventsDataStats: typeof Events.getWebsiteEventsDataStats;
+    readonly getRealtime: typeof Realtime.getRealtime;
 }

package/dist/index.js

@@ -1,4 +1,10 @@
+import { Admin } from "./namespaces/Admin.js";
+import { Events } from "./namespaces/Events.js";
+import { Realtime } from "./namespaces/Realtime.js";
+import { Teams } from "./namespaces/Teams.js";
+import { Users } from "./namespaces/Users.js";
 import { adaptParametersForGETRequests, correctType } from "./utilities.js";
+export { Admin, Users, Teams, Events, Realtime };
 /** If the {@link API} throws an error, it should always be an {@link APIError}! */
 export class APIError extends Error {
     message;
@@ -57,7 +63,7 @@ export class API {
     /** Should always be "Bearer" */
     get token_type() { return this._token_type; }
     set token_type(token) { this._token_type = token; }
-    _expires = new Date(new Date().getTime() + 24 * 60 * 60 * 1000); // 24 hours default, is set through getAndSetToken anyway
+    _expires = new Date(new Date().getTime() + 24 * 60 * 60 * 1000); // 24 hours default, is set through setNewToken anyway
     /** The expiration date of your token */
     get expires() { return this._expires; }
     set expires(date) {
@@ -336,7 +342,7 @@ export class API {
         return response;
     }
     /**
-     * The function that directly communicates with the API! Almost every functions of the API object uses this function!
+     * The function that directly communicates with the API! Almost all functions of the API object uses this function!
      * @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
@@ -369,4 +375,38 @@ export class API {
     async getWebsiteStats(website_id, startAt, endAt) {
         return await this.request("get", ["websites", website_id, "stats"], { startAt: Number(startAt), endAt: Number(endAt) });
     }
+    // ADMIN
+    getUsersAsAdmin = Admin.getUsers;
+    getWebsitesAsAdmin = Admin.getWebsites;
+    getTeamsAsAdmin = Admin.getTeams;
+    // USERS
+    createUser = Users.createUser;
+    getUser = Users.getUser;
+    updateUser = Users.updateUser;
+    deleteUser = Users.deleteUser;
+    getUserTeams = Users.getUserTeams;
+    getUserWebsites = Users.getUserWebsites;
+    // TEAMS
+    getTeams = Teams.getTeams;
+    createTeam = Teams.createTeam;
+    joinTeam = Teams.joinTeam;
+    getTeam = Teams.getTeam;
+    updateTeam = Teams.updateTeam;
+    deleteTeam = Teams.deleteTeam;
+    getTeamUsers = Teams.getTeamUsers;
+    addTeamUser = Teams.addTeamUser;
+    getTeamUser = Teams.getTeamUser;
+    updateTeamUser = Teams.updateTeamUser;
+    removeTeamUser = Teams.removeTeamUser;
+    getTeamWebsites = Teams.getTeamWebsites;
+    // EVENTS
+    getWebsiteEvents = Events.getWebsiteEvents;
+    getWebsiteEventData = Events.getWebsiteEventData;
+    getWebsiteEventsData = Events.getWebsiteEventsData;
+    getWebsiteEventsDataFields = Events.getWebsiteEventsDataFields;
+    getWebsiteEventsDataProperties = Events.getWebsiteEventsDataProperties;
+    getWebsiteEventsDataValues = Events.getWebsiteEventsDataValues;
+    getWebsiteEventsDataStats = Events.getWebsiteEventsDataStats;
+    // REALTIME
+    getRealtime = Realtime.getRealtime;
 }

package/dist/namespaces/Admin.d.ts

@@ -0,0 +1,50 @@
+import { API, GenericObject, GenericRequestParameters, Role, Teams } from "../index.js";
+/** For endpoints listed on: https://umami.is/docs/api/admin-api */
+export declare namespace Admin {
+    /** Returns all users: https://umami.is/docs/api/admin-api#get-apiadminusers */
+    function getUsers(this: API, parameters?: GenericRequestParameters): Promise<(GenericObject & {
+        username: string;
+        /** @remarks **UNDOCUMENTED** & seems encrypted (thankfully, lol) */
+        password: string;
+        role: Role;
+        logoUrl: string | null;
+        displayName: string | null;
+        _count: {
+            /** @remarks **UNDOCUMENTED**, documented uncorrectly as `websites`? */
+            websiteUser: number;
+        };
+    })[]>;
+    /**
+     * Returns all websites: https://umami.is/docs/api/admin-api#get-apiadminwebsites
+     * @remarks TODO Possibly doesn't work? (throws 400 on my end)
+     */
+    function getWebsites(this: API, parameters?: GenericRequestParameters): Promise<(GenericObject & {
+        name: string;
+        domain: string;
+        shareId: number | null;
+        resetAt: Date | null;
+        userId: string;
+        teamid: string | null;
+        createdBy: string;
+        user: {
+            username: string;
+            id: string;
+        };
+        /** @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;
+    })[]>;
+    /**
+     * Returns all teams: https://umami.is/docs/api/admin-api#get-apiadminteams
+     * @remarks TODO Possibly doesn't work? (throws 404 on my end)
+     */
+    function getTeams(this: API, parameters?: GenericRequestParameters): Promise<(GenericObject & {
+        name: string;
+        accessCode: string;
+        logoUrl: string | null;
+        members: Teams.TeamMember[];
+        _count: {
+            websites: number;
+            members: number;
+        };
+    })[]>;
+}

package/dist/namespaces/Admin.js

@@ -0,0 +1,28 @@
+/** For endpoints listed on: https://umami.is/docs/api/admin-api */
+export var Admin;
+(function (Admin) {
+    /** Returns all users: https://umami.is/docs/api/admin-api#get-apiadminusers */
+    async function getUsers(parameters) {
+        const response = await this.request("get", ["admin", "users"], parameters);
+        return response.data;
+    }
+    Admin.getUsers = getUsers;
+    /**
+     * Returns all websites: https://umami.is/docs/api/admin-api#get-apiadminwebsites
+     * @remarks TODO Possibly doesn't work? (throws 400 on my end)
+     */
+    async function getWebsites(parameters) {
+        const response = await this.request("get", ["admin", "websites"], parameters);
+        return response.data;
+    }
+    Admin.getWebsites = getWebsites;
+    /**
+     * Returns all teams: https://umami.is/docs/api/admin-api#get-apiadminteams
+     * @remarks TODO Possibly doesn't work? (throws 404 on my end)
+     */
+    async function getTeams(parameters) {
+        const response = await this.request("get", ["admin", "teams"], parameters);
+        return response.data;
+    }
+    Admin.getTeams = getTeams;
+})(Admin || (Admin = {}));

package/dist/namespaces/Events.d.ts

@@ -0,0 +1,116 @@
+import { API, GenericRequestParameters } 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<{
+        id: string;
+        websiteId: string;
+        sessionId: string;
+        createdAt: Date;
+        hostname: string;
+        urlPath: string;
+        urlQuery: string;
+        referrerPath: string;
+        referrerQuery: string;
+        referrerDomain: string;
+        country: string;
+        city: string;
+        device: string;
+        os: string;
+        browser: string;
+        pageTitle: string;
+        eventType: number;
+        eventName: string;
+        hasData: number;
+    }[]>;
+    /** Gets event-data for a individual event https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataeventid (TODO UNTESTED) */
+    function getWebsiteEventData(this: API, websiteId: string, eventId: string): Promise<{
+        websiteId: string;
+        sessionId: string;
+        eventId: string;
+        urlPath: string;
+        eventName: string;
+        dataKey: string;
+        stringValue: string;
+        numberValue: number | null;
+        dateValue: Date | null;
+        dataType: number;
+        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 & {
+        /** Event name filter */
+        event?: string;
+    }): Promise<{
+        eventName: string;
+        propertyName: string;
+        dataType: number;
+        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<{
+        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<{
+        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 & {
+        /** Event name filter */
+        event: string;
+        /** 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-api#get-apiwebsiteswebsiteidevent-datastats (TODO UNTESTED) */
+    function getWebsiteEventsDataStats(this: API, websiteId: string, parameters: FiltersAndTimestamps): Promise<{
+        events: number;
+        properties: number;
+        records: number;
+    }[]>;
+}

package/dist/namespaces/Events.js

@@ -0,0 +1,44 @@
+/** For endpoints listed on: https://umami.is/docs/api/events-api */
+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;
+    }
+    Events.getWebsiteEvents = getWebsiteEvents;
+    /** Gets event-data for a individual event https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataeventid (TODO UNTESTED) */
+    async function getWebsiteEventData(websiteId, eventId) {
+        return await this.request("get", ["websites", websiteId, "event-data", eventId]);
+    }
+    Events.getWebsiteEventData = getWebsiteEventData;
+    /** Gets event data names, properties, and counts: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataevents (TODO UNTESTED) */
+    async function getWebsiteEventsData(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "event-data", "events"], parameters);
+    }
+    Events.getWebsiteEventsData = getWebsiteEventsData;
+    /** Gets event data property and value counts within a given time range: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datafields (TODO UNTESTED) */
+    async function getWebsiteEventsDataFields(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "event-data", "fields"], parameters);
+    }
+    Events.getWebsiteEventsDataFields = getWebsiteEventsDataFields;
+    /** Gets event name and property counts for a website: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataproperties (TODO UNTESTED) */
+    async function getWebsiteEventsDataProperties(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "event-data", "properties"], parameters);
+    }
+    Events.getWebsiteEventsDataProperties = getWebsiteEventsDataProperties;
+    /** Gets event data counts for a given event and property: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datavalues (TODO UNTESTED) */
+    async function getWebsiteEventsDataValues(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "event-data", "values"], parameters);
+    }
+    Events.getWebsiteEventsDataValues = getWebsiteEventsDataValues;
+    /** Gets aggregated website events, properties, and records within a given time range https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datastats (TODO UNTESTED) */
+    async function getWebsiteEventsDataStats(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "event-data", "stats"], parameters);
+    }
+    Events.getWebsiteEventsDataStats = getWebsiteEventsDataStats;
+})(Events || (Events = {}));

package/dist/namespaces/Realtime.d.ts

@@ -0,0 +1,45 @@
+import { API } from "../index.js";
+/** For endpoints listed on: https://umami.is/docs/api/realtime-api */
+export declare namespace Realtime {
+    /** Realtime stats within the last 30 minutes: https://umami.is/docs/api/realtime-api#get-apirealtimewebsiteid (TODO UNTESTED) */
+    function getRealtime(this: API, websiteId: string): Promise<{
+        countries: {
+            [k: string]: number;
+        };
+        urls: {
+            [k: string]: number;
+        };
+        referrers: {
+            [k: string]: number;
+        };
+        events: {
+            __type: string;
+            sessionId: string;
+            eventName: string;
+            createdAt: Date;
+            browser: string;
+            os: string;
+            device: string;
+            country: string;
+            urlPath: string;
+            referrerDomain: string;
+        }[];
+        series: {
+            views: {
+                x: Date;
+                y: number;
+            }[];
+            visitors: {
+                x: Date;
+                y: number;
+            }[];
+        };
+        totals: {
+            views: number;
+            visitors: number;
+            events: number;
+            countries: number;
+        };
+        timestamp: number;
+    }>;
+}

package/dist/namespaces/Realtime.js

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

package/dist/namespaces/Teams.d.ts

@@ -0,0 +1,76 @@
+import { API, GenericObject, GenericRequestParameters, TeamRole } from "../index.js";
+/** For endpoints listed on: https://umami.is/docs/api/teams-api */
+export declare namespace Teams {
+    interface GenericTeam extends GenericObject {
+        name: string;
+        accessCode: string;
+        logoUrl: string | null;
+    }
+    interface TeamMember extends Omit<GenericObject, "deletedAt"> {
+        teamId: string;
+        userId: string;
+        role: TeamRole;
+        user: {
+            id: string;
+            username: string;
+        };
+    }
+    /** Returns all teams: https://umami.is/docs/api/teams-api#get-apiteams (TODO UNTESTED) */
+    function getTeams(this: API, parameters?: Omit<GenericRequestParameters, "search">): Promise<(GenericTeam & {
+        members: TeamMember[];
+        _count: {
+            websites: number;
+            members: number;
+        };
+    })[]>;
+    /** Creates a team: https://umami.is/docs/api/teams-api#post-apiteams (TODO UNTESTED) */
+    function createTeam(this: API, name: string): Promise<[GenericTeam, Omit<TeamMember, "user">]>;
+    /** Join a team: https://umami.is/docs/api/teams-api#post-apiteamsjoin (TODO UNTESTED) */
+    function joinTeam(this: API, accessCode: string): Promise<Omit<TeamMember, "user">>;
+    /** Get a team: https://umami.is/docs/api/teams-api#get-apiteamsteamid (TODO UNTESTED) */
+    function getTeam(this: API, teamId: string): Promise<GenericTeam & {
+        members: Omit<TeamMember, "user">[];
+    }>;
+    /** Update a team: https://umami.is/docs/api/teams-api#post-apiteamsteamid (TODO UNTESTED) */
+    function updateTeam(this: API, teamId: string, parameters: {
+        /** The team's name */
+        name?: string;
+        /** The team's access code */
+        accessCode?: string;
+    }): Promise<GenericTeam>;
+    /** Delete a team: https://umami.is/docs/api/teams-api#delete-apiteamsteamid (TODO UNTESTED) */
+    function deleteTeam(this: API, teamId: string): Promise<{
+        ok: boolean;
+    }>;
+    /** Get all users that belong to a team: https://umami.is/docs/api/teams-api#get-apiteamsteamidusers (TODO UNTESTED) */
+    function getTeamUsers(this: API, teamId: string, parameters: GenericRequestParameters): Promise<TeamMember[]>;
+    /** Add a user to a team: https://umami.is/docs/api/teams-api#post-apiteamsteamidusers (TODO UNTESTED) */
+    function addTeamUser(this: API, teamId: string, parameters: {
+        /** ID of user to be added */
+        userId: string;
+        /** Team role for user */
+        role: TeamRole;
+    }): Promise<Omit<TeamMember, "user">>;
+    /** Get a user belonging to a team: https://umami.is/docs/api/teams-api#get-apiteamsteamidusersuserid (TODO UNTESTED) */
+    function getTeamUser(this: API, teamId: string, userId: string): Promise<Omit<TeamMember, "user">>;
+    /** Update a user's role on a team: https://umami.is/docs/api/teams-api#post-apiteamsteamidusersuserid (TODO UNTESTED) */
+    function updateTeamUser(this: API, teamId: string, userId: string, role: TeamRole): Promise<Omit<TeamMember, "user">>;
+    /** Remove a user from a team: https://umami.is/docs/api/teams-api#delete-apiteamsteamidusersuserid (TODO UNTESTED) */
+    function removeTeamUser(this: API, teamId: string, userId: string): Promise<{
+        ok: boolean;
+    }>;
+    /** Get all websites that belong to a team: https://umami.is/docs/api/teams-api#get-apiteamsteamidwebsites (TODO UNTESTED) */
+    function getTeamWebsites(this: API, teamId: string, parameters: GenericRequestParameters): Promise<(GenericObject & {
+        name: string;
+        domain: string;
+        shareId: string;
+        resetAt: Date | null;
+        userId: string | null;
+        teamId: string | null;
+        createdBy: string;
+        createUser: {
+            id: string;
+            username: string;
+        };
+    })[]>;
+}

package/dist/namespaces/Teams.js

@@ -0,0 +1,67 @@
+/** For endpoints listed on: https://umami.is/docs/api/teams-api */
+export var Teams;
+(function (Teams) {
+    /** Returns all teams: https://umami.is/docs/api/teams-api#get-apiteams (TODO UNTESTED) */
+    async function getTeams(parameters) {
+        const response = await this.request("get", ["teams"], parameters);
+        return response.data;
+    }
+    Teams.getTeams = getTeams;
+    /** Creates a team: https://umami.is/docs/api/teams-api#post-apiteams (TODO UNTESTED) */
+    async function createTeam(name) {
+        return await this.request("post", ["teams"], { name });
+    }
+    Teams.createTeam = createTeam;
+    /** Join a team: https://umami.is/docs/api/teams-api#post-apiteamsjoin (TODO UNTESTED) */
+    async function joinTeam(accessCode) {
+        return await this.request("post", ["teams", "join"], { accessCode });
+    }
+    Teams.joinTeam = joinTeam;
+    /** Get a team: https://umami.is/docs/api/teams-api#get-apiteamsteamid (TODO UNTESTED) */
+    async function getTeam(teamId) {
+        return await this.request("get", ["teams", teamId]);
+    }
+    Teams.getTeam = getTeam;
+    /** Update a team: https://umami.is/docs/api/teams-api#post-apiteamsteamid (TODO UNTESTED) */
+    async function updateTeam(teamId, parameters) {
+        return await this.request("post", ["teams", teamId], parameters);
+    }
+    Teams.updateTeam = updateTeam;
+    /** Delete a team: https://umami.is/docs/api/teams-api#delete-apiteamsteamid (TODO UNTESTED) */
+    async function deleteTeam(teamId) {
+        return await this.request("delete", ["teams", teamId]);
+    }
+    Teams.deleteTeam = deleteTeam;
+    /** Get all users that belong to a team: https://umami.is/docs/api/teams-api#get-apiteamsteamidusers (TODO UNTESTED) */
+    async function getTeamUsers(teamId, parameters) {
+        const response = await this.request("get", ["teams", teamId, "users"], parameters);
+        return response.data;
+    }
+    Teams.getTeamUsers = getTeamUsers;
+    /** Add a user to a team: https://umami.is/docs/api/teams-api#post-apiteamsteamidusers (TODO UNTESTED) */
+    async function addTeamUser(teamId, parameters) {
+        return await this.request("post", ["teams", teamId, "users"], parameters);
+    }
+    Teams.addTeamUser = addTeamUser;
+    /** Get a user belonging to a team: https://umami.is/docs/api/teams-api#get-apiteamsteamidusersuserid (TODO UNTESTED) */
+    async function getTeamUser(teamId, userId) {
+        return await this.request("get", ["teams", teamId, "users", userId]);
+    }
+    Teams.getTeamUser = getTeamUser;
+    /** Update a user's role on a team: https://umami.is/docs/api/teams-api#post-apiteamsteamidusersuserid (TODO UNTESTED) */
+    async function updateTeamUser(teamId, userId, role) {
+        return await this.request("post", ["teams", teamId, "users", userId], { role });
+    }
+    Teams.updateTeamUser = updateTeamUser;
+    /** Remove a user from a team: https://umami.is/docs/api/teams-api#delete-apiteamsteamidusersuserid (TODO UNTESTED) */
+    async function removeTeamUser(teamId, userId) {
+        return await this.request("delete", ["teams", teamId, "users", userId]);
+    }
+    Teams.removeTeamUser = removeTeamUser;
+    /** Get all websites that belong to a team: https://umami.is/docs/api/teams-api#get-apiteamsteamidwebsites (TODO UNTESTED) */
+    async function getTeamWebsites(teamId, parameters) {
+        const response = await this.request("get", ["teams", teamId, "websites"], parameters);
+        return response.data;
+    }
+    Teams.getTeamWebsites = getTeamWebsites;
+})(Teams || (Teams = {}));

package/dist/namespaces/Users.d.ts

@@ -0,0 +1,74 @@
+import { API, GenericObject, GenericRequestParameters, Role, TeamRole } from "../index.js";
+/** For endpoints listed on: https://umami.is/docs/api/users-api */
+export declare namespace Users {
+    interface GenericUser {
+        id: string;
+        username: string;
+        role: Role;
+    }
+    /** Creates a user: https://umami.is/docs/api/users-api#post-apiusers */
+    function createUser(this: API, parameters: {
+        /** The user's username */
+        username: string;
+        /** The user's password */
+        password: string;
+        /** The user's role */
+        role: Role;
+        /** Force a UUID assignment to the user */
+        id?: string;
+    }): Promise<GenericUser>;
+    /** Gets a user by ID: https://umami.is/docs/api/users-api#get-apiusersuserid */
+    function getUser(this: API, id: string): Promise<GenericUser & {
+        createdAt: Date;
+    }>;
+    /** Updates a user: https://umami.is/docs/api/users-api#post-apiusersuserid */
+    function updateUser(this: API, id: string, parameters?: {
+        /** The user's username */
+        username?: string;
+        /** The user's password */
+        password?: string;
+        /** The user's role */
+        role?: Role;
+    }): Promise<GenericUser & {
+        createdAt: Date;
+    }>;
+    /** Deletes a user: https://umami.is/docs/api/users-api#delete-apiusersuserid */
+    function deleteUser(this: API, id: string): Promise<{
+        ok: boolean;
+    }>;
+    /** Gets all websites that belong to a user: https://umami.is/docs/api/users-api#get-apiusersuseridwebsites */
+    function getUserWebsites(this: API, id: string, parameters: GenericRequestParameters & {
+        includeTeams: boolean;
+    }): Promise<(GenericObject & {
+        name: string;
+        domain: string;
+        shareId: string | null;
+        resetAt: Date | null;
+        userId: string;
+        teamId: string | null;
+        createdBy: string;
+        user: {
+            username: string;
+            id: string;
+        };
+    })[]>;
+    /** Gets all teams that belong to a user: https://umami.is/docs/api/users-api#get-apiusersuseridteams */
+    function getUserTeams(this: API, id: string, parameters?: Omit<GenericRequestParameters, "search">): Promise<(GenericObject & {
+        name: string;
+        accessCode: string;
+        logoUrl: string | null;
+        members: Omit<GenericObject, "deletedAt"> & {
+            teamId: string;
+            userId: string;
+            role: TeamRole;
+            user: {
+                id: string;
+                username: string;
+            };
+        }[];
+        _count: {
+            websites: number;
+            members: number;
+        };
+    })[]>;
+}

package/dist/namespaces/Users.js

@@ -0,0 +1,36 @@
+/** For endpoints listed on: https://umami.is/docs/api/users-api */
+export var Users;
+(function (Users) {
+    /** Creates a user: https://umami.is/docs/api/users-api#post-apiusers */
+    async function createUser(parameters) {
+        return await this.request("post", ["users"], parameters);
+    }
+    Users.createUser = createUser;
+    /** Gets a user by ID: https://umami.is/docs/api/users-api#get-apiusersuserid */
+    async function getUser(id) {
+        return await this.request("get", ["users", id]);
+    }
+    Users.getUser = getUser;
+    /** Updates a user: https://umami.is/docs/api/users-api#post-apiusersuserid */
+    async function updateUser(id, parameters) {
+        return await this.request("post", ["users", id], parameters);
+    }
+    Users.updateUser = updateUser;
+    /** Deletes a user: https://umami.is/docs/api/users-api#delete-apiusersuserid */
+    async function deleteUser(id) {
+        return await this.request("delete", ["users", id]);
+    }
+    Users.deleteUser = deleteUser;
+    /** Gets all websites that belong to a user: https://umami.is/docs/api/users-api#get-apiusersuseridwebsites */
+    async function getUserWebsites(id, parameters) {
+        const response = await this.request("get", ["users", id, "websites"], parameters);
+        return response.data;
+    }
+    Users.getUserWebsites = getUserWebsites;
+    /** Gets all teams that belong to a user: https://umami.is/docs/api/users-api#get-apiusersuseridteams */
+    async function getUserTeams(id, parameters) {
+        const response = await this.request("get", ["users", id, "teams"], parameters);
+        return response.data;
+    }
+    Users.getUserTeams = getUserTeams;
+})(Users || (Users = {}));

package/dist/utilities.js

@@ -55,9 +55,10 @@ export function correctType(x, force_string) {
         const keys = Object.keys(x);
         const vals = Object.values(x);
         // If a key is any of those, the value is expected to be a string, so we use `force_string` to make correctType convert them to string for us
-        const unconvertables = [];
+        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((p) => keys[i] === p));
+            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.1",
+  "version": "0.0.2",
   "description": "Package to easily access the umami api!",
   "type": "module",
   "main": "dist/index.js",