effect 4.0.2 → 4.0.4

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":[]}