🤖 Merge PR DefinitelyTyped#71767 [@types/umami-browser] update definitions to umami ver 2.13.0 by @ari-party

Author: ari-party

types/umami-browser/index.d.ts

@@ -1,18 +1,47 @@
 declare var umami: umami.umami;
 
+type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] };
+
+/**
+ * @see {@link https://umami.is/docs/tracker-functions|Umami Docs}
+ */
 declare namespace umami {
-    interface TrackPayload {
+    interface PageViewProperties {
         website: string;
-        hostname?: string;
-        language?: string;
-        referrer?: string;
-        screen?: string;
-        title?: string;
-        url?: string;
+        hostname: string;
+        language: string;
+        referrer: string;
+        screen: string;
+        title: string;
+        url: string;
+    }
+
+    interface EventData {
+        [key: string]:
+            | number
+            | string
+            | EventData
+            | number[]
+            | string[]
+            | EventData[];
+    }
+
+    interface CustomPayload extends WithRequired<Partial<PageViewProperties>, "website"> {
+        name?: string;
+        data?: EventData;
     }
 
     interface umami {
-        track(payloadOrCallback?: TrackPayload | ((properties: TrackPayload) => TrackPayload)): void;
-        track(eventName?: string, eventData?: Record<string, unknown>): void;
+        track: {
+            (): Promise<string>;
+            (eventName: string): Promise<string>;
+            (eventName: string, eventData: EventData): Promise<string>;
+            (props: CustomPayload): Promise<string>;
+            (
+                callback: (props: PageViewProperties) => CustomPayload,
+            ): Promise<string>;
+        };
+
+        identify(data: EventData): Promise<string>;
     }
 }

types/umami-browser/package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/umami-browser",
-    "version": "2.3.9999",
+    "version": "2.13.9999",
     "nonNpm": true,
     "nonNpmDescription": "umami-browser",
     "projects": [

types/umami-browser/umami-browser-tests.ts

@@ -1,17 +1,24 @@
 umami.track();
 
-umami.track({ website: "" });
-umami.track({ website: "", hostname: "" });
-umami.track({ website: "", language: "" });
-umami.track({ website: "", referrer: "" });
-umami.track({ website: "", screen: "" });
-umami.track({ website: "", title: "" });
-umami.track({ website: "", url: "" });
-
-umami.track(properties => {
-    return { ...properties, url: "", title: "" };
+umami.track({
+    website: "e676c9b4-11e4-4ef1-a4d7-87001773e9f2",
+    url: "/home",
+    title: "Home page",
 });
 
-umami.track("custom_event");
+umami.track((props) => ({ ...props, url: "/home", title: "Home page" }));
+
+umami.track("signup-button");
+
+umami.track("signup-button", { name: "newsletter", id: 123 });
+
+umami.track((props) => ({
+    ...props,
+    name: "signup-button",
+    data: {
+        name: "newsletter",
+        id: 123,
+    },
+}));
 
-umami.track("custom_event", { name: "newsletter", id: 123 });
+umami.identify({ email: "[email protected]" });