fix all docs to SchemaRoot instead of Schema

Author: capaj

README.md

@@ -34,9 +34,9 @@ query {
 ```
 
 ```ts
-import { Schema, Query, compileSchema } from 'decapi'
+import { SchemaRoot, Query, compileSchema } from 'decapi'
 
-@Schema()
+@SchemaRoot()
 class SuperSchema {
   @Query()
   hello(name: string): string {
@@ -87,7 +87,7 @@ Such query will have a bit more code and here it is:
 
 ```ts
 import {
-  Schema,
+  SchemaRoot,
   Query,
   ObjectType,
   Field,
@@ -109,7 +109,7 @@ class Product {
   }
 }
 
-@Schema()
+@SchemaRoot()
 class SuperSchema {
   @Mutation()
   createProduct(name: string, price: number): Product {

docs/explore/duplex-type-and-duplex-field.mdx

@@ -20,7 +20,7 @@ class User {
   password_hash: string
 }
 
-@Schema()
+@SchemaRoot()
 class SuperSchema {
   @Mutation()
   createUser(data: User): User {

docs/explore/schema/Schema.mdx

@@ -13,12 +13,12 @@ decapi is set of decorators allowing creating GraphQL APIs quickly and in type-s
 
 Schema is main building block of any `graphql` schema. It'll join all parts of our api together.
 
-In `decapi` to create schema, we need to pass a class decorated with `@Schema` to `compileSchema` function
+In `decapi` to create schema, we need to pass a class decorated with `@SchemaRoot` to `compileSchema` function
 
 ```js
-import { Schema, compileSchema} from 'decapi
+import { SchemaRoot, compileSchema} from 'decapi
 
-@Schema()
+@SchemaRoot()
 class SuperSchema {
   // fields implementation
 }
@@ -28,7 +28,7 @@ const compiledSchema = compileSchema(SuperSchema);
 
 `compiledSchema` from example above is standard, regular `graphql` schema.
 
-You can also pass an array of classes decorated with `@Schema`-any non trivial app will probably require more than one class to expose all it's API root logic.
+You can also pass an array of classes decorated with `@SchemaRoot`-any non trivial app will probably require more than one class to expose all it's API root logic.
 
 ## Adding Query and Mutation fields
 
@@ -45,9 +45,9 @@ Very simple fully working schema like
 Could be implemented as:
 
 ```js
-import { Schema, Query, compileSchema} from 'decapi
+import { SchemaRoot, Query, compileSchema} from 'decapi
 
-@Schema()
+@SchemaRoot()
 class SuperSchema {
   @Query()
   hello(): string {
@@ -71,9 +71,9 @@ Let's add some customization to our schema:
 With tiny change in our code:
 
 ```js
-import { Schema, Query, compileSchema} from 'decapi
+import { SchemaRoot, Query, compileSchema} from 'decapi
 
-@Schema()
+@SchemaRoot()
 class SuperSchema {
   @Query()
   hello(name: string): string {
@@ -101,7 +101,7 @@ mutation {
 Such query will have a bit more code and here it is:
 
 ```js
-import { Schema, Query, ObjectType, Field, Mutation, compileSchema} from 'decapi;
+import { SchemaRoot, Query, ObjectType, Field, Mutation, compileSchema} from 'decapi;
 
 @ObjectType({ description: 'Simple product object type' })
 class Product {
@@ -117,7 +117,7 @@ class Product {
   }
 }
 
-@Schema()
+@SchemaRoot()
 class SuperSchema {
   @Mutation()
   createProduct(name: string, price: number): Product {

docs/getting-started/minimal-example.mdx

@@ -19,7 +19,7 @@ Schema able to handle such query:
 Can be created with:
 
 ```ts
-import { Schema, Query, ObjectType, Field, compileSchema } from 'decapi'
+import { SchemaRoot, Query, ObjectType, Field, compileSchema } from 'decapi'
 
 @ObjectType()
 class Hello {
@@ -29,7 +29,7 @@ class Hello {
   }
 }
 
-@Schema()
+@SchemaRoot()
 class MyFirstSchema {
   @Query()
   hello(): Hello {

docs/reference/api-reference.mdx

@@ -187,23 +187,23 @@ type HookExecutor = (data: HookExecutorResolverArgs) => any | Promise<any>;
 @After(hook: HookExecutor);
 ```
 
-## @Schema
+## @SchemaRoot
 
 ```ts
-@Schema(): ClassDecorator;
+@SchemaRoot(): ClassDecorator;
 ```
 
 ### @Query
 
-Has same interface as [@Field](#field) decorator. Can be used only inside @Schema class
+Has same interface as [@Field](#field) decorator. Can be used only inside @SchemaRoot class
 
 ### @Mutation
 
-Has same interface as [@Field](#field) decorator. Can be used only inside @Schema class
+Has same interface as [@Field](#field) decorator. Can be used only inside @SchemaRoot class
 
 ### @QueryAndMutation
 
-A shorthand for both Query And Mutation. Can be used only inside @Schema class
+A shorthand for both Query And Mutation. Can be used only inside @SchemaRoot class
 
 ## @Union
 

examples/basic-express-server/README.md

@@ -12,10 +12,10 @@ Here is all the server code required:
 
 ```ts
 import express from 'express'
-import { Schema, Query, compileSchema } from 'decapi'
+import { SchemaRoot, Query, compileSchema } from 'decapi'
 import graphqlHTTP from 'express-graphql'
 
-@Schema()
+@SchemaRoot()
 class SuperSchema {
   @Query()
   hello(name: string): string {

examples/custom-decorators/README.md

@@ -7,7 +7,7 @@ Doing it is quite simple. You'd need to define custom function that returns call
 Let's say we want to define custom field decorator that always has `String` type and requires field description (that originally would be optional)
 
 ```ts
-import { Schema, Query, Field, ObjectType, compileSchema } from 'decapi'
+import { SchemaRoot, Query, Field, ObjectType, compileSchema } from 'decapi'
 
 function StringWithDescription(fieldDescription: string) {
   if (!fieldDescription) {

examples/custom-decorators/index.ts

@@ -1,5 +1,4 @@
 import express from 'express'
-import { Schema, Query, compileSchema } from 'decapi'
 import graphqlHTTP from 'express-graphql'
 
 import { schema } from './schema'

examples/serverless/README.md

@@ -13,10 +13,10 @@ query {
 As schema compiled by `compileSchema` is regular, normal GraphQLSchema, we can simply use it with `apollo-server-lambda` that will handle everything.
 
 ```ts
-import { Schema, Query, compileSchema } from 'decapi'
+import { SchemaRoot, Query, compileSchema } from 'decapi'
 import { graphqlLambda, graphiqlLambda } from 'apollo-server-lambda'
 
-@Schema()
+@SchemaRoot()
 class MySchema {
   @Query()
   hello(name: string): string {

examples/typeorm-basic-integration/README.md

@@ -71,7 +71,7 @@ export class User extends BaseEntity {
 After model is ready, let's define some api interface with some mutation and queries
 
 ```ts
-@Schema()
+@SchemaRoot()
 class ApiSchema {
   @Query({ type: [User] }) // as function return type is Promise of user, we need to set type manually as array of users
   async getAllUsers(): Promise<User[]> {

package.json

@@ -55,11 +55,11 @@
     "rimraf": "^3.0.0",
     "rollup": "^1.21.0",
     "rollup-plugin-typescript2": "^0.24.0",
-    "ts-jest": "^24.0.2",
+    "ts-jest": "^24.1.0",
     "tslint": "^5.19.0",
     "tslint-config-prettier": "^1.18.0",
     "tslint-sonarts": "^1.9.0",
-    "typescript": "^3.6.2"
+    "typescript": "^3.6.3"
   },
   "peerDependencies": {
     "graphql": "^0.13 || ^14"

src/domains/field/compiler/fieldCompiler.ts

@@ -62,7 +62,7 @@ function getAllFields(target: Function) {
       throw new FieldError(
         target,
         fieldName,
-        `Given field is root field (@Query or @Mutation) not registered inside @Schema type. `
+        `Given field is root field (@Query or @Mutation) not registered inside @SchemaRoot type. `
       )
     }
 

src/domains/field/special-fields.spec.ts

@@ -1,7 +1,7 @@
 import { ObjectType, Query, compileObjectType } from '../..'
 
 describe('Special fields - @Query, @Mutation @Subscribe', () => {
-  it('Will not allow registering special type on type that is not @Schema', () => {
+  it('Will not allow registering special type on type that is not @SchemaRoot', () => {
     @ObjectType()
     class Foo {
       @Query()
@@ -13,7 +13,7 @@ describe('Special fields - @Query, @Mutation @Subscribe', () => {
     expect(() => {
       return compileObjectType(Foo).getFields()
     }).toThrowErrorMatchingInlineSnapshot(
-      `"@ObjectType Foo.bar: Given field is root field (@Query or @Mutation) not registered inside @Schema type. "`
+      `"@ObjectType Foo.bar: Given field is root field (@Query or @Mutation) not registered inside @SchemaRoot type. "`
     )
   })
 })

src/domains/schema/SchemaRoot.spec.ts

@@ -17,17 +17,21 @@ import {
 } from 'graphql'
 
 describe('@SchemaRoot', () => {
-  it('should not allow compiling schema not decorated with @Schema', () => {
+  it('should not allow compiling schema not decorated with @SchemaRoot', () => {
     class Foo {}
 
-    expect(() => compileSchema([Foo])).toThrowErrorMatchingSnapshot()
+    expect(() => compileSchema([Foo])).toThrowErrorMatchingInlineSnapshot(
+      `"@SchemaRoot Foo: Schema root must be registered with @SchemaRoot"`
+    )
   })
 
-  it('should not allow @Schema without any @Query field', () => {
+  it('should not allow @SchemaRoot without any @Query field', () => {
     @SchemaRoot()
     class Foo {}
 
-    expect(() => compileSchema([Foo])).toThrowErrorMatchingSnapshot()
+    expect(() => compileSchema([Foo])).toThrowErrorMatchingInlineSnapshot(
+      `"At least one of schema roots must have @Query root field."`
+    )
   })
 
   it('should generate all schema fields properly for valid schema', async () => {
@@ -133,7 +137,9 @@ describe('@SchemaRoot', () => {
 
     expect(() =>
       compileSchema([FooSchema, BarSchema])
-    ).toThrowErrorMatchingSnapshot()
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"At least one of schema roots must have @Query root field."`
+    )
   })
 
   it('will not allow multiple schema roots to have conflicting root field names', async () => {
@@ -155,7 +161,9 @@ describe('@SchemaRoot', () => {
 
     expect(() =>
       compileSchema([FooSchema, BarSchema])
-    ).toThrowErrorMatchingSnapshot()
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"@SchemaRoot BarSchema: Duplicate of root field name: 'foo'. Seems this name is also used inside other schema root."`
+    )
   })
 
   it('will not allow schema with incorrect object types', async () => {
@@ -175,7 +183,9 @@ describe('@SchemaRoot', () => {
       }
     }
 
-    expect(() => compileSchema([FooSchema])).toThrowErrorMatchingSnapshot()
+    expect(() => compileSchema([FooSchema])).toThrowErrorMatchingInlineSnapshot(
+      `"@ObjectType Hello.world: Field type was infered as \\"function Promise() { [native code] }\\" so it's required to explicitly set the type as it's not possible to guess it. Pass it in a config for the field like: @Field({ type: ItemType })"`
+    )
   })
 
   it('should support schema root instance properties', async () => {

src/domains/schema/__snapshots__/SchemaRoot.spec.ts.snap

@@ -968,13 +968,3 @@ In some cases, you need to provide options to alter GraphQL's execution behavior
   },
 }
 `;
-
-exports[`@SchemaRoot should not allow @Schema without any @Query field 1`] = `"At least one of schema roots must have @Query root field."`;
-
-exports[`@SchemaRoot should not allow compiling schema not decorated with @Schema 1`] = `"@Schema Foo: Schema root must be registered with @SchemaRoot"`;
-
-exports[`@SchemaRoot should not allow schema that has only mutation fields 1`] = `"At least one of schema roots must have @Query root field."`;
-
-exports[`@SchemaRoot will not allow multiple schema roots to have conflicting root field names 1`] = `"@Schema BarSchema: Duplicate of root field name: 'foo'. Seems this name is also used inside other schema root."`;
-
-exports[`@SchemaRoot will not allow schema with incorrect object types 1`] = `"@ObjectType Hello.world: Field type was infered as \\"function Promise() { [native code] }\\" so it's required to explicitly set the type as it's not possible to guess it. Pass it in a config for the field like: @Field({ type: ItemType })"`;

src/domains/schema/error.ts

@@ -2,15 +2,15 @@ import { BaseError } from '../../services/error'
 
 export class SchemaRootError extends BaseError {
   constructor(target: Function, msg: string) {
-    const fullMsg = `@Schema ${target.name}: ${msg}`
+    const fullMsg = `@SchemaRoot ${target.name}: ${msg}`
     super(fullMsg)
     this.message = fullMsg
   }
 }
 
 export class SchemaFieldError extends BaseError {
   constructor(target: Function, fieldName: string, msg: string) {
-    const fullMsg = `@Schema ${target.name}.${fieldName}: ${msg}`
+    const fullMsg = `@SchemaRoot ${target.name}.${fieldName}: ${msg}`
     super(fullMsg)
     this.message = fullMsg
   }

src/domains/schema/rootFields.ts

@@ -26,7 +26,7 @@ function requireSchemaRoot(target: Function, fieldName: string) {
   throw new SchemaFieldError(
     target,
     fieldName,
-    `Root field must be registered on class decorated with @Schema`
+    `Root field must be registered on class decorated with @SchemaRoot`
   )
 }
 

yarn.lock

@@ -6638,6 +6638,11 @@ lodash.iteratee@^4.5.0:
   resolved "https://registry.yarnpkg.com/lodash.iteratee/-/lodash.iteratee-4.7.0.tgz#be4177db289a8ccc3c0990f1db26b5b22fc1554c"
   integrity sha1-vkF32yiajMw8CZDx2ya1si/BVUw=
 
+[email protected]:
+  version "4.1.2"
+  resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe"
+  integrity sha1-vMbEmkKihA7Zl/Mj6tpezRguC/4=
+
 lodash.sortby@^4.7.0:
   version "4.7.0"
   resolved "https://registry.yarnpkg.com/lodash.sortby/-/lodash.sortby-4.7.0.tgz#edd14c824e2cc9c1e0b0a1b42bb5210516a42438"
@@ -10153,15 +10158,16 @@ tryer@^1.0.1:
   resolved "https://registry.yarnpkg.com/tryer/-/tryer-1.0.1.tgz#f2c85406800b9b0f74c9f7465b81eaad241252f8"
   integrity sha512-c3zayb8/kWWpycWYg87P71E1S1ZL6b6IJxfb5fvsUgsf0S2MVGaDhDXXjDMpdCpfWXqptc+4mXwmiy1ypXqRAA==
 
-ts-jest@^24.0.2:
-  version "24.0.2"
-  resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-24.0.2.tgz#8dde6cece97c31c03e80e474c749753ffd27194d"
-  integrity sha512-h6ZCZiA1EQgjczxq+uGLXQlNgeg02WWJBbeT8j6nyIBRQdglqbvzDoHahTEIiS6Eor6x8mK6PfZ7brQ9Q6tzHw==
+ts-jest@^24.1.0:
+  version "24.1.0"
+  resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-24.1.0.tgz#2eaa813271a2987b7e6c3fefbda196301c131734"
+  integrity sha512-HEGfrIEAZKfu1pkaxB9au17b1d9b56YZSqz5eCVE8mX68+5reOvlM93xGOzzCREIov9mdH7JBG+s0UyNAqr0tQ==
   dependencies:
     bs-logger "0.x"
     buffer-from "1.x"
     fast-json-stable-stringify "2.x"
     json5 "2.x"
+    lodash.memoize "4.x"
     make-error "1.x"
     mkdirp "0.x"
     resolve "1.x"
@@ -10268,10 +10274,10 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.3.4000.tgz#76b0f89cfdbf97827e1112d64f283f1151d6adf0"
   integrity sha512-jjOcCZvpkl2+z7JFn0yBOoLQyLoIkNZAs/fYJkUG6VKy6zLPHJGfQJYFHzibB6GJaF/8QrcECtlQ5cpvRHSMEA==
 
-typescript@^3.6.2:
-  version "3.6.2"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.6.2.tgz#105b0f1934119dde543ac8eb71af3a91009efe54"
-  integrity sha512-lmQ4L+J6mnu3xweP8+rOrUwzmN+MRAj7TgtJtDaXE5PMyX2kCrklhg3rvOsOIfNeAWMQWO2F1GPc1kMD2vLAfw==
+typescript@^3.6.3:
+  version "3.6.3"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.6.3.tgz#fea942fabb20f7e1ca7164ff626f1a9f3f70b4da"
+  integrity sha512-N7bceJL1CtRQ2RiG0AQME13ksR7DiuQh/QehubYcghzv20tnh+MQnQIuJddTmsbqYj+dztchykemz0zFzlvdQw==
 
 ua-parser-js@^0.7.18:
   version "0.7.20"