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

package/src/composables/useJobsStatusTray.ts

@@ -5,6 +5,7 @@ import {
   ref,
   shallowRef,
   toValue,
+  watch,
   type ComputedRef,
   type MaybeRefOrGetter,
   type Ref,
@@ -16,7 +17,12 @@ import type {
   JobListPayload,
   JobState,
   JobStateInput,
+  JobStreamData,
 } from '../types/jobs'
+import type {
+  PluginEventStreamMessage,
+  UsePluginEventStreamReturn,
+} from './usePluginClient'
 
 export type JobsStatusTrayTab = 'active' | 'history'
 
@@ -140,11 +146,32 @@ function duplicatePluginJobId(jobId: string): Error {
   return new Error(`Duplicate plugin job id across combined sources: ${jobId}`)
 }
 
+/** @deprecated Prefer a {@link PluginJobCenterSource}. */
+export interface JobsStatusTrayAdapter {
+  listJobs?: () => Promise<JobListPayload | readonly JobStateInput[]>
+  cancelJob?: (job: JobState) => Promise<JobStateInput | void>
+  deleteJob?: (job: JobState) => Promise<boolean | void>
+  clearFinishedJobs?: (jobs: readonly JobState[]) => Promise<number | void>
+}
+
 export interface UsePluginJobCenterOptions {
   source?: MaybeRefOrGetter<PluginJobCenterSource | undefined>
+  /** @deprecated Pass a source with its canonical jobs ref. */
+  jobs?: MaybeRefOrGetter<readonly JobStateInput[] | undefined>
+  /** @deprecated Pass source actions instead. */
+  adapter?: MaybeRefOrGetter<JobsStatusTrayAdapter | undefined>
+  /** @deprecated Event handling belongs to the source runtime. */
+  eventStream?: MaybeRefOrGetter<UsePluginEventStreamReturn<JobStreamData> | undefined>
   loadOnMount?: boolean
 }
 
+export interface UseJobsStatusTrayOptions extends UsePluginJobCenterOptions {}
+
+export interface JobStreamMessage {
+  event: string
+  data: JobStreamData
+}
+
 export interface UsePluginJobCenterReturn {
   jobs: ComputedRef<JobState[]>
   activeJobs: ComputedRef<JobState[]>
@@ -164,12 +191,30 @@ export interface UsePluginJobCenterReturn {
   close: () => void
   toggle: () => void
   refresh: () => Promise<boolean>
+  applyStreamMessage: (message: JobStreamMessage) => void
   cancelJob: (job: JobState) => Promise<boolean>
   deleteJob: (job: JobState) => Promise<boolean>
   clearFinished: () => Promise<boolean>
   isPending: (job: JobState) => boolean
 }
 
+export type UseJobsStatusTrayReturn = UsePluginJobCenterReturn
+
+interface LegacyJobsOverride {
+  readonly input: readonly JobStateInput[] | undefined
+  readonly jobs: JobState[]
+}
+
+function responseJobs(
+  response: JobListPayload | readonly JobStateInput[],
+): readonly JobStateInput[] {
+  return 'jobs' in response ? response.jobs : response
+}
+
+function isSnapshotPayload(data: JobStreamData): data is { jobs: JobStateInput[] } {
+  return 'jobs' in data && Array.isArray(data.jobs)
+}
+
 function errorMessage(error: unknown, fallback: string): string {
   return error instanceof Error ? error.message : fallback
 }
@@ -183,30 +228,84 @@ function errorMessage(error: unknown, fallback: string): string {
 export function usePluginJobCenter(
   options: UsePluginJobCenterOptions = {},
 ): UsePluginJobCenterReturn {
+  const legacyOverride = shallowRef<LegacyJobsOverride | null>(null)
   const isOpen = ref(false)
   const activeTab = ref<JobsStatusTrayTab>('active')
   const isLoading = ref(false)
   const error = shallowRef<string | null>(null)
   const pendingJobIds = ref(new Set<string>())
+  const jobRevisions = new Map<string, number>()
+  let stateRevision = 0
   let requestGeneration = 0
   let active = true
   const source = computed(() => toValue(options.source))
+  const adapter = computed(() => toValue(options.adapter))
 
-  const jobs = computed<JobState[]>(() => (
-    source.value ? [...toValue(source.value.jobs)].map(normalizeJobState) : []
-  ))
+  const jobs = computed<JobState[]>(() => {
+    const currentSource = source.value
+    if (currentSource) {
+      return [...toValue(currentSource.jobs)].map(normalizeJobState)
+    }
+    const input = toValue(options.jobs)
+    const override = legacyOverride.value
+    if (override && override.input === input) return override.jobs
+    return input ? [...input].map(normalizeJobState) : []
+  })
   const activeJobs = computed(() => jobs.value.filter(job => isActiveJobStatus(job.status)))
   const historyJobs = computed(() => jobs.value.filter(job => !isActiveJobStatus(job.status)))
   const deletableJobs = computed(() => historyJobs.value.filter(job => job.can_delete))
   const featuredJob = computed(() => activeJobs.value[0] ?? historyJobs.value[0] ?? null)
-  const canRefresh = computed(() => Boolean(source.value?.refreshJobs))
-  const canCancel = computed(() => Boolean(source.value?.cancelJob))
-  const canDelete = computed(() => Boolean(source.value?.deleteJob))
+  const canRefresh = computed(() => Boolean(source.value?.refreshJobs || adapter.value?.listJobs))
+  const canCancel = computed(() => Boolean(source.value?.cancelJob || adapter.value?.cancelJob))
+  const canDelete = computed(() => Boolean(source.value?.deleteJob || adapter.value?.deleteJob))
   const canClearFinished = computed(() => Boolean(
     source.value?.clearFinishedJobs
     || source.value?.deleteJob
+    || adapter.value?.clearFinishedJobs
+    || adapter.value?.deleteJob,
   ))
 
+  function bumpJobRevision(jobId: string): void {
+    jobRevisions.set(jobId, (jobRevisions.get(jobId) ?? 0) + 1)
+  }
+
+  function replaceLegacyJobs(nextJobs: readonly JobStateInput[]): void {
+    const normalized = nextJobs.map(normalizeJobState)
+    const touchedJobIds = new Set([
+      ...jobs.value.map(job => job.job_id),
+      ...normalized.map(job => job.job_id),
+    ])
+    touchedJobIds.forEach(bumpJobRevision)
+    legacyOverride.value = {
+      input: toValue(options.jobs),
+      jobs: normalized,
+    }
+    stateRevision += 1
+  }
+
+  function upsertLegacyJob(nextJob: JobStateInput): void {
+    const normalized = normalizeJobState(nextJob)
+    const existingIndex = jobs.value.findIndex(job => job.job_id === normalized.job_id)
+    const nextJobs = [...jobs.value]
+    if (existingIndex === -1) nextJobs.unshift(normalized)
+    else nextJobs[existingIndex] = normalized
+    legacyOverride.value = {
+      input: toValue(options.jobs),
+      jobs: nextJobs,
+    }
+    bumpJobRevision(normalized.job_id)
+    stateRevision += 1
+  }
+
+  function removeLegacyJobs(jobIds: Set<string>): void {
+    legacyOverride.value = {
+      input: toValue(options.jobs),
+      jobs: jobs.value.filter(job => !jobIds.has(job.job_id)),
+    }
+    jobIds.forEach(bumpJobRevision)
+    stateRevision += 1
+  }
+
   function setPending(jobId: string, pending: boolean): void {
     const next = new Set(pendingJobIds.value)
     if (pending) next.add(jobId)
@@ -214,15 +313,35 @@ export function usePluginJobCenter(
     pendingJobIds.value = next
   }
 
+  function applyStreamMessage(message: JobStreamMessage): void {
+    if (!active || source.value) return
+    if (message.event === 'snapshot' && isSnapshotPayload(message.data)) {
+      replaceLegacyJobs(message.data.jobs)
+      return
+    }
+    if (
+      (message.event === 'job' || message.event === 'terminal')
+      && !isSnapshotPayload(message.data)
+    ) {
+      upsertLegacyJob(message.data)
+    }
+  }
+
   async function refresh(): Promise<boolean> {
-    const refreshJobs = source.value?.refreshJobs
-    if (!refreshJobs) return false
+    const currentSource = source.value
+    const listJobs = currentSource?.refreshJobs ?? adapter.value?.listJobs
+    if (!listJobs) return false
     const generation = ++requestGeneration
+    const revision = stateRevision
     isLoading.value = true
     error.value = null
     try {
-      await refreshJobs()
-      return active && generation === requestGeneration
+      const response = await listJobs()
+      if (!active || generation !== requestGeneration || revision !== stateRevision) {
+        return false
+      }
+      if (!currentSource && response) replaceLegacyJobs(responseJobs(response))
+      return true
     } catch (cause) {
       if (active && generation === requestGeneration) {
         error.value = errorMessage(cause, 'Failed to load jobs')
@@ -235,14 +354,23 @@ export function usePluginJobCenter(
 
   async function cancelJob(job: JobState): Promise<boolean> {
     const sourceCancel = source.value?.cancelJob
-    if (!job.can_cancel || !sourceCancel || pendingJobIds.value.has(job.job_id)) {
+    const adapterCancel = adapter.value?.cancelJob
+    if (!job.can_cancel || (!sourceCancel && !adapterCancel) || pendingJobIds.value.has(job.job_id)) {
       return false
     }
+    const revision = jobRevisions.get(job.job_id) ?? 0
     setPending(job.job_id, true)
     error.value = null
     try {
-      await sourceCancel(job.job_id)
-      return active
+      const updated = sourceCancel
+        ? await sourceCancel(job.job_id)
+        : await adapterCancel!(job)
+      if (!active) return false
+      if (!sourceCancel && revision === (jobRevisions.get(job.job_id) ?? 0)) {
+        if (updated) upsertLegacyJob(updated)
+        else await refresh()
+      }
+      return true
     } catch (cause) {
       if (active) error.value = errorMessage(cause, 'Failed to cancel job')
       return false
@@ -253,14 +381,22 @@ export function usePluginJobCenter(
 
   async function deleteJob(job: JobState): Promise<boolean> {
     const sourceDelete = source.value?.deleteJob
-    if (!job.can_delete || !sourceDelete || pendingJobIds.value.has(job.job_id)) {
+    const adapterDelete = adapter.value?.deleteJob
+    if (!job.can_delete || (!sourceDelete && !adapterDelete) || pendingJobIds.value.has(job.job_id)) {
       return false
     }
     setPending(job.job_id, true)
     error.value = null
     try {
-      const deleted = await sourceDelete(job.job_id)
-      return active && deleted !== false
+      const deleted = sourceDelete
+        ? await sourceDelete(job.job_id)
+        : await adapterDelete!(job)
+      if (!active) return false
+      if (!sourceDelete) {
+        if (deleted === false) await refresh()
+        else removeLegacyJobs(new Set([job.job_id]))
+      }
+      return deleted !== false
     } catch (cause) {
       if (active) error.value = errorMessage(cause, 'Failed to delete job')
       return false
@@ -284,13 +420,36 @@ export function usePluginJobCenter(
         const results = await Promise.all(targets.map(job => deleteJob(job)))
         return results.every(Boolean)
       }
-      return false
+      const currentAdapter = adapter.value
+      if (currentAdapter?.clearFinishedJobs) {
+        const deleted = await currentAdapter.clearFinishedJobs(targets)
+        if (!active) return false
+        if (typeof deleted === 'number' && deleted !== targets.length) {
+          await refresh()
+          return false
+        }
+        removeLegacyJobs(new Set(targets.map(job => job.job_id)))
+        return true
+      }
+      if (!currentAdapter?.deleteJob) return false
+      const results = await Promise.all(targets.map(job => deleteJob(job)))
+      return results.every(Boolean)
     } catch (cause) {
       if (active) error.value = errorMessage(cause, 'Failed to clear jobs')
       return false
     }
   }
 
+  if (options.eventStream !== undefined) {
+    watch(
+      () => toValue(options.eventStream)?.lastMessage.value ?? null,
+      (message: PluginEventStreamMessage<JobStreamData> | null) => {
+        if (message) applyStreamMessage(message)
+      },
+      { immediate: true },
+    )
+  }
+
   onMounted(() => {
     if (options.loadOnMount !== false) void refresh()
   })
@@ -318,9 +477,17 @@ export function usePluginJobCenter(
     close: () => { isOpen.value = false },
     toggle: () => { isOpen.value = !isOpen.value },
     refresh,
+    applyStreamMessage,
     cancelJob,
     deleteJob,
     clearFinished,
     isPending: job => pendingJobIds.value.has(job.job_id),
   }
 }
+
+/** @deprecated Use `usePluginJobCenter()` for the plugin job-center controller. */
+export function useJobsStatusTray(
+  options: UseJobsStatusTrayOptions = {},
+): UseJobsStatusTrayReturn {
+  return usePluginJobCenter(options)
+}

package/src/composables/usePluginClient.ts

@@ -538,6 +538,11 @@ function normalizePluginSettingsOptions(options: UsePluginSettingsOptions | stri
   return typeof options === 'string' ? { pluginName: options } : options
 }
 
+/** @deprecated Use `useGeneratedPluginClient()` for generated clients. */
+export function usePluginClient<TClient>(client: TClient): TClient {
+  return client
+}
+
 const PLATFORM_OWNED_SETTINGS_KEY = 'allowed_experiment_types'
 
 function cloneRecord(value: Record<string, unknown>): Record<string, unknown> {

package/src/composables/usePluginConfig.ts

@@ -0,0 +1,250 @@
+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
+}
+
+/** @deprecated Use `usePluginSettings()` for typed plugin settings. */
+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,
+  }
+}

package/src/stores/auth.ts

@@ -58,6 +58,7 @@ export const useAuthStore = defineStore('mint-auth', () => {
     passkeyEnabled: false,
     passkeyRegistered: false,
     registrationEnabled: false,
+    databaseMode: 'none',
     experimentVisibilityMode: 'open',
   })
   const isInitialized = ref(false)

package/src/types/auth.ts

@@ -6,6 +6,7 @@ export interface AuthConfig {
   passkeyEnabled: boolean
   passkeyRegistered: boolean
   registrationEnabled: boolean
+  databaseMode: string
   experimentVisibilityMode?: 'open' | 'restricted'
 }