graphql-schemax - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

CHANGELOG.md

@@ -5,2 +5,4 @@ # Changelog
 
+### [0.0.6](https://github.com/nicolasdao/graphql-schemax/compare/v0.0.5...v0.0.6) (2021-10-21)
+
 ### [0.0.5](https://github.com/nicolasdao/graphql-schemax/compare/v0.0.4...v0.0.5) (2021-10-21)
@@ -7,0 +9,0 @@

package.json

 {
   "name": "graphql-schemax",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Creates GraphQL string schema from plain JSON objects.",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -100,4 +100,6 @@ # GRAPHQL-SCHEMAX
 >	- [Directives](#directives)
-> * [Manipulating schemas](#manipulating-schemas)
->	- [Merging schemas](#merging-schemas)
+> * [APIs](#apis)
+>	- [`constructor`](#constructor)
+>	- [`toString`](#tostring)
+>	- [`add`](#add)
 > * [Dev](#dev)
@@ -107,2 +109,4 @@ >	- [About this project](#about-this-project)
 >	- [Unit test](#unit-test)
+> * [FAQ](#faq)
+>	- [How to merge schemas?](#how-to-merge-schemas)
 > * [License](#license)
@@ -518,3 +522,3 @@
 
-const inlineSchema = [
+const inlineSchema01 = [
 'type Project', {
@@ -524,2 +528,7 @@ id: 'ID',
 },
+'type Query', {
+	projects: '[Project]'
+}]
+
+const inlineSchema02 = [
 'type User', {
@@ -531,7 +540,6 @@ id: 'ID',
 'type Query', {
-	projects: '[Project]',
 	users: '[User]'
 }]
 
-const schema = new Schemax(inlineSchema)
+const schema = new Schemax(inlineSchema01, inlineSchema02)
 
@@ -541,5 +549,165 @@ console.log(schema.toString())
 
-# FAQ
-## How to merge schemas?
+> __NOTICE:__ The `type Query` is defined twice. When Schemax detects multiple identical definitions, it merges them. This means that in this example, the output is equal to:
+> ```js
+> type Query {
+> 	projects: [Project]
+> 	users: [User]
+> }
+> ```
 
+Finally, the constructor also support mixing those two styles:
+
+```js
+const schema = new Schemax(inlineSchema01, 
+'type User', {
+	id: 'ID',
+	first_name: 'String',
+	last_name: 'String'
+},
+'type Query', {
+	users: '[User]'
+})
+```
+
+## `toString`
+
+Compiles the `Schemax` instance to a GraphQL string. 
+
+```js
+import { Schemax } from 'graphql-schemax'
+
+const schema = new Schemax(
+	'type Project', {
+		id: 'ID',
+		name: 'String'
+	},
+	'type User', {
+		id: 'ID',
+		first_name: 'String',
+		last_name: 'String'
+	},
+	'type Query', {
+		projects: '[Project]',
+		users: '[User]'
+	}
+)
+
+console.log(schema.toString())
+```
+
+Which outputs:
+
+```js
+type Project {
+	id: ID
+	name: String
+}
+
+type User {
+	id: ID
+	first_name: String
+	last_name: String
+}
+
+type Query {
+	projects: [Project]
+	users: [User]
+}
+
+schema {
+	query: Query
+}
+```
+
+## `add`
+
+Mutates the `Schemax` instance by adding more schemas definitions. It supports the same signature as the [`constructore`](#constructor).
+
+```js
+import { Schemax } from 'graphql-schemax'
+
+const inlineSchema01 = [
+'type Project', {
+	id: 'ID',
+	name: 'String'
+},
+'type Query', {
+	projects: '[Project]'
+}]
+
+const inlineSchema02 = [
+'type User', {
+	id: 'ID',
+	first_name: 'String',
+	last_name: 'String'
+},
+'type Query', {
+	users: '[User]'
+}]
+
+const schema = new Schemax()
+
+console.log('SAMPLE 01')
+console.log(schema.toString())
+
+schema.add(inlineSchema01)
+
+console.log('SAMPLE 02')
+console.log(schema.toString())
+
+schema.add(inlineSchema02, 
+'type Address', {
+	id: 'ID',
+	line01: 'String'
+})
+
+console.log('SAMPLE 03')
+console.log(schema.toString())
+```
+
+Which outputs:
+
+```js
+// SAMPLE 01
+
+// SAMPLE 02
+type Project {
+	id: ID
+	name: String
+}
+
+type Query {
+	projects: [Project]
+}
+
+schema {
+	query: Query
+}
+// SAMPLE 03
+type Project {
+	id: ID
+	name: String
+}
+
+type Query {
+	projects: [Project]
+	users: [User]
+}
+
+type User {
+	id: ID
+	first_name: String
+	last_name: String
+}
+
+type Address {
+	id: ID
+	line01: String
+}
+
+schema {
+	query: Query
+}
+```
+
 # Dev
@@ -566,2 +734,68 @@ ## About this project
 
+# FAQ
+## How to merge schemas?
+
+Both the [`constructor`](#constructor) and [`add`](#add) APIs support multiple schema definitions. Those schema definitions are merged when the [`toString`](#tostring) API is executed.
+
+## What happens when the same type definitions exist in multiple schemas?
+
+They are merged in a single type definition. This is how the `type Query`, `type Mutation` and `type Subscription` can be defined in multiple microservice schema and merged into a single GraphQL schema. For example:
+
+```js
+import { Schemax } from 'graphql-schemax'
+
+const inlineSchema01 = [
+'type Project', {
+	id: 'ID',
+	name: 'String'
+},
+'type Query', {
+	projects: '[Project]'
+}]
+
+const inlineSchema02 = [
+'type User', {
+	id: 'ID',
+	first_name: 'String',
+	last_name: 'String'
+},
+'type Project', {
+	sku: 'String'
+},
+'type Query', {
+	users: '[User]'
+}]
+
+const schema = new Schemax(inlineSchema01, inlineSchema02)
+
+console.log(schema.toString())
+```
+
+Outputs:
+
+```js
+type Project {
+	id: ID
+	name: String
+	sku: String
+}
+
+type Query {
+	projects: [Project]
+	users: [User]
+}
+
+type User {
+	id: ID
+	first_name: String
+	last_name: String
+}
+
+schema {
+	query: Query
+}
+```
+
+Notice that both `type Project` and `type Query` are defined twice. They are both merged in the final GraphQL schema.
+
 # License
@@ -568,0 +802,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

38799

increased by10.51%

Number of lines in readme file

827

increased by39.46%

No dependency changes