@xyd-js/gql 0.1.0-xyd.13 → 0.1.0-xyd.15

package/src/hydration/gql-types.ts

@@ -1,50 +0,0 @@
-import {GraphQLEnumType} from "graphql";
-
-import {GraphQLScalarType} from "@graphql-markdown/types";
-
-import type {DefinitionProperty, Reference} from "@xyd-js/uniform";
-
-// gqlEnumToUniformRef is a helper function to convert a GraphQL enum type into a 'uniform' reference.
-export function gqlEnumToUniformRef(gqlType: GraphQLEnumType): Reference {
-    const props: DefinitionProperty[] = gqlType.getValues().map(value => ({
-        name: value.name,
-        type: "string",
-        description: value.description || "",
-    }))
-
-    return {
-        title: gqlType.name,
-        description: gqlType.description || "",
-        canonical: `enum-${gqlType.name}`, // TODO: better solution
-        context: {
-            graphqlName: gqlType.name,
-            graphqlTypeShort: "enum" // TODO: better solution
-        },
-        definitions: [
-            {
-                title: "Valid values",
-                properties: props
-            }
-        ],
-        examples: {
-            groups: []
-        }
-    } as Reference
-}
-
-// gqlScalarToUniformRef is a helper function to convert a GraphQL scalar type into a 'uniform' reference.
-export function gqlScalarToUniformRef(gqlType: GraphQLScalarType): Reference {
-    return {
-        title: gqlType.name,
-        description: gqlType.description || "",
-        canonical: `scalar-${gqlType.name}`, // TODO: better solution
-        context: {
-            graphqlName: gqlType.name,
-            graphqlTypeShort: "scalar" // TODO: better solution
-        },
-        definitions: [],
-        examples: {
-            groups: []
-        }
-    } as Reference
-}

package/src/samples/index.ts

@@ -1,95 +0,0 @@
-import {jsonToGraphQLQuery, VariableType} from "json-to-graphql-query";
-
-import {
-    DefinitionProperty,
-    ReferenceType
-} from "@xyd-js/uniform";
-
-// simpleGraphqlExample is a helper function to create a simple GraphQL example query or mutation.
-export function simpleGraphqlExample(
-    operationType: ReferenceType.GRAPHQL_QUERY | ReferenceType.GRAPHQL_MUTATION,
-    operationName: string,
-    args: DefinitionProperty[],
-    returns: DefinitionProperty[],
-) {
-    let obj: any = {}
-
-    switch (operationType) {
-        case ReferenceType.GRAPHQL_QUERY: {
-            const exampleReturnProps = exampleReturns(returns)
-
-            obj = {
-                query: {
-                    __name: operationName,
-                    [operationName]: exampleReturnProps
-                }
-            }
-
-            break
-        }
-        case ReferenceType.GRAPHQL_MUTATION: {
-            const exampleReturnProps = exampleReturns(returns)
-            const vars = exampleVariables(args)
-            const argumen = exampleArguments(args)
-
-            obj = {
-                mutation: {
-                    __name: operationName,
-                    __variables: vars,
-                    [operationName]: {
-                        ...exampleReturnProps,
-                        __args: argumen,
-                    }
-                }
-            }
-
-            break;
-        }
-    }
-
-    return jsonToGraphQLQuery(obj, {pretty: true});
-}
-
-// exampleReturns return an example of return GraphQL object
-function exampleReturns(
-    properties: DefinitionProperty[],
-    obj: any = {}
-) {
-    properties.forEach((property) => {
-        // TODO: only if required?
-        obj[property.name] = true
-
-        if (property?.properties?.length) {
-            obj[property.name] = {}
-            exampleReturns(property.properties, obj[property.name])
-        }
-    })
-
-    return obj
-}
-
-// exampleArguments return an example of GraphQL arguments
-function exampleArguments(
-    properties: DefinitionProperty[],
-    obj: any = {}
-) {
-
-    properties.forEach((property) => {
-        obj[property.name] = new VariableType(property.name)
-    })
-
-    return obj
-}
-
-// exampleVariables return an example of GraphQL variables
-function exampleVariables(
-    properties: DefinitionProperty[],
-    obj: any = {}
-) {
-
-    properties.forEach((property) => {
-        obj[property.name] = property.type
-    })
-
-    return obj
-}

package/test/graphql-types.0.test.ts

@@ -1,125 +0,0 @@
-import path from "path";
-
-import {beforeEach, describe, expect, it} from 'vitest'
-
-import {gqlSchemaToReferences} from "../src";
-
-describe('graphql-types', async () => {
-    beforeEach(() => {
-    })
-
-    it('0.basic', async () => {
-        const schemaLocation = path.join(process.cwd(), "./examples/graphql-types/graphql-types.0.basic.graphqls")
-
-        const references = await gqlSchemaToReferences(schemaLocation)
-
-        const equal = [
-            {
-                "canonical": "Date",
-                "description": "This is a custom scalar type for Date.",
-                "context": {
-                    "graphqlName": "Date",
-                    "graphqlType": "scalar"
-                },
-                "definitions": [],
-                "examples": {
-                    "groups": []
-                },
-                "title": "Date"
-            },
-            {
-                "canonical": "Role",
-                "description": "This is a custom enum type for Role.",
-                "context": {
-                    "graphqlName": "Role",
-                    "graphqlType": "enum"
-                },
-                "definitions": [
-                    {
-                        "properties": [
-                            {
-                                "description": "",
-                                "name": "ADMIN",
-                                "type": "string"
-                            },
-                            {
-                                "description": "",
-                                "name": "OWNER",
-                                "type": "string"
-                            }
-                        ],
-                        "title": "Valid values"
-                    }
-                ],
-                "examples": {
-                    "groups": []
-                },
-                "title": "Role"
-            },
-            {
-                "title": "BookInput",
-                "description": "This is a custom input type for Book.",
-                "canonical": "BookInput",
-                "context": {
-                    "graphqlName": "BookInput",
-                    "graphqlType": "input"
-                },
-                "definitions": [
-                    {
-                        "title": "Fields",
-                        "properties": [
-                            {
-                                "name": "title",
-                                "type": "String!",
-                                "description": "",
-                                "properties": []
-                            },
-                            {
-                                "name": "author",
-                                "type": "String!",
-                                "description": "",
-                                "properties": []
-                            }
-                        ]
-                    }
-                ],
-                "examples": {
-                    "groups": []
-                }
-            },
-            {
-                "title": "Book",
-                "description": "This is a custom type for Book.",
-                "canonical": "Book",
-                "context": {
-                    "graphqlName": "Book",
-                    "graphqlType": "object"
-                },
-                "definitions": [
-                    {
-                        "title": "Fields",
-                        "properties": [
-                            {
-                                "name": "title",
-                                "type": "String!",
-                                "description": "",
-                                "properties": []
-                            },
-                            {
-                                "name": "author",
-                                "type": "String!",
-                                "description": "",
-                                "properties": []
-                            }
-                        ]
-                    }
-                ],
-                "examples": {
-                    "groups": []
-                }
-            }
-        ]
-
-        expect(references).toEqual(equal)
-    })
-})

package/test/nested-arg.0.test.ts

@@ -1,208 +0,0 @@
-import path from "path";
-
-import {beforeEach, describe, expect, it} from 'vitest'
-
-import {gqlSchemaToReferences} from "../src";
-
-describe('nested-arg', async () => {
-    beforeEach(() => {
-    })
-
-    it('0.required', async () => {
-        const schemaLocation = path.join(process.cwd(), "./examples/nested/nested-arg.0.required.graphqls")
-
-        const references = await gqlSchemaToReferences(schemaLocation)
-
-        const equal = [
-            {
-                "title": "addBook",
-                "canonical": "addBook",
-                "description": "",
-                "category": "graphql",
-                "type": "graphql_mutation",
-                "examples": {
-                    "groups": [
-                        {
-                            "description": "Example request",
-                            "examples": [
-                                {
-                                    "codeblock": {
-                                        "tabs": [
-                                            {
-                                                "title": "graphql",
-                                                "language": "graphql",
-                                                "code": "mutation addBook ($bookInput: BookInput) {\n    addBook (bookInput: $bookInput)\n}"
-                                            }
-                                        ]
-                                    }
-                                }
-                            ]
-                        }
-                    ]
-                },
-                "definitions": [
-                    {
-                        "title": "Arguments",
-                        "properties": [
-                            {
-                                "name": "bookInput",
-                                "type": "BookInput",
-                                "description": "",
-                                "properties": [
-                                    {
-                                        "name": "title",
-                                        "type": "String!",
-                                        "description": "",
-                                        "properties": []
-                                    },
-                                    {
-                                        "name": "author",
-                                        "type": "String!",
-                                        "description": "",
-                                        "properties": []
-                                    }
-                                ]
-                            }
-                        ]
-                    },
-                    {
-                        "title": "Returns",
-                        "properties": []
-                    }
-                ]
-            },
-            {
-                "title": "BookInput",
-                "description": "",
-                "canonical": "BookInput",
-                "context": {
-                    "graphqlName": "BookInput",
-                    "graphqlType": "input"
-                },
-                "definitions": [
-                    {
-                        "title": "Fields",
-                        "properties": [
-                            {
-                                "name": "title",
-                                "type": "String!",
-                                "description": "",
-                                "properties": []
-                            },
-                            {
-                                "name": "author",
-                                "type": "String!",
-                                "description": "",
-                                "properties": []
-                            }
-                        ]
-                    }
-                ],
-                "examples": {
-                    "groups": []
-                }
-            }
-        ]
-
-        expect(references).toEqual(equal)
-    })
-
-    it('0.not-required', async () => {
-        const schemaLocation = path.join(process.cwd(), "./examples/nested/nested-arg.0.not-required.graphqls")
-
-        const references = await gqlSchemaToReferences(schemaLocation)
-
-        const equal = [
-            {
-                "title": "addBook",
-                "canonical": "addBook",
-                "description": "",
-                "category": "graphql",
-                "type": "graphql_mutation",
-                "examples": {
-                    "groups": [
-                        {
-                            "description": "Example request",
-                            "examples": [
-                                {
-                                    "codeblock": {
-                                        "tabs": [
-                                            {
-                                                "title": "graphql",
-                                                "language": "graphql",
-                                                "code": "mutation addBook ($bookInput: BookInput) {\n    addBook (bookInput: $bookInput)\n}"
-                                            }
-                                        ]
-                                    }
-                                }
-                            ]
-                        }
-                    ]
-                },
-                "definitions": [
-                    {
-                        "title": "Arguments",
-                        "properties": [
-                            {
-                                "name": "bookInput",
-                                "type": "BookInput",
-                                "description": "",
-                                "properties": [
-                                    {
-                                        "name": "title",
-                                        "type": "String!",
-                                        "description": "",
-                                        "properties": []
-                                    },
-                                    {
-                                        "name": "author",
-                                        "type": "String!",
-                                        "description": "",
-                                        "properties": []
-                                    }
-                                ]
-                            }
-                        ]
-                    },
-                    {
-                        "title": "Returns",
-                        "properties": []
-                    }
-                ]
-            },
-            {
-                "title": "BookInput",
-                "description": "",
-                "canonical": "BookInput",
-                "context": {
-                    "graphqlName": "BookInput",
-                    "graphqlType": "input"
-                },
-                "definitions": [
-                    {
-                        "title": "Fields",
-                        "properties": [
-                            {
-                                "name": "title",
-                                "type": "String!",
-                                "description": "",
-                                "properties": []
-                            },
-                            {
-                                "name": "author",
-                                "type": "String!",
-                                "description": "",
-                                "properties": []
-                            }
-                        ]
-                    }
-                ],
-                "examples": {
-                    "groups": []
-                }
-            }
-        ]
-
-        expect(references).toEqual(equal)
-    })
-})

package/test/nested-arg.1.test.ts

@@ -1,19 +0,0 @@
-import path from "path";
-
-import {beforeEach, describe, expect, it} from 'vitest'
-
-import {gqlSchemaToReferences} from "../src";
-
-describe('nested-arg', async () => {
-    beforeEach(() => {
-    })
-
-    it('1.deep', async () => {
-        const schemaLocation = path.join(process.cwd(), "./examples/nested/nested-arg.1.deep.graphqls")
-
-        const references = await gqlSchemaToReferences(schemaLocation)
-
-        // console.log(JSON.stringify(references, null, 2))
-        // expect(references).toEqual()
-    })
-})