@schema-hub/zod-graphql-fake-client 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,27 @@
+{
+    "author": "Mathias Schreck <schreck.mathias@gmail.com>",
+    "dependencies": {
+        "@schema-hub/zod-graphql-query-builder": "0.0.2"
+    },
+    "description": "Fake GraphQL client for testing @schema-hub/zod-graphql-client",
+    "engines": {
+        "node": "^20"
+    },
+    "keywords": [
+        "fake-graphql-client",
+        "testing-client"
+    ],
+    "license": "MIT",
+    "main": "zod-graphql-fake-client/fake-client.js",
+    "name": "@schema-hub/zod-graphql-fake-client",
+    "peerDependencies": {
+        "@schema-hub/zod-graphql-client": "0.0.1"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+ssh://git@github.com/enormora/schema-hub.git"
+    },
+    "type": "module",
+    "types": "zod-graphql-fake-client/fake-client.d.ts",
+    "version": "0.0.1"
+}

package/readme.md

@@ -0,0 +1,60 @@
+# zod-graphql-fake-client
+
+A fake GraphQL client for testing purposes, compatible with the [`@schema-hub/zod-graphql-client`](../zod-graphql-client/readme.md).
+
+## Installation
+
+Install `@schema-hub/zod-graphql-fake-client` via npm:
+
+```bash
+npm install --dev @schema-hub/zod-graphql-fake-client
+```
+
+## Usage
+
+To use the fake GraphQL client in tests, import it and create an instance with custom configurations:
+
+```typescript
+import { createFakeGraphqlClient } from '@schema-hub/zod-graphql-fake-client';
+
+const client = createFakeGraphqlClient();
+```
+
+It works best with dependency injection, so it's recommended to inject a new client instance for every test case.
+
+### Customizing Query Results
+
+Specify custom query results for individual queries by passing an array of `FakeResult` objects to `createFakeGraphqlClient`. Each `FakeResult` can contain either a successful data payload or an error object, allowing simulation of various scenarios in tests.
+
+```typescript
+import { createFakeGraphqlClient } from '@schema-hub/zod-graphql-fake-client';
+
+const customResults = [
+    { data: { foo: 'bar' } }, // Successful response
+    { error: { type: 'network', message: 'Request timed out' } }, // Network error
+    { error: { type: 'server', statusCode: 500, message: 'Internal server error' } } // Server error
+    // Add more custom results as needed...
+];
+
+const client = createFakeGraphqlClient({ results: customResults });
+```
+
+The order of the array matters, so the first result will be returned by the first `query()` call.
+
+### Inspecting Query Payloads
+
+The fake GraphQL client keeps track of all query payloads sent to the server (without actually sending them), allowing inspection during tests. Retrieve individual query payloads by index or inspect the first query payload recorded.
+
+```typescript
+import { createFakeGraphqlClient } from '@schema-hub/zod-graphql-fake-client';
+
+const client = createFakeGraphqlClient();
+
+// Inspect the payload of the first query
+const firstPayload = client.inspectFirstQueryPayload();
+console.log(firstPayload);
+
+// Inspect the payload of the second query
+const secondPayload = client.inspectQueryPayload(1);
+console.log(secondPayload);
+```

package/zod-graphql-fake-client/fake-client.d.ts

@@ -0,0 +1,25 @@
+import { type GraphqlClient, type QueryErrorDetails } from '@schema-hub/zod-graphql-client/zod-graphql-client/entry-point.d.ts';
+export type QueryPayload = {
+    operationName?: string | undefined;
+    variables: Record<string, unknown>;
+    query: string;
+};
+export type FakeGraphqlClient = GraphqlClient & {
+    readonly inspectQueryPayload: (index: number) => QueryPayload;
+    readonly inspectFirstQueryPayload: () => QueryPayload;
+};
+type FakeSuccessData = {
+    error?: undefined;
+    data: unknown;
+};
+type FakeFailureResult = {
+    data?: undefined;
+    error: QueryErrorDetails;
+};
+export type FakeResult = FakeFailureResult | FakeSuccessData;
+type FakeClientOptions = {
+    readonly results?: FakeResult[];
+};
+export declare function createFakeGraphqlClient(clientOptions?: FakeClientOptions): FakeGraphqlClient;
+export {};
+//# sourceMappingURL=fake-client.d.ts.map

package/zod-graphql-fake-client/fake-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fake-client.d.ts","sourceRoot":"","sources":["../../../../source/zod-graphql-fake-client/fake-client.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,aAAa,EAElB,KAAK,iBAAiB,EAGzB,MAAM,sCAAsC,CAAC;AAI9C,MAAM,MAAM,YAAY,GAAG;IACvB,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG;IAC5C,QAAQ,CAAC,mBAAmB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,YAAY,CAAC;IAC9D,QAAQ,CAAC,wBAAwB,EAAE,MAAM,YAAY,CAAC;CACzD,CAAC;AAEF,KAAK,eAAe,GAAG;IACnB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,IAAI,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,KAAK,iBAAiB,GAAG;IACrB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,KAAK,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,iBAAiB,GAAG,eAAe,CAAC;AAE7D,KAAK,iBAAiB,GAAG;IACrB,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;CACnC,CAAC;AACF,wBAAgB,uBAAuB,CAAC,aAAa,GAAE,iBAAsB,GAAG,iBAAiB,CAuDhG"}

package/zod-graphql-fake-client/fake-client.js

@@ -0,0 +1,45 @@
+import { GraphqlQueryError } from '@schema-hub/zod-graphql-client/zod-graphql-client/entry-point.js';
+import { extractVariableDefinitions, extractVariableValues } from '@schema-hub/zod-graphql-client/zod-graphql-client/variables.js';
+import { buildGraphqlQuery } from '@schema-hub/zod-graphql-query-builder/zod-graphql-query-builder/entry-point.js';
+export function createFakeGraphqlClient(clientOptions = {}) {
+    const { results = [] } = clientOptions;
+    const queryPayloads = [];
+    const defaultResult = { data: {} };
+    async function query(schema, options = {}) {
+        const { variables = {} } = options;
+        const variableDefinitions = extractVariableDefinitions(variables);
+        const variableValues = extractVariableValues(variables);
+        const serializedQuery = buildGraphqlQuery(schema, {
+            queryName: options.queryName,
+            variableDefinitions
+        });
+        const result = results[queryPayloads.length] ?? defaultResult;
+        queryPayloads.push({ operationName: options.queryName, query: serializedQuery, variables: variableValues });
+        if (result.error !== undefined) {
+            return { success: false, errorDetails: result.error };
+        }
+        return { success: true, data: result.data };
+    }
+    function inspectQueryPayload(index) {
+        const payload = queryPayloads[index];
+        if (payload === undefined) {
+            throw new Error(`No query payload at index ${index} recorded`);
+        }
+        return payload;
+    }
+    return {
+        query,
+        async queryOrThrow(schema, options) {
+            const result = await query(schema, options);
+            if (result.success) {
+                return result.data;
+            }
+            throw new GraphqlQueryError(result.errorDetails);
+        },
+        inspectQueryPayload,
+        inspectFirstQueryPayload() {
+            return inspectQueryPayload(0);
+        }
+    };
+}
+//# sourceMappingURL=fake-client.js.map

package/zod-graphql-fake-client/fake-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fake-client.js","sourceRoot":"","sources":["../../../../source/zod-graphql-fake-client/fake-client.ts"],"names":[],"mappings":"AAEA,OAAO,EAEH,iBAAiB,EAIpB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AACvG,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AA4BhF,MAAM,UAAU,uBAAuB,CAAC,gBAAmC,EAAE;IACzE,MAAM,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,aAAa,CAAC;IACvC,MAAM,aAAa,GAAmB,EAAE,CAAC;IACzC,MAAM,aAAa,GAAe,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IAE/C,KAAK,UAAU,KAAK,CAChB,MAAc,EACd,UAAwB,EAAE;QAE1B,MAAM,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC;QACnC,MAAM,mBAAmB,GAAG,0BAA0B,CAAC,SAAS,CAAC,CAAC;QAClE,MAAM,cAAc,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAExD,MAAM,eAAe,GAAG,iBAAiB,CAAC,MAAM,EAAE;YAC9C,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,mBAAmB;SACtB,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,aAAa,CAAC;QAE9D,aAAa,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,SAAS,EAAE,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC,CAAC;QAE5G,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;QAC1D,CAAC;QACD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,IAAsB,EAAE,CAAC;IAClE,CAAC;IAED,SAAS,mBAAmB,CAAC,KAAa;QACtC,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,6BAA6B,KAAK,WAAW,CAAC,CAAC;QACnE,CAAC;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,OAAO;QACH,KAAK;QAEL,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO;YAC9B,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC5C,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACjB,OAAO,MAAM,CAAC,IAAI,CAAC;YACvB,CAAC;YAED,MAAM,IAAI,iBAAiB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACrD,CAAC;QAED,mBAAmB;QAEnB,wBAAwB;YACpB,OAAO,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC;KACJ,CAAC;AACN,CAAC"}