effect 4.0.2 → 4.0.4

package/dist/graphql/GraphQLClientError.js

@@ -0,0 +1,479 @@
+/**
+ * Serializable GraphQL client errors with an operation name and a
+ * `Schema.TaggedError` reason.
+ *
+ * @stability experimental
+ * @since 4.0.0
+ */
+import * as Duration from "../Duration.js";
+import { HeadersSchema } from "../internal/graphqlHeaders.js";
+import { hasProperty } from "../Predicate.js";
+import * as Schema from "../Schema.js";
+const TypeId = "~effect/graphql/GraphQLClientError";
+/**
+ * One entry of a GraphQL response's `errors` array, as described by the
+ * GraphQL specification.
+ *
+ * **Details**
+ *
+ * `path[0]` is the response key the error belongs to, which is the alias when
+ * the document used one, so callers can match an error to the field it hit.
+ * Unknown top-level fields are preserved as JSON values, including GitHub's
+ * `type` field.
+ *
+ * **Example** (Finding which alias an error belongs to)
+ *
+ * ```ts import.meta.vitest
+ * import { Schema } from "effect"
+ * import { GraphQLClientError } from "effect/graphql"
+ *
+ * const error = Schema.decodeUnknownSync(GraphQLClientError.GraphQLError)({
+ *   message: "Could not resolve to a Repository",
+ *   path: ["missing", "issues"],
+ *   type: "NOT_FOUND"
+ * })
+ *
+ * error.path?.[0] // => "missing"
+ * ```
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export const GraphQLError = /*#__PURE__*/Schema.StructWithRest(/*#__PURE__*/Schema.Struct({
+  message: Schema.String,
+  locations: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Array(/*#__PURE__*/Schema.Struct({
+    line: Schema.Number,
+    column: Schema.Number
+  }))),
+  path: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Array(/*#__PURE__*/Schema.Union([Schema.String, Schema.Number]))),
+  extensions: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Record(Schema.String, Schema.Json))
+}), [/*#__PURE__*/Schema.Record(Schema.String, Schema.Json)]);
+/**
+ * The server answered with a non-empty `errors` array.
+ *
+ * **Details**
+ *
+ * Queries and mutations fail even when partial `data` is present, since a
+ * field error's `null` cannot be distinguished from a genuine `null`. Use
+ * `{ partial: true }` to receive decoded `{ data, errors }` instead.
+ *
+ * On this error, `data` is raw. `GraphQLError.path[0]` identifies the response
+ * key (or alias). Non-2xx HTTP responses with a GraphQL body also use this
+ * reason rather than `TransportError`.
+ *
+ * `status` and `headers` are the HTTP status and response headers, as the
+ * transport reported them and middleware left them. Headers use
+ * `Headers.Headers` at runtime and encode as a plain string record.
+ * Decoding restores the normalized header collection. Both are unset over
+ * graphql-ws, and `status` is unset for graphql-sse events. `retryAfter`
+ * parses the `Retry-After` response header as whole seconds or an HTTP date,
+ * measured from `Date.now()` when the error is constructed. `isRetryable` is
+ * true for HTTP status `429` or `500`–`599`, and for any response with a
+ * valid `Retry-After`, whatever its status. It is false otherwise, including
+ * when there is no status.
+ *
+ * For queries and mutations, callers opt into retries with `Effect.retry`,
+ * and should wait for `retryAfter` when it is set. With
+ * `GraphQLClient.pages`, retry each page's call, not the stream:
+ * `Stream.retry` starts again from the first page. Subscriptions retry a
+ * retryable `ResponseError` on their own, by resubscribing. graphql-sse events
+ * carry the stream response's headers, so an event with `errors` is retried
+ * when that response had a valid `Retry-After`, and ends the stream
+ * otherwise.
+ *
+ * **Example** (Inspecting the errors of a failed call)
+ *
+ * ```ts import.meta.vitest
+ * import { GraphQLClientError } from "effect/graphql"
+ *
+ * const reason = new GraphQLClientError.ResponseError({
+ *   errors: [{ message: "Not found", path: ["repository"] }],
+ *   data: { repository: null },
+ *   status: 200
+ * })
+ *
+ * reason.isRetryable // => false
+ * reason.status // => 200
+ * reason.errors.map((error) => error.path?.[0]) // => ["repository"]
+ * ```
+ *
+ * **Example** (Retrying a call on retryable errors)
+ *
+ * ```ts import.meta.vitest
+ * import { Effect } from "effect"
+ * import { GraphQLClientError } from "effect/graphql"
+ *
+ * const call = Effect.fail(new GraphQLClientError.GraphQLClientError({
+ *   operation: "Viewer",
+ *   reason: new GraphQLClientError.ResponseError({
+ *     errors: [{ message: "Query timed out" }],
+ *     status: 502
+ *   })
+ * }))
+ *
+ * const retried = Effect.retry(call, {
+ *   while: (error) => error.reason.isRetryable,
+ *   times: 3
+ * })
+ * ```
+ *
+ * @stability experimental
+ * @category errors
+ * @since 4.0.0
+ */
+export class ResponseError extends /*#__PURE__*/Schema.TaggedError("effect/graphql/GraphQLClientError/ResponseError")("ResponseError", {
+  errors: /*#__PURE__*/Schema.NonEmptyArray(GraphQLError),
+  data: /*#__PURE__*/Schema.optional(Schema.Json),
+  extensions: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Record(Schema.String, Schema.Json)),
+  status: /*#__PURE__*/Schema.optional(Schema.Int),
+  headers: /*#__PURE__*/Schema.optional(HeadersSchema)
+}) {
+  /**
+   * `true` for HTTP status `429` or `500`–`599`, or when the response has a
+   * `Retry-After` header that parses, at any status, including a graphql-sse
+   * event whose stream response had one; `false` otherwise, including when
+   * there is no status and no `Retry-After`. Use this as the `while` predicate
+   * of `Effect.retry` on the call, and {@link retryAfter} as the delay when it
+   * is set. Subscriptions resubscribe on it.
+   *
+   * @since 4.0.0
+   */
+  get isRetryable() {
+    if (this.retryAfter !== undefined) return true;
+    return this.status !== undefined && isRetryableStatus(this.status);
+  }
+  #retryAfter = /*#__PURE__*/parseRetryAfter(this.headers?.["retry-after"], /*#__PURE__*/Date.now());
+  /**
+   * The `Retry-After` response header parsed as whole seconds or an HTTP
+   * date. An HTTP date is measured from `Date.now()` when the error is
+   * constructed, so every read returns the same delay. Missing or invalid
+   * values yield `undefined`. `Effect.retry` does not apply this delay
+   * automatically.
+   *
+   * @since 4.0.0
+   */
+  get retryAfter() {
+    return this.#retryAfter;
+  }
+  get message() {
+    return this.errors.map(error => error.message).join("; ");
+  }
+}
+const retryableStandardCloseCodes = /*#__PURE__*/new Set([1000, 1001, 1005, 1006, 1012, 1013, 1014]);
+const fatalGraphQLWsCloseCodes = /*#__PURE__*/new Set([4400, 4401, 4403, 4406, 4409, 4429, 4500]);
+/**
+ * Tests whether a WebSocket close code is fatal, meaning a `TransportError`
+ * carrying it is not retryable.
+ *
+ * **Details**
+ *
+ * Fatal codes are every standard `1xxx` code except `1000`, `1001`, `1005`,
+ * `1006`, `1012`, `1013` and `1014`, plus the graphql-ws codes `4400` (bad
+ * request), `4401` (unauthorized), `4403` (forbidden), `4406` (subprotocol
+ * not acceptable), `4409` (subscriber already exists), `4429` (too many
+ * initialisation requests) and `4500` (internal server error). Any other code
+ * is retryable.
+ *
+ * `4403` is fatal because reconnecting with the same credentials is refused
+ * again.
+ *
+ * **Example** (Checking close codes)
+ *
+ * ```ts import.meta.vitest
+ * import { GraphQLClientError } from "effect/graphql"
+ *
+ * GraphQLClientError.isFatalCloseCode(1006) // => false
+ * GraphQLClientError.isFatalCloseCode(1011) // => true
+ * GraphQLClientError.isFatalCloseCode(4401) // => true
+ * ```
+ *
+ * @stability experimental
+ * @category predicates
+ * @since 4.0.0
+ */
+export const isFatalCloseCode = code => code >= 1000 && code < 2000 ? !retryableStandardCloseCodes.has(code) : fatalGraphQLWsCloseCodes.has(code);
+const isRetryableStatus = status => status === 429 || status >= 500 && status < 600;
+/**
+ * Parses a `Retry-After` header value, either whole seconds or an HTTP date,
+ * into a `Duration` measured from `now` (epoch milliseconds). Anything else,
+ * such as `1.5` or `-1`, yields `undefined`.
+ */
+const parseRetryAfter = (value, now) => {
+  if (value === undefined) return undefined;
+  const trimmed = value.trim();
+  if (/^\d+$/.test(trimmed)) {
+    return Duration.seconds(Number(trimmed));
+  }
+  // Every HTTP date names a day or month; `Date.parse` alone also accepts
+  // bare numbers such as `1.5` or `-1`.
+  if (!/[a-z]/i.test(trimmed)) return undefined;
+  const date = Date.parse(trimmed);
+  if (Number.isNaN(date)) return undefined;
+  return Duration.millis(Math.max(0, date - now));
+};
+/**
+ * The client could not get a GraphQL response from the server: a network
+ * failure, an HTTP response that is not a GraphQL response, or a closed
+ * WebSocket connection.
+ *
+ * **Details**
+ *
+ * - `status` and `headers` are only set for an HTTP response that is not a
+ *   GraphQL response. Headers use `Headers.Headers` at runtime and encode
+ *   as a plain string record; decoding restores the header collection.
+ * - `retryAfter` comes from the `Retry-After` header (whole seconds or an
+ *   HTTP date) and is encoded as milliseconds. When it is set, the error is
+ *   retryable at any status, unless the close code is fatal.
+ * - `closeCode` is set when a WebSocket connection closed. See
+ *   {@link isFatalCloseCode} for the codes that are not retryable.
+ * - `fatal: true` marks a failure that retrying cannot fix, such as an
+ *   operation on a graphql-ws transport whose scope has closed.
+ * - `cause` holds the original error, such as the `HttpClientError`. Once
+ *   encoded it shrinks to `{ name, message }`, the standard `Schema.Defect`
+ *   behaviour.
+ *
+ * **Example** (Retryability of transport failures)
+ *
+ * ```ts import.meta.vitest
+ * import { GraphQLClientError } from "effect/graphql"
+ *
+ * new GraphQLClientError.TransportError({ description: "ECONNREFUSED" }).isRetryable // => true
+ * new GraphQLClientError.TransportError({ description: "503", status: 503 }).isRetryable // => true
+ * new GraphQLClientError.TransportError({ description: "404", status: 404 }).isRetryable // => false
+ * new GraphQLClientError.TransportError({ description: "closed", closeCode: 4401 }).isRetryable // => false
+ * new GraphQLClientError.TransportError({ description: "shut down", fatal: true }).isRetryable // => false
+ * ```
+ *
+ * @stability experimental
+ * @category errors
+ * @since 4.0.0
+ */
+export class TransportError extends /*#__PURE__*/Schema.TaggedError("effect/graphql/GraphQLClientError/TransportError")("TransportError", {
+  description: Schema.String,
+  status: /*#__PURE__*/Schema.optional(Schema.Int),
+  headers: /*#__PURE__*/Schema.optional(HeadersSchema),
+  retryAfter: /*#__PURE__*/Schema.optional(Schema.DurationFromMillis),
+  closeCode: /*#__PURE__*/Schema.optional(Schema.Int),
+  fatal: /*#__PURE__*/Schema.optional(Schema.Boolean),
+  cause: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Defect())
+}) {
+  /**
+   * `true` for a network failure (no `status`), a `429` or `500`–`599`
+   * status, a `retryAfter` at any status, and any close code that is not
+   * fatal (see {@link isFatalCloseCode}). An error marked `fatal` or with a
+   * fatal close code is never retryable. When retrying, wait for
+   * `retryAfter` when it is set.
+   *
+   * @since 4.0.0
+   */
+  get isRetryable() {
+    if (this.fatal === true) return false;
+    if (this.closeCode !== undefined && isFatalCloseCode(this.closeCode)) return false;
+    if (this.retryAfter !== undefined) return true;
+    return this.status === undefined || isRetryableStatus(this.status);
+  }
+  get message() {
+    return this.description;
+  }
+  /**
+   * Converts an `HttpClientError` into a `TransportError`, reading `status`,
+   * `headers` (as `Headers.Headers`) and `Retry-After` from the response
+   * when there is one.
+   *
+   * **Details**
+   *
+   * `Retry-After` is read as whole seconds or an HTTP date; any other value
+   * is ignored. An HTTP date is measured from `options.now` (epoch
+   * milliseconds), which defaults to `Date.now()`. Transports pass the Effect
+   * clock's time when the response arrives.
+   *
+   * @since 4.0.0
+   */
+  static fromHttpClientError(error, options) {
+    const response = error.response;
+    return new TransportError({
+      description: error.message,
+      status: response?.status,
+      headers: response?.headers,
+      retryAfter: parseRetryAfter(response?.headers["retry-after"], options?.now ?? Date.now()),
+      cause: error
+    });
+  }
+}
+/**
+ * The variables Schema rejected the input, so nothing was sent.
+ *
+ * @stability experimental
+ * @category errors
+ * @since 4.0.0
+ */
+export class EncodeError extends /*#__PURE__*/Schema.TaggedError("effect/graphql/GraphQLClientError/EncodeError")("EncodeError", {
+  description: Schema.String
+}) {
+  /**
+   * An `EncodeError` is never retryable.
+   *
+   * @since 4.0.0
+   */
+  get isRetryable() {
+    return false;
+  }
+  get message() {
+    return this.description;
+  }
+}
+/**
+ * The response was not a GraphQL response, or `data` did not match the result
+ * Schema.
+ *
+ * **Details**
+ *
+ * `data: null` without `errors` also produces a `DecodeError`, since
+ * `ResponseError` requires a non-empty errors array.
+ *
+ * @stability experimental
+ * @category errors
+ * @since 4.0.0
+ */
+export class DecodeError extends /*#__PURE__*/Schema.TaggedError("effect/graphql/GraphQLClientError/DecodeError")("DecodeError", {
+  description: Schema.String
+}) {
+  /**
+   * A `DecodeError` is never retryable.
+   *
+   * @since 4.0.0
+   */
+  get isRetryable() {
+    return false;
+  }
+  get message() {
+    return this.description;
+  }
+}
+/**
+ * Cursor paging could not continue. Only `GraphQLClient.pages` and
+ * `GraphQLClient.items` raise it, when a connection becomes `null` on a page
+ * after the first, or when `hasNextPage` is `true` but `endCursor` is `null`
+ * or did not advance.
+ *
+ * **Details**
+ *
+ * `cursor` is the last cursor that was sent, `null` on the first page.
+ *
+ * @stability experimental
+ * @category errors
+ * @since 4.0.0
+ */
+export class PaginationError extends /*#__PURE__*/Schema.TaggedError("effect/graphql/GraphQLClientError/PaginationError")("PaginationError", {
+  description: Schema.String,
+  cursor: /*#__PURE__*/Schema.NullOr(Schema.String)
+}) {
+  /**
+   * A `PaginationError` is never retryable.
+   *
+   * @since 4.0.0
+   */
+  get isRetryable() {
+    return false;
+  }
+  get message() {
+    return this.description;
+  }
+}
+const httpReason = reason => reason._tag === "ResponseError" || reason._tag === "TransportError" ? reason : undefined;
+/**
+ * The error every `GraphQLClient` method fails with. It names the operation
+ * and carries one of the five reasons; `cause` is the reason itself.
+ *
+ * **Example** (Retrying only what is retryable)
+ *
+ * ```ts import.meta.vitest
+ * import { Duration, Schema } from "effect"
+ * import { GraphQLClientError } from "effect/graphql"
+ *
+ * const error = new GraphQLClientError.GraphQLClientError({
+ *   operation: "Viewer",
+ *   reason: new GraphQLClientError.TransportError({
+ *     description: "503 Service Unavailable",
+ *     status: 503,
+ *     retryAfter: Duration.seconds(30)
+ *   })
+ * })
+ *
+ * error.isRetryable // => true
+ * error.retryAfter // => Duration.seconds(30)
+ *
+ * // Errors round-trip through their Schema
+ * const encoded = Schema.encodeSync(GraphQLClientError.GraphQLClientError)(error)
+ * Schema.decodeUnknownSync(GraphQLClientError.GraphQLClientError)(encoded).reason._tag // => "TransportError"
+ * ```
+ *
+ * @stability experimental
+ * @category errors
+ * @since 4.0.0
+ */
+export class GraphQLClientError extends /*#__PURE__*/Schema.TaggedError(TypeId)("GraphQLClientError", {
+  operation: Schema.String,
+  reason: /*#__PURE__*/Schema.Union([ResponseError, TransportError, EncodeError, DecodeError, PaginationError])
+}) {
+  /**
+   * Marks this value as a GraphQL client error for runtime guards.
+   *
+   * @stability experimental
+   * @since 4.0.0
+   */
+  [TypeId] = TypeId;
+  /**
+   * The reason, exposed as the error's cause.
+   *
+   * @since 4.0.0
+   */
+  cause = this.reason;
+  /**
+   * Delegates to the reason's `isRetryable`.
+   *
+   * @since 4.0.0
+   */
+  get isRetryable() {
+    return this.reason.isRetryable;
+  }
+  /**
+   * The `Retry-After` hint of a `ResponseError` or `TransportError` reason,
+   * if any. Use it as the delay when retrying on {@link isRetryable}.
+   *
+   * @since 4.0.0
+   */
+  get retryAfter() {
+    return httpReason(this.reason)?.retryAfter;
+  }
+  /**
+   * The HTTP status of a `ResponseError` or `TransportError` reason, if any.
+   *
+   * @since 4.0.0
+   */
+  get status() {
+    return httpReason(this.reason)?.status;
+  }
+  /**
+   * The response headers of a `ResponseError` or `TransportError` reason, if
+   * any.
+   *
+   * @since 4.0.0
+   */
+  get headers() {
+    return httpReason(this.reason)?.headers;
+  }
+  get message() {
+    return `${this.operation}: ${this.reason._tag}: ${this.reason.message}`;
+  }
+}
+/**
+ * Tests whether a value is a {@link GraphQLClientError}.
+ *
+ * @stability experimental
+ * @category guards
+ * @since 4.0.0
+ */
+export const isGraphQLClientError = u => hasProperty(u, TypeId);
+//# sourceMappingURL=GraphQLClientError.js.map

package/dist/graphql/GraphQLClientError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphQLClientError.js","names":[],"sources":["../../src/graphql/GraphQLClientError.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;AAOA,OAAO,KAAK,QAAQ,MAAM,gBAAgB;AAG1C,SAAS,aAAa,QAAQ,+BAA+B;AAC7D,SAAS,WAAW,QAAQ,iBAAiB;AAC7C,OAAO,KAAK,MAAM,MAAM,cAAc;AAEtC,MAAM,MAAM,GAAG,oCAAoC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,OAAO,MAAM,YAAY,gBAAG,MAAM,CAAC,cAAc,cAC/C,MAAM,CAAC,MAAM,CAAC;EACZ,OAAO,EAAE,MAAM,CAAC,MAAM;EACtB,SAAS,eAAE,MAAM,CAAC,QAAQ,cAAC,MAAM,CAAC,KAAK,cAAC,MAAM,CAAC,MAAM,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC,MAAM;IAAE,MAAM,EAAE,MAAM,CAAC;EAAM,CAAE,CAAC,CAAC,CAAC;EACvG,IAAI,eAAE,MAAM,CAAC,QAAQ,cAAC,MAAM,CAAC,KAAK,cAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;EACjF,UAAU,eAAE,MAAM,CAAC,QAAQ,cAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC;CACtE,CAAC,EACF,cAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAC5C;AAWD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyEA,OAAM,MAAO,aACX,sBAAQ,MAAM,CAAC,WAAW,CAAgB,iDAAiD,CAAC,CAAC,eAAe,EAAE;EAC5G,MAAM,eAAE,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;EAC1C,IAAI,eAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;EAClC,UAAU,eAAE,MAAM,CAAC,QAAQ,cAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;EACtE,MAAM,eAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC;EACnC,OAAO,eAAE,MAAM,CAAC,QAAQ,CAAC,aAAa;CACvC,CAAC;EAEF;;;;;;;;;;EAUA,IAAI,WAAW;IACb,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,OAAO,IAAI;IAC9C,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC;EACpE;EAES,WAAW,gBAAG,eAAe,CAAC,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC,eAAE,IAAI,CAAC,GAAG,EAAE,CAAC;EAEjF;;;;;;;;;EASA,IAAI,UAAU;IACZ,OAAO,IAAI,CAAC,WAAW;EACzB;EAEA,IAAa,OAAO;IAClB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAE,KAAK,IAAK,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;EAC7D;;AAGF,MAAM,2BAA2B,gBAAwB,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAE5G,MAAM,wBAAwB,gBAAwB,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAEzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,OAAO,MAAM,gBAAgB,GAAI,IAAY,IAC3C,IAAI,IAAI,IAAI,IAAI,IAAI,GAAG,IAAI,GAAG,CAAC,2BAA2B,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,GAAG,CAAC,IAAI,CAAC;AAE3G,MAAM,iBAAiB,GAAI,MAAc,IAAc,MAAM,KAAK,GAAG,IAAK,MAAM,IAAI,GAAG,IAAI,MAAM,GAAG,GAAI;AAExG;;;;;AAKA,MAAM,eAAe,GAAG,CAAC,KAAyB,EAAE,GAAW,KAAmC;EAChG,IAAI,KAAK,KAAK,SAAS,EAAE,OAAO,SAAS;EACzC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE;EAC5B,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;IACzB,OAAO,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;EAC1C;EACA;EACA;EACA,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,SAAS;EAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;EAChC,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,SAAS;EACxC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,GAAG,GAAG,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCA,OAAM,MAAO,cACX,sBAAQ,MAAM,CAAC,WAAW,CAAiB,kDAAkD,CAAC,CAAC,gBAAgB,EAAE;EAC/G,WAAW,EAAE,MAAM,CAAC,MAAM;EAC1B,MAAM,eAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC;EACnC,OAAO,eAAE,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC;EACvC,UAAU,eAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,kBAAkB,CAAC;EACtD,SAAS,eAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC;EACtC,KAAK,eAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC;EACtC,KAAK,eAAE,MAAM,CAAC,QAAQ,cAAC,MAAM,CAAC,MAAM,EAAE;CACvC,CAAC;EAEF;;;;;;;;;EASA,IAAI,WAAW;IACb,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE,OAAO,KAAK;IACrC,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,KAAK;IAClF,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,OAAO,IAAI;IAC9C,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC;EACpE;EAEA,IAAa,OAAO;IAClB,OAAO,IAAI,CAAC,WAAW;EACzB;EAEA;;;;;;;;;;;;;;EAcA,OAAO,mBAAmB,CACxB,KAAsC,EACtC,OAA+C;IAE/C,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ;IAC/B,OAAO,IAAI,cAAc,CAAC;MACxB,WAAW,EAAE,KAAK,CAAC,OAAO;MAC1B,MAAM,EAAE,QAAQ,EAAE,MAAM;MACxB,OAAO,EAAE,QAAQ,EAAE,OAAO;MAC1B,UAAU,EAAE,eAAe,CAAC,QAAQ,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;MACzF,KAAK,EAAE;KACR,CAAC;EACJ;;AAGF;;;;;;;AAOA,OAAM,MAAO,WACX,sBAAQ,MAAM,CAAC,WAAW,CAAc,+CAA+C,CAAC,CAAC,aAAa,EAAE;EACtG,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;EAEF;;;;;EAKA,IAAI,WAAW;IACb,OAAO,KAAK;EACd;EAEA,IAAa,OAAO;IAClB,OAAO,IAAI,CAAC,WAAW;EACzB;;AAGF;;;;;;;;;;;;;AAaA,OAAM,MAAO,WACX,sBAAQ,MAAM,CAAC,WAAW,CAAc,+CAA+C,CAAC,CAAC,aAAa,EAAE;EACtG,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;EAEF;;;;;EAKA,IAAI,WAAW;IACb,OAAO,KAAK;EACd;EAEA,IAAa,OAAO;IAClB,OAAO,IAAI,CAAC,WAAW;EACzB;;AAGF;;;;;;;;;;;;;;AAcA,OAAM,MAAO,eACX,sBAAQ,MAAM,CAAC,WAAW,CAAkB,mDAAmD,CAAC,CAAC,iBAAiB,EAAE;EAClH,WAAW,EAAE,MAAM,CAAC,MAAM;EAC1B,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM;CACpC,CAAC;EAEF;;;;;EAKA,IAAI,WAAW;IACb,OAAO,KAAK;EACd;EAEA,IAAa,OAAO;IAClB,OAAO,IAAI,CAAC,WAAW;EACzB;;AAYF,MAAM,UAAU,GAAI,MAAc,IAChC,MAAM,CAAC,IAAI,KAAK,eAAe,IAAI,MAAM,CAAC,IAAI,KAAK,gBAAgB,GAAG,MAAM,GAAG,SAAS;AAE1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,OAAM,MAAO,kBAAmB,sBAAQ,MAAM,CAAC,WAAW,CAAqB,MAAM,CAAC,CAAC,oBAAoB,EAAE;EAC3G,SAAS,EAAE,MAAM,CAAC,MAAM;EACxB,MAAM,eAAE,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,eAAe,CAAC;CAChG,CAAC;EACA;;;;;;EAMS,CAAC,MAAM,IAAI,MAAM;EAE1B;;;;;EAKkB,KAAK,GAAG,IAAI,CAAC,MAAM;EAErC;;;;;EAKA,IAAI,WAAW;IACb,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW;EAChC;EAEA;;;;;;EAMA,IAAI,UAAU;IACZ,OAAO,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,UAAU;EAC5C;EAEA;;;;;EAKA,IAAI,MAAM;IACR,OAAO,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM;EACxC;EAEA;;;;;;EAMA,IAAI,OAAO;IACT,OAAO,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO;EACzC;EAEA,IAAa,OAAO;IAClB,OAAO,GAAG,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;EACzE;;AAGF;;;;;;;AAOA,OAAO,MAAM,oBAAoB,GAAI,CAAU,IAA8B,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC","ignoreList":[]}

package/dist/graphql/GraphQLGroup.d.ts

@@ -0,0 +1,118 @@
+/**
+ * Groups of GraphQL operations, merged to build a client. Group middleware
+ * runs outside operation middleware. `@effect/graphql-generator` emits one
+ * group per document file.
+ *
+ * @stability experimental
+ * @since 4.0.0
+ */
+import { type Pipeable } from "../Pipeable.ts";
+import type * as GraphQL from "./GraphQL.ts";
+import type * as GraphQLMiddleware from "./GraphQLMiddleware.ts";
+declare const TypeId = "~effect/graphql/GraphQLGroup";
+/**
+ * A set of operations plus the middleware attached at the group level.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface GraphQLGroup<out Ops extends GraphQL.Any> extends Pipeable {
+    readonly [TypeId]: typeof TypeId;
+    readonly operations: ReadonlyArray<Ops>;
+    /** Middleware attached to the group, outermost first. */
+    readonly middlewares: ReadonlyArray<GraphQLMiddleware.AnyService>;
+    /**
+     * Attaches a middleware to every operation in the group. Group middleware
+     * runs outside operation middleware; several group middleware run in the
+     * order attached.
+     */
+    middleware<M extends GraphQLMiddleware.AnyService>(middleware: M): GraphQLGroup<GraphQL.AddMiddleware<Ops, M>>;
+}
+/**
+ * Any group, with its operations erased.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export type Any = GraphQLGroup<GraphQL.Any>;
+/**
+ * Extracts the union of operations in a group.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export type Operations<G> = G extends GraphQLGroup<infer Ops> ? Ops : never;
+/**
+ * Tests whether a value is a {@link GraphQLGroup}.
+ *
+ * @stability experimental
+ * @category guards
+ * @since 4.0.0
+ */
+export declare const isGraphQLGroup: (u: unknown) => u is Any;
+/**
+ * Builds a group from operations. Operation names must be unique within a
+ * group, because they become the client's method names.
+ *
+ * **Example** (One group per `.graphql` file)
+ *
+ * ```ts import.meta.vitest
+ * import { Schema } from "effect"
+ * import { GraphQL, GraphQLGroup } from "effect/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)
+ *
+ * ViewerGraphQLGroup.operations.map((op) => op.name) // => ["Viewer"]
+ * ```
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const make: <const Ops extends ReadonlyArray<GraphQL.Any>>(...operations: Ops) => GraphQLGroup<Ops[number]>;
+/**
+ * Merges groups into one. Middleware attached to a source group stays
+ * attached to that group's operations; middleware attached to the merged
+ * group afterwards runs outside all of it.
+ *
+ * **Example** (Auth on one file, logging on everything)
+ *
+ * ```ts import.meta.vitest
+ * import { Schema } from "effect"
+ * import { GraphQL, GraphQLGroup, GraphQLMiddleware } from "effect/graphql"
+ *
+ * class Auth extends GraphQLMiddleware.Service<Auth>()("app/Auth") {}
+ * class Logging extends GraphQLMiddleware.Service<Logging>()("app/Logging") {}
+ *
+ * const Viewer = GraphQL.query("Viewer", {
+ *   document: "query Viewer{viewer{login}}",
+ *   result: Schema.Struct({ viewer: Schema.Struct({ login: Schema.String }) })
+ * })
+ * const Rate = GraphQL.query("Rate", {
+ *   document: "query Rate{rateLimit{remaining}}",
+ *   result: Schema.Struct({ rateLimit: Schema.Struct({ remaining: Schema.Int }) })
+ * })
+ *
+ * const all = GraphQLGroup.merge(GraphQLGroup.make(Viewer).middleware(Auth), GraphQLGroup.make(Rate))
+ *   .middleware(Logging)
+ *
+ * all.operations.map((op) => op.name) // => ["Viewer", "Rate"]
+ * all.middlewares.map((m) => m.key) // => ["app/Logging"]
+ * all.operations[0].middlewares.map((m) => m.key) // => ["app/Auth"]
+ * ```
+ *
+ * @stability experimental
+ * @category combinators
+ * @since 4.0.0
+ */
+export declare const merge: <const Groups extends ReadonlyArray<Any>>(...groups: Groups) => GraphQLGroup<Operations<Groups[number]>>;
+export {};
+//# sourceMappingURL=GraphQLGroup.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"GraphQLGroup.d.ts","sourceRoot":"","sources":["../../src/graphql/GraphQLGroup.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,gBAAgB,CAAA;AAE7D,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAEhE,QAAA,MAAM,MAAM,iCAAiC,CAAA;AAE7C;;;;;;GAMG;AACH,MAAM,WAAW,YAAY,CAAC,GAAG,CAAC,GAAG,SAAS,OAAO,CAAC,GAAG,CAAE,SAAQ,QAAQ;IACzE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,CAAC,CAAA;IACvC,yDAAyD;IACzD,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAA;IACjE;;;;OAIG;IACH,UAAU,CAAC,CAAC,SAAS,iBAAiB,CAAC,UAAU,EAAE,UAAU,EAAE,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAA;CAC/G;AAED;;;;;;GAMG;AACH,MAAM,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;AAE3C;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,YAAY,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAA;AAE3E;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,MAAO,OAAO,KAAG,CAAC,IAAI,GAA6B,CAAA;AA8B9E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,IAAI,GAAI,KAAK,CAAC,GAAG,SAAS,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,KAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CACxD,CAAA;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,KAAK,GAAI,KAAK,CAAC,MAAM,SAAS,aAAa,CAAC,GAAG,CAAC,aAChD,MAAM,KAChB,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAYK,CAAA"}