Skip to content

Modern Docker Management, Designed for Everyone

14.3 KB
Raw Blame
import type { User } from '#lib/types/auth.js';
import type { SearchPaginationSortRequest } from '#lib/types/shared.js';

function stableSerialize(value: unknown): string {
	if (value === null || value === undefined) return 'null';
	if (typeof value !== 'object') return JSON.stringify(value);
	if (Array.isArray(value)) return `[${value.map((entry) => stableSerialize(entry)).join(',')}]`;

	const entries = Object.entries(value as Record<string, unknown>)
		.filter(([, entry]) => entry !== undefined)
		.sort(([a], [b]) => a.localeCompare(b));

	return `{${entries.map(([key, entry]) => `${JSON.stringify(key)}:${stableSerialize(entry)}`).join(',')}}`;
}

export const queryKeys = {
	swarm: {
		info: (environmentId: string) => ['swarm', environmentId, 'info'] as const,
		status: (environmentId: string) => ['swarm', environmentId, 'status'] as const,
		joinTokens: (environmentId: string) => ['swarm', environmentId, 'join-tokens'] as const,
		unlockKey: (environmentId: string) => ['swarm', environmentId, 'unlock-key'] as const,
		joinCandidates: (environmentId: string | null, user: Pick<User, 'id' | 'permissionsByEnv'> | null) =>
			['swarm', environmentId, 'join-candidates', user?.id ?? null, stableSerialize(user?.permissionsByEnv)] as const,
		serviceTasks: (environmentId: string, serviceId: string) => ['swarm', environmentId, 'service-tasks', serviceId] as const
	},
	podman: {
		environment: (environmentId: string) => ['podman', environmentId] as const,
		status: (environmentId: string) => ['podman', environmentId, 'status'] as const,
		pods: (scope: string, options: SearchPaginationSortRequest) => ['podman-pods', scope, stableSerialize(options)] as const,
		quadlets: (scope: string, options: SearchPaginationSortRequest) =>
			['podman-quadlets', scope, stableSerialize(options)] as const,
		secrets: (scope: string, options: SearchPaginationSortRequest) =>
			['podman-secrets', scope, stableSerialize(options)] as const,
		pod: (environmentId: string, podId: string) => ['podman', environmentId, 'pods', podId] as const,
		podStats: (environmentId: string, podName: string) => ['podman', environmentId, 'pods', podName, 'stats'] as const,
		podTop: (environmentId: string, podId: string) => ['podman', environmentId, 'pods', podId, 'top'] as const,
		quadlet: (environmentId: string, name: string) => ['podman', environmentId, 'quadlets', name] as const,
		quadletFile: (environmentId: string, name: string) => ['podman', environmentId, 'quadlets', name, 'file'] as const
	},
	jobs: {
		list: (environmentId: string) => ['environment-jobs', environmentId] as const,
		runs: (environmentId: string, jobId: string, page: number) => ['job-runs', environmentId, jobId, page] as const,
		run: (environmentId: string, jobId: string, runId: string | undefined) => ['job-run', environmentId, jobId, runId] as const
	},
	backupActivities: {
		active: (environmentId: string, resourceKey: string, discoverFromHistory: boolean) =>
			['backup-activities', environmentId, resourceKey, discoverFromHistory] as const
	},
	auth: {
		all: ['auth'] as const,
		logout: () => ['auth', 'logout'] as const,
		currentUser: () => ['auth', 'current-user'] as const,
		autoLoginConfig: () => ['auth', 'auto-login-config'] as const,
		autoLoginAttempt: () => ['auth', 'auto-login-attempt'] as const
	},
	settings: {
		all: ['settings'] as const,
		global: () => ['settings', 'global'] as const,
		byEnvironment: (environmentId: string) => ['settings', environmentId] as const,
		public: (environmentId: string) => ['settings', 'public', environmentId] as const
	},
	roles: {
		all: () => ['roles', 'all'] as const,
		list: (options: SearchPaginationSortRequest) => ['roles', 'list', stableSerialize(options)] as const,
		detail: (roleId: string) => ['roles', 'detail', roleId] as const,
		permissionsManifest: () => ['roles', 'permissions-manifest'] as const
	},
	users: {
		all: ['users'] as const,
		list: (options: SearchPaginationSortRequest) => ['users', stableSerialize(options)] as const
	},
	apiKeys: {
		all: ['api-keys'] as const,
		list: (options: SearchPaginationSortRequest) => ['api-keys', stableSerialize(options)] as const
	},
	federatedCredentials: {
		all: ['federated-credentials'] as const,
		list: (options: SearchPaginationSortRequest) => ['federated-credentials', stableSerialize(options)] as const
	},
	environments: {
		all: ['environments'] as const,
		list: (options: SearchPaginationSortRequest) => ['environments', stableSerialize(options)] as const,
		switcher: (options: SearchPaginationSortRequest) => ['environments', 'switcher', stableSerialize(options)] as const,
		detail: (environmentId: string) => ['environment', environmentId] as const,
		settings: (environmentId: string) => ['environment-settings', environmentId] as const,
		deploymentSnippets: (environmentId: string) => ['environment', 'deployment-snippets', environmentId] as const
	},
	gitRepositories: {
		all: ['git-repositories'] as const,
		list: (options: SearchPaginationSortRequest) => ['git-repositories', stableSerialize(options)] as const,
		syncDialog: () => ['git-repositories', 'sync-dialog'] as const,
		branches: (repositoryId: string) => ['git-repositories', 'branches', repositoryId] as const,
		files: (repositoryId: string, branch: string, path: string) => ['git-repository-files', repositoryId, branch, path] as const
	},
	containerRegistries: {
		all: ['container-registries'] as const,
		list: (options: SearchPaginationSortRequest) => ['container-registries', stableSerialize(options)] as const,
		pullUsage: () => ['container-registries', 'pull-usage'] as const,
		detail: (registryId: string) => ['container-registries', 'detail', registryId] as const,
		repositoriesPrefix: (registryId: string) => ['container-registries', 'repositories', registryId] as const,
		repositories: (registryId: string, options: SearchPaginationSortRequest) =>
			['container-registries', 'repositories', registryId, stableSerialize(options)] as const,
		tagsPrefix: (registryId: string, repository: string) => ['container-registries', 'tags', registryId, repository] as const,
		tags: (registryId: string, repository: string, options: SearchPaginationSortRequest) =>
			['container-registries', 'tags', registryId, repository, stableSerialize(options)] as const
	},
	templates: {
		all: ['templates'] as const,
		allTemplates: () => ['templates', 'all'] as const,
		defaults: () => ['templates', 'defaults'] as const,
		list: (options: SearchPaginationSortRequest) => ['templates', stableSerialize(options)] as const,
		content: (templateId: string) => ['template-content', templateId] as const,
		registries: () => ['template-registries'] as const
	},
	variables: {
		all: ['variables'] as const,
		list: () => ['variables', 'list'] as const
	},
	notifications: {
		settings: () => ['notification-settings'] as const
	},
	events: {
		all: ['events'] as const,
		listGlobal: (options: SearchPaginationSortRequest) => ['events', 'global', stableSerialize(options)] as const,
		statsGlobal: () => ['events', 'stats', 'global'] as const,
		deleteSelectedGlobal: () => ['events', 'delete-selected', 'global'] as const
	},
	system: {
		appVersion: () => ['system', 'app-version'] as const,
		upgradeAvailable: (scope: 'mobile-nav' | 'sidebar') => ['system', 'upgrade-available', scope] as const,
		environmentUpgradeAvailable: (environmentId: string) =>
			['system', 'upgrade-available', 'environment', environmentId] as const,
		upgradeHealth: (environmentId: string) => ['system', 'upgrade-health', environmentId] as const,
		versionInfo: (environmentId: string) => ['system', 'version-info', environmentId] as const,
		dockerInfo: (environmentId: string) => ['system', 'docker-info', environmentId] as const
	},
	containers: {
		all: ['containers'] as const,
		listPrefix: (scope: string) => ['containers', scope] as const,
		list: (environmentId: string, options: SearchPaginationSortRequest) =>
			['containers', environmentId, stableSerialize(options)] as const,
		create: (environmentId: string) => ['containers', 'create', environmentId] as const,
		statusCounts: (environmentId: string) => ['containers', 'status-counts', environmentId] as const,
		environment: (environmentId: string) => ['container', environmentId] as const,
		detail: (environmentId: string, containerId: string) => ['container', environmentId, containerId] as const,
		editConfig: (environmentId: string, containerId: string) => ['container', environmentId, containerId, 'edit-config'] as const,
		processes: (environmentId: string, containerId: string) => ['container', environmentId, containerId, 'processes'] as const
	},
	images: {
		all: ['images'] as const,
		listPrefix: (scope: string) => ['images', scope] as const,
		list: (environmentId: string, options: SearchPaginationSortRequest) =>
			['images', environmentId, stableSerialize(options)] as const,
		usageCounts: (environmentId: string) => ['images', 'usage-counts', environmentId] as const,
		uploadLimit: (environmentId: string) => ['images', 'upload-limit', environmentId] as const,
		environment: (environmentId: string) => ['image', environmentId] as const,
		history: (environmentId: string, imageId: string) => ['image', environmentId, imageId, 'history'] as const,
		detail: (environmentId: string, imageId: string) => ['image', environmentId, imageId] as const,
		updateCheck: (environmentId: string, imageId: string) => ['image-update', environmentId, imageId] as const,
		builds: (environmentId: string) => ['images', environmentId, 'builds'] as const,
		buildsList: (environmentId: string, options: SearchPaginationSortRequest) =>
			['images', environmentId, 'builds', stableSerialize(options)] as const,
		buildRecord: (environmentId: string, buildId: string) => ['images', environmentId, 'builds', buildId] as const,
		buildRun: (environmentId: string) => ['images', environmentId, 'build-run'] as const
	},
	projects: {
		all: ['projects'] as const,
		environment: (environmentId: string) => ['project', environmentId] as const,
		listPrefix: (scope: string) => ['projects', scope] as const,
		list: (environmentId: string, options: SearchPaginationSortRequest) =>
			['projects', environmentId, stableSerialize(options)] as const,
		checkUpdates: (environmentId: string) => ['projects', 'check-updates', environmentId] as const,
		detailCheckUpdates: (environmentId: string, projectId: string) =>
			['project', 'check-updates', environmentId, projectId] as const,
		statusCounts: (environmentId: string) => ['projects', 'status-counts', environmentId] as const,
		tags: (environmentId: string) => ['projects', 'tags', environmentId] as const,
		detail: (environmentId: string, projectId: string) => ['project', environmentId, projectId] as const,
		workspace: (environmentId: string, projectId: string) => ['project', environmentId, projectId, 'workspace'] as const,
		workspaceFile: (environmentId: string, projectId: string, relativePath: string) =>
			['project', environmentId, projectId, 'workspace-file', relativePath] as const
	},
	networks: {
		all: ['networks'] as const,
		list: (environmentId: string, options: SearchPaginationSortRequest) =>
			['networks', environmentId, stableSerialize(options)] as const,
		detail: (environmentId: string, networkId: string) => ['network', environmentId, networkId] as const,
		topology: (environmentId: string) => ['networks', environmentId, 'topology'] as const
	},
	ports: {
		all: ['ports'] as const,
		list: (environmentId: string, options: SearchPaginationSortRequest) =>
			['ports', environmentId, stableSerialize(options)] as const
	},
	gitOpsSyncs: {
		all: ['gitops-syncs'] as const,
		list: (environmentId: string, options: SearchPaginationSortRequest) =>
			['gitops-syncs', environmentId, stableSerialize(options)] as const,
		detail: (environmentId: string, syncId: string) => ['gitops-syncs', environmentId, syncId] as const,
		projectBackup: (environmentId: string, projectId: string) =>
			['gitops-syncs', environmentId, 'project-backup', projectId] as const,
		backupPreview: (environmentId: string, syncId: string) => ['gitops-syncs', environmentId, syncId, 'backup-preview'] as const,
		backupHistory: (environmentId: string, syncId: string, limit?: number) =>
			['gitops-syncs', environmentId, syncId, 'backup-history', limit ?? 'all'] as const,
		backupRevision: (environmentId: string, syncId: string, commit: string) =>
			['gitops-syncs', environmentId, syncId, 'backup-revision', commit] as const
	},
	volumes: {
		sizes: (environmentId: string) => ['volume-sizes', environmentId] as const,
		backupVolumeNames: (scope: string) => ['volume-backup-names', scope] as const,
		table: (environmentId: string, options: SearchPaginationSortRequest) =>
			['volumes', environmentId, stableSerialize(options)] as const,
		detail: (environmentId: string, volumeName: string) => ['volume', environmentId, volumeName] as const,
		workspace: (environmentId: string, volumeName: string) => ['volume', environmentId, volumeName, 'workspace'] as const,
		workspaceFile: (environmentId: string, volumeName: string, relativePath: string) =>
			['volume', environmentId, volumeName, 'workspace-file', relativePath] as const,
		backups: (volumeName: string) => ['volume-backups', volumeName] as const,
		backupHasPath: (environmentId: string, volumeName: string, backupId: string, path: string) =>
			['volume-backups', environmentId, volumeName, backupId, 'has-path', path] as const
	},
	vulnerabilities: {
		overviewByEnvironment: (environmentId: string) => ['vulnerabilities', 'overview', environmentId] as const,
		scanSummaries: (scope: string, imageKeys: string[]) => ['vulnerabilities', 'scan-summaries', scope, ...imageKeys] as const,
		scanResult: (environmentId: string, imageId: string) => ['vulnerabilities', 'scan-result', environmentId, imageId] as const,
		allByEnvironment: (environmentId: string, request: SearchPaginationSortRequest) =>
			['vulnerabilities', 'all', environmentId, stableSerialize(request)] as const,
		imageRows: (environmentId: string, imageId: string, request: SearchPaginationSortRequest) =>
			['vulnerabilities', 'image', environmentId, imageId, stableSerialize(request)] as const
	},
	buildWorkspace: {
		all: ['build-workspace'] as const,
		listPrefix: (environmentId: string) => ['build-workspace', environmentId, 'list'] as const,
		list: (environmentId: string, path: string) => ['build-workspace', environmentId, 'list', path] as const,
		contentPrefix: (environmentId: string) => ['build-workspace', environmentId, 'content'] as const,
		content: (environmentId: string, path: string) => ['build-workspace', environmentId, 'content', path] as const
	}
} as const;