{ "schemaVersion": "2.0", "id": 354, "name": "@probitas-test/client-graphql", "variant": "project", "kind": 1, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "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 " }, { "kind": "code", "text": "`AsyncDisposable`" }, { "kind": "text", "text": " for proper cleanup\n- **Template Literals**: Re-exports " }, { "kind": "code", "text": "`outdent`" }, { "kind": "text", "text": " for clean multi-line queries\n\n## Installation\n\n" }, { "kind": "code", "text": "```bash\nnpm install @probitas-test/client-graphql\n```" }, { "kind": "text", "text": "\n\n## Quick Start\n\n" }, { "kind": "code", "text": "```ts\nimport { createGraphqlClient, outdent } from \"@probitas-test/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```" }, { "kind": "text", "text": "\n\n## Using with " }, { "kind": "code", "text": "`using`" }, { "kind": "text", "text": " Statement\n\n" }, { "kind": "code", "text": "```ts\nimport { createGraphqlClient } from \"@probitas-test/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```" }, { "kind": "text", "text": "\n\n## Related Packages\n\n| Package | Description |\n|---------|-------------|\n| [" }, { "kind": "code", "text": "`@probitas-test/client`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client) | Core utilities and types |\n| [" }, { "kind": "code", "text": "`@probitas-test/client-http`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-http) | HTTP client |\n\n## Links\n\n- [GitHub Repository](https://github.com/probitas-test/probitas-packages)\n- [Probitas Framework](https://github.com/probitas-test/probitas)" } ] }, "children": [ { "id": 418, "name": "GraphqlExecutionError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "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.)." } ] }, "children": [ { "id": 419, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 420, "name": "GraphqlExecutionError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 421, "name": "errors", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 355, "name": "GraphqlErrorItem", "package": "@probitas-test/client-graphql" } } } }, { "id": 422, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2022.error.d.ts", "qualifiedName": "ErrorOptions" }, "name": "ErrorOptions", "package": "typescript" } } ], "type": { "type": "reference", "target": 418, "name": "GraphqlExecutionError", "package": "@probitas-test/client-graphql" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } } ], "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } }, { "id": 425, "name": "errors", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "GraphQL errors from response" } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 355, "name": "GraphqlErrorItem", "package": "@probitas-test/client-graphql" } } } }, { "id": 424, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "graphql" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": -1, "name": "ClientError.kind" } }, { "id": 423, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "GraphqlExecutionError" }, "defaultValue": "\"GraphqlExecutionError\"", "overwrites": { "type": "reference", "target": -1, "name": "ClientError.name" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/errors.d.ts", "qualifiedName": "ClientError" }, "name": "ClientError", "package": "@probitas-test/client" } ] }, { "id": 426, "name": "GraphqlNetworkError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "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.)." } ] }, "children": [ { "id": 427, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 428, "name": "GraphqlNetworkError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 429, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 430, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2022.error.d.ts", "qualifiedName": "ErrorOptions" }, "name": "ErrorOptions", "package": "typescript" } } ], "type": { "type": "reference", "target": 426, "name": "GraphqlNetworkError", "package": "@probitas-test/client-graphql" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } } ], "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } }, { "id": 432, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "network" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": -1, "name": "ClientError.kind" } }, { "id": 431, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "GraphqlNetworkError" }, "defaultValue": "\"GraphqlNetworkError\"", "overwrites": { "type": "reference", "target": -1, "name": "ClientError.name" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/errors.d.ts", "qualifiedName": "ClientError" }, "name": "ClientError", "package": "@probitas-test/client" } ] }, { "id": 386, "name": "GraphqlClient", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "GraphQL client interface." } ] }, "children": [ { "id": 387, "name": "config", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Client configuration" } ] }, "type": { "type": "reference", "target": 377, "name": "GraphqlClientConfig", "package": "@probitas-test/client-graphql" } }, { "id": 416, "name": "close", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 417, "name": "close", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Close the client and release resources" } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 402, "name": "execute", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 403, "name": "execute", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a GraphQL document (query or mutation)" } ] }, "typeParameters": [ { "id": 404, "name": "TData", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } }, { "id": 405, "name": "TVariables", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 406, "name": "document", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 407, "name": "variables", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 405, "name": "TVariables", "package": "@probitas-test/client-graphql", "refersToTypeParameter": true } }, { "id": 408, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 363, "name": "GraphqlOptions", "package": "@probitas-test/client-graphql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 509, "typeArguments": [ { "type": "reference", "target": 404, "name": "TData", "package": "@probitas-test/client-graphql", "refersToTypeParameter": true } ], "name": "GraphqlResponse", "package": "@probitas-test/client-graphql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 395, "name": "mutation", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 396, "name": "mutation", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a GraphQL mutation" } ] }, "typeParameters": [ { "id": 397, "name": "TData", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } }, { "id": 398, "name": "TVariables", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 399, "name": "mutation", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 400, "name": "variables", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 398, "name": "TVariables", "package": "@probitas-test/client-graphql", "refersToTypeParameter": true } }, { "id": 401, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 363, "name": "GraphqlOptions", "package": "@probitas-test/client-graphql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 509, "typeArguments": [ { "type": "reference", "target": 397, "name": "TData", "package": "@probitas-test/client-graphql", "refersToTypeParameter": true } ], "name": "GraphqlResponse", "package": "@probitas-test/client-graphql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 388, "name": "query", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 389, "name": "query", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a GraphQL query" } ] }, "typeParameters": [ { "id": 390, "name": "TData", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } }, { "id": 391, "name": "TVariables", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 392, "name": "query", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 393, "name": "variables", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 391, "name": "TVariables", "package": "@probitas-test/client-graphql", "refersToTypeParameter": true } }, { "id": 394, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 363, "name": "GraphqlOptions", "package": "@probitas-test/client-graphql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 509, "typeArguments": [ { "type": "reference", "target": 390, "name": "TData", "package": "@probitas-test/client-graphql", "refersToTypeParameter": true } ], "name": "GraphqlResponse", "package": "@probitas-test/client-graphql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 409, "name": "subscribe", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 410, "name": "subscribe", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Subscribe to a GraphQL subscription via WebSocket" } ] }, "typeParameters": [ { "id": 411, "name": "TData", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } }, { "id": 412, "name": "TVariables", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 413, "name": "document", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 414, "name": "variables", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 412, "name": "TVariables", "package": "@probitas-test/client-graphql", "refersToTypeParameter": true } }, { "id": 415, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 363, "name": "GraphqlOptions", "package": "@probitas-test/client-graphql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2018.asynciterable.d.ts", "qualifiedName": "AsyncIterable" }, "typeArguments": [ { "type": "reference", "target": 509, "typeArguments": [ { "type": "reference", "target": 411, "name": "TData", "package": "@probitas-test/client-graphql", "refersToTypeParameter": true } ], "name": "GraphqlResponse", "package": "@probitas-test/client-graphql" } ], "name": "AsyncIterable", "package": "typescript" } } ] } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.esnext.disposable.d.ts", "qualifiedName": "AsyncDisposable" }, "name": "AsyncDisposable", "package": "typescript" } ] }, { "id": 377, "name": "GraphqlClientConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "GraphQL client configuration." } ] }, "children": [ { "id": 381, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Custom fetch implementation (for testing/mocking)" } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "Fetch" }, "name": "Fetch", "package": "@probitas-test/client" } }, { "id": 379, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Default headers for all requests" } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "HeadersInit" }, "name": "HeadersInit", "package": "typescript" } }, { "id": 385, "name": "retry", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Retry configuration." } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "RetryOptions" }, "name": "RetryOptions", "package": "@probitas-test/client" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.retry" } }, { "id": 384, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "AbortSignal for cancellation." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.signal" } }, { "id": 382, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to throw GraphqlError when response contains errors or request fails.\nCan be overridden per-request via GraphqlOptions." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 383, "name": "timeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Timeout in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.timeout" } }, { "id": 378, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "GraphQL endpoint URL.\n\nCan be a URL string or a connection configuration object." } ], "blockTags": [ { "tag": "@example", "name": "String URL", "content": [ { "kind": "code", "text": "```ts\nimport type { GraphqlClientConfig } from \"@probitas-test/client-graphql\";\nconst config: GraphqlClientConfig = { url: \"http://localhost:4000/graphql\" };\n```" } ] }, { "tag": "@example", "name": "Connection config object", "content": [ { "kind": "code", "text": "```ts\nimport type { GraphqlClientConfig } from \"@probitas-test/client-graphql\";\nconst config: GraphqlClientConfig = {\n url: { host: \"api.example.com\", port: 443, protocol: \"https\" },\n};\n```" } ] } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": 370, "name": "GraphqlConnectionConfig", "package": "@probitas-test/client-graphql" } ] } }, { "id": 380, "name": "wsEndpoint", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "WebSocket endpoint URL (for subscriptions)" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "CommonOptions" }, "name": "CommonOptions", "package": "@probitas-test/client" } ] }, { "id": 370, "name": "GraphqlConnectionConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "GraphQL connection configuration.\n\nExtends CommonConnectionConfig with GraphQL-specific options." } ] }, "children": [ { "id": 373, "name": "host", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Hostname or IP address." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n\"localhost\"\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.host" } }, { "id": 376, "name": "password", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Password for authentication." } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.password" } }, { "id": 372, "name": "path", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "GraphQL endpoint path." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n\"/graphql\"\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 374, "name": "port", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Port number. Each service has its own default." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.port" } }, { "id": 371, "name": "protocol", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Protocol to use." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n\"http\"\n```" } ] } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "http" }, { "type": "literal", "value": "https" } ] } }, { "id": 375, "name": "username", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Username for authentication." } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.username" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "CommonConnectionConfig" }, "name": "CommonConnectionConfig", "package": "@probitas-test/client" } ] }, { "id": 355, "name": "GraphqlErrorItem", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "GraphQL error item as per GraphQL specification." } ], "blockTags": [ { "tag": "@see", "content": [ { "kind": "text", "text": "https://spec.graphql.org/October2021/#sec-Errors.Error-Result-Format" } ] } ] }, "children": [ { "id": 362, "name": "extensions", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Additional error metadata" } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" }, { "type": "literal", "value": null } ] } }, { "id": 357, "name": "locations", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Location(s) in the GraphQL document where the error occurred" } ] }, "type": { "type": "union", "types": [ { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 358, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 360, "name": "column", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 359, "name": "line", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ] } } } }, { "type": "literal", "value": null } ] } }, { "id": 356, "name": "message", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error message" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 361, "name": "path", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Path to the field that caused the error" } ] }, "type": { "type": "union", "types": [ { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" } ] } } }, { "type": "literal", "value": null } ] } } ] }, { "id": 363, "name": "GraphqlOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for individual GraphQL requests." } ] }, "children": [ { "id": 364, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Additional request headers" } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "HeadersInit" }, "name": "HeadersInit", "package": "typescript" } }, { "id": 365, "name": "operationName", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation name (for documents with multiple operations)" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 369, "name": "retry", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Retry configuration." } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "RetryOptions" }, "name": "RetryOptions", "package": "@probitas-test/client" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.retry" } }, { "id": 368, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "AbortSignal for cancellation." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.signal" } }, { "id": 366, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to throw GraphqlError when response contains errors or request fails." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse (inherited from client config if not specified)\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 367, "name": "timeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Timeout in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.timeout" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "CommonOptions" }, "name": "CommonOptions", "package": "@probitas-test/client" } ] }, { "id": 511, "name": "GraphqlResponseError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "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." } ] }, "children": [ { "id": 520, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Response data (null if no data, may be partial data with errors)." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 512, "name": "T", "package": "@probitas-test/client-graphql", "qualifiedName": "GraphqlResponseError.T", "refersToTypeParameter": true }, { "type": "literal", "value": null } ] }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.data", "package": "@probitas-test/client-graphql" } }, { "id": 522, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Response time in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 535, "name": "GraphqlResponseBase.duration", "package": "@probitas-test/client-graphql" } }, { "id": 515, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error information (null if successful).\n\nContains:\n- GraphqlExecutionError for GraphQL errors\n- GraphqlNetworkError/AbortError/TimeoutError for failures" } ] }, "type": { "type": "reference", "target": 418, "name": "GraphqlExecutionError", "package": "@probitas-test/client-graphql" }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.error", "package": "@probitas-test/client-graphql" } }, { "id": 518, "name": "extensions", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Response extensions." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" }, { "type": "literal", "value": null } ] }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.extensions", "package": "@probitas-test/client-graphql" } }, { "id": 517, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP response headers." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "Headers" }, "name": "Headers", "package": "typescript" } }, { "id": 521, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nAlways " }, { "kind": "code", "text": "`\"graphql\"`" }, { "kind": "text", "text": " for GraphQL responses. Use this in switch statements\nfor type-safe narrowing of union types." } ] }, "type": { "type": "literal", "value": "graphql" }, "inheritedFrom": { "type": "reference", "target": 534, "name": "GraphqlResponseBase.kind", "package": "@probitas-test/client-graphql" } }, { "id": 514, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the request was successful.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": No errors, data available\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": GraphQL errors or request failure" } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.ok", "package": "@probitas-test/client-graphql" } }, { "id": 513, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the request was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server responded (success or GraphQL error)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before processing (network error, HTTP error)" } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.processed", "package": "@probitas-test/client-graphql" } }, { "id": 519, "name": "raw", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Raw Web standard Response." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.raw", "package": "@probitas-test/client-graphql" } }, { "id": 516, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 523, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Request URL." } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 536, "name": "GraphqlResponseBase.url", "package": "@probitas-test/client-graphql" } } ], "typeParameters": [ { "id": 512, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-graphql", "packagePath": "response.ts", "qualifiedName": "GraphqlResponseBase" }, "typeArguments": [ { "type": "reference", "target": 512, "name": "T", "package": "@probitas-test/client-graphql", "qualifiedName": "GraphqlResponseError.T", "refersToTypeParameter": true } ], "name": "GraphqlResponseBase", "package": "@probitas-test/client-graphql" } ] }, { "id": 442, "name": "GraphqlResponseErrorParams", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for creating an error GraphqlResponse." } ] }, "children": [ { "id": 445, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "union", "types": [ { "type": "reference", "target": 443, "name": "T", "package": "@probitas-test/client-graphql", "qualifiedName": "GraphqlResponseErrorParams.T", "refersToTypeParameter": true }, { "type": "literal", "value": null } ] } }, { "id": 448, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 446, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": 418, "name": "GraphqlExecutionError", "package": "@probitas-test/client-graphql" } }, { "id": 447, "name": "extensions", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "union", "types": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" }, { "type": "literal", "value": null } ] } }, { "id": 450, "name": "raw", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } }, { "id": 449, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 444, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ], "typeParameters": [ { "id": 443, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ] }, { "id": 524, "name": "GraphqlResponseFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Failed GraphQL request (network error, HTTP error, etc.).\n\nThe request did not reach GraphQL processing." } ] }, "children": [ { "id": 533, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "No data (request didn't reach server)." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.data", "package": "@probitas-test/client-graphql" } }, { "id": 535, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Response time in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.duration" } }, { "id": 528, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error information (null if successful).\n\nContains:\n- GraphqlExecutionError for GraphQL errors\n- GraphqlNetworkError/AbortError/TimeoutError for failures" } ] }, "type": { "type": "reference", "target": 433, "name": "GraphqlFailureError", "package": "@probitas-test/client-graphql" }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.error", "package": "@probitas-test/client-graphql" } }, { "id": 529, "name": "extensions", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Response extensions (always null for failures)." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.extensions", "package": "@probitas-test/client-graphql" } }, { "id": 531, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP response headers (null for failures)." } ] }, "type": { "type": "literal", "value": null } }, { "id": 534, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nAlways " }, { "kind": "code", "text": "`\"graphql\"`" }, { "kind": "text", "text": " for GraphQL responses. Use this in switch statements\nfor type-safe narrowing of union types." } ] }, "type": { "type": "literal", "value": "graphql" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.kind" } }, { "id": 527, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the request was successful.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": No errors, data available\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": GraphQL errors or request failure" } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.ok", "package": "@probitas-test/client-graphql" } }, { "id": 526, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the request was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server responded (success or GraphQL error)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before processing (network error, HTTP error)" } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.processed", "package": "@probitas-test/client-graphql" } }, { "id": 532, "name": "raw", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "No raw response (request didn't reach server)." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.raw", "package": "@probitas-test/client-graphql" } }, { "id": 530, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code (null for network failures)." } ] }, "type": { "type": "literal", "value": null } }, { "id": 536, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Request URL." } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.url" } } ], "typeParameters": [ { "id": 525, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-graphql", "packagePath": "response.ts", "qualifiedName": "GraphqlResponseBase" }, "typeArguments": [ { "type": "reference", "target": 525, "name": "T", "package": "@probitas-test/client-graphql", "qualifiedName": "GraphqlResponseFailure.T", "refersToTypeParameter": true } ], "name": "GraphqlResponseBase", "package": "@probitas-test/client-graphql" } ] }, { "id": 451, "name": "GraphqlResponseFailureParams", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for creating a failure GraphqlResponse." } ] }, "children": [ { "id": 454, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 453, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": 433, "name": "GraphqlFailureError", "package": "@probitas-test/client-graphql" } }, { "id": 452, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 537, "name": "GraphqlResponseSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful GraphQL response (no errors)." } ] }, "children": [ { "id": 546, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Response data (null if no data)." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 538, "name": "T", "package": "@probitas-test/client-graphql", "qualifiedName": "GraphqlResponseSuccess.T", "refersToTypeParameter": true }, { "type": "literal", "value": null } ] }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.data", "package": "@probitas-test/client-graphql" } }, { "id": 548, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Response time in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.duration" } }, { "id": 541, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error information (null if successful).\n\nContains:\n- GraphqlExecutionError for GraphQL errors\n- GraphqlNetworkError/AbortError/TimeoutError for failures" } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.error", "package": "@probitas-test/client-graphql" } }, { "id": 544, "name": "extensions", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Response extensions." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" }, { "type": "literal", "value": null } ] }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.extensions", "package": "@probitas-test/client-graphql" } }, { "id": 543, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP response headers." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "Headers" }, "name": "Headers", "package": "typescript" } }, { "id": 547, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nAlways " }, { "kind": "code", "text": "`\"graphql\"`" }, { "kind": "text", "text": " for GraphQL responses. Use this in switch statements\nfor type-safe narrowing of union types." } ] }, "type": { "type": "literal", "value": "graphql" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.kind" } }, { "id": 540, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the request was successful.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": No errors, data available\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": GraphQL errors or request failure" } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.ok", "package": "@probitas-test/client-graphql" } }, { "id": 539, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the request was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server responded (success or GraphQL error)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before processing (network error, HTTP error)" } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.processed", "package": "@probitas-test/client-graphql" } }, { "id": 545, "name": "raw", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Raw Web standard Response." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.raw", "package": "@probitas-test/client-graphql" } }, { "id": 542, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 549, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Request URL." } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "GraphqlResponseBase.url" } } ], "typeParameters": [ { "id": 538, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-graphql", "packagePath": "response.ts", "qualifiedName": "GraphqlResponseBase" }, "typeArguments": [ { "type": "reference", "target": 538, "name": "T", "package": "@probitas-test/client-graphql", "qualifiedName": "GraphqlResponseSuccess.T", "refersToTypeParameter": true } ], "name": "GraphqlResponseBase", "package": "@probitas-test/client-graphql" } ] }, { "id": 434, "name": "GraphqlResponseSuccessParams", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for creating a successful GraphqlResponse." } ] }, "children": [ { "id": 437, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "union", "types": [ { "type": "reference", "target": 435, "name": "T", "package": "@probitas-test/client-graphql", "qualifiedName": "GraphqlResponseSuccessParams.T", "refersToTypeParameter": true }, { "type": "literal", "value": null } ] } }, { "id": 439, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 438, "name": "extensions", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "union", "types": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" }, { "type": "literal", "value": null } ] } }, { "id": 441, "name": "raw", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } }, { "id": 440, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 436, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ], "typeParameters": [ { "id": 435, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ] }, { "id": 433, "name": "GraphqlFailureError", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error types that indicate the operation was not processed.\nThese are errors that occur before the request reaches the GraphQL server." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 426, "name": "GraphqlNetworkError", "package": "@probitas-test/client-graphql" }, { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/errors.d.ts", "qualifiedName": "AbortError" }, "name": "AbortError", "package": "@probitas-test/client" }, { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/errors.d.ts", "qualifiedName": "TimeoutError" }, "name": "TimeoutError", "package": "@probitas-test/client" } ] } }, { "id": 509, "name": "GraphqlResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "GraphQL response union type.\n\nUse " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " to distinguish between server responses and failures:\n- " }, { "kind": "code", "text": "`processed === true`" }, { "kind": "text", "text": ": Server responded (Success or Error)\n- " }, { "kind": "code", "text": "`processed === false`" }, { "kind": "text", "text": ": Request failed (Failure)\n\nUse " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " to check for success:\n- " }, { "kind": "code", "text": "`ok === true`" }, { "kind": "text", "text": ": Success (no errors)\n- " }, { "kind": "code", "text": "`ok === false`" }, { "kind": "text", "text": ": Error or Failure" } ] }, "typeParameters": [ { "id": 510, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 537, "typeArguments": [ { "type": "reference", "target": 510, "name": "T", "package": "@probitas-test/client-graphql", "refersToTypeParameter": true } ], "name": "GraphqlResponseSuccess", "package": "@probitas-test/client-graphql" }, { "type": "reference", "target": 511, "typeArguments": [ { "type": "reference", "target": 510, "name": "T", "package": "@probitas-test/client-graphql", "refersToTypeParameter": true } ], "name": "GraphqlResponseError", "package": "@probitas-test/client-graphql" }, { "type": "reference", "target": 524, "typeArguments": [ { "type": "reference", "target": 510, "name": "T", "package": "@probitas-test/client-graphql", "refersToTypeParameter": true } ], "name": "GraphqlResponseFailure", "package": "@probitas-test/client-graphql" } ] } }, { "id": 506, "name": "createGraphqlClient", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 507, "name": "createGraphqlClient", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "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." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A new GraphQL client instance" } ] }, { "tag": "@example", "name": "Basic query", "content": [ { "kind": "code", "text": "```ts\nimport { createGraphqlClient } from \"@probitas-test/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```" } ] }, { "tag": "@example", "name": "Using connection config object", "content": [ { "kind": "code", "text": "```ts\nimport { createGraphqlClient } from \"@probitas-test/client-graphql\";\n\nconst client = createGraphqlClient({\n url: { host: \"api.example.com\", port: 443, protocol: \"https\" },\n});\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Mutation with error handling", "content": [ { "kind": "code", "text": "```ts\nimport { createGraphqlClient } from \"@probitas-test/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```" } ] }, { "tag": "@example", "name": "Using `await using` for automatic cleanup", "content": [ { "kind": "code", "text": "```ts\nimport { createGraphqlClient } from \"@probitas-test/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```" } ] } ] }, "parameters": [ { "id": 508, "name": "config", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Client configuration including URL and default options" } ] }, "type": { "type": "reference", "target": 377, "name": "GraphqlClientConfig", "package": "@probitas-test/client-graphql" } } ], "type": { "type": "reference", "target": 386, "name": "GraphqlClient", "package": "@probitas-test/client-graphql" } } ] } ], "packageName": "@probitas-test/client-graphql", "packageVersion": "0.7.1" }