feat(admin,admin-ui,medusa): Add Medusa Admin plugin (#3334)

packages/admin-ui/ui/src/services/analytics.ts

@@ -0,0 +1,112 @@
+import { AdminAnalyticsConfigRes } from "@medusajs/medusa"
+import { AnalyticsBrowser } from "@segment/analytics-next"
+import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query"
+import axios from "axios"
+import { WRITE_KEY } from "../constants/analytics"
+import { MEDUSA_BACKEND_URL } from "../constants/medusa-backend-url"
+import { useFeatureFlag } from "../providers/feature-flag-provider"
+
+// API
+
+const ANALYTICS_BASE = "admin/analytics-configs"
+
+const client = axios.create({
+  baseURL: MEDUSA_BACKEND_URL,
+  withCredentials: true,
+})
+
+// Analytics instance used for tracking one-off events, such as errors and the initial permission request
+export const analytics = AnalyticsBrowser.load({
+  writeKey: WRITE_KEY,
+})
+
+/**
+ * Fetches the analytics config for the current user.
+ */
+export const getAnalyticsConfig =
+  async (): Promise<AdminAnalyticsConfigRes> => {
+    const { data } = await client.get(ANALYTICS_BASE)
+    return data
+  }
+
+type CreateConfigPayload = {
+  opt_out: boolean
+  anonymize?: boolean
+}
+
+/**
+ * Creates a new analytics config for the current user.
+ */
+export const createAnalyticsConfig = async (
+  payload: CreateConfigPayload
+): Promise<AdminAnalyticsConfigRes> => {
+  const { data } = await client.post(ANALYTICS_BASE, payload)
+  return data
+}
+
+type UpdateConfigPayload = {
+  opt_out?: boolean
+  anonymize?: boolean
+}
+
+/**
+ * Updates the users analytics config
+ */
+export const updateAnalyticsConfig = async (
+  payload: UpdateConfigPayload
+): Promise<AdminAnalyticsConfigRes> => {
+  const { data } = await client.post(`${ANALYTICS_BASE}/update`, payload)
+  return data
+}
+
+// Hooks
+
+const ANALYTICS_CONFIG_KEY = ["analytics-config"]
+
+const useInvalidateAnalyticsConfig = () => {
+  const queryClient = useQueryClient()
+  return () => {
+    queryClient.invalidateQueries(ANALYTICS_CONFIG_KEY)
+  }
+}
+
+export const useAdminAnalyticsConfig = () => {
+  const { isFeatureEnabled } = useFeatureFlag()
+
+  const { data, ...rest } = useQuery(
+    ANALYTICS_CONFIG_KEY,
+    () => getAnalyticsConfig(),
+    {
+      retry: false,
+      enabled: isFeatureEnabled("analytics"),
+    }
+  )
+
+  return { ...data, ...rest }
+}
+
+export const useAdminUpdateAnalyticsConfig = () => {
+  const invalidateAnalyticsConfig = useInvalidateAnalyticsConfig()
+
+  const mutation = useMutation(
+    (payload: UpdateConfigPayload) => updateAnalyticsConfig(payload),
+    {
+      onSuccess: invalidateAnalyticsConfig,
+    }
+  )
+
+  return mutation
+}
+
+export const useAdminCreateAnalyticsConfig = () => {
+  const invalidateAnalyticsConfig = useInvalidateAnalyticsConfig()
+
+  const mutation = useMutation(
+    (payload: CreateConfigPayload) => createAnalyticsConfig(payload),
+    {
+      onSuccess: invalidateAnalyticsConfig,
+    }
+  )
+
+  return mutation
+}