@prefecthq/prefect-ui-library 3.5.9 → 3.5.11

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/utilities/api.d.ts

@@ -27,7 +27,8 @@ import { WorkspaceWorkPoolQueuesApi } from '../services/WorkspaceWorkPoolQueuesA
 import { WorkspaceWorkPoolsApi } from '../services/WorkspaceWorkPoolsApi';
 import { WorkspaceWorkPoolWorkersApi } from '../services/WorkspaceWorkPoolWorkersApi';
 import { WorkspaceWorkQueuesApi } from '../services/WorkspaceWorkQueuesApi';
-export declare function createApi(workspaceConfig: WorkspaceApiConfig, instanceSetupHook?: AxiosInstanceSetupHook | null): {
+import { MaybeGetter } from '../types/reactivity';
+export declare function createApi(workspaceConfig: MaybeGetter<WorkspaceApiConfig>, instanceSetupHook?: AxiosInstanceSetupHook | null): {
     artifacts: import("@prefecthq/vue-compositions").CreateActions<WorkspaceArtifactsApi>;
     automations: import("@prefecthq/vue-compositions").CreateActions<WorkspaceAutomationsApi>;
     blockCapabilities: import("@prefecthq/vue-compositions").CreateActions<WorkspaceBlockCapabilitiesApi>;

package/package.json

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

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/utilities/api.ts

@@ -28,10 +28,11 @@ import { WorkspaceWorkPoolQueuesApi } from '@/services/WorkspaceWorkPoolQueuesAp
 import { WorkspaceWorkPoolsApi } from '@/services/WorkspaceWorkPoolsApi'
 import { WorkspaceWorkPoolWorkersApi } from '@/services/WorkspaceWorkPoolWorkersApi'
 import { WorkspaceWorkQueuesApi } from '@/services/WorkspaceWorkQueuesApi'
+import { MaybeGetter } from '@/types/reactivity'
 
 // We want the return type to be inferred
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export function createApi(workspaceConfig: WorkspaceApiConfig, instanceSetupHook: AxiosInstanceSetupHook | null = null) {
+export function createApi(workspaceConfig: MaybeGetter<WorkspaceApiConfig>, instanceSetupHook: AxiosInstanceSetupHook | null = null) {
   return {
     artifacts: createActions(new WorkspaceArtifactsApi(workspaceConfig, instanceSetupHook)),
     automations: createActions(new WorkspaceAutomationsApi(workspaceConfig, instanceSetupHook)),