@graphql-tools/mock 8.4.4 → 8.5.0

package/index.d.ts

@@ -3,3 +3,4 @@ export * from './addMocksToSchema';
 export * from './mockServer';
 export * from './types';
 export * from './MockList';
+export * from './pagination';

package/index.js

@@ -59,6 +59,10 @@ function copyOwnProps(target, ...sources) {
     }
     return target;
 }
+const isRootType = (type, schema) => {
+    const rootTypeNames = utils.getRootTypeNames(schema);
+    return rootTypeNames.has(type.name);
+};
 
 /**
  * @internal
@@ -801,10 +805,6 @@ function addMocksToSchema({ schema: schema$1, store: maybeStore, mocks, typePoli
     });
     return resolvers ? schema.addResolversToSchema(schemaWithMocks, resolvers) : schemaWithMocks;
 }
-const isRootType = (type, schema) => {
-    const rootTypeNames = utils.getRootTypeNames(schema);
-    return rootTypeNames.has(type.name);
-};
 
 /**
  * A convenience wrapper on top of addMocksToSchema. It adds your mock resolvers
@@ -839,6 +839,76 @@ function mockServer(schema$1, mocks, preserveResolvers = false) {
     };
 }
 
+/**
+ * Produces a resolver that'll mock a [Relay-style cursor pagination](https://relay.dev/graphql/connections.htm).
+ *
+ * ```ts
+ * const schemaWithMocks = addMocksToSchema({
+ *   schema,
+ *   resolvers: (store) => ({
+ *     User: {
+ *       friends: relayStylePaginationMock(store),
+ *     }
+ *   }),
+ * })
+ * ```
+ * @param store the MockStore
+ */
+const relayStylePaginationMock = (store, { cursorFn = node => `${node.$ref.key}`, applyOnNodes, allNodesFn, } = {}) => {
+    return (parent, args, context, info) => {
+        const source = isRootType(info.parentType, info.schema) ? makeRef(info.parentType.name, 'ROOT') : parent;
+        const allNodesFn_ = allNodesFn !== null && allNodesFn !== void 0 ? allNodesFn : defaultAllNodesFn(store);
+        let allNodes = allNodesFn_(source, args, context, info);
+        if (applyOnNodes) {
+            allNodes = applyOnNodes(allNodes, args);
+        }
+        const allEdges = allNodes.map(node => ({
+            node,
+            cursor: cursorFn(node),
+        }));
+        let start, end;
+        const { first, after, last, before } = args;
+        if (typeof first === 'number') {
+            // forward pagination
+            if (last || before) {
+                throw new Error("if `first` is provided, `last` or `before` can't be provided");
+            }
+            const afterIndex = after ? allEdges.findIndex(e => e.cursor === after) : -1;
+            start = afterIndex + 1;
+            end = afterIndex + 1 + first;
+        }
+        else if (typeof last === 'number') {
+            // backward pagination
+            if (first || after) {
+                throw new Error("if `last` is provided, `first` or `after` can't be provided");
+            }
+            const foundBeforeIndex = before ? allEdges.findIndex(e => e.cursor === before) : -1;
+            const beforeIndex = foundBeforeIndex !== -1 ? foundBeforeIndex : allNodes.length;
+            start = allEdges.length - (allEdges.length - beforeIndex) - last;
+            // negative index on Array.slice indicate offset from end of sequence => we don't want
+            if (start < 0)
+                start = 0;
+            end = beforeIndex;
+        }
+        else {
+            throw new Error('A `first` or a `last` arguments should be provided');
+        }
+        const edges = allEdges.slice(start, end);
+        const pageInfo = {
+            startCursor: edges.length > 0 ? edges[0].cursor : '',
+            endCursor: edges.length > 0 ? edges[edges.length - 1].cursor : '',
+            hasNextPage: end < allEdges.length - 1,
+            hasPreviousPage: start > 0,
+        };
+        return {
+            edges,
+            pageInfo,
+            totalCount: allEdges.length,
+        };
+    };
+};
+const defaultAllNodesFn = (store) => (parent, _, __, info) => store.get(parent, [info.fieldName, 'edges']).map(e => store.get(e, 'node'));
+
 exports.MockList = MockList;
 exports.MockStore = MockStore;
 exports.addMocksToSchema = addMocksToSchema;
@@ -850,3 +920,4 @@ exports.isMockList = isMockList;
 exports.isRecord = isRecord;
 exports.isRef = isRef;
 exports.mockServer = mockServer;
+exports.relayStylePaginationMock = relayStylePaginationMock;

package/index.mjs

@@ -1,6 +1,6 @@
 import { isNullableType, getNullableType, isCompositeType, isAbstractType, isListType, isScalarType, isEnumType, isObjectType, GraphQLString, isInterfaceType, isSchema, isUnionType, GraphQLUnionType, GraphQLInterfaceType, defaultFieldResolver, graphql } from 'graphql';
 import stringify from 'fast-json-stable-stringify';
-import { mapSchema, MapperKind, getRootTypeNames } from '@graphql-tools/utils';
+import { getRootTypeNames, mapSchema, MapperKind } from '@graphql-tools/utils';
 import { addResolversToSchema, makeExecutableSchema } from '@graphql-tools/schema';
 
 function isRef(maybeRef) {
@@ -53,6 +53,10 @@ function copyOwnProps(target, ...sources) {
     }
     return target;
 }
+const isRootType = (type, schema) => {
+    const rootTypeNames = getRootTypeNames(schema);
+    return rootTypeNames.has(type.name);
+};
 
 /**
  * @internal
@@ -795,10 +799,6 @@ function addMocksToSchema({ schema, store: maybeStore, mocks, typePolicies, reso
     });
     return resolvers ? addResolversToSchema(schemaWithMocks, resolvers) : schemaWithMocks;
 }
-const isRootType = (type, schema) => {
-    const rootTypeNames = getRootTypeNames(schema);
-    return rootTypeNames.has(type.name);
-};
 
 /**
  * A convenience wrapper on top of addMocksToSchema. It adds your mock resolvers
@@ -833,4 +833,74 @@ function mockServer(schema, mocks, preserveResolvers = false) {
     };
 }
 
-export { MockList, MockStore, addMocksToSchema, assertIsRef, createMockStore, deepResolveMockList, defaultMocks, isMockList, isRecord, isRef, mockServer };
+/**
+ * Produces a resolver that'll mock a [Relay-style cursor pagination](https://relay.dev/graphql/connections.htm).
+ *
+ * ```ts
+ * const schemaWithMocks = addMocksToSchema({
+ *   schema,
+ *   resolvers: (store) => ({
+ *     User: {
+ *       friends: relayStylePaginationMock(store),
+ *     }
+ *   }),
+ * })
+ * ```
+ * @param store the MockStore
+ */
+const relayStylePaginationMock = (store, { cursorFn = node => `${node.$ref.key}`, applyOnNodes, allNodesFn, } = {}) => {
+    return (parent, args, context, info) => {
+        const source = isRootType(info.parentType, info.schema) ? makeRef(info.parentType.name, 'ROOT') : parent;
+        const allNodesFn_ = allNodesFn !== null && allNodesFn !== void 0 ? allNodesFn : defaultAllNodesFn(store);
+        let allNodes = allNodesFn_(source, args, context, info);
+        if (applyOnNodes) {
+            allNodes = applyOnNodes(allNodes, args);
+        }
+        const allEdges = allNodes.map(node => ({
+            node,
+            cursor: cursorFn(node),
+        }));
+        let start, end;
+        const { first, after, last, before } = args;
+        if (typeof first === 'number') {
+            // forward pagination
+            if (last || before) {
+                throw new Error("if `first` is provided, `last` or `before` can't be provided");
+            }
+            const afterIndex = after ? allEdges.findIndex(e => e.cursor === after) : -1;
+            start = afterIndex + 1;
+            end = afterIndex + 1 + first;
+        }
+        else if (typeof last === 'number') {
+            // backward pagination
+            if (first || after) {
+                throw new Error("if `last` is provided, `first` or `after` can't be provided");
+            }
+            const foundBeforeIndex = before ? allEdges.findIndex(e => e.cursor === before) : -1;
+            const beforeIndex = foundBeforeIndex !== -1 ? foundBeforeIndex : allNodes.length;
+            start = allEdges.length - (allEdges.length - beforeIndex) - last;
+            // negative index on Array.slice indicate offset from end of sequence => we don't want
+            if (start < 0)
+                start = 0;
+            end = beforeIndex;
+        }
+        else {
+            throw new Error('A `first` or a `last` arguments should be provided');
+        }
+        const edges = allEdges.slice(start, end);
+        const pageInfo = {
+            startCursor: edges.length > 0 ? edges[0].cursor : '',
+            endCursor: edges.length > 0 ? edges[edges.length - 1].cursor : '',
+            hasNextPage: end < allEdges.length - 1,
+            hasPreviousPage: start > 0,
+        };
+        return {
+            edges,
+            pageInfo,
+            totalCount: allEdges.length,
+        };
+    };
+};
+const defaultAllNodesFn = (store) => (parent, _, __, info) => store.get(parent, [info.fieldName, 'edges']).map(e => store.get(e, 'node'));
+
+export { MockList, MockStore, addMocksToSchema, assertIsRef, createMockStore, deepResolveMockList, defaultMocks, isMockList, isRecord, isRef, mockServer, relayStylePaginationMock };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/mock",
-  "version": "8.4.4",
+  "version": "8.5.0",
   "description": "A set of utils for faster development of GraphQL tools",
   "sideEffects": false,
   "peerDependencies": {
@@ -32,6 +32,7 @@
     "./*": {
       "require": "./*.js",
       "import": "./*.mjs"
-    }
+    },
+    "./package.json": "./package.json"
   }
 }

package/pagination.d.ts

@@ -0,0 +1,86 @@
+import { IFieldResolver } from '@graphql-tools/utils';
+import { GraphQLResolveInfo } from 'graphql';
+import { IMockStore, Ref } from './types';
+export declare type AllNodesFn<TContext, TArgs extends RelayPaginationParams> = (parent: Ref, args: TArgs, context: TContext, info: GraphQLResolveInfo) => Ref[];
+export declare type RelayStylePaginationMockOptions<TContext, TArgs extends RelayPaginationParams> = {
+    /**
+     * Use this option to apply filtering or sorting on the nodes given the
+     * arguments the paginated field receives.
+     *
+     * ```ts
+     * {
+     *    User: {
+     *      friends: mockedRelayStylePagination<
+     *        unknown,
+     *        RelayPaginationParams & { sortByBirthdateDesc?: boolean}
+     *      >(
+     *        store, {
+     *          applyOnEdges: (edges, { sortByBirthdateDesc }) => {
+     *            if (!sortByBirthdateDesc) return edges
+     *            return _.sortBy(edges, (e) => store.get(e, ['node', 'birthdate']))
+     *          }
+     *       }),
+     *    }
+     * }
+     * ```
+     */
+    applyOnNodes?: (nodeRefs: Ref[], args: TArgs) => Ref[];
+    /**
+     * A function that'll be used to get all the nodes used for pagination.
+     *
+     * By default, it will use the nodes of the field this pagination is attached to.
+     *
+     * This option is handy when several paginable fields should share
+     * the same base nodes:
+     * ```ts
+     * {
+     *    User: {
+     *      friends: mockedRelayStylePagination(store),
+     *      maleFriends: mockedRelayStylePagination(store, {
+     *        allNodesFn: (userRef) =>
+     *          store
+     *           .get(userRef, ['friends', 'edges'])
+     *           .map((e) => store.get(e, 'node'))
+     *           .filter((userRef) => store.get(userRef, 'sex') === 'male')
+     *      })
+     *    }
+     * }
+     * ```
+     */
+    allNodesFn?: AllNodesFn<TContext, TArgs>;
+    /**
+     * The function that'll be used to compute the cursor of a node.
+     *
+     * By default, it'll use `MockStore` internal reference `Ref`'s `key`
+     * as cursor.
+     */
+    cursorFn?: (nodeRef: Ref) => string;
+};
+export declare type RelayPaginationParams = {
+    first?: number;
+    after?: string;
+    last?: number;
+    before?: string;
+};
+export declare type RelayPageInfo = {
+    hasPreviousPage: boolean;
+    hasNextPage: boolean;
+    startCursor: string;
+    endCursor: string;
+};
+/**
+ * Produces a resolver that'll mock a [Relay-style cursor pagination](https://relay.dev/graphql/connections.htm).
+ *
+ * ```ts
+ * const schemaWithMocks = addMocksToSchema({
+ *   schema,
+ *   resolvers: (store) => ({
+ *     User: {
+ *       friends: relayStylePaginationMock(store),
+ *     }
+ *   }),
+ * })
+ * ```
+ * @param store the MockStore
+ */
+export declare const relayStylePaginationMock: <TContext, TArgs extends RelayPaginationParams = RelayPaginationParams>(store: IMockStore, { cursorFn, applyOnNodes, allNodesFn, }?: RelayStylePaginationMockOptions<TContext, TArgs>) => IFieldResolver<Ref<string>, TContext, TArgs, any>;

package/utils.d.ts

@@ -1,3 +1,4 @@
+import { GraphQLObjectType, GraphQLSchema } from 'graphql';
 import { Ref, KeyTypeConstraints } from './types';
 export declare function uuidv4(): string;
 export declare const randomListLength: () => number;
@@ -6,3 +7,4 @@ export declare function makeRef<KeyT extends KeyTypeConstraints = string>(typeNa
 export declare function isObject(thing: any): boolean;
 export declare function copyOwnPropsIfNotPresent(target: Record<string, any>, source: Record<string, any>): void;
 export declare function copyOwnProps(target: Record<string, any>, ...sources: Array<Record<string, any>>): Record<string, any>;
+export declare const isRootType: (type: GraphQLObjectType, schema: GraphQLSchema) => boolean;