Merge branch 'master' of https://github.com/umami-software/api-client

Author: franciscao633

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umami/api-client",
-  "version": "0.37.0",
+  "version": "0.41.0",
   "description": "API client for Umami Analytics",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

src/UmamiApiClient.ts

@@ -1,6 +1,7 @@
 import { createSecureToken, hash, get, post, put, del, buildUrl, ApiResponse } from 'next-basics';
 import * as Umami from './types';
 import { log } from 'utils';
+import { FilterResult } from './types';
 
 export const API_KEY_HEADER = 'x-umami-api-key';
 
@@ -47,31 +48,31 @@ export class UmamiApiClient {
   get(url: string, params?: object, headers?: object) {
     const dest = buildUrl(`${this.apiEndpoint}/${url}`, params);
 
-    log(`GET ${dest}`);
+    log(`GET ${dest}`, params, headers);
 
     return get(dest, undefined, this.getHeaders(headers));
   }
 
   post(url: string, params?: object, headers?: object) {
     const dest = `${this.apiEndpoint}/${url}`;
 
-    log(`POST ${dest}`);
+    log(`POST ${dest}`, params, headers);
 
     return post(dest, params, this.getHeaders(headers));
   }
 
   put(url: string, params?: object, headers?: object) {
     const dest = `${this.apiEndpoint}/${url}`;
 
-    log(`PUT ${dest}`);
+    log(`PUT ${dest}`, params, headers);
 
     return put(dest, params, this.getHeaders(headers));
   }
 
   del(url: string, params?: object, headers?: object) {
     const dest = buildUrl(`${this.apiEndpoint}/${url}`, params);
 
-    log(`DELETE ${dest}`);
+    log(`DELETE ${dest}`, params, headers);
 
     return del(dest, undefined, this.getHeaders(headers));
   }
@@ -84,8 +85,8 @@ export class UmamiApiClient {
     return this.get(`users/${userId}`);
   }
 
-  async getUsers(): Promise<ApiResponse<Umami.User[]>> {
-    return this.get(`users`);
+  async getUsers(params: Umami.UserSearchFilter): Promise<ApiResponse<FilterResult<Umami.User[]>>> {
+    return this.get(`users`, params);
   }
 
   async getUserUsage(
@@ -98,8 +99,11 @@ export class UmamiApiClient {
     return this.get(`users/${userId}/usage`, params);
   }
 
-  async getUserWebsites(userId: string): Promise<ApiResponse<Umami.User[]>> {
-    return this.get(`users/${userId}/websites`);
+  async getUserWebsites(
+    userId: string,
+    params: Umami.WebsiteSearchFilter,
+  ): Promise<ApiResponse<FilterResult<Umami.User[]>>> {
+    return this.get(`users/${userId}/websites`, params);
   }
 
   async deleteUser(userId: string): Promise<ApiResponse<Umami.Empty>> {
@@ -144,8 +148,10 @@ export class UmamiApiClient {
     return this.post(`websites/${websiteId}/reset`);
   }
 
-  async getWebsites(): Promise<ApiResponse<Umami.Website[]>> {
-    return this.get(`websites`);
+  async getWebsites(
+    params?: Umami.WebsiteSearchFilter,
+  ): Promise<ApiResponse<FilterResult<Umami.Website[]>>> {
+    return this.get(`websites`, params);
   }
 
   async getWebsiteActive(websiteId: string): Promise<ApiResponse<Umami.WebsiteActive[]>> {
@@ -260,24 +266,30 @@ export class UmamiApiClient {
     return this.get(`teams/${teamId}`);
   }
 
-  async getTeams(): Promise<ApiResponse<Umami.Team[]>> {
-    return this.get(`teams`);
+  async getTeams(params?: Umami.TeamSearchFilter): Promise<ApiResponse<Umami.Team[]>> {
+    return this.get(`teams`, params);
   }
 
   async joinTeam(data: { accessCode: string }): Promise<ApiResponse<Umami.Team>> {
     return this.post(`teams/join`, data);
   }
 
-  async getTeamUsers(teamId: string): Promise<ApiResponse<Umami.User[]>> {
-    return this.get(`teams/${teamId}/users`);
+  async getTeamUsers(
+    teamId: string,
+    params?: Umami.UserSearchFilter,
+  ): Promise<ApiResponse<FilterResult<FilterResult<Umami.User[]>>>> {
+    return this.get(`teams/${teamId}/users`, params);
   }
 
   async deleteTeamUser(teamId: string, userId: string): Promise<ApiResponse<Umami.Empty>> {
     return this.del(`teams/${teamId}/users/${userId}`);
   }
 
-  async getTeamWebsites(teamId: string): Promise<ApiResponse<Umami.Website[]>> {
-    return this.get(`teams/${teamId}/websites`);
+  async getTeamWebsites(
+    teamId: string,
+    params?: Umami.WebsiteSearchFilter,
+  ): Promise<ApiResponse<FilterResult<FilterResult<Umami.Website[]>>>> {
+    return this.get(`teams/${teamId}/websites`, params);
   }
 
   async createTeamWebsites(
@@ -318,8 +330,12 @@ export class UmamiApiClient {
     return this.get('me');
   }
 
-  async getMyWebsites() {
-    return this.post('me/websites');
+  async getMyWebsites(params?: Umami.WebsiteSearchFilter) {
+    return this.get('me/websites', params);
+  }
+
+  async getMyTeams(params?: Umami.TeamSearchFilter) {
+    return this.get('me/teams', params);
   }
 
   async updateMyPassword(data: { currentPassword: string; newPassword: string }) {

src/client.ts

@@ -14,7 +14,11 @@ export const queryMap = [
   },
   {
     path: /^me\/websites$/,
-    get: async () => client.getMyWebsites(),
+    get: async (args, data) => client.getMyWebsites(data),
+  },
+  {
+    path: /^me\/teams$/,
+    get: async (args, data) => client.getMyTeams(data),
   },
   {
     path: /^event-data\/events$/,
@@ -30,7 +34,7 @@ export const queryMap = [
   },
   {
     path: /^teams$/,
-    get: async () => client.getTeams(),
+    get: async (args, data) => client.getTeams(data),
     post: async (args, data) => client.createTeam(data),
   },
   {
@@ -43,14 +47,17 @@ export const queryMap = [
     post: async ([, id], data) => client.updateTeam(id, data),
     delete: async ([, id]) => client.deleteTeam(id),
   },
-  { path: /^teams\/[0-9a-f-]+\/users$/, get: async ([, id]) => client.getTeamUsers(id) },
+  {
+    path: /^teams\/[0-9a-f-]+\/users$/,
+    get: async ([, id], data) => client.getTeamUsers(id, data),
+  },
   {
     path: /^teams\/[0-9a-f-]+\/users\/[0-9a-f-]+$/,
     delete: async ([, teamId, , userId]) => client.deleteTeamUser(teamId, userId),
   },
   {
     path: /^teams\/[0-9a-f-]+\/websites$/,
-    get: async ([, id]) => client.getTeamWebsites(id),
+    get: async ([, id], data) => client.getTeamWebsites(id, data),
     post: async ([, id], data) => client.createTeamWebsites(id, data),
   },
   {
@@ -59,7 +66,7 @@ export const queryMap = [
   },
   {
     path: /^users$/,
-    get: async () => client.getUsers(),
+    get: async (args, data) => client.getUsers(data),
     post: async (args, data) => client.createUser(data),
   },
   {
@@ -70,15 +77,15 @@ export const queryMap = [
   },
   {
     path: /^users\/[0-9a-f-]+\/websites$/,
-    get: async ([, id]) => client.getUserWebsites(id),
+    get: async ([, id], data) => client.getUserWebsites(id, data),
   },
   {
     path: /^users\/[0-9a-f-]+\/usage$/,
     get: async ([, id], data) => client.getUserUsage(id, data),
   },
   {
     path: /^websites$/,
-    get: async () => client.getWebsites(),
+    get: async (args, data) => client.getWebsites(data),
     post: async (args, data) => client.createWebsite(data),
   },
   {

src/constants.ts

@@ -0,0 +1,18 @@
+export const USER_FILTER_TYPES = {
+  all: 'All',
+  username: 'Username',
+} as const;
+
+export const WEBSITE_FILTER_TYPES = { all: 'All', name: 'Name', domain: 'Domain' } as const;
+
+export const TEAM_FILTER_TYPES = { all: 'All', name: 'Name', 'user:username': 'Owner' } as const;
+
+export const REPORT_FILTER_TYPES = {
+  all: 'All',
+  name: 'Name',
+  description: 'Description',
+  type: 'Type',
+  'user:username': 'Username',
+  'website:name': 'Website Name',
+  'website:domain': 'Website Domain',
+} as const;

src/index.ts

@@ -2,3 +2,4 @@ export * from './client';
 export * from './types';
 export * from './UmamiApiClient';
 export * from './utils';
+export * from './constants';

src/types.ts

@@ -1,3 +1,10 @@
+import {
+  REPORT_FILTER_TYPES,
+  TEAM_FILTER_TYPES,
+  USER_FILTER_TYPES,
+  WEBSITE_FILTER_TYPES,
+} from './constants';
+
 export interface User {
   id: string;
   username: string;
@@ -89,3 +96,45 @@ export interface WebsiteEventData {
 }
 
 export interface Empty {}
+
+type ObjectValues<T> = T[keyof T];
+
+export type ReportSearchFilterType = ObjectValues<typeof REPORT_FILTER_TYPES>;
+export type UserSearchFilterType = ObjectValues<typeof USER_FILTER_TYPES>;
+export type WebsiteSearchFilterType = ObjectValues<typeof WEBSITE_FILTER_TYPES>;
+export type TeamSearchFilterType = ObjectValues<typeof TEAM_FILTER_TYPES>;
+
+export interface WebsiteSearchFilter extends SearchFilter<WebsiteSearchFilterType> {
+  userId?: string;
+  teamId?: string;
+  includeTeams?: boolean;
+}
+
+export interface UserSearchFilter extends SearchFilter<UserSearchFilterType> {
+  teamId?: string;
+}
+
+export interface TeamSearchFilter extends SearchFilter<TeamSearchFilterType> {
+  userId?: string;
+}
+
+export interface ReportSearchFilter extends SearchFilter<ReportSearchFilterType> {
+  userId?: string;
+  websiteId?: string;
+}
+
+export interface SearchFilter<T> {
+  filter?: string;
+  filterType?: T;
+  pageSize?: number;
+  page?: number;
+  orderBy?: string;
+}
+
+export interface FilterResult<T> {
+  data: T;
+  count: number;
+  pageSize: number;
+  page: number;
+  orderBy?: string;
+}