effect 4.0.3 → 4.0.4

package/dist/graphql/GraphQLClient.d.ts

@@ -0,0 +1,562 @@
+import * as Context from "../Context.ts";
+import * as Duration from "../Duration.ts";
+import * as Effect from "../Effect.ts";
+import * as Headers from "../http/Headers.ts";
+import * as UrlParams from "../http/UrlParams.ts";
+import * as Layer from "../Layer.ts";
+import * as Schedule from "../Schedule.ts";
+import * as Stream from "../Stream.ts";
+import type * as GraphQL from "./GraphQL.ts";
+import { GraphQLClientError, type GraphQLError } from "./GraphQLClientError.ts";
+import type * as GraphQLGroup from "./GraphQLGroup.ts";
+import type * as GraphQLMiddleware from "./GraphQLMiddleware.ts";
+import { GraphQLProtocol } from "./GraphQLProtocol.ts";
+/**
+ * Decoded `data` and response `errors` for a `{ partial: true }` call.
+ * The errors array may be empty.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface PartialResult<A> {
+    readonly data: A;
+    readonly errors: ReadonlyArray<GraphQLError>;
+}
+type Args<Variables, Options> = {} extends Variables ? [variables?: Variables, options?: Options] : [variables: Variables, options?: Options];
+type ArgsWithOptions<Variables, Options> = {} extends Variables ? [variables: Variables | undefined, options: Options] : [variables: Variables, options: Options];
+/**
+ * The client method for a query or mutation.
+ *
+ * **Details**
+ *
+ * Called as `(variables?, options?)`. Without `partial`, or with
+ * `partial: false`, it returns the decoded result and fails with a
+ * `ResponseError` on any `errors`. With `partial: true` it returns
+ * `{ data, errors }`. `partial` must be a literal `true` or `false`, not
+ * an arbitrary `boolean`.
+ *
+ * An operation without variables is called as `client.Viewer()` or, with
+ * options, `client.Viewer(undefined, { headers })`.
+ *
+ * `headers` and `urlParams` are sent by the HTTP transport, ignored over
+ * graphql-ws, and visible to middleware either way as
+ * `GraphQLRequest.headers` and `GraphQLRequest.urlParams`. Header options
+ * accept `Headers.Input` and are normalized to `Headers.Headers` before
+ * middleware runs. `context` provides
+ * services for this call only, and removes them from the method's
+ * requirements.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface OperationMethod<Op extends GraphQL.Any> {
+    /** The operation this method runs. */
+    readonly operation: Op;
+    <R2 = never>(...args: ArgsWithOptions<GraphQL.Variables<Op>, {
+        readonly headers?: Headers.Input | undefined;
+        readonly urlParams?: UrlParams.Input | undefined;
+        readonly context?: Context.Context<R2> | undefined;
+        readonly partial: true;
+    }>): Effect.Effect<PartialResult<GraphQL.Result<Op>>, GraphQL.Error<Op>, Exclude<GraphQL.Services<Op>, R2>>;
+    <R2 = never>(...args: Args<GraphQL.Variables<Op>, {
+        readonly headers?: Headers.Input | undefined;
+        readonly urlParams?: UrlParams.Input | undefined;
+        readonly context?: Context.Context<R2> | undefined;
+        readonly partial?: false | undefined;
+    }>): Effect.Effect<GraphQL.Result<Op>, GraphQL.Error<Op>, Exclude<GraphQL.Services<Op>, R2>>;
+}
+/**
+ * The client method for a subscription. It returns a `Stream` of decoded
+ * events; an event with `errors` fails the stream with a `ResponseError`,
+ * unless that error is retryable and the client resubscribes (see
+ * {@link make}). `headers`, `urlParams` and `context` work as for
+ * {@link OperationMethod}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface SubscriptionMethod<Op extends GraphQL.Any> {
+    /** The operation this method runs. */
+    readonly operation: Op;
+    <R2 = never>(...args: Args<GraphQL.Variables<Op>, {
+        readonly headers?: Headers.Input | undefined;
+        readonly urlParams?: UrlParams.Input | undefined;
+        readonly context?: Context.Context<R2> | undefined;
+    }>): Stream.Stream<GraphQL.Result<Op>, GraphQL.Error<Op>, Exclude<GraphQL.Services<Op>, R2>>;
+}
+/**
+ * The client method type for an operation, by its kind.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export type Method<Op extends GraphQL.Any> = Op["kind"] extends "subscription" ? SubscriptionMethod<Op> : OperationMethod<Op>;
+/**
+ * A client: one method per operation, keyed by operation name.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export type GraphQLClient<Ops extends GraphQL.Any> = {
+    readonly [Op in Ops as Op["name"]]: Method<Op>;
+};
+/**
+ * Derives the client type for all operations in a `GraphQLGroup`.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export type FromGroup<Group> = GraphQLClient<GraphQLGroup.Operations<Group>>;
+/**
+ * The default subscription retry schedule: exponential from 500 milliseconds
+ * with factor 1.5, capped at 5 seconds, and never shorter than the server's
+ * `retryAfter`.
+ *
+ * @stability experimental
+ * @category constants
+ * @since 4.0.0
+ */
+export declare const defaultSubscriptionRetry: Schedule.Schedule<Duration.Duration, GraphQLClientError>;
+/**
+ * Builds a client from a group, requiring `GraphQLProtocol` and every
+ * middleware service attached to the group or its operations.
+ *
+ * **Details**
+ *
+ * Group middleware runs outside operation middleware. Within each level,
+ * middleware run in the order attached.
+ *
+ * `subscriptionRetry` decides how a subscription is retried after it fails
+ * with a retryable error: usually a `TransportError`, but also a
+ * `ResponseError` whose response carried a valid `Retry-After`, including an
+ * event with `errors` on a graphql-sse stream whose response had that header.
+ * It defaults to {@link defaultSubscriptionRetry}. Fatal errors are never
+ * retried, whatever the schedule. A retry starts a new subscription, so the
+ * server may send events again that the stream already emitted.
+ *
+ * **Example** (A client as a service)
+ *
+ * ```ts import.meta.vitest
+ * import { Context, Effect, Layer, Schema, Stream } from "effect"
+ * import { GraphQL, GraphQLClient, GraphQLGroup, GraphQLProtocol } from "effect/graphql"
+ *
+ * // What the generator emits for viewer.graphql
+ * const Viewer = GraphQL.query("Viewer", {
+ *   document: "query Viewer{viewer{login}}",
+ *   result: Schema.Struct({ viewer: Schema.Struct({ login: Schema.String }) })
+ * })
+ * const ViewerGraphQLGroup = GraphQLGroup.make(Viewer)
+ *
+ * class GitHub extends Context.Service<GitHub>()("app/GitHub", {
+ *   make: GraphQLClient.make(ViewerGraphQLGroup)
+ * }) {}
+ *
+ * // A scripted transport; use GraphQLProtocol.layerHttp({ url }) for a real server
+ * const Scripted = Layer.succeed(GraphQLProtocol.GraphQLProtocol, {
+ *   execute: () => Effect.succeed({ body: { data: { viewer: { login: "tim" } } } }),
+ *   subscribe: () => Stream.empty
+ * })
+ *
+ * const program = GitHub.use((github) => github.Viewer()).pipe(
+ *   Effect.provide(Layer.effect(GitHub, GitHub.make).pipe(Layer.provide(Scripted)))
+ * )
+ *
+ * await Effect.runPromise(program) // => { viewer: { login: "tim" } }
+ * ```
+ *
+ * **Example** (Partial results)
+ *
+ * ```ts import.meta.vitest
+ * import { Effect, Layer, Schema, Stream } from "effect"
+ * import { GraphQL, GraphQLClient, GraphQLGroup, GraphQLProtocol } from "effect/graphql"
+ *
+ * const Repos = GraphQL.query("Repos", {
+ *   document: "query Repos{a:repository(owner:\"x\",name:\"a\"){name} b:repository(owner:\"x\",name:\"b\"){name}}",
+ *   result: Schema.Struct({
+ *     a: Schema.NullOr(Schema.Struct({ name: Schema.String })),
+ *     b: Schema.NullOr(Schema.Struct({ name: Schema.String }))
+ *   })
+ * })
+ *
+ * const Scripted = Layer.succeed(GraphQLProtocol.GraphQLProtocol, {
+ *   execute: () =>
+ *     Effect.succeed({
+ *       body: {
+ *         data: { a: { name: "a" }, b: null },
+ *         errors: [{ message: "Could not resolve to a Repository", path: ["b"] }]
+ *       }
+ *     }),
+ *   subscribe: () => Stream.empty
+ * })
+ *
+ * const program = Effect.gen(function*() {
+ *   const client = yield* GraphQLClient.make(GraphQLGroup.make(Repos))
+ *   // The default call fails with a ResponseError because `errors` is non-empty
+ *   const failed = yield* Effect.flip(client.Repos())
+ *   // With partial: true the decoded data comes back together with the errors
+ *   const { data, errors } = yield* client.Repos(undefined, { partial: true })
+ *   return [failed.reason._tag, data.a?.name, errors[0].path?.[0]]
+ * })
+ *
+ * await Effect.runPromise(program.pipe(Effect.provide(Scripted))) // => ["ResponseError", "a", "b"]
+ * ```
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const make: <Ops extends GraphQL.Any>(group: GraphQLGroup.GraphQLGroup<Ops>, options?: {
+    readonly subscriptionRetry?: Schedule.Schedule<unknown, GraphQLClientError> | undefined;
+} | undefined) => Effect.Effect<GraphQLClient<Ops>, never, GraphQLProtocol | GraphQLMiddleware.Identifier<GraphQL.Middleware<Ops>>>;
+/**
+ * The `pageInfo` a paged connection must select.
+ *
+ * @stability experimental
+ * @category paging
+ * @since 4.0.0
+ */
+export interface PageInfo {
+    readonly hasNextPage: boolean;
+    readonly endCursor: string | null;
+}
+/**
+ * What the `connection` getter of {@link pages} must return.
+ *
+ * @stability experimental
+ * @category paging
+ * @since 4.0.0
+ */
+export interface Connection {
+    readonly pageInfo: PageInfo;
+}
+/**
+ * What the `connection` getter of {@link items} must return: a connection
+ * that also selects `nodes`.
+ *
+ * @stability experimental
+ * @category paging
+ * @since 4.0.0
+ */
+export interface NodesConnection<Node> extends Connection {
+    readonly nodes: ReadonlyArray<Node> | null;
+}
+/**
+ * The type `variables` is given when the operation has no `$after` variable.
+ * Nothing is assignable to it, so the mistake is a compile error at the call.
+ *
+ * @stability experimental
+ * @category paging
+ * @since 4.0.0
+ */
+export interface MissingAfterVariable {
+    readonly "effect/graphql": "GraphQLClient.pages requires the operation to declare a nullable `$after: String` variable";
+}
+/**
+ * The type `variables` is given when the operation's `after` variable is
+ * required or does not accept a `string`. The helper leaves `after` out on the
+ * first page and sends the previous `endCursor` afterwards, so it can only
+ * drive an optional variable that takes a string.
+ *
+ * @stability experimental
+ * @category paging
+ * @since 4.0.0
+ */
+export interface InvalidAfterVariable {
+    readonly "effect/graphql": "GraphQLClient.pages requires the `after` variable to be optional and to accept a string";
+}
+/**
+ * The `variables` accepted by {@link pages} and {@link items}: the method's
+ * variables without `after`, which the helper supplies.
+ *
+ * **Details**
+ *
+ * The operation's `after` variable must be optional and accept a `string`.
+ * `after?: string | null`, from a nullable `$after: String`, and
+ * `after?: string`, from a `$after: String!` with a default value, are both
+ * accepted. A required `after` gives {@link InvalidAfterVariable}, as does one
+ * that does not accept a `string`; no `after` at all gives
+ * {@link MissingAfterVariable}.
+ *
+ * @stability experimental
+ * @category paging
+ * @since 4.0.0
+ */
+export type PagingVariables<Variables> = "after" extends keyof Variables ? {} extends Pick<Variables, "after"> ? string extends Variables["after"] ? Omit<Variables, "after"> : InvalidAfterVariable : InvalidAfterVariable : MissingAfterVariable;
+/**
+ * Pages forward through a cursor connection, emitting one connection per
+ * page.
+ *
+ * **Details**
+ *
+ * Requires an optional string `$after` variable (see {@link PagingVariables}).
+ * The first request omits `after`; subsequent requests use the previous
+ * `endCursor`. Pages are fetched only when pulled, so `Stream.take` stops
+ * further requests. Middleware runs on each page.
+ *
+ * `connection` extracts the connection from each result. `options` is
+ * forwarded to every call but cannot include `partial`: errors fail the stream.
+ * Its `headers` accept `Headers.Input`, just as for operation calls.
+ *
+ * The stream ends after a page whose `hasNextPage` is `false`. A `null`
+ * connection on the first page gives an empty stream; on a later page it
+ * fails with a `PaginationError`, as does `hasNextPage: true` with a `null`
+ * or unchanged `endCursor`.
+ *
+ * Root fields that come with every page, such as GitHub's `rateLimit`, are for
+ * middleware to read from the raw `ExecutionResult`.
+ *
+ * **Example** (Paging issues, two per page)
+ *
+ * ```ts import.meta.vitest
+ * import { Effect, Layer, Schema, Stream } from "effect"
+ * import { GraphQL, GraphQLClient, GraphQLGroup, GraphQLProtocol } from "effect/graphql"
+ *
+ * const RepoIssues = GraphQL.query("RepoIssues", {
+ *   document: "query RepoIssues($owner:String!,$name:String!,$after:String){repository(owner:$owner,name:$name){issues(first:2,after:$after){pageInfo{hasNextPage endCursor}nodes{number}}}}",
+ *   variables: { owner: Schema.String, name: Schema.String, after: Schema.optional(Schema.NullOr(Schema.String)) },
+ *   result: Schema.Struct({
+ *     repository: Schema.NullOr(Schema.Struct({
+ *       issues: Schema.Struct({
+ *         pageInfo: Schema.Struct({ hasNextPage: Schema.Boolean, endCursor: Schema.NullOr(Schema.String) }),
+ *         nodes: Schema.NullOr(Schema.Array(Schema.NullOr(Schema.Struct({ number: Schema.Int }))))
+ *       })
+ *     }))
+ *   })
+ * })
+ *
+ * // A scripted server with two pages
+ * const Scripted = Layer.succeed(GraphQLProtocol.GraphQLProtocol, {
+ *   execute: (request) => {
+ *     const after = (request.variables as { after?: string }).after
+ *     const page = after === undefined
+ *       ? { pageInfo: { hasNextPage: true, endCursor: "c1" }, nodes: [{ number: 1 }, { number: 2 }] }
+ *       : { pageInfo: { hasNextPage: false, endCursor: null }, nodes: [{ number: 3 }] }
+ *     return Effect.succeed({ body: { data: { repository: { issues: page } } } })
+ *   },
+ *   subscribe: () => Stream.empty
+ * })
+ *
+ * const program = Effect.gen(function*() {
+ *   const client = yield* GraphQLClient.make(GraphQLGroup.make(RepoIssues))
+ *   const pages = GraphQLClient.pages(client.RepoIssues, {
+ *     variables: { owner: "Effect-TS", name: "effect" },
+ *     connection: (result) => result.repository?.issues
+ *   })
+ *   return yield* Stream.runCollect(Stream.map(pages, (page) => page.pageInfo.endCursor))
+ * })
+ *
+ * await Effect.runPromise(program.pipe(Effect.provide(Scripted))) // => ["c1", null]
+ * ```
+ *
+ * @stability experimental
+ * @category paging
+ * @since 4.0.0
+ */
+export declare const pages: <Op extends GraphQL.Any, C extends Connection, R2 = never>(method: OperationMethod<Op>, options: {
+    readonly variables: PagingVariables<GraphQL.Variables<Op>>;
+    readonly connection: (result: GraphQL.Result<Op>) => C | null | undefined;
+    readonly options?: {
+        readonly headers?: Headers.Input | undefined;
+        readonly urlParams?: UrlParams.Input | undefined;
+        readonly context?: Context.Context<R2> | undefined;
+    } | undefined;
+}) => Stream.Stream<C, GraphQL.Error<Op>, Exclude<GraphQL.Services<Op>, R2>>;
+/**
+ * Like {@link pages}, but emits decoded entries from `nodes`, including
+ * `null` entries. Use `Stream.filter(Predicate.isNotNull)` to drop them.
+ * For connections selecting only `edges`, use {@link pages} with
+ * `Stream.flatMap`.
+ *
+ * **Example** (Flattening issue numbers across pages)
+ *
+ * ```ts import.meta.vitest
+ * import { Effect, Layer, Schema, Stream } from "effect"
+ * import { GraphQL, GraphQLClient, GraphQLGroup, GraphQLProtocol } from "effect/graphql"
+ *
+ * const RepoIssues = GraphQL.query("RepoIssues", {
+ *   document: "query RepoIssues($owner:String!,$name:String!,$after:String){repository(owner:$owner,name:$name){issues(first:2,after:$after){pageInfo{hasNextPage endCursor}nodes{number}}}}",
+ *   variables: { owner: Schema.String, name: Schema.String, after: Schema.optional(Schema.NullOr(Schema.String)) },
+ *   result: Schema.Struct({
+ *     repository: Schema.NullOr(Schema.Struct({
+ *       issues: Schema.Struct({
+ *         pageInfo: Schema.Struct({ hasNextPage: Schema.Boolean, endCursor: Schema.NullOr(Schema.String) }),
+ *         nodes: Schema.NullOr(Schema.Array(Schema.NullOr(Schema.Struct({ number: Schema.Int }))))
+ *       })
+ *     }))
+ *   })
+ * })
+ *
+ * const Scripted = Layer.succeed(GraphQLProtocol.GraphQLProtocol, {
+ *   execute: (request) => {
+ *     const after = (request.variables as { after?: string }).after
+ *     const page = after === undefined
+ *       ? { pageInfo: { hasNextPage: true, endCursor: "c1" }, nodes: [{ number: 1 }, null] }
+ *       : { pageInfo: { hasNextPage: false, endCursor: null }, nodes: [{ number: 3 }] }
+ *     return Effect.succeed({ body: { data: { repository: { issues: page } } } })
+ *   },
+ *   subscribe: () => Stream.empty
+ * })
+ *
+ * const program = Effect.gen(function*() {
+ *   const client = yield* GraphQLClient.make(GraphQLGroup.make(RepoIssues))
+ *   const items = GraphQLClient.items(client.RepoIssues, {
+ *     variables: { owner: "Effect-TS", name: "effect" },
+ *     connection: (result) => result.repository?.issues
+ *   })
+ *   return yield* Stream.runCollect(Stream.map(items, (issue) => issue?.number ?? null))
+ * })
+ *
+ * await Effect.runPromise(program.pipe(Effect.provide(Scripted))) // => [1, null, 3]
+ * ```
+ *
+ * @stability experimental
+ * @category paging
+ * @since 4.0.0
+ */
+export declare const items: <Op extends GraphQL.Any, Node, R2 = never>(method: OperationMethod<Op>, options: {
+    readonly variables: PagingVariables<GraphQL.Variables<Op>>;
+    readonly connection: (result: GraphQL.Result<Op>) => NodesConnection<Node> | null | undefined;
+    readonly options?: {
+        readonly headers?: Headers.Input | undefined;
+        readonly urlParams?: UrlParams.Input | undefined;
+        readonly context?: Context.Context<R2> | undefined;
+    } | undefined;
+}) => Stream.Stream<Node, GraphQL.Error<Op>, Exclude<GraphQL.Services<Op>, R2>>;
+/**
+ * The options a {@link makeTest} handler receives: the `headers` and
+ * `urlParams` the caller passed, unchanged. Headers accept `Headers.Input`;
+ * unlike real transport requests, test call options are not normalized.
+ *
+ * @stability experimental
+ * @category testing
+ * @since 4.0.0
+ */
+export interface TestCallOptions {
+    readonly headers?: Headers.Input | undefined;
+    readonly urlParams?: UrlParams.Input | undefined;
+}
+/**
+ * A {@link makeTest} handler for one operation. Queries and mutations return
+ * an `Effect` and subscriptions a `Stream` of the decoded result type.
+ *
+ * @stability experimental
+ * @category testing
+ * @since 4.0.0
+ */
+export type TestHandler<Op extends GraphQL.Any> = Op["kind"] extends "subscription" ? (variables: GraphQL.Variables<Op>, options: TestCallOptions) => Stream.Stream<GraphQL.Result<Op>, GraphQL.Error<Op>> : (variables: GraphQL.Variables<Op>, options: TestCallOptions) => Effect.Effect<GraphQL.Result<Op>, GraphQL.Error<Op>>;
+/**
+ * The handlers given to {@link makeTest}, keyed by operation name. Every
+ * handler is optional.
+ *
+ * @stability experimental
+ * @category testing
+ * @since 4.0.0
+ */
+export type TestHandlers<Ops extends GraphQL.Any> = {
+    readonly [Op in Ops as Op["name"]]?: TestHandler<Op>;
+};
+/**
+ * Builds a client for tests that answers each operation from a handler,
+ * without a protocol.
+ *
+ * **Details**
+ *
+ * Handlers receive the caller's `variables` and options unchanged and return
+ * values in their decoded form. Nothing is encoded, decoded or validated, and
+ * no middleware runs. Called with `{ partial: true }`, a method returns
+ * `{ data, errors: [] }`. Subscriptions are not retried. Every method carries
+ * `.operation`, so {@link pages} and {@link items} work on it.
+ *
+ * Calling an operation without a handler dies with an `UnimplementedError`
+ * defect, so `catchTag` in the code under test cannot swallow a missing stub.
+ *
+ * Methods keep the real client's types, including middleware service
+ * requirements. Tests must provide those services even though mocks do not
+ * use them.
+ *
+ * To test partial data together with `errors`, or the encode and decode path,
+ * provide a scripted `GraphQLProtocol` layer to {@link make} instead.
+ *
+ * **Example** (Replacing a client service in tests)
+ *
+ * ```ts import.meta.vitest
+ * import { Context, Effect, Layer, Schema } from "effect"
+ * import { GraphQL, GraphQLClient, GraphQLGroup } from "effect/graphql"
+ *
+ * const RepoIssues = GraphQL.query("RepoIssues", {
+ *   document: "query RepoIssues($owner:String!,$name:String!){repository(owner:$owner,name:$name){issues{totalCount}}}",
+ *   variables: { owner: Schema.String, name: Schema.String },
+ *   result: Schema.Struct({
+ *     repository: Schema.NullOr(Schema.Struct({ issues: Schema.Struct({ totalCount: Schema.Int }) }))
+ *   })
+ * })
+ * const GitHubGraphQLGroup = GraphQLGroup.make(RepoIssues)
+ *
+ * class GitHub extends Context.Service<GitHub>()("app/GitHub", {
+ *   make: GraphQLClient.make(GitHubGraphQLGroup)
+ * }) {}
+ *
+ * const GitHubTest = Layer.succeed(
+ *   GitHub,
+ *   GraphQLClient.makeTest(GitHubGraphQLGroup)({
+ *     RepoIssues: ({ name }) => Effect.succeed({ repository: { issues: { totalCount: name.length } } })
+ *   })
+ * )
+ *
+ * const program = GitHub.use((github) => github.RepoIssues({ owner: "Effect-TS", name: "effect" }))
+ *
+ * await Effect.runPromise(program.pipe(Effect.provide(GitHubTest))) // => { repository: { issues: { totalCount: 6 } } }
+ * ```
+ *
+ * @stability experimental
+ * @category testing
+ * @since 4.0.0
+ */
+export declare const makeTest: <Ops extends GraphQL.Any>(group: GraphQLGroup.GraphQLGroup<Ops>) => (handlers: TestHandlers<Ops>) => GraphQLClient<Ops>;
+/**
+ * Builds a mock layer for a client service using {@link makeTest}. Bind the
+ * service and group once to expose a `layerTest(handlers)` helper on the service.
+ * The group fixes the operation types before the handlers are checked.
+ *
+ * **Example** (Binding a mock layer to a client service)
+ *
+ * ```ts import.meta.vitest
+ * import { Context, Effect, Schema } from "effect"
+ * import { GraphQL, GraphQLClient, GraphQLGroup } from "effect/graphql"
+ *
+ * const RepoIssues = GraphQL.query("RepoIssues", {
+ *   document: "query RepoIssues($owner:String!,$name:String!){repository(owner:$owner,name:$name){issues{totalCount}}}",
+ *   variables: { owner: Schema.String, name: Schema.String },
+ *   result: Schema.Struct({
+ *     repository: Schema.NullOr(Schema.Struct({ issues: Schema.Struct({ totalCount: Schema.Int }) }))
+ *   })
+ * })
+ * const GitHubGraphQLGroup = GraphQLGroup.make(RepoIssues)
+ *
+ * class GitHub extends Context.Service<GitHub>()("app/GitHub", {
+ *   make: GraphQLClient.make(GitHubGraphQLGroup)
+ * }) {
+ *   static readonly layerTest = GraphQLClient.layerTest(GitHub, GitHubGraphQLGroup)
+ * }
+ *
+ * const program = GitHub.use((github) => github.RepoIssues({ owner: "Effect-TS", name: "effect" }))
+ *
+ * await Effect.runPromise(program.pipe(Effect.provide(GitHub.layerTest({
+ *   RepoIssues: ({ name }) => Effect.succeed({ repository: { issues: { totalCount: name.length } } })
+ * })))) // => { repository: { issues: { totalCount: 6 } } }
+ * ```
+ *
+ * @see {@link makeTest} for mock behavior and the middleware-services limitation.
+ * @stability experimental
+ * @category testing
+ * @since 4.0.0
+ */
+export declare const layerTest: <I, Service, Ops extends GraphQL.Any>(service: Context.Key<I, Service>, group: GraphQLGroup.GraphQLGroup<Ops> & (GraphQLClient<Ops> extends NoInfer<Service> ? unknown : never)) => (handlers: TestHandlers<Ops>) => Layer.Layer<I>;
+export {};
+//# sourceMappingURL=GraphQLClient.d.ts.map

package/dist/graphql/GraphQLClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphQLClient.d.ts","sourceRoot":"","sources":["../../src/graphql/GraphQLClient.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,OAAO,MAAM,eAAe,CAAA;AACxC,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAA;AAC1C,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AAEtC,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAA;AAC7C,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAA;AAGjD,OAAO,KAAK,KAAK,MAAM,aAAa,CAAA;AAGpC,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAA;AAE1C,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AAGtC,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,EAEL,kBAAkB,EAClB,KAAK,YAAY,EAGlB,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAChE,OAAO,EAAmB,eAAe,EAAuB,MAAM,sBAAsB,CAAA;AAE5F;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;IAChB,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC,CAAA;CAC7C;AAED,KAAK,IAAI,CAAC,SAAS,EAAE,OAAO,IAAI,EAAE,SAAS,SAAS,GAAG,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,GAC7F,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAA;AAE7C,KAAK,eAAe,CAAC,SAAS,EAAE,OAAO,IAAI,EAAE,SAAS,SAAS,GAAG,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,GAClH,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,eAAe,CAAC,EAAE,SAAS,OAAO,CAAC,GAAG;IACrD,sCAAsC;IACtC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAA;IACtB,CAAC,EAAE,GAAG,KAAK,EACT,GAAG,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE;QAC9C,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,SAAS,CAAA;QAC5C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,KAAK,GAAG,SAAS,CAAA;QAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;QAClD,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAA;KACvB,CAAC,GACD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;IACzG,CAAC,EAAE,GAAG,KAAK,EACT,GAAG,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE;QACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,SAAS,CAAA;QAC5C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,KAAK,GAAG,SAAS,CAAA;QAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;QAClD,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;KACrC,CAAC,GACD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;CAC3F;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB,CAAC,EAAE,SAAS,OAAO,CAAC,GAAG;IACxD,sCAAsC;IACtC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAA;IACtB,CAAC,EAAE,GAAG,KAAK,EACT,GAAG,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE;QACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,SAAS,CAAA;QAC5C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,KAAK,GAAG,SAAS,CAAA;QAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;KACnD,CAAC,GACD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;CAC3F;AAED;;;;;;GAMG;AACH,MAAM,MAAM,MAAM,CAAC,EAAE,SAAS,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,SAAS,cAAc,GAAG,kBAAkB,CAAC,EAAE,CAAC,GACnG,eAAe,CAAC,EAAE,CAAC,CAAA;AAEvB;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,CAAC,GAAG,SAAS,OAAO,CAAC,GAAG,IAAI;IACnD,QAAQ,EAAE,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC;CAC/C,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,CAAC,KAAK,IAAI,aAAa,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAA;AAE5E;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB,EAAE,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,kBAAkB,CAS7F,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuFG;AACH,eAAO,MAAM,IAAI,GAAI,GAAG,SAAS,OAAO,CAAC,GAAG,SACnC,YAAY,CAAC,YAAY,CAAC,GAAG,CAAC,YAC3B;IACR,QAAQ,CAAC,iBAAiB,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAC,GAAG,SAAS,CAAA;CACxF,GAAG,SAAS,KACZ,MAAM,CAAC,MAAM,CACd,aAAa,CAAC,GAAG,CAAC,EAClB,KAAK,EACL,eAAe,GAAG,iBAAiB,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAQrE,CAAA;AA2KJ;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAA;IAC7B,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe,CAAC,IAAI,CAAE,SAAQ,UAAU;IACvD,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;CAC3C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,gBAAgB,EACvB,4FAA4F,CAAA;CAC/F;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,gBAAgB,EAAE,yFAAyF,CAAA;CACrH;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,eAAe,CAAC,SAAS,IAAI,OAAO,SAAS,MAAM,SAAS,GACpE,EAAE,SAAS,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,MAAM,SAAS,SAAS,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,GAChG,oBAAoB,GACtB,oBAAoB,GACpB,oBAAoB,CAAA;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEG;AACH,eAAO,MAAM,KAAK,GAAI,EAAE,SAAS,OAAO,CAAC,GAAG,EAAE,CAAC,SAAS,UAAU,EAAE,EAAE,GAAG,KAAK,UACpE,eAAe,CAAC,EAAE,CAAC,WAClB;IACP,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAA;IAC1D,QAAQ,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,SAAS,CAAA;IACzE,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjB,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,SAAS,CAAA;QAC5C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,KAAK,GAAG,SAAS,CAAA;QAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;KACnD,GAAG,SAAS,CAAA;CACd,KACA,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAkCvE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,eAAO,MAAM,KAAK,GAAI,EAAE,SAAS,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,GAAG,KAAK,UACpD,eAAe,CAAC,EAAE,CAAC,WAClB;IACP,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAA;IAC1D,QAAQ,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,eAAe,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,CAAA;IAC7F,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjB,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,SAAS,CAAA;QAC5C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,KAAK,GAAG,SAAS,CAAA;QAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;KACnD,GAAG,SAAS,CAAA;CACd,KACA,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CACuB,CAAA;AAElG;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,SAAS,CAAA;IAC5C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,KAAK,GAAG,SAAS,CAAA;CACjD;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,CAAC,EAAE,SAAS,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,SAAS,cAAc,GAAG,CAClF,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,EAChC,OAAO,EAAE,eAAe,KACrB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GACvD,CACA,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,EAChC,OAAO,EAAE,eAAe,KACrB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAA;AAE3D;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,CAAC,GAAG,SAAS,OAAO,CAAC,GAAG,IAAI;IAClD,QAAQ,EAAE,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,CAAC;CACrD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,eAAO,MAAM,QAAQ,GAClB,GAAG,SAAS,OAAO,CAAC,GAAG,SAAS,YAAY,CAAC,YAAY,CAAC,GAAG,CAAC,gBACpD,YAAY,CAAC,GAAG,CAAC,KAAG,aAAa,CAAC,GAAG,CAS/C,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,OAAO,EAAE,GAAG,SAAS,OAAO,CAAC,GAAG,WAClD,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,SACzB,YAAY,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC,gBAE9F,YAAY,CAAC,GAAG,CAAC,KAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAE6B,CAAA"}