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

package/examples/basic/schema.graphqls

@@ -1,89 +0,0 @@
-# TODO: !!! case with circular dependencies !!!
-
-"""
-A book type
-"""
-type Book {
-    """
-    The title of the book
-    """
-    title: String
-
-    """
-    The author of the book
-    """
-    author_name: String
-    #    author: Author
-}
-
-"""
-An author type
-"""
-type Author {
-    """
-    The name of the author
-    """
-    name: String
-
-    """
-    The books of the author
-    """
-    books: [String]
-    #    books: [Book]
-}
-
-"""
-A nested book type
-"""
-input NestedBook {
-    """
-    The date of the book
-    """
-    date: String
-}
-
-"""
-The input object for the getBook query
-"""
-input BookInput {
-    """
-    The title of the book
-    """
-    title: String
-
-    """
-    The author of the book
-    """
-    nestedBook: NestedBook
-}
-
-type Query {
-    #    books: [Book]
-    #    authors: [Author]
-    """
-    Get a book by title
-    """
-    getBook(
-        """
-        The title of the book
-        """
-        title: String
-
-        """
-        The author of the book
-        """
-        input: BookInput
-    ): Book
-}
-
-type Mutation {
-    """
-    Add a book
-    """
-    addBook(title: String, author: String): Book
-
-    """
-    Add an author
-    """
-    addAuthor(name: String): Author
-}

package/examples/basic/todo-app.graphqls

@@ -1,184 +0,0 @@
-# Define custom scalars for Date and ID
-scalar Date
-scalar ID
-
-# Define the User type
-"""
-A user type representing a user in the system
-"""
-type User {
-    """
-    The unique ID of the user
-    """
-    id: ID!
-
-    """
-    The name of the user
-    """
-    name: String!
-
-    """
-    The email of the user
-    """
-    email: String!
-
-    """
-    The list of todos created by the user
-    """
-    todos: [Todo!]!
-}
-
-# Define the Todo type
-"""
-A todo type representing a task to be done
-"""
-type Todo {
-    """
-    The unique ID of the todo
-    """
-    id: ID!
-
-    """
-    The title of the todo
-    """
-    title: String!
-
-    """
-    The description of the todo
-    """
-    description: String
-
-    """
-    The status of the todo (completed or not)
-    """
-    completed: Boolean!
-
-    """
-    The due date of the todo
-    """
-    dueDate: Date
-}
-
-# Define input types for creating and updating todos
-"""
-Input type for creating a new todo
-"""
-input CreateTodoInput {
-    title: String!
-    description: String
-    dueDate: Date
-    userId: ID!
-}
-
-"""
-Input type for updating an existing todo
-"""
-input UpdateTodoInput {
-    id: ID!
-    title: String
-    description: String
-    completed: Boolean
-    dueDate: Date
-}
-
-# Define the Query type
-"""
----
-title: Query
-group: [Root Types]
----
-
-The root query type
-"""
-type Query {
-    """
-    ---
-    title: Users
-    group: [GraphQL, Users]
-    ---
-
-    Get a list of all users
-    """
-    users: [User!]!
-
-    """
-    ---
-    title: User
-    group: [GraphQL, Users]
-    ---
-
-    Get a user by ID
-    """
-    user(id: ID!): User
-
-    """
-    ---
-    title: Todos
-    group: [GraphQL, Todos]
-    ---
-
-    Get a list of all todos
-    """
-    todos: [Todo!]!
-
-    """
-    ---
-    title: Todo
-    group: [GraphQL, Todos]
-    ---
-
-    Get a todo by ID
-    """
-    todo(id: ID!): Todo
-}
-
-# Define the Mutation type
-"""
----
-title: Mutation
-group: [Root Types]
----
-
-The root mutation type
-"""
-type Mutation {
-    """
-    ---
-    title: Create User
-    group: [GraphQL, Users]
-    ---
-
-    Create a new user
-    """
-    createUser(name: String!, email: String!): User!
-
-    """
-    ---
-    title: Create Todo
-    group: [GraphQL, Todos]
-    ---
-
-    Create a new todo
-    """
-    createTodo(input: CreateTodoInput!): Todo!
-
-    """
-    ---
-    title: Update Todo
-    group: [GraphQL, Todos]
-    ---
-
-    Update an existing todo
-    """
-    updateTodo(input: UpdateTodoInput!): Todo!
-
-    """
-    ---
-    title: Delete Todo
-    group: [GraphQL, Todos]
-    ---
-
-    Delete a todo by ID
-    """
-    deleteTodo(id: ID!): Boolean!
-}

package/examples/graphql-types/graphql-types.0.basic.graphqls

@@ -1,28 +0,0 @@
-"""
-This is a custom scalar type for Date.
-"""
-scalar Date
-
-"""
-This is a custom enum type for Role.
-"""
-enum Role {
-    ADMIN
-    OWNER
-}
-
-"""
-This is a custom input type for Book.
-"""
-input BookInput {
-    title: String!
-    author: String!
-}
-
-"""
-This is a custom type for Book.
-"""
-type Book {
-    title: String!
-    author: String!
-}

package/examples/nested/nested-arg.0.not-required.graphqls

@@ -1,8 +0,0 @@
-input BookInput {
-    title: String!
-    author: String!
-}
-
-type Mutation {
-    addBook(bookInput: BookInput): Boolean!
-}

package/examples/nested/nested-arg.0.required.graphqls

@@ -1,8 +0,0 @@
-input BookInput {
-    title: String!
-    author: String!
-}
-
-type Mutation {
-    addBook(bookInput: BookInput!): Boolean!
-}

package/examples/nested/nested-arg.1.deep.graphqls

@@ -1,12 +0,0 @@
-input BookInput {
-    title: String!
-    author: Author!
-}
-
-input Author {
-    name: String!
-}
-
-type Mutation {
-    addBook(bookInput: BookInput): Boolean!
-}

package/src/hydration/README.md

@@ -1 +0,0 @@
-`hydration` converts a GraphQL into XYD `uniform` format.

package/src/hydration/gql-arg.ts

@@ -1,53 +0,0 @@
-import {GraphQLArgument} from "graphql/type/definition";
-import {GraphQLInputObjectType} from "graphql/type";
-
-import {DefinitionProperty} from "@xyd-js/uniform";
-
-import {gqlInputToUniformDefinitionProperty} from "./gql-input";
-
-// gqlArgToUniformDefinitionProperty converts GraphQL arguments into xyd 'uniform' definition properties
-export function gqlArgToUniformDefinitionProperty(
-    args: readonly GraphQLArgument[]
-): DefinitionProperty[] {
-    const resp: DefinitionProperty[] = []
-
-    args.forEach(arg => {
-        let obj: GraphQLInputObjectType | null = null
-
-        switch (arg.type.constructor.name) {
-            case "GraphQLNonNull": {
-                if ("ofType" in arg.type) {
-                    const ofType = arg.type?.ofType
-
-                    if (ofType?.constructor.name === "GraphQLInputObjectType") {
-                        obj = ofType as GraphQLInputObjectType
-                    }
-                }
-                break
-            }
-
-            case "GraphQLInputObjectType" : {
-                obj = arg.type as GraphQLInputObjectType
-
-                break
-            }
-
-            default: {
-            }
-        }
-
-        if (!obj) {
-            console.error("unsupported argument type", arg.type.constructor.name)
-            return
-        }
-
-        resp.push(gqlInputToUniformDefinitionProperty(
-            arg.name,
-            arg.description || "",
-            obj
-        ))
-    })
-
-    return resp
-}
-

package/src/hydration/gql-field.ts

@@ -1,206 +0,0 @@
-import {
-    GraphQLField,
-    GraphQLFieldMap,
-    GraphQLInputField,
-    GraphQLInputFieldMap,
-    GraphQLInputObjectType
-} from "graphql/type";
-import {GraphQLObjectType, GraphQLNamedType} from "graphql";
-
-import {DefinitionProperty} from "@xyd-js/uniform";
-import {isIntrospectionType, isSpecifiedScalarType} from "graphql/index";
-
-// gqlFieldToUniformDefinitionProperty converts GraphQL fields (field or input field) into xyd 'uniform' definition property
-export function gqlFieldToUniformDefinitionProperty(
-    fieldName: string,
-    field: GraphQLField<any, any> | GraphQLInputField,
-): DefinitionProperty {
-    let properties;
-    let graphqlTypeFlat: GraphQLNamedType | null = null
-
-    // if 'ofType' types (non-null values e.g '!<type>')
-    if ("ofType" in field.type) {
-        switch (field.type.constructor.name) {
-            case "GraphQLList": {
-                switch (field.type.ofType.constructor.name) {
-                    case "GraphQLObjectType": {
-                        const objectType = field.type.ofType as GraphQLObjectType
-
-                        properties = nestedProperties(objectType)
-                        graphqlTypeFlat = objectType
-
-                        break
-                    }
-
-                    case "GraphQLInputObjectType": {
-                        const inputObjectType = field.type.ofType as GraphQLInputObjectType
-
-                        properties = nestedProperties(inputObjectType)
-                        graphqlTypeFlat = inputObjectType
-
-                        break
-                    }
-
-                    case "GraphQLScalarType": {
-                        properties = definitionPropsFromNestedObj(field) || []
-                        graphqlTypeFlat = field.type.ofType as GraphQLNamedType
-
-                        break
-                    }
-
-                    case "GraphQLNonNull": {
-                        properties = definitionPropsFromNestedObj(field) || []
-
-                        if ("ofType" in field.type.ofType) {
-                            graphqlTypeFlat = field.type.ofType.ofType as GraphQLNamedType
-                        }
-
-                        break
-                    }
-
-                    default: {
-                        console.error("unsupported ofType list", field.type.ofType.constructor.name)
-                        break
-                    }
-
-                }
-
-                break
-            }
-
-            case "GraphQLNonNull": {
-                properties = definitionPropsFromNestedObj(field) || []
-                graphqlTypeFlat = field.type.ofType as GraphQLNamedType
-
-                break
-            }
-
-            default: {
-                console.error("unsupported ofType", field.type.constructor.name)
-
-                break
-            }
-
-        }
-    }
-
-    // if regular object type
-    else if (field.type.constructor.name === "GraphQLObjectType") {
-        const objectType = field.type as GraphQLObjectType
-        graphqlTypeFlat = field.type
-
-        // TODO: support nested & circular references - ITS JUST A FAST SOLUTION FOR TESTING PURPOSES
-        // properties = [
-        //     {
-        //         name: fieldName,
-        //         type: "object",
-        //         description: objectType.description || "",
-        //     }
-        // ]
-
-        // TODO: comment if bug with circular references
-        properties = nestedProperties(objectType)
-    } else if (field.type.constructor.name === "GraphQLInputObjectType") {
-        const objectType = field.type as GraphQLInputObjectType
-
-        graphqlTypeFlat = field.type
-        properties = nestedProperties(objectType)
-    } else if (field.type.constructor.name === "GraphQLScalarType") {
-        graphqlTypeFlat = field.type
-    }
-
-
-    switch (graphqlTypeFlat?.constructor?.name) {
-        case "GraphQLList": {
-            if ("ofType" in graphqlTypeFlat) {
-                graphqlTypeFlat = graphqlTypeFlat.ofType as GraphQLNamedType
-            }
-        }
-    }
-
-    const builtInType = graphqlTypeFlat ? (isSpecifiedScalarType(graphqlTypeFlat) ||
-        isIntrospectionType(graphqlTypeFlat)
-    ) : undefined
-
-    let graphqlTypeShort = ""
-
-    switch (graphqlTypeFlat?.constructor?.name) {
-        case "GraphQLObjectType": {
-            graphqlTypeShort = "object"
-
-            break
-        }
-        case "GraphQLInputObjectType": {
-            graphqlTypeShort = "input"
-
-            break
-        }
-        case "GraphQLScalarType": {
-            graphqlTypeShort = "scalar"
-
-            break
-        }
-    }
-
-    return {
-        name: fieldName,
-        type: field.type.toJSON(),
-        context: {
-            graphqlBuiltInType: builtInType,
-            graphqlName: fieldName,
-            graphqlTypeFlat: graphqlTypeFlat && graphqlTypeFlat.toJSON(),
-            graphqlTypeShort,
-        },
-        description: field.description || "",
-        properties,
-    }
-}
-
-// TODO: fix any + another more safety solution?
-// definitionPropsFromNestedObj converts graphql nested obj into xyd 'uniform' definition properties
-function definitionPropsFromNestedObj(obj: any): DefinitionProperty[] | null {
-    if (!obj) {
-        return null
-    }
-    if (obj.getFields) {
-        return nestedProperties(obj)
-    }
-
-    if (obj.ofType) {
-        return definitionPropsFromNestedObj(obj.ofType)
-    }
-
-    if (obj.type) {
-        return definitionPropsFromNestedObj(obj.type)
-    }
-
-    return null
-}
-
-// deepFieldMap iterates over GraphQL field (field or input fields) maps
-function deepFieldMap(
-    fieldsMap: GraphQLFieldMap<any, any> | GraphQLInputFieldMap,
-) {
-    const properties: DefinitionProperty[] = []
-
-    for (const [name, field] of Object.entries(fieldsMap)) {
-        const prop = gqlFieldToUniformDefinitionProperty(
-            name,
-            field,
-        )
-
-        if (prop) {
-            properties.push(prop)
-        }
-    }
-
-    return properties
-}
-
-// nestedProperties get fields from object or input object types and iterates over them
-function nestedProperties(objectType: GraphQLObjectType | GraphQLInputObjectType) {
-    const nestedFields = objectType?.getFields?.()
-
-    return deepFieldMap(nestedFields)
-}
-

package/src/hydration/gql-input.ts

@@ -1,67 +0,0 @@
-import {GraphQLInputObjectType} from "graphql/type";
-
-import {DefinitionProperty, Reference} from "@xyd-js/uniform";
-
-import {gqlFieldToUniformDefinitionProperty} from "./gql-field";
-
-// gqlInputToUniformRef is a helper function to convert a GraphQL input object type into a 'uniform' reference.
-export function gqlInputToUniformRef(gqlType: GraphQLInputObjectType): Reference {
-    const prop = gqlInputToUniformDefinitionProperty(
-        gqlType.name,
-        gqlType.description || "",
-        gqlType
-    )
-
-    return {
-        title: gqlType.name,
-        description: gqlType.description || "",
-        canonical: `input-${gqlType.name}`, // TODO: better solution
-        context: {
-            graphqlName: gqlType.name,
-            graphqlTypeShort: "input" // TODO: better solution
-        },
-        definitions: [
-            {
-                title: "Fields",
-                properties: prop.properties || []
-            }
-        ],
-        examples: {
-            groups: []
-        }
-    } as Reference
-}
-
-// gqlInputToUniformDefinitionProperty is a helper function to convert a GraphQL input object into a xyd definition property.
-export function gqlInputToUniformDefinitionProperty(
-    name: string,
-    description: string,
-    obj: GraphQLInputObjectType
-) {
-    const inputFields = obj.getFields?.()
-
-    const nestedProps: DefinitionProperty[] = []
-    const nestedDefinitionProperty: DefinitionProperty = {
-        name: name,
-        type: obj.toJSON(),
-        description: description || "",
-        context: {
-            graphqlName: name,
-            graphqlTypeShort: "input"
-        },
-        properties: nestedProps,
-    }
-
-    for (const [name, inputField] of Object.entries(inputFields)) {
-        const prop = gqlFieldToUniformDefinitionProperty(
-            name,
-            inputField,
-        )
-
-        if (prop) {
-            nestedProps.push(prop)
-        }
-    }
-
-    return nestedDefinitionProperty
-}

package/src/hydration/gql-object.ts

@@ -1,35 +0,0 @@
-import {GraphQLObjectType} from "graphql";
-
-import type {DefinitionProperty} from "@xyd-js/uniform";
-
-import {gqlFieldToUniformDefinitionProperty} from "./gql-field";
-
-// gqlObjectToUniformRef is a helper function to convert a GraphQL object type into a 'uniform' reference.
-export function gqlObjectToUniformRef(gqlType: GraphQLObjectType) {
-    const props: DefinitionProperty[] = []
-
-    for (const [name, field] of Object.entries(gqlType.getFields())) {
-        const prop = gqlFieldToUniformDefinitionProperty(name, field)
-
-        props.push(prop)
-    }
-
-    return {
-        title: gqlType.name,
-        description: gqlType.description || "",
-        canonical: `object-${gqlType.name}`, // TODO: better solution
-        context: {
-            graphqlName: gqlType.name,
-            graphqlTypeShort: "object" // TODO: better solution
-        },
-        definitions: [
-            {
-                title: "Fields",
-                properties: props
-            }
-        ],
-        examples: {
-            groups: []
-        }
-    }
-}