@luvio/graphql-parser 0.102.2 → 0.104.1

package/dist/main.d.ts

@@ -1,15 +1,18 @@
 import { GraphQLSchema, GraphQLScalarType, execute, buildSchema, getNamedType, isObjectType } from 'graphql';
 import { buildASTSchema } from 'graphql/utilities';
 import { LuvioDocumentNode, LuvioArgumentNode, LuvioDefinitionNode, LuvioObjectValueNode, LuvioOperationDefinitionNode, LuvioSelectionCustomFieldNode, LuvioSelectionNode, LuvioSelectionObjectFieldNode, LuvioSelectionScalarFieldNode, LuvioValueNode, LuvioFieldNode, LuvioVariableDefinitionNode, LuvioVariableNode, LuvioNamedTypeNode, LuvioListTypeNode, LuvioListValueNode, LuvioTypeNode } from './ast';
-export declare function parseAndVisit(source: string): LuvioDocumentNode;
 export type { GraphQLObjectType, GraphQLInterfaceType, GraphQLDirective, GraphQLUnionType, GraphQLNamedType, } from 'graphql/type';
-export type { ListTypeNode, BooleanValueNode, EnumTypeDefinitionNode, FieldDefinitionNode, FloatValueNode, InterfaceTypeDefinitionNode, IntValueNode, NamedTypeNode, ObjectTypeDefinitionNode, StringValueNode, TypeNode, UnionTypeDefinitionNode, DocumentNode, OperationDefinitionNode, FieldNode, ArgumentNode, ValueNode, SelectionNode, SelectionSetNode, FragmentDefinitionNode, DirectiveNode, ObjectFieldNode, ScalarTypeDefinitionNode, InputObjectTypeDefinitionNode, } from 'graphql/language';
+export type { 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, } from 'graphql/language';
 export { ASTVisitor, parse, Kind, print, visit } from 'graphql/language';
 export { isScalarType } from 'graphql/type';
 export { stripIgnoredCharacters } from 'graphql/utilities';
-export { gql, enableAddMetaschemaDirective, disableAddMetaschemaDirective, astResolver, } from './gql';
+export { gql, astResolver } from './gql';
 export type { AstResolver } from './gql';
 /**
  * @deprecated - Schema-backed adapters will use standard graphql types re-exported from @luvio/graphql
  */
 export { LuvioDocumentNode, LuvioArgumentNode, LuvioDefinitionNode, LuvioObjectValueNode, LuvioOperationDefinitionNode, LuvioSelectionCustomFieldNode, LuvioSelectionNode, LuvioSelectionObjectFieldNode, LuvioSelectionScalarFieldNode, LuvioValueNode, LuvioFieldNode, LuvioVariableDefinitionNode, LuvioVariableNode, LuvioNamedTypeNode, LuvioListTypeNode, LuvioListValueNode, LuvioTypeNode, GraphQLSchema, GraphQLScalarType, buildASTSchema, execute, buildSchema, getNamedType, isObjectType, };
+/**
+ * @deprecated In favor of gql tagged template literal
+ */
+export declare function parseAndVisit(source: string): LuvioDocumentNode;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@luvio/graphql-parser",
-    "version": "0.102.2",
+    "version": "0.104.1",
     "description": "GraphQL parser for Luvio GraphQL adapter support",
     "repository": {
         "type": "git",

package/src/__tests__/gql.spec.ts

@@ -1,13 +1,4 @@
-import {
-    gql,
-    docMap,
-    astResolver,
-    processSubstitutions,
-    stripLocation,
-    addMetaschemaDirectives,
-    enableAddMetaschemaDirective,
-    disableAddMetaschemaDirective,
-} from '../gql';
+import { gql, docMap, astResolver, processSubstitutions, stripLocation } from '../gql';
 import ast from './ast.json';
 import astNoLoc from './astNoLoc.json';
 
@@ -672,13 +663,3 @@ describe('stripLocation', () => {
         expect(doc).toStrictEqual(astNoLoc);
     });
 });
-
-describe('addMetaschemaDirectives', () => {
-    it('flips', () => {
-        expect(addMetaschemaDirectives).toBe(false);
-        enableAddMetaschemaDirective();
-        expect(addMetaschemaDirectives).toBe(true);
-        disableAddMetaschemaDirective();
-        expect(addMetaschemaDirectives).toBe(false);
-    });
-});

package/src/__tests__/main.spec.ts

@@ -1,4 +1,5 @@
 import * as parser from '../main';
+import { astResolver, stripLocation } from '../gql';
 
 describe('LDS GraphQL Parser', () => {
     describe('parseAndVisit', () => {
@@ -597,4 +598,54 @@ describe('LDS GraphQL Parser', () => {
             expect(target).toStrictEqual(expected);
         });
     });
+
+    describe('metaschema', () => {
+        it('should be able to use luvio document node as key to get metaschema AST', () => {
+            const source = /* GraphQL */ `
+                query {
+                    uiapi {
+                        query {
+                            Account(where: { Name: { like: "Account1" } }) @connection {
+                                edges {
+                                    node @resource(type: "Record") {
+                                        Name {
+                                            value
+                                            displayValue
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            `;
+
+            const metaschemaSource = /* GraphQL */ `
+                query {
+                    uiapi {
+                        query {
+                            Account(where: { Name: { like: "Account1" } })
+                                @category(name: "recordQuery") {
+                                edges {
+                                    node {
+                                        Name {
+                                            value
+                                            displayValue
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            `;
+
+            const target = parser.parseAndVisit(source);
+            const metaschemaAST = astResolver(target);
+
+            expect(stripLocation(metaschemaAST)).toStrictEqual(
+                stripLocation(parser.parse(metaschemaSource))
+            );
+        });
+    });
 });

package/src/gql.ts

@@ -7,7 +7,6 @@ import type { DefinitionNode, DocumentNode } from 'graphql/language';
 import { parse } from 'graphql/language';
 import { stripIgnoredCharacters } from 'graphql/utilities';
 import { ObjectCreate, ObjectKeys } from './util/language';
-import { metaschemaMapper } from './metaschema';
 
 export type AstResolver = (astReference: any) => DocumentNode | undefined;
 
@@ -22,8 +21,6 @@ export const docMap = new Map<string, DocumentNode>();
  */
 export const referenceMap = new WeakMap<Object, DocumentNode>();
 
-export let addMetaschemaDirectives: boolean = false;
-
 /**
  * Strips characters that are not significant to the validity or execution
  * of a GraphQL document:
@@ -43,7 +40,7 @@ function operationKeyBuilder(inputString: string): string {
  * @param inputString - operation string
  * @returns DocumentNode
  */
-function parseDocument(inputString: string): DocumentNode | null {
+export function parseDocument(inputString: string): DocumentNode | null {
     const operationKey = operationKeyBuilder(inputString);
     const cachedDoc = docMap.get(operationKey);
     if (cachedDoc !== undefined) {
@@ -58,11 +55,6 @@ function parseDocument(inputString: string): DocumentNode | null {
         return null;
     }
 
-    // in-place substitution for removal of legacy and adding metaschema directives
-    if (addMetaschemaDirectives) {
-        metaschemaMapper(parsedDoc);
-    }
-
     const parsedDocNoLoc = stripLocation(parsedDoc);
 
     docMap.set(operationKey, parsedDocNoLoc);
@@ -85,9 +77,13 @@ function insertFragments(doc: DocumentNode, fragments: DefinitionNode[]): Docume
     return doc;
 }
 
-function createReference(document: DocumentNode): object {
+export function updateReferenceMapWithKnownKey(doc: DocumentNode, key: object): void {
+    referenceMap.set(key, doc);
+}
+
+export function updateReferenceMapAndGetKey(doc: DocumentNode): object {
     const key = ObjectCreate(null);
-    referenceMap.set(key, document);
+    updateReferenceMapWithKnownKey(doc, key);
 
     return key;
 }
@@ -219,19 +215,8 @@ export function gql(
     }
 
     if (inputSubstitutionFragments.length === 0) {
-        return createReference(document);
+        return updateReferenceMapAndGetKey(document);
     }
 
-    return createReference(insertFragments(document, inputSubstitutionFragments));
-}
-
-/**
- * Enable the parser to add corresponding metaschema directives for backwards compatibility
- */
-export function enableAddMetaschemaDirective() {
-    addMetaschemaDirectives = true;
-}
-
-export function disableAddMetaschemaDirective() {
-    addMetaschemaDirectives = false;
+    return updateReferenceMapAndGetKey(insertFragments(document, inputSubstitutionFragments));
 }

package/src/main.ts

@@ -1,4 +1,3 @@
-import { parse } from 'graphql/language';
 import {
     GraphQLSchema,
     GraphQLScalarType,
@@ -29,14 +28,8 @@ import {
     LuvioTypeNode,
 } from './ast';
 import { transform } from './document';
-
-/*
-    Deprecated - Remove after existing usages are removed.
-*/
-export function parseAndVisit(source: string): LuvioDocumentNode {
-    const ast = parse(source);
-    return transform(ast);
-}
+import { updateReferenceMapWithKnownKey } from './gql';
+import { metaschemaMapper } from './metaschema';
 
 export type {
     GraphQLObjectType,
@@ -70,16 +63,13 @@ export type {
     ObjectFieldNode,
     ScalarTypeDefinitionNode,
     InputObjectTypeDefinitionNode,
+    InlineFragmentNode,
 } from 'graphql/language';
+import { parse } from 'graphql/language';
 export { ASTVisitor, parse, Kind, print, visit } from 'graphql/language';
 export { isScalarType } from 'graphql/type';
 export { stripIgnoredCharacters } from 'graphql/utilities';
-export {
-    gql,
-    enableAddMetaschemaDirective,
-    disableAddMetaschemaDirective,
-    astResolver,
-} from './gql';
+export { gql, astResolver } from './gql';
 export type { AstResolver } from './gql';
 
 /**
@@ -111,3 +101,19 @@ export {
     getNamedType,
     isObjectType,
 };
+
+/**
+ * @deprecated In favor of gql tagged template literal
+ */
+export function parseAndVisit(source: string): LuvioDocumentNode {
+    const ast = parse(source);
+    const luvioDocumentNode = transform(ast!);
+
+    // In-place substitution of metaschema annotations
+    metaschemaMapper(ast!);
+
+    // Set the AST reference map with LuvioDocumentNode as the key
+    // ASTResolver will resolve it to metaschema mapped AST
+    updateReferenceMapWithKnownKey(ast!, luvioDocumentNode);
+    return luvioDocumentNode;
+}