effect 4.0.3 → 4.0.4

package/dist/graphql/GraphQL.d.ts

@@ -0,0 +1,349 @@
+import { type Pipeable } from "../Pipeable.ts";
+import * as Schema from "../Schema.ts";
+import type { GraphQLClientError } from "./GraphQLClientError.ts";
+import type * as GraphQLMiddleware from "./GraphQLMiddleware.ts";
+declare const TypeId = "~effect/graphql/GraphQL";
+/**
+ * The three kinds of GraphQL operation.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export type Kind = "query" | "mutation" | "subscription";
+/**
+ * An operation document split into the pieces needed to rename and alias it
+ * without a GraphQL parser. The generator emits one for every query and
+ * mutation.
+ *
+ * **Details**
+ *
+ * A `body` is a {@link DocumentTemplate.Parts} array: literal text at even
+ * indices and, at odd indices, the variable names and fragment names that
+ * would be renamed if the operation were repeated under a prefix. Joining the
+ * pieces gives the printed document, which is what the operation sends.
+ *
+ * A fragment whose `body` has a name in it is per-slice: it references a
+ * variable, directly or through a fragment it spreads. Every other fragment is
+ * shared.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DocumentTemplate {
+    /** The variable definitions, in document order. */
+    readonly variables: ReadonlyArray<DocumentTemplate.Variable>;
+    /** The operation's directives, if it has any. */
+    readonly directives?: DocumentTemplate.Parts | undefined;
+    /** The root selections, in document order. */
+    readonly selections: ReadonlyArray<DocumentTemplate.Selection>;
+    /** The fragments the operation uses, in the order they follow it. */
+    readonly fragments: ReadonlyArray<DocumentTemplate.Fragment>;
+}
+/**
+ * The pieces of a {@link DocumentTemplate}.
+ *
+ * @stability experimental
+ * @since 4.0.0
+ */
+export declare namespace DocumentTemplate {
+    /**
+     * Literal text at even indices and names to rename at odd indices.
+     *
+     * @stability experimental
+     * @category models
+     * @since 4.0.0
+     */
+    type Parts = ReadonlyArray<string>;
+    /**
+     * A variable definition: `$name:` followed by `body`, the type, default
+     * value and directives as printed.
+     *
+     * @stability experimental
+     * @category models
+     * @since 4.0.0
+     */
+    interface Variable {
+        readonly name: string;
+        readonly body: string;
+    }
+    /**
+     * A root selection. For a field, `body` is everything after its name and
+     * the response key is `alias ?? name`. A fragment spread or inline fragment
+     * has no `name`, and `body` is the whole selection.
+     *
+     * @stability experimental
+     * @category models
+     * @since 4.0.0
+     */
+    interface Selection {
+        readonly alias?: string | undefined;
+        readonly name?: string | undefined;
+        readonly body: Parts;
+    }
+    /**
+     * A fragment definition: `fragment` and `name`, followed by `body`, which
+     * starts at its type condition.
+     *
+     * @stability experimental
+     * @category models
+     * @since 4.0.0
+     */
+    interface Fragment {
+        readonly name: string;
+        readonly body: Parts;
+    }
+}
+/**
+ * A named GraphQL document with variable and result schemas and middleware.
+ * Variables are encoded before sending; results are decoded from `data`.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface Operation<out K extends Kind, out Name extends string, out Variables extends Schema.Top, out Result extends Schema.Top, out Middleware = never> extends Pipeable {
+    readonly [TypeId]: typeof TypeId;
+    readonly kind: K;
+    readonly name: Name;
+    /** The printed document, sent as-is. It is never parsed at runtime. */
+    readonly document: string;
+    /** The template the document was joined from, if it was given as one. */
+    readonly template: DocumentTemplate | undefined;
+    readonly variables: Variables;
+    readonly result: Result;
+    /** Middleware attached to this operation, outermost first. */
+    readonly middlewares: ReadonlyArray<GraphQLMiddleware.AnyService>;
+    readonly "~middleware"?: Middleware;
+    /**
+     * Returns a copy of this operation with `middleware` attached. Operation
+     * middleware runs inside any group middleware; within the operation,
+     * middleware run in the order they were attached.
+     */
+    middleware<M extends GraphQLMiddleware.AnyService>(middleware: M): Operation<K, Name, Variables, Result, Middleware | M>;
+}
+/**
+ * Any operation, with its type parameters erased.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export type Any = Operation<Kind, string, Schema.Top, Schema.Top, any>;
+/**
+ * Extracts the union of middleware attached to an operation.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export type Middleware<Op> = Op extends Operation<any, any, any, any, infer M> ? M : never;
+/**
+ * The decoded variables type of an operation, which is what a client method
+ * takes.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export type Variables<Op extends Any> = Op["variables"]["Type"];
+/**
+ * The decoded result type of an operation.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export type Result<Op extends Any> = Op["result"]["Type"];
+/**
+ * The error type of a client method for an operation: `GraphQLClientError`
+ * plus the errors of every attached middleware.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export type Error<Op extends Any> = GraphQLClientError | GraphQLMiddleware.Error<Middleware<Op>>;
+/**
+ * The services a client method for an operation requires: the Schemas'
+ * encoding and decoding services plus the requirements of every attached
+ * middleware.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export type Services<Op extends Any> = Op["variables"]["EncodingServices"] | Op["result"]["DecodingServices"] | GraphQLMiddleware.Requires<Middleware<Op>>;
+/**
+ * The type of an operation after attaching middleware `M`.
+ *
+ * @stability experimental
+ * @category utility types
+ * @since 4.0.0
+ */
+export type AddMiddleware<Op, M> = Op extends Operation<infer K, infer N, infer V, infer R, infer Old> ? Operation<K, N, V, R, Old | M> : never;
+/**
+ * Tests whether a value is an {@link Operation}.
+ *
+ * @stability experimental
+ * @category guards
+ * @since 4.0.0
+ */
+export declare const isOperation: (u: unknown) => u is Any;
+/**
+ * Defines a query. The client accepts decoded variables and encodes them
+ * through their Schema, including custom scalar codecs. `variables` accepts
+ * struct fields or a Schema; omit it for an operation without variables.
+ * `document` accepts printed text or a {@link DocumentTemplate}, joined once
+ * when the operation is defined.
+ *
+ * **Example** (A query with variables)
+ *
+ * ```ts import.meta.vitest
+ * import { Schema } from "effect"
+ * import { GraphQL } from "effect/graphql"
+ *
+ * const RepoIssues = GraphQL.query("RepoIssues", {
+ *   document: "query RepoIssues($owner:String!,$name:String!){repository(owner:$owner,name:$name){issues(first:10){nodes{number title}}}}",
+ *   variables: { owner: Schema.String, name: Schema.String },
+ *   result: Schema.Struct({
+ *     repository: Schema.NullOr(Schema.Struct({
+ *       issues: Schema.Struct({
+ *         nodes: Schema.NullOr(Schema.Array(Schema.NullOr(Schema.Struct({ number: Schema.Int, title: Schema.String }))))
+ *       })
+ *     }))
+ *   })
+ * })
+ *
+ * RepoIssues.kind // => "query"
+ * RepoIssues.name // => "RepoIssues"
+ * ```
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const query: <const Name extends string, Result extends Schema.Top, Variables extends Schema.Top | Schema.Struct.Fields = Schema.Struct<{}>>(name: Name, options: {
+    readonly document: string | DocumentTemplate;
+    readonly variables?: Variables | undefined;
+    readonly result: Result;
+}) => Operation<"query", Name, Variables extends Schema.Struct.Fields ? Schema.Struct<Variables> : Variables, Result>;
+/**
+ * Defines a mutation. Same shape as {@link query}.
+ *
+ * **Example** (A mutation)
+ *
+ * ```ts import.meta.vitest
+ * import { Schema } from "effect"
+ * import { GraphQL } from "effect/graphql"
+ *
+ * const AddComment = GraphQL.mutation("AddComment", {
+ *   document: "mutation AddComment($subjectId:ID!,$body:String!){addComment(input:{subjectId:$subjectId,body:$body}){clientMutationId}}",
+ *   variables: { subjectId: Schema.String, body: Schema.String },
+ *   result: Schema.Struct({ addComment: Schema.NullOr(Schema.Struct({ clientMutationId: Schema.NullOr(Schema.String) })) })
+ * })
+ *
+ * AddComment.kind // => "mutation"
+ * ```
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const mutation: <const Name extends string, Result extends Schema.Top, Variables extends Schema.Top | Schema.Struct.Fields = Schema.Struct<{}>>(name: Name, options: {
+    readonly document: string | DocumentTemplate;
+    readonly variables?: Variables | undefined;
+    readonly result: Result;
+}) => Operation<"mutation", Name, Variables extends Schema.Struct.Fields ? Schema.Struct<Variables> : Variables, Result>;
+/**
+ * Defines a subscription. The client method for a subscription returns a
+ * `Stream` of decoded events instead of an `Effect`.
+ *
+ * **Example** (A subscription)
+ *
+ * ```ts import.meta.vitest
+ * import { Schema } from "effect"
+ * import { GraphQL } from "effect/graphql"
+ *
+ * const IssueUpdated = GraphQL.subscription("IssueUpdated", {
+ *   document: "subscription IssueUpdated($id:ID!){issueUpdated(id:$id){title}}",
+ *   variables: { id: Schema.String },
+ *   result: Schema.Struct({ issueUpdated: Schema.Struct({ title: Schema.String }) })
+ * })
+ *
+ * IssueUpdated.kind // => "subscription"
+ * ```
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const subscription: <const Name extends string, Result extends Schema.Top, Variables extends Schema.Top | Schema.Struct.Fields = Schema.Struct<{}>>(name: Name, options: {
+    readonly document: string | DocumentTemplate;
+    readonly variables?: Variables | undefined;
+    readonly result: Result;
+}) => Operation<"subscription", Name, Variables extends Schema.Struct.Fields ? Schema.Struct<Variables> : Variables, Result>;
+/**
+ * The `__typename` Schema for the "every other type" member of a generated
+ * union.
+ *
+ * **Details**
+ *
+ * The type excludes selected names, allowing `__typename` narrowing. The
+ * decoder accepts any other string, including types added by the server
+ * later. Selected names are rejected so malformed selected results cannot
+ * fall through to the catch-all member.
+ *
+ * **Example** (The catch-all member of a union)
+ *
+ * ```ts import.meta.vitest
+ * import { Schema } from "effect"
+ * import { GraphQL } from "effect/graphql"
+ *
+ * type Node = "Issue" | "PullRequest" | "Repository"
+ *
+ * const OtherNode = Schema.Struct({
+ *   __typename: GraphQL.otherTypename<Node>()(["Issue"]),
+ *   id: Schema.String
+ * })
+ *
+ * Schema.decodeUnknownSync(OtherNode)({ __typename: "PullRequest", id: "1" }).__typename // => "PullRequest"
+ * Schema.decodeUnknownSync(OtherNode)({ __typename: "AddedLater", id: "2" }).__typename // => "AddedLater"
+ * Schema.is(OtherNode)({ __typename: "Issue", id: "3" }) // => false
+ * ```
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const otherTypename: <All extends string>() => <const Selected extends ReadonlyArray<All>>(selected: Selected) => Schema.refine<Exclude<All, Selected[number]>, Schema.String>;
+/**
+ * The Schema for a GraphQL enum in a result position.
+ *
+ * **Details**
+ *
+ * It is typed as the declared literals but decodes any string, so a value the
+ * server adds later does not fail the whole query. Inputs stay strict: the
+ * generator uses `Schema.Literals` for enums in variables and input objects.
+ *
+ * **Example** (An enum that tolerates new values)
+ *
+ * ```ts import.meta.vitest
+ * import { Schema } from "effect"
+ * import { GraphQL } from "effect/graphql"
+ *
+ * const IssueState = GraphQL.enumLiterals(["OPEN", "CLOSED"])
+ *
+ * Schema.decodeUnknownSync(IssueState)("OPEN") // => "OPEN"
+ * Schema.decodeUnknownSync(IssueState)("MERGED") // => "MERGED"
+ * Schema.is(IssueState)(42) // => false
+ * ```
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const enumLiterals: <const Literals extends ReadonlyArray<string>>(literals: Literals) => Schema.refine<Literals[number], Schema.String>;
+export {};
+//# sourceMappingURL=GraphQL.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"GraphQL.d.ts","sourceRoot":"","sources":["../../src/graphql/GraphQL.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,gBAAgB,CAAA;AAE7D,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AACjE,OAAO,KAAK,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAEhE,QAAA,MAAM,MAAM,4BAA4B,CAAA;AAExC;;;;;;GAMG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,GAAG,UAAU,GAAG,cAAc,CAAA;AAExD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,gBAAgB;IAC/B,mDAAmD;IACnD,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAA;IAC5D,iDAAiD;IACjD,QAAQ,CAAC,UAAU,CAAC,EAAE,gBAAgB,CAAC,KAAK,GAAG,SAAS,CAAA;IACxD,8CAA8C;IAC9C,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAA;IAC9D,qEAAqE;IACrE,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAA;CAC7D;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC;;;;;;OAMG;IACH,KAAY,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC,CAAA;IAEzC;;;;;;;OAOG;IACH,UAAiB,QAAQ;QACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KACtB;IAED;;;;;;;;OAQG;IACH,UAAiB,SAAS;QACxB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACnC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAClC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;KACrB;IAED;;;;;;;OAOG;IACH,UAAiB,QAAQ;QACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;KACrB;CACF;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,SAAS,CACxB,GAAG,CAAC,CAAC,SAAS,IAAI,EAClB,GAAG,CAAC,IAAI,SAAS,MAAM,EACvB,GAAG,CAAC,SAAS,SAAS,MAAM,CAAC,GAAG,EAChC,GAAG,CAAC,MAAM,SAAS,MAAM,CAAC,GAAG,EAC7B,GAAG,CAAC,UAAU,GAAG,KAAK,CACtB,SAAQ,QAAQ;IAChB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;IAChB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;IACnB,uEAAuE;IACvE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,yEAAyE;IACzE,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,GAAG,SAAS,CAAA;IAC/C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,8DAA8D;IAC9D,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAA;IACjE,QAAQ,CAAC,aAAa,CAAC,EAAE,UAAU,CAAA;IACnC;;;;OAIG;IACH,UAAU,CAAC,CAAC,SAAS,iBAAiB,CAAC,UAAU,EAC/C,UAAU,EAAE,CAAC,GACZ,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,GAAG,CAAC,CAAC,CAAA;CACzD;AAED;;;;;;GAMG;AACH,MAAM,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;AAEtE;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,CAAC,EAAE,IAAI,EAAE,SAAS,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;AAE1F;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,EAAE,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAA;AAE/D;;;;;;GAMG;AACH,MAAM,MAAM,MAAM,CAAC,EAAE,SAAS,GAAG,IAAI,EAAE,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAA;AAEzD;;;;;;;GAOG;AACH,MAAM,MAAM,KAAK,CAAC,EAAE,SAAS,GAAG,IAAI,kBAAkB,GAAG,iBAAiB,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAA;AAEhG;;;;;;;;GAQG;AACH,MAAM,MAAM,QAAQ,CAAC,EAAE,SAAS,GAAG,IAC/B,EAAE,CAAC,WAAW,CAAC,CAAC,kBAAkB,CAAC,GACnC,EAAE,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,GAChC,iBAAiB,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAA;AAE9C;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,SAAS,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,GAClG,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC,GAC9B,KAAK,CAAA;AAET;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,MAAO,OAAO,KAAG,CAAC,IAAI,GAA6B,CAAA;AA+C3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,KAAK,EAAE,CAClB,KAAK,CAAC,IAAI,SAAS,MAAM,EACzB,MAAM,SAAS,MAAM,CAAC,GAAG,EACzB,SAAS,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAEvE,IAAI,EAAE,IAAI,EACV,OAAO,EAAE;IACP,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAC5C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAA;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB,KACE,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,SAAS,EAAE,MAAM,CAC3F,CAAA;AAExB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,QAAQ,EAAE,CACrB,KAAK,CAAC,IAAI,SAAS,MAAM,EACzB,MAAM,SAAS,MAAM,CAAC,GAAG,EACzB,SAAS,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAEvE,IAAI,EAAE,IAAI,EACV,OAAO,EAAE;IACP,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAC5C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAA;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB,KACE,SAAS,CACZ,UAAU,EACV,IAAI,EACJ,SAAS,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,SAAS,EAC7E,MAAM,CACqB,CAAA;AAE7B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,YAAY,EAAE,CACzB,KAAK,CAAC,IAAI,SAAS,MAAM,EACzB,MAAM,SAAS,MAAM,CAAC,GAAG,EACzB,SAAS,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAEvE,IAAI,EAAE,IAAI,EACV,OAAO,EAAE;IACP,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAC5C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAA;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB,KACE,SAAS,CACZ,cAAc,EACd,IAAI,EACJ,SAAS,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,SAAS,EAC7E,MAAM,CACyB,CAAA;AAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,aAAa,GAAI,GAAG,SAAS,MAAM,QAC/C,KAAK,CAAC,QAAQ,SAAS,aAAa,CAAC,GAAG,CAAC,YAC9B,QAAQ,KACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAY7D,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,YAAY,GAAI,KAAK,CAAC,QAAQ,SAAS,aAAa,CAAC,MAAM,CAAC,YAC7D,QAAQ,KACjB,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAO5C,CAAA"}

package/dist/graphql/GraphQL.js

@@ -0,0 +1,207 @@
+/**
+ * Typed GraphQL operations for `GraphQLGroup` and `GraphQLClient.make`,
+ * written by hand or generated by `@effect/graphql-generator`.
+ *
+ * Includes the generator's lenient decoders, {@link otherTypename} and
+ * {@link enumLiterals}.
+ *
+ * @stability experimental
+ * @since 4.0.0
+ */
+import * as internal from "../internal/graphql.js";
+import { pipeArguments } from "../Pipeable.js";
+import { hasProperty } from "../Predicate.js";
+import * as Schema from "../Schema.js";
+const TypeId = "~effect/graphql/GraphQL";
+/**
+ * Tests whether a value is an {@link Operation}.
+ *
+ * @stability experimental
+ * @category guards
+ * @since 4.0.0
+ */
+export const isOperation = u => hasProperty(u, TypeId);
+const Proto = {
+  [TypeId]: TypeId,
+  pipe() {
+    return pipeArguments(this, arguments);
+  },
+  middleware(middleware) {
+    return makeProto({
+      ...this,
+      middlewares: [...this.middlewares, middleware]
+    });
+  }
+};
+// The middleware type of an operation is phantom and its Schemas are erased to
+// `Schema.Top` here, so the typed constructors below state their operation
+// type with one assertion each.
+const makeProto = fields => Object.assign(Object.create(Proto), fields);
+const makeOperation = kind => (name, options) => makeProto({
+  kind,
+  name,
+  document: typeof options.document === "string" ? options.document : internal.joinTemplate(kind, name, options.document),
+  template: typeof options.document === "string" ? undefined : options.document,
+  variables: options.variables === undefined ? Schema.Struct({}) : Schema.isSchema(options.variables) ? options.variables : Schema.Struct(options.variables),
+  result: options.result,
+  middlewares: []
+});
+/**
+ * Defines a query. The client accepts decoded variables and encodes them
+ * through their Schema, including custom scalar codecs. `variables` accepts
+ * struct fields or a Schema; omit it for an operation without variables.
+ * `document` accepts printed text or a {@link DocumentTemplate}, joined once
+ * when the operation is defined.
+ *
+ * **Example** (A query with variables)
+ *
+ * ```ts import.meta.vitest
+ * import { Schema } from "effect"
+ * import { GraphQL } from "effect/graphql"
+ *
+ * const RepoIssues = GraphQL.query("RepoIssues", {
+ *   document: "query RepoIssues($owner:String!,$name:String!){repository(owner:$owner,name:$name){issues(first:10){nodes{number title}}}}",
+ *   variables: { owner: Schema.String, name: Schema.String },
+ *   result: Schema.Struct({
+ *     repository: Schema.NullOr(Schema.Struct({
+ *       issues: Schema.Struct({
+ *         nodes: Schema.NullOr(Schema.Array(Schema.NullOr(Schema.Struct({ number: Schema.Int, title: Schema.String }))))
+ *       })
+ *     }))
+ *   })
+ * })
+ *
+ * RepoIssues.kind // => "query"
+ * RepoIssues.name // => "RepoIssues"
+ * ```
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export const query = /*#__PURE__*/makeOperation("query");
+/**
+ * Defines a mutation. Same shape as {@link query}.
+ *
+ * **Example** (A mutation)
+ *
+ * ```ts import.meta.vitest
+ * import { Schema } from "effect"
+ * import { GraphQL } from "effect/graphql"
+ *
+ * const AddComment = GraphQL.mutation("AddComment", {
+ *   document: "mutation AddComment($subjectId:ID!,$body:String!){addComment(input:{subjectId:$subjectId,body:$body}){clientMutationId}}",
+ *   variables: { subjectId: Schema.String, body: Schema.String },
+ *   result: Schema.Struct({ addComment: Schema.NullOr(Schema.Struct({ clientMutationId: Schema.NullOr(Schema.String) })) })
+ * })
+ *
+ * AddComment.kind // => "mutation"
+ * ```
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export const mutation = /*#__PURE__*/makeOperation("mutation");
+/**
+ * Defines a subscription. The client method for a subscription returns a
+ * `Stream` of decoded events instead of an `Effect`.
+ *
+ * **Example** (A subscription)
+ *
+ * ```ts import.meta.vitest
+ * import { Schema } from "effect"
+ * import { GraphQL } from "effect/graphql"
+ *
+ * const IssueUpdated = GraphQL.subscription("IssueUpdated", {
+ *   document: "subscription IssueUpdated($id:ID!){issueUpdated(id:$id){title}}",
+ *   variables: { id: Schema.String },
+ *   result: Schema.Struct({ issueUpdated: Schema.Struct({ title: Schema.String }) })
+ * })
+ *
+ * IssueUpdated.kind // => "subscription"
+ * ```
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export const subscription = /*#__PURE__*/makeOperation("subscription");
+/**
+ * The `__typename` Schema for the "every other type" member of a generated
+ * union.
+ *
+ * **Details**
+ *
+ * The type excludes selected names, allowing `__typename` narrowing. The
+ * decoder accepts any other string, including types added by the server
+ * later. Selected names are rejected so malformed selected results cannot
+ * fall through to the catch-all member.
+ *
+ * **Example** (The catch-all member of a union)
+ *
+ * ```ts import.meta.vitest
+ * import { Schema } from "effect"
+ * import { GraphQL } from "effect/graphql"
+ *
+ * type Node = "Issue" | "PullRequest" | "Repository"
+ *
+ * const OtherNode = Schema.Struct({
+ *   __typename: GraphQL.otherTypename<Node>()(["Issue"]),
+ *   id: Schema.String
+ * })
+ *
+ * Schema.decodeUnknownSync(OtherNode)({ __typename: "PullRequest", id: "1" }).__typename // => "PullRequest"
+ * Schema.decodeUnknownSync(OtherNode)({ __typename: "AddedLater", id: "2" }).__typename // => "AddedLater"
+ * Schema.is(OtherNode)({ __typename: "Issue", id: "3" }) // => false
+ * ```
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export const otherTypename = () => selected => {
+  const rejected = new Set(selected);
+  // Type boundary: decoding is lenient by design. The guard passes any string
+  // other than the selected names, including names the server adds later, but
+  // the type only lists the names known when the code was generated.
+  return Schema.refine(name => !rejected.has(name), {
+    title: "otherTypename",
+    message: `Expected a __typename other than ${selected.map(s => `"${s}"`).join(", ")}`
+  })(Schema.String);
+};
+/**
+ * The Schema for a GraphQL enum in a result position.
+ *
+ * **Details**
+ *
+ * It is typed as the declared literals but decodes any string, so a value the
+ * server adds later does not fail the whole query. Inputs stay strict: the
+ * generator uses `Schema.Literals` for enums in variables and input objects.
+ *
+ * **Example** (An enum that tolerates new values)
+ *
+ * ```ts import.meta.vitest
+ * import { Schema } from "effect"
+ * import { GraphQL } from "effect/graphql"
+ *
+ * const IssueState = GraphQL.enumLiterals(["OPEN", "CLOSED"])
+ *
+ * Schema.decodeUnknownSync(IssueState)("OPEN") // => "OPEN"
+ * Schema.decodeUnknownSync(IssueState)("MERGED") // => "MERGED"
+ * Schema.is(IssueState)(42) // => false
+ * ```
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export const enumLiterals = literals =>
+// Type boundary: decoding is lenient by design. The guard passes any string,
+// including values the server adds later, but the type only lists the values
+// known when the code was generated.
+Schema.refine(_ => true)(Schema.String).annotate({
+  title: `enum(${literals.join(" | ")})`,
+  description: `One of ${literals.map(l => `"${l}"`).join(", ")}, or any string the server adds later`
+});
+//# sourceMappingURL=GraphQL.js.map

package/dist/graphql/GraphQL.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphQL.js","names":[],"sources":["../../src/graphql/GraphQL.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;AAUA,OAAO,KAAK,QAAQ,MAAM,wBAAwB;AAClD,SAAwB,aAAa,QAAQ,gBAAgB;AAC7D,SAAS,WAAW,QAAQ,iBAAiB;AAC7C,OAAO,KAAK,MAAM,MAAM,cAAc;AAItC,MAAM,MAAM,GAAG,yBAAyB;AAiNxC;;;;;;;AAOA,OAAO,MAAM,WAAW,GAAI,CAAU,IAAe,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC;AAE3E,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;MAAE,GAAG,IAAI;MAAE,WAAW,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,UAAU;IAAC,CAAE,CAAC;EAC/E;CACD;AAED;AACA;AACA;AACA,MAAM,SAAS,GAAI,MAAwD,IACzE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;AAE7C,MAAM,aAAa,GAA0B,IAAO,IACpD,CAKE,IAAU,EACV,OAIC,KAED,SAAS,CAAC;EACR,IAAI;EACJ,IAAI;EACJ,QAAQ,EAAE,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,GAC1C,OAAO,CAAC,QAAQ,GAChB,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC;EACvD,QAAQ,EAAE,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ;EAC7E,SAAS,EAAE,OAAO,CAAC,SAAS,KAAK,SAAS,GACtC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,GACjB,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,GAClC,OAAO,CAAC,SAAS,GACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAiC,CAAC;EAC5D,MAAM,EAAE,OAAO,CAAC,MAAM;EACtB,WAAW,EAAE;CACd,CAA8G;AAEjH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,OAAO,MAAM,KAAK,gBAYhB,aAAa,CAAC,OAAO,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAM,QAAQ,gBAgBjB,aAAa,CAAC,UAAU,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,MAAM,YAAY,gBAgBrB,aAAa,CAAC,cAAc,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,OAAO,MAAM,aAAa,GAAG,MAE3B,QAAkB,IAC8C;EAChE,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAS,QAAQ,CAAC;EAC1C;EACA;EACA;EACA,OAAO,MAAM,CAAC,MAAM,CACjB,IAAI,IAA6C,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EACrE;IACE,KAAK,EAAE,eAAe;IACtB,OAAO,EAAE,oCAAoC,QAAQ,CAAC,GAAG,CAAE,CAAC,IAAK,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;GACtF,CACF,CAAC,MAAM,CAAC,MAAM,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,OAAO,MAAM,YAAY,GACvB,QAAkB;AAElB;AACA;AACA;AACA,MAAM,CAAC,MAAM,CAAmC,CAAC,IAA4B,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC;EACzG,KAAK,EAAE,QAAQ,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG;EACtC,WAAW,EAAE,UAAU,QAAQ,CAAC,GAAG,CAAE,CAAC,IAAK,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;CAChE,CAAC","ignoreList":[]}