@conduit-client/onestore-graphql-parser 3.14.0 → 3.15.0

package/dist/types/v1/bindings-utils.d.ts

@@ -1,4 +1,5 @@
 import { type Result } from '@conduit-client/utils';
+import { type ParsedGraphQLDocument } from './gql';
 import type { DocumentNode } from 'graphql/language';
 import type { GraphQLResponse } from './types';
 /**
@@ -16,7 +17,7 @@ export type ResolveAndValidateOptions = {
     acceptedOperations?: ('query' | 'mutation' | 'subscription')[];
 };
 export type UnverifiedGraphQLConfig = {
-    query?: unknown;
+    query?: ParsedGraphQLDocument;
     operationName?: string;
     variables?: Record<string, unknown>;
 };

package/dist/types/v1/gql.d.ts

@@ -1,5 +1,20 @@
 import type { DefinitionNode, DocumentNode } from 'graphql/language';
 import type { GraphQLResponse } from './types';
+declare const __brand: unique symbol;
+/**
+ * Compile-time-only branded type. Intersects a base type `T` with a phantom property
+ * keyed by a unique symbol, preventing structurally identical types from being assigned
+ * to one another. The brand property has no runtime representation.
+ */
+type Opaque<T, B> = T & {
+    readonly [__brand]: B;
+};
+/**
+ * Opaque branded type returned by `gql`.
+ * Consumers cannot construct this directly -- it can only be obtained from the `gql` tag / function.
+ * Pass it as `query` in adapter config types for type-safe GraphQL resolution.
+ */
+export type ParsedGraphQLDocument = Opaque<unknown, 'ParsedGraphQLDocument'>;
 export type AstResolution = {
     type: 'document';
     document: DocumentNode;
@@ -23,9 +38,9 @@ export declare const referenceMap: WeakMap<Object, AstResolution>;
  * @param inputString - operation string
  * @returns DocumentNode or GraphQLResponse with errors if parsing fails
  */
-export declare function parseDocument(inputString: string): AstResolution | null;
+export declare function parseDocument(inputString: string): AstResolution;
 export declare function updateReferenceMapWithKnownKey(doc: AstResolution, key: object): void;
-export declare function updateReferenceMapAndGetKey(doc: AstResolution): object;
+export declare function updateReferenceMapAndGetKey(doc: AstResolution): ParsedGraphQLDocument;
 /**
  * Insert string and fragment substitutions with the actual nodes
  * @param inputString
@@ -42,9 +57,16 @@ export declare function processSubstitutions(inputString: ReadonlyArray<string>,
  */
 export declare const astResolver: AstResolver;
 /**
+ * Tagged template literal (or callable function) that parses a GraphQL operation string.
+ *
+ * Always returns an opaque {@link ParsedGraphQLDocument} reference -- even when parsing fails.
+ * A returned reference does **not** indicate successful parsing. Parsing errors are deferred
+ * until the adapter resolves the reference, at which point a `GraphQLErrors`-shaped response
+ * is emitted to the consumer.
  *
- * @param literals - operation query string
- * @param subs - all other substitutions
- * @returns an opaque reference to the parsed document
+ * @param literals - operation query string (or template literal strings array)
+ * @param subs - template literal substitutions (strings or fragment references from other `gql` calls)
+ * @returns an opaque reference that can be passed as `query` in adapter config types
  */
-export declare function gql(literals: ReadonlyArray<string> | string, ...subs: (string | object)[]): object | null;
+export declare function gql(literals: ReadonlyArray<string> | string, ...subs: (string | object)[]): ParsedGraphQLDocument;
+export {};

package/dist/types/v1/index.d.ts

@@ -2,7 +2,7 @@ export type { GraphQLObjectType, GraphQLInterfaceType, GraphQLDirective, GraphQL
 export type { ASTNode, ObjectValueNode, ListTypeNode, BooleanValueNode, EnumTypeDefinitionNode, FieldDefinitionNode, FloatValueNode, InterfaceTypeDefinitionNode, IntValueNode, NamedTypeNode, ObjectTypeDefinitionNode, StringValueNode, TypeNode, UnionTypeDefinitionNode, DocumentNode, OperationDefinitionNode, FieldNode, ArgumentNode, ValueNode, SelectionNode, SelectionSetNode, FragmentDefinitionNode, DirectiveNode, ObjectFieldNode, ScalarTypeDefinitionNode, InputObjectTypeDefinitionNode, InlineFragmentNode, FragmentSpreadNode, VariableDefinitionNode, ListValueNode, VariableNode, NullValueNode, } from 'graphql/language';
 export { Kind } from 'graphql/language';
 export { gql, astResolver } from './gql';
-export type { AstResolver, AstResolution } from './gql';
+export type { AstResolver, AstResolution, ParsedGraphQLDocument } from './gql';
 export { parse, print, visit } from 'graphql/language';
 export type { ResolveAndValidateOptions, UnverifiedGraphQLConfig, ValidGraphQLConfig, } from './bindings-utils';
 export { resolveAndValidateGraphQLConfig } from './bindings-utils';

package/dist/v1/index.js

@@ -3112,6 +3112,12 @@ function updateReferenceMapAndGetKey(doc) {
   updateReferenceMapWithKnownKey(doc, key);
   return key;
 }
+function createErrorRef(message) {
+  return updateReferenceMapAndGetKey({
+    type: "error",
+    error: { errors: [{ message }] }
+  });
+}
 function processSubstitutions(inputString, substitutions) {
   let outputString = "";
   const fragments = [];
@@ -3123,21 +3129,13 @@ function processSubstitutions(inputString, substitutions) {
       outputString += substitution;
     } else if (typeof substitution === "object") {
       const resolved = referenceMap.get(substitution);
-      if (resolved === void 0) {
-        if (process.env.NODE_ENV !== "production") {
-          throw new Error("Invalid substitution fragment");
-        }
+      if (resolved === void 0 || resolved.type === "error") {
         return null;
       }
-      if (resolved.type === "document") {
-        for (const def of resolved.document.definitions) {
-          fragments.push(def);
-        }
+      for (const def of resolved.document.definitions) {
+        fragments.push(def);
       }
     } else {
-      if (process.env.NODE_ENV !== "production") {
-        throw new Error("Unsupported substitution type");
-      }
       return null;
     }
   }
@@ -3156,32 +3154,23 @@ function gql(literals, ...subs) {
   let inputString;
   let inputSubstitutionFragments;
   if (!literals) {
-    if (process.env.NODE_ENV !== "production") {
-      throw new Error("Invalid query");
-    }
-    return null;
+    return createErrorRef("Invalid query");
   } else if (typeof literals === "string") {
     inputString = literals.trim();
     inputSubstitutionFragments = [];
   } else {
     const sub = processSubstitutions(literals, subs);
     if (sub === null) {
-      return null;
+      return createErrorRef("Invalid substitution");
     }
     const { operationString, fragments } = sub;
     inputString = operationString.trim();
     inputSubstitutionFragments = fragments;
   }
   if (inputString.length === 0) {
-    if (process.env.NODE_ENV !== "production") {
-      throw new Error("Invalid query");
-    }
-    return null;
+    return createErrorRef("Invalid query");
   }
   const document = parseDocument(inputString);
-  if (document === null) {
-    return null;
-  }
   if (document.type === "error") {
     return updateReferenceMapAndGetKey(document);
   }