Files
simstudioai--sim/apps/sim/hooks/queries/api-keys.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

174 lines
4.7 KiB
TypeScript

import { keepPreviousData, useMutation, useQuery, useQueryClient } from '@tanstack/react-query'
import { requestJson } from '@/lib/api/client/request'
import type { ContractBodyInput } from '@/lib/api/contracts'
import {
type ApiKey,
createPersonalApiKeyContract,
createWorkspaceApiKeyContract,
deletePersonalApiKeyContract,
deleteWorkspaceApiKeyContract,
listPersonalApiKeysContract,
listWorkspaceApiKeysContract,
updateWorkspaceContract,
} from '@/lib/api/contracts'
import { workspaceKeys } from '@/hooks/queries/workspace'
export type { ApiKey }
/**
* Query key factories for API keys-related queries
*/
export const apiKeysKeys = {
all: ['apiKeys'] as const,
workspaces: () => [...apiKeysKeys.all, 'workspace'] as const,
workspace: (workspaceId: string) => [...apiKeysKeys.workspaces(), workspaceId] as const,
personal: () => [...apiKeysKeys.all, 'personal'] as const,
combineds: () => [...apiKeysKeys.all, 'combined'] as const,
combined: (workspaceId: string) => [...apiKeysKeys.combineds(), workspaceId] as const,
}
export const API_KEYS_COMBINED_STALE_TIME = 60 * 1000
type CombinedApiKeysData = {
workspaceKeys: ApiKey[]
personalKeys: ApiKey[]
conflicts: string[]
}
/**
* Fetch both workspace and personal API keys
*/
async function fetchApiKeys(
workspaceId: string,
signal?: AbortSignal
): Promise<CombinedApiKeysData> {
const [workspaceData, personalData] = await Promise.all([
requestJson(listWorkspaceApiKeysContract, { params: { id: workspaceId }, signal }),
requestJson(listPersonalApiKeysContract, { signal }),
])
const workspaceKeys: ApiKey[] = workspaceData.keys
const personalKeys: ApiKey[] = personalData.keys
const workspaceKeyNames = new Set(workspaceKeys.map((k) => k.name))
const conflicts = personalKeys
.filter((key) => workspaceKeyNames.has(key.name))
.map((key) => key.name)
return {
workspaceKeys,
personalKeys,
conflicts,
}
}
/**
* Hook to fetch API keys (both workspace and personal)
*/
export function useApiKeys(workspaceId: string) {
return useQuery({
queryKey: apiKeysKeys.combined(workspaceId),
queryFn: ({ signal }) => fetchApiKeys(workspaceId, signal),
enabled: !!workspaceId,
staleTime: API_KEYS_COMBINED_STALE_TIME,
placeholderData: keepPreviousData,
})
}
/**
* Create API key mutation params
*/
type CreateApiKeyParams = {
workspaceId: string
keyType: 'personal' | 'workspace'
} & ContractBodyInput<typeof createWorkspaceApiKeyContract>
/**
* Hook to create a new API key
*/
export function useCreateApiKey() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async ({ workspaceId, name, keyType, source }: CreateApiKeyParams) => {
if (keyType === 'workspace') {
return requestJson(createWorkspaceApiKeyContract, {
params: { id: workspaceId },
body: { name, source },
})
}
return requestJson(createPersonalApiKeyContract, { body: { name } })
},
onSettled: (_data, _error, variables) => {
return queryClient.invalidateQueries({
queryKey: apiKeysKeys.combined(variables.workspaceId),
})
},
})
}
/**
* Delete API key mutation params
*/
type DeleteApiKeyParams = {
workspaceId: string
keyId: string
keyType: 'personal' | 'workspace'
}
/**
* Hook to delete an API key
*/
export function useDeleteApiKey() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async ({ workspaceId, keyId, keyType }: DeleteApiKeyParams) => {
if (keyType === 'workspace') {
return requestJson(deleteWorkspaceApiKeyContract, {
params: { id: workspaceId, keyId },
})
}
return requestJson(deletePersonalApiKeyContract, { params: { id: keyId } })
},
onSettled: (_data, _error, variables) => {
return queryClient.invalidateQueries({
queryKey: apiKeysKeys.combined(variables.workspaceId),
})
},
})
}
/**
* Update workspace API key settings mutation params
*/
type UpdateWorkspaceApiKeySettingsParams = { workspaceId: string } & Pick<
ContractBodyInput<typeof updateWorkspaceContract>,
'allowPersonalApiKeys'
>
/**
* Hook to update workspace API key settings
*/
export function useUpdateWorkspaceApiKeySettings() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async ({
workspaceId,
allowPersonalApiKeys,
}: UpdateWorkspaceApiKeySettingsParams) => {
return requestJson(updateWorkspaceContract, {
params: { id: workspaceId },
body: { allowPersonalApiKeys },
})
},
onSettled: (_data, _error, variables) => {
return queryClient.invalidateQueries({
queryKey: workspaceKeys.settings(variables.workspaceId),
})
},
})
}