@prefecthq/prefect-ui-library 2.9.6 → 2.9.8

package/dist/types/src/automations/maps/utilities.d.ts

@@ -1,13 +1,13 @@
-import { AutomationTriggerMatch, EventResource, EventResourceLabel, EventResourceRole, EventResourceValue } from '../../automations/types/api/triggers';
+import { AutomationTriggerMatch, AutomationTriggerEventResource, AutomationTriggerEventResourceLabel, AutomationTriggerEventResourceRole, EventResourceValue } from '../../automations/types/api/triggers';
 import { AutomationTrigger } from '../../automations/types/triggers';
-export declare function toResourceId(resource: EventResource, values: string[]): string | string[];
-export declare function fromResourceId(resource: EventResource, value: EventResourceValue): string[];
-export declare function fromResourceName(match: AutomationTriggerMatch, role: EventResourceRole): string[];
+export declare function toResourceId(resource: AutomationTriggerEventResource, values: string[]): string | string[];
+export declare function fromResourceId(resource: AutomationTriggerEventResource, value: EventResourceValue): string[];
+export declare function fromResourceName(match: AutomationTriggerMatch, role: AutomationTriggerEventResourceRole): string[];
 export declare function toStateNameEvents(stateTypes: string[]): string[];
 export declare function fromStateNameEvents(events: string[]): string[];
-export declare function toMatchRelatedId(role: EventResourceRole, id: string | string[]): AutomationTriggerMatch | undefined;
-export declare function toMatchRelatedName(role: EventResourceRole, name: string | string[]): AutomationTriggerMatch | undefined;
+export declare function toMatchRelatedId(role: AutomationTriggerEventResourceRole, id: string | string[]): AutomationTriggerMatch | undefined;
+export declare function toMatchRelatedName(role: AutomationTriggerEventResourceRole, name: string | string[]): AutomationTriggerMatch | undefined;
 export declare function isMatchResource(trigger: AutomationTrigger, predicate: (resourceIds: string[]) => boolean): boolean;
-export declare function isForEachResource(trigger: AutomationTrigger, resource: EventResourceLabel): boolean;
+export declare function isForEachResource(trigger: AutomationTrigger, resource: AutomationTriggerEventResourceLabel): boolean;
 export declare function isExpectResource(trigger: AutomationTrigger, predicate: (resourceIds: string[]) => boolean): boolean;
 export declare function isAfterResource(trigger: AutomationTrigger, predicate: (resourceIds: string[]) => boolean): boolean;

package/dist/types/src/automations/types/api/triggers.d.ts

@@ -1,8 +1,8 @@
-export type EventResourceLabel = 'prefect.resource.id' | 'prefect.resource.role' | 'prefect.resource.name' | 'prefect-cloud.incident.severity';
-export type EventResource = 'prefect.deployment' | 'prefect.flow-run' | 'prefect.flow' | 'prefect.tag' | 'prefect.work-pool' | 'prefect.work-queue' | 'prefect-cloud.incident';
-export type EventResourceRole = 'flow' | 'tag' | 'work-queue' | 'work-pool';
+export type AutomationTriggerEventResourceLabel = 'prefect.resource.id' | 'prefect.resource.role' | 'prefect.resource.name' | 'prefect-cloud.incident.severity';
+export type AutomationTriggerEventResource = 'prefect.deployment' | 'prefect.flow-run' | 'prefect.flow' | 'prefect.tag' | 'prefect.work-pool' | 'prefect.work-queue' | 'prefect-cloud.incident';
+export type AutomationTriggerEventResourceRole = 'flow' | 'tag' | 'work-queue' | 'work-pool';
 export type EventResourceValue = string | string[] | undefined;
-export type AutomationTriggerMatch = Partial<Record<EventResourceLabel, EventResourceValue>>;
+export type AutomationTriggerMatch = Partial<Record<AutomationTriggerEventResourceLabel, EventResourceValue>>;
 export declare const automationTriggerEventPosture: readonly ["Reactive", "Proactive"], isAutomationTriggerEventPosture: (value: unknown) => value is "Reactive" | "Proactive";
 export declare const DEFAULT_EVENT_TRIGGER_WITHIN = 0;
 export type AutomationTriggerEventPosture = typeof automationTriggerEventPosture[number];

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

@@ -625,4 +625,20 @@ export declare const maps: {
     WorkQueueStatusTrigger: {
         AutomationTrigger: import("..").MapFunction<import("..").WorkQueueStatusTrigger, import("..").AutomationTriggerEvent>;
     };
+    WorkspaceEventResponse: {
+        WorkspaceEvent: import("..").MapFunction<import("../models/api/workspaceEvents").WorkspaceEventResponse, import("../models/workspaceEvent").WorkspaceEvent>;
+    };
+    WorkspaceEventsResponse: {
+        WorkspaceEvents: import("..").MapFunction<import("../models/api/workspaceEvents").WorkspaceEventsResponse, import("../models/workspaceEvents").WorkspaceEvents>;
+    };
+    WorkspaceEventsCountResponse: {
+        WorkspaceEventsCount: import("..").MapFunction<import("../models/api/workspaceEvents").WorkspaceEventsCountResponse, import("../models/workspaceEventsCount").WorkspaceEventsCount>;
+        HistogramDataPoint: import("..").MapFunction<import("../models/api/workspaceEvents").WorkspaceEventsCountResponse, import("@prefecthq/vue-charts").HistogramDataPoint>;
+    };
+    WorkspaceEventsFilter: {
+        WorkspaceEventsFilterRequest: import("..").MapFunction<import("..").WorkspaceEventsFilter, import("../models/api/workspaceEventsFilterRequest").WorkspaceEventsFilterRequest>;
+    };
+    WorkspaceEventsHistory: {
+        WorkspaceEventsHistoryRequest: import("..").MapFunction<import("../types/workspaceEventsHistory").WorkspaceEventsHistory, import("../models/api/workspaceEventsHistoryRequest").WorkspaceEventsHistoryRequest>;
+    };
 };

package/dist/types/src/maps/workspaceEvent.d.ts

@@ -0,0 +1,4 @@
+import { WorkspaceEventResponse } from '../models/api/workspaceEvents';
+import { WorkspaceEvent } from '../models/workspaceEvent';
+import { MapFunction } from '../services/Mapper';
+export declare const mapWorkspaceEventResponseToWorkspaceEvent: MapFunction<WorkspaceEventResponse, WorkspaceEvent>;

package/dist/types/src/maps/workspaceEvents.d.ts

@@ -0,0 +1,4 @@
+import { WorkspaceEventsResponse } from '../models/api/workspaceEvents';
+import { WorkspaceEvents } from '../models/workspaceEvents';
+import { MapFunction } from '../services/Mapper';
+export declare const mapWorkspaceEventsResponseToWorkspaceEvents: MapFunction<WorkspaceEventsResponse, WorkspaceEvents>;

package/dist/types/src/maps/workspaceEventsCount.d.ts

@@ -0,0 +1,6 @@
+import { HistogramDataPoint } from '@prefecthq/vue-charts';
+import { WorkspaceEventsCountResponse } from '../models/api/workspaceEvents';
+import { WorkspaceEventsCount } from '../models/workspaceEventsCount';
+import { MapFunction } from '../services/Mapper';
+export declare const mapWorkspaceEventsCountResponseToWorkspaceEventsCount: MapFunction<WorkspaceEventsCountResponse, WorkspaceEventsCount>;
+export declare const mapWorkspaceEventsCountResponseToHistogramDataPoint: MapFunction<WorkspaceEventsCountResponse, HistogramDataPoint>;

package/dist/types/src/maps/workspaceEventsFilter.d.ts

@@ -0,0 +1,4 @@
+import { WorkspaceEventsFilterRequest } from '../models/api/workspaceEventsFilterRequest';
+import { MapFunction } from '../services/Mapper';
+import { WorkspaceEventsFilter } from '../types/workspaceEventsFilter';
+export declare const mapWorkspaceEventsFilterToWorkspaceEventsFilterRequest: MapFunction<WorkspaceEventsFilter, WorkspaceEventsFilterRequest>;

package/dist/types/src/maps/workspaceEventsHistory.d.ts

@@ -0,0 +1,4 @@
+import { WorkspaceEventsHistoryRequest } from '../models/api/workspaceEventsHistoryRequest';
+import { MapFunction } from '../services/Mapper';
+import { WorkspaceEventsHistory } from '../types/workspaceEventsHistory';
+export declare const mapEventsHistoryToEventsHistoryRequest: MapFunction<WorkspaceEventsHistory, WorkspaceEventsHistoryRequest>;

package/dist/types/src/models/api/workspaceEvents.d.ts

@@ -0,0 +1,33 @@
+export type WorkspaceEventResource = {
+    'prefect.resource.id': string;
+    'prefect.resource.role'?: string;
+    'prefect.resource.name'?: string;
+    'prefect.name'?: string;
+    'prefect-cloud.name'?: string;
+} & Record<string, string | undefined>;
+export type WorkspaceRelatedResource = WorkspaceEventResource & {
+    'prefect.resource.role': string;
+};
+export type WorkspaceEventResponse = {
+    id: string;
+    account: string;
+    event: string;
+    occurred: string;
+    payload: unknown;
+    received: string;
+    related: WorkspaceRelatedResource[];
+    resource: WorkspaceEventResource;
+    workspace: string | null;
+};
+export type WorkspaceEventsResponse = {
+    events: WorkspaceEventResponse[];
+    next_page: string | null;
+    total: number;
+};
+export type WorkspaceEventsCountResponse = {
+    count: number;
+    label: string;
+    value: string;
+    start_time: string;
+    end_time: string;
+};

package/dist/types/src/models/api/workspaceEventsFilterRequest.d.ts

@@ -0,0 +1,41 @@
+export type EventResourceValue = string | string[] | undefined;
+/** A list to include events for resources with these IDs */
+type id = {
+    id?: string[];
+};
+/** An object record to include events for resources with these labels */
+type labels = {
+    labels?: Record<string, EventResourceValue>;
+};
+export type WorkspaceEventsFilterRequest = {
+    limit?: number;
+    filter?: {
+        occurred?: {
+            since?: string;
+            until?: string;
+        };
+        event?: {
+            prefix?: string[];
+            name?: string[];
+            exclude_prefix?: string[];
+            exclude_name?: string[];
+        };
+        any_resource?: id & labels & {
+            id_prefix?: string[];
+        };
+        resource?: id & labels & {
+            id_prefix?: string[];
+            distinct?: boolean;
+        };
+        related?: id & labels & {
+            role?: string[];
+            resources_in_roles?: unknown[];
+        };
+        scope?: {
+            account?: string;
+            workspace?: string[];
+        };
+        id?: id;
+    };
+};
+export {};

package/dist/types/src/models/api/workspaceEventsHistoryRequest.d.ts

@@ -0,0 +1,7 @@
+import { WorkspaceEventsFilterRequest } from '../../models/api/workspaceEventsFilterRequest';
+export type WorkspaceEventsHistoryUnit = 'week' | 'day' | 'hour' | 'minute' | 'second';
+export type WorkspaceEventsHistoryRequest = {
+    filter?: WorkspaceEventsFilterRequest['filter'];
+    time_unit?: WorkspaceEventsHistoryUnit;
+    time_interval?: number;
+};

package/dist/types/src/models/workspaceEvent.d.ts

@@ -0,0 +1,40 @@
+import { WorkspaceRelatedResource, WorkspaceEventResource } from '../models/api/workspaceEvents';
+export declare const prefectEventPrefixes: readonly ["prefect-cloud.actor", "prefect-cloud.automation", "prefect-cloud.workspace", "prefect-cloud.webhook", "prefect.block-document", "prefect.deployment", "prefect.flow-run", "prefect.flow", "prefect.task-run", "prefect.work-queue", "prefect.work-pool", "prefect.tag", "prefect.concurrency-limit", "prefect.artifact-collection", "prefect.creator"];
+export type PrefectEventPrefixes = typeof prefectEventPrefixes[number];
+export declare const prefectResourceRoles: string[];
+export type PrefectResourceRole = PrefectEventPrefixes extends `${string}.${infer T}` ? T : never;
+export declare function isPrefectResourceRole(value: unknown): value is PrefectResourceRole;
+export type IWorkspaceEvent = {
+    id: string;
+    account: string;
+    event: string;
+    occurred: Date;
+    payload: unknown;
+    received: Date;
+    related: WorkspaceRelatedResource[];
+    resource: WorkspaceEventResource;
+    workspace: string | null;
+};
+export declare class WorkspaceEvent implements IWorkspaceEvent {
+    id: string;
+    account: string;
+    event: string;
+    occurred: Date;
+    payload: unknown;
+    received: Date;
+    related: WorkspaceRelatedResource[];
+    resource: WorkspaceEventResource;
+    workspace: string | null;
+    constructor(event: IWorkspaceEvent);
+    getRelatedByRole(role: PrefectResourceRole): WorkspaceRelatedResource | null;
+    get email(): string;
+    get actorName(): string | null;
+    get workspaceHandle(): string;
+    get occurredFormatted(): string;
+    get eventPrefectWithoutPrefix(): string;
+    get eventLabel(): string;
+    get occurredDate(): string;
+    get occurredTime(): string;
+    get resourceId(): string;
+}
+export declare function isEvent(value: unknown): value is WorkspaceEvent;

package/dist/types/src/models/workspaceEvents.d.ts

@@ -0,0 +1,14 @@
+import { WorkspaceEvent } from '../models/workspaceEvent';
+export type IWorkspaceEvents = {
+    events: WorkspaceEvent[];
+    nextPage: string | null;
+    total: number;
+};
+export declare class WorkspaceEvents {
+    events: WorkspaceEvent[];
+    nextPage: string | null;
+    total: number;
+    constructor(eventStream: IWorkspaceEvents);
+    get nextPageToken(): string | null;
+    get pages(): number;
+}

package/dist/types/src/models/workspaceEventsCount.d.ts

@@ -0,0 +1,17 @@
+export type WorkspaceEventsCountable = 'day' | 'event' | 'workspace' | 'actor' | 'resource';
+export type IWorkspaceEventsCount = {
+    count: number;
+    label: string;
+    value: string;
+    startTime: Date;
+    endTime: Date;
+};
+export declare class WorkspaceEventsCount implements IWorkspaceEventsCount {
+    count: number;
+    label: string;
+    value: string;
+    startTime: Date;
+    endTime: Date;
+    constructor(count: IWorkspaceEventsCount);
+    get eventPrefectWithoutPrefix(): string;
+}

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

@@ -649,6 +649,22 @@ export declare const mapper: Mapper<{
     WorkQueueStatusTrigger: {
         AutomationTrigger: MapFunction<import("..").WorkQueueStatusTrigger, import("..").AutomationTriggerEvent>;
     };
+    WorkspaceEventResponse: {
+        WorkspaceEvent: MapFunction<import("../models/api/workspaceEvents").WorkspaceEventResponse, import("../models/workspaceEvent").WorkspaceEvent>;
+    };
+    WorkspaceEventsResponse: {
+        WorkspaceEvents: MapFunction<import("../models/api/workspaceEvents").WorkspaceEventsResponse, import("../models/workspaceEvents").WorkspaceEvents>;
+    };
+    WorkspaceEventsCountResponse: {
+        WorkspaceEventsCount: MapFunction<import("../models/api/workspaceEvents").WorkspaceEventsCountResponse, import("../models/workspaceEventsCount").WorkspaceEventsCount>;
+        HistogramDataPoint: MapFunction<import("../models/api/workspaceEvents").WorkspaceEventsCountResponse, import("@prefecthq/vue-charts").HistogramDataPoint>;
+    };
+    WorkspaceEventsFilter: {
+        WorkspaceEventsFilterRequest: MapFunction<import("..").WorkspaceEventsFilter, import("../models/api/workspaceEventsFilterRequest").WorkspaceEventsFilterRequest>;
+    };
+    WorkspaceEventsHistory: {
+        WorkspaceEventsHistoryRequest: MapFunction<import("../types/workspaceEventsHistory").WorkspaceEventsHistory, import("../models/api/workspaceEventsHistoryRequest").WorkspaceEventsHistoryRequest>;
+    };
 }>;
 export type MapFunction<S, D> = (this: typeof mapper, source: S) => D;
 export {};

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

@@ -0,0 +1,16 @@
+import { HistogramData } from '@prefecthq/vue-charts';
+import { WorkspaceEvent } from '../models/workspaceEvent';
+import { WorkspaceEvents } from '../models/workspaceEvents';
+import { WorkspaceEventsCount, WorkspaceEventsCountable } from '../models/workspaceEventsCount';
+import { WorkspaceApi } from '../services/WorkspaceApi';
+import { WorkspaceEventsFilter } from '../types/workspaceEventsFilter';
+import { WorkspaceEventsHistory } from '../types/workspaceEventsHistory';
+export declare class WorkspaceEventsApi extends WorkspaceApi {
+    protected routePrefix: string;
+    getEvents(filter: WorkspaceEventsFilter): Promise<WorkspaceEvents>;
+    getEvent(eventId: string, occurred: Date): Promise<WorkspaceEvent>;
+    getFirstEvent(filter: WorkspaceEventsFilter): Promise<WorkspaceEvent>;
+    getNextPage(pageToken: string): Promise<WorkspaceEvents>;
+    getEventsCount(countable: WorkspaceEventsCountable, filter: WorkspaceEventsFilter): Promise<WorkspaceEventsCount[]>;
+    getEventsHistory(eventsHistory: WorkspaceEventsHistory): Promise<HistogramData>;
+}

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

@@ -17,3 +17,4 @@ export * from './tabs';
 export * from './tailwind';
 export * from './useEntitySubscription';
 export * from './utilities';
+export * from './workspaceEventsFilter';

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

@@ -0,0 +1,56 @@
+import { EventResourceValue } from '../automations/types/api/triggers';
+/** A list to include events for resources with these IDs */
+type id = {
+    id?: string[];
+};
+/** An object record to include events for resources with these labels */
+type labels = {
+    labels?: Record<string, EventResourceValue>;
+};
+export type EventNameFilter = {
+    prefix?: string[];
+    name?: string[];
+    excludePrefix?: string[];
+    excludeName?: string[];
+};
+export type EventAnyResourceFilter = id & labels & {
+    idPrefix?: string[];
+};
+export type EventResourceFilter = EventAnyResourceFilter & {
+    distinct?: boolean;
+};
+export type EventRelatedFilter = id & labels & {
+    role?: string[];
+    resourcesInRoles?: unknown[];
+};
+export declare const EventsFilterOrderOptions: readonly ["ASC", "DESC"], isEventsFilterOrderOption: (value: unknown) => value is "ASC" | "DESC";
+export type EventsFilterOrderOption = typeof EventsFilterOrderOptions[number];
+export type WorkspaceEventsFilter = {
+    limit?: number;
+    occurred: {
+        since: Date;
+        until: Date;
+    };
+    event?: EventNameFilter;
+    anyResource?: EventAnyResourceFilter;
+    resource?: EventResourceFilter;
+    related?: EventRelatedFilter;
+    scope?: {
+        account?: string;
+        workspace?: string[];
+    };
+    id?: id;
+    order?: EventsFilterOrderOption;
+};
+/**
+ * Caution: Do not use unless you need to construct a partial filter before adding occurred.
+ * All requests made should include occurred and the api endpoints guard against this by using
+ * the EventsFilter type which requires both occurred.since and occurred.until.
+ */
+export type PartialEventsFilter = Omit<WorkspaceEventsFilter, 'occurred'> & {
+    occurred?: {
+        since?: Date;
+        until?: Date;
+    };
+};
+export {};

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

@@ -0,0 +1,7 @@
+import { WorkspaceEventsHistoryUnit } from '../models/api/workspaceEventsHistoryRequest';
+import { WorkspaceEventsFilter } from '../types/workspaceEventsFilter';
+export type WorkspaceEventsHistory = {
+    unit?: WorkspaceEventsHistoryUnit;
+    interval?: number;
+    filter: WorkspaceEventsFilter;
+};

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

@@ -14,6 +14,7 @@ import { WorkspaceConcurrencyLimitsApi } from '../services/WorkspaceConcurrencyL
 import { WorkspaceConcurrencyV2LimitsApi } from '../services/WorkspaceConcurrencyLimitsV2API';
 import { WorkspaceDeploymentsApi } from '../services/WorkspaceDeploymentsApi';
 import { WorkspaceDeploymentScheduleApi } from '../services/WorkspaceDeploymentScheduleApi';
+import { WorkspaceEventsApi } from '../services/workspaceEventsApi';
 import { WorkspaceFlowRunsApi } from '../services/WorkspaceFlowRunsApi';
 import { WorkspaceFlowsApi } from '../services/WorkspaceFlowsApi';
 import { WorkspaceLogsApi } from '../services/WorkspaceLogsApi';
@@ -52,6 +53,7 @@ export declare function createApi(workspaceConfig: WorkspaceApiConfig, instanceS
     workPoolWorkers: import("@prefecthq/vue-compositions").CreateActions<WorkspaceWorkPoolWorkersApi>;
     workQueues: import("@prefecthq/vue-compositions").CreateActions<WorkspaceWorkQueuesApi>;
     schemas: import("@prefecthq/vue-compositions").CreateActions<WorkspaceSchemasWorkspaceApi>;
+    events: import("@prefecthq/vue-compositions").CreateActions<WorkspaceEventsApi>;
 };
 export type CreateApi = ReturnType<typeof createApi>;
 export declare const workspaceApiKey: InjectionKey<CreateApi>;

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

@@ -0,0 +1 @@
+export declare function removePrefectEventLabelPrefix(value: string): string;

package/package.json

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