@nerjs/gql 1.5.0 → 2.0.1

package/README.md

@@ -1,220 +1,3 @@
-# Gql (apollo) config and utils
+# The utility is incomplete and is no longer supported. 
 
-## Install 
-
-```
-npm i @nerjs/gql
-```
-or:
-```
-yarn add @nerjs/gql
-```
-
-
-## Use
-
-
-### createClient()
-
-create [Apollo client](https://www.apollographql.com/docs/react/get-started/#create-a-client).
-
-```js
-const createClient = require('@nerjs/gql/client')
-// or
-import createClient from '@nerjs/gql/client'
-
-
-const client = createClient({/* ...clientOptions */})
-```
-
-#### clientOptions
-
-|prop name|type|required|description|
-|:--:|:--:|:--:|:--|
-|***uri***|**String**|:white_check_mark:|Graphql server endpoint. Used in [HttpLink](https://www.apollographql.com/docs/link/links/batch-http/)|
-|***httpOptions***|**Object**|| Other options [HttpLink](https://www.apollographql.com/docs/link/links/batch-http/#options)|
-|***wsUri***|**String**||Graphql server websocket endpoint. Used in [WebSocketLink](https://www.apollographql.com/docs/link/links/ws/)|
-|***wsOptions***|**Object**|| Other otions [WebSocketLink](https://www.apollographql.com/docs/link/links/ws/#options)|
-|***links***|**Array**|| Array of [ApolloLinks](https://www.apollographql.com/docs/link/)|
-|***onError***|**Function**||errorHandler for [apollo-link-error](https://www.apollographql.com/docs/link/links/error/)|
-
-### createGqlServer 
-
-create [ApolloServer](https://www.apollographql.com/docs/apollo-server/api/apollo-server/)
-
-```js
-const createGqlServer = require('@nerjs/gql/server')
-
-const server = createGqlServer({/* ...serverOptions */})
-```
-
-#### serverOptions
-
-|prop name|type|required|description|
-|:--:|:--:|:--:|:--|
-|***app***|**[Application](https://expressjs.com/ru/4x/api.html#app)**|:white_check_mark:|Express application|
-|***path***|**String**|:white_check_mark:|Graphql [uri endpoint](https://github.com/apollographql/apollo-server/tree/master/packages/apollo-server-express)|
-|***playground***|**Boolean**||Enable graphql [playground](https://www.apollographql.com/docs/apollo-server/testing/graphql-playground/#gatsby-focus-wrapper)|
-|***types***|**String**|:white_check_mark:|Path to graphql [types](https://github.com/Urigo/merge-graphql-schemas#merging-type-definitions). Used by [merge-graphql-schemas](https://github.com/Urigo/merge-graphql-schemas)|
-|***resolvers***|**String**|:white_check_mark:|Path to graphql [resolvers](https://github.com/Urigo/merge-graphql-schemas#merging-resolvers). Used by [merge-graphql-schemas](https://github.com/Urigo/merge-graphql-schemas)|
-|***middlewares***|**Array(Function \| Object)**||[graphql-middleware](https://github.com/prisma-labs/graphql-middleware)|
-|***cors***|||
-|***formatError***|||
-|***context***|||
-|***subscriptions***|||
-
-
-
-
-### GqlProvider
-
-[React component](https://en.reactjs.org/docs/react-component.html). Wrap over [ApolloProvider](https://www.apollographql.com/docs/react/api/react-hooks/#apolloprovider).
-
-```js
-const GqlProvider = require('@nerjs/gql/provider')
-// or
-import GqlProvider from '@nerjs/gql/provider'
-import React from 'react'
-
-
-const App = () => {
-    return <GqlProvider {.../* providerProps */} />
-}
-```
-
-#### providerProps
-
-1. ***client***: (**[ApolloClient](https://www.apollographql.com/docs/react/api/apollo-client/)**): Required if not use [clientOptions](#clientoptions)
-
-or:
-
-2. `{...options}` **[clientOptions](#clientoptions)**
-
-### useGqlErrors
-
-```js
-const useGqlErrors = require('@nerjs/gql/useGqlErrors')
-// or
-import useGqlErrors from '@nerjs/gql/useGqlErrors'
-
-const { lastError } = useGqlErrors()
-```
-
-> Returns the last error
-> Does not work outside the [GqlProvider](#gqlprovider) or when using the [first option](#providerprops)
-
----
-
-### Scalars (resolvers)
-
-```js
-const { ...scalars } = require('@nerjs/gql/scalars')
-```
-
-* DateResolver (scalar `Date`)
-* NumberResolver (scalar `Number`)
-
-### gql middlewares
-
-```js
-const { ...middlewares } = require('@nerjs/gql/mdw')
-```
-
-#### validate middleware
-
-```js
-const validateMiddleware = require('@nerjs/gql/mdw/validate')
-
-
-const schemaMiddlewares = {
-    Query: {
-        getItem: validateMiddleware({ input: yupInputSchema }),
-        getItems: validateMiddleware(yupInputSchema)
-    }
-}
-```
-
-> Used [yup](https://github.com/jquense/yup#readme) validation
-> default **errorWrapper** [YupGqlError](https://github.com/nerjs/utils/tree/master/errors#yupgqlerror)
-
-***Custom (not yup) validation***
-
-> The schema must have a `.validate(input)` method
-
-```js
-const { createValidateMiddleware } = require('@nerjs/gql/mdw/validate')
-
-const validateMiddleware = createValidateMiddleware({
-    isSchemaField: '__isYupSchema__', // The property of an object, by which it is clear that this is a validator scheme
-    schemaOptions: { abortEarly: false },
-    errorWrapper: Error
-})
-```
-
-#### notNull middleware
-
-> Prevents return NULL
-
-```js
-const notNullMiddleware = require('@nerjs/gql/mdw/notNull')
-
-const schemaMiddlewares = {
-    User: {
-        getUser: notNullMiddleware('User not found' /* error message */)
-    }
-}
-```
-
-> throw [NotFoundGqlError(message)](https://github.com/nerjs/utils/tree/master/errors#notfoundgqlerror) if resolver return null
-
-#### onlyId middleware 
-
-> Prevents unnecessary resolver calls
-
-```js
-const onlyIdMiddleware = require('@nerjs/gql/mdw/onlyId')
-
-const schemaMiddlewares = {
-    Post: {
-        author: onlyIdMiddleware()
-    }
-}
-```
-
-#### returnBoolean middleware
-
-> Returns a boolean value depending on the success of the resolver. 
-> If `preventError` is specified as true - returns false instead of an exception
-
-```js
-const returnBooleanMiddleware = require('@nerjs/gql/mdw/returnBoolean')
-
-const schemaMiddlewares = {
-    Post: {
-        author: onlyIdMiddleware(/* preventError = false */)
-    }
-}
-```
-
-### combine middlewares
-
-> Combines and launches middlewares
-
-```js
-const combineMiddlewares = require('@nerjs/gql/mdw/combine')
-
-const schemaMiddlewares = {
-    Post: {
-        author: combine(
-            onlyIdMiddleware(),
-            notNullMiddleware('Not foud author')
-        )
-    }
-}
-```
-
-
----
-
-
-#### [:link: All utils ](https://github.com/nerjs/utils#readme)
+Feel free to check out [my profile](https://github.com/nerjs) if you're interested

package/index.js

@@ -0,0 +1 @@
+throw new Error('The utility is incomplete and is no longer supported. ')

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "@nerjs/gql",
-  "version": "1.5.0",
-  "description": "Gql (apollo) config and utils",
+  "version": "2.0.1",
+  "description": "The utility is incomplete and is no longer supported.",
   "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
   "keywords": [
     "config",
     "Apollo",
@@ -15,38 +12,21 @@
   ],
   "author": "nerjs",
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/nerjs/utils/labels/gql"
-  },
-  "homepage": "https://github.com/nerjs/utils/tree/master/gql#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/nerjs/utils.git"
-  },
+  "homepage": "https://github.com/nerjs",
   "dependencies": {
-    "@nerjs/errors": "1.2.2",
-    "apollo-cache-inmemory": "1.6.5",
-    "apollo-client": "2.6.8",
-    "apollo-link": "1.2.14",
-    "apollo-link-batch-http": "1.2.14",
-    "apollo-link-error": "1.1.13",
-    "apollo-link-ws": "1.0.20",
-    "apollo-server-express": "2.12.0",
-    "graphql": "15.0.0",
-    "graphql-fields": "2.0.3",
-    "graphql-middleware": "4.0.2",
-    "graphql-tools": "5.0.0",
-    "merge-graphql-schemas": "1.7.8",
-    "nlogs": "1.1.2",
-    "subscriptions-transport-ws": "0.9.16"
-  },
-  "optionalDependencies": {
-    "@apollo/react-hooks": "^3.1.5",
-    "react": "^16.13.1"
-  },
-  "devDependencies": {
-    "@apollo/react-hooks": "^3.1.5",
+    "@nerjs/batchloader": "^2.1.0",
+    "@nerjs/errors": "^1.2.2",
     "@nerjs/eslint": "^1.0.2",
-    "react": "^16.13.1"
+    "@nerjs/webpack": "^1.0.3",
+    "create-redux-store": "^1.1.2",
+    "electron-ebt": "^1.1.0",
+    "helpers-promise": "^1.3.0",
+    "nerjs-utils": "^0.1.23",
+    "nlogs": "^2.4.4",
+    "@nerjs/gnome-shell-types": "^0.0.2",
+    "react-trc": "^2.0.0",
+    "@nerjs/task-planner": "^0.0.3",
+    "@nerjs/eslint-config": "^2.0.0",
+    "@nerjs/express": "2.0.1"
   }
 }

package/client/createHttpLink.js

@@ -1,33 +0,0 @@
-const { BatchHttpLink } = require('apollo-link-batch-http')
-const { WebSocketLink } = require('apollo-link-ws')
-const { getMainDefinition } = require('apollo-utilities')
-const { split } = require('apollo-link')
-
-const createHttpLink = ({ uri, httpOptions = {}, wsUri, wsOptions = {} }) => {
-    const httpLink = new BatchHttpLink({ uri, ...httpOptions })
-
-    if (!wsUri) return httpLink
-
-    const wsLink = new WebSocketLink({
-        uri: wsUri,
-        options: {
-            reconnect: true,
-            lazy: true,
-            ...wsOptions,
-        },
-    })
-
-    return split(
-        // split based on operation type
-        ({ query }) => {
-            const definition = getMainDefinition(query)
-            return (
-                definition.kind === 'OperationDefinition' && definition.operation === 'subscription'
-            )
-        },
-        wsLink,
-        httpLink,
-    )
-}
-
-module.exports = createHttpLink

package/client/index.js

@@ -1,22 +0,0 @@
-const { ApolloClient } = require('apollo-client')
-const { InMemoryCache } = require('apollo-cache-inmemory')
-const { ApolloLink } = require('apollo-link')
-const { onError: onErrorLink } = require('apollo-link-error')
-const createHttpLink = require('./createHttpLink')
-
-const createClient = ({ uri, httpOptions, wsUri, wsOptions, links, onError }) => {
-    const apolloLinks = [createHttpLink({ uri, httpOptions, wsUri, wsOptions })]
-
-    if (links && Array.isArray(links)) apolloLinks.unshift(...links)
-
-    if (onError && typeof onError === 'function') apolloLinks.unshift(onErrorLink(onError))
-
-    const client = new ApolloClient({
-        cache: new InMemoryCache(),
-        link: apolloLinks.length === 1 ? apolloLinks[0] : ApolloLink.from(apolloLinks),
-    })
-
-    return client
-}
-
-module.exports = createClient

package/client.d.ts

@@ -1,13 +0,0 @@
-import {ApolloClient} from "apollo-client";
-
-export = createClient
-
-declare namespace createClient2 {
-    export declare interface ClientOptions2 {
-
-        /** @description graphql server endpoint */
-        uri: string;
-    } 
-}
-
-declare function createClient2(options: createClient.ClientOptions2): ApolloClient<any>;

package/helpers/checkType.js

@@ -1,12 +0,0 @@
-const isObjectId = require('./isObjectId')
-
-const isNumber = num => typeof num === 'number'
-
-const isString = str => typeof str === 'string'
-
-module.exports = {
-    ObjectId: isObjectId,
-    string: isString,
-    number: isNumber,
-    id: id => isObjectId(id) || isNumber(id),
-}

package/helpers/isObjectId.js

@@ -1,3 +0,0 @@
-module.exports = id =>
-    (typeof id === 'string' && id.length === 24) ||
-    (typeof id === 'object' && id._bsontype === 'ObjectID' && id.id instanceof Buffer)

package/index.d.ts

@@ -1,72 +0,0 @@
-import {ApolloClient} from "apollo-client";
-import { ApolloServer } from "apollo-server-express";
-import {Application} from "express";
-import { IMiddleware, IMiddlewareFieldMap, IMiddlewareFunction } from "graphql-middleware";
-
-
-declare module '@nerjs/gql/client' {
-
-
-    declare interface ClientOptions {
-
-        /** @description graphql server endpoint */
-        uri: string;
-    }
-
-    export default function createClient(options: ClientOptions): ApolloClient<TCacheShape>;
-}
-
-declare module '@nerjs/gql/server' {
-
-    declare interface GqlServerOptions {
-
-        /** @description Express application */
-        app: Application;
-    
-        /** @description Graphql endpoint */
-        path: string;
-    
-        /** @description Enable graphql playground */
-        playground?: boolean;
-    
-        /** @description Path to graphql types */
-        types: string;
-        
-        /** @description Path to graphql resolvers */
-        resolvers: string;
-    
-        middlewares?: [IMiddlewareFieldMap | IMiddlewareFunction | IMiddleware]
-    }
-
-    export default function createGqlServer(options:GqlServerOptions): ApolloServer;
-}
-
-declare module '@nerjs/gql/provider' {
-
-
-    declare interface ClientOptions {
-
-        /** @description graphql server endpoint */
-        uri: string;
-    }
-
-    declare interface ApolloProviderProps {
-
-        /** @description graphql server endpoint */
-        uri: string;
-    
-        /** @description options for create apollo client */
-        options?: ClientOptions
-    }
-
-    declare interface ApolloProviderProps {
-
-        /** @description Apollo client */
-        client: ApolloClient<any>;
-    }
-
-    
-    declare const GqlProvider: FC<ApolloProviderProps>;
-
-    export default GqlProvider
-}

package/mdw/combine.js

@@ -1,13 +0,0 @@
-const combineMiddlewares = (..._fns) => {
-    const fns = _fns.filter(fn => typeof fn === 'function')
-
-    const fabric = (resolver, idx) => {
-        if (!fns[idx]) return resolver
-        const fn = fns[idx]
-        return (...args) => fn(fabric(resolver, idx + 1), ...args)
-    }
-
-    return (resolver, ...args) => fabric(resolver, 0)(...args)
-}
-
-module.exports = combineMiddlewares

package/mdw/index.js

@@ -1,5 +0,0 @@
-exports.validateMiddleware = require('./validate')
-exports.notNullMiddleware = require('./notNull')
-exports.onlyIdMiddleware = require('./onlyId')
-exports.returnBooleanMiddleware = require('./returnBoolean')
-exports.combine = require('./combine')

package/mdw/notNull.js

@@ -1,9 +0,0 @@
-const NotFoundGqlError = require('@nerjs/errors/NotFoundGqlError')
-
-const notNullMiddleware = message => async (resolver, ...args) => {
-    const res = await resolver(...args)
-    if (res === null) throw new NotFoundGqlError(message)
-    return res
-}
-
-module.exports = notNullMiddleware

package/mdw/onlyId.js

@@ -1,25 +0,0 @@
-const graphqlFields = require('graphql-fields')
-const checkType = require('../helpers/checkType')
-
-const onlyIdMiddleware = (type = 'ObjectId', fieldQueryName = 'id', nullIfNotArg = true) => async (
-    resolver,
-    parent,
-    args,
-    ctx,
-    info,
-) => {
-    const { fieldName } = info
-    if (!parent[fieldName]) return nullIfNotArg ? null : resolver(parent, args, ctx, info)
-
-    if (!checkType[type] || !checkType[type](parent[fieldName]))
-        return resolver(parent, args, ctx, info)
-
-    const fields = Object.keys(graphqlFields(info))
-
-    if (fields.length === 1 && fields[0] === fieldQueryName)
-        return { [fieldQueryName]: parent[fieldName] }
-
-    return resolver(parent, args, ctx, info)
-}
-
-module.exports = onlyIdMiddleware

package/mdw/returnBoolean.js

@@ -1,11 +0,0 @@
-const returnBooleanMiddleware = preventError => async (resolver, ...args) => {
-    try {
-        await resolver(...args)
-        return true
-    } catch (e) {
-        if (preventError) return false
-        throw e
-    }
-}
-
-module.exports = returnBooleanMiddleware

package/mdw/validate.js

@@ -1,35 +0,0 @@
-const YupGqlError = require('@nerjs/errors/YupGqlError')
-const GqlError = require('@nerjs/errors/GqlError')
-
-const createValidateMiddleware = ({ isSchemaField, schemaOptions, errorWrapper }) => {
-    const isSchema = obj =>
-        obj && !!obj[isSchemaField] && obj.validate && typeof obj.validate === 'function'
-
-    return fields => async (resolver, parent, args, ctx, info) => {
-        try {
-            if (isSchema(fields)) {
-                await fields.validate(args, schemaOptions)
-            } else {
-                await Promise.all(
-                    Object.keys(fields || {}).map(field =>
-                        fields[field].validate(args[field], schemaOptions),
-                    ),
-                )
-            }
-        } catch (e) {
-            if (e.name === 'ValidationError') throw new errorWrapper(e)
-
-            throw new GqlError('Something went wrong', GqlError.codes.INTERNAL_SERVER_ERROR, {}, e)
-        }
-
-        return resolver(parent, args, ctx, info)
-    }
-}
-
-exports = module.exports = createValidateMiddleware({
-    isSchemaField: '__isYupSchema__',
-    schemaOptions: { abortEarly: false },
-    errorWrapper: YupGqlError,
-})
-
-exports.createValidateMiddleware = createValidateMiddleware

package/provider/ErrorsContext.js

@@ -1,7 +0,0 @@
-const { createContext } = require('react')
-
-const ErrorsContext = createContext({
-    lastError: null,
-})
-
-module.exports = ErrorsContext

package/provider/index.js

@@ -1,29 +0,0 @@
-const React = require('react')
-const { ApolloProvider } = require('@apollo/react-hooks')
-const createClient = require('../client')
-const ErrorsContext = require('./ErrorsContext')
-
-const Provider = ({ children, client, onError, ...clientOptions }) => {
-    const [lastError, setLastError] = React.useState(null)
-    const [apolloClient] = React.useState(
-        () => client || createClient({ ...clientOptions, onError: onErrorHandler }),
-    )
-
-    const onErrorHandler = React.useCallback(
-        err => {
-            setLastError(err)
-            return onError && typeof onError === 'function'
-                ? onError(err)
-                : err.forward(err.operation)
-        },
-        [onError, setLastError],
-    )
-
-    return React.createElement(
-        ApolloProvider,
-        { client: apolloClient },
-        React.createElement(ErrorsContext.Provider, { value: { lastError } }, children),
-    )
-}
-
-module.exports = Provider

package/scalars/date.js

@@ -1,31 +0,0 @@
-const { GraphQLScalarType, Kind } = require('graphql')
-
-const parseDate = _date => {
-    const date = new Date(_date)
-    // if (isNaN(date)) throw new GqlValidationError(`Invalid Date.`, _date, date)
-    if (isNaN(date)) throw new Error(`Invalid Date.`)
-    return date
-}
-
-const DateResolver = new GraphQLScalarType({
-    name: 'Date',
-    description:
-        'The `Date` scalar type' +
-        ' Can be transmitted as a number (`timestamp`) or a string (`js Date format`)',
-    serialize(value) {
-        const date = parseDate(value)
-        return process.env.NODE_ENV !== 'production' ? date.toJSON() : date.getTime()
-    },
-    parseValue: parseDate,
-    parseLiteral: ast => {
-        if (ast.kind === Kind.INT) return parseDate(Number(ast.value))
-        if (ast.kind === Kind.STRING) return parseDate(ast.value)
-        throw new GqlValidationError(
-            `Incorrect type argument. [${ast.kind}!==(${Kind.INT}|${Kind.STRING})]`,
-            ast.kind,
-            [Kind.INT, Kind.STRING],
-        )
-    },
-})
-
-module.exports = DateResolver

package/scalars/index.js

@@ -1,2 +0,0 @@
-exports.DateResolver = require('./date')
-exports.NumberResolver = require('./number')

package/scalars/number.js

@@ -1,44 +0,0 @@
-const { GraphQLScalarType, Kind } = require('graphql')
-
-const MAX_NUMBER = Math.pow(2, 64) - 1
-const MIN_NUMBER = -Math.pow(2, 63)
-
-/*
-feature 
-После создания кастомного GqlError
-*/
-// const parseNumber = num => {
-//     if (typeof num !== 'number' || isNaN(num))
-//         throw new GqlValidationError('Value is not a number', 'NaN', 'Number')
-//     if (num < MIN_NUMBER || num > MAX_NUMBER)
-//         throw new GqlValidationError('Number is out of range', num, `${MIN_NUMBER}<>${MAX_NUMBER}`)
-//     if (num !== parseInt(num, 10))
-//         throw new GqlValidationError(`Invalid non-fractional number.`, num, parseInt(num))
-
-//     return num
-// }
-
-const parseNumber = num => {
-    if (typeof num !== 'number' || isNaN(num)) throw new Error('Value is not a number')
-    if (num < MIN_NUMBER || num > MAX_NUMBER) throw new Error('Number is out of range')
-    if (num !== parseInt(num, 10)) throw new Error('Invalid non-fractional number.')
-
-    return num
-}
-
-const NumberResolver = new GraphQLScalarType({
-    name: 'Number',
-    description:
-        'The `Number` scalar type represents non-fractional signed whole numeric values.' +
-        ' `Number` can represent values between -(2^64) and 2^64 - 1.',
-    serialize: parseNumber,
-    parseValue: parseNumber,
-    parseLiteral(ast) {
-        if (ast.kind !== Kind.INT)
-            throw new GqlValidationError(`Incorrect type argument.`, ast.kind, Kind.INT)
-
-        return parseNumber(Number(ast.value))
-    },
-})
-
-module.export = NumberResolver

package/server.js

@@ -1,63 +0,0 @@
-const { ApolloServer, ApolloError } = require('apollo-server-express')
-const { makeExecutableSchema } = require('graphql-tools')
-const { fileLoader, mergeTypes, mergeResolvers } = require('merge-graphql-schemas')
-const { applyMiddleware } = require('graphql-middleware')
-const DbGqlError = require('@nerjs/errors/DbGqlError')
-const logger = require('nlogs')(module)
-
-const createGqlServer = ({
-    app,
-    path,
-    playground,
-    types,
-    resolvers,
-    middlewares,
-    cors,
-    formatError,
-    context,
-    subscriptions,
-}) => {
-    const executableSchema = makeExecutableSchema({
-        typeDefs: mergeTypes(fileLoader(types)),
-        resolvers: mergeResolvers(fileLoader(resolvers)),
-    })
-
-    const schema =
-        middlewares && Array.isArray(middlewares)
-            ? applyMiddleware(executableSchema, ...middlewares)
-            : executableSchema
-
-    const server = new ApolloServer({
-        schema,
-        playground: !!playground,
-        cors,
-        context,
-        subscriptions,
-        formatError: err => {
-            if (process.env.NODE_ENV === 'production') {
-                if (DbGqlError.is(err)) {
-                    logger.error(err)
-                    err = new ApolloError(
-                        'Something went wrong',
-                        DbGqlError.codes.INTERNAL_SERVER_ERROR,
-                    )
-                }
-
-                const { code, exception, ...details } = err.extensions
-                return new ApolloError(err.message, code, details)
-            }
-
-            return formatError && typeof formatError === 'function' ? formatError(err) : err
-        },
-    })
-
-    server.applyMiddleware({
-        app,
-        path,
-        cors,
-    })
-
-    return server
-}
-
-module.exports = createGqlServer

package/useGqlErrors.js

@@ -1,4 +0,0 @@
-const { useContext } = require('react')
-const ErrorsContext = require('./provider/ErrorsContext')
-
-module.exports = () => useContext(ErrorsContext)