QiLi

A graphql server

Install

npm install qili

Protocol

http header or query

• X-Application-Id=? : create an application from qili2.com to get appid
• X-Session-Token=? : get a session token from following request as json data

config

Cloud

to extend server, with following API.

• apiKey: readonly

• merge(resolver1, resolver2, ...): a utility to deep merge objects

• addModule({typeDefs, resolver, persistedQuery,static,wechat}) : to add a cloud module

  • typeDefs: string, app's schema
  • resolver: graphql resolver object, app's resolver
  • persistedQuery: {: graphql:string, ...}
  • static(service)
    • serve request at <version=1>/:appKey/static/
    • service .on([regexp|string]/path/, function(req/{path,app}/, res/{send}/)) .on(path,callback)
  • wechat(service)
    • serve wechat request at <version=1>/:appKey/wechat
    • service .on(event/event name/,function(req/{message,app}/, res/{send}/))

      event could be text,image,voice, video,location,link, event,device_text,device_event,subcribe,unsubscribe,scan callback=function(req/{message,app}/, res/{send}/) when event name is empty, callback will be called on every event

• ID(...): a utility to extract id from type field resolver arguments

• reportThreshold: write only, to a performance profiler threshold when app set isDev=true in app.qili2.com,default undefined

• logVariables(variables,operationName): write only, returned value as log.variables, default undefined

• buildPagination(Type:String): {typeDefs, resolver}

  • to build pagination module for Type, you should manually merge returned typeDefs and resolver

  • typeDefs

    type ${Type}Edge{ node: ${Type} cursor: JSON }

    type ${Type}Connection{ edges: [${Type}Edge] pageInfo: PageInfo }

• buildComment(Type:String): {typeDefs, resolver}

  • to build comment module for Type, you should manually merge returned typeDefs and resolver

  • typeDefs

    enum CommentType { photo text }

    interface Comment{ id: ID! content: String! type: CommentType author: User! createdAt: Date! parent: ObjectID! isOwner: Boolean }

    extend type Mutation{ comment_create(parent:ID,content:String!, type: CommentType, _id: ObjectID):Comment }

    type ${CommentType} implements Comment & Node { id: ID! content: String! type: CommentType author: User! createdAt: Date! parent: ObjectID! isOwner: Boolean }

    ${Pagination.typeDefs}

    extend type Query{ ${type}_comments(parent:ObjectID,last:Int, before: JSON):${CommentType}Connection

    }

• buildFavorite(Type:String, statisticsFieldName[optional]): {typeDefs,resolver}

  • to build favorite module for Type, you should manually merge returned typeDefs and resolver to Cloud

  • typeDefs

      type ${TypedFavorite} implements Node{
          id: ID!
          author: User!
          ${type}: ${Type}!
      }
    
      extend type User{
          ${typedFavorite}s:[${Type}]
      }
    
      extend type ${Type}{
          isMyFavorite: Boolean
          ${!statisticsFieldName ? "favorited: Int" : ""}
      }
    
      extend type Mutation{
          ${typedFavorite}_toggle(_id:ObjectID!): ${Type}
      }
    

• buildStatistics(Type:String,fields:[String])

  • to build statistics module for Type

  • typeDefs

      type ${TypedStatistics} implements Node{
          id: ID!
          ${fieldDefs}
      }
    
      extend type ${Type}{
          ${fieldDefs}
      	
      	"""use query to auto count: _viewed in your query to inc viewed automatically"""
          ${fields.map(a=>`_${a}: Boolean`).join("\n\r")}
      }
    

• statistics(typeName, statObject, {app}): function to call whenever you want to statistic for an type object

  • typeName: such as "User"
  • statObject: {_id, login:1, score:2,...}, the User[_id] login+=1, score+=2
  • context: {app}

Schema

scalar Date
scalar ObjectID
scalar JSON
enum Gender {
  girl
  boy
}

interface Node {
  id: ID!
}

type PageInfo {
  hasNextPage: Boolean
  endCursor: JSON
  hasPreviousPage: Boolean
  startCursor: JSON
}

type Query {
  version: String!
  schema: String!
  me: User!
}
type Subscription {
  ping: Boolean
}

type Mutation {
  requestToken(contact: String!): Boolean
  login(contact: String!, token: String!, name: String): User
  logout: Boolean
  user_update(username: String, birthday: Date, gender: Gender, location: String, signature: String): Date
  role_create(name: String): Role
  role_update(_id: ObjectID!, name: String): Date
  role_remove(_id: ObjectID!): Boolean
  role_user_add(_id: ObjectID!, users: [String!]!): Date
  role_user_remove(_id: ObjectID!, users: [String!]!): Date
  file_link(url: String!, id: ID!, field: String!): Boolean
  file_tokens(count: Int): [FileToken]
  file_clean(host: ID!): Boolean
  comment_create(parent: ID, content: String!, type: CommentType): Comment
}


type User implements Node {
  id: ID!
  photo(size: Int = 25): String
  name: String
  email: String
  phone: String
  createdAt: Date!
  updatedAt: Date
  token: String
  username: String
  birthday: Date
  gender: Gender
  location: String
  signature: String
  roles: [Role]
}

type File {
  id: ID!
  url: String
  host: ID!
}

type FileToken {
  token: String!
  expires: Int!
}

type Role implements Node {
  id: ID!
  name: String!
  createdAt: Date!
  updatedAt: Date
  author: User
  users: [User]
}

How to Start

1. create app on qili2.com
2. get schema of created app on qili2.com with query "query {schema}"
3. upload your cloud code on qili2.com
4. create your client app,
   • yarn add github.com/lalalic/qili-app, and check qili-app tutorial
   • or create your own client app from scratch

cloud example

	//localhost/1//book
	Cloud.addModule({
		static.on("book",function(req, res){
			res.send("book")
		}
	})
	
	Cloud.wechat.on(function(req, res){
		res.send("hello, wechat")
	}).on("text",function(req,res){
		res.send(req.message.Content)
	})
	
	const BookComment=Cloud.buildComment("Book")
	
	Cloud.typeDefs=`
		type Book implements Node{
			id:ID
			title: String
		}
		extend type  User{
			firstName: String
		}
	`
	
	Cloud.resolver=merge(BookComment.resolver,{
		Book:{
			id(book, root, {app,user}){
				return `books:${book._id}`
			}
		}
	})
	
	Cloud.isDev=true