@morscherlab/mint-sdk 1.1.25 → 1.2.0-beta.2

package/src/composables/usePluginConfig.ts

@@ -1,250 +0,0 @@
-import { ref, computed, onMounted, type Ref, type ComputedRef } from 'vue'
-import { useApi } from './useApi'
-import { usePlatformContext } from './usePlatformContext'
-import { getInjectedPlatformContext } from './platformContextHelpers'
-import { useRequestSyncState } from './useRequestSyncState'
-
-const PLATFORM_OWNED_SETTINGS_KEY = 'allowed_experiment_types'
-
-function cloneConfig(config: Record<string, unknown>): Record<string, unknown> {
-  return JSON.parse(JSON.stringify(config)) as Record<string, unknown>
-}
-
-function hasOwnConfig(config: Record<string, unknown>, key: string): boolean {
-  return Object.prototype.hasOwnProperty.call(config, key)
-}
-
-function changedTopLevelKeys(
-  current: Record<string, unknown>,
-  saved: Record<string, unknown>,
-): Set<string> {
-  return new Set(
-    [...new Set([...Object.keys(current), ...Object.keys(saved)])].filter(
-      key => JSON.stringify(current[key]) !== JSON.stringify(saved[key]),
-    ),
-  )
-}
-
-function topLevelConfigPatch(
-  current: Record<string, unknown>,
-  keys: Iterable<string>,
-): Record<string, unknown> {
-  return Object.fromEntries(
-    [...keys].map(key => [
-      key,
-      hasOwnConfig(current, key) ? current[key] : null,
-    ]),
-  )
-}
-
-function platformOwnedConfigPatch(config: Record<string, unknown>): Record<string, unknown> {
-  return {
-    [PLATFORM_OWNED_SETTINGS_KEY]: hasOwnConfig(config, PLATFORM_OWNED_SETTINGS_KEY)
-      ? config[PLATFORM_OWNED_SETTINGS_KEY]
-      : null,
-  }
-}
-
-function responseConfigPayload(response: {
-  config?: Record<string, unknown>
-  settings?: Record<string, unknown>
-}): Record<string, unknown> {
-  return response.config ?? response.settings ?? {}
-}
-
-export interface UsePluginConfigReturn {
-  /** Editable plugin configuration values. */
-  config: Ref<Record<string, unknown>>
-  /** Whether the config is currently loading. */
-  isLoading: Ref<boolean>
-  /** Whether the config is currently saving. */
-  isSaving: Ref<boolean>
-  /** Error message from the last failed operation, or null. */
-  error: Ref<string | null>
-  /** Timestamp of the last successful load, or null. */
-  lastLoadedAt: Ref<Date | null>
-  /** Timestamp of the last successful save, or null. */
-  lastSavedAt: Ref<Date | null>
-  /** Whether local config differs from the last loaded or saved snapshot. */
-  isDirty: ComputedRef<boolean>
-  /** Load plugin configuration from the platform. */
-  load: () => Promise<void>
-  /** Save plugin configuration to the platform. */
-  save: () => Promise<boolean>
-  /** Restore the last loaded or saved configuration snapshot. */
-  reset: () => void
-}
-
-/** Loads, saves, and tracks dirty state for a plugin's persistent configuration via the platform API. */
-export function usePluginConfig(pluginName?: string): UsePluginConfigReturn {
-  const injectedContext = getInjectedPlatformContext()
-  const { plugin } = usePlatformContext()
-  const platformApi = useApi()
-  const pluginApi = useApi({
-    baseUrl: injectedContext?.plugin?.api_prefix ?? plugin.value?.api_prefix,
-  })
-
-  const resolvedName = computed(
-    () => pluginName ?? plugin.value?.name ?? injectedContext?.plugin?.name ?? '',
-  )
-  const usesPluginSettingsApi = computed(() => {
-    const currentPlugin = injectedContext?.plugin ?? plugin.value
-    return currentPlugin?.settings_api === 'plugin'
-      && resolvedName.value === currentPlugin.name
-  })
-
-  const config = ref<Record<string, unknown>>({})
-  const savedConfig = ref<Record<string, unknown>>({})
-  const revision = ref<string | null>(null)
-  const request = useRequestSyncState('Plugin config request failed.')
-  const isLoading = ref(false)
-  const isSaving = ref(false)
-  const error = request.error
-  const lastLoadedAt = request.lastLoadedAt
-  const lastSavedAt = request.lastSavedAt
-
-  const isDirty = computed(() => {
-    return JSON.stringify(config.value) !== JSON.stringify(savedConfig.value)
-  })
-
-  async function load(): Promise<void> {
-    const name = resolvedName.value
-    if (!name) return
-
-    isLoading.value = true
-    try {
-      const response = usesPluginSettingsApi.value
-        ? await request.run(
-          () => pluginApi.get<{
-            settings: Record<string, unknown>
-            mode?: string
-            revision?: string
-          }>('/settings'),
-          { success: 'load', errorMessage: 'Failed to load plugin config' },
-        )
-        : await request.run(
-          () => platformApi.get<{
-            plugin_name: string
-            config: Record<string, unknown>
-            revision?: string
-          }>(
-            `/plugins/${encodeURIComponent(name)}/config`,
-          ),
-          { success: 'load', errorMessage: 'Failed to load plugin config' },
-        )
-      const responseConfig = responseConfigPayload(response)
-      config.value = cloneConfig(responseConfig)
-      savedConfig.value = cloneConfig(responseConfig)
-      revision.value = response.revision ?? null
-    } catch {
-      // Error state is handled by request.run().
-    } finally {
-      isLoading.value = false
-    }
-  }
-
-  async function save(): Promise<boolean> {
-    const name = resolvedName.value
-    if (!name) return false
-
-    isSaving.value = true
-    try {
-      const payload = cloneConfig(config.value)
-      let response: {
-        plugin_name?: string
-        config?: Record<string, unknown>
-        settings?: Record<string, unknown>
-        mode?: string
-        revision?: string
-      } | undefined
-      let nextRevision = revision.value
-
-      if (usesPluginSettingsApi.value) {
-        response = await request.run(
-          () => pluginApi.put<{
-            settings: Record<string, unknown>
-            mode?: string
-            revision?: string
-          }>(
-            '/settings',
-            payload,
-            revision.value
-              ? { headers: { 'If-Match': `"${revision.value}"` } }
-              : undefined,
-          ),
-          { success: 'save', errorMessage: 'Failed to save plugin config' },
-        )
-        nextRevision = response.revision ?? nextRevision
-      } else {
-        const dirtyKeys = changedTopLevelKeys(payload, savedConfig.value)
-        const platformOwnedChanged = dirtyKeys.has(PLATFORM_OWNED_SETTINGS_KEY)
-        const typedKeys = [...dirtyKeys].filter(
-          key => key !== PLATFORM_OWNED_SETTINGS_KEY,
-        )
-
-        if (typedKeys.length) {
-          response = await request.run(
-            () => platformApi.patch<{
-              plugin_name: string
-              config: Record<string, unknown>
-              revision?: string
-            }>(
-              `/plugins/${encodeURIComponent(name)}/config`,
-              { config: topLevelConfigPatch(payload, typedKeys) },
-            ),
-            { success: 'save', errorMessage: 'Failed to save plugin config' },
-          )
-          nextRevision = response.revision ?? nextRevision
-        }
-
-        if (platformOwnedChanged) {
-          response = await request.run(
-            () => platformApi.patch<{
-              plugin_name: string
-              config: Record<string, unknown>
-              revision?: string
-            }>(
-              `/plugins/${encodeURIComponent(name)}/config`,
-              { config: platformOwnedConfigPatch(payload) },
-            ),
-            { success: 'save', errorMessage: 'Failed to save plugin config' },
-          )
-          nextRevision = response.revision ?? nextRevision
-        }
-      }
-
-      if (!response) return true
-      const responseConfig = responseConfigPayload(response)
-      config.value = cloneConfig(responseConfig)
-      savedConfig.value = cloneConfig(responseConfig)
-      revision.value = response.revision ?? nextRevision
-      return true
-    } catch {
-      return false
-    } finally {
-      isSaving.value = false
-    }
-  }
-
-  function reset(): void {
-    config.value = cloneConfig(savedConfig.value)
-    request.clearError()
-  }
-
-  onMounted(() => {
-    load()
-  })
-
-  return {
-    config,
-    isLoading,
-    isSaving,
-    error,
-    lastLoadedAt,
-    lastSavedAt,
-    isDirty,
-    load,
-    save,
-    reset,
-  }
-}