@prefecthq/prefect-ui-library 3.11.13 → 3.11.14

package/dist/types/src/compositions/index.d.ts

@@ -54,6 +54,7 @@ export * from './useTaskRunsHistory';
 export * from './useThemeTokens';
 export * from './useVariable';
 export * from './useVariables';
+export * from './useWorker';
 export * from './useWorkPool';
 export * from './useWorkPoolById';
 export * from './useWorkPoolLastPolled';

package/dist/types/src/compositions/useWorker.d.ts

@@ -0,0 +1,5 @@
+import { MaybeRefOrGetter } from 'vue';
+import { WorkspaceWorkPoolWorkersApi } from '../services';
+import { UseEntitySubscription } from '../types/useEntitySubscription';
+export type UseWorker = UseEntitySubscription<WorkspaceWorkPoolWorkersApi['getWorker'], 'worker'>;
+export declare function useWorker(workPoolName: MaybeRefOrGetter<string | null | undefined>, workerId: MaybeRefOrGetter<string | null | undefined>): UseWorker;

package/dist/types/src/services/WorkspaceWorkPoolWorkersApi.d.ts

@@ -9,5 +9,6 @@ export declare class WorkspaceWorkPoolWorkersApi extends WorkspaceApi {
     protected routePrefix: string;
     getWorkers(workPoolName: string, filter?: WorkPoolWorkersFilter): Promise<WorkPoolWorker[]>;
     getWorkersPaginated(workPoolName: string, filter?: WorkPoolWorkersPagination): Promise<PaginatedWorkPoolWorkers>;
+    getWorker(workPoolName: string, workerId: string): Promise<WorkPoolWorker>;
     deleteWorker(arg: WorkerDeleteArg): Promise<void>;
 }

package/dist/types/src/services/can.d.ts

@@ -2,7 +2,7 @@ import { InjectionKey } from 'vue';
 import { MaybeRef } from '../types/reactivity';
 export declare const workspaceFeatureFlags: readonly ["access:deploymentScheduleFlowRunInfraOverrides"];
 export type WorkspaceFeatureFlag = typeof workspaceFeatureFlags[number];
-export declare const workspacePermissions: readonly ["create:artifact", "create:automation", "create:block", "create:concurrency_limit", "create:deployment", "create:flow_run", "create:flow", "create:log", "create:notification_policy", "create:saved_search", "create:task_run", "create:variable", "create:work_queue", "create:work_pool_queue", "create:work_pool", "create:workspace_bot_access", "create:workspace_user_access", "delete:artifact", "delete:automation", "delete:block", "delete:concurrency_limit", "delete:deployment", "delete:flow_run", "delete:flow", "delete:notification_policy", "delete:saved_search", "delete:task_run", "delete:work_queue", "delete:work_pool_queue", "delete:work_pool", "delete:workspace_bot_access", "delete:workspace_user_access", "delete:variable", "read:artifact", "read:automation", "read:block", "read:concurrency_limit", "read:deployment", "read:flow_run", "read:flow", "read:log", "read:notification_policy", "read:saved_search", "read:task_run", "read:variable", "read:work_queue", "read:work_pool_queue", "read:work_pool", "read:workspace_bot_access", "read:workspace_settings", "read:workspace_user_access", "run:deployment", "update:automation", "update:block", "update:concurrency_limit", "update:deployment", "update:flow_run", "update:flow", "update:notification_policy", "update:task_run", "update:variable", "update:work_queue", "update:work_pool_queue", "update:work_pool", "update:workspace_bot_access", "update:workspace_settings", "update:workspace_user_access", "update:workspace"];
+export declare const workspacePermissions: readonly ["create:artifact", "create:automation", "create:block", "create:concurrency_limit", "create:deployment", "create:flow_run", "create:flow", "create:log", "create:notification_policy", "create:saved_search", "create:task_run", "create:variable", "create:work_queue", "create:work_pool_queue", "create:work_pool", "create:workspace_bot_access", "create:workspace_user_access", "delete:artifact", "delete:automation", "delete:block", "delete:concurrency_limit", "delete:deployment", "delete:flow_run", "delete:flow", "delete:notification_policy", "delete:saved_search", "delete:task_run", "delete:work_queue", "delete:work_pool_queue", "delete:work_pool", "delete:worker", "delete:workspace_bot_access", "delete:workspace_user_access", "delete:variable", "read:artifact", "read:automation", "read:block", "read:concurrency_limit", "read:deployment", "read:flow_run", "read:flow", "read:log", "read:notification_policy", "read:saved_search", "read:task_run", "read:variable", "read:work_queue", "read:work_pool_queue", "read:work_pool", "read:worker", "read:workspace_bot_access", "read:workspace_settings", "read:workspace_user_access", "run:deployment", "update:automation", "update:block", "update:concurrency_limit", "update:deployment", "update:flow_run", "update:flow", "update:notification_policy", "update:task_run", "update:variable", "update:work_queue", "update:work_pool_queue", "update:work_pool", "update:workspace_bot_access", "update:workspace_settings", "update:workspace_user_access", "update:workspace"];
 export type WorkspacePermission = typeof workspacePermissions[number];
 export type PermissionValue = boolean | undefined;
 export type PermissionVerb<T extends string> = T extends `${infer Action}:${string}` ? Action : never;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@prefecthq/prefect-ui-library",
-    "version": "3.11.13",
+    "version": "3.11.14",
     "private": false,
     "repository": {
         "type": "git",

package/src/compositions/index.ts

@@ -54,6 +54,7 @@ export * from './useTaskRunsHistory'
 export * from './useThemeTokens'
 export * from './useVariable'
 export * from './useVariables'
+export * from './useWorker'
 export * from './useWorkPool'
 export * from './useWorkPoolById'
 export * from './useWorkPoolLastPolled'

package/src/compositions/useWorker.ts

@@ -0,0 +1,39 @@
+import { useSubscriptionWithDependencies } from '@prefecthq/vue-compositions'
+import { computed, MaybeRefOrGetter, toRef, toValue } from 'vue'
+import { useCan } from '@/compositions/useCan'
+import { useWorkspaceApi } from '@/compositions/useWorkspaceApi'
+import { WorkspaceWorkPoolWorkersApi } from '@/services'
+import { Getter } from '@/types/reactivity'
+import { UseEntitySubscription } from '@/types/useEntitySubscription'
+
+export type UseWorker = UseEntitySubscription<WorkspaceWorkPoolWorkersApi['getWorker'], 'worker'>
+
+export function useWorker(workPoolName: MaybeRefOrGetter<string | null | undefined>, workerId: MaybeRefOrGetter<string | null | undefined>): UseWorker {
+  const api = useWorkspaceApi()
+  const can = useCan()
+
+  const getter: Getter<[string, string] | null> = () => {
+    if (!can.read.worker) {
+      return null
+    }
+
+    const name = toValue(workPoolName)
+    const id = toValue(workerId)
+
+    if (!name || !id) {
+      return null
+    }
+
+    return [name, id]
+  }
+
+  const parameters = toRef(getter)
+
+  const subscription = useSubscriptionWithDependencies(api.workPoolWorkers.getWorker, parameters)
+  const worker = computed(() => subscription.response)
+
+  return {
+    subscription,
+    worker,
+  }
+}

package/src/models/api/Filters.ts

@@ -1,4 +1,3 @@
-import { ServerWorkPoolWorkerStatus } from '@/models/WorkPoolWorkerStatus'
 import { ArtifactSortValues, DeploymentSortValues, FlowRunSortValues, FlowSortValues, LogSortValues, TaskRunSortValues, VariableSortValues, WorkPoolWorkerSortValues } from '@/types/SortOptionTypes'
 
 /** A list where results will be returned only if they match all the values in the list */

package/src/services/WorkspaceWorkPoolWorkersApi.ts

@@ -26,6 +26,13 @@ export class WorkspaceWorkPoolWorkersApi extends WorkspaceApi {
     return mapper.map('WorkPoolWorkersPaginationResponse', data, 'PaginatedWorkPoolWorkers')
   }
 
+  public async getWorker(workPoolName: string, workerId: string): Promise<WorkPoolWorker> {
+    const encodedWorkPoolName = encodeURI(workPoolName)
+    const { data } = await this.get<WorkPoolWorkerResponse>(`/${encodedWorkPoolName}/workers/${workerId}`)
+
+    return mapper.map('WorkPoolWorkerResponse', data, 'WorkPoolWorker')
+  }
+
   public deleteWorker(arg: WorkerDeleteArg): Promise<void> {
     const encodedWorkPoolName = encodeURI(arg.workPoolName)
     const encodedWorkerName = encodeURI(arg.workerName)

package/src/services/can.ts

@@ -36,6 +36,7 @@ export const workspacePermissions = [
   'delete:work_queue',
   'delete:work_pool_queue',
   'delete:work_pool',
+  'delete:worker',
   'delete:workspace_bot_access',
   'delete:workspace_user_access',
   'delete:variable',
@@ -54,6 +55,7 @@ export const workspacePermissions = [
   'read:work_queue',
   'read:work_pool_queue',
   'read:work_pool',
+  'read:worker',
   'read:workspace_bot_access',
   'read:workspace_settings',
   'read:workspace_user_access',