@prefecthq/prefect-ui-library 3.5.8 → 3.5.10

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

@@ -1,4 +1,5 @@
 import { AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from 'axios';
+import { MaybeGetter } from '../types';
 import { MaybeArray } from '../types/utilities';
 export type AxiosInstanceSetupHook = (instance: AxiosInstance) => void;
 export type PrefectConfig = {
@@ -12,12 +13,13 @@ export declare const getPrefectBaseUrl: ApiBaseUrl;
 export declare const getPrefectUIHeaders: RawAxiosRequestHeaders;
 export declare const getAuthorizationHeaders: ApiHeaders;
 export declare class Api<T extends PrefectConfig = PrefectConfig> {
-    protected readonly apiConfig: T;
+    protected readonly apiConfig: MaybeGetter<T>;
     protected apiHeaders: MaybeArray<ApiHeaders>;
     protected apiBaseUrl: ApiBaseUrl;
     protected routePrefix: string | undefined;
     protected instanceSetupHook: AxiosInstanceSetupHook | null;
-    constructor(apiConfig: T, instanceSetupHook?: AxiosInstanceSetupHook | null);
+    constructor(apiConfig: MaybeGetter<T>, instanceSetupHook?: AxiosInstanceSetupHook | null);
+    protected getConfig(): T;
     protected composeBaseUrl(): string;
     protected composeHeaders(): RawAxiosRequestHeaders;
     protected combinePath(route: string | undefined): string;

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

@@ -27,5 +27,5 @@ export declare class WorkspaceFlowRunsApi extends WorkspaceApi {
     resumeFlowRun(id: string, values?: SchemaValues): Promise<OrchestrationResult>;
     resumeFlowRunV2(id: string, values: SchemaValuesV2): Promise<OrchestrationResult>;
     deleteFlowRun(flowRunId: string): Promise<void>;
-    downloadFlowRunLogsCsv(flowRunId: string, flowRunName: string | null): Promise<void>;
+    downloadFlowRunLogs(flowRunId: string, flowRunName: string | null): Promise<void>;
 }

package/package.json

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

package/src/components/FlowRunLogsDownloadButton.vue

@@ -21,7 +21,7 @@
     loading.value = true
 
     try {
-      await api.flowRuns.downloadFlowRunLogsCsv(flowRun.id, flowRun.name)
+      await api.flowRuns.downloadFlowRunLogs(flowRun.id, flowRun.name)
     } catch (error) {
       console.error(error)
 

package/src/services/Api.ts

@@ -1,5 +1,6 @@
 import { asArray } from '@prefecthq/prefect-design'
 import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from 'axios'
+import { MaybeGetter } from '@/types'
 import { MaybeArray } from '@/types/utilities'
 import { isDefined } from '@/utilities/variables'
 
@@ -29,30 +30,38 @@ export const getAuthorizationHeaders: ApiHeaders = (config) => {
 }
 
 export class Api<T extends PrefectConfig = PrefectConfig> {
-  protected readonly apiConfig: T
+  protected readonly apiConfig: MaybeGetter<T>
   protected apiHeaders: MaybeArray<ApiHeaders> = [getPrefectUIHeaders, getAuthorizationHeaders]
   protected apiBaseUrl: ApiBaseUrl = getPrefectBaseUrl
   protected routePrefix: string | undefined
   protected instanceSetupHook: AxiosInstanceSetupHook | null
 
-  public constructor(apiConfig: T, instanceSetupHook: AxiosInstanceSetupHook | null = null) {
+  public constructor(apiConfig: MaybeGetter<T>, instanceSetupHook: AxiosInstanceSetupHook | null = null) {
     this.apiConfig = apiConfig
     this.instanceSetupHook = instanceSetupHook
   }
 
+  protected getConfig(): T {
+    if (typeof this.apiConfig === 'function') {
+      return this.apiConfig()
+    }
+
+    return this.apiConfig
+  }
+
   protected composeBaseUrl(): string {
     if (typeof this.apiBaseUrl === 'string') {
       return this.apiBaseUrl
     }
 
-    return this.apiBaseUrl(this.apiConfig)
+    return this.apiBaseUrl(this.getConfig())
   }
 
   protected composeHeaders(): RawAxiosRequestHeaders {
     const array = asArray(this.apiHeaders)
 
     return array.reduce<RawAxiosRequestHeaders>((headers, header) => {
-      const value = typeof header === 'function' ? header(this.apiConfig) : header
+      const value = typeof header === 'function' ? header(this.getConfig()) : header
 
       return {
         ...headers,

package/src/services/WorkspaceFlowRunsApi.ts

@@ -146,8 +146,8 @@ export class WorkspaceFlowRunsApi extends WorkspaceApi {
     return this.delete(`/${flowRunId}`)
   }
 
-  public async downloadFlowRunLogsCsv(flowRunId: string, flowRunName: string | null): Promise<void> {
-    const { data } = await this.get<string>(`/${flowRunId}/download-logs-csv`, {
+  public async downloadFlowRunLogs(flowRunId: string, flowRunName: string | null): Promise<void> {
+    const { data } = await this.get<string>(`/${flowRunId}/logs/download`, {
       responseType: 'stream',
     })