fix: warn about mutating data in option transform

README.md

@@ -50,125 +50,7 @@ const client = new ApolloClient({
 
 ## Options
 
-```typescript
-export interface FullOptions {
-  /**
-   * Determines if the given operation should be handled or discarded.
-   *
-   * If undefined, all operations will be included.
-   */
-  shouldHandleOperation: undefined | ((operation: Operation) => boolean);
-
-  /**
-   * The uri of the GraphQL endpoint.
-   *
-   * Used to add context information, e.g. to breadcrumbs.
-   *
-   * Defaults to undefined.
-   */
-  uri: undefined | string;
-
-  /**
-   * Set the Sentry transaction name to the GraphQL operation name.
-   *
-   * May be overwritten by other parts of your app.
-   *
-   * Defaults to true.
-   */
-  setTransaction: true | false;
-
-  /**
-   * Narrow Sentry's fingerprint by appending the GraphQL operation name to the {{default}} key.
-   *
-   * Only the last executed operation will be added, not every operation that's been through the link.
-   * May be overwritten by other parts of your app.
-   *
-   * Defaults to true.
-   */
-  setFingerprint: true | false;
-
-  /**
-   * Attach a breadcrumb for executed GraphQL operations.
-   *
-   * The following information will be included by default:
-   * {
-   *   type: 'http',
-   *   category: `graphql.${operationType}`,
-   *   message: operationName,
-   *   level: errors ? 'error' : 'info',
-   * }
-   */
-  attachBreadcrumbs: AttachBreadcrumbsOptions | false;
-}
-
-export type AttachBreadcrumbsOptions = {
-  /**
-   * Include the full query string?
-   *
-   * Defaults to false.
-   */
-  includeQuery: false | true;
-
-  /**
-   * Include the variable values?
-   *
-   * Be careful not to leak sensitive information or send too much data.
-   *
-   * Defaults to false.
-   */
-  includeVariables: false | true;
-
-  /**
-   * Include the fetched result (data, errors, extensions)?
-   *
-   * Be careful not to leak sensitive information or send too much data.
-   *
-   * Defaults to false.
-   */
-  includeFetchResult: false | true;
-
-  /**
-   * Include the response error?
-   *
-   * Be careful not to leak sensitive information or send too much data.
-   *
-   * Defaults to false.
-   */
-  includeError: false | true;
-
-  /**
-   * Include the contents of the Apollo Client cache?
-   *
-   * This is mostly useful for debugging purposes and not recommended for production environments,
-   * see "Be careful what you include", unless carefully combined with `beforeBreadcrumb`.
-   *
-   * Defaults to false.
-   */
-  includeCache: false | true;
-
-  /**
-   * Include arbitrary data from the `ApolloContext`?
-   *
-   * Accepts a list of keys in dot notation, e.g. `foo.bar`. Can be useful to include extra
-   * information such as headers.
-   *
-   * Defaults to false.
-   */
-  includeContext: false | NonEmptyArray<string>;
-
-  /**
-   * Modify the breadcrumb right before it is sent.
-   *
-   * Can be used to add additional data from the operation or clean up included data.
-   * Very useful in combination with options like `includeVariables` and `includeContext`.
-   *
-   * Defaults to undefined.
-   */
-  transform:
-    | undefined
-    | ((breadcrumb: GraphQLBreadcrumb, operation: Operation) => Breadcrumb);
-};
-```
+See [src/options.ts](src/options.ts).
 
 ### Compatibility with other Apollo Links
 

src/options.ts

@@ -112,9 +112,10 @@ export type AttachBreadcrumbsOptions = {
   includeContext: false | NonEmptyArray<string>;
 
   /**
-   * Modify the breadcrumb right before it is sent.
+   * Allows to return a modified copy of the breadcrumb right before it is sent.
    *
    * Can be used to add additional data from the operation or clean up included data.
+   * Do not mutate the data within the breadcrumb object, as it references the original.
    * Very useful in combination with options like `includeVariables` and `includeContext`.
    *
    * Defaults to undefined.