Files
simstudioai--sim/apps/sim/hooks/queries/environment.ts
T
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

130 lines
4.1 KiB
TypeScript

import { createLogger } from '@sim/logger'
import { keepPreviousData, useMutation, useQuery, useQueryClient } from '@tanstack/react-query'
import { requestJson } from '@/lib/api/client/request'
import {
type ContractBodyInput,
removeWorkspaceEnvironmentContract,
savePersonalEnvironmentContract,
upsertWorkspaceEnvironmentContract,
} from '@/lib/api/contracts'
import type { WorkspaceEnvironmentData } from '@/lib/environment/api'
import { fetchPersonalEnvironment, fetchWorkspaceEnvironment } from '@/lib/environment/api'
const logger = createLogger('EnvironmentQueries')
/**
* Query key factories for environment variable queries
*/
export const PERSONAL_ENVIRONMENT_STALE_TIME = 60 * 1000
export const WORKSPACE_ENVIRONMENT_STALE_TIME = 60 * 1000
export const environmentKeys = {
all: ['environment'] as const,
personal: () => [...environmentKeys.all, 'personal'] as const,
workspaces: () => [...environmentKeys.all, 'workspace'] as const,
workspace: (workspaceId: string) => [...environmentKeys.workspaces(), workspaceId] as const,
}
/**
* Hook to fetch personal environment variables
*/
export function usePersonalEnvironment() {
return useQuery({
queryKey: environmentKeys.personal(),
queryFn: ({ signal }) => fetchPersonalEnvironment(signal),
staleTime: PERSONAL_ENVIRONMENT_STALE_TIME,
})
}
/**
* Hook to fetch workspace environment variables
*/
export function useWorkspaceEnvironment<TData = WorkspaceEnvironmentData>(
workspaceId: string,
options?: { select?: (data: WorkspaceEnvironmentData) => TData }
) {
return useQuery({
queryKey: environmentKeys.workspace(workspaceId),
queryFn: ({ signal }) => fetchWorkspaceEnvironment(workspaceId, signal),
enabled: !!workspaceId,
staleTime: WORKSPACE_ENVIRONMENT_STALE_TIME,
placeholderData: keepPreviousData,
...options,
})
}
/**
* Save personal environment variables mutation
*/
type SavePersonalEnvironmentParams = ContractBodyInput<typeof savePersonalEnvironmentContract>
export function useSavePersonalEnvironment() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async ({ variables }: SavePersonalEnvironmentParams) => {
await requestJson(savePersonalEnvironmentContract, { body: { variables } })
logger.info('Saved personal environment variables')
},
onSettled: async () => {
await Promise.all([
queryClient.invalidateQueries({ queryKey: environmentKeys.personal() }),
queryClient.invalidateQueries({ queryKey: environmentKeys.workspaces() }),
])
},
})
}
/**
* Upsert workspace environment variables mutation
*/
type UpsertWorkspaceEnvironmentParams = { workspaceId: string } & ContractBodyInput<
typeof upsertWorkspaceEnvironmentContract
>
export function useUpsertWorkspaceEnvironment() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async ({ workspaceId, variables }: UpsertWorkspaceEnvironmentParams) => {
const data = await requestJson(upsertWorkspaceEnvironmentContract, {
params: { id: workspaceId },
body: { variables },
})
logger.info(`Upserted workspace environment variables for workspace: ${workspaceId}`)
return data
},
onSettled: (_data, _error, variables) =>
queryClient.invalidateQueries({
queryKey: environmentKeys.workspace(variables.workspaceId),
}),
})
}
/**
* Remove workspace environment variables mutation
*/
type RemoveWorkspaceEnvironmentParams = { workspaceId: string } & ContractBodyInput<
typeof removeWorkspaceEnvironmentContract
>
export function useRemoveWorkspaceEnvironment() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async ({ workspaceId, keys }: RemoveWorkspaceEnvironmentParams) => {
const data = await requestJson(removeWorkspaceEnvironmentContract, {
params: { id: workspaceId },
body: { keys },
})
logger.info(`Removed ${keys.length} workspace environment keys for workspace: ${workspaceId}`)
return data
},
onSettled: (_data, _error, variables) =>
queryClient.invalidateQueries({
queryKey: environmentKeys.workspace(variables.workspaceId),
}),
})
}