@prefecthq/prefect-ui-library 1.1.2 → 1.1.4

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

@@ -1,35 +1,32 @@
-import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-import { ApiRouteParams } from '../models/ApiRouteParams';
-import { Require } from '../types/utilities';
-/**
- * @deprecated
- */
-export type ApiRoute = string | ((params?: ApiRouteParams) => string);
-/**
- * @deprecated
- */
-export type ApiServer = string | Promise<string>;
-/**
- * @deprecated
- */
-export declare abstract class Api {
-    protected server: ApiServer;
-    protected route: ApiRoute;
-    private _config;
-    private _instance;
-    private _params;
-    constructor(config?: AxiosRequestConfig);
-    protected instance(): Promise<AxiosInstance>;
-    protected config(): Promise<AxiosRequestConfig>;
-    protected request<T = any, R = AxiosResponse<T>>(config: Require<AxiosRequestConfig, 'url' | 'method'>): Promise<R>;
-    protected get<T = any, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
-    protected delete<T = any, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
-    protected head<T = any, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
-    protected options<T = any, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
-    protected post<T = any, R = AxiosResponse<T>>(url: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
-    protected put<T = any, R = AxiosResponse<T>>(url: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
-    protected patch<T = any, R = AxiosResponse<T>>(url: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
-    protected withParams(params?: ApiRouteParams): this;
-    protected getRoute(params?: ApiRouteParams): string;
-    private withRoute;
+import { AxiosInstance, AxiosRequestConfig, AxiosRequestHeaders, AxiosResponse } from 'axios';
+import { MaybeArray } from '../types/utilities';
+export type PrefectConfig = {
+    baseUrl: string;
+    token?: string;
+};
+type ConfigFunction<R, T extends PrefectConfig = PrefectConfig> = (config: T) => R;
+export type ApiBaseUrl<T extends PrefectConfig = PrefectConfig> = string | ConfigFunction<string, T>;
+export type ApiHeaders<T extends PrefectConfig = PrefectConfig> = AxiosRequestHeaders | ConfigFunction<AxiosRequestHeaders, T>;
+export declare const getPrefectBaseUrl: ApiBaseUrl;
+export declare const getPrefectUIHeaders: ApiHeaders;
+export declare const getAuthorizationHeaders: ApiHeaders;
+export declare class Api<T extends PrefectConfig = PrefectConfig> {
+    protected readonly apiConfig: T;
+    protected apiHeaders: MaybeArray<ApiHeaders>;
+    protected apiBaseUrl: ApiBaseUrl;
+    protected routePrefix: string | undefined;
+    constructor(apiConfig: T);
+    protected composeBaseUrl(): string;
+    protected composeHeaders(): AxiosRequestHeaders;
+    protected removeLeadingAndTrailingSlashes(input: string): string;
+    protected combinePath(route: string | undefined): string;
+    protected instance(): AxiosInstance;
+    protected get<T, R = AxiosResponse<T>>(route?: string, config?: AxiosRequestConfig): Promise<R>;
+    protected delete<T, R = AxiosResponse<T>>(route?: string, config?: AxiosRequestConfig): Promise<R>;
+    protected head<T, R = AxiosResponse<T>>(route?: string, config?: AxiosRequestConfig): Promise<R>;
+    protected options<T, R = AxiosResponse<T>>(route?: string, config?: AxiosRequestConfig): Promise<R>;
+    protected post<T, R = AxiosResponse<T>>(route?: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
+    protected put<T, R = AxiosResponse<T>>(route?: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
+    protected patch<T, R = AxiosResponse<T>>(route?: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
 }
+export {};

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

@@ -1,5 +1,6 @@
-import { Api, ApiRoute } from '../services/Api';
+import { Api } from '../services/Api';
 export declare class HealthApi extends Api {
-    protected route: ApiRoute;
-    getHealth(): Promise<string>;
+    protected routePrefix: string;
+    getHealth(): Promise<boolean>;
+    isHealthy(): Promise<boolean>;
 }

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

@@ -1,9 +1,7 @@
-import { InjectionKey } from 'vue';
 import { FlowRunsFilter } from '../models/Filters';
 import { UiFlowRunHistory } from '../models/UiFlowRunHistory';
-import { Api, ApiRoute } from '../services/Api';
-export declare class UiApi extends Api {
-    protected route: ApiRoute;
+import { WorkspaceApi } from '../services/WorkspaceApi';
+export declare class UiApi extends WorkspaceApi {
+    protected routePrefix: string;
     getFlowRunHistory(filter: FlowRunsFilter): Promise<UiFlowRunHistory[]>;
 }
-export declare const uiApiKey: InjectionKey<UiApi>;

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

@@ -1,27 +1,10 @@
-import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-export type PrefectConfig = {
-    baseUrl: string;
-};
-export type PrefectCloudConfig = {
-    baseUrl: string;
+import { Api, ApiBaseUrl, PrefectConfig } from '../services/Api';
+export type CloudApiConfig = PrefectConfig & {
     accountId: string;
     workspaceId: string;
-    token: string;
 };
-export type WorkspaceApiConfig = PrefectConfig | PrefectCloudConfig;
-export declare class WorkspaceApi {
-    private readonly workspaceConfig;
-    protected routePrefix: string;
-    constructor(workspaceConfig: WorkspaceApiConfig);
-    private get config();
-    private get baseUrl();
-    private get headers();
-    protected instance(): AxiosInstance;
-    protected get<T, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
-    protected delete<T, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
-    protected head<T, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
-    protected options<T, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
-    protected post<T, R = AxiosResponse<T>>(url: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
-    protected put<T, R = AxiosResponse<T>>(url: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
-    protected patch<T, R = AxiosResponse<T>>(url: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
+export type WorkspaceApiConfig = PrefectConfig | CloudApiConfig;
+export declare function isCloudConfig(config: WorkspaceApiConfig): config is CloudApiConfig;
+export declare class WorkspaceApi extends Api<WorkspaceApiConfig> {
+    protected apiBaseUrl: ApiBaseUrl<PrefectConfig>;
 }

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

@@ -1,4 +1,3 @@
-export * from './AdminApi';
 export * from './Api';
 export * from './can';
 export * from './HealthApi';

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

@@ -1,5 +1,4 @@
 export * from './buttons';
-export * from './classes';
 export * from './ColorMode';
 export * from './css';
 export * from './dates';

package/dist/types/src/utilities/api.d.ts

@@ -1,4 +1,6 @@
 import { InjectionKey } from 'vue';
+import { HealthApi } from '../services/HealthApi';
+import { UiApi } from '../services/UiApi';
 import { WorkspaceApiConfig } from '../services/WorkspaceApi';
 import { WorkspaceBlockCapabilitiesApi } from '../services/WorkspaceBlockCapabilitiesApi';
 import { WorkspaceBlockDocumentsApi } from '../services/WorkspaceBlockDocumentsApi';
@@ -25,14 +27,16 @@ export declare function createApi(workspaceConfig: WorkspaceApiConfig): {
     deployments: import("@prefecthq/vue-compositions").CreateActions<WorkspaceDeploymentsApi>;
     flowRuns: import("@prefecthq/vue-compositions").CreateActions<WorkspaceFlowRunsApi>;
     flows: import("@prefecthq/vue-compositions").CreateActions<WorkspaceFlowsApi>;
+    health: import("@prefecthq/vue-compositions").CreateActions<HealthApi>;
     logs: import("@prefecthq/vue-compositions").CreateActions<WorkspaceLogsApi>;
     notifications: import("@prefecthq/vue-compositions").CreateActions<WorkspaceNotificationsApi>;
-    taskRuns: import("@prefecthq/vue-compositions").CreateActions<WorkspaceTaskRunsApi>;
-    workQueues: import("@prefecthq/vue-compositions").CreateActions<WorkspaceWorkQueuesApi>;
     savedSearches: import("@prefecthq/vue-compositions").CreateActions<WorkspaceSavedSearchesApi>;
-    workPools: import("@prefecthq/vue-compositions").CreateActions<WorkspaceWorkPoolsApi>;
+    taskRuns: import("@prefecthq/vue-compositions").CreateActions<WorkspaceTaskRunsApi>;
+    ui: import("@prefecthq/vue-compositions").CreateActions<UiApi>;
     workPoolQueues: import("@prefecthq/vue-compositions").CreateActions<WorkspaceWorkPoolQueuesApi>;
+    workPools: import("@prefecthq/vue-compositions").CreateActions<WorkspaceWorkPoolsApi>;
     workPoolWorkers: import("@prefecthq/vue-compositions").CreateActions<WorkspaceWorkPoolWorkersApi>;
+    workQueues: import("@prefecthq/vue-compositions").CreateActions<WorkspaceWorkQueuesApi>;
 };
 export type CreateApi = ReturnType<typeof createApi>;
 export declare const workspaceApiKey: InjectionKey<CreateApi>;

package/dist/types/src/utilities/variables.d.ts

@@ -1,3 +1,4 @@
 export declare function sameValue(valueA: unknown, valueB: unknown): boolean;
 export declare function isNullish(value: unknown): value is null | undefined;
 export declare function isNotNullish<T>(value: T | null | undefined): value is T;
+export declare function isDefined<T>(input: T | undefined): input is T;

package/dist/{viewport.es-5fa29f11-37567970.mjs → viewport.es-5fa29f11-b9064c60.mjs}

@@ -1,7 +1,7 @@
-import { l as c, q as b, L as O, w as k } from "./index-349da0b8.mjs";
+import { l as c, q as b, L as O, w as k } from "./index-8419f309.mjs";
 import "vue";
-import "@prefecthq/vue-compositions";
 import "@prefecthq/prefect-design";
+import "@prefecthq/vue-compositions";
 import "vee-validate";
 import "vue-router";
 class d {
@@ -1534,4 +1534,4 @@ export {
   C as Viewport,
   $ as Wheel
 };
-//# sourceMappingURL=viewport.es-5fa29f11-37567970.mjs.map
+//# sourceMappingURL=viewport.es-5fa29f11-b9064c60.mjs.map