graphql-http 1.11.0 → 1.12.0

package/lib/audits/server.mjs

@@ -3,7 +3,7 @@
  * audit/server
  *
  */
-import { assert, assertBodyAsExecutionResult, audit, extendedTypeof, } from './utils.mjs';
+import { ressert, audit, extendedTypeof, AuditError } from './utils.mjs';
 /**
  * List of server audits required to check GraphQL over HTTP spec conformance.
  *
@@ -24,8 +24,10 @@ export function serverAudits(opts) {
                 },
                 body: JSON.stringify({ query: '{ __typename }' }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Content-Type header', res.headers.get('content-type')).toContain('application/graphql-response+json');
+            ressert(res).status.toBe(200);
+            ressert(res)
+                .header('content-type')
+                .toContain('application/graphql-response+json');
         }),
         audit('MUST accept application/json and match the content-type', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -36,8 +38,8 @@ export function serverAudits(opts) {
                 },
                 body: JSON.stringify({ query: '{ __typename }' }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Content-Type header', res.headers.get('content-type')).toContain('application/json');
+            ressert(res).status.toBe(200);
+            ressert(res).header('content-type').toContain('application/json');
         }),
         audit('SHOULD accept */* and use application/json for the content-type', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -48,15 +50,15 @@ export function serverAudits(opts) {
                 },
                 body: JSON.stringify({ query: '{ __typename }' }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Content-Type header', res.headers.get('content-type')).toContain('application/json');
+            ressert(res).status.toBe(200);
+            ressert(res).header('content-type').toContain('application/json');
         }),
         audit('SHOULD assume application/json content-type when accept is missing', async () => {
             const url = new URL(await getUrl(opts.url));
             url.searchParams.set('query', '{ __typename }');
             const res = await fetchFn(url.toString());
-            assert('Status code', res.status).toBe(200);
-            assert('Content-Type header', res.headers.get('content-type')).toContain('application/json');
+            ressert(res).status.toBe(200);
+            ressert(res).header('content-type').toContain('application/json');
         }),
         audit('MUST use utf-8 encoding when responding', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -66,28 +68,16 @@ export function serverAudits(opts) {
                 },
                 body: JSON.stringify({ query: '{ __typename }' }),
             });
-            assert('Status code', res.status).toBe(200);
-            // has charset set to utf-8
-            try {
-                assert('Content-Type header', res.headers.get('content-type')).toContain('charset=utf-8');
-                return;
-            }
-            catch (_a) {
-                // noop, continue
-            }
-            // has no charset specified
-            assert('Content-Type header', res.headers.get('content-type')).notToContain('charset');
-            // and the content is utf-8 encoded
+            ressert(res).status.toBe(200);
             try {
                 const decoder = new TextDecoder('utf-8');
-                const decoded = decoder.decode(await res.arrayBuffer());
-                assert('UTF-8 decoded body', decoded).toBe('{"data":{"__typename":"Query"}}');
+                decoder.decode(await res.arrayBuffer());
             }
-            catch (_b) {
-                throw 'Body is not UTF-8 encoded';
+            catch (_a) {
+                throw new AuditError(res, 'Response body is not UTF-8 encoded');
             }
         }),
-        audit('MUST accept utf-8 encoding', async () => {
+        audit('MUST accept utf-8 encoded request', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
                 method: 'POST',
                 headers: {
@@ -95,10 +85,9 @@ export function serverAudits(opts) {
                 },
                 body: JSON.stringify({ query: '{ __typename }' }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Content-Type header', res.headers.get('content-type')).toContain('utf-8');
+            ressert(res).status.toBe(200);
         }),
-        audit('MUST assume utf-8 if encoding is unspecified', async () => {
+        audit('MUST assume utf-8 in request if encoding is unspecified', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
                 method: 'POST',
                 headers: {
@@ -106,8 +95,7 @@ export function serverAudits(opts) {
                 },
                 body: JSON.stringify({ query: '{ __typename }' }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Content-Type header', res.headers.get('content-type')).toContain('utf-8');
+            ressert(res).status.toBe(200);
         }),
         // Request
         audit('MUST accept POST requests', async () => {
@@ -116,13 +104,13 @@ export function serverAudits(opts) {
                 headers: { 'content-type': 'application/json' },
                 body: JSON.stringify({ query: '{ __typename }' }),
             });
-            assert('Status code', res.status).toBe(200);
+            ressert(res).status.toBe(200);
         }),
         audit('MAY accept application/x-www-form-urlencoded formatted GET requests', async () => {
             const url = new URL(await getUrl(opts.url));
             url.searchParams.set('query', '{ __typename }');
             const res = await fetchFn(url.toString());
-            assert('Status code', res.status).toBe(200);
+            ressert(res).status.toBe(200);
         }),
         // Request GET
         // TODO: this is a MUST if the server supports GET requests
@@ -134,14 +122,14 @@ export function serverAudits(opts) {
                     accept: 'application/graphql-response+json',
                 },
             });
-            assert('Status code', res.status).toBeBetween(400, 499);
+            ressert(res).status.toBeBetween(400, 499);
         }),
         // Request POST
         audit('SHOULD respond with 4xx status code if content-type is not supplied on POST requests', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
                 method: 'POST',
             });
-            assert('Status code', res.status).toBeBetween(400, 499);
+            ressert(res).status.toBeBetween(400, 499);
         }),
         audit('MUST accept application/json POST requests', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -149,7 +137,7 @@ export function serverAudits(opts) {
                 headers: { 'content-type': 'application/json' },
                 body: JSON.stringify({ query: '{ __typename }' }),
             });
-            assert('Status code', res.status).toBe(200);
+            ressert(res).status.toBe(200);
         }),
         audit('MUST require a request body on POST', async () => {
             var _a;
@@ -158,10 +146,10 @@ export function serverAudits(opts) {
                 headers: { 'content-type': 'application/json' },
             });
             if ((_a = res.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.includes('application/json')) {
-                assert('Execution result', await assertBodyAsExecutionResult(res)).toHaveProperty('errors');
+                await ressert(res).bodyAsExecutionResult.toHaveProperty('errors');
             }
             else {
-                assert('Status code', res.status).toBe(400);
+                ressert(res).status.toBe(400);
             }
         }),
         // Request Parameters
@@ -176,7 +164,7 @@ export function serverAudits(opts) {
                 },
                 body: JSON.stringify({ notquery: '{ __typename }' }),
             });
-            assert('Status code', res.status).toBe(400);
+            ressert(res).status.toBe(400);
         }),
         audit('SHOULD use 200 status code with errors field on missing {query} parameter when accepting application/json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -187,8 +175,8 @@ export function serverAudits(opts) {
                 },
                 body: JSON.stringify({ notquery: '{ __typename }' }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Execution result', await assertBodyAsExecutionResult(res)).toHaveProperty('errors');
+            ressert(res).status.toBe(200);
+            await ressert(res).bodyAsExecutionResult.toHaveProperty('errors');
         }),
         ...[{ obj: 'ect' }, 0, false, ['array']].map((invalid) => audit(
         // TODO: convert to MUST after watershed
@@ -203,7 +191,7 @@ export function serverAudits(opts) {
                     query: invalid,
                 }),
             });
-            assert('Status code', res.status).toBe(400);
+            ressert(res).status.toBe(400);
         })),
         ...[{ obj: 'ect' }, 0, false, ['array']].map((invalid) => audit(`SHOULD use 200 status code with errors field on ${extendedTypeof(invalid)} {query} parameter when accepting application/json`, async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -216,8 +204,8 @@ export function serverAudits(opts) {
                     query: invalid,
                 }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Execution result', await assertBodyAsExecutionResult(res)).toHaveProperty('errors');
+            ressert(res).status.toBe(200);
+            await ressert(res).bodyAsExecutionResult.toHaveProperty('errors');
         })),
         audit(
         // TODO: convert to MUST after watershed
@@ -232,7 +220,7 @@ export function serverAudits(opts) {
                     query: '{ __typename }',
                 }),
             });
-            assert('Status code', res.status).toBe(200);
+            ressert(res).status.toBe(200);
         }),
         audit('MUST allow string {query} parameter when accepting application/json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -245,8 +233,8 @@ export function serverAudits(opts) {
                     query: '{ __typename }',
                 }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Execution result', await assertBodyAsExecutionResult(res)).notToHaveProperty('errors');
+            ressert(res).status.toBe(200);
+            await ressert(res).bodyAsExecutionResult.notToHaveProperty('errors');
         }),
         ...[{ obj: 'ect' }, 0, false, ['array']].map((invalid) => audit(
         // TODO: convert to MUST after watershed
@@ -262,7 +250,7 @@ export function serverAudits(opts) {
                     query: '{ __typename }',
                 }),
             });
-            assert('Status code', res.status).toBe(400);
+            ressert(res).status.toBe(400);
         })),
         ...[{ obj: 'ect' }, 0, false, ['array']].map((invalid) => audit(`SHOULD use 200 status code with errors field on ${extendedTypeof(invalid)} {operationName} parameter when accepting application/json`, async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -276,8 +264,8 @@ export function serverAudits(opts) {
                     query: '{ __typename }',
                 }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Execution result', await assertBodyAsExecutionResult(res)).toHaveProperty('errors');
+            ressert(res).status.toBe(200);
+            await ressert(res).bodyAsExecutionResult.toHaveProperty('errors');
         })),
         audit(
         // TODO: convert to MUST after watershed
@@ -293,7 +281,7 @@ export function serverAudits(opts) {
                     query: 'query Query { __typename }',
                 }),
             });
-            assert('Status code', res.status).toBe(200);
+            ressert(res).status.toBe(200);
         }),
         audit('MUST allow string {operationName} parameter when accepting application/json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -307,8 +295,8 @@ export function serverAudits(opts) {
                     query: 'query Query { __typename }',
                 }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Execution result', await assertBodyAsExecutionResult(res)).notToHaveProperty('errors');
+            ressert(res).status.toBe(200);
+            await ressert(res).bodyAsExecutionResult.notToHaveProperty('errors');
         }),
         ...['variables', 'operationName', 'extensions'].flatMap((parameter) => [
             audit(
@@ -325,8 +313,8 @@ export function serverAudits(opts) {
                         [parameter]: null,
                     }),
                 });
-                assert('Status code', res.status).toBe(200);
-                assert('Execution result', await assertBodyAsExecutionResult(res)).notToHaveProperty('errors');
+                ressert(res).status.toBe(200);
+                await ressert(res).bodyAsExecutionResult.notToHaveProperty('errors');
             }),
             audit(`MUST allow null {${parameter}} parameter when accepting application/json`, async () => {
                 const res = await fetchFn(await getUrl(opts.url), {
@@ -340,8 +328,8 @@ export function serverAudits(opts) {
                         [parameter]: null,
                     }),
                 });
-                assert('Status code', res.status).toBe(200);
-                assert('Execution result', await assertBodyAsExecutionResult(res)).notToHaveProperty('errors');
+                ressert(res).status.toBe(200);
+                await ressert(res).bodyAsExecutionResult.notToHaveProperty('errors');
             }),
         ]),
         ...['string', 0, false, ['array']].map((invalid) => audit(
@@ -358,7 +346,7 @@ export function serverAudits(opts) {
                     variables: invalid,
                 }),
             });
-            assert('Status code', res.status).toBe(400);
+            ressert(res).status.toBe(400);
         })),
         ...['string', 0, false, ['array']].map((invalid) => audit(`SHOULD use 200 status code with errors field on ${extendedTypeof(invalid)} {variables} parameter when accepting application/json`, async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -372,8 +360,8 @@ export function serverAudits(opts) {
                     variables: invalid,
                 }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Execution result', await assertBodyAsExecutionResult(res)).toHaveProperty('errors');
+            ressert(res).status.toBe(200);
+            await ressert(res).bodyAsExecutionResult.toHaveProperty('errors');
         })),
         audit(
         // TODO: convert to MUST after watershed
@@ -389,7 +377,7 @@ export function serverAudits(opts) {
                     variables: { name: 'sometype' },
                 }),
             });
-            assert('Status code', res.status).toBe(200);
+            ressert(res).status.toBe(200);
         }),
         audit('MUST allow map {variables} parameter when accepting application/json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -403,8 +391,8 @@ export function serverAudits(opts) {
                     variables: { name: 'sometype' },
                 }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Execution result', await assertBodyAsExecutionResult(res)).notToHaveProperty('errors');
+            ressert(res).status.toBe(200);
+            await ressert(res).bodyAsExecutionResult.notToHaveProperty('errors');
         }),
         audit('MAY allow URL-encoded JSON string {variables} parameter in GETs when accepting application/graphql-response+json', async () => {
             const url = new URL(await getUrl(opts.url));
@@ -416,7 +404,7 @@ export function serverAudits(opts) {
                     accept: 'application/graphql-response+json',
                 },
             });
-            assert('Status code', res.status).toBe(200);
+            ressert(res).status.toBe(200);
         }),
         audit('MAY allow URL-encoded JSON string {variables} parameter in GETs when accepting application/json', async () => {
             const url = new URL(await getUrl(opts.url));
@@ -428,8 +416,8 @@ export function serverAudits(opts) {
                     accept: 'application/json',
                 },
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Execution result', await assertBodyAsExecutionResult(res)).notToHaveProperty('errors');
+            ressert(res).status.toBe(200);
+            await ressert(res).bodyAsExecutionResult.notToHaveProperty('errors');
         }),
         ...['string', 0, false, ['array']].map((invalid) => audit(
         // TODO: convert to MUST after watershed
@@ -445,7 +433,7 @@ export function serverAudits(opts) {
                     extensions: invalid,
                 }),
             });
-            assert('Status code', res.status).toBe(400);
+            ressert(res).status.toBe(400);
         })),
         ...['string', 0, false, ['array']].map((invalid) => audit(`SHOULD use 200 status code with errors field on ${extendedTypeof(invalid)} {extensions} parameter when accepting application/json`, async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -459,8 +447,8 @@ export function serverAudits(opts) {
                     extensions: invalid,
                 }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Execution result', await assertBodyAsExecutionResult(res)).toHaveProperty('errors');
+            ressert(res).status.toBe(200);
+            await ressert(res).bodyAsExecutionResult.toHaveProperty('errors');
         })),
         audit(
         // TODO: convert to MUST after watershed
@@ -476,7 +464,7 @@ export function serverAudits(opts) {
                     extensions: { some: 'value' },
                 }),
             });
-            assert('Status code', res.status).toBe(200);
+            ressert(res).status.toBe(200);
         }),
         audit('MUST allow map {extensions} parameter when accepting application/json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -490,8 +478,8 @@ export function serverAudits(opts) {
                     extensions: { some: 'value' },
                 }),
             });
-            assert('Status code', res.status).toBe(200);
-            assert('Execution result', await assertBodyAsExecutionResult(res)).notToHaveProperty('errors');
+            ressert(res).status.toBe(200);
+            await ressert(res).bodyAsExecutionResult.notToHaveProperty('errors');
         }),
         // TODO: audit('MUST accept a map for the {extensions} parameter'),
         // Response application/json
@@ -504,7 +492,7 @@ export function serverAudits(opts) {
                 },
                 body: '{ "not a JSON',
             });
-            assert('Status code', res.status).toBe(200);
+            ressert(res).status.toBe(200);
         }),
         audit('SHOULD use 200 status code if parameters are invalid when accepting application/json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -517,7 +505,7 @@ export function serverAudits(opts) {
                     qeury: /* typo */ '{ __typename }',
                 }),
             });
-            assert('Status code', res.status).toBe(200);
+            ressert(res).status.toBe(200);
         }),
         audit('SHOULD use 200 status code on document parsing failure when accepting application/json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -528,7 +516,7 @@ export function serverAudits(opts) {
                 },
                 body: JSON.stringify({ query: '{' }),
             });
-            assert('Status code', res.status).toBe(200);
+            ressert(res).status.toBe(200);
         }),
         audit('SHOULD use 200 status code on document validation failure when accepting application/json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -541,7 +529,7 @@ export function serverAudits(opts) {
                     query: '{ 8f31403dfe404bccbb0e835f2629c6a7 }', // making sure the field doesnt exist
                 }),
             });
-            assert('Status code', res.status).toBe(200);
+            ressert(res).status.toBe(200);
         }),
         // Response application/graphql-response+json
         audit(
@@ -555,7 +543,7 @@ export function serverAudits(opts) {
                 },
                 body: '{ "not a JSON',
             });
-            assert('Status code', res.status).toBeBetween(400, 499);
+            ressert(res).status.toBeBetween(400, 499);
         }),
         audit('SHOULD use 400 status code on JSON parsing failure when accepting application/graphql-response+json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -566,7 +554,7 @@ export function serverAudits(opts) {
                 },
                 body: '{ "not a JSON',
             });
-            assert('Status code', res.status).toBe(400);
+            ressert(res).status.toBe(400);
         }),
         audit('SHOULD not contain the data entry on JSON parsing failure when accepting application/graphql-response+json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -577,7 +565,7 @@ export function serverAudits(opts) {
                 },
                 body: '{ "not a JSON',
             });
-            assert('Data entry', (await assertBodyAsExecutionResult(res)).data).toBe(undefined);
+            await ressert(res).bodyAsExecutionResult.data.toBe(undefined);
         }),
         audit(
         // TODO: convert to MUST after watershed
@@ -592,7 +580,7 @@ export function serverAudits(opts) {
                     qeury /* typo */: '{ __typename }',
                 }),
             });
-            assert('Status code', res.status).toBeBetween(400, 599);
+            ressert(res).status.toBeBetween(400, 599);
         }),
         audit('SHOULD use 400 status code if parameters are invalid when accepting application/graphql-response+json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -605,7 +593,7 @@ export function serverAudits(opts) {
                     qeury: /* typo */ '{ __typename }',
                 }),
             });
-            assert('Status code', res.status).toBe(400);
+            ressert(res).status.toBe(400);
         }),
         audit('SHOULD not contain the data entry if parameters are invalid when accepting application/graphql-response+json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -618,7 +606,7 @@ export function serverAudits(opts) {
                     qeury: /* typo */ '{ __typename }',
                 }),
             });
-            assert('Data entry', (await assertBodyAsExecutionResult(res)).data).toBe(undefined);
+            await ressert(res).bodyAsExecutionResult.data.toBe(undefined);
         }),
         audit(
         // TODO: convert to MUST after watershed
@@ -633,7 +621,7 @@ export function serverAudits(opts) {
                     query: '{',
                 }),
             });
-            assert('Status code', res.status).toBeBetween(400, 599);
+            ressert(res).status.toBeBetween(400, 599);
         }),
         audit('SHOULD use 400 status code on document parsing failure when accepting application/graphql-response+json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -646,7 +634,7 @@ export function serverAudits(opts) {
                     query: '{',
                 }),
             });
-            assert('Status code', res.status).toBe(400);
+            ressert(res).status.toBe(400);
         }),
         audit('SHOULD not contain the data entry on document parsing failure when accepting application/graphql-response+json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -659,7 +647,7 @@ export function serverAudits(opts) {
                     query: '{',
                 }),
             });
-            assert('Data entry', (await assertBodyAsExecutionResult(res)).data).toBe(undefined);
+            await ressert(res).bodyAsExecutionResult.data.toBe(undefined);
         }),
         audit(
         // TODO: convert to MUST after watershed
@@ -674,7 +662,7 @@ export function serverAudits(opts) {
                     query: '{ 8f31403dfe404bccbb0e835f2629c6a7 }', // making sure the field doesnt exist
                 }),
             });
-            assert('Status code', res.status).toBeBetween(400, 599);
+            ressert(res).status.toBeBetween(400, 599);
         }),
         audit('SHOULD use 400 status code on document validation failure when accepting application/graphql-response+json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -687,7 +675,7 @@ export function serverAudits(opts) {
                     query: '{ 8f31403dfe404bccbb0e835f2629c6a7 }', // making sure the field doesnt exist
                 }),
             });
-            assert('Status code', res.status).toBe(400);
+            ressert(res).status.toBe(400);
         }),
         audit('SHOULD not contain the data entry on document validation failure when accepting application/graphql-response+json', async () => {
             const res = await fetchFn(await getUrl(opts.url), {
@@ -700,7 +688,7 @@ export function serverAudits(opts) {
                     query: '{ 8f31403dfe404bccbb0e835f2629c6a7 }', // making sure the field doesnt exist
                 }),
             });
-            assert('Data entry', (await assertBodyAsExecutionResult(res)).data).toBe(undefined);
+            await ressert(res).bodyAsExecutionResult.data.toBe(undefined);
         }),
         // TODO: how to fail and have the data entry?
         // audit('MUST use 2xx status code if response contains the data entry and it is not null when accepting application/graphql-response+json'),

package/lib/audits/utils.d.mts

@@ -13,25 +13,44 @@ export * from '../utils';
  */
 export declare function audit(name: AuditName, fn: () => Promise<void>): Audit;
 /**
- * Will throw a string if the assertion fails.
- *
- * All fatal problems will throw an instance of Error.
+ * Error thrown when an assertion test fails.
  *
  * @private
  */
-export declare function assert<T = unknown>(name: string, actual: T): {
-    toBe: (expected: T) => void;
-    toBeBetween: (min: T extends number ? T : never, max: T extends number ? T : never) => void;
-    toContain: (expected: T extends (infer U)[] ? U : T extends string ? T : never) => void;
-    notToContain: (expected: T extends (infer U_1)[] ? U_1 : T extends string ? T : never) => void;
-    toHaveProperty: (prop: T extends Record<any, any> ? PropertyKey : never) => void;
-    notToHaveProperty: (prop: T extends Record<any, any> ? PropertyKey : never) => void;
-};
+export declare class AuditError {
+    /**
+     * Response from the server.
+     */
+    response: Response;
+    /**
+     * Reason for the failing audit.
+     */
+    reason: string;
+    constructor(response: Response, reason: string);
+}
 /**
- * Parses the string as JSON and safely reports parsing issues for audits.
+ * Will throw an AuditError if the assertion on Response fails.
+ *
+ * All fatal problems will throw an instance of an Error.
  *
- * Assumes the parsed JSON will be an `ExecutionResult`.
+ * The name "ressert" is a wordplay combining "response" and "assert".
  *
  * @private
- * */
-export declare function assertBodyAsExecutionResult(res: Response): Promise<ExecutionResult<import("graphql/jsutils/ObjMap").ObjMap<unknown>, import("graphql/jsutils/ObjMap").ObjMap<unknown>>>;
+ */
+export declare function ressert(res: Response): {
+    status: {
+        toBe(code: number): void;
+        toBeBetween: (min: number, max: number) => void;
+    };
+    header(key: 'content-type'): {
+        toContain(part: string): void;
+        notToContain(part: string): void;
+    };
+    bodyAsExecutionResult: {
+        data: {
+            toBe(val: ExecutionResult['data']): Promise<void>;
+        };
+        toHaveProperty(key: keyof ExecutionResult): Promise<void>;
+        notToHaveProperty(key: keyof ExecutionResult): Promise<void>;
+    };
+};

package/lib/audits/utils.d.ts

@@ -13,25 +13,44 @@ export * from '../utils';
  */
 export declare function audit(name: AuditName, fn: () => Promise<void>): Audit;
 /**
- * Will throw a string if the assertion fails.
- *
- * All fatal problems will throw an instance of Error.
+ * Error thrown when an assertion test fails.
  *
  * @private
  */
-export declare function assert<T = unknown>(name: string, actual: T): {
-    toBe: (expected: T) => void;
-    toBeBetween: (min: T extends number ? T : never, max: T extends number ? T : never) => void;
-    toContain: (expected: T extends (infer U)[] ? U : T extends string ? T : never) => void;
-    notToContain: (expected: T extends (infer U_1)[] ? U_1 : T extends string ? T : never) => void;
-    toHaveProperty: (prop: T extends Record<any, any> ? PropertyKey : never) => void;
-    notToHaveProperty: (prop: T extends Record<any, any> ? PropertyKey : never) => void;
-};
+export declare class AuditError {
+    /**
+     * Response from the server.
+     */
+    response: Response;
+    /**
+     * Reason for the failing audit.
+     */
+    reason: string;
+    constructor(response: Response, reason: string);
+}
 /**
- * Parses the string as JSON and safely reports parsing issues for audits.
+ * Will throw an AuditError if the assertion on Response fails.
+ *
+ * All fatal problems will throw an instance of an Error.
  *
- * Assumes the parsed JSON will be an `ExecutionResult`.
+ * The name "ressert" is a wordplay combining "response" and "assert".
  *
  * @private
- * */
-export declare function assertBodyAsExecutionResult(res: Response): Promise<ExecutionResult<import("graphql/jsutils/ObjMap").ObjMap<unknown>, import("graphql/jsutils/ObjMap").ObjMap<unknown>>>;
+ */
+export declare function ressert(res: Response): {
+    status: {
+        toBe(code: number): void;
+        toBeBetween: (min: number, max: number) => void;
+    };
+    header(key: 'content-type'): {
+        toContain(part: string): void;
+        notToContain(part: string): void;
+    };
+    bodyAsExecutionResult: {
+        data: {
+            toBe(val: ExecutionResult['data']): Promise<void>;
+        };
+        toHaveProperty(key: keyof ExecutionResult): Promise<void>;
+        notToHaveProperty(key: keyof ExecutionResult): Promise<void>;
+    };
+};