metrickit 0.1.2

package/dist/orpc.d.ts

@@ -0,0 +1,36 @@
+import type { CacheAdapter } from './cache.ts';
+import type { MetricResultChunk, MetricsResult } from './run-metrics.ts';
+import type { MetricsRequestFor } from './registry.ts';
+import type { FilterFieldDefinition } from './filters/types.ts';
+import type { AnyRegistry, GetMetricByKey, InferAvailableMetricKey, InferRegistryMetrics, MetricCatalogFor, MetricKindFor } from './registry.ts';
+export interface MetricsRouterOptions<TORPCContext, TResolverContext, R extends AnyRegistry = AnyRegistry> {
+    registry: R;
+    createContext: (orpcCtx: TORPCContext) => TResolverContext | Promise<TResolverContext>;
+    hasAccess?: (metric: InferRegistryMetrics<R>[number], orpcCtx: TORPCContext) => boolean;
+    cache?: CacheAdapter;
+}
+export declare function createRunMetricsProcedure<TORPCContext, TResolverContext, R extends AnyRegistry>(options: MetricsRouterOptions<TORPCContext, TResolverContext, R>): <TRequest extends MetricsRequestFor<R>>(input: TRequest, orpcCtx: TORPCContext) => Promise<MetricsResult<R, TRequest["metrics"]> & {
+    hasErrors: boolean;
+}>;
+export declare function createRunMetricsStreamProcedure<TORPCContext, TResolverContext, R extends AnyRegistry>(options: MetricsRouterOptions<TORPCContext, TResolverContext, R>): <TRequest extends MetricsRequestFor<R>>(input: TRequest, orpcCtx: TORPCContext) => AsyncGenerator<MetricResultChunk<R, TRequest["metrics"]>, void, unknown>;
+export type AvailableMetricFor<R extends AnyRegistry, K extends InferAvailableMetricKey<R> = InferAvailableMetricKey<R>> = {
+    key: K;
+    kind: MetricKindFor<R, K>;
+    displayName: string;
+    description: string;
+    supportsTimeRange: GetMetricByKey<R, K>['supportsTimeRange'];
+    catalog?: MetricCatalogFor<R, K>;
+    filters: FilterFieldDefinition[];
+};
+export type AvailableMetricsResult<R extends AnyRegistry> = {
+    metrics: AvailableMetricFor<R>[];
+    total: number;
+};
+export declare function createGetAvailableMetricsProcedure<TORPCContext, R extends AnyRegistry>(options: Pick<MetricsRouterOptions<TORPCContext, unknown, R>, 'registry' | 'hasAccess'>): (orpcCtx: TORPCContext) => AvailableMetricsResult<R>;
+export declare function createMetricsRouter<TORPCContext, TResolverContext, R extends AnyRegistry>(options: MetricsRouterOptions<TORPCContext, TResolverContext, R>): {
+    runMetrics: <TRequest extends MetricsRequestFor<R>>(input: TRequest, orpcCtx: TORPCContext) => Promise<MetricsResult<R, TRequest["metrics"]> & {
+        hasErrors: boolean;
+    }>;
+    runMetricsStream: <TRequest extends MetricsRequestFor<R>>(input: TRequest, orpcCtx: TORPCContext) => AsyncGenerator<import("./registry.ts").MetricResultChunkFor<R, TRequest["metrics"]>, void, unknown>;
+    getAvailableMetrics: (orpcCtx: TORPCContext) => AvailableMetricsResult<R>;
+};