swetrix 2.3.1 → 3.0.0

package/src/utils.ts

@@ -1,3 +1,8 @@
+interface IGetPath {
+  hash?: boolean
+  search?: boolean
+}
+
 const findInSearch = (exp: RegExp): string | undefined => {
   const res = location.search.match(exp)
   return (res && res[2]) || undefined
@@ -41,7 +46,34 @@ export const getUTMMedium = () => findInSearch(utmMediumRegex)
 
 export const getUTMCampaign = () => findInSearch(utmCampaignRegex)
 
-export const getPath = (): string => {
-  // TODO: Maybe we should also include such data as location.hash or location.search
-  return location.pathname || ''
+/**
+ * Function used to track the current page (path) of the application.
+ * Will work in cases where the path looks like:
+ * - /path
+ * - /#/path
+ * - /path?search
+ * - /path?search#hash
+ * - /path#hash?search
+ *
+ * @param options - Options for the function.
+ * @param options.hash - Whether to trigger on hash change.
+ * @param options.search - Whether to trigger on search change.
+ * @returns The path of the current page.
+ */
+export const getPath = (options: IGetPath): string => {
+  let result = location.pathname || ''
+
+  if (options.hash) {
+    const hashIndex = location.hash.indexOf('?')
+    const hashString = hashIndex > -1 ? location.hash.substring(0, hashIndex) : location.hash
+    result += hashString
+  }
+
+  if (options.search) {
+    const hashIndex = location.hash.indexOf('?')
+    const searchString = location.search || (hashIndex > -1 ? location.hash.substring(hashIndex) : '')
+    result += searchString
+  }
+
+  return result
 }