graphile-test 2.8.6 → 2.8.8

package/README.md

@@ -194,6 +194,19 @@ expect(result.data.createUser.username).toBe('alice');
 * Start with `getConnections()` for most use cases.
 * Consider `getConnectionsUnwrapped()` for cleaner test assertions.
 
+## Snapshot Utilities
+
+The `graphile-test/utils` module provides utilities for sanitizing query results for snapshot testing. These helpers replace dynamic values (IDs, UUIDs, dates, hashes) with stable placeholders, making snapshots deterministic.
+
+```ts
+import { snapshot } from 'graphile-test/utils';
+
+const res = await query(`query { allUsers { nodes { id name createdAt } } }`);
+expect(snapshot(res.data)).toMatchSnapshot();
+```
+
+See [`pgsql-test` Snapshot Utilities](https://www.npmjs.com/package/pgsql-test#snapshot-utilities) for the full API reference.
+
 ---
 
 ## Education and Tutorials

package/esm/get-connections.js

@@ -27,7 +27,8 @@ const createConnectionsBase = async (input, seedAdapters) => {
         db,
         teardown,
         baseQuery,
-        baseQueryPositional
+        baseQueryPositional,
+        gqlContext
     };
 };
 // ============================================================================
@@ -37,12 +38,13 @@ const createConnectionsBase = async (input, seedAdapters) => {
  * Creates connections with raw GraphQL responses
  */
 export const getConnectionsObject = async (input, seedAdapters) => {
-    const { pg, db, teardown, baseQuery } = await createConnectionsBase(input, seedAdapters);
+    const { pg, db, teardown, baseQuery, gqlContext } = await createConnectionsBase(input, seedAdapters);
     return {
         pg,
         db,
         teardown,
-        query: baseQuery
+        query: baseQuery,
+        gqlContext
     };
 };
 /**

package/esm/index.js

@@ -1,6 +1,5 @@
-export * from './clean';
 export * from './context';
 export * from './get-connections';
 export * from './graphile-test';
 export * from './types';
-export { seed } from 'pgsql-test';
+export { seed, snapshot } from 'pgsql-test';

package/esm/utils.js

@@ -0,0 +1 @@
+export * from 'pgsql-test/utils';

package/get-connections.d.ts

@@ -1,7 +1,7 @@
 import type { GetConnectionOpts } from 'pgsql-test';
 import type { SeedAdapter } from 'pgsql-test/seed/types';
 import type { PgTestClient } from 'pgsql-test/test-client';
-import type { GetConnectionsInput, GraphQLQueryFn, GraphQLQueryFnObj, GraphQLQueryUnwrappedFn, GraphQLQueryUnwrappedFnObj } from './types';
+import type { GetConnectionsInput, GraphQLQueryFn, GraphQLQueryFnObj, GraphQLQueryUnwrappedFn, GraphQLQueryUnwrappedFnObj, GraphQLTestContext } from './types';
 /**
  * Creates connections with raw GraphQL responses
  */
@@ -10,6 +10,7 @@ export declare const getConnectionsObject: (input: GetConnectionsInput & GetConn
     db: PgTestClient;
     teardown: () => Promise<void>;
     query: GraphQLQueryFnObj;
+    gqlContext: GraphQLTestContext;
 }>;
 /**
  * Creates connections with unwrapped GraphQL responses (throws on errors)

package/get-connections.js

@@ -30,7 +30,8 @@ const createConnectionsBase = async (input, seedAdapters) => {
         db,
         teardown,
         baseQuery,
-        baseQueryPositional
+        baseQueryPositional,
+        gqlContext
     };
 };
 // ============================================================================
@@ -40,12 +41,13 @@ const createConnectionsBase = async (input, seedAdapters) => {
  * Creates connections with raw GraphQL responses
  */
 const getConnectionsObject = async (input, seedAdapters) => {
-    const { pg, db, teardown, baseQuery } = await createConnectionsBase(input, seedAdapters);
+    const { pg, db, teardown, baseQuery, gqlContext } = await createConnectionsBase(input, seedAdapters);
     return {
         pg,
         db,
         teardown,
-        query: baseQuery
+        query: baseQuery,
+        gqlContext
     };
 };
 exports.getConnectionsObject = getConnectionsObject;

package/index.d.ts

@@ -1,6 +1,5 @@
-export * from './clean';
 export * from './context';
 export * from './get-connections';
 export * from './graphile-test';
 export * from './types';
-export { seed } from 'pgsql-test';
+export { seed, snapshot } from 'pgsql-test';

package/index.js

@@ -14,11 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.seed = void 0;
-__exportStar(require("./clean"), exports);
+exports.snapshot = exports.seed = void 0;
 __exportStar(require("./context"), exports);
 __exportStar(require("./get-connections"), exports);
 __exportStar(require("./graphile-test"), exports);
 __exportStar(require("./types"), exports);
 var pgsql_test_1 = require("pgsql-test");
 Object.defineProperty(exports, "seed", { enumerable: true, get: function () { return pgsql_test_1.seed; } });
+Object.defineProperty(exports, "snapshot", { enumerable: true, get: function () { return pgsql_test_1.snapshot; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-test",
-  "version": "2.8.6",
+  "version": "2.8.8",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "description": "PostGraphile Testing",
   "main": "index.js",
@@ -38,7 +38,7 @@
     "graphql": "15.10.1",
     "mock-req": "^0.2.0",
     "pg": "^8.16.0",
-    "pgsql-test": "^2.14.9",
+    "pgsql-test": "^2.14.11",
     "postgraphile": "^4.14.1"
   },
   "keywords": [
@@ -48,5 +48,5 @@
     "launchql",
     "test"
   ],
-  "gitHead": "1da5f98bd18b47382b652e104cdc4db1b9ee79db"
+  "gitHead": "ff477433074d91c28be6017e858b601fa99aa568"
 }

package/utils.d.ts

@@ -0,0 +1 @@
+export * from 'pgsql-test/utils';

package/utils.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("pgsql-test/utils"), exports);