npm - @xyd-js/gql - Versions diffs - 0.1.0-xyd.4 → 0.1.0-xyd.54 - Mend

@xyd-js/gql 0.1.0-xyd.4 → 0.1.0-xyd.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (89) hide show

package/CHANGELOG.md +459 -0
package/LICENSE +21 -0
package/TODO.md +8 -0
package/__fixtures__/-1.opendocs.docs-nested/input.graphql +66 -0
package/__fixtures__/-1.opendocs.docs-nested/output.json +554 -0
package/__fixtures__/-1.opendocs.flat/input.graphql +19 -0
package/__fixtures__/-1.opendocs.flat/output.json +243 -0
package/__fixtures__/-1.opendocs.scopes/input.graphql +33 -0
package/__fixtures__/-1.opendocs.scopes/output.json +378 -0
package/__fixtures__/-1.opendocs.sidebar/input.graphql +44 -0
package/__fixtures__/-1.opendocs.sort/input.graphql +92 -0
package/__fixtures__/-1.opendocs.sort/output.json +1078 -0
package/__fixtures__/-1.opendocs.sort+group/input.graphql +111 -0
package/__fixtures__/-1.opendocs.sort+group/output.json +1114 -0
package/__fixtures__/-1.opendocs.sort+group+path/input.graphql +118 -0
package/__fixtures__/-1.opendocs.sort+group+path/output.json +1114 -0
package/__fixtures__/-2.complex.github/input.graphql +69424 -0
package/__fixtures__/-2.complex.github/output.json +269874 -0
package/__fixtures__/-2.complex.livesession/input.graphql +23 -0
package/__fixtures__/-2.complex.livesession/output.json +302 -0
package/__fixtures__/-2.complex.monday/input.graphql +6089 -0
package/__fixtures__/-2.complex.monday/output.json +1 -0
package/__fixtures__/-3.array-non-null-return/input.graphql +9 -0
package/__fixtures__/-3.array-non-null-return/output.json +151 -0
package/__fixtures__/1.basic/input.graphql +118 -0
package/__fixtures__/1.basic/output.json +630 -0
package/__fixtures__/2.circular/input.graphql +17 -0
package/__fixtures__/2.circular/output.json +248 -0
package/__fixtures__/3.opendocs/input.graphql +27 -0
package/__fixtures__/3.opendocs/output.json +338 -0
package/__fixtures__/4.union/input.graphql +19 -0
package/__fixtures__/4.union/output.json +344 -0
package/__fixtures__/5.flat/input.graphql +27 -0
package/__fixtures__/5.flat/output.json +383 -0
package/__fixtures__/6.default-values/input.graphql +47 -0
package/__fixtures__/6.default-values/output.json +655 -0
package/__fixtures__/7.type-args/input.graphql +19 -0
package/__fixtures__/7.type-args/output.json +301 -0
package/__fixtures__/8.default-sort/input.graphql +60 -0
package/__fixtures__/8.default-sort/output.json +1078 -0
package/__tests__/gqlSchemaToReferences.test.ts +109 -0
package/__tests__/utils.ts +45 -0
package/declarations.d.ts +4 -0
package/dist/index.d.ts +17 -1
package/dist/index.js +1334 -19871
package/dist/index.js.map +1 -1
package/dist/opendocs.graphql +56 -0
package/package.json +7 -9
package/src/context.ts +17 -0
package/src/converters/gql-arg.ts +51 -0
package/src/converters/gql-enum.ts +27 -0
package/src/converters/gql-field.ts +164 -0
package/src/converters/gql-input.ts +34 -0
package/src/converters/gql-interface.ts +35 -0
package/src/converters/gql-mutation.ts +36 -0
package/src/converters/gql-object.ts +83 -0
package/src/converters/gql-operation.ts +128 -0
package/src/converters/gql-query.ts +36 -0
package/src/converters/gql-sample.ts +159 -0
package/src/converters/gql-scalar.ts +16 -0
package/src/converters/gql-subscription.ts +36 -0
package/src/converters/gql-types.ts +195 -0
package/src/converters/gql-union.ts +40 -0
package/src/gql-core.ts +362 -0
package/src/opendocs.graphql +56 -0
package/src/opendocs.ts +253 -0
package/src/schema.ts +253 -67
package/src/types.ts +103 -0
package/src/utils.ts +21 -96
package/tsconfig.json +1 -1
package/tsup.config.ts +15 -1
package/vitest.config.ts +15 -1
package/examples/basic/index.ts +0 -12
package/examples/basic/schema.graphqls +0 -89
package/examples/basic/todo-app.graphqls +0 -184
package/examples/graphql-types/graphql-types.0.basic.graphqls +0 -28
package/examples/nested/nested-arg.0.not-required.graphqls +0 -8
package/examples/nested/nested-arg.0.required.graphqls +0 -8
package/examples/nested/nested-arg.1.deep.graphqls +0 -12
package/src/hydration/README.md +0 -1
package/src/hydration/gql-arg.ts +0 -53
package/src/hydration/gql-field.ts +0 -206
package/src/hydration/gql-input.ts +0 -67
package/src/hydration/gql-object.ts +0 -35
package/src/hydration/gql-types.ts +0 -50
package/src/samples/index.ts +0 -95
package/test/graphql-types.0.test.ts +0 -125
package/test/nested-arg.0.test.ts +0 -208
package/test/nested-arg.1.test.ts +0 -19

package/__fixtures__/6.default-values/output.json ADDED Viewed

@@ -0,0 +1,655 @@
+[
+  {
+    "title": "getData",
+    "description": "",
+    "canonical": "queries/getData",
+    "category": "graphql",
+    "type": "graphql_query",
+    "context": {
+      "graphqlTypeShort": "query",
+      "graphqlName": "getData",
+      "group": [
+        "Queries"
+      ],
+      "scopes": []
+    },
+    "examples": {
+      "groups": [
+        {
+          "description": "",
+          "examples": [
+            {
+              "codeblock": {
+                "tabs": [
+                  {
+                    "title": "",
+                    "language": "graphql",
+                    "code": "query getData($input: DataInput!) {\n  getData(input: $input) {\n    # getData fields\n  }\n}"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      ]
+    },
+    "definitions": [
+      {
+        "title": "Arguments",
+        "properties": [
+          {
+            "name": "input",
+            "type": "DataInput!",
+            "description": "",
+            "context": {
+              "graphqlTypeShort": "input",
+              "graphqlName": "DataInput",
+              "group": [
+                "Inputs"
+              ],
+              "scopes": []
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": "inputs/DataInput"
+            }
+          }
+        ]
+      },
+      {
+        "title": "Returns",
+        "properties": [
+          {
+            "name": "",
+            "type": "Data",
+            "description": "",
+            "context": {
+              "graphqlName": "getData",
+              "graphqlTypeFlat": "Data",
+              "graphqlBuiltInType": false
+            },
+            "properties": [],
+            "meta": [],
+            "symbolDef": {
+              "canonical": "objects/Data"
+            }
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "title": "getDataList",
+    "description": "",
+    "canonical": "queries/getDataList",
+    "category": "graphql",
+    "type": "graphql_query",
+    "context": {
+      "graphqlTypeShort": "query",
+      "graphqlName": "getDataList",
+      "group": [
+        "Queries"
+      ],
+      "scopes": []
+    },
+    "examples": {
+      "groups": [
+        {
+          "description": "",
+          "examples": [
+            {
+              "codeblock": {
+                "tabs": [
+                  {
+                    "title": "",
+                    "language": "graphql",
+                    "code": "{\n  getDataList(limit: 10) {\n    # getDataList fields\n  }\n}"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      ]
+    },
+    "definitions": [
+      {
+        "title": "Arguments",
+        "properties": [
+          {
+            "name": "limit",
+            "type": "Int!",
+            "description": "",
+            "context": {
+              "graphqlName": "limit",
+              "graphqlTypeFlat": "Int",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              },
+              {
+                "name": "defaults",
+                "value": 10
+              }
+            ],
+            "symbolDef": {
+              "canonical": "/limit"
+            }
+          },
+          {
+            "name": "offset",
+            "type": "Int",
+            "description": "",
+            "context": {
+              "graphqlName": "offset",
+              "graphqlTypeFlat": "Int",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "defaults",
+                "value": 0
+              }
+            ],
+            "symbolDef": {
+              "canonical": "/offset"
+            }
+          },
+          {
+            "name": "page",
+            "type": "Int",
+            "description": "",
+            "context": {
+              "graphqlName": "page",
+              "graphqlTypeFlat": "Int",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [],
+            "symbolDef": {
+              "canonical": "/page"
+            }
+          }
+        ]
+      },
+      {
+        "title": "Returns",
+        "properties": [
+          {
+            "name": "",
+            "type": "Data",
+            "description": "",
+            "context": {
+              "graphqlName": "getDataList",
+              "graphqlTypeFlat": "Data",
+              "graphqlBuiltInType": false
+            },
+            "properties": [],
+            "meta": [],
+            "symbolDef": {
+              "canonical": "objects/Data"
+            }
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "title": "Data",
+    "description": "",
+    "canonical": "objects/Data",
+    "category": "graphql",
+    "type": "graphql_object",
+    "context": {
+      "graphqlTypeShort": "object",
+      "graphqlName": "Data",
+      "group": [
+        "Objects"
+      ],
+      "scopes": []
+    },
+    "examples": {
+      "groups": []
+    },
+    "definitions": [
+      {
+        "title": "Arguments",
+        "properties": [],
+        "variants": [],
+        "meta": [
+          {
+            "name": "type",
+            "value": "arguments"
+          }
+        ]
+      },
+      {
+        "title": "Fields",
+        "properties": [
+          {
+            "name": "id",
+            "type": "ID!",
+            "description": "",
+            "context": {
+              "graphqlName": "id",
+              "graphqlTypeFlat": "ID",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": "/id"
+            }
+          },
+          {
+            "name": "name",
+            "type": "String!",
+            "description": "",
+            "context": {
+              "graphqlName": "name",
+              "graphqlTypeFlat": "String",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": "/name"
+            }
+          },
+          {
+            "name": "metadata",
+            "type": "Metadata!",
+            "description": "",
+            "context": {
+              "graphqlName": "metadata",
+              "graphqlTypeFlat": "Metadata",
+              "graphqlBuiltInType": false
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": "objects/Metadata"
+            }
+          }
+        ],
+        "meta": [
+          {
+            "name": "type",
+            "value": "fields"
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "title": "Metadata",
+    "description": "",
+    "canonical": "objects/Metadata",
+    "category": "graphql",
+    "type": "graphql_object",
+    "context": {
+      "graphqlTypeShort": "object",
+      "graphqlName": "Metadata",
+      "group": [
+        "Objects"
+      ],
+      "scopes": []
+    },
+    "examples": {
+      "groups": []
+    },
+    "definitions": [
+      {
+        "title": "Arguments",
+        "properties": [],
+        "variants": [],
+        "meta": [
+          {
+            "name": "type",
+            "value": "arguments"
+          }
+        ]
+      },
+      {
+        "title": "Fields",
+        "properties": [
+          {
+            "name": "active",
+            "type": "Boolean!",
+            "description": "",
+            "context": {
+              "graphqlName": "active",
+              "graphqlTypeFlat": "Boolean",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": "/active"
+            }
+          },
+          {
+            "name": "tags",
+            "type": "[String!]!",
+            "description": "",
+            "context": {
+              "graphqlName": "tags",
+              "graphqlTypeFlat": "String",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": "/tags"
+            }
+          }
+        ],
+        "meta": [
+          {
+            "name": "type",
+            "value": "fields"
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "title": "DataInput",
+    "description": "",
+    "canonical": "inputs/DataInput",
+    "category": "graphql",
+    "type": "graphql_input",
+    "context": {
+      "graphqlTypeShort": "input",
+      "graphqlName": "DataInput",
+      "group": [
+        "Inputs"
+      ],
+      "scopes": []
+    },
+    "examples": {
+      "groups": []
+    },
+    "definitions": [
+      {
+        "title": "Fields",
+        "properties": [
+          {
+            "name": "name",
+            "type": "String",
+            "description": "",
+            "context": {
+              "graphqlName": "name",
+              "graphqlTypeFlat": "String",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "defaults",
+                "value": "default"
+              }
+            ],
+            "symbolDef": {
+              "canonical": "/name"
+            }
+          },
+          {
+            "name": "count",
+            "type": "Int",
+            "description": "",
+            "context": {
+              "graphqlName": "count",
+              "graphqlTypeFlat": "Int",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "defaults",
+                "value": 0
+              }
+            ],
+            "symbolDef": {
+              "canonical": "/count"
+            }
+          },
+          {
+            "name": "isActive",
+            "type": "Boolean",
+            "description": "",
+            "context": {
+              "graphqlName": "isActive",
+              "graphqlTypeFlat": "Boolean",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "defaults",
+                "value": true
+              }
+            ],
+            "symbolDef": {
+              "canonical": "/isActive"
+            }
+          },
+          {
+            "name": "role",
+            "type": "Role",
+            "description": "",
+            "context": {
+              "graphqlName": "role",
+              "graphqlTypeFlat": "Role",
+              "graphqlBuiltInType": false
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "defaults",
+                "value": "USER"
+              }
+            ],
+            "symbolDef": {
+              "canonical": "enums/Role"
+            }
+          },
+          {
+            "name": "tags",
+            "type": "[String!]",
+            "description": "",
+            "context": {
+              "graphqlName": "tags",
+              "graphqlTypeFlat": "String",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              },
+              {
+                "name": "defaults",
+                "value": [
+                  "tag1",
+                  "tag2"
+                ]
+              }
+            ],
+            "symbolDef": {
+              "canonical": "/tags"
+            }
+          },
+          {
+            "name": "metadata",
+            "type": "MetadataInput",
+            "description": "",
+            "context": {
+              "graphqlName": "metadata",
+              "graphqlTypeFlat": "MetadataInput",
+              "graphqlBuiltInType": false
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "defaults",
+                "value": {
+                  "active": true,
+                  "tags": [
+                    "default"
+                  ]
+                }
+              }
+            ],
+            "symbolDef": {
+              "canonical": "inputs/MetadataInput"
+            }
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "title": "MetadataInput",
+    "description": "",
+    "canonical": "inputs/MetadataInput",
+    "category": "graphql",
+    "type": "graphql_input",
+    "context": {
+      "graphqlTypeShort": "input",
+      "graphqlName": "MetadataInput",
+      "group": [
+        "Inputs"
+      ],
+      "scopes": []
+    },
+    "examples": {
+      "groups": []
+    },
+    "definitions": [
+      {
+        "title": "Fields",
+        "properties": [
+          {
+            "name": "active",
+            "type": "Boolean",
+            "description": "",
+            "context": {
+              "graphqlName": "active",
+              "graphqlTypeFlat": "Boolean",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "defaults",
+                "value": false
+              }
+            ],
+            "symbolDef": {
+              "canonical": "/active"
+            }
+          },
+          {
+            "name": "tags",
+            "type": "[String!]",
+            "description": "",
+            "context": {
+              "graphqlName": "tags",
+              "graphqlTypeFlat": "String",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              },
+              {
+                "name": "defaults",
+                "value": [
+                  "default"
+                ]
+              }
+            ],
+            "symbolDef": {
+              "canonical": "/tags"
+            }
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "title": "Role",
+    "description": "",
+    "canonical": "enums/Role",
+    "category": "graphql",
+    "type": "graphql_enum",
+    "context": {
+      "graphqlTypeShort": "enum",
+      "graphqlName": "Role",
+      "group": [
+        "Enums"
+      ],
+      "scopes": []
+    },
+    "examples": {
+      "groups": []
+    },
+    "definitions": [
+      {
+        "title": "Valid values",
+        "properties": [
+          {
+            "name": "USER",
+            "type": "string",
+            "description": ""
+          },
+          {
+            "name": "ADMIN",
+            "type": "string",
+            "description": ""
+          }
+        ]
+      }
+    ]
+  }
+]

package/__fixtures__/7.type-args/input.graphql ADDED Viewed

@@ -0,0 +1,19 @@
+type Book {
+    authors(
+        first: Int
+        after: String
+        limit: Int!
+    ): [Author!]!
+    libraries(
+        limit: Int!
+    ): [Library!]!
+}
+type Author {
+    name: String!
+}
+type Library {
+    name: String!
+}