@envelop/sentry 7.1.1 → 8.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envelop/sentry",
-  "version": "7.1.1",
+  "version": "8.0.0",
   "sideEffects": false,
   "peerDependencies": {
     "@envelop/core": "^5.0.0",

package/typings/index.d.cts

@@ -1,8 +1,7 @@
-import { ExecutionArgs } from 'graphql';
-import { isOriginalGraphQLError, type Plugin } from '@envelop/core';
+import { isOriginalGraphQLError, TypedExecutionArgs, type Plugin } from '@envelop/core';
 import * as Sentry from '@sentry/node';
 import type { TraceparentData } from '@sentry/types';
-export type SentryPluginOptions = {
+export type SentryPluginOptions<PluginContext extends Record<string, any>> = {
     /**
      * Starts a new transaction for every GraphQL Operation.
      * When disabled, an already existing Transaction will be used.
@@ -38,34 +37,34 @@ export type SentryPluginOptions = {
     /**
      * Adds custom tags to every Transaction.
      */
-    appendTags?: (args: ExecutionArgs) => Record<string, unknown>;
+    appendTags?: (args: TypedExecutionArgs<PluginContext>) => Record<string, unknown>;
     /**
      * Callback to set context information onto the scope.
      */
-    configureScope?: (args: ExecutionArgs, scope: Sentry.Scope) => void;
+    configureScope?: (args: TypedExecutionArgs<PluginContext>, scope: Sentry.Scope) => void;
     /**
      * Produces a name of Transaction (only when "renameTransaction" or "startTransaction" are enabled) and description of created Span.
      *
      * @default operation's name or "Anonymous Operation" when missing)
      */
-    transactionName?: (args: ExecutionArgs) => string;
+    transactionName?: (args: TypedExecutionArgs<PluginContext>) => string;
     /**
      * Produces tracing data for Transaction
      *
      * @default is empty
      */
-    traceparentData?: (args: ExecutionArgs) => TraceparentData | undefined;
+    traceparentData?: (args: TypedExecutionArgs<PluginContext>) => TraceparentData | undefined;
     /**
      * Produces a "op" (operation) of created Span.
      *
      * @default execute
      */
-    operationName?: (args: ExecutionArgs) => string;
+    operationName?: (args: TypedExecutionArgs<PluginContext>) => string;
     /**
      * Indicates whether or not to skip the entire Sentry flow for given GraphQL operation.
      * By default, no operations are skipped.
      */
-    skip?: (args: ExecutionArgs) => boolean;
+    skip?: (args: TypedExecutionArgs<PluginContext>) => boolean;
     /**
      * Indicates whether or not to skip Sentry exception reporting for a given error.
      * By default, this plugin skips all `GraphQLError` errors and does not report it to Sentry.
@@ -73,4 +72,4 @@ export type SentryPluginOptions = {
     skipError?: (args: Error) => boolean;
 };
 export declare const defaultSkipError: typeof isOriginalGraphQLError;
-export declare const useSentry: (options?: SentryPluginOptions) => Plugin;
+export declare const useSentry: <PluginContext extends Record<string, any> = {}>(options?: SentryPluginOptions<PluginContext>) => Plugin<PluginContext>;

package/typings/index.d.ts

@@ -1,8 +1,7 @@
-import { ExecutionArgs } from 'graphql';
-import { isOriginalGraphQLError, type Plugin } from '@envelop/core';
+import { isOriginalGraphQLError, TypedExecutionArgs, type Plugin } from '@envelop/core';
 import * as Sentry from '@sentry/node';
 import type { TraceparentData } from '@sentry/types';
-export type SentryPluginOptions = {
+export type SentryPluginOptions<PluginContext extends Record<string, any>> = {
     /**
      * Starts a new transaction for every GraphQL Operation.
      * When disabled, an already existing Transaction will be used.
@@ -38,34 +37,34 @@ export type SentryPluginOptions = {
     /**
      * Adds custom tags to every Transaction.
      */
-    appendTags?: (args: ExecutionArgs) => Record<string, unknown>;
+    appendTags?: (args: TypedExecutionArgs<PluginContext>) => Record<string, unknown>;
     /**
      * Callback to set context information onto the scope.
      */
-    configureScope?: (args: ExecutionArgs, scope: Sentry.Scope) => void;
+    configureScope?: (args: TypedExecutionArgs<PluginContext>, scope: Sentry.Scope) => void;
     /**
      * Produces a name of Transaction (only when "renameTransaction" or "startTransaction" are enabled) and description of created Span.
      *
      * @default operation's name or "Anonymous Operation" when missing)
      */
-    transactionName?: (args: ExecutionArgs) => string;
+    transactionName?: (args: TypedExecutionArgs<PluginContext>) => string;
     /**
      * Produces tracing data for Transaction
      *
      * @default is empty
      */
-    traceparentData?: (args: ExecutionArgs) => TraceparentData | undefined;
+    traceparentData?: (args: TypedExecutionArgs<PluginContext>) => TraceparentData | undefined;
     /**
      * Produces a "op" (operation) of created Span.
      *
      * @default execute
      */
-    operationName?: (args: ExecutionArgs) => string;
+    operationName?: (args: TypedExecutionArgs<PluginContext>) => string;
     /**
      * Indicates whether or not to skip the entire Sentry flow for given GraphQL operation.
      * By default, no operations are skipped.
      */
-    skip?: (args: ExecutionArgs) => boolean;
+    skip?: (args: TypedExecutionArgs<PluginContext>) => boolean;
     /**
      * Indicates whether or not to skip Sentry exception reporting for a given error.
      * By default, this plugin skips all `GraphQLError` errors and does not report it to Sentry.
@@ -73,4 +72,4 @@ export type SentryPluginOptions = {
     skipError?: (args: Error) => boolean;
 };
 export declare const defaultSkipError: typeof isOriginalGraphQLError;
-export declare const useSentry: (options?: SentryPluginOptions) => Plugin;
+export declare const useSentry: <PluginContext extends Record<string, any> = {}>(options?: SentryPluginOptions<PluginContext>) => Plugin<PluginContext>;