{ "name": "client-graphql", "specifier": "@probitas/client-graphql", "version": "0.6.0", "moduleDoc": "GraphQL client for [Probitas](https://github.com/probitas-test/probitas) scenario testing framework.\n\nThis package provides a GraphQL client designed for integration testing of GraphQL APIs.\n\n## Features\n\n- **Query & Mutation**: Full support for GraphQL operations\n- **Variables Support**: Pass typed variables to queries and mutations\n- **Duration Tracking**: Built-in timing for performance monitoring\n- **Error Inspection**: Inspect GraphQL errors and their structure\n- **Resource Management**: Implements `AsyncDisposable` for proper cleanup\n- **Template Literals**: Re-exports `outdent` for clean multi-line queries\n\n## Installation\n\n```bash\ndeno add jsr:@probitas/client-graphql\n```\n\n## Quick Start\n\n```ts\nimport { createGraphqlClient, outdent } from \"@probitas/client-graphql\";\n\nconst client = createGraphqlClient({ url: \"http://localhost:4000/graphql\" });\n\n// Query with variables\nconst res = await client.query(outdent`\n query GetUser($id: ID!) {\n user(id: $id) { id name email }\n }\n`, { id: \"123\" });\nconsole.log(\"User:\", res.data);\n\n// Mutation\nconst created = await client.mutation(outdent`\n mutation CreateUser($input: CreateUserInput!) {\n createUser(input: $input) { id name }\n }\n`, { input: { name: \"Jane\", email: \"jane@example.com\" } });\nconsole.log(\"Created:\", created.data);\n\nawait client.close();\n```\n\n## Using with `using` Statement\n\n```ts\nimport { createGraphqlClient } from \"@probitas/client-graphql\";\n\nawait using client = createGraphqlClient({ url: \"http://localhost:4000/graphql\" });\n\nconst res = await client.query(`{ __typename }`);\nconsole.log(res.data);\n// Client automatically closed when block exits\n```\n\n## Related Packages\n\n| Package | Description |\n|---------|-------------|\n| [`@probitas/client`](https://jsr.io/@probitas/client) | Core utilities and types |\n| [`@probitas/client-http`](https://jsr.io/@probitas/client-http) | HTTP client |\n\n## Links\n\n- [GitHub Repository](https://github.com/probitas-test/probitas-client)\n- [Probitas Framework](https://github.com/probitas-test/probitas)\n", "exports": [ { "name": "outdent", "isDefault": false, "location": { "filename": "https://jsr.io/@cspotcode/outdent/0.8.0/src/index.ts", "line": 203, "col": 6, "byteIndex": 6181 }, "declarationKind": "export", "kind": "variable", "variableDef": { "tsType": { "repr": "Outdent", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "Outdent" } }, "kind": "const" } }, { "name": "GraphqlErrorItem", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 13, "col": 0, "byteIndex": 357 }, "declarationKind": "export", "jsDoc": { "doc": "GraphQL error item as per GraphQL specification.", "tags": [ { "kind": "see", "doc": "https://spec.graphql.org/October2021/#sec-Errors.Error-Result-Format" } ] }, "kind": "interface", "interfaceDef": { "extends": [], "constructors": [], "methods": [], "properties": [ { "name": "message", "jsDoc": { "doc": "Error message" }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 15, "col": 2, "byteIndex": 418 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "typeParams": [] }, { "name": "locations", "jsDoc": { "doc": "Location(s) in the GraphQL document where the error occurred" }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 18, "col": 2, "byteIndex": 517 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "", "kind": "typeOperator", "typeOperator": { "operator": "readonly", "tsType": { "repr": "", "kind": "array", "array": { "repr": "", "kind": "typeLiteral", "typeLiteral": { "constructors": [], "methods": [], "properties": [ { "name": "line", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 18, "col": 33, "byteIndex": 548 }, "params": [], "computed": false, "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "typeParams": [] }, { "name": "column", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 18, "col": 47, "byteIndex": 562 }, "params": [], "computed": false, "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [] } } } } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "typeParams": [] }, { "name": "path", "jsDoc": { "doc": "Path to the field that caused the error" }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 21, "col": 2, "byteIndex": 641 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "", "kind": "typeOperator", "typeOperator": { "operator": "readonly", "tsType": { "repr": "", "kind": "array", "array": { "repr": "", "kind": "parenthesized", "parenthesized": { "repr": "", "kind": "union", "union": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "number", "kind": "keyword", "keyword": "number" } ] } } } } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "typeParams": [] }, { "name": "extensions", "jsDoc": { "doc": "Additional error metadata" }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 24, "col": 2, "byteIndex": 731 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } ], "typeName": "Record" } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "GraphqlResponse", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 166, "col": 0, "byteIndex": 4260 }, "declarationKind": "export", "jsDoc": { "doc": "GraphQL response union type.\n\nUse `processed` to distinguish between server responses and failures:\n- `processed === true`: Server responded (Success or Error)\n- `processed === false`: Request failed (Failure)\n\nUse `ok` to check for success:\n- `ok === true`: Success (no errors)\n- `ok === false`: Error or Failure" }, "kind": "typeAlias", "typeAliasDef": { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "GraphqlResponseSuccess", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "GraphqlResponseSuccess" } }, { "repr": "GraphqlResponseError", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "GraphqlResponseError" } }, { "repr": "GraphqlResponseFailure", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "GraphqlResponseFailure" } } ] }, "typeParams": [ { "name": "T", "default": { "repr": "any", "kind": "keyword", "keyword": "any" } } ] } }, { "name": "GraphqlResponseError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 105, "col": 0, "byteIndex": 2591 }, "declarationKind": "export", "jsDoc": { "doc": "GraphQL response with execution errors.\n\nNote: GraphQL allows partial success where both data and errors are present.\nUse data() to access any partial data." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "GraphqlResponseBase", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "GraphqlResponseBase" } } ], "constructors": [], "methods": [], "properties": [ { "name": "processed", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 106, "col": 2, "byteIndex": 2673 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "true", "kind": "literal", "literal": { "kind": "boolean", "boolean": true } }, "typeParams": [] }, { "name": "ok", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 107, "col": 2, "byteIndex": 2701 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "false", "kind": "literal", "literal": { "kind": "boolean", "boolean": false } }, "typeParams": [] }, { "name": "error", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 108, "col": 2, "byteIndex": 2723 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "GraphqlExecutionError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlExecutionError" } }, "typeParams": [] }, { "name": "status", "jsDoc": { "doc": "HTTP status code." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 111, "col": 2, "byteIndex": 2792 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "typeParams": [] }, { "name": "headers", "jsDoc": { "doc": "HTTP response headers." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 114, "col": 2, "byteIndex": 2852 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "Headers", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "Headers" } }, "typeParams": [] }, { "name": "extensions", "jsDoc": { "doc": "Response extensions." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 117, "col": 2, "byteIndex": 2912 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } ], "typeName": "Record" } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "typeParams": [] }, { "name": "raw", "jsDoc": { "doc": "Raw Web standard Response." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 120, "col": 2, "byteIndex": 3004 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "globalThis.Response", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "globalThis.Response" } }, "typeParams": [] }, { "name": "data", "jsDoc": { "doc": "Response data (null if no data, may be partial data with errors)." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 123, "col": 2, "byteIndex": 3117 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [ { "name": "T", "default": { "repr": "any", "kind": "keyword", "keyword": "any" } } ] } }, { "name": "GraphqlResponseFailure", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 132, "col": 0, "byteIndex": 3302 }, "declarationKind": "export", "jsDoc": { "doc": "Failed GraphQL request (network error, HTTP error, etc.).\n\nThe request did not reach GraphQL processing." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "GraphqlResponseBase", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "GraphqlResponseBase" } } ], "constructors": [], "methods": [], "properties": [ { "name": "processed", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 134, "col": 2, "byteIndex": 3388 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "false", "kind": "literal", "literal": { "kind": "boolean", "boolean": false } }, "typeParams": [] }, { "name": "ok", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 135, "col": 2, "byteIndex": 3417 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "false", "kind": "literal", "literal": { "kind": "boolean", "boolean": false } }, "typeParams": [] }, { "name": "error", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 136, "col": 2, "byteIndex": 3439 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "GraphqlFailureError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlFailureError" } }, "typeParams": [] }, { "name": "extensions", "jsDoc": { "doc": "Response extensions (always null for failures)." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 139, "col": 2, "byteIndex": 3536 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "typeParams": [] }, { "name": "status", "jsDoc": { "doc": "HTTP status code (null for network failures)." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 142, "col": 2, "byteIndex": 3621 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "typeParams": [] }, { "name": "headers", "jsDoc": { "doc": "HTTP response headers (null for failures)." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 145, "col": 2, "byteIndex": 3699 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "typeParams": [] }, { "name": "raw", "jsDoc": { "doc": "No raw response (request didn't reach server)." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 148, "col": 2, "byteIndex": 3782 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "typeParams": [] }, { "name": "data", "jsDoc": { "doc": "No data (request didn't reach server)." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 151, "col": 2, "byteIndex": 3853 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [ { "name": "T", "default": { "repr": "any", "kind": "keyword", "keyword": "any" } } ] } }, { "name": "GraphqlResponseSuccess", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 76, "col": 0, "byteIndex": 1872 }, "declarationKind": "export", "jsDoc": { "doc": "Successful GraphQL response (no errors)." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "GraphqlResponseBase", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "GraphqlResponseBase" } } ], "constructors": [], "methods": [], "properties": [ { "name": "processed", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 78, "col": 2, "byteIndex": 1958 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "true", "kind": "literal", "literal": { "kind": "boolean", "boolean": true } }, "typeParams": [] }, { "name": "ok", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 79, "col": 2, "byteIndex": 1986 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "true", "kind": "literal", "literal": { "kind": "boolean", "boolean": true } }, "typeParams": [] }, { "name": "error", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 80, "col": 2, "byteIndex": 2007 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "typeParams": [] }, { "name": "status", "jsDoc": { "doc": "HTTP status code." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 83, "col": 2, "byteIndex": 2059 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "typeParams": [] }, { "name": "headers", "jsDoc": { "doc": "HTTP response headers." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 86, "col": 2, "byteIndex": 2119 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "Headers", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "Headers" } }, "typeParams": [] }, { "name": "extensions", "jsDoc": { "doc": "Response extensions." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 89, "col": 2, "byteIndex": 2179 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } ], "typeName": "Record" } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "typeParams": [] }, { "name": "raw", "jsDoc": { "doc": "Raw Web standard Response." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 92, "col": 2, "byteIndex": 2271 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "globalThis.Response", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "globalThis.Response" } }, "typeParams": [] }, { "name": "data", "jsDoc": { "doc": "Response data (null if no data)." }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 95, "col": 2, "byteIndex": 2351 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [ { "name": "T", "default": { "repr": "any", "kind": "keyword", "keyword": "any" } } ] } }, { "name": "GraphqlOptions", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 37, "col": 0, "byteIndex": 952 }, "declarationKind": "export", "jsDoc": { "doc": "Options for individual GraphQL requests." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "CommonOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "CommonOptions" } } ], "constructors": [], "methods": [], "properties": [ { "name": "headers", "jsDoc": { "doc": "Additional request headers" }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 39, "col": 2, "byteIndex": 1046 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "HeadersInit", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "HeadersInit" } }, "typeParams": [] }, { "name": "operationName", "jsDoc": { "doc": "Operation name (for documents with multiple operations)" }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 42, "col": 2, "byteIndex": 1146 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "typeParams": [] }, { "name": "throwOnError", "jsDoc": { "doc": "Whether to throw GraphqlError when response contains errors or request fails.", "tags": [ { "kind": "unsupported", "value": "@default false (inherited from client config if not specified)" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 48, "col": 2, "byteIndex": 1345 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "boolean", "kind": "keyword", "keyword": "boolean" }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "GraphqlConnectionConfig", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 56, "col": 0, "byteIndex": 1494 }, "declarationKind": "export", "jsDoc": { "doc": "GraphQL connection configuration.\n\nExtends CommonConnectionConfig with GraphQL-specific options." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "CommonConnectionConfig", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "CommonConnectionConfig" } } ], "constructors": [], "methods": [], "properties": [ { "name": "protocol", "jsDoc": { "doc": "Protocol to use.", "tags": [ { "kind": "unsupported", "value": "@default \"http\"" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 61, "col": 2, "byteIndex": 1625 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "http", "kind": "literal", "literal": { "kind": "string", "string": "http" } }, { "repr": "https", "kind": "literal", "literal": { "kind": "string", "string": "https" } } ] }, "typeParams": [] }, { "name": "path", "jsDoc": { "doc": "GraphQL endpoint path.", "tags": [ { "kind": "unsupported", "value": "@default \"/graphql\"" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 67, "col": 2, "byteIndex": 1731 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "GraphqlClientConfig", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 73, "col": 0, "byteIndex": 1799 }, "declarationKind": "export", "jsDoc": { "doc": "GraphQL client configuration." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "CommonOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "CommonOptions" } } ], "constructors": [], "methods": [], "properties": [ { "name": "url", "jsDoc": { "doc": "GraphQL endpoint URL.\n\nCan be a URL string or a connection configuration object.\n", "tags": [ { "kind": "example", "doc": "String URL\n```ts\nimport type { GraphqlClientConfig } from \"@probitas/client-graphql\";\nconst config: GraphqlClientConfig = { url: \"http://localhost:4000/graphql\" };\n```\n" }, { "kind": "example", "doc": "Connection config object\n```ts\nimport type { GraphqlClientConfig } from \"@probitas/client-graphql\";\nconst config: GraphqlClientConfig = {\n url: { host: \"api.example.com\", port: 443, protocol: \"https\" },\n};\n```" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 93, "col": 2, "byteIndex": 2436 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "GraphqlConnectionConfig", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlConnectionConfig" } } ] }, "typeParams": [] }, { "name": "headers", "jsDoc": { "doc": "Default headers for all requests" }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 96, "col": 2, "byteIndex": 2529 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "HeadersInit", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "HeadersInit" } }, "typeParams": [] }, { "name": "wsEndpoint", "jsDoc": { "doc": "WebSocket endpoint URL (for subscriptions)" }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 99, "col": 2, "byteIndex": 2616 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "typeParams": [] }, { "name": "fetch", "jsDoc": { "doc": "Custom fetch implementation (for testing/mocking)" }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 102, "col": 2, "byteIndex": 2708 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "fetch", "kind": "typeQuery", "typeQuery": "fetch" }, "typeParams": [] }, { "name": "throwOnError", "jsDoc": { "doc": "Whether to throw GraphqlError when response contains errors or request fails.\nCan be overridden per-request via GraphqlOptions.", "tags": [ { "kind": "unsupported", "value": "@default false" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 109, "col": 2, "byteIndex": 2912 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "boolean", "kind": "keyword", "keyword": "boolean" }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "GraphqlClient", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 115, "col": 0, "byteIndex": 2985 }, "declarationKind": "export", "jsDoc": { "doc": "GraphQL client interface." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "AsyncDisposable", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "AsyncDisposable" } } ], "constructors": [], "methods": [ { "name": "query", "jsDoc": { "doc": "Execute a GraphQL query" }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 121, "col": 2, "byteIndex": 3186 }, "params": [ { "kind": "identifier", "name": "query", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "variables", "optional": true, "tsType": { "repr": "TVariables", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "TVariables" } } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "GraphqlOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlOptions" } } } ], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "GraphqlResponse", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "TData", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "TData" } } ], "typeName": "GraphqlResponse" } } ], "typeName": "Promise" } }, "typeParams": [ { "name": "TData", "default": { "repr": "any", "kind": "keyword", "keyword": "any" } }, { "name": "TVariables", "default": { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "any", "kind": "keyword", "keyword": "any" } ], "typeName": "Record" } } } ] }, { "name": "mutation", "jsDoc": { "doc": "Execute a GraphQL mutation" }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 129, "col": 2, "byteIndex": 3432 }, "params": [ { "kind": "identifier", "name": "mutation", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "variables", "optional": true, "tsType": { "repr": "TVariables", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "TVariables" } } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "GraphqlOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlOptions" } } } ], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "GraphqlResponse", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "TData", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "TData" } } ], "typeName": "GraphqlResponse" } } ], "typeName": "Promise" } }, "typeParams": [ { "name": "TData", "default": { "repr": "any", "kind": "keyword", "keyword": "any" } }, { "name": "TVariables", "default": { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "any", "kind": "keyword", "keyword": "any" } ], "typeName": "Record" } } } ] }, { "name": "execute", "jsDoc": { "doc": "Execute a GraphQL document (query or mutation)" }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 137, "col": 2, "byteIndex": 3704 }, "params": [ { "kind": "identifier", "name": "document", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "variables", "optional": true, "tsType": { "repr": "TVariables", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "TVariables" } } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "GraphqlOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlOptions" } } } ], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "GraphqlResponse", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "TData", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "TData" } } ], "typeName": "GraphqlResponse" } } ], "typeName": "Promise" } }, "typeParams": [ { "name": "TData", "default": { "repr": "any", "kind": "keyword", "keyword": "any" } }, { "name": "TVariables", "default": { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "any", "kind": "keyword", "keyword": "any" } ], "typeName": "Record" } } } ] }, { "name": "subscribe", "jsDoc": { "doc": "Subscribe to a GraphQL subscription via WebSocket" }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 145, "col": 2, "byteIndex": 3978 }, "params": [ { "kind": "identifier", "name": "document", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "variables", "optional": true, "tsType": { "repr": "TVariables", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "TVariables" } } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "GraphqlOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlOptions" } } } ], "optional": false, "returnType": { "repr": "AsyncIterable", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "GraphqlResponse", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "TData", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "TData" } } ], "typeName": "GraphqlResponse" } } ], "typeName": "AsyncIterable" } }, "typeParams": [ { "name": "TData", "default": { "repr": "any", "kind": "keyword", "keyword": "any" } }, { "name": "TVariables", "default": { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "any", "kind": "keyword", "keyword": "any" } ], "typeName": "Record" } } } ] }, { "name": "close", "jsDoc": { "doc": "Close the client and release resources" }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 152, "col": 2, "byteIndex": 4211 }, "params": [], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "void", "kind": "keyword", "keyword": "void" } ], "typeName": "Promise" } }, "typeParams": [] } ], "properties": [ { "name": "config", "jsDoc": { "doc": "Client configuration" }, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/types.ts", "line": 117, "col": 2, "byteIndex": 3074 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "GraphqlClientConfig", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlClientConfig" } }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "GraphqlExecutionError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/errors.ts", "line": 10, "col": 0, "byteIndex": 345 }, "declarationKind": "export", "jsDoc": { "doc": "Error thrown for GraphQL execution errors.\n\nThis error is returned when the GraphQL server processes the request\nbut returns errors in the response (validation errors, resolver errors, etc.)." }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "errors", "optional": false, "tsType": { "repr": "", "kind": "typeOperator", "typeOperator": { "operator": "readonly", "tsType": { "repr": "", "kind": "array", "array": { "repr": "GraphqlErrorItem", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlErrorItem" } } } } } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "ErrorOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "ErrorOptions" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/errors.ts", "line": 17, "col": 2, "byteIndex": 591 } } ], "properties": [ { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "name", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/errors.ts", "line": 11, "col": 2, "byteIndex": 404 } }, { "tsType": { "repr": "graphql", "kind": "literal", "literal": { "kind": "string", "string": "graphql" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "kind", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/errors.ts", "line": 12, "col": 2, "byteIndex": 456 } }, { "jsDoc": { "doc": "GraphQL errors from response" }, "tsType": { "repr": "", "kind": "typeOperator", "typeOperator": { "operator": "readonly", "tsType": { "repr": "", "kind": "array", "array": { "repr": "GraphqlErrorItem", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlErrorItem" } } } } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "errors", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/errors.ts", "line": 15, "col": 2, "byteIndex": 542 } } ], "indexSignatures": [], "methods": [], "extends": "ClientError", "implements": [], "typeParams": [], "superTypeParams": [] } }, { "name": "GraphqlNetworkError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/errors.ts", "line": 33, "col": 0, "byteIndex": 995 }, "declarationKind": "export", "jsDoc": { "doc": "Error thrown for network-level failures.\n\nThis error indicates that the request could not reach or be processed\nby the GraphQL server (connection refused, HTTP errors, etc.)." }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "message", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "ErrorOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "ErrorOptions" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/errors.ts", "line": 37, "col": 2, "byteIndex": 1150 } } ], "properties": [ { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "name", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/errors.ts", "line": 34, "col": 2, "byteIndex": 1052 } }, { "tsType": { "repr": "network", "kind": "literal", "literal": { "kind": "string", "string": "network" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "kind", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/errors.ts", "line": 35, "col": 2, "byteIndex": 1102 } } ], "indexSignatures": [], "methods": [], "extends": "ClientError", "implements": [], "typeParams": [], "superTypeParams": [] } }, { "name": "GraphqlFailureError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/errors.ts", "line": 62, "col": 0, "byteIndex": 1779 }, "declarationKind": "export", "jsDoc": { "doc": "Error types that indicate the operation was not processed.\nThese are errors that occur before the request reaches the GraphQL server." }, "kind": "typeAlias", "typeAliasDef": { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "GraphqlNetworkError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlNetworkError" } }, { "repr": "AbortError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "AbortError" } }, { "repr": "TimeoutError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "TimeoutError" } } ] }, "typeParams": [] } }, { "name": "GraphqlResponseSuccessParams", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 174, "col": 0, "byteIndex": 4454 }, "declarationKind": "export", "jsDoc": { "doc": "Parameters for creating a successful GraphqlResponse." }, "kind": "interface", "interfaceDef": { "extends": [], "constructors": [], "methods": [], "properties": [ { "name": "url", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 175, "col": 2, "byteIndex": 4507 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "typeParams": [] }, { "name": "data", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 176, "col": 2, "byteIndex": 4531 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "typeParams": [] }, { "name": "extensions", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 177, "col": 2, "byteIndex": 4558 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } ], "typeName": "Record" } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "typeParams": [] }, { "name": "duration", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 178, "col": 2, "byteIndex": 4613 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "typeParams": [] }, { "name": "status", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 179, "col": 2, "byteIndex": 4642 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "typeParams": [] }, { "name": "raw", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 180, "col": 2, "byteIndex": 4669 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "globalThis.Response", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "globalThis.Response" } }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [ { "name": "T" } ] } }, { "name": "GraphqlResponseErrorParams", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 186, "col": 0, "byteIndex": 4768 }, "declarationKind": "export", "jsDoc": { "doc": "Parameters for creating an error GraphqlResponse." }, "kind": "interface", "interfaceDef": { "extends": [], "constructors": [], "methods": [], "properties": [ { "name": "url", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 187, "col": 2, "byteIndex": 4819 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "typeParams": [] }, { "name": "data", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 188, "col": 2, "byteIndex": 4843 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "typeParams": [] }, { "name": "error", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 189, "col": 2, "byteIndex": 4870 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "GraphqlExecutionError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlExecutionError" } }, "typeParams": [] }, { "name": "extensions", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 190, "col": 2, "byteIndex": 4911 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } ], "typeName": "Record" } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "typeParams": [] }, { "name": "duration", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 191, "col": 2, "byteIndex": 4966 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "typeParams": [] }, { "name": "status", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 192, "col": 2, "byteIndex": 4995 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "typeParams": [] }, { "name": "raw", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 193, "col": 2, "byteIndex": 5022 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "globalThis.Response", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "globalThis.Response" } }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [ { "name": "T" } ] } }, { "name": "GraphqlResponseFailureParams", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 199, "col": 0, "byteIndex": 5122 }, "declarationKind": "export", "jsDoc": { "doc": "Parameters for creating a failure GraphqlResponse." }, "kind": "interface", "interfaceDef": { "extends": [], "constructors": [], "methods": [], "properties": [ { "name": "url", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 200, "col": 2, "byteIndex": 5172 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "typeParams": [] }, { "name": "error", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 201, "col": 2, "byteIndex": 5196 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "GraphqlFailureError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlFailureError" } }, "typeParams": [] }, { "name": "duration", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 202, "col": 2, "byteIndex": 5235 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "GraphqlResponseSuccessImpl", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 209, "col": 0, "byteIndex": 5331 }, "declarationKind": "export", "jsDoc": { "doc": "Implementation of GraphqlResponseSuccess.", "tags": [ { "kind": "internal" } ] }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "params", "optional": false, "tsType": { "repr": "GraphqlResponseSuccessParams", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "GraphqlResponseSuccessParams" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 224, "col": 2, "byteIndex": 5779 } } ], "properties": [ { "tsType": { "repr": "graphql", "kind": "literal", "literal": { "kind": "string", "string": "graphql" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "kind", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 211, "col": 2, "byteIndex": 5417 } }, { "tsType": { "repr": "true", "kind": "literal", "literal": { "kind": "boolean", "boolean": true } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "processed", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 212, "col": 2, "byteIndex": 5455 } }, { "tsType": { "repr": "true", "kind": "literal", "literal": { "kind": "boolean", "boolean": true } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "ok", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 213, "col": 2, "byteIndex": 5493 } }, { "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "error", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 214, "col": 2, "byteIndex": 5524 } }, { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } ], "typeName": "Record" } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "extensions", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 215, "col": 2, "byteIndex": 5549 } }, { "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "duration", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 216, "col": 2, "byteIndex": 5604 } }, { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "url", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 217, "col": 2, "byteIndex": 5633 } }, { "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "status", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 218, "col": 2, "byteIndex": 5657 } }, { "tsType": { "repr": "Headers", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "Headers" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "headers", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 219, "col": 2, "byteIndex": 5684 } }, { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "data", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 221, "col": 2, "byteIndex": 5714 } }, { "tsType": { "repr": "globalThis.Response", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "globalThis.Response" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "raw", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 222, "col": 2, "byteIndex": 5741 } } ], "indexSignatures": [], "methods": [], "extends": null, "implements": [ { "repr": "GraphqlResponseSuccess", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "GraphqlResponseSuccess" } } ], "typeParams": [ { "name": "T" } ], "superTypeParams": [] } }, { "name": "GraphqlResponseErrorImpl", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 239, "col": 0, "byteIndex": 6138 }, "declarationKind": "export", "jsDoc": { "doc": "Implementation of GraphqlResponseError.", "tags": [ { "kind": "internal" } ] }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "params", "optional": false, "tsType": { "repr": "GraphqlResponseErrorParams", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "GraphqlResponseErrorParams" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 253, "col": 2, "byteIndex": 6597 } } ], "properties": [ { "tsType": { "repr": "graphql", "kind": "literal", "literal": { "kind": "string", "string": "graphql" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "kind", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 240, "col": 2, "byteIndex": 6218 } }, { "tsType": { "repr": "true", "kind": "literal", "literal": { "kind": "boolean", "boolean": true } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "processed", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 241, "col": 2, "byteIndex": 6256 } }, { "tsType": { "repr": "false", "kind": "literal", "literal": { "kind": "boolean", "boolean": false } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "ok", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 242, "col": 2, "byteIndex": 6294 } }, { "tsType": { "repr": "GraphqlExecutionError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlExecutionError" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "error", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 243, "col": 2, "byteIndex": 6326 } }, { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } ], "typeName": "Record" } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "extensions", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 244, "col": 2, "byteIndex": 6367 } }, { "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "duration", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 245, "col": 2, "byteIndex": 6422 } }, { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "url", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 246, "col": 2, "byteIndex": 6451 } }, { "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "status", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 247, "col": 2, "byteIndex": 6475 } }, { "tsType": { "repr": "Headers", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "Headers" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "headers", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 248, "col": 2, "byteIndex": 6502 } }, { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "data", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 250, "col": 2, "byteIndex": 6532 } }, { "tsType": { "repr": "globalThis.Response", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "globalThis.Response" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "raw", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 251, "col": 2, "byteIndex": 6559 } } ], "indexSignatures": [], "methods": [], "extends": null, "implements": [ { "repr": "GraphqlResponseError", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "GraphqlResponseError" } } ], "typeParams": [ { "name": "T" } ], "superTypeParams": [] } }, { "name": "GraphqlResponseFailureImpl", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 269, "col": 0, "byteIndex": 6987 }, "declarationKind": "export", "jsDoc": { "doc": "Implementation of GraphqlResponseFailure.", "tags": [ { "kind": "internal" } ] }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "params", "optional": false, "tsType": { "repr": "GraphqlResponseFailureParams", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlResponseFailureParams" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 283, "col": 2, "byteIndex": 7405 } } ], "properties": [ { "tsType": { "repr": "graphql", "kind": "literal", "literal": { "kind": "string", "string": "graphql" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "kind", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 271, "col": 2, "byteIndex": 7073 } }, { "tsType": { "repr": "false", "kind": "literal", "literal": { "kind": "boolean", "boolean": false } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "processed", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 272, "col": 2, "byteIndex": 7111 } }, { "tsType": { "repr": "false", "kind": "literal", "literal": { "kind": "boolean", "boolean": false } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "ok", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 273, "col": 2, "byteIndex": 7150 } }, { "tsType": { "repr": "GraphqlFailureError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlFailureError" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "error", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 274, "col": 2, "byteIndex": 7182 } }, { "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "extensions", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 275, "col": 2, "byteIndex": 7221 } }, { "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "status", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 276, "col": 2, "byteIndex": 7251 } }, { "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "headers", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 277, "col": 2, "byteIndex": 7277 } }, { "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "duration", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 278, "col": 2, "byteIndex": 7304 } }, { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "url", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 279, "col": 2, "byteIndex": 7333 } }, { "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "data", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 280, "col": 2, "byteIndex": 7357 } }, { "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "raw", "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/response.ts", "line": 281, "col": 2, "byteIndex": 7381 } } ], "indexSignatures": [], "methods": [], "extends": null, "implements": [ { "repr": "GraphqlResponseFailure", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "GraphqlResponseFailure" } } ], "typeParams": [ { "name": "T" } ], "superTypeParams": [] } }, { "name": "createGraphqlClient", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-graphql/0.6.0/client.ts", "line": 580, "col": 0, "byteIndex": 16746 }, "declarationKind": "export", "jsDoc": { "doc": "Create a new GraphQL client instance.\n\nThe client provides methods for executing GraphQL queries, mutations,\nand subscriptions with automatic error handling and response parsing.\n", "tags": [ { "kind": "param", "name": "config", "doc": "- Client configuration including URL and default options" }, { "kind": "return", "doc": "A new GraphQL client instance\n" }, { "kind": "example", "doc": "Basic query\n```ts\nimport { createGraphqlClient } from \"@probitas/client-graphql\";\n\nconst client = createGraphqlClient({\n url: \"http://localhost:4000/graphql\",\n});\n\nconst response = await client.query(`\n query GetUser($id: ID!) {\n user(id: $id) { id name email }\n }\n`, { id: \"123\" });\n\nconsole.log(response.data);\nawait client.close();\n```\n" }, { "kind": "example", "doc": "Using connection config object\n```ts\nimport { createGraphqlClient } from \"@probitas/client-graphql\";\n\nconst client = createGraphqlClient({\n url: { host: \"api.example.com\", port: 443, protocol: \"https\" },\n});\nawait client.close();\n```\n" }, { "kind": "example", "doc": "Mutation with error handling\n```ts\nimport { createGraphqlClient } from \"@probitas/client-graphql\";\n\nconst client = createGraphqlClient({ url: \"http://localhost:4000/graphql\" });\n\nconst response = await client.mutation(`\n mutation CreateUser($input: CreateUserInput!) {\n createUser(input: $input) { id }\n }\n`, { input: { name: \"Alice\", email: \"alice@example.com\" } });\n\nif (response.ok) {\n console.log(\"Created user:\", (response.data as any).createUser.id);\n}\n\nawait client.close();\n```\n" }, { "kind": "example", "doc": "Using `await using` for automatic cleanup\n```ts\nimport { createGraphqlClient } from \"@probitas/client-graphql\";\n\nawait using client = createGraphqlClient({\n url: \"http://localhost:4000/graphql\",\n});\nconst response = await client.query(`{ __typename }`);\n// Client automatically closed when scope exits\n```" } ] }, "kind": "function", "functionDef": { "params": [ { "kind": "identifier", "name": "config", "optional": false, "tsType": { "repr": "GraphqlClientConfig", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlClientConfig" } } } ], "returnType": { "repr": "GraphqlClient", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "GraphqlClient" } }, "hasBody": true, "isAsync": false, "isGenerator": false, "typeParams": [] } } ] }