npm - @xyd-js/gql - Versions diffs - 0.0.0-build - Mend

@xyd-js/gql 0.0.0-build

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 (76) hide show

package/CHANGELOG.md +10 -0
package/LICENSE +21 -0
package/README.md +3 -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 +21 -0
package/dist/index.js +1503 -0
package/dist/index.js.map +1 -0
package/dist/opendocs.graphql +56 -0
package/index.ts +3 -0
package/package.json +29 -0
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/index.ts +3 -0
package/src/opendocs.graphql +56 -0
package/src/opendocs.ts +253 -0
package/src/schema.ts +293 -0
package/src/types.ts +103 -0
package/src/utils.ts +25 -0
package/tsconfig.json +18 -0
package/tsup.config.ts +33 -0
package/tsup.examples-config.ts +30 -0
package/vitest.config.ts +21 -0

package/__fixtures__/2.circular/output.json ADDED Viewed

@@ -0,0 +1,248 @@
+[
+  {
+    "title": "getBookByTitle",
+    "description": "",
+    "canonical": "queries/getBookByTitle",
+    "category": "graphql",
+    "type": "graphql_query",
+    "context": {
+      "graphqlTypeShort": "query",
+      "graphqlName": "getBookByTitle",
+      "group": [
+        "Queries"
+      ],
+      "scopes": []
+    },
+    "examples": {
+      "groups": [
+        {
+          "description": "",
+          "examples": [
+            {
+              "codeblock": {
+                "tabs": [
+                  {
+                    "title": "",
+                    "language": "graphql",
+                    "code": "{\n  getBookByTitle(title: \"example-title\") {\n    # getBookByTitle fields\n  }\n}"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      ]
+    },
+    "definitions": [
+      {
+        "title": "Arguments",
+        "properties": [
+          {
+            "name": "title",
+            "type": "String!",
+            "description": "",
+            "context": {
+              "graphqlName": "title",
+              "graphqlTypeFlat": "String",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": ""
+            }
+          }
+        ]
+      },
+      {
+        "title": "Returns",
+        "properties": [
+          {
+            "name": "",
+            "type": "Book",
+            "description": "",
+            "context": {
+              "graphqlName": "getBookByTitle",
+              "graphqlTypeFlat": "Book",
+              "graphqlBuiltInType": false
+            },
+            "properties": [],
+            "meta": [],
+            "symbolDef": {
+              "canonical": "objects/Book"
+            }
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "title": "Author",
+    "description": "",
+    "canonical": "objects/Author",
+    "category": "graphql",
+    "type": "graphql_object",
+    "context": {
+      "graphqlTypeShort": "object",
+      "graphqlName": "Author",
+      "group": [
+        "Objects"
+      ],
+      "scopes": []
+    },
+    "examples": {
+      "groups": []
+    },
+    "definitions": [
+      {
+        "title": "Arguments",
+        "properties": [],
+        "variants": [],
+        "meta": [
+          {
+            "name": "type",
+            "value": "arguments"
+          }
+        ]
+      },
+      {
+        "title": "Fields",
+        "properties": [
+          {
+            "name": "title",
+            "type": "String!",
+            "description": "",
+            "context": {
+              "graphqlName": "title",
+              "graphqlTypeFlat": "String",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": ""
+            }
+          },
+          {
+            "name": "books",
+            "type": "[Book!]!",
+            "description": "",
+            "context": {
+              "graphqlName": "books",
+              "graphqlTypeFlat": "Book",
+              "graphqlBuiltInType": false
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": "objects/Book"
+            }
+          }
+        ],
+        "meta": [
+          {
+            "name": "type",
+            "value": "fields"
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "title": "Book",
+    "description": "",
+    "canonical": "objects/Book",
+    "category": "graphql",
+    "type": "graphql_object",
+    "context": {
+      "graphqlTypeShort": "object",
+      "graphqlName": "Book",
+      "group": [
+        "Objects"
+      ],
+      "scopes": []
+    },
+    "examples": {
+      "groups": []
+    },
+    "definitions": [
+      {
+        "title": "Arguments",
+        "properties": [],
+        "variants": [],
+        "meta": [
+          {
+            "name": "type",
+            "value": "arguments"
+          }
+        ]
+      },
+      {
+        "title": "Fields",
+        "properties": [
+          {
+            "name": "title",
+            "type": "String!",
+            "description": "",
+            "context": {
+              "graphqlName": "title",
+              "graphqlTypeFlat": "String",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": ""
+            }
+          },
+          {
+            "name": "author",
+            "type": "Author!",
+            "description": "",
+            "context": {
+              "graphqlName": "author",
+              "graphqlTypeFlat": "Author",
+              "graphqlBuiltInType": false
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": "objects/Author"
+            }
+          }
+        ],
+        "meta": [
+          {
+            "name": "type",
+            "value": "fields"
+          }
+        ]
+      }
+    ]
+  }
+]

package/__fixtures__/3.opendocs/input.graphql ADDED Viewed

@@ -0,0 +1,27 @@
+type Checkout @doc(
+    group: ["Checkout"],
+) {
+    id: ID!
+    checkoutId: String!
+    @deprecated(reason: "Use `id` instead.")
+}
+type CheckoutLine @doc(
+    group: ["Checkout"],
+) {
+    id: ID!
+    checkoutLineId: String!
+    @deprecated
+}
+type Query {
+    checkout(
+        id: ID!
+    ): Checkout
+    checkoutLine(
+        id: ID!
+    ): CheckoutLine
+}

package/__fixtures__/3.opendocs/output.json ADDED Viewed

@@ -0,0 +1,338 @@
+[
+  {
+    "title": "checkout",
+    "description": "",
+    "canonical": "queries/checkout",
+    "category": "graphql",
+    "type": "graphql_query",
+    "context": {
+      "graphqlTypeShort": "query",
+      "graphqlName": "checkout",
+      "group": [
+        "Queries"
+      ],
+      "scopes": []
+    },
+    "examples": {
+      "groups": [
+        {
+          "description": "",
+          "examples": [
+            {
+              "codeblock": {
+                "tabs": [
+                  {
+                    "title": "",
+                    "language": "graphql",
+                    "code": "query checkout($id: ID!) {\n  checkout(id: $id) {\n    # checkout fields\n  }\n}"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      ]
+    },
+    "definitions": [
+      {
+        "title": "Arguments",
+        "properties": [
+          {
+            "name": "id",
+            "type": "ID!",
+            "description": "",
+            "context": {
+              "graphqlName": "id",
+              "graphqlTypeFlat": "ID",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": ""
+            }
+          }
+        ]
+      },
+      {
+        "title": "Returns",
+        "properties": [
+          {
+            "name": "",
+            "type": "Checkout",
+            "description": "",
+            "context": {
+              "graphqlName": "checkout",
+              "graphqlTypeFlat": "Checkout",
+              "graphqlBuiltInType": false
+            },
+            "properties": [],
+            "meta": [],
+            "symbolDef": {
+              "canonical": "objects/Checkout"
+            }
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "title": "checkoutLine",
+    "description": "",
+    "canonical": "queries/checkoutLine",
+    "category": "graphql",
+    "type": "graphql_query",
+    "context": {
+      "graphqlTypeShort": "query",
+      "graphqlName": "checkoutLine",
+      "group": [
+        "Queries"
+      ],
+      "scopes": []
+    },
+    "examples": {
+      "groups": [
+        {
+          "description": "",
+          "examples": [
+            {
+              "codeblock": {
+                "tabs": [
+                  {
+                    "title": "",
+                    "language": "graphql",
+                    "code": "query checkoutLine($id: ID!) {\n  checkoutLine(id: $id) {\n    # checkoutLine fields\n  }\n}"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      ]
+    },
+    "definitions": [
+      {
+        "title": "Arguments",
+        "properties": [
+          {
+            "name": "id",
+            "type": "ID!",
+            "description": "",
+            "context": {
+              "graphqlName": "id",
+              "graphqlTypeFlat": "ID",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": ""
+            }
+          }
+        ]
+      },
+      {
+        "title": "Returns",
+        "properties": [
+          {
+            "name": "",
+            "type": "CheckoutLine",
+            "description": "",
+            "context": {
+              "graphqlName": "checkoutLine",
+              "graphqlTypeFlat": "CheckoutLine",
+              "graphqlBuiltInType": false
+            },
+            "properties": [],
+            "meta": [],
+            "symbolDef": {
+              "canonical": "objects/CheckoutLine"
+            }
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "title": "Checkout",
+    "description": "",
+    "canonical": "objects/Checkout",
+    "category": "graphql",
+    "type": "graphql_object",
+    "context": {
+      "graphqlTypeShort": "object",
+      "graphqlName": "Checkout",
+      "group": [
+        "Checkout"
+      ],
+      "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": ""
+            }
+          },
+          {
+            "name": "checkoutId",
+            "type": "String!",
+            "description": "",
+            "context": {
+              "graphqlName": "checkoutId",
+              "graphqlTypeFlat": "String",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              },
+              {
+                "name": "deprecated",
+                "value": "Use `id` instead."
+              }
+            ],
+            "symbolDef": {
+              "canonical": ""
+            }
+          }
+        ],
+        "meta": [
+          {
+            "name": "type",
+            "value": "fields"
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "title": "CheckoutLine",
+    "description": "",
+    "canonical": "objects/CheckoutLine",
+    "category": "graphql",
+    "type": "graphql_object",
+    "context": {
+      "graphqlTypeShort": "object",
+      "graphqlName": "CheckoutLine",
+      "group": [
+        "Checkout"
+      ],
+      "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": ""
+            }
+          },
+          {
+            "name": "checkoutLineId",
+            "type": "String!",
+            "description": "",
+            "context": {
+              "graphqlName": "checkoutLineId",
+              "graphqlTypeFlat": "String",
+              "graphqlBuiltInType": true
+            },
+            "properties": [],
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              },
+              {
+                "name": "deprecated",
+                "value": "true"
+              }
+            ],
+            "symbolDef": {
+              "canonical": ""
+            }
+          }
+        ],
+        "meta": [
+          {
+            "name": "type",
+            "value": "fields"
+          }
+        ]
+      }
+    ]
+  }
+]

package/__fixtures__/4.union/input.graphql ADDED Viewed

@@ -0,0 +1,19 @@
+type Discount {
+    id: ID!
+}
+type Coupon {
+    id: ID!
+}
+type Refund {
+    id: ID!
+}
+union Offer = Discount | Coupon | Refund
+type Order {
+    id: ID!
+    offer: Offer
+}