├── .dockerignore ├── .vscode └── settings.json ├── src ├── loader │ ├── index.ts │ ├── company.ts │ └── project.ts ├── constant │ ├── index.ts │ ├── project.ts │ ├── company.ts │ └── application.ts ├── utils │ ├── index.ts │ ├── query.ts │ ├── sort.ts │ ├── filters │ │ ├── index.ts │ │ └── date-filter.ts │ └── page-info.ts ├── api │ ├── index.ts │ ├── project-service.ts │ └── http-request.ts ├── template │ ├── trp.ts │ └── index.ts ├── boostrap │ ├── elasticsearch.ts │ ├── index.ts │ └── apolloserver.ts ├── schema │ ├── pagination.ts │ ├── company.ts │ ├── project.ts │ ├── filter.ts │ ├── search.ts │ └── index.ts ├── resolver │ ├── index.ts │ ├── company.ts │ ├── project.ts │ └── search.ts ├── index.ts └── logging.ts ├── .prettierrc ├── Dockerfile ├── .env.sample ├── docker-compose.yml ├── tsconfig.json ├── README.md ├── config.ts ├── .gitignore ├── tslint.json ├── package.json └── LICENSE /.dockerignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | npm-debug.log -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "editor.tabSize": 2 3 | } -------------------------------------------------------------------------------- /src/loader/index.ts: -------------------------------------------------------------------------------- 1 | export * from './project'; 2 | export * from './company'; -------------------------------------------------------------------------------- /src/constant/index.ts: -------------------------------------------------------------------------------- 1 | export * from './application'; 2 | export * from './project'; 3 | export * from './company'; -------------------------------------------------------------------------------- /src/constant/project.ts: -------------------------------------------------------------------------------- 1 | export const PROJECT_INDEX = 'projects_index'; 2 | export const PROJECT_TYPE = 'project'; 3 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "semi": true, 3 | "trailingComma": "all", 4 | "singleQuote": true, 5 | "printWidth": 70, 6 | } -------------------------------------------------------------------------------- /src/constant/company.ts: -------------------------------------------------------------------------------- 1 | export const COMPANY_INDEX = 'companies_index'; 2 | export const COMPANY_TYPE = 'company'; 3 | -------------------------------------------------------------------------------- /src/utils/index.ts: -------------------------------------------------------------------------------- 1 | export * from './query'; 2 | export * from './page-info'; 3 | export * from './sort'; 4 | export * from './filters'; -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:10.15.1 2 | 3 | WORKDIR /src 4 | 5 | COPY package*.json ./ 6 | RUN npm install 7 | 8 | COPY . . 9 | 10 | CMD ["npm", "run", "serve"] -------------------------------------------------------------------------------- /.env.sample: -------------------------------------------------------------------------------- 1 | PORT=3000 2 | HOST=localhost 3 | DEBUG_LOGLEVEL=true 4 | 5 | ESHOST=localhost:9200 6 | ES_LOGGING=trace 7 | ES_API_VERSION = 1.7 8 | ES_REQUEST_TIMEOUT=10000 -------------------------------------------------------------------------------- /src/api/index.ts: -------------------------------------------------------------------------------- 1 | import ProjectService from './project-service'; 2 | 3 | // Give arg to provider to start endpoint with specific path for example = abc.com/api/person 4 | export const projectService = new ProjectService('project'); 5 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3.1' 2 | services : 3 | gprahql-elasticsearch: 4 | container_name: gprahql-elasticsearch 5 | build: 6 | context: . 7 | dockerfile: Dockerfile 8 | env_file: 9 | - .env 10 | ports: 11 | - 4200:4200 12 | -------------------------------------------------------------------------------- /src/template/trp.ts: -------------------------------------------------------------------------------- 1 | export default [ 2 | { 3 | term: { 4 | isActive: true 5 | } 6 | }, 7 | { 8 | exists: { 9 | field: 'portals' 10 | } 11 | }, 12 | { 13 | terms: { 14 | 'portals.id': ['BRI'] 15 | } 16 | } 17 | ]; -------------------------------------------------------------------------------- /src/utils/query.ts: -------------------------------------------------------------------------------- 1 | export const searchString = (query: string, fields: Array = ['_all']) => { 2 | return { 3 | bool: { 4 | must: [{ 5 | query_string: { 6 | default_field: '_all', 7 | query, 8 | fields 9 | } 10 | }] 11 | } 12 | }; 13 | }; -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "lib": [ 4 | "es5", 5 | "es6" 6 | ], 7 | "target": "es5", 8 | "module": "commonjs", 9 | "moduleResolution": "node", 10 | "outDir": "./build", 11 | "emitDecoratorMetadata": true, 12 | "experimentalDecorators": true, 13 | "sourceMap": true, 14 | "allowJs": false, 15 | "resolveJsonModule": true 16 | } 17 | } -------------------------------------------------------------------------------- /src/api/project-service.ts: -------------------------------------------------------------------------------- 1 | import HttpRequest from './http-request'; 2 | import { PROJECT_SERVICE_HOST } from '../../config'; 3 | 4 | export default class ProjectService extends HttpRequest { 5 | private readonly path: string; 6 | 7 | constructor(path: string) { 8 | super(PROJECT_SERVICE_HOST); 9 | this.path = `${PROJECT_SERVICE_HOST}/${path}`; 10 | } 11 | 12 | public createProject(data: any) { 13 | return this.create(this.path, data); 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /src/boostrap/elasticsearch.ts: -------------------------------------------------------------------------------- 1 | import { Client } from 'elasticsearch'; 2 | import { esConfig } from '../../config'; 3 | 4 | export const elasticSearchConnection = () => { 5 | // Get connection options from env variable 6 | return new Client(esConfig); 7 | }; 8 | 9 | export const pingElasticsearch = async (client: Client) => { 10 | return client.ping({ 11 | requestTimeout: 10000, 12 | }); 13 | }; 14 | 15 | export const elasticClient: Client = elasticSearchConnection(); -------------------------------------------------------------------------------- /src/constant/application.ts: -------------------------------------------------------------------------------- 1 | export const CLIENT = { 2 | TRP: 'TRP', 3 | TRBD: 'TRBD', 4 | DEFAULT: '' 5 | }; 6 | 7 | export const PAGINATION = { 8 | PER_PAGE: 10, 9 | PER_PAGE_LIMIT: 1000, 10 | PAGE: 1, 11 | }; 12 | export const DEFAULT_QUERY = '*'; 13 | export const DEFAULT_FILTER = { match_all: {} }; 14 | export const DEFAULT_INPUT = { perPage: PAGINATION.PER_PAGE, page: PAGINATION.PAGE, q: DEFAULT_QUERY, sort: [], filters: {}, client: CLIENT.DEFAULT }; -------------------------------------------------------------------------------- /src/template/index.ts: -------------------------------------------------------------------------------- 1 | import { CLIENT } from '../constant'; 2 | import trpFilters from './trp'; 3 | 4 | const defaultTemplate = [{ 'match_all': {} }]; 5 | 6 | export const clientTemplate = (client: any) => { 7 | let clientFilters = []; 8 | switch (client) { 9 | case CLIENT.TRP: 10 | clientFilters = trpFilters; 11 | break; 12 | default: 13 | clientFilters = defaultTemplate; 14 | } 15 | return clientFilters; 16 | }; 17 | -------------------------------------------------------------------------------- /src/boostrap/index.ts: -------------------------------------------------------------------------------- 1 | import { pingElasticsearch, elasticClient } from './elasticsearch'; 2 | import apolloServer from './apolloserver'; 3 | import { ApolloServer } from 'apollo-server-koa'; 4 | 5 | export const bootstrap = async (): Promise => { 6 | try { 7 | // ping connection with elasticsearch 8 | // await pingElasticsearch(elasticClient); 9 | return await apolloServer(); 10 | } catch (err) { 11 | console.log('bootstrap error: ', err); 12 | throw err; 13 | } 14 | }; -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Graphql (Apollo Server) with ElasticSearch 2 | > Graphql App using Node with typescript, KOA framework. Elasticsearch for dataStore. Middlewares JWT, CORS, Winston Logger. 3 | 4 | ## Installation 5 | 6 | * `npm install` install dependencies. 7 | 8 | ## Useful commands 9 | 10 | * `npm run watch`: start server in watch mode. 11 | * `npm start`: start built server. 12 | * `npm run build`: build typescript files. 13 | 14 | ## Manage Graphql Playground 15 | 16 | * `Graphql Playground`: http://localhost:3000/graphql. 17 | -------------------------------------------------------------------------------- /src/utils/sort.ts: -------------------------------------------------------------------------------- 1 | import * as _ from 'underscore'; 2 | import { DEFAULT_QUERY } from '../constant'; 3 | 4 | export const esSort = (query: string, sort: string[]) => { 5 | if (sort && !(_.isEmpty(sort))) { 6 | return sort; 7 | } 8 | return query === DEFAULT_QUERY ? ['lastModified.attribute:desc'] : ['_score:desc']; 9 | }; 10 | 11 | export const mergeCommonSort = ({common = [], ...restSort}) => { 12 | return _.mapObject(restSort, function(sortArray = [], _key) { 13 | return _.union(common, sortArray); 14 | }); 15 | }; -------------------------------------------------------------------------------- /src/schema/pagination.ts: -------------------------------------------------------------------------------- 1 | import { gql } from 'apollo-server-koa'; 2 | 3 | export default gql` 4 | # Information about pagination. 5 | type PageInfo { 6 | # Current page number 7 | currentPage: Int! 8 | # Number of items per page 9 | perPage: Int! 10 | # Total number of pages 11 | pageCount: Int 12 | # Total number of items 13 | itemCount: Int 14 | # When paginating forwards, are there more items? 15 | hasNextPage: Boolean 16 | # When paginating backwards, are there more items? 17 | hasPreviousPage: Boolean 18 | } 19 | `; 20 | -------------------------------------------------------------------------------- /src/resolver/index.ts: -------------------------------------------------------------------------------- 1 | import { DateTime, NonNegativeFloat, NonNegativeInt } from '@okgrow/graphql-scalars'; 2 | import * as GraphQLJSON from 'graphql-type-json'; 3 | import projectResolvers from './project'; 4 | import companyResolvers from './company'; 5 | import searchResolvers from './search'; 6 | 7 | const customScalarResolver = { 8 | Date: DateTime, 9 | JSON: GraphQLJSON, 10 | UnsignedFloat: NonNegativeFloat, 11 | UnsignedInt: NonNegativeInt 12 | }; 13 | 14 | export default [ 15 | customScalarResolver, 16 | projectResolvers, 17 | companyResolvers, 18 | searchResolvers, 19 | ]; 20 | -------------------------------------------------------------------------------- /config.ts: -------------------------------------------------------------------------------- 1 | import { ConfigOptions } from 'elasticsearch'; 2 | 3 | export const port = process.env.PORT || 3000; 4 | export const host = process.env.HOST || 'localhost'; 5 | export const debugLogging = process.env.DEBUG_LOGLEVEL || false; 6 | 7 | export const esConfig: ConfigOptions = { 8 | host: process.env.ESHOST || '80.227.48.78:9200', 9 | log: process.env.ES_LOGGING || 'trace', 10 | requestTimeout: +process.env.ES_REQUEST_TIMEOUT || 10000, 11 | // apiVersion: process.env.ES_API_VERSION || '1.7' 12 | }; 13 | 14 | export const PROJECT_SERVICE_HOST = process.env.PROJECT_SERVICE_HOST || 'http://localhost:3001'; -------------------------------------------------------------------------------- /src/schema/company.ts: -------------------------------------------------------------------------------- 1 | import { gql } from 'apollo-server-koa'; 2 | 3 | export default gql` 4 | 5 | input CompanyInput { 6 | perPage: Int 7 | page: Int 8 | q: String 9 | filters: CompanyFilters 10 | sort: [String] 11 | client: String 12 | } 13 | 14 | input CompanyFilters { 15 | dateFilter: [DateFilter] 16 | } 17 | 18 | extend type Query { 19 | company(id: String): Company 20 | companies(input: CompanyInput): CompanyList 21 | } 22 | 23 | type CompanyList { 24 | result: [Company] 25 | count: Int 26 | pageInfo: PageInfo 27 | } 28 | 29 | type Company { 30 | aka: StringAttr 31 | alias: StringAttr 32 | } 33 | 34 | `; -------------------------------------------------------------------------------- /src/schema/project.ts: -------------------------------------------------------------------------------- 1 | import { gql } from 'apollo-server-koa'; 2 | 3 | export default gql` 4 | 5 | input ProjectInput { 6 | perPage: Int 7 | page: Int 8 | q: String 9 | filters: ProjectFilters 10 | sort: [String] 11 | client: String 12 | } 13 | 14 | input ProjectFilters { 15 | dateFilter: [DateFilter] 16 | } 17 | 18 | extend type Query { 19 | project(id: String): Project 20 | projects(input: ProjectInput): ProjectList 21 | } 22 | 23 | type ProjectList { 24 | result: [Project] 25 | count: Int 26 | pageInfo: PageInfo 27 | } 28 | 29 | 30 | type Project { 31 | id: ID 32 | isActive: Boolean 33 | creationDate: DateAttr 34 | } 35 | `; 36 | 37 | -------------------------------------------------------------------------------- /src/boostrap/apolloserver.ts: -------------------------------------------------------------------------------- 1 | import { ApolloServer } from 'apollo-server-koa'; 2 | import typeDefs from '../schema'; 3 | import resolvers from '../resolver'; 4 | import { makeExecutableSchema } from 'graphql-tools'; 5 | 6 | export default async () => { 7 | return new ApolloServer({ 8 | introspection: true, 9 | playground: true, 10 | schema: makeExecutableSchema({ 11 | typeDefs, 12 | resolvers, 13 | }), 14 | formatError: error => { 15 | // format and log error 16 | return error; 17 | }, 18 | context: async (c: any) => { 19 | // context for the graphql 20 | return { ...c }; 21 | }, 22 | }); 23 | }; 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | 6 | # Runtime data 7 | pids 8 | *.pid 9 | *.seed 10 | 11 | # Directory for instrumented libs generated by jscoverage/JSCover 12 | lib-cov 13 | 14 | # Coverage directory used by tools like istanbul 15 | coverage 16 | 17 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 18 | .grunt 19 | 20 | # node-waf configuration 21 | .lock-wscript 22 | 23 | # Compiled binary addons (http://nodejs.org/api/addons.html) 24 | build/* 25 | dist 26 | 27 | # Dependency directory 28 | node_modules 29 | 30 | # Optional npm cache directory 31 | .npm 32 | 33 | # Optional REPL history 34 | .node_repl_history 35 | 36 | # IDE configuration directory 37 | .idea 38 | 39 | # Configuration files 40 | src/conf/*.json 41 | .env -------------------------------------------------------------------------------- /src/schema/filter.ts: -------------------------------------------------------------------------------- 1 | 2 | import { gql } from 'apollo-server-koa'; 3 | 4 | export default gql` 5 | 6 | input DateRange { 7 | to: Date! 8 | from: Date! 9 | } 10 | 11 | input DateOperators { 12 | eq: Date 13 | lt: Date 14 | lte: Date 15 | gt: Date 16 | gte: Date 17 | between: DateRange 18 | } 19 | 20 | input DateFilter { 21 | field: String 22 | operator: DateOperators 23 | } 24 | 25 | input StringOperators { 26 | eq: String 27 | contains: String 28 | } 29 | 30 | input BooleanOperators { 31 | eq: Boolean 32 | } 33 | 34 | input NumberRange { 35 | to: Float! 36 | from: Float! 37 | } 38 | 39 | input NumberOperators { 40 | eq: Float 41 | lt: Float 42 | lte: Float 43 | gt: Float 44 | gte: Float 45 | between: NumberRange 46 | } 47 | `; 48 | -------------------------------------------------------------------------------- /src/utils/filters/index.ts: -------------------------------------------------------------------------------- 1 | import * as _ from 'underscore'; 2 | import { dateFilter, DateFilter } from './date-filter'; 3 | 4 | export interface Filters { 5 | dateFilter?: DateFilter[]; 6 | } 7 | 8 | const filteredResult = (result = []) => { 9 | return result.filter(filter => !(_.isEmpty((filter)))); 10 | }; 11 | 12 | export const esFilters = (filters: Filters) => { 13 | let resultFilter: any = []; 14 | if (filters) { 15 | if (filters.dateFilter) { 16 | resultFilter = [resultFilter, dateFilter(filters.dateFilter)]; 17 | } 18 | } 19 | return filteredResult(resultFilter); 20 | }; 21 | 22 | export const mergeCommonFilters = (common = {}, ...restFilters) => { 23 | return _.mapObject(restFilters, function(filterArray = [], _key) { 24 | return { ...common, ...filterArray}; 25 | }); 26 | }; -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import 'dotenv/config'; 2 | import * as koa from 'koa'; 3 | import * as helmet from 'koa-helmet'; 4 | import * as cors from '@koa/cors'; 5 | import * as winston from 'winston'; 6 | import { logger } from './logging'; 7 | import { port, host } from '../config'; 8 | import { bootstrap } from './boostrap'; 9 | 10 | bootstrap().then((apolloServer) => { 11 | const app = new koa(); 12 | // Provides important security headers to make your app more secure 13 | app.use(helmet()); 14 | // Enable cors with default options 15 | app.use(cors()); 16 | // Logger middleware -> use winston as logger (logging.ts with config) 17 | app.use(logger(winston)); 18 | 19 | apolloServer.applyMiddleware({ app }); 20 | 21 | app.listen(port, () => { 22 | console.log(`Server ready at http://${host}:${port}${apolloServer.graphqlPath}`); 23 | }); 24 | }); 25 | -------------------------------------------------------------------------------- /src/schema/search.ts: -------------------------------------------------------------------------------- 1 | import { gql } from 'apollo-server-koa'; 2 | 3 | 4 | export default gql` 5 | 6 | input SearchInput { 7 | perPage: Int 8 | page: Int 9 | q: String 10 | filters: SearchFilter 11 | sort: SearchSort 12 | client: String 13 | } 14 | 15 | input SearchSort { 16 | common: [String] 17 | project: [String] 18 | company: [String] 19 | } 20 | 21 | input SearchFilter { 22 | common: CommonFilters 23 | project: ProjectFilters 24 | company: CompanyFilters 25 | } 26 | 27 | input CommonFilters { 28 | dateFilter: [DateFilter] 29 | } 30 | 31 | extend type Query { 32 | search(input: SearchInput): Search 33 | } 34 | 35 | type Search { 36 | projects: ProjectList 37 | companies: CompanyList 38 | } 39 | `; 40 | 41 | 42 | -------------------------------------------------------------------------------- /src/resolver/company.ts: -------------------------------------------------------------------------------- 1 | import { getCompany, getCompanies } from '../loader'; 2 | import { pageInfo } from '../utils'; 3 | import { DEFAULT_INPUT } from '../constant'; 4 | 5 | export default { 6 | Query: { 7 | company: async (_obj, { id }, _context, _info) => { 8 | return await getCompany(id); 9 | }, 10 | 11 | companies: async (_obj, { input = DEFAULT_INPUT } , _context, _info) => { 12 | const { perPage, page, q, sort, filters, client } = input; 13 | const data = await getCompanies(perPage, page, q, sort, filters, client); 14 | const items = data && data.hits && data.hits.hits || []; 15 | const itemCount: number = data && data.hits && data.hits.total || 0; 16 | 17 | return { 18 | result: items.map(item => item._source), 19 | count: itemCount, 20 | pageInfo: pageInfo(perPage, page, itemCount), 21 | }; 22 | } 23 | }, 24 | 25 | Mutation: { 26 | }, 27 | 28 | Subscription: { 29 | } 30 | 31 | }; 32 | -------------------------------------------------------------------------------- /src/resolver/project.ts: -------------------------------------------------------------------------------- 1 | import { getProject, getProjects } from '../loader'; 2 | import { pageInfo } from '../utils'; 3 | import { DEFAULT_INPUT } from '../constant'; 4 | 5 | export default { 6 | Query: { 7 | project: async (_obj, { id }, _context, _info) => { 8 | return await getProject(id); 9 | }, 10 | 11 | projects: async (_obj, { input = DEFAULT_INPUT } , _context, _info) => { 12 | const { perPage, page, q, sort, filters, client } = input; 13 | const data = await getProjects(perPage, page, q, sort, filters, client); 14 | const items = data && data.hits && data.hits.hits || []; 15 | const itemCount: number = data && data.hits && data.hits.total || 0; 16 | 17 | return { 18 | result: items.map(item => item._source), 19 | count: itemCount, 20 | pageInfo: pageInfo(perPage, page, itemCount), 21 | }; 22 | }, 23 | }, 24 | 25 | Mutation: { 26 | }, 27 | 28 | Subscription: { 29 | } 30 | 31 | }; 32 | -------------------------------------------------------------------------------- /src/utils/page-info.ts: -------------------------------------------------------------------------------- 1 | import { PAGINATION } from '../constant'; 2 | 3 | interface PageInfo { 4 | currentPage: number; 5 | perPage: number; 6 | pageCount: number; 7 | itemCount: number; 8 | hasNextPage: boolean; 9 | hasPreviousPage: boolean; 10 | } 11 | 12 | export const pageInfo = (perPage: number = PAGINATION.PER_PAGE, page: number = PAGINATION.PAGE, itemCount: number = 0): PageInfo => { 13 | if (page <= 0) { 14 | throw new Error('Argument `page` should be positive number.'); 15 | } 16 | 17 | if (perPage > PAGINATION.PER_PAGE_LIMIT) { 18 | throw new Error(`Argument 'perPage' should be less ${PAGINATION.PER_PAGE_LIMIT}.`); 19 | } 20 | 21 | if (perPage <= 0) { 22 | throw new Error('Argument `perPage` should be positive number.'); 23 | } 24 | return { 25 | hasNextPage: itemCount > page * perPage, 26 | hasPreviousPage: page > 1, 27 | currentPage: page, 28 | perPage, 29 | pageCount: Math.ceil(itemCount / perPage), 30 | itemCount, 31 | }; 32 | }; -------------------------------------------------------------------------------- /src/resolver/search.ts: -------------------------------------------------------------------------------- 1 | import projectResolver from './project'; 2 | import companyResolver from './company'; 3 | import { DEFAULT_INPUT } from '../constant'; 4 | import { mergeCommonSort, mergeCommonFilters } from '../utils'; 5 | 6 | export default { 7 | Query: { 8 | search: async (_obj, args, _context, _info) => { 9 | const { input = DEFAULT_INPUT, ...restArgs } = args; 10 | const { sort, filters, ...restInput } = input; 11 | const {project: projectSort, company: companytSort } = mergeCommonSort(sort); 12 | const {project: projectFilter, company: companytFilter } = mergeCommonFilters(filters); 13 | return { 14 | projects: projectResolver.Query.projects(_obj, 15 | { input: {sort: projectSort, filters: projectFilter, ...restInput}, ...restArgs }, _context, _info), 16 | companies: companyResolver.Query.companies(_obj, 17 | { input: {sort: companytSort, filters: companytFilter, ...restInput}, ...restArgs }, _context, _info), 18 | }; 19 | }, 20 | } 21 | }; 22 | -------------------------------------------------------------------------------- /src/schema/index.ts: -------------------------------------------------------------------------------- 1 | import { gql } from 'apollo-server-koa'; 2 | import paginationSchema from './pagination'; 3 | import projectSchema from './project'; 4 | import companySchema from './company'; 5 | import searchSchema from './search'; 6 | import filterSchema from './filter'; 7 | 8 | const linkSchema = gql` 9 | scalar Date 10 | scalar JSON 11 | scalar UnsignedFloat 12 | scalar UnsignedInt 13 | 14 | type Query { 15 | _: Boolean 16 | } 17 | type Mutation { 18 | _: Boolean 19 | } 20 | type Subscription { 21 | _: Boolean 22 | } 23 | 24 | type DateAttr { 25 | attribute: Date 26 | dateFormatType: String 27 | } 28 | 29 | type StringAttr { 30 | attribute: String 31 | } 32 | 33 | type IntAttr { 34 | attribute: Int 35 | } 36 | 37 | type FloatAttr { 38 | attribute: Float 39 | } 40 | 41 | type UnsignedFloatAttr { 42 | attribute: UnsignedFloat 43 | } 44 | 45 | type UnsignedIntAttr { 46 | attribute: UnsignedInt 47 | } 48 | 49 | type BooleanAttr { 50 | attribute: Boolean 51 | } 52 | `; 53 | 54 | export default [linkSchema, paginationSchema, projectSchema, companySchema, searchSchema, filterSchema]; -------------------------------------------------------------------------------- /src/logging.ts: -------------------------------------------------------------------------------- 1 | import * as Koa from 'koa'; 2 | import { debugLogging } from '../config'; 3 | import * as winston from 'winston'; 4 | 5 | export function logger(winstonInstance) { 6 | return async(ctx: Koa.Context, next: () => Promise) => { 7 | 8 | const start = new Date().getMilliseconds(); 9 | 10 | await next(); 11 | 12 | const ms = new Date().getMilliseconds() - start; 13 | 14 | let logLevel: string; 15 | if (ctx.status >= 500) { 16 | logLevel = 'error'; 17 | } 18 | if (ctx.status >= 400) { 19 | logLevel = 'warn'; 20 | } 21 | if (ctx.status >= 100) { 22 | logLevel = 'info'; 23 | } 24 | 25 | const msg: string = `${ctx.method} ${ctx.originalUrl} ${ctx.status} ${ms}ms`; 26 | 27 | winstonInstance.configure({ 28 | level: debugLogging ? 'debug' : 'info', 29 | transports: [ 30 | // 31 | // - Write all logs error (and below) to `error.log`. 32 | new winston.transports.File({ filename: 'error.log', level: 'error' }), 33 | // 34 | // - Write to all logs with specified level to console. 35 | new winston.transports.Console({ format: winston.format.combine( 36 | winston.format.colorize(), 37 | winston.format.simple() 38 | ) }) 39 | ] 40 | }); 41 | 42 | winstonInstance.log(logLevel, msg); 43 | }; 44 | } -------------------------------------------------------------------------------- /tslint.json: -------------------------------------------------------------------------------- 1 | { 2 | "rules": { 3 | "class-name": true, 4 | "comment-format": [ 5 | true, 6 | "check-space" 7 | ], 8 | "indent": [ 9 | true, 10 | "spaces" 11 | ], 12 | "one-line": [ 13 | true, 14 | "check-open-brace", 15 | "check-whitespace" 16 | ], 17 | "no-var-keyword": true, 18 | "quotemark": [ 19 | true, 20 | "single", 21 | "avoid-escape" 22 | ], 23 | "semicolon": [ 24 | true, 25 | "always", 26 | "ignore-bound-class-methods" 27 | ], 28 | "whitespace": [ 29 | true, 30 | "check-branch", 31 | "check-decl", 32 | "check-operator", 33 | "check-module", 34 | "check-separator", 35 | "check-type" 36 | ], 37 | "typedef-whitespace": [ 38 | true, 39 | { 40 | "call-signature": "nospace", 41 | "index-signature": "nospace", 42 | "parameter": "nospace", 43 | "property-declaration": "nospace", 44 | "variable-declaration": "nospace" 45 | }, 46 | { 47 | "call-signature": "onespace", 48 | "index-signature": "onespace", 49 | "parameter": "onespace", 50 | "property-declaration": "onespace", 51 | "variable-declaration": "onespace" 52 | } 53 | ], 54 | "no-internal-module": true, 55 | "no-trailing-whitespace": true, 56 | "no-null-keyword": true, 57 | "prefer-const": true, 58 | "jsdoc-format": true 59 | } 60 | } -------------------------------------------------------------------------------- /src/loader/company.ts: -------------------------------------------------------------------------------- 1 | import { elasticClient } from '../boostrap/elasticsearch'; 2 | import { COMPANY_INDEX, COMPANY_TYPE, PAGINATION, DEFAULT_QUERY, CLIENT } from '../constant'; 3 | import { SearchResponse } from 'elasticsearch'; 4 | import { clientTemplate } from '../template'; 5 | import { searchString, esSort, Filters, esFilters } from '../utils'; 6 | 7 | const companyElasticConfig = { 8 | index: COMPANY_INDEX, 9 | type: COMPANY_TYPE, 10 | _source: true 11 | }; 12 | 13 | export const getCompany = async (id: string): Promise => { 14 | return elasticClient.getSource({ 15 | id: id, 16 | ...companyElasticConfig, 17 | }); 18 | }; 19 | 20 | export const getCompanies = async (perPage: number = PAGINATION.PER_PAGE, page: number = PAGINATION.PAGE, 21 | query: string = DEFAULT_QUERY, sort: string[] = [], filters: Filters, client: string = CLIENT.DEFAULT) 22 | : Promise> => { 23 | 24 | return elasticClient.search({ 25 | ...companyElasticConfig, 26 | size: perPage, 27 | from: perPage * (page - 1), 28 | sort: esSort(query, sort), 29 | body: { 30 | query: { 31 | filtered: { 32 | query: { 33 | bool: { 34 | should: [ 35 | searchString(query, [ 36 | 'name.attribute' 37 | ]), 38 | ], 39 | } 40 | } 41 | } 42 | }, 43 | filter: { 44 | and: { 45 | filters: [ 46 | ...clientTemplate(client), 47 | ...esFilters(filters), 48 | ] 49 | } 50 | } 51 | } 52 | }); 53 | }; 54 | -------------------------------------------------------------------------------- /src/loader/project.ts: -------------------------------------------------------------------------------- 1 | import { elasticClient } from '../boostrap/elasticsearch'; 2 | import { PROJECT_INDEX, PROJECT_TYPE, PAGINATION, DEFAULT_QUERY, CLIENT } from '../constant'; 3 | import { SearchResponse } from 'elasticsearch'; 4 | import { clientTemplate } from '../template'; 5 | import { searchString, esSort, esFilters, Filters } from '../utils'; 6 | 7 | const projectElasticConfig = { 8 | index: PROJECT_INDEX, 9 | type: PROJECT_TYPE, 10 | _source: true, 11 | }; 12 | 13 | export const getProject = async (id: string): Promise => { 14 | return elasticClient.getSource({ 15 | id: id, 16 | ...projectElasticConfig, 17 | }); 18 | }; 19 | 20 | export const getProjects = async (perPage: number = PAGINATION.PER_PAGE, page: number = PAGINATION.PAGE, 21 | query: string = DEFAULT_QUERY, sort: string[] = [], filters: Filters, client: string = CLIENT.DEFAULT) 22 | : Promise> => { 23 | 24 | return elasticClient.search({ 25 | ...projectElasticConfig, 26 | size: perPage, 27 | from: perPage * (page - 1), 28 | sort: esSort(query, sort), 29 | body: { 30 | query: { 31 | filtered: { 32 | query: { 33 | bool: { 34 | should: [ 35 | searchString(query, [ 36 | 'name.attribute' 37 | ]), 38 | ], 39 | } 40 | } 41 | } 42 | }, 43 | filter: { 44 | and: { 45 | filters: [ 46 | ...clientTemplate(client), 47 | ...esFilters(filters), 48 | ] 49 | } 50 | } 51 | } 52 | }); 53 | }; 54 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "graphql-elasticsearch-starter", 3 | "version": "1.0.0", 4 | "description": "Graphql App using Node with typescript, KOA framework. Elasticsearch for dataStore. Middlewares JWT, CORS, Winston Logger.", 5 | "main": "index.js", 6 | "engines": { 7 | "node": "10.11.0" 8 | }, 9 | "scripts": { 10 | "build-ts": "tsc", 11 | "lint": "tslint -c tslint.json -p tsconfig.json", 12 | "lint:fix": "tslint -c tslint.json -p tsconfig.json --fix", 13 | "build": "npm run lint && npm run build-ts", 14 | "serve": "ts-node src/index.ts", 15 | "start": "nodemon --watch 'src/**/*' -e ts,tsx --exec ts-node src/index.ts" 16 | }, 17 | "keywords": [ 18 | "typescript", 19 | "koa", 20 | "koa2", 21 | "winston", 22 | "rest", 23 | "starter", 24 | "helmet", 25 | "api", 26 | "cors", 27 | "apollo server", 28 | "elasticsearch", 29 | "graphql", 30 | "node", 31 | "axios" 32 | ], 33 | "author": "Murtaza Nathani (mudza100@gmail.com)", 34 | "devDependencies": { 35 | "@koa/cors": "^2.2.3", 36 | "@types/axios": "^0.14.0", 37 | "@types/dotenv": "^6.1.0", 38 | "@types/elasticsearch": "^5.0.31", 39 | "@types/graphql": "^14.0.7", 40 | "@types/graphql-iso-date": "^3.3.1", 41 | "@types/graphql-type-json": "^0.1.3", 42 | "@types/koa": "^2.0.48", 43 | "@types/koa-helmet": "^3.1.2", 44 | "@types/underscore": "^1.8.13", 45 | "@types/winston": "^2.4.4", 46 | "axios": "^0.18.0", 47 | "nodemon": "^1.18.10", 48 | "ts-node": "8.0.2", 49 | "tslint": "^5.13.0", 50 | "typescript": "^3.3.3" 51 | }, 52 | "dependencies": { 53 | "@okgrow/graphql-scalars": "^0.4.5", 54 | "apollo-server": "^2.4.2", 55 | "apollo-server-koa": "^2.4.7", 56 | "cors": "^2.8.5", 57 | "dotenv": "^6.2.0", 58 | "elasticsearch": "^15.4.1", 59 | "graphql": "^14.1.1", 60 | "graphql-iso-date": "^3.6.1", 61 | "graphql-tools": "^4.0.4", 62 | "graphql-type-json": "^0.2.1", 63 | "koa": "^2.7.0", 64 | "koa-helmet": "^4.0.0", 65 | "underscore": "^1.9.1", 66 | "winston": "^3.2.1" 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /src/api/http-request.ts: -------------------------------------------------------------------------------- 1 | import axios, { AxiosInstance, AxiosPromise, AxiosRequestConfig, AxiosResponse } from 'axios'; 2 | 3 | class HttpRequest { 4 | public axios: AxiosInstance; 5 | constructor(baseURL: string) { 6 | this.axios = axios.create({ 7 | baseURL: baseURL, 8 | }); 9 | } 10 | 11 | public reponseInterceptor(response: AxiosResponse) { 12 | // Add a response interceptor 13 | this.axios.interceptors.response.use( 14 | (response): AxiosResponse | Promise => { 15 | // Do something with response data 16 | return response; 17 | }, 18 | error => { 19 | // Do something with response error 20 | return Promise.reject(error); 21 | }, 22 | ); 23 | } 24 | 25 | public requsetInterceptor(config: AxiosRequestConfig) { 26 | this.axios.interceptors.request.use( 27 | (config): AxiosRequestConfig | Promise => { 28 | // Do something before request is sent 29 | return config; 30 | }, 31 | error => { 32 | // Do something with request error 33 | return Promise.reject(error); 34 | }, 35 | ); 36 | } 37 | 38 | public fetch(url: string, params: object, config: AxiosRequestConfig = {}): AxiosPromise { 39 | return this.axios.get(url, { 40 | params, 41 | ...config, 42 | }); 43 | } 44 | 45 | public create(url: string, data: object, config: AxiosRequestConfig = {}): AxiosPromise { 46 | return this.axios.post(url, data, { 47 | ...config, 48 | }); 49 | } 50 | 51 | public update(url: string, data: object, config: AxiosRequestConfig = {}): AxiosPromise { 52 | return this.axios.put(url, data, { 53 | ...config, 54 | }); 55 | } 56 | 57 | public patch(url: string, data: object, config: AxiosRequestConfig = {}): AxiosPromise { 58 | return this.axios.patch(url, data, { 59 | ...config, 60 | }); 61 | } 62 | 63 | public remove(url: string, params: object, config: AxiosRequestConfig = {}): AxiosPromise { 64 | return this.axios.delete(url, { 65 | params, 66 | ...config, 67 | }); 68 | } 69 | } 70 | 71 | export default HttpRequest; 72 | -------------------------------------------------------------------------------- /src/utils/filters/date-filter.ts: -------------------------------------------------------------------------------- 1 | import * as _ from 'underscore'; 2 | 3 | interface DateRange { 4 | to: Date; 5 | from: Date; 6 | } 7 | 8 | interface DateOperators { 9 | eq: Date; 10 | lt: Date; 11 | lte: Date; 12 | gt: Date; 13 | gte: Date; 14 | between: DateRange; 15 | } 16 | 17 | export interface DateFilter { 18 | field: string; 19 | operator: DateOperators; 20 | } 21 | 22 | const dateComparision = (filter: DateFilter, key: string) => { 23 | const { operator, field } = filter; 24 | return { 25 | bool: { 26 | must: [{ 27 | range: { 28 | [field]: { 29 | [key]: operator[key] 30 | } 31 | } 32 | }] 33 | } 34 | }; 35 | }; 36 | 37 | const dateRange = (filter: DateFilter) => { 38 | const { operator, field } = filter; 39 | return { 40 | bool: { 41 | must: [{ 42 | range: { 43 | [field]: { 44 | gt: operator.between.from, 45 | lt: operator.between.to 46 | } 47 | } 48 | }] 49 | } 50 | }; 51 | }; 52 | 53 | const dateMatch = (filter: DateFilter, key: string) => { 54 | const { operator, field } = filter; 55 | return { 56 | bool: { 57 | must: [ 58 | { 59 | term: { 60 | [field]: operator[key] 61 | } 62 | } 63 | ] 64 | } 65 | }; 66 | }; 67 | 68 | const dateOperators = (filter: DateFilter) => { 69 | const { operator, field } = filter; 70 | const key = Object.keys(operator)[0]; 71 | let resultFilter = {}; 72 | 73 | if (_.isEmpty(field)) { 74 | throw Error('no field found for the filed.'); 75 | } 76 | 77 | if (_.isEmpty(key)) { 78 | throw Error('no operator found for the filed.'); 79 | } 80 | switch (key) { 81 | case 'lt': 82 | case 'lte': 83 | case 'gt': 84 | case 'gte': 85 | resultFilter = dateComparision(filter, key); 86 | break; 87 | case 'eq': 88 | resultFilter = dateMatch(filter, key); 89 | break; 90 | case 'between': 91 | resultFilter = dateRange(filter); 92 | default: 93 | resultFilter = {}; 94 | break; 95 | } 96 | 97 | return resultFilter; 98 | }; 99 | 100 | export const dateFilter = (dateFilters: Array): any => { 101 | let result = {}; 102 | dateFilters.forEach( (filter) => { 103 | result = { ...result, ...dateOperators(filter) }; 104 | }); 105 | 106 | return result; 107 | }; -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------