@luvio/graphql-parser 0.73.0 → 0.73.5

package/src/__tests__/schema.spec.ts

@@ -0,0 +1,21 @@
+import { parseLuvioSchema } from '../main';
+import { readFileSync } from 'fs';
+import path from 'path';
+
+function readSchemaAsString(fileName: string) {
+    const fullPath = path.join(__dirname, 'data', fileName);
+    const buffer = readFileSync(fullPath);
+    return buffer.toString();
+}
+
+describe('Luvio GraphQL Schema Parsing', () => {
+    it('default implementation can parse github api', () => {
+        const schema = parseLuvioSchema(readSchemaAsString('github.graphql'), 'githubSchema');
+        expect(schema).toMatchSnapshot();
+    });
+
+    it('default implementation can parse star wars api', () => {
+        const schema = parseLuvioSchema(readSchemaAsString('swapi.graphql'), 'swapiSchema');
+        expect(schema).toMatchSnapshot();
+    });
+});

package/src/luvio-schema.ts

@@ -0,0 +1,18 @@
+import { GraphQLSchema } from 'graphql';
+
+interface LuvioGraphQLSchemaParams {
+    schema: GraphQLSchema;
+    schemaName: string;
+}
+
+export class LuvioGraphQLSchema {
+    // INVARIANT - Do not mutate the source schema, or add special AST or schema syntax,
+    // just store additional information alongside it. In this way - we can accept this extra data in basically any format (RAML, JSON, YML)
+    schema: Readonly<GraphQLSchema>;
+    schemaName: Readonly<string>;
+
+    constructor(luvioSchemaParams: Readonly<LuvioGraphQLSchemaParams>) {
+        this.schemaName = luvioSchemaParams.schemaName;
+        this.schema = luvioSchemaParams.schema;
+    }
+}

package/src/main.ts

@@ -5,6 +5,8 @@ import {
     IntValueNode,
     StringValueNode,
 } from 'graphql/language';
+
+import { buildASTSchema } from 'graphql/utilities';
 import {
     LuvioDocumentNode,
     LuvioArgumentNode,
@@ -25,14 +27,27 @@ import {
     LuvioTypeNode,
 } from './ast';
 import { transform } from './document';
+import { LuvioGraphQLSchema } from './luvio-schema';
 
+/*
+    Deprecated - Remove after existing usages are removed. 
+*/
 export function parseAndVisit(source: string): LuvioDocumentNode {
-    // TODO: handle generic <Type>
     const ast = parse(source);
     return transform(ast);
 }
 
-// type exports
+export function parseLuvioSchema(source: string, schemaName: string): LuvioGraphQLSchema {
+    const schema = buildASTSchema(parse(source));
+    return new LuvioGraphQLSchema({
+        schema,
+        schemaName,
+    });
+}
+
+/*
+    Deprecated - Schema-backed adapters will use standard graphql types re-exported from @luvio/graphql
+*/
 export {
     BooleanValueNode,
     FloatValueNode,