├── .nvmrc ├── public └── robots.txt ├── .gitattributes ├── .env.example ├── tsconfig.build.json ├── .idea ├── codeStyles │ ├── codeStyleConfig.xml │ └── Project.xml ├── vcs.xml ├── .gitignore ├── jsLibraryMappings.xml ├── modules.xml ├── Screenshot-API.iml ├── prettier.xml └── php.xml ├── src ├── config │ └── configuration.ts ├── app.module.ts ├── cluster.service.ts ├── app.controller.spec.ts ├── app.controller.ts ├── main.ts ├── app.service.ts └── dto │ └── CaptureDTO.ts ├── nest-cli.json ├── .prettierrc ├── test ├── jest-e2e.json └── app.e2e-spec.ts ├── .github └── art │ └── icon.svg ├── tsconfig.json ├── .eslintrc.js ├── Dockerfile ├── README.md ├── package.json ├── .gitignore └── LICENSE /.nvmrc: -------------------------------------------------------------------------------- 1 | v21 -------------------------------------------------------------------------------- /public/robots.txt: -------------------------------------------------------------------------------- 1 | User-agent: * 2 | Disallow: / -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | NODE_ENV=development 2 | 3 | PORT=5000 4 | 5 | ALLOWED_HOSTS="localhost, example.com" -------------------------------------------------------------------------------- /tsconfig.build.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./tsconfig.json", 3 | "exclude": ["node_modules", "test", "dist", "**/*spec.ts"] 4 | } 5 | -------------------------------------------------------------------------------- /.idea/codeStyles/codeStyleConfig.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | -------------------------------------------------------------------------------- /src/config/configuration.ts: -------------------------------------------------------------------------------- 1 | export default () => ({ 2 | port: parseInt(process.env.PORT ?? '5000', 10), 3 | 4 | allowedHosts: process.env.ALLOWED_HOSTS?.split(', ') ?? ['localhost'] 5 | }) 6 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /nest-cli.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://json.schemastore.org/nest-cli", 3 | "collection": "@nestjs/schematics", 4 | "sourceRoot": "src", 5 | "compilerOptions": { 6 | "deleteOutDir": true 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | # Editor-based HTTP Client requests 5 | /httpRequests/ 6 | # Datasource local storage ignored files 7 | /dataSources/ 8 | /dataSources.local.xml 9 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "printWidth": 120, 3 | "useTabs": true, 4 | "semi": false, 5 | "arrowParens": "always", 6 | "singleQuote": true, 7 | "trailingComma": "none", 8 | "singleAttributePerLine": true 9 | } 10 | -------------------------------------------------------------------------------- /.idea/jsLibraryMappings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /test/jest-e2e.json: -------------------------------------------------------------------------------- 1 | { 2 | "moduleFileExtensions": ["js", "json", "ts"], 3 | "rootDir": ".", 4 | "testEnvironment": "node", 5 | "testRegex": ".e2e-spec.ts$", 6 | "transform": { 7 | "^.+\\.(t|j)s$": "ts-jest" 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.idea/Screenshot-API.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.idea/prettier.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 8 | -------------------------------------------------------------------------------- /.github/art/icon.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 8 | 9 | -------------------------------------------------------------------------------- /src/app.module.ts: -------------------------------------------------------------------------------- 1 | import { Module } from '@nestjs/common' 2 | import { AppController } from './app.controller' 3 | import { AppService } from './app.service' 4 | import configuration from './config/configuration' 5 | import { ConfigModule } from '@nestjs/config' 6 | 7 | @Module({ 8 | imports: [ 9 | ConfigModule.forRoot({ 10 | isGlobal: true, 11 | cache: true, 12 | 13 | load: [configuration] 14 | }) 15 | ], 16 | controllers: [AppController], 17 | providers: [AppService] 18 | }) 19 | export class AppModule {} 20 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "module": "commonjs", 4 | "declaration": true, 5 | "removeComments": true, 6 | "emitDecoratorMetadata": true, 7 | "experimentalDecorators": true, 8 | "allowSyntheticDefaultImports": true, 9 | "target": "ESNext", 10 | "sourceMap": true, 11 | "outDir": "./dist", 12 | "baseUrl": "./", 13 | "incremental": true, 14 | "skipLibCheck": true, 15 | "strictNullChecks": true, 16 | "noImplicitAny": true, 17 | "strictBindCallApply": true, 18 | "forceConsistentCasingInFileNames": true, 19 | "noFallthroughCasesInSwitch": true 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /.idea/php.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | 7 | 9 | 10 | 12 | 13 | 15 | 16 | 18 | -------------------------------------------------------------------------------- /test/app.e2e-spec.ts: -------------------------------------------------------------------------------- 1 | import { Test, TestingModule } from '@nestjs/testing'; 2 | import { INestApplication } from '@nestjs/common'; 3 | import * as request from 'supertest'; 4 | import { AppModule } from './../src/app.module'; 5 | 6 | describe('AppController (e2e)', () => { 7 | let app: INestApplication; 8 | 9 | beforeEach(async () => { 10 | const moduleFixture: TestingModule = await Test.createTestingModule({ 11 | imports: [AppModule], 12 | }).compile(); 13 | 14 | app = moduleFixture.createNestApplication(); 15 | await app.init(); 16 | }); 17 | 18 | it('/ (GET)', () => { 19 | return request(app.getHttpServer()) 20 | .get('/') 21 | .expect(200) 22 | .expect('Hello World!'); 23 | }); 24 | }); 25 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | parser: '@typescript-eslint/parser', 3 | parserOptions: { 4 | project: 'tsconfig.json', 5 | tsconfigRootDir: __dirname, 6 | sourceType: 'module', 7 | }, 8 | plugins: ['@typescript-eslint/eslint-plugin'], 9 | extends: [ 10 | 'plugin:@typescript-eslint/recommended', 11 | 'plugin:prettier/recommended', 12 | ], 13 | root: true, 14 | env: { 15 | node: true, 16 | jest: true, 17 | }, 18 | ignorePatterns: ['.eslintrc.js'], 19 | rules: { 20 | '@typescript-eslint/interface-name-prefix': 'off', 21 | '@typescript-eslint/explicit-function-return-type': 'off', 22 | '@typescript-eslint/explicit-module-boundary-types': 'off', 23 | '@typescript-eslint/no-explicit-any': 'off', 24 | }, 25 | }; 26 | -------------------------------------------------------------------------------- /src/cluster.service.ts: -------------------------------------------------------------------------------- 1 | import { Injectable } from '@nestjs/common' 2 | import { availableParallelism } from 'os' 3 | 4 | // Fix for cluster import - https://stackoverflow.com/a/70320320 5 | import * as _cluster from 'cluster' 6 | 7 | const cluster = _cluster as unknown as _cluster.Cluster 8 | 9 | const numCPUs = process.env.NODE_ENV === 'production' ? availableParallelism() : 1 10 | 11 | @Injectable() 12 | export class AppClusterService { 13 | static clusterize(callback: Function) { 14 | // 15 | 16 | if (cluster.isPrimary) { 17 | console.log(`Primary ${process.pid} is running`) 18 | 19 | for (let i = 0; i < numCPUs; i++) { 20 | cluster.fork() 21 | } 22 | 23 | cluster.on('exit', (worker, code, signal) => { 24 | console.log(`Worker ${worker.process.pid} died. Restarting...`) 25 | }) 26 | 27 | // 28 | } else { 29 | console.log(`Worker ${process.pid} started`) 30 | callback() 31 | } 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/app.controller.spec.ts: -------------------------------------------------------------------------------- 1 | import { Test, TestingModule } from '@nestjs/testing' 2 | import { AppController } from './app.controller' 3 | import { AppService } from './app.service' 4 | 5 | describe('AppController', () => { 6 | let appController: AppController 7 | 8 | beforeEach(async () => { 9 | const app: TestingModule = await Test.createTestingModule({ 10 | controllers: [AppController], 11 | providers: [AppService] 12 | }).compile() 13 | 14 | appController = app.get(AppController) 15 | }) 16 | 17 | describe('/v1/status', () => { 18 | // 19 | 20 | test('GET', () => { 21 | expect(appController.getStatus()).toEqual({ status: 'ok' }) 22 | }) 23 | }) 24 | 25 | describe('/v1/capture', () => { 26 | // 27 | 28 | test('GET akbal.dev', async () => { 29 | // Expect WEBP image 30 | 31 | await appController.getCapture(undefined, { 32 | url: 'https://akbal.dev' 33 | }) 34 | }) 35 | }) 36 | }) 37 | -------------------------------------------------------------------------------- /src/app.controller.ts: -------------------------------------------------------------------------------- 1 | import { Controller, Get, Query, Res } from '@nestjs/common' 2 | import { AppService } from './app.service' 3 | import { CaptureDTO } from './dto/CaptureDTO' 4 | import { FastifyReply } from 'fastify' 5 | 6 | @Controller({ 7 | version: '1' 8 | }) 9 | export class AppController { 10 | constructor(private readonly appService: AppService) {} 11 | 12 | @Get('status') 13 | getStatus() { 14 | return this.appService.getStatus() 15 | } 16 | 17 | @Get('capture') 18 | async getCapture( 19 | // 20 | @Res({ passthrough: true }) response: FastifyReply, 21 | @Query() query: CaptureDTO 22 | ) { 23 | // TODO: Refactor 24 | // In case of error, do not cache 25 | response.header('Cache-Control', 'no-cache') 26 | 27 | const capture = await this.appService.getCapture(query) 28 | 29 | // Cache 12 hours on client | Cache 12 hours on CDN | Stale while revalidate 30 minutes 30 | response.header('Cache-Control', 'max-age=43200, s-maxage=43200, stale-while-revalidate=1800') 31 | 32 | return capture 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:21-alpine 2 | 3 | ENV PORT 3000 4 | ENV NODE_ENV production 5 | 6 | # System dependencies 7 | RUN apk add --no-cache curl 8 | 9 | RUN npm install -g pnpm 10 | 11 | # Install chrome - https://github.com/Zenika/alpine-chrome/blob/master/Dockerfile 12 | RUN apk upgrade --no-cache --available \ 13 | && apk add --no-cache \ 14 | chromium-swiftshader \ 15 | ttf-freefont \ 16 | font-noto-emoji \ 17 | && apk add --no-cache \ 18 | --repository=https://dl-cdn.alpinelinux.org/alpine/edge/community \ 19 | font-wqy-zenhei 20 | 21 | ENV PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium-browser 22 | ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true 23 | 24 | 25 | # Create app directory 26 | WORKDIR /app 27 | 28 | RUN chown -R node:node /app 29 | 30 | COPY --chown=node:node . . 31 | 32 | 33 | # Install dependencies 34 | RUN pnpm install --prod=false --frozen-lockfile 35 | 36 | 37 | # Build app 38 | RUN pnpm build 39 | 40 | 41 | # Start 42 | USER node 43 | 44 | EXPOSE $PORT 45 | 46 | HEALTHCHECK --interval=10s --timeout=5s --retries=3 CMD curl -f http://localhost:$PORT/v1/status || exit 1 47 | 48 | # WARN: use with --init (docker run --init) 49 | CMD [ "node", "dist/main.js" ] -------------------------------------------------------------------------------- /src/main.ts: -------------------------------------------------------------------------------- 1 | import { join } from 'path' 2 | import { NestFactory } from '@nestjs/core' 3 | import { FastifyAdapter, NestFastifyApplication } from '@nestjs/platform-fastify' 4 | import { AppModule } from './app.module' 5 | import { ValidationPipe, VersioningType } from '@nestjs/common' 6 | import { ConfigService } from '@nestjs/config' 7 | import { AppClusterService } from './cluster.service' 8 | import fastifyCompress from '@fastify/compress' 9 | import fastifyHelmet from '@fastify/helmet' 10 | 11 | async function bootstrap() { 12 | const app = await NestFactory.create(AppModule, new FastifyAdapter()) 13 | const configService = app.get(ConfigService) 14 | 15 | app.useStaticAssets({ 16 | root: join(__dirname, '..', 'public') 17 | }) 18 | 19 | app.enableVersioning({ 20 | type: VersioningType.URI 21 | }) 22 | 23 | app.useGlobalPipes( 24 | new ValidationPipe({ 25 | transform: true, 26 | whitelist: true, 27 | forbidNonWhitelisted: true 28 | }) 29 | ) 30 | 31 | await app.register(fastifyCompress, { encodings: ['gzip', 'deflate'] }) 32 | 33 | await app.register(fastifyHelmet, { 34 | crossOriginResourcePolicy: false, 35 | crossOriginEmbedderPolicy: false, 36 | crossOriginOpenerPolicy: false 37 | }) 38 | 39 | app.enableCors({ 40 | origin: configService.get('allowedHosts'), 41 | credentials: true 42 | }) 43 | 44 | await app.listen(configService.get('port') as number, '0.0.0.0') 45 | } 46 | 47 | AppClusterService.clusterize(bootstrap) 48 | -------------------------------------------------------------------------------- /src/app.service.ts: -------------------------------------------------------------------------------- 1 | import { Injectable, StreamableFile } from '@nestjs/common' 2 | import { CaptureDTO } from './dto/CaptureDTO' 3 | 4 | @Injectable() 5 | export class AppService { 6 | getStatus() { 7 | return { status: 'ok' } 8 | } 9 | 10 | async getCapture(query: CaptureDTO) { 11 | /** 12 | * @type {import('capture-website')} 13 | */ 14 | const { default: captureWebsite } = await eval(`import('capture-website')`) 15 | 16 | const websiteBuffer = await captureWebsite.buffer(query.url, { 17 | width: query.width, 18 | height: query.height, 19 | 20 | scaleFactor: query.scale, 21 | 22 | type: query.mime_type, 23 | quality: query.quality, 24 | 25 | timeout: query.timeout, 26 | delay: query.delay, 27 | 28 | disableAnimations: true, 29 | blockAds: true, 30 | 31 | userAgent: 32 | 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36', 33 | 34 | launchOptions: { 35 | // https://cri.dev/posts/2020-04-04-Full-list-of-Chromium-Puppeteer-flags/ 36 | args: [ 37 | // Insecure way to allow it running in Docker 38 | '--headless', 39 | '--no-sandbox', 40 | '--disable-setuid-sandbox', 41 | '--disable-gpu', 42 | 43 | // Aesthetic 44 | '--hide-scrollbars', 45 | '--mute-audio', 46 | '--use-fake-ui-for-media-stream' // Pages that ask for webcam/microphone access 47 | ] 48 | } 49 | }) 50 | 51 | return new StreamableFile(websiteBuffer, { 52 | disposition: 'inline', 53 | type: `image/${query.mime_type}`, 54 | length: websiteBuffer.length 55 | }) 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /src/dto/CaptureDTO.ts: -------------------------------------------------------------------------------- 1 | import { IsIn, IsInt, IsNotEmpty, IsNumber, IsOptional, IsString, IsUrl, Max, Min } from 'class-validator' 2 | import { Transform } from 'class-transformer' 3 | 4 | export class CaptureDTO { 5 | @IsUrl() 6 | url: string 7 | 8 | @IsInt() 9 | @Max(4096) 10 | @Min(1) 11 | @Transform(({ value }) => parseInt(value)) 12 | @IsOptional() 13 | width: number = 1024 14 | 15 | @IsInt() 16 | @Max(4096) 17 | @Min(1) 18 | @Transform(({ value }) => parseInt(value)) 19 | @IsOptional() 20 | height: number = 768 21 | 22 | @IsInt() 23 | @Max(2) 24 | @Min(1) 25 | @Transform(({ value }) => parseInt(value)) 26 | @IsOptional() 27 | scale: number = 1 28 | 29 | @IsInt() 30 | @Max(60) 31 | @Min(1) 32 | @Transform(({ value }) => parseInt(value)) 33 | @IsOptional() 34 | timeout: number = 15 35 | 36 | @IsInt() 37 | @Min(0) 38 | @Max(5) 39 | @Transform(({ value }) => parseInt(value)) 40 | @IsOptional() 41 | delay: number = 0 42 | 43 | @IsString() 44 | @IsNotEmpty() 45 | @IsIn(['jpeg', 'png', 'webp']) 46 | @IsOptional() 47 | mime_type: string = 'webp' 48 | 49 | @IsNumber() 50 | @Min(0) 51 | @Max(1) 52 | @Transform(({ value }) => parseFloat(value)) 53 | @IsOptional() 54 | quality: number = 0.8 55 | } 56 | 57 | // export const captureDto = Joi.object({ 58 | // url: Joi.string().uri().required(), 59 | // 60 | // width: Joi.number().integer().positive().optional().default(1024), 61 | // 62 | // height: Joi.number().integer().positive().optional().default(768), 63 | // 64 | // delay: Joi.number().integer().positive().optional().default(0), 65 | // 66 | // mime_type: Joi.string().valid('jpeg', 'png', 'webp').optional().default('webp'), 67 | // 68 | // quality: Joi.number().min(0).max(1).optional().default(0.8), 69 | // 70 | // }); 71 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | Icon 5 |

6 | 7 |

8 | Screenshot API 9 |

10 | 11 | A simple self-hosted API to take screenshots of websites using Puppeteer. 12 | 13 | ### Technologies 14 | 15 | A [NestJS](https://nestjs.com/) wrapper around [capture-website](https://github.com/sindresorhus/capture-website). 16 | 17 | Check the [package.json](package.json) for the full list of dependencies. 18 | 19 | Check the [Dockerfile](Dockerfile) to see how the image is built. 20 | 21 | ### Endpoints 22 | 23 | #### GET /v1/capture 24 | 25 | | Parameter | Type | Default Value | Description | 26 | |-----------|--------|---------------|------------------------------| 27 | | url | string | | URL to capture | 28 | | width | number | 1024 | Viewport width | 29 | | height | number | 768 | Viewport height | 30 | | scale | number | 1 | Scale factor of the viewport | 31 | | timeout | number | 15 | Timeout before giving up | 32 | | delay | number | 0 | Delay after page load | 33 | | mime_type | string | webp | jpg, png or webp | 34 | | quality | number | 0.8 | Image quality | 35 | 36 | You can view the full query parameters [here](src/dto/CaptureDTO.js). 37 | 38 | ## Development 39 | 40 | ### Installation 41 | 42 | ```bash 43 | pnpm install 44 | ``` 45 | 46 | ### Configuration 47 | 48 | ```bash 49 | cp .env.example .env 50 | nano .env 51 | ``` 52 | 53 | ### Running the app 54 | 55 | ```bash 56 | # development 57 | pnpm run start 58 | 59 | # watch mode 60 | pnpm run start:dev 61 | 62 | # production mode 63 | pnpm run start:prod 64 | ``` 65 | 66 | ### Test 67 | 68 | ```bash 69 | # unit tests 70 | pnpm run test 71 | 72 | # e2e tests 73 | pnpm run test:e2e 74 | 75 | # test coverage 76 | pnpm run test:cov 77 | ``` 78 | 79 | ## Building for production 80 | 81 | ```bash 82 | docker build -t screenshot-api . 83 | 84 | docker run -p 3000:3000 screenshot-api 85 | ``` 86 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "screenshot-api", 3 | "version": "0.0.1", 4 | "description": "", 5 | "author": "", 6 | "private": true, 7 | "license": "AGPL-3.0", 8 | "engines": { 9 | "node": ">=21" 10 | }, 11 | "scripts": { 12 | "build": "nest build", 13 | "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"", 14 | "start": "node dist/main", 15 | "start:dev": "nest start --watch", 16 | "start:debug": "nest start --debug --watch", 17 | "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix", 18 | "test": "jest", 19 | "test:watch": "jest --watch", 20 | "test:cov": "jest --coverage", 21 | "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand", 22 | "test:e2e": "jest --config ./test/jest-e2e.json" 23 | }, 24 | "dependencies": { 25 | "@fastify/compress": "^7.0.3", 26 | "@fastify/helmet": "^11.1.1", 27 | "@fastify/static": "^7.0.4", 28 | "@nestjs/common": "^10.4.20", 29 | "@nestjs/config": "^3.3.0", 30 | "@nestjs/core": "^10.4.20", 31 | "@nestjs/platform-express": "^10.4.20", 32 | "@nestjs/platform-fastify": "^10.4.20", 33 | "capture-website": "^4.2.0", 34 | "class-transformer": "^0.5.1", 35 | "class-validator": "^0.14.2", 36 | "fastify": "^4.29.1", 37 | "i": "^0.3.7", 38 | "reflect-metadata": "^0.2.2", 39 | "rxjs": "^7.8.2" 40 | }, 41 | "devDependencies": { 42 | "@nestjs/cli": "^10.4.9", 43 | "@nestjs/schematics": "^10.2.3", 44 | "@nestjs/testing": "^10.4.20", 45 | "@types/express": "^4.17.23", 46 | "@types/jest": "^29.5.14", 47 | "@types/node": "^20.19.19", 48 | "@types/supertest": "^6.0.3", 49 | "@typescript-eslint/eslint-plugin": "^7.18.0", 50 | "@typescript-eslint/parser": "^7.18.0", 51 | "eslint": "^9.37.0", 52 | "eslint-config-prettier": "^9.1.2", 53 | "eslint-plugin-prettier": "^5.5.4", 54 | "jest": "^29.7.0", 55 | "prettier": "^3.6.2", 56 | "source-map-support": "^0.5.21", 57 | "supertest": "^6.3.4", 58 | "ts-jest": "^29.4.4", 59 | "ts-loader": "^9.5.4", 60 | "ts-node": "^10.9.2", 61 | "tsconfig-paths": "^4.2.0", 62 | "typescript": "^5.9.3" 63 | }, 64 | "jest": { 65 | "moduleFileExtensions": [ 66 | "js", 67 | "json", 68 | "ts" 69 | ], 70 | "rootDir": "src", 71 | "testRegex": ".*\\.spec\\.ts$", 72 | "transform": { 73 | "^.+\\.(t|j)s$": "ts-jest" 74 | }, 75 | "collectCoverageFrom": [ 76 | "**/*.(t|j)s" 77 | ], 78 | "coverageDirectory": "../coverage", 79 | "testEnvironment": "node" 80 | }, 81 | "pnpm": { 82 | "overrides": { 83 | "fastify": "^4.29.1" 84 | } 85 | } 86 | } 87 | -------------------------------------------------------------------------------- /.idea/codeStyles/Project.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 8 | 9 | 18 | 19 | 28 | 29 | 32 | 33 | 41 | 42 | 50 | 51 | 59 | 60 | 66 | 67 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### Custom 2 | engine.bin 3 | 4 | # compiled output 5 | /dist 6 | /node_modules 7 | /build 8 | 9 | # Logs 10 | logs 11 | *.log 12 | npm-debug.log* 13 | pnpm-debug.log* 14 | yarn-debug.log* 15 | yarn-error.log* 16 | lerna-debug.log* 17 | 18 | # OS 19 | .DS_Store 20 | 21 | # Tests 22 | /coverage 23 | /.nyc_output 24 | 25 | # IDEs and editors 26 | /.idea 27 | .project 28 | .classpath 29 | .c9/ 30 | *.launch 31 | .settings/ 32 | *.sublime-workspace 33 | 34 | # IDE - VSCode 35 | .vscode/* 36 | !.vscode/settings.json 37 | !.vscode/tasks.json 38 | !.vscode/launch.json 39 | !.vscode/extensions.json 40 | 41 | # dotenv environment variable files 42 | .env 43 | .env.development.local 44 | .env.test.local 45 | .env.production.local 46 | .env.local 47 | 48 | # temp directory 49 | .temp 50 | .tmp 51 | 52 | # Runtime data 53 | pids 54 | *.pid 55 | *.seed 56 | *.pid.lock 57 | 58 | # Diagnostic reports (https://nodejs.org/api/report.html) 59 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 60 | 61 | ### VisualStudioCode template 62 | .vscode/* 63 | !.vscode/settings.json 64 | !.vscode/tasks.json 65 | !.vscode/launch.json 66 | !.vscode/extensions.json 67 | !.vscode/*.code-snippets 68 | 69 | # Local History for Visual Studio Code 70 | .history/ 71 | 72 | # Built Visual Studio Code Extensions 73 | *.vsix 74 | 75 | ### JetBrains template 76 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 77 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 78 | 79 | # User-specific stuff 80 | .idea/**/workspace.xml 81 | .idea/**/tasks.xml 82 | .idea/**/usage.statistics.xml 83 | .idea/**/dictionaries 84 | .idea/**/shelf 85 | 86 | # AWS User-specific 87 | .idea/**/aws.xml 88 | 89 | # Generated files 90 | .idea/**/contentModel.xml 91 | 92 | # Sensitive or high-churn files 93 | .idea/**/dataSources/ 94 | .idea/**/dataSources.ids 95 | .idea/**/dataSources.local.xml 96 | .idea/**/sqlDataSources.xml 97 | .idea/**/dynamic.xml 98 | .idea/**/uiDesigner.xml 99 | .idea/**/dbnavigator.xml 100 | 101 | # Gradle 102 | .idea/**/gradle.xml 103 | .idea/**/libraries 104 | 105 | # Gradle and Maven with auto-import 106 | # When using Gradle or Maven with auto-import, you should exclude module files, 107 | # since they will be recreated, and may cause churn. Uncomment if using 108 | # auto-import. 109 | # .idea/artifacts 110 | # .idea/compiler.xml 111 | # .idea/jarRepositories.xml 112 | # .idea/modules.xml 113 | # .idea/*.iml 114 | # .idea/modules 115 | # *.iml 116 | # *.ipr 117 | 118 | # CMake 119 | cmake-build-*/ 120 | 121 | # Mongo Explorer plugin 122 | .idea/**/mongoSettings.xml 123 | 124 | # File-based project format 125 | *.iws 126 | 127 | # IntelliJ 128 | out/ 129 | 130 | # mpeltonen/sbt-idea plugin 131 | .idea_modules/ 132 | 133 | # JIRA plugin 134 | atlassian-ide-plugin.xml 135 | 136 | # Cursive Clojure plugin 137 | .idea/replstate.xml 138 | 139 | # SonarLint plugin 140 | .idea/sonarlint/ 141 | 142 | # Crashlytics plugin (for Android Studio and IntelliJ) 143 | com_crashlytics_export_strings.xml 144 | crashlytics.properties 145 | crashlytics-build.properties 146 | fabric.properties 147 | 148 | # Editor-based Rest Client 149 | .idea/httpRequests 150 | 151 | # Android studio 3.1+ serialized cache file 152 | .idea/caches/build_file_checksums.ser 153 | 154 | ### Node template 155 | # Logs 156 | logs 157 | *.log 158 | npm-debug.log* 159 | yarn-debug.log* 160 | yarn-error.log* 161 | lerna-debug.log* 162 | .pnpm-debug.log* 163 | 164 | # Diagnostic reports (https://nodejs.org/api/report.html) 165 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 166 | 167 | # Runtime data 168 | pids 169 | *.pid 170 | *.seed 171 | *.pid.lock 172 | 173 | # Directory for instrumented libs generated by jscoverage/JSCover 174 | lib-cov 175 | 176 | # Coverage directory used by tools like istanbul 177 | coverage 178 | *.lcov 179 | 180 | # nyc test coverage 181 | .nyc_output 182 | 183 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 184 | .grunt 185 | 186 | # Bower dependency directory (https://bower.io/) 187 | bower_components 188 | 189 | # node-waf configuration 190 | .lock-wscript 191 | 192 | # Compiled binary addons (https://nodejs.org/api/addons.html) 193 | build/Release 194 | 195 | # Dependency directories 196 | node_modules/ 197 | jspm_packages/ 198 | 199 | # Snowpack dependency directory (https://snowpack.dev/) 200 | web_modules/ 201 | 202 | # TypeScript cache 203 | *.tsbuildinfo 204 | 205 | # Optional npm cache directory 206 | .npm 207 | 208 | # Optional eslint cache 209 | .eslintcache 210 | 211 | # Optional stylelint cache 212 | .stylelintcache 213 | 214 | # Microbundle cache 215 | .rpt2_cache/ 216 | .rts2_cache_cjs/ 217 | .rts2_cache_es/ 218 | .rts2_cache_umd/ 219 | 220 | # Optional REPL history 221 | .node_repl_history 222 | 223 | # Output of 'npm pack' 224 | *.tgz 225 | 226 | # Yarn Integrity file 227 | .yarn-integrity 228 | 229 | # dotenv environment variable files 230 | .env 231 | .env.development.local 232 | .env.test.local 233 | .env.production.local 234 | .env.local 235 | 236 | # parcel-bundler cache (https://parceljs.org/) 237 | .cache 238 | .parcel-cache 239 | 240 | # Next.js build output 241 | .next 242 | out 243 | 244 | # Nuxt.js build / generate output 245 | .nuxt 246 | dist 247 | 248 | # Gatsby files 249 | .cache/ 250 | # Comment in the public line in if your project uses Gatsby and not Next.js 251 | # https://nextjs.org/blog/next-9-1#public-directory-support 252 | # public 253 | 254 | # vuepress build output 255 | .vuepress/dist 256 | 257 | # vuepress v2.x temp and cache directory 258 | .temp 259 | .cache 260 | 261 | # Docusaurus cache and generated files 262 | .docusaurus 263 | 264 | # Serverless directories 265 | .serverless/ 266 | 267 | # FuseBox cache 268 | .fusebox/ 269 | 270 | # DynamoDB Local files 271 | .dynamodb/ 272 | 273 | # TernJS port file 274 | .tern-port 275 | 276 | # Stores VSCode versions used for testing VSCode extensions 277 | .vscode-test 278 | 279 | # yarn v2 280 | .yarn/cache 281 | .yarn/unplugged 282 | .yarn/build-state.yml 283 | .yarn/install-state.gz 284 | .pnp.* 285 | 286 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------