@quilted/quilt 0.5.154 → 0.5.156

package/CHANGELOG.md

@@ -1,5 +1,76 @@
 # @quilted/quilt
 
+## 0.5.156
+
+### Patch Changes
+
+- [`ca9e1de5`](https://github.com/lemonmade/quilt/commit/ca9e1de5ab2723ca7bfae1cf29dd5472a158bacd) Thanks [@lemonmade](https://github.com/lemonmade)! - Fix tree-shaken GraphQL matchers import
+
+## 0.5.155
+
+### Patch Changes
+
+- [`a68e6915`](https://github.com/lemonmade/quilt/commit/a68e691535e0b472883bebc4b4b3671ad885cfd9) Thanks [@lemonmade](https://github.com/lemonmade)! - Add back GraphQL matchers
+
+- [`055ffe19`](https://github.com/lemonmade/quilt/commit/055ffe19fdfde694d24f700d8cd8c7636491556a) Thanks [@{id:](https://github.com/{id:), [@{id:](https://github.com/{id:), [@{id:](https://github.com/{id:)! - Simplify `GraphQLFetch` type and separate HTTP options
+
+  The `GraphQLFetch` and `GraphQLStreamingFetch` types previous had the assumption of an HTTP transport baked into their options. This made it awkward to use in other contexts, like a directly-callable function.
+
+  To fix this issue, we’ve simplified the `GraphQLFetch` and `GraphQLStreamingFetch` types so that they only accept options universal to all transports: `variables`, for the operation variables, and `signal`, for an optional `AbortSignal` that should cancel the request. The previous HTTP-specific options have been moved to new `GraphQLFetchOverHTTPOptions` and `GraphQLStreamingFetchOverHTTPOptions` types. The `GraphQLFetch` function was also made a little more strict (requiring it to return a `Promise` for a GraphQL result).
+
+  Additionally, the extendable `GraphQLFetchContext` type has been removed from this library. This type could previously be extended to declare additional context that would be optionally available in a GraphQL fetch function:
+
+  ```ts
+  import type {GraphQLFetch} from '@quilted/graphql';
+
+  // A "module augmentation" that tells TypeScript
+  // a `user` field is required
+  declare module '@quilted/graphql' {
+    interface GraphQLFetchContext {
+   string};
+    }
+  }
+
+  const fetch: GraphQLFetch = async (operation, {variables}, context) => {
+    // `user` is available because of our module augmentation
+    const user = context?.user;
+
+    // ... do something with the user and return a result
+  };
+
+  const result = await fetch('query { message }', {}, {user: {id: '123'}});
+  ```
+
+  This type was removed in favor of a new `Context` generic on the `GraphQLFetch` and `GraphQLStreamingFetch` types. These allow you to define the types of any additional context you need for your GraphQL fetcher explicitly, without a module augmentation:
+
+  ```ts
+  import type {GraphQLFetch} from '@quilted/graphql';
+
+  // A "module augmentation" that tells TypeScript
+  // a `user` field is required
+  declare module '@quilted/graphql' {
+    interface GraphQLFetchContext {
+   string};
+    }
+  }
+
+  const fetch: GraphQLFetch<{
+   string};
+  }> = async (operation, {variables}, context) => {
+    // `user` is available because of our module augmentation
+    const user = context?.user;
+
+    // ... do something with the user and return a result
+  };
+
+  const result = await fetch('query { message }', {}, {user: {id: '123'}});
+  ```
+
+  Finally, the `GraphQLVariableOptions` has been simplified. It no longer requires that variables be defined if there are non-nullable variables for the operation. This bit of type safety was very nice, but it was hard to build on top of the `GraphQLVariableOptions` type because of the advanced TypeScript features this type previously used. The new type is a simpler interface that is easy to extend.
+
+- Updated dependencies [[`772fd3d1`](https://github.com/lemonmade/quilt/commit/772fd3d1ae845cf990c7b6c1fef0d92669dea660), [`055ffe19`](https://github.com/lemonmade/quilt/commit/055ffe19fdfde694d24f700d8cd8c7636491556a), [`055ffe19`](https://github.com/lemonmade/quilt/commit/055ffe19fdfde694d24f700d8cd8c7636491556a)]:
+  - @quilted/graphql@2.0.0
+
 ## 0.5.154
 
 ### Patch Changes

package/build/cjs/graphql/testing/matchers/operations.cjs

@@ -0,0 +1,42 @@
+'use strict';
+
+var jestMatcherUtils = require('jest-matcher-utils');
+var ast = require('@quilted/graphql/ast');
+var utilities = require('./utilities.cjs');
+
+function toHavePerformedGraphQLOperation(graphql, operation, variables) {
+  utilities.assertIsGraphQLController(graphql, {
+    expectation: 'toHavePerformedGraphQLOperation',
+    isNot: this.isNot
+  });
+  const foundByOperation = graphql.completed.all({
+    operation
+  });
+  const foundByVariables = variables == null ? foundByOperation : foundByOperation.filter(operation => Object.keys(variables).every(key => this.equals(variables[key], (operation.variables ?? {})[key])));
+  const pass = foundByVariables.length > 0;
+  const {
+    name
+  } = ast.normalizeOperation(operation);
+  const message = pass ? () => `${jestMatcherUtils.matcherHint('.not.toHavePerformedGraphQLOperation')}\n\n` + `Expected not to have performed GraphQL operation:\n  ${jestMatcherUtils.EXPECTED_COLOR(name)}\n${variables ? `With variables matching:\n  ${jestMatcherUtils.printExpected(variables)}\n` : ''}` + `But ${foundByVariables.length} matching ${foundByVariables.length === 1 ? 'operation was' : 'operations were'} found.\n` : () => `${`${jestMatcherUtils.matcherHint('.toHavePerformedGraphQLOperation')}\n\n` + `Expected to have performed GraphQL operation:\n  ${jestMatcherUtils.EXPECTED_COLOR(name)}\n${variables ? `With variables matching:\n  ${jestMatcherUtils.printExpected(variables)}\n` : ''}`}${foundByOperation.length === 0 ? `But no matching operations were found.\n` : `But the ${foundByVariables.length === 1 ? 'found operation has' : 'found operations have'} the following variable differences:\n\n${diffs(foundByVariables, variables, this.expand)}`}`;
+  return {
+    pass,
+    message
+  };
+}
+function diffs(requests, variables, expand) {
+  return requests.reduce((diffs, request, index) => `${diffs}${index === 0 ? '' : '\n\n'}${normalizedDiff(request, variables, {
+    expand,
+    showLegend: index === 0
+  })}`, '');
+}
+function normalizedDiff(request, variables, {
+  expand = false,
+  showLegend = false
+}) {
+  const result = utilities.diffVariables(request.variables ?? {}, variables, {
+    expand
+  }) || '';
+  return showLegend ? result : result.split('\n\n')[1];
+}
+
+exports.toHavePerformedGraphQLOperation = toHavePerformedGraphQLOperation;

package/build/cjs/graphql/testing/matchers/utilities.cjs

@@ -0,0 +1,43 @@
+'use strict';
+
+var jestMatcherUtils = require('jest-matcher-utils');
+var testing = require('@quilted/graphql/testing');
+
+function assertIsGraphQLController(graphql, {
+  expectation,
+  isNot
+}) {
+  if (!(graphql instanceof testing.GraphQLController)) {
+    throw new Error(jestMatcherUtils.matcherErrorMessage(jestMatcherUtils.matcherHint(`.${expectation}`, undefined, undefined, {
+      isNot
+    }), `${jestMatcherUtils.RECEIVED_COLOR('received')} value must be a @quilted/graphql/fixtures GraphQLController object`, jestMatcherUtils.printWithType('Received', graphql, jestMatcherUtils.printReceived)));
+  }
+}
+function diffVariables(actual, expected, {
+  expand = false
+}) {
+  return jestMatcherUtils.diff(expected, getObjectSubset(actual, expected), {
+    expand
+  });
+}
+
+// Original from https://github.com/facebook/jest/blob/master/packages/expect/source/utils.ts#L107
+function getObjectSubset(object, subset) {
+  if (Array.isArray(object)) {
+    if (Array.isArray(subset) && subset.length === object.length) {
+      return subset.map((sub, i) => getObjectSubset(object[i], sub));
+    }
+  } else if (object instanceof Date) {
+    return object;
+  } else if (typeof object === 'object' && object !== null && typeof subset === 'object' && subset !== null) {
+    const trimmed = {};
+    Object.keys(subset).filter(key => Reflect.has(object, key)).forEach(key => trimmed[key] = getObjectSubset(object[key], subset[key]));
+    if (Object.keys(trimmed).length > 0) {
+      return trimmed;
+    }
+  }
+  return object;
+}
+
+exports.assertIsGraphQLController = assertIsGraphQLController;
+exports.diffVariables = diffVariables;

package/build/cjs/graphql/testing/matchers.cjs

@@ -0,0 +1,10 @@
+'use strict';
+
+var testing = require('@quilted/testing');
+var operations = require('./matchers/operations.cjs');
+
+testing.expect.extend({
+  toHavePerformedGraphQLOperation: operations.toHavePerformedGraphQLOperation,
+  toHavePerformedGraphQLQuery: operations.toHavePerformedGraphQLOperation,
+  toHavePerformedGraphQLMutation: operations.toHavePerformedGraphQLOperation
+});

package/build/cjs/graphql/testing.cjs

@@ -1,31 +1,18 @@
 'use strict';
 
-var testing = require('@quilted/graphql/testing');
-var testing$1 = require('@quilted/react-graphql/testing');
+require('./testing/matchers.cjs');
+var testing$1 = require('@quilted/graphql/testing');
+var testing = require('@quilted/react-graphql/testing');
 
 
 
-Object.defineProperty(exports, 'GraphQLController', {
-  enumerable: true,
-  get: function () { return testing.GraphQLController; }
-});
-Object.defineProperty(exports, 'createGraphQLFiller', {
-  enumerable: true,
-  get: function () { return testing.createGraphQLFiller; }
-});
-Object.defineProperty(exports, 'createGraphQLSchema', {
-  enumerable: true,
-  get: function () { return testing.createGraphQLSchema; }
-});
-Object.defineProperty(exports, 'gql', {
-  enumerable: true,
-  get: function () { return testing.gql; }
-});
-Object.defineProperty(exports, 'graphql', {
-  enumerable: true,
-  get: function () { return testing.graphql; }
-});
 Object.defineProperty(exports, 'GraphQLTesting', {
-  enumerable: true,
-  get: function () { return testing$1.GraphQLTesting; }
+	enumerable: true,
+	get: function () { return testing.GraphQLTesting; }
+});
+Object.keys(testing$1).forEach(function (k) {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: function () { return testing$1[k]; }
+	});
 });

package/build/cjs/graphql.cjs

@@ -5,39 +5,17 @@ var reactGraphql = require('@quilted/react-graphql');
 
 
 
-Object.defineProperty(exports, 'GraphQLFetchRequest', {
-  enumerable: true,
-  get: function () { return graphql.GraphQLFetchRequest; }
-});
-Object.defineProperty(exports, 'createGraphQLHttpFetch', {
-  enumerable: true,
-  get: function () { return graphql.createGraphQLHttpFetch; }
-});
-Object.defineProperty(exports, 'createGraphQLHttpStreamingFetch', {
-  enumerable: true,
-  get: function () { return graphql.createGraphQLHttpStreamingFetch; }
-});
-Object.defineProperty(exports, 'gql', {
-  enumerable: true,
-  get: function () { return graphql.gql; }
-});
-Object.defineProperty(exports, 'graphql', {
-  enumerable: true,
-  get: function () { return graphql.graphql; }
-});
-Object.defineProperty(exports, 'toGraphQLOperation', {
-  enumerable: true,
-  get: function () { return graphql.toGraphQLOperation; }
-});
-Object.defineProperty(exports, 'toGraphQLSource', {
-  enumerable: true,
-  get: function () { return graphql.toGraphQLSource; }
-});
 Object.defineProperty(exports, 'GraphQLContext', {
-  enumerable: true,
-  get: function () { return reactGraphql.GraphQLContext; }
+	enumerable: true,
+	get: function () { return reactGraphql.GraphQLContext; }
 });
 Object.defineProperty(exports, 'useGraphQLFetch', {
-  enumerable: true,
-  get: function () { return reactGraphql.useGraphQLFetch; }
+	enumerable: true,
+	get: function () { return reactGraphql.useGraphQLFetch; }
+});
+Object.keys(graphql).forEach(function (k) {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: function () { return graphql[k]; }
+	});
 });

package/build/esm/graphql/testing/matchers/operations.mjs

@@ -0,0 +1,40 @@
+import { matcherHint, EXPECTED_COLOR, printExpected } from 'jest-matcher-utils';
+import { normalizeOperation } from '@quilted/graphql/ast';
+import { assertIsGraphQLController, diffVariables } from './utilities.mjs';
+
+function toHavePerformedGraphQLOperation(graphql, operation, variables) {
+  assertIsGraphQLController(graphql, {
+    expectation: 'toHavePerformedGraphQLOperation',
+    isNot: this.isNot
+  });
+  const foundByOperation = graphql.completed.all({
+    operation
+  });
+  const foundByVariables = variables == null ? foundByOperation : foundByOperation.filter(operation => Object.keys(variables).every(key => this.equals(variables[key], (operation.variables ?? {})[key])));
+  const pass = foundByVariables.length > 0;
+  const {
+    name
+  } = normalizeOperation(operation);
+  const message = pass ? () => `${matcherHint('.not.toHavePerformedGraphQLOperation')}\n\n` + `Expected not to have performed GraphQL operation:\n  ${EXPECTED_COLOR(name)}\n${variables ? `With variables matching:\n  ${printExpected(variables)}\n` : ''}` + `But ${foundByVariables.length} matching ${foundByVariables.length === 1 ? 'operation was' : 'operations were'} found.\n` : () => `${`${matcherHint('.toHavePerformedGraphQLOperation')}\n\n` + `Expected to have performed GraphQL operation:\n  ${EXPECTED_COLOR(name)}\n${variables ? `With variables matching:\n  ${printExpected(variables)}\n` : ''}`}${foundByOperation.length === 0 ? `But no matching operations were found.\n` : `But the ${foundByVariables.length === 1 ? 'found operation has' : 'found operations have'} the following variable differences:\n\n${diffs(foundByVariables, variables, this.expand)}`}`;
+  return {
+    pass,
+    message
+  };
+}
+function diffs(requests, variables, expand) {
+  return requests.reduce((diffs, request, index) => `${diffs}${index === 0 ? '' : '\n\n'}${normalizedDiff(request, variables, {
+    expand,
+    showLegend: index === 0
+  })}`, '');
+}
+function normalizedDiff(request, variables, {
+  expand = false,
+  showLegend = false
+}) {
+  const result = diffVariables(request.variables ?? {}, variables, {
+    expand
+  }) || '';
+  return showLegend ? result : result.split('\n\n')[1];
+}
+
+export { toHavePerformedGraphQLOperation };

package/build/esm/graphql/testing/matchers/utilities.mjs

@@ -0,0 +1,40 @@
+import { matcherErrorMessage, matcherHint, RECEIVED_COLOR, printWithType, printReceived, diff } from 'jest-matcher-utils';
+import { GraphQLController } from '@quilted/graphql/testing';
+
+function assertIsGraphQLController(graphql, {
+  expectation,
+  isNot
+}) {
+  if (!(graphql instanceof GraphQLController)) {
+    throw new Error(matcherErrorMessage(matcherHint(`.${expectation}`, undefined, undefined, {
+      isNot
+    }), `${RECEIVED_COLOR('received')} value must be a @quilted/graphql/fixtures GraphQLController object`, printWithType('Received', graphql, printReceived)));
+  }
+}
+function diffVariables(actual, expected, {
+  expand = false
+}) {
+  return diff(expected, getObjectSubset(actual, expected), {
+    expand
+  });
+}
+
+// Original from https://github.com/facebook/jest/blob/master/packages/expect/source/utils.ts#L107
+function getObjectSubset(object, subset) {
+  if (Array.isArray(object)) {
+    if (Array.isArray(subset) && subset.length === object.length) {
+      return subset.map((sub, i) => getObjectSubset(object[i], sub));
+    }
+  } else if (object instanceof Date) {
+    return object;
+  } else if (typeof object === 'object' && object !== null && typeof subset === 'object' && subset !== null) {
+    const trimmed = {};
+    Object.keys(subset).filter(key => Reflect.has(object, key)).forEach(key => trimmed[key] = getObjectSubset(object[key], subset[key]));
+    if (Object.keys(trimmed).length > 0) {
+      return trimmed;
+    }
+  }
+  return object;
+}
+
+export { assertIsGraphQLController, diffVariables };

package/build/esm/graphql/testing/matchers.mjs

@@ -0,0 +1,8 @@
+import { expect } from '@quilted/testing';
+import { toHavePerformedGraphQLOperation } from './matchers/operations.mjs';
+
+expect.extend({
+  toHavePerformedGraphQLOperation,
+  toHavePerformedGraphQLQuery: toHavePerformedGraphQLOperation,
+  toHavePerformedGraphQLMutation: toHavePerformedGraphQLOperation
+});

package/build/esm/graphql/testing.mjs

@@ -1,2 +1,3 @@
-export { GraphQLController, createGraphQLFiller, createGraphQLSchema, gql, graphql } from '@quilted/graphql/testing';
+import './testing/matchers.mjs';
+export * from '@quilted/graphql/testing';
 export { GraphQLTesting } from '@quilted/react-graphql/testing';

package/build/esm/graphql.mjs

@@ -1,2 +1,2 @@
-export { GraphQLFetchRequest, createGraphQLHttpFetch, createGraphQLHttpStreamingFetch, gql, graphql, toGraphQLOperation, toGraphQLSource } from '@quilted/graphql';
+export * from '@quilted/graphql';
 export { GraphQLContext, useGraphQLFetch } from '@quilted/react-graphql';

package/build/esnext/graphql/testing/matchers/operations.esnext

@@ -0,0 +1,40 @@
+import { matcherHint, EXPECTED_COLOR, printExpected } from 'jest-matcher-utils';
+import { normalizeOperation } from '@quilted/graphql/ast';
+import { assertIsGraphQLController, diffVariables } from './utilities.esnext';
+
+function toHavePerformedGraphQLOperation(graphql, operation, variables) {
+  assertIsGraphQLController(graphql, {
+    expectation: 'toHavePerformedGraphQLOperation',
+    isNot: this.isNot
+  });
+  const foundByOperation = graphql.completed.all({
+    operation
+  });
+  const foundByVariables = variables == null ? foundByOperation : foundByOperation.filter(operation => Object.keys(variables).every(key => this.equals(variables[key], (operation.variables ?? {})[key])));
+  const pass = foundByVariables.length > 0;
+  const {
+    name
+  } = normalizeOperation(operation);
+  const message = pass ? () => `${matcherHint('.not.toHavePerformedGraphQLOperation')}\n\n` + `Expected not to have performed GraphQL operation:\n  ${EXPECTED_COLOR(name)}\n${variables ? `With variables matching:\n  ${printExpected(variables)}\n` : ''}` + `But ${foundByVariables.length} matching ${foundByVariables.length === 1 ? 'operation was' : 'operations were'} found.\n` : () => `${`${matcherHint('.toHavePerformedGraphQLOperation')}\n\n` + `Expected to have performed GraphQL operation:\n  ${EXPECTED_COLOR(name)}\n${variables ? `With variables matching:\n  ${printExpected(variables)}\n` : ''}`}${foundByOperation.length === 0 ? `But no matching operations were found.\n` : `But the ${foundByVariables.length === 1 ? 'found operation has' : 'found operations have'} the following variable differences:\n\n${diffs(foundByVariables, variables, this.expand)}`}`;
+  return {
+    pass,
+    message
+  };
+}
+function diffs(requests, variables, expand) {
+  return requests.reduce((diffs, request, index) => `${diffs}${index === 0 ? '' : '\n\n'}${normalizedDiff(request, variables, {
+    expand,
+    showLegend: index === 0
+  })}`, '');
+}
+function normalizedDiff(request, variables, {
+  expand = false,
+  showLegend = false
+}) {
+  const result = diffVariables(request.variables ?? {}, variables, {
+    expand
+  }) || '';
+  return showLegend ? result : result.split('\n\n')[1];
+}
+
+export { toHavePerformedGraphQLOperation };

package/build/esnext/graphql/testing/matchers/utilities.esnext

@@ -0,0 +1,40 @@
+import { matcherErrorMessage, matcherHint, RECEIVED_COLOR, printWithType, printReceived, diff } from 'jest-matcher-utils';
+import { GraphQLController } from '@quilted/graphql/testing';
+
+function assertIsGraphQLController(graphql, {
+  expectation,
+  isNot
+}) {
+  if (!(graphql instanceof GraphQLController)) {
+    throw new Error(matcherErrorMessage(matcherHint(`.${expectation}`, undefined, undefined, {
+      isNot
+    }), `${RECEIVED_COLOR('received')} value must be a @quilted/graphql/fixtures GraphQLController object`, printWithType('Received', graphql, printReceived)));
+  }
+}
+function diffVariables(actual, expected, {
+  expand = false
+}) {
+  return diff(expected, getObjectSubset(actual, expected), {
+    expand
+  });
+}
+
+// Original from https://github.com/facebook/jest/blob/master/packages/expect/source/utils.ts#L107
+function getObjectSubset(object, subset) {
+  if (Array.isArray(object)) {
+    if (Array.isArray(subset) && subset.length === object.length) {
+      return subset.map((sub, i) => getObjectSubset(object[i], sub));
+    }
+  } else if (object instanceof Date) {
+    return object;
+  } else if (typeof object === 'object' && object !== null && typeof subset === 'object' && subset !== null) {
+    const trimmed = {};
+    Object.keys(subset).filter(key => Reflect.has(object, key)).forEach(key => trimmed[key] = getObjectSubset(object[key], subset[key]));
+    if (Object.keys(trimmed).length > 0) {
+      return trimmed;
+    }
+  }
+  return object;
+}
+
+export { assertIsGraphQLController, diffVariables };

package/build/esnext/graphql/testing/matchers.esnext

@@ -0,0 +1,8 @@
+import { expect } from '@quilted/testing';
+import { toHavePerformedGraphQLOperation } from './matchers/operations.esnext';
+
+expect.extend({
+  toHavePerformedGraphQLOperation,
+  toHavePerformedGraphQLQuery: toHavePerformedGraphQLOperation,
+  toHavePerformedGraphQLMutation: toHavePerformedGraphQLOperation
+});

package/build/esnext/graphql/testing.esnext

@@ -1,2 +1,3 @@
-export { GraphQLController, createGraphQLFiller, createGraphQLSchema, gql, graphql } from '@quilted/graphql/testing';
+import './testing/matchers.esnext';
+export * from '@quilted/graphql/testing';
 export { GraphQLTesting } from '@quilted/react-graphql/testing';

package/build/esnext/graphql.esnext

@@ -1,2 +1,2 @@
-export { GraphQLFetchRequest, createGraphQLHttpFetch, createGraphQLHttpStreamingFetch, gql, graphql, toGraphQLOperation, toGraphQLSource } from '@quilted/graphql';
+export * from '@quilted/graphql';
 export { GraphQLContext, useGraphQLFetch } from '@quilted/react-graphql';