grats - npm Package Compare versions

Comparing version 0.0.0-main-650020d8 to 0.0.0-main-6626f659

dist/src/Errors.d.ts

@@ -35,3 +35,3 @@ /**
 export declare function typeTagOnUnnamedClass(): string;
-export declare function typeTagOnAliasOfNonObject(): string;
+export declare function typeTagOnAliasOfNonObjectOrUnknown(): string;
 export declare function typeNameNotDeclaration(): string;
@@ -38,0 +38,0 @@ export declare function typeNameMissingInitializer(): string;

dist/src/Errors.js

 "use strict";
 exports.__esModule = true;
-exports.defaultArgPropertyMissingName = exports.defaultArgElementIsNotAssignment = exports.defaultValueIsNotLiteral = exports.ambiguousNumberType = exports.expectedOneNonNullishType = exports.propertyFieldMissingType = exports.cannotResolveSymbolForDescription = exports.promiseMissingTypeArg = exports.methodMissingType = exports.gqlEntityMissingName = exports.enumVariantMissingInitializer = exports.enumVariantNotStringLiteral = exports.enumTagOnInvalidNode = exports.argNotTyped = exports.argNameNotLiteral = exports.argIsNotProperty = exports.argumentParamIsNotObject = exports.argumentParamIsMissingType = exports.typeNameDoesNotMatchExpected = exports.typeNameTypeNotStringLiteral = exports.typeNameMissingTypeAnnotation = exports.typeNameInitializerWrong = exports.typeNameInitializeNotString = exports.typeNameMissingInitializer = exports.typeNameNotDeclaration = exports.typeTagOnAliasOfNonObject = exports.typeTagOnUnnamedClass = exports.inputFieldUntyped = exports.inputTypeFieldNotProperty = exports.inputTypeNotLiteral = exports.functionFieldNotNamedExport = exports.functionFieldDefaultExport = exports.functionFieldNotNamed = exports.functionFieldParentTypeNotValid = exports.functionFieldParentTypeMissing = exports.functionFieldNotTopLevel = exports.invalidReturnTypeForFunctionField = exports.invalidParentArgForFunctionField = exports.expectedUnionTypeReference = exports.expectedUnionTypeNode = exports.invalidUnionTagUsage = exports.invalidInputTagUsage = exports.invalidEnumTagUsage = exports.invalidInterfaceTagUsage = exports.invalidScalarTagUsage = exports.invalidTypeTagUsage = exports.invalidGratsTag = exports.wrongCasingForGratsTag = exports.killsParentOnExceptionOnWrongNode = exports.fieldTagOnWrongNode = void 0;
+exports.defaultArgPropertyMissingName = exports.defaultArgElementIsNotAssignment = exports.defaultValueIsNotLiteral = exports.ambiguousNumberType = exports.expectedOneNonNullishType = exports.propertyFieldMissingType = exports.cannotResolveSymbolForDescription = exports.promiseMissingTypeArg = exports.methodMissingType = exports.gqlEntityMissingName = exports.enumVariantMissingInitializer = exports.enumVariantNotStringLiteral = exports.enumTagOnInvalidNode = exports.argNotTyped = exports.argNameNotLiteral = exports.argIsNotProperty = exports.argumentParamIsNotObject = exports.argumentParamIsMissingType = exports.typeNameDoesNotMatchExpected = exports.typeNameTypeNotStringLiteral = exports.typeNameMissingTypeAnnotation = exports.typeNameInitializerWrong = exports.typeNameInitializeNotString = exports.typeNameMissingInitializer = exports.typeNameNotDeclaration = exports.typeTagOnAliasOfNonObjectOrUnknown = exports.typeTagOnUnnamedClass = exports.inputFieldUntyped = exports.inputTypeFieldNotProperty = exports.inputTypeNotLiteral = exports.functionFieldNotNamedExport = exports.functionFieldDefaultExport = exports.functionFieldNotNamed = exports.functionFieldParentTypeNotValid = exports.functionFieldParentTypeMissing = exports.functionFieldNotTopLevel = exports.invalidReturnTypeForFunctionField = exports.invalidParentArgForFunctionField = exports.expectedUnionTypeReference = exports.expectedUnionTypeNode = exports.invalidUnionTagUsage = exports.invalidInputTagUsage = exports.invalidEnumTagUsage = exports.invalidInterfaceTagUsage = exports.invalidScalarTagUsage = exports.invalidTypeTagUsage = exports.invalidGratsTag = exports.wrongCasingForGratsTag = exports.killsParentOnExceptionOnWrongNode = exports.fieldTagOnWrongNode = void 0;
 exports.multipleContextTypes = exports.unexpectedParamSpreadForContextParam = exports.expectedTypeAnnotationOnContextToHaveDeclaration = exports.expectedTypeAnnotationOnContextToBeResolvable = exports.expectedTypeAnnotationOfReferenceOnContext = exports.expectedTypeAnnotationOnContext = exports.unresolvedTypeReference = exports.invalidTypePassedToFieldFunction = exports.parameterPropertyMissingType = exports.parameterPropertyNotPublic = exports.parameterWithoutModifiers = exports.duplicateInterfaceTag = exports.duplicateTag = exports.implementsTagOnTypeAlias = exports.implementsTagOnInterface = exports.implementsTagOnClass = exports.implementsTagMissingValue = exports.mergedInterfaces = exports.nonNullTypeCannotBeOptional = exports.killsParentOnExceptionOnNullable = exports.killsParentOnExceptionWithWrongConfig = exports.expectedIdentifier = exports.pluralTypeMissingParameter = exports.unknownGraphQLType = exports.unsupportedTypeLiteral = exports.defaultArgPropertyMissingInitializer = void 0;
@@ -119,6 +119,6 @@ var Extractor_1 = require("./Extractor");
 exports.typeTagOnUnnamedClass = typeTagOnUnnamedClass;
-function typeTagOnAliasOfNonObject() {
-    return "Expected `@".concat(Extractor_1.TYPE_TAG, "` type to be a type literal. For example: `type Foo = { bar: string }`");
+function typeTagOnAliasOfNonObjectOrUnknown() {
+    return "Expected `@".concat(Extractor_1.TYPE_TAG, "` type to be a type literal or `unknown`. For example: `type Foo = { bar: string }` or `type Query = unknown`.");
 }
-exports.typeTagOnAliasOfNonObject = typeTagOnAliasOfNonObject;
+exports.typeTagOnAliasOfNonObjectOrUnknown = typeTagOnAliasOfNonObjectOrUnknown;
 function typeNameNotDeclaration() {
@@ -125,0 +125,0 @@ return "Expected `__typename` to be a property declaration.";

dist/src/Extractor.js

@@ -457,11 +457,19 @@ "use strict";
             return null;
-        if (!ts.isTypeLiteralNode(node.type)) {
-            this.reportUnhandled(node.type, "type", E.typeTagOnAliasOfNonObject());
-            return;
+        var fields = [];
+        var interfaces = null;
+        if (ts.isTypeLiteralNode(node.type)) {
+            fields = this.collectFields(node.type);
+            interfaces = this.collectInterfaces(node);
+            this.checkForTypenameProperty(node.type, name.value);
         }
+        else if (node.type.kind === ts.SyntaxKind.UnknownKeyword) {
+            // This is fine, we just don't know what it is. This should be the expected
+            // case for operation types such as `Query`, `Mutation`, and `Subscription`
+            // where there is not strong convention around.
+        }
+        else {
+            return this.report(node.type, E.typeTagOnAliasOfNonObjectOrUnknown());
+        }
         var description = this.collectDescription(node.name);
-        var fields = this.collectFields(node.type);
-        var interfaces = this.collectInterfaces(node);
         this.ctx.recordTypeName(node.name, name, "TYPE");
-        this.checkForTypenameProperty(node.type, name.value);
         this.definitions.push(this.gql.objectTypeDefinition(node, name, fields, interfaces, description));
@@ -468,0 +476,0 @@ };

dist/src/tests/test.js

@@ -122,2 +122,3 @@ "use strict";
 });
+var gratsDir = path.join(__dirname, "../..");
 var fixturesDir = path.join(__dirname, "fixtures");
@@ -188,5 +189,2 @@ var integrationFixturesDir = path.join(__dirname, "integrationFixtures");
                         }
-                        if (server.Query == null || typeof server.Query !== "function") {
-                            throw new Error("Expected `".concat(filePath, "` to export a Query type as `Query`"));
-                        }
                         options = {
@@ -197,3 +195,8 @@ nullableByDefault: true
                         parsedOptions = {
-                            options: {},
+                            options: {
+                                // Required to enable ts-node to locate function exports
+                                rootDir: gratsDir,
+                                outDir: "dist",
+                                configFilePath: "tsconfig.json"
+                            },
                             raw: {
@@ -213,3 +216,3 @@ grats: options
                                 source: server.query,
-                                rootValue: new server.Query()
+                                rootValue: server.Query != null ? new server.Query() : null
                             })];
@@ -216,0 +219,0 @@ case 2:

package.json

 {
   "name": "grats",
-  "version": "0.0.0-main-650020d8",
+  "version": "0.0.0-main-6626f659",
   "main": "dist/src/index.js",
@@ -5,0 +5,0 @@ "bin": "dist/src/cli.js",

README.md

@@ -17,3 +17,3 @@ # -=[ ALPHA SOFTWARE ]=-
 By making your TypeScript implementation the source of truth, you never have to
-worry about valuating that your implementation matches your schema. Your
+worry about validating that your implementation matches your schema. Your
 implementation _is_ your schema!
@@ -20,0 +20,0 @@

No alert changes

Improved metrics

Total package byte prevSize

209038

increased by0.48%

Number of package files

49

increased by4.26%

Lines of code

4324

increased by0.6%

No dependency changes