effect 4.0.3 → 4.0.4

package/dist/graphql/GraphQLGroup.js

@@ -0,0 +1,109 @@
+/**
+ * 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 { pipeArguments } from "../Pipeable.js";
+import { hasProperty } from "../Predicate.js";
+const TypeId = "~effect/graphql/GraphQLGroup";
+/**
+ * Tests whether a value is a {@link GraphQLGroup}.
+ *
+ * @stability experimental
+ * @category guards
+ * @since 4.0.0
+ */
+export const isGraphQLGroup = u => hasProperty(u, TypeId);
+const Proto = {
+  [TypeId]: TypeId,
+  pipe() {
+    return pipeArguments(this, arguments);
+  },
+  middleware(middleware) {
+    return makeProto(this.operations, [...this.middlewares, middleware]);
+  }
+};
+// The operation and middleware types of a group are phantom: at runtime a
+// group holds erased `GraphQL.Any` operations and `AnyService` tags, so the
+// typed constructors below state their group type with one assertion each.
+const makeProto = (operations, middlewares) => {
+  const byName = new Map();
+  for (const operation of operations) {
+    const existing = byName.get(operation.name);
+    if (existing !== undefined && existing !== operation) {
+      throw new Error(`GraphQLGroup: duplicate operation name "${operation.name}"`);
+    }
+    byName.set(operation.name, operation);
+  }
+  return Object.assign(Object.create(Proto), {
+    operations: Array.from(byName.values()),
+    middlewares
+  });
+};
+/**
+ * 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 const make = (...operations) => makeProto(operations, []);
+/**
+ * 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 const merge = (...groups) => makeProto(groups.flatMap(group => group.middlewares.length === 0 ? group.operations : group.operations.map(operation => Object.assign(Object.create(Object.getPrototypeOf(operation)), operation, {
+  middlewares: [...group.middlewares, ...operation.middlewares]
+}))), []);
+//# sourceMappingURL=GraphQLGroup.js.map

package/dist/graphql/GraphQLGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphQLGroup.js","names":[],"sources":["../../src/graphql/GraphQLGroup.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;AAQA,SAAwB,aAAa,QAAQ,gBAAgB;AAC7D,SAAS,WAAW,QAAQ,iBAAiB;AAI7C,MAAM,MAAM,GAAG,8BAA8B;AAwC7C;;;;;;;AAOA,OAAO,MAAM,cAAc,GAAI,CAAU,IAAe,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC;AAE9E,MAAM,KAAK,GAAG;EACZ,CAAC,MAAM,GAAG,MAAM;EAChB,IAAI;IACF,OAAO,aAAa,CAAC,IAAI,EAAE,SAAS,CAAC;EACvC,CAAC;EACD,UAAU,CAAY,UAAwC;IAC5D,OAAO,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;EACtE;CACD;AAED;AACA;AACA;AACA,MAAM,SAAS,GAAG,CAChB,UAAsC,EACtC,WAAwD,KACjD;EACP,MAAM,MAAM,GAAG,IAAI,GAAG,EAAuB;EAC7C,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;IAClC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC;IAC3C,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,EAAE;MACpD,MAAM,IAAI,KAAK,CAAC,2CAA2C,SAAS,CAAC,IAAI,GAAG,CAAC;IAC/E;IACA,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC;EACvC;EACA,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;IAAE,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IAAE;EAAW,CAAE,CAAC;AACtG,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,OAAO,MAAM,IAAI,GAAG,CAA+C,GAAG,UAAe,KACnF,SAAS,CAAC,UAAU,EAAE,EAAE,CAA8B;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCA,OAAO,MAAM,KAAK,GAAG,CACnB,GAAG,MAAc,KAEjB,SAAS,CACP,MAAM,CAAC,OAAO,CAAE,KAAK,IACnB,KAAK,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,GAC1B,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,CAAC,GAAG,CAAE,SAAS,IAC/B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,EAAE;EACxE,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC,WAAW,EAAE,GAAG,SAAS,CAAC,WAAW;CAC7D,CAAC,CACH,CACJ,EACD,EAAE,CACyC","ignoreList":[]}

package/dist/graphql/GraphQLMiddleware.d.ts

@@ -0,0 +1,249 @@
+/**
+ * GraphQL-level middleware provided as `Context.Service` implementations.
+ * Middleware can rewrite requests and inspect raw results, including response
+ * extensions and HTTP headers. Provide implementations with `Layer.succeed`
+ * or `Layer.effect`.
+ *
+ * @stability experimental
+ * @since 4.0.0
+ */
+import * as Context from "../Context.ts";
+import * as Effect from "../Effect.ts";
+import * as Stream from "../Stream.ts";
+import type * as Types from "../Types.ts";
+import type * as GraphQL from "./GraphQL.ts";
+import type { GraphQLClientError } from "./GraphQLClientError.ts";
+import type { ExecutionResult, GraphQLRequest } from "./GraphQLProtocol.ts";
+declare const TypeId = "~effect/graphql/GraphQLMiddleware";
+/**
+ * Middleware handlers for queries, mutations and subscriptions. Both
+ * `execute` and `subscribe` are required.
+ *
+ * **Details**
+ *
+ * `execute` runs once per query or mutation. `subscribe` runs once per
+ * subscription attempt (the client re-runs the whole chain when it retries a
+ * subscription) and can map or tap the event stream.
+ *
+ * Both receive the operation being run, the request so far, and `next`, which
+ * runs the rest of the chain with the given request and returns the raw
+ * `ExecutionResult` (or, for `subscribe`, the stream of them). Its `status`
+ * and `headers` are the HTTP status and response headers the transport
+ * reported, if any; a middleware may rewrite them, and a failed call's
+ * `ResponseError` carries the final values. Request and response headers
+ * are `Headers.Headers` values; use `Headers.set` to rewrite them.
+ *
+ * `next` fails with `GraphQLClientError`, or with the error of a middleware
+ * further in, which is typed as `Types.unhandled`, as in `RpcMiddleware`.
+ * Narrow it, for example with `Effect.catchTag("GraphQLClientError", ...)`,
+ * before reading `reason`.
+ *
+ * Use {@link mapRequest} when the middleware only needs to transform the
+ * request.
+ *
+ * **Example** (Reading a rate-limit header)
+ *
+ * ```ts import.meta.vitest
+ * import { Effect } from "effect"
+ * import { GraphQLMiddleware } from "effect/graphql"
+ * import { Headers } from "effect/http"
+ *
+ * const rateLimit: GraphQLMiddleware.Implementation = {
+ *   execute: ({ next, request }) =>
+ *     Effect.tap(next(request), (result) =>
+ *       Effect.log(result.headers === undefined ? undefined : Headers.get(result.headers, "x-ratelimit-remaining"))
+ *     ),
+ *   subscribe: ({ next, request }) => next(request)
+ * }
+ * ```
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface Implementation<E = never, R = never> {
+    readonly execute: (options: {
+        readonly operation: GraphQL.Any;
+        readonly request: GraphQLRequest;
+        readonly next: (request: GraphQLRequest) => Effect.Effect<ExecutionResult, GraphQLClientError | Types.unhandled>;
+    }) => Effect.Effect<ExecutionResult, GraphQLClientError | Types.unhandled | E, R>;
+    readonly subscribe: (options: {
+        readonly operation: GraphQL.Any;
+        readonly request: GraphQLRequest;
+        readonly next: (request: GraphQLRequest) => Stream.Stream<ExecutionResult, GraphQLClientError | Types.unhandled>;
+    }) => Stream.Stream<ExecutionResult, GraphQLClientError | Types.unhandled | E, R>;
+}
+/**
+ * The class returned by {@link Service}: a `Context.Service` for an
+ * {@link Implementation}, carrying the declared `error` and `requires` types.
+ *
+ * @stability experimental
+ * @category services
+ * @since 4.0.0
+ */
+export interface ServiceClass<Self, Key extends string, E, R> extends Context.Service<Self, Implementation<E, R>> {
+    new (_: never): Context.ServiceClass.Shape<Key, Implementation<E, R>> & {
+        readonly [TypeId]: {
+            readonly error: E;
+            readonly requires: R;
+        };
+    };
+    readonly [TypeId]: {
+        readonly error: E;
+        readonly requires: R;
+    };
+    readonly key: Key;
+}
+/**
+ * Any middleware service class, with its error and requirement types erased.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export interface AnyService extends Context.Service<any, Implementation<any, any>> {
+    readonly [TypeId]: {
+        readonly error: any;
+        readonly requires: any;
+    };
+}
+/**
+ * Extracts the service identifier of a middleware, which is what
+ * `GraphQLClient.make` requires.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export type Identifier<M> = M extends Context.Service<infer I, any> ? I : never;
+/**
+ * Extracts the error type a middleware declared.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export type Error<M> = M extends {
+    readonly [TypeId]: {
+        readonly error: infer E;
+    };
+} ? E : never;
+/**
+ * Extracts the services a middleware declared it requires per call.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export type Requires<M> = M extends {
+    readonly [TypeId]: {
+        readonly requires: infer R;
+    };
+} ? R : never;
+/**
+ * Declares a middleware tag. `requires` are services the implementation needs
+ * on every call, and `error` is what it can fail with; both show up on the
+ * requirements and error type of every client method the middleware is
+ * attached to.
+ *
+ * **Example** (An auth middleware that needs the current user)
+ *
+ * ```ts import.meta.vitest
+ * import { Context, Effect, Layer, Schema, Stream } from "effect"
+ * import { GraphQL, GraphQLClient, GraphQLGroup, GraphQLMiddleware, GraphQLProtocol } from "effect/graphql"
+ * import { Headers } from "effect/http"
+ *
+ * class CurrentUser extends Context.Service<CurrentUser, { readonly token: string }>()("CurrentUser") {}
+ * class TokenExpired extends Schema.TaggedError<TokenExpired>()("TokenExpired", {}) {}
+ *
+ * class Auth extends GraphQLMiddleware.Service<Auth, {
+ *   requires: CurrentUser
+ *   error: TokenExpired
+ * }>()("app/Auth") {}
+ *
+ * const AuthLive = Layer.succeed(
+ *   Auth,
+ *   GraphQLMiddleware.mapRequest(Effect.fnUntraced(function*(request) {
+ *     const user = yield* CurrentUser
+ *     if (user.token === "") return yield* new TokenExpired()
+ *     return { ...request, headers: Headers.set(request.headers, "authorization", `Bearer ${user.token}`) }
+ *   }))
+ * )
+ *
+ * const Viewer = GraphQL.query("Viewer", {
+ *   document: "query Viewer{viewer{login}}",
+ *   result: Schema.Struct({ viewer: Schema.Struct({ login: Schema.String }) })
+ * })
+ *
+ * const Scripted = Layer.succeed(GraphQLProtocol.GraphQLProtocol, {
+ *   execute: (request) => Effect.succeed({ body: { data: { viewer: { login: request.headers.authorization } } } }),
+ *   subscribe: () => Stream.empty
+ * })
+ *
+ * const program = Effect.gen(function*() {
+ *   const client = yield* GraphQLClient.make(GraphQLGroup.make(Viewer).middleware(Auth))
+ *   // CurrentUser is required by the method because Auth is attached
+ *   return yield* client.Viewer().pipe(Effect.provideService(CurrentUser, { token: "abc" }))
+ * })
+ *
+ * await Effect.runPromise(program.pipe(Effect.provide([Scripted, AuthLive]))) // => { viewer: { login: "Bearer abc" } }
+ * ```
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const Service: <Self, Config extends {
+    readonly requires?: any;
+    readonly error?: any;
+} = {}>() => <const Key extends string>(key: Key) => ServiceClass<Self, Key, Config extends {
+    readonly error: infer E;
+} ? E : never, Config extends {
+    readonly requires: infer R;
+} ? R : never>;
+/**
+ * Builds an {@link Implementation} that transforms requests for queries,
+ * mutations and subscriptions. Use it to set headers, auth or extensions.
+ *
+ * **Example** (Adding a header to every request)
+ *
+ * ```ts import.meta.vitest
+ * import { Effect, Layer, Schema, Stream } from "effect"
+ * import { GraphQL, GraphQLClient, GraphQLGroup, GraphQLMiddleware, GraphQLProtocol } from "effect/graphql"
+ * import { Headers } from "effect/http"
+ *
+ * class RequestId extends GraphQLMiddleware.Service<RequestId>()("app/RequestId") {}
+ *
+ * const RequestIdLive = Layer.succeed(
+ *   RequestId,
+ *   GraphQLMiddleware.mapRequest((request) =>
+ *     Effect.succeed({ ...request, headers: Headers.set(request.headers, "x-request-id", "abc") })
+ *   )
+ * )
+ *
+ * const Viewer = GraphQL.query("Viewer", {
+ *   document: "query Viewer{viewer{login}}",
+ *   result: Schema.Struct({ viewer: Schema.Struct({ login: Schema.String }) })
+ * })
+ *
+ * const Scripted = Layer.succeed(GraphQLProtocol.GraphQLProtocol, {
+ *   execute: (request) =>
+ *     Effect.succeed({ body: { data: { viewer: { login: request.headers["x-request-id"] } } } }),
+ *   subscribe: () => Stream.empty
+ * })
+ *
+ * const program = Effect.gen(function*() {
+ *   const client = yield* GraphQLClient.make(GraphQLGroup.make(Viewer).middleware(RequestId))
+ *   return yield* client.Viewer()
+ * })
+ *
+ * await Effect.runPromise(program.pipe(Effect.provide([Scripted, RequestIdLive]))) // => { viewer: { login: "abc" } }
+ * ```
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const mapRequest: <E = never, R = never>(f: (request: GraphQLRequest, operation: GraphQL.Any) => Effect.Effect<GraphQLRequest, E, R>) => Implementation<E, R>;
+export {};
+//# sourceMappingURL=GraphQLMiddleware.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"GraphQLMiddleware.d.ts","sourceRoot":"","sources":["../../src/graphql/GraphQLMiddleware.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAA;AACxC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,KAAK,KAAK,KAAK,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE3E,QAAA,MAAM,MAAM,sCAAsC,CAAA;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK;IAClD,QAAQ,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE;QAC1B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,CAAA;QAC/B,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAA;QAChC,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,kBAAkB,GAAG,KAAK,CAAC,SAAS,CAAC,CAAA;KACjH,KAAK,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,kBAAkB,GAAG,KAAK,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;IACjF,QAAQ,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE;QAC5B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,CAAA;QAC/B,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAA;QAChC,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,kBAAkB,GAAG,KAAK,CAAC,SAAS,CAAC,CAAA;KACjH,KAAK,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,kBAAkB,GAAG,KAAK,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;CAClF;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY,CAAC,IAAI,EAAE,GAAG,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,CAAE,SAAQ,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/G,KAAI,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG;QACrE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;YAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;YAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAA;SAAE,CAAA;KAC/D,CAAA;IACD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;QAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAA;KAAE,CAAA;IAC9D,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAChF,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC;QAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAA;KAAE,CAAA;CACnE;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;AAE/E;;;;;;GAMG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAA;AAE/F;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAA;AAErG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,eAAO,MAAM,OAAO,GAClB,IAAI,EACJ,MAAM,SAAS;IACb,QAAQ,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAA;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,CAAA;CACrB,GAAG,EAAE,OACH,CAAC,KAAK,CAAC,GAAG,SAAS,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,YAAY,CACvD,IAAI,EACJ,GAAG,EACH,MAAM,SAAS;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,EACtD,MAAM,SAAS;IAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAM1D,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,KAC1C,CAAC,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,CAAC,GAAG,KAAK,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC,KAC1F,cAAc,CAAC,CAAC,EAAE,CAAC,CAGpB,CAAA"}

package/dist/graphql/GraphQLMiddleware.js

@@ -0,0 +1,130 @@
+/**
+ * GraphQL-level middleware provided as `Context.Service` implementations.
+ * Middleware can rewrite requests and inspect raw results, including response
+ * extensions and HTTP headers. Provide implementations with `Layer.succeed`
+ * or `Layer.effect`.
+ *
+ * @stability experimental
+ * @since 4.0.0
+ */
+import * as Context from "../Context.js";
+import * as Effect from "../Effect.js";
+import * as Stream from "../Stream.js";
+const TypeId = "~effect/graphql/GraphQLMiddleware";
+/**
+ * Declares a middleware tag. `requires` are services the implementation needs
+ * on every call, and `error` is what it can fail with; both show up on the
+ * requirements and error type of every client method the middleware is
+ * attached to.
+ *
+ * **Example** (An auth middleware that needs the current user)
+ *
+ * ```ts import.meta.vitest
+ * import { Context, Effect, Layer, Schema, Stream } from "effect"
+ * import { GraphQL, GraphQLClient, GraphQLGroup, GraphQLMiddleware, GraphQLProtocol } from "effect/graphql"
+ * import { Headers } from "effect/http"
+ *
+ * class CurrentUser extends Context.Service<CurrentUser, { readonly token: string }>()("CurrentUser") {}
+ * class TokenExpired extends Schema.TaggedError<TokenExpired>()("TokenExpired", {}) {}
+ *
+ * class Auth extends GraphQLMiddleware.Service<Auth, {
+ *   requires: CurrentUser
+ *   error: TokenExpired
+ * }>()("app/Auth") {}
+ *
+ * const AuthLive = Layer.succeed(
+ *   Auth,
+ *   GraphQLMiddleware.mapRequest(Effect.fnUntraced(function*(request) {
+ *     const user = yield* CurrentUser
+ *     if (user.token === "") return yield* new TokenExpired()
+ *     return { ...request, headers: Headers.set(request.headers, "authorization", `Bearer ${user.token}`) }
+ *   }))
+ * )
+ *
+ * const Viewer = GraphQL.query("Viewer", {
+ *   document: "query Viewer{viewer{login}}",
+ *   result: Schema.Struct({ viewer: Schema.Struct({ login: Schema.String }) })
+ * })
+ *
+ * const Scripted = Layer.succeed(GraphQLProtocol.GraphQLProtocol, {
+ *   execute: (request) => Effect.succeed({ body: { data: { viewer: { login: request.headers.authorization } } } }),
+ *   subscribe: () => Stream.empty
+ * })
+ *
+ * const program = Effect.gen(function*() {
+ *   const client = yield* GraphQLClient.make(GraphQLGroup.make(Viewer).middleware(Auth))
+ *   // CurrentUser is required by the method because Auth is attached
+ *   return yield* client.Viewer().pipe(Effect.provideService(CurrentUser, { token: "abc" }))
+ * })
+ *
+ * await Effect.runPromise(program.pipe(Effect.provide([Scripted, AuthLive]))) // => { viewer: { login: "Bearer abc" } }
+ * ```
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export const Service = () => key => {
+  function ServiceClass() {}
+  Object.setPrototypeOf(ServiceClass, Object.getPrototypeOf(Context.Service(key)));
+  return Object.assign(ServiceClass, {
+    key,
+    [TypeId]: TypeId
+  });
+};
+/**
+ * Builds an {@link Implementation} that transforms requests for queries,
+ * mutations and subscriptions. Use it to set headers, auth or extensions.
+ *
+ * **Example** (Adding a header to every request)
+ *
+ * ```ts import.meta.vitest
+ * import { Effect, Layer, Schema, Stream } from "effect"
+ * import { GraphQL, GraphQLClient, GraphQLGroup, GraphQLMiddleware, GraphQLProtocol } from "effect/graphql"
+ * import { Headers } from "effect/http"
+ *
+ * class RequestId extends GraphQLMiddleware.Service<RequestId>()("app/RequestId") {}
+ *
+ * const RequestIdLive = Layer.succeed(
+ *   RequestId,
+ *   GraphQLMiddleware.mapRequest((request) =>
+ *     Effect.succeed({ ...request, headers: Headers.set(request.headers, "x-request-id", "abc") })
+ *   )
+ * )
+ *
+ * const Viewer = GraphQL.query("Viewer", {
+ *   document: "query Viewer{viewer{login}}",
+ *   result: Schema.Struct({ viewer: Schema.Struct({ login: Schema.String }) })
+ * })
+ *
+ * const Scripted = Layer.succeed(GraphQLProtocol.GraphQLProtocol, {
+ *   execute: (request) =>
+ *     Effect.succeed({ body: { data: { viewer: { login: request.headers["x-request-id"] } } } }),
+ *   subscribe: () => Stream.empty
+ * })
+ *
+ * const program = Effect.gen(function*() {
+ *   const client = yield* GraphQLClient.make(GraphQLGroup.make(Viewer).middleware(RequestId))
+ *   return yield* client.Viewer()
+ * })
+ *
+ * await Effect.runPromise(program.pipe(Effect.provide([Scripted, RequestIdLive]))) // => { viewer: { login: "abc" } }
+ * ```
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export const mapRequest = f => ({
+  execute: ({
+    next,
+    operation,
+    request
+  }) => Effect.flatMap(f(request, operation), next),
+  subscribe: ({
+    next,
+    operation,
+    request
+  }) => Stream.unwrap(Effect.map(f(request, operation), next))
+});
+//# sourceMappingURL=GraphQLMiddleware.js.map

package/dist/graphql/GraphQLMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphQLMiddleware.js","names":[],"sources":["../../src/graphql/GraphQLMiddleware.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;AASA,OAAO,KAAK,OAAO,MAAM,eAAe;AACxC,OAAO,KAAK,MAAM,MAAM,cAAc;AACtC,OAAO,KAAK,MAAM,MAAM,cAAc;AAMtC,MAAM,MAAM,GAAG,mCAAmC;AAoHlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqDA,OAAO,MAAM,OAAO,GAAG,MAYtB,GAAW,IAAI;EACd,SAAS,YAAY,IAAI;EACzB,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAY,GAAG,CAAC,CAAC,CAAC;EAC3F,OAAO,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE;IAAE,GAAG;IAAE,CAAC,MAAM,GAAG;EAAM,CAAE,CAAQ;AACtE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,OAAO,MAAM,UAAU,GACrB,CAA2F,KACjE;EAC1B,OAAO,EAAE,CAAC;IAAE,IAAI;IAAE,SAAS;IAAE;EAAO,CAAE,KAAK,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC;EACtF,SAAS,EAAE,CAAC;IAAE,IAAI;IAAE,SAAS;IAAE;EAAO,CAAE,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC;CACnG,CAAC","ignoreList":[]}