@envelop/prometheus 6.4.1 → 6.4.3-alpha-62b6e087.0

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@envelop/prometheus",
-  "version": "6.4.1",
+  "version": "6.4.3-alpha-62b6e087.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "^2.4.1",
+    "@envelop/core": "2.4.3-alpha-62b6e087.0",
     "prom-client": "^13 || ^14.0.0",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
@@ -24,7 +24,7 @@
   "exports": {
     ".": {
       "require": {
-        "types": "./typings/index.d.ts",
+        "types": "./typings/index.d.cts",
         "default": "./cjs/index.js"
       },
       "import": {
@@ -38,7 +38,7 @@
     },
     "./*": {
       "require": {
-        "types": "./typings/*.d.ts",
+        "types": "./typings/*.d.cts",
         "default": "./cjs/*.js"
       },
       "import": {

package/typings/config.d.cts

@@ -0,0 +1,17 @@
+import { createCounter, createHistogram, createSummary } from './utils.cjs';
+import { Registry } from 'prom-client';
+export declare type PrometheusTracingPluginConfig = {
+    requestCount?: boolean | ReturnType<typeof createCounter>;
+    requestTotalDuration?: boolean | ReturnType<typeof createHistogram>;
+    requestSummary?: boolean | ReturnType<typeof createSummary>;
+    parse?: boolean | ReturnType<typeof createHistogram>;
+    validate?: boolean | ReturnType<typeof createHistogram>;
+    contextBuilding?: boolean | ReturnType<typeof createHistogram>;
+    execute?: boolean | ReturnType<typeof createHistogram>;
+    errors?: boolean | ReturnType<typeof createCounter>;
+    resolvers?: boolean | ReturnType<typeof createHistogram>;
+    resolversWhitelist?: string[];
+    deprecatedFields?: boolean | ReturnType<typeof createCounter>;
+    registry?: Registry;
+    skipIntrospection?: boolean;
+};

package/typings/index.d.cts

@@ -0,0 +1,11 @@
+import { Plugin } from '@envelop/core';
+import { createHistogram, createCounter, FillLabelsFnParams, createSummary } from './utils.cjs';
+import { PrometheusTracingPluginConfig } from './config.cjs';
+export { PrometheusTracingPluginConfig, createCounter, createHistogram, createSummary, FillLabelsFnParams };
+declare const promPluginContext: unique symbol;
+declare const promPluginExecutionStartTimeSymbol: unique symbol;
+declare type PluginInternalContext = {
+    [promPluginContext]: FillLabelsFnParams;
+    [promPluginExecutionStartTimeSymbol]: number;
+};
+export declare const usePrometheus: (config?: PrometheusTracingPluginConfig) => Plugin<PluginInternalContext>;

package/typings/utils.d.cts

@@ -0,0 +1,34 @@
+import { GraphQLError, DocumentNode, OperationDefinitionNode, GraphQLResolveInfo, TypeInfo, ASTNode } from 'graphql';
+import { AfterParseEventPayload } from '@envelop/core';
+import { PrometheusTracingPluginConfig } from './config.cjs';
+import { Counter, Histogram, Summary } from 'prom-client';
+export declare type DeprecatedFieldInfo = {
+    fieldName: string;
+    typeName: string;
+};
+export declare type FillLabelsFnParams = {
+    document?: DocumentNode;
+    operationName?: string;
+    operationType?: OperationDefinitionNode['operation'];
+    info?: GraphQLResolveInfo;
+    errorPhase?: string;
+    error?: GraphQLError;
+    deprecationInfo?: DeprecatedFieldInfo;
+};
+export declare function shouldTraceFieldResolver(info: GraphQLResolveInfo, whitelist: string[] | undefined): boolean;
+export declare function createInternalContext(parseResult: AfterParseEventPayload<any>['result']): FillLabelsFnParams | null;
+export declare type FillLabelsFn<LabelNames extends string> = (params: FillLabelsFnParams, rawContext: any) => Record<LabelNames, string>;
+export declare function createHistogram<LabelNames extends string>(options: {
+    histogram: Histogram<LabelNames>;
+    fillLabelsFn: FillLabelsFn<LabelNames>;
+}): typeof options;
+export declare function createSummary<LabelNames extends string>(options: {
+    summary: Summary<LabelNames>;
+    fillLabelsFn: FillLabelsFn<LabelNames>;
+}): typeof options;
+export declare function createCounter<LabelNames extends string>(options: {
+    counter: Counter<LabelNames>;
+    fillLabelsFn: FillLabelsFn<LabelNames>;
+}): typeof options;
+export declare function getHistogramFromConfig(config: PrometheusTracingPluginConfig, phase: keyof PrometheusTracingPluginConfig, name: string, help: string): ReturnType<typeof createHistogram> | undefined;
+export declare function extractDeprecatedFields(node: ASTNode, typeInfo: TypeInfo): DeprecatedFieldInfo[];