├── .gitignore
├── __tests__
├── testPairings.json
├── checkIn.test.ts
├── startConversations.test.ts
└── generatePairs.test.ts
├── babel.config.js
├── utils
├── data
│ └── pairings.json
├── buttons.ts
├── checkMessageHistory.ts
├── startConversations.ts
└── generatePairs.ts
├── scripts
├── checkInScript.ts
├── pairAndConverseScript.ts
└── weeklyInteractionScript.ts
├── tsconfig.json
├── database
├── dbConfig.ts
├── statusDataManager.ts
├── pairsDataManager.ts
├── usersDataManager.ts
└── poolDataManager.ts
├── appConfig.ts
├── README.md
├── .github
└── workflows
│ └── weeklyInteraction.yml
├── package.json
├── pairAndIntroduce.ts
├── lambdaFiles
└── mainLambda.js
├── jest.config.ts
└── LICENSE
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules/
2 | bin/
3 | .idea*
4 | .env
--------------------------------------------------------------------------------
/__tests__/testPairings.json:
--------------------------------------------------------------------------------
1 | [["test_channel",["Jia"]]]
2 |
--------------------------------------------------------------------------------
/babel.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | presets: [
3 | ['@babel/preset-env', {targets: {node: 'current'}}],
4 | '@babel/preset-typescript',
5 | ],
6 | };
--------------------------------------------------------------------------------
/utils/data/pairings.json:
--------------------------------------------------------------------------------
1 | {
2 | "C036L3EUX8R": [
3 | "U02CPHBDP5G",
4 | "U018N3UV6Q7"
5 | ],
6 | "C0412JNN7SQ": [
7 | "U01KD7HUS64",
8 | "UR20JQF34",
9 | "UM4BRPNRZ"
10 | ]
11 | }
--------------------------------------------------------------------------------
/scripts/checkInScript.ts:
--------------------------------------------------------------------------------
1 | import { appConfig } from '../appConfig';
2 | import { sendCheckInDM } from '../utils/buttons';
3 |
4 | sendCheckInDM(appConfig);
5 | console.log("LOG INFO: sent midpoint checkin to all group dms");
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "target": "es2017",
4 | "module": "commonjs",
5 | "strict": true,
6 | "outDir": "bin",
7 | "esModuleInterop": true,
8 | "resolveJsonModule": true
9 | }
10 | }
11 |
--------------------------------------------------------------------------------
/database/dbConfig.ts:
--------------------------------------------------------------------------------
1 | const AWS = require('aws-sdk');
2 | require('dotenv').config();
3 |
4 | AWS.config.update({
5 | region: process.env.DB_DEFAULT_REGION,
6 | accessKeyId: process.env.DB_ACCESS_KEY_ID,
7 | secretAccessKey: process.env.DB_SECRET_ACCESS_KEY
8 | });
9 |
10 | export const DB_CLIENT = new AWS.DynamoDB.DocumentClient();
--------------------------------------------------------------------------------
/appConfig.ts:
--------------------------------------------------------------------------------
1 | import { App } from '@slack/bolt';
2 | require('dotenv').config();
3 |
4 | // Initializes your app with your bot token and signing secret
5 | export const appConfig = new App({
6 | token: process.env.SLACK_BOT_TOKEN,
7 | signingSecret: process.env.SLACK_SIGNING_SECRET,
8 | socketMode: true,
9 | appToken: process.env.SLACK_APP_TOKEN
10 | });
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # boba-buddies
2 | Sandbox's virtual water cooler conversation app.
3 |
4 |
5 | ## How to Contribute :D
6 | At the current state of things, feel free to take on any open issues and make a PR for it.
7 |
8 | ### Tech Stack
9 | TypeScript
10 | Node.js
11 | Slack Bolt API
12 | Jest Framework for Testing
13 |
14 | ### Wiki
15 | https://www.notion.so/Boba-Buddies-WIP-c90d9071bfad43b4aa679aee7b0eb913#00415aa2d4c14edc979dd3589cf2fdfb
16 |
--------------------------------------------------------------------------------
/scripts/pairAndConverseScript.ts:
--------------------------------------------------------------------------------
1 | import { appConfig } from '../appConfig';
2 | import { generatePairs } from '../utils/generatePairs';
3 | import { startConversations } from '../utils/startConversations';
4 |
5 | const yeet = async () => {
6 | let pairList = await generatePairs(appConfig);
7 | console.log("LOG INFO: pairings for this run is done: ", pairList);
8 | await startConversations(appConfig, pairList);
9 | console.log("LOG INFO: started conversations with the pairings");
10 | }
11 |
12 | yeet();
--------------------------------------------------------------------------------
/database/statusDataManager.ts:
--------------------------------------------------------------------------------
1 | import { DB_CLIENT } from "./dbConfig";
2 |
3 | const STATUS_TABLE: string = "boba-buddies-status";
4 | const STATUS_ID: string = "CURRENT_STATUS";
5 |
6 | export class StatusDataManager {
7 | async getStatus(): Promise {
8 | const getParam = {
9 | TableName: STATUS_TABLE
10 | }
11 |
12 | const result = await DB_CLIENT.scan(getParam).promise();
13 |
14 | return result.Items.map((item: any) => item.shouldPair).every(Boolean);
15 | }
16 |
17 | async putStatus(oldStatus: boolean): Promise {
18 | const putParam = {
19 | TableName: STATUS_TABLE,
20 | Item: {
21 | "weeklyStatus": STATUS_ID,
22 | "shouldPair": !oldStatus
23 | }
24 | }
25 |
26 | return await DB_CLIENT.put(putParam).promise();
27 | }
28 | }
--------------------------------------------------------------------------------
/.github/workflows/weeklyInteraction.yml:
--------------------------------------------------------------------------------
1 | name: "Weekly Interaction"
2 | on:
3 | schedule:
4 | - cron: "0 15 * 1-4,9-12 0"
5 |
6 | jobs:
7 | interact:
8 | runs-on: ubuntu-latest
9 | steps:
10 | - uses: actions/checkout@v3
11 | - run: npm install
12 | - name: Pair or Check In on Buddies
13 | env:
14 | SLACK_SIGNING_SECRET: ${{ secrets.SLACK_SIGNING_SECRET }}
15 | SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
16 | SLACK_APP_TOKEN: ${{ secrets.SLACK_APP_TOKEN }}
17 | PAIRINGS_PATH: ${{ secrets.PAIRINGS_PATH }}
18 | DB_ACCESS_KEY_ID: ${{ secrets.DB_ACCESS_KEY_ID }}
19 | DB_SECRET_ACCESS_KEY: ${{ secrets.DB_SECRET_ACCESS_KEY }}
20 | DB_DEFAULT_REGION: ${{ secrets.DB_DEFAULT_REGION }}
21 | run: npm run weekly
22 |
--------------------------------------------------------------------------------
/scripts/weeklyInteractionScript.ts:
--------------------------------------------------------------------------------
1 | import { appConfig } from '../appConfig';
2 | import { sendCheckInDM } from '../utils/buttons';
3 | import { generatePairs } from '../utils/generatePairs';
4 | import { startConversations } from '../utils/startConversations';
5 | import { StatusDataManager } from '../database/statusDataManager';
6 |
7 | const interactWithBuddies = async () => {
8 | const statusManager = new StatusDataManager();
9 |
10 | const shouldPair = await statusManager.getStatus();
11 | console.log(shouldPair
12 | ? "LOG INFO: PAIRING will happen for this week"
13 | : "LOG INFO: CHECKING IN will happen for this week");
14 |
15 | if (shouldPair) {
16 | let pairList = await generatePairs(appConfig);
17 | console.log("LOG INFO: pairings for this run is done: ", pairList);
18 |
19 | await startConversations(appConfig, pairList);
20 | console.log("LOG INFO: started conversations with the pairings");
21 | } else {
22 | await sendCheckInDM(appConfig);
23 | console.log("LOG INFO: sent midpoint checkin to all group dms");
24 | }
25 |
26 | await statusManager.putStatus(shouldPair);
27 | }
28 |
29 | interactWithBuddies();
--------------------------------------------------------------------------------
/database/pairsDataManager.ts:
--------------------------------------------------------------------------------
1 | import { DB_CLIENT } from "./dbConfig";
2 |
3 | const PAIRS_TABLE: string = "boba-buddies-pairs";
4 |
5 | export class PairsDataManager {
6 | async getCurrentPairs(): Promise> {
7 | const params = {
8 | TableName: PAIRS_TABLE
9 | };
10 | const result = await DB_CLIENT.scan(params).promise();
11 | const channelAndPairsMap = new Map();
12 | for(const item of result.Items) {
13 | channelAndPairsMap.set(item.channelId, item.slackUserIds);
14 | }
15 |
16 | return channelAndPairsMap;
17 | }
18 |
19 | async addPairs(channelId: string, slackUserIds: string[]): Promise {
20 | const params = {
21 | TableName: PAIRS_TABLE,
22 | Item: {
23 | "channelId": channelId,
24 | "slackUserIds": slackUserIds
25 | }
26 | }
27 |
28 | return await DB_CLIENT.put(params).promise();
29 | }
30 |
31 | async deleteAllPairs(): Promise {
32 | const channelPairs: Map = await this.getCurrentPairs();
33 | for(const channelId of channelPairs.keys()) {
34 | const params = {
35 | TableName: PAIRS_TABLE,
36 | Key: {
37 | channelId: channelId
38 | }
39 | }
40 |
41 | await DB_CLIENT.delete(params).promise();
42 | }
43 |
44 | return;
45 | }
46 | }
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "boba-buddies",
3 | "version": "1.0.0",
4 | "description": "",
5 | "main": "index.js",
6 | "scripts": {
7 | "test": "cross-env PAIRINGS_PATH=./__tests__/testPairings.json jest",
8 | "build": "tsc",
9 | "start": "ts-node pairAndIntroduce.ts",
10 | "pair": "ts-node ./scripts/pairAndConverseScript.ts",
11 | "checkin": "ts-node ./scripts/checkInScript.ts",
12 | "weekly": "ts-node ./scripts/weeklyInteractionScript.ts"
13 | },
14 | "repository": {
15 | "type": "git",
16 | "url": "git+https://github.com/sandboxnu/boba-buddies.git"
17 | },
18 | "author": "",
19 | "license": "ISC",
20 | "bugs": {
21 | "url": "https://github.com/sandboxnu/boba-buddies/issues"
22 | },
23 | "homepage": "https://github.com/sandboxnu/boba-buddies#readme",
24 | "dependencies": {
25 | "@babel/core": "^7.16.0",
26 | "@babel/preset-env": "^7.16.0",
27 | "@babel/preset-typescript": "^7.16.0",
28 | "@slack/bolt": "^3.8.1",
29 | "aws-sdk": "^2.1227.0",
30 | "babel-jest": "^27.3.1",
31 | "cross-env": "^7.0.3",
32 | "dotenv": "^10.0.0"
33 | },
34 | "devDependencies": {
35 | "@types/jest": "^27.0.2",
36 | "@types/node": "^16.11.7",
37 | "jest": "^27.3.1",
38 | "ts-node": "^10.4.0",
39 | "typescript": "^4.4.4"
40 | }
41 | }
42 |
--------------------------------------------------------------------------------
/pairAndIntroduce.ts:
--------------------------------------------------------------------------------
1 | import { appConfig } from './appConfig';
2 | import { generatePairs, shiftByOne } from './utils/generatePairs';
3 | import { startConversations } from './utils/startConversations';
4 | import { sendCheckInDM } from './utils/buttons';
5 |
6 | const ONE_WEEK_MS = 604800000
7 | let pairingDate = new Date(1652735785000); // TODO: change this to actual start date
8 | let isCheckedIn = false;
9 | let firstPairing = true;
10 |
11 | setInterval(async () => {
12 | const currDate = new Date();
13 |
14 | // @ts-ignore
15 | if (Math.abs(currDate - pairingDate) > (ONE_WEEK_MS * 2)) { // Two weeks, re-gen pairs
16 | let pairs;
17 | if (firstPairing) {
18 | firstPairing = false;
19 | pairs = await generatePairs(appConfig)
20 |
21 | } else {
22 | pairs = shiftByOne()
23 | }
24 |
25 | if (pairs) {
26 | await startConversations(appConfig, pairs)
27 | console.log("wow we're nasty - started convo")
28 | }
29 |
30 | pairingDate = currDate
31 | isCheckedIn = false;
32 | } else { // @ts-ignore
33 | if (!isCheckedIn && Math.abs(currDate - pairingDate) > ONE_WEEK_MS) { // TODO: this ts-ignore feels wrong, one week check in
34 | await sendCheckInDM(appConfig)
35 | isCheckedIn = true;
36 | console.log("lfg - sent check in")
37 | }
38 | }
39 | }, ONE_WEEK_MS);
40 |
41 |
--------------------------------------------------------------------------------
/utils/buttons.ts:
--------------------------------------------------------------------------------
1 | import { App } from "@slack/bolt";
2 | import { ChatPostMessageResponse } from "@slack/web-api";
3 | import { PairsDataManager } from "../database/pairsDataManager";
4 |
5 | const pairsManager = new PairsDataManager();
6 |
7 | const CheckIn = (convoId: string) => ({
8 | channel: convoId,
9 | blocks: [
10 | {
11 | type: "section",
12 | text: {
13 | type: "mrkdwn",
14 | text: "Did you have a chance to connect?",
15 | },
16 | },
17 | {
18 | type: "actions",
19 | elements: [
20 | {
21 | type: "button",
22 | text: {
23 | type: "plain_text",
24 | text: "Yes! :kekuwu:",
25 | emoji: true,
26 | },
27 | value: "yes",
28 | },
29 | {
30 | type: "button",
31 | text: {
32 | type: "plain_text",
33 | text: "Nope :kekcry:",
34 | emoji: true,
35 | },
36 | value: "no",
37 | },
38 | ],
39 | },
40 | ],
41 | });
42 |
43 | export async function sendCheckInDM(app: App) {
44 | const pairings: Map = await pairsManager.getCurrentPairs();
45 | for (const convoID of pairings.keys()) {
46 | // post messages to convo id
47 | const checkInMessageResponse: ChatPostMessageResponse =
48 | await app.client.chat.postMessage(CheckIn(convoID));
49 |
50 | // error logging
51 | if (!checkInMessageResponse.ok) {
52 | console.log(
53 | `Check in message could not be sent. Error: ${checkInMessageResponse.error}`
54 | );
55 | }
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/__tests__/checkIn.test.ts:
--------------------------------------------------------------------------------
1 | import { checkMessageHistory } from "../utils/checkMessageHistory";
2 |
3 | describe('testing the util function for checking in on past pairings', () =>{
4 | const mockApp: any = {
5 | client: {
6 | conversations: {
7 |
8 | },
9 | chat: {
10 |
11 | }
12 | }
13 | };
14 | it('should send a good status message if non-bot messages exceed 0', async () => {
15 | const messageHistory = [{user: "Vera"}, {user: "Ryan"}];
16 | const mockConversations: any = {
17 | history: jest.fn().mockReturnValue({ messages: messageHistory }),
18 | };
19 | const mockChat: any = {
20 | postMessage: jest.fn().mockReturnValue({})
21 | };
22 | mockApp.client.conversations = mockConversations;
23 | mockApp.client.chat = mockChat;
24 |
25 | await checkMessageHistory(mockApp);
26 |
27 | expect(mockConversations.history).toHaveBeenCalled();
28 | expect(mockChat.postMessage).toHaveBeenCalledWith({channel: "test_channel", text: 'Thank you for talking to each other!!!'});
29 | })
30 | it('should send a bad status message if no non-bot messages were sent', async () => {
31 | const emptyHistory: string[] = [];
32 | const mockConversations: any = {
33 | history: jest.fn().mockReturnValue({ messages: emptyHistory }),
34 | };
35 | const mockChat: any = {
36 | postMessage: jest.fn().mockReturnValue({})
37 | };
38 | mockApp.client.conversations = mockConversations;
39 | mockApp.client.chat = mockChat;
40 |
41 | await checkMessageHistory(mockApp);
42 |
43 | expect(mockConversations.history).toHaveBeenCalled();
44 | expect(mockChat.postMessage).toHaveBeenCalledWith({channel: "test_channel", text: "SAY SOMETHING NOW <@Jia>!!"});
45 | })
46 | })
47 |
--------------------------------------------------------------------------------
/database/usersDataManager.ts:
--------------------------------------------------------------------------------
1 | import { DB_CLIENT } from "./dbConfig";
2 |
3 | const USERS_TABLE: string = "boba-buddies-users";
4 |
5 | export class UsersDataManager {
6 | async getUsers(): Promise {
7 | const params = {
8 | TableName: USERS_TABLE
9 | };
10 | const slackUsers = await DB_CLIENT.scan(params).promise();
11 |
12 | return slackUsers.Items.map((item: any) => item.slackUserId);
13 | }
14 |
15 | async addUser(slackUserId: string): Promise {
16 | const params = {
17 | TableName: USERS_TABLE,
18 | Item: {
19 | "slackUserId": slackUserId
20 | }
21 | }
22 |
23 | return await DB_CLIENT.put(params).promise();
24 | }
25 |
26 | async delete(slackUserId: string): Promise {
27 | const params = {
28 | TableName: USERS_TABLE,
29 | Key: {
30 | slackUserId: slackUserId
31 | }
32 | }
33 |
34 | return await DB_CLIENT.delete(params).promise();
35 | }
36 |
37 | async deleteAllUsers(): Promise {
38 | const users: string[] = await this.getUsers();
39 | for(const id of users) {
40 | await this.delete(id);
41 | }
42 |
43 | return;
44 | }
45 |
46 | async syncUsersTable(usersFromSlack: string[]): Promise {
47 | const usersFromDb: string[] = await this.getUsers();
48 | if (usersFromDb.length === 0) {
49 | console.log("LOG INFO: there are no users in the DB, so now we populate with the slack users: ", usersFromSlack);
50 | for(const user of usersFromSlack) {
51 | await this.addUser(user);
52 | }
53 | }
54 |
55 | const newUsersFromDb: string[] = await this.getUsers();
56 | const toAdd: string[] = usersFromSlack.filter(user => !newUsersFromDb.includes(user));
57 | const toDelete: string[] = newUsersFromDb.filter(user => !usersFromSlack.includes(user));
58 | if (toAdd.length > 0) {
59 | for (const user of toAdd) {
60 | await this.addUser(user);
61 | }
62 | }
63 |
64 | if (toDelete.length > 0) {
65 | for (const user of toDelete) {
66 | await this.delete(user);
67 | }
68 | }
69 |
70 | return this.getUsers();
71 | }
72 | }
--------------------------------------------------------------------------------
/utils/checkMessageHistory.ts:
--------------------------------------------------------------------------------
1 | import { App } from "@slack/bolt";
2 | import { ChatPostMessageResponse, ConversationsHistoryResponse } from "@slack/web-api";
3 | import fs from 'fs';
4 | import { BOT_USER_ID } from "./generatePairs";
5 |
6 | require('dotenv').config();
7 |
8 | /**
9 | * Checks the conversation history for each pairing to determine if introductions were made.
10 | * If no non-bot messages were sent, randomly ping channel user prompting them to send a message.
11 | * @param app
12 | */
13 | export const checkMessageHistory = async (app: App) => {
14 | // TODO: set this env variable before deploy
15 | const pairingsPath = process.env.PAIRINGS_PATH;
16 | let pairsJson = fs.readFileSync(pairingsPath, {encoding: 'utf8'});
17 | let channelAndPairs: Map = new Map(JSON.parse(pairsJson));
18 |
19 | for (const [channelId, pair] of channelAndPairs.entries()) {
20 | const historyResponse: ConversationsHistoryResponse = await app.client.conversations.history({channel: channelId});
21 | if(!historyResponse.ok) {
22 | console.log(`Conversation history could not be opened. Error: ${historyResponse.error}`)
23 | }
24 |
25 | if (historyResponse.messages) {
26 | //TODO: fix this shit later
27 | const userMessages = historyResponse.messages.filter(message => message.user !== BOT_USER_ID);
28 | if (userMessages.length > 0) {
29 | const goodJobMessageResponse: ChatPostMessageResponse = await app.client.chat.postMessage({channel: channelId, text: 'Thank you for talking to each other!!!'});
30 | if(!goodJobMessageResponse.ok) {
31 | console.log(`Message could not be posted. Error: ${goodJobMessageResponse.error}`)
32 | }
33 | }
34 | else {
35 | const userToPing = pair[Math.floor(Math.random() * channelAndPairs.size)];
36 | const pleaseTalkMessageResponse: ChatPostMessageResponse = await app.client.chat.postMessage({channel: channelId, text: `SAY SOMETHING NOW <@${userToPing}>!!`});
37 | if(!pleaseTalkMessageResponse.ok) {
38 | console.log(`Message could not be posted. Error: ${pleaseTalkMessageResponse.error}`)
39 | }
40 | }
41 | }
42 | }
43 | }
44 |
--------------------------------------------------------------------------------
/__tests__/startConversations.test.ts:
--------------------------------------------------------------------------------
1 | import { startConversations } from "../utils/startConversations"
2 |
3 | describe('testing the startConversations function', () =>{
4 | const mockApp: any = {
5 | client: {
6 | conversations: {
7 |
8 | },
9 | chat: {
10 |
11 | }
12 | }
13 | };
14 |
15 | it('should not pair for an empty list', async() => {
16 | const emptyList: string[] = [];
17 | const mockConversations: any = {
18 | members: jest.fn().mockReturnValue({ members: emptyList }),
19 | open: jest.fn()
20 | };
21 | mockApp.client.conversations = mockConversations;
22 |
23 | await startConversations(mockApp);
24 |
25 | expect(mockConversations.members).toHaveBeenCalled();
26 | expect(mockConversations.open).toHaveBeenCalledTimes(0);
27 | })
28 |
29 | it('should open a DM between all pairs and send an intro msg/icebreaker for an even number of people', async() => {
30 | const evenList: string[] = ["ryan", "vera", "sophie", "jia"];
31 | const mockConversations: any = {
32 | members: jest.fn().mockReturnValue({ members: evenList }),
33 | open: jest.fn().mockReturnValue({ok: true, channel: {id: "hahaha"}})
34 | };
35 | const mockChat: any = {
36 | postMessage: jest.fn().mockReturnValue({ok: true, channel: {id: "hahaha"}})
37 | };
38 |
39 | mockApp.client.conversations = mockConversations;
40 | mockApp.client.chat = mockChat;
41 |
42 | await startConversations(mockApp);
43 |
44 | expect(mockConversations.members).toHaveBeenCalled();
45 | expect(mockConversations.open).toHaveBeenCalledTimes(2);
46 | expect(mockChat.postMessage).toHaveBeenCalledTimes(4);
47 | })
48 |
49 | it('should open a DM between all pairs and send an intro msg/icebreaker for an odd number of people', async() => {
50 | const oddList: string[] = ["ryan", "vera", "sophie", "jia", "rick"];
51 | const mockConversations: any = {
52 | members: jest.fn().mockReturnValue({ members: oddList }),
53 | open: jest.fn().mockReturnValue({ok: true, channel: {id: "hahaha"}})
54 | };
55 | const mockChat: any = {
56 | postMessage: jest.fn().mockReturnValue({ok: true, channel: {id: "hahaha"}})
57 | };
58 |
59 | mockApp.client.conversations = mockConversations;
60 | mockApp.client.chat = mockChat;
61 |
62 | await startConversations(mockApp);
63 |
64 | expect(mockConversations.members).toHaveBeenCalled();
65 | expect(mockConversations.open).toHaveBeenCalledTimes(2);
66 | expect(mockChat.postMessage).toHaveBeenCalledTimes(4);
67 | })
68 | });
--------------------------------------------------------------------------------
/utils/startConversations.ts:
--------------------------------------------------------------------------------
1 | import { App } from "@slack/bolt";
2 | import { ChatPostMessageResponse, ConversationsOpenResponse } from '@slack/web-api';
3 | import { generatePairs } from "./generatePairs";
4 | import { PairsDataManager } from "../database/pairsDataManager";
5 |
6 | const pairsManager = new PairsDataManager();
7 |
8 | const INTRO_MSG = "Say hi to your boba buddy!"
9 | const ICEBREAKER_1 = "What's your hot take?"
10 | const ICEBREAKER_2 = "What's your favorite fruit?"
11 | const ICEBREAKER_3 = "Last song you listened to?"
12 | const ICEBREAKER_4 = "Best/worst professor at NEU?"
13 | const ICEBREAKER_5 = "Favorite pizza topping?"
14 | const ICEBREAKER_6 = "Favorite drink?"
15 | const ICEBREAKER_7 = "If all of Sandbox was on a deserted island, who would be the last to survive?"
16 | const ICEBREAKER_8 = "What's your enneagram/MBTI?"
17 | const ICEBREAKER_9 = "If you were a potato, how would you like to be cooked?"
18 | const ICEBREAKER_10 = "What hobbies do you have (outside of Sandbox)?"
19 | const ICEBREAKERS = [ICEBREAKER_1, ICEBREAKER_2, ICEBREAKER_3, ICEBREAKER_4, ICEBREAKER_5, ICEBREAKER_6, ICEBREAKER_7, ICEBREAKER_8, ICEBREAKER_9, ICEBREAKER_10]
20 |
21 | export const startConversations = async (app: App, pairs: string[][]) => {
22 | await pairsManager.deleteAllPairs();
23 | // iterate through all pairs to open a DM and send an intro message
24 | for (const pair of pairs) {
25 | // generate users string
26 | const users: string = pair.join(",");
27 |
28 | // open DM between users
29 | const conversationResponse: ConversationsOpenResponse = await app.client.conversations.open({users: users});
30 | if (!conversationResponse.ok) {
31 | console.log(`Conversation could not be opened. Error: ${conversationResponse.error}`);
32 | }
33 |
34 | // get DM conversation id from the response
35 | if (conversationResponse.channel) {
36 | const conversationId: string = conversationResponse.channel.id as string;
37 | // post messages to convo id
38 | const introMessageResponse: ChatPostMessageResponse = await app.client.chat.postMessage({channel: conversationId, text: INTRO_MSG});
39 | const icebreaker = ICEBREAKERS[Math.floor(Math.random() * ICEBREAKERS.length)];
40 | const icebreakerResponse: ChatPostMessageResponse = await app.client.chat.postMessage({channel: conversationId, text: icebreaker});
41 |
42 | if (!introMessageResponse.ok) {
43 | console.log(`Intro message could not be sent. Error: ${introMessageResponse.error}`);
44 | }
45 | if (!icebreakerResponse.ok) {
46 | console.log(`Icebreaker could not be sent. Error: ${icebreakerResponse.error}`);
47 | }
48 |
49 | await pairsManager.addPairs(conversationId, pair);
50 | }
51 |
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/__tests__/generatePairs.test.ts:
--------------------------------------------------------------------------------
1 | import {shiftByOne, generatePairs} from "../utils/generatePairs";
2 |
3 | describe('testing the util function for generating pairs', () =>{
4 | const mockApp: any = {
5 | client: {
6 | conversations: {
7 |
8 | }
9 | }
10 | };
11 | beforeEach(() => {
12 | jest.spyOn(global.Math, 'random').mockReturnValue(0.5);
13 | });
14 |
15 | afterEach(() => {
16 | jest.spyOn(global.Math, 'random').mockRestore();
17 | })
18 |
19 | it('should pair an even numbered list', async () => {
20 | const evenList: string[] = ["rick", "morty", "summer", "beth"];
21 | const mockConversations: any = {
22 | members: jest.fn().mockReturnValue({ members: evenList })
23 | };
24 | mockApp.client.conversations = mockConversations;
25 |
26 | const actualList: string[][] = await generatePairs(mockApp);
27 |
28 | expect(actualList).toHaveLength(2);
29 | expect(actualList[0]).toHaveLength(2);
30 | expect(actualList[1]).toHaveLength(2);
31 |
32 | // ensure all names are present
33 | evenList.forEach((s) => {
34 | expect(actualList[0].includes(s) || actualList[1].includes(s)).toBeTruthy();
35 | });
36 |
37 | expect(mockConversations.members).toHaveBeenCalled();
38 | })
39 | it('should pair an odd numbered list', async () => {
40 | // gdi jerry smh
41 | const oddList: string[] = ["rick", "morty", "summer", "beth", "jerry"];
42 | const mockConversations: any = {
43 | members: jest.fn().mockReturnValue({ members: oddList })
44 | };
45 | mockApp.client.conversations = mockConversations;
46 |
47 | const actualList: string[][] = await generatePairs(mockApp);
48 |
49 | expect(actualList).toHaveLength(2);
50 | expect(actualList[0]).toHaveLength(2);
51 | expect(actualList[1]).toHaveLength(3);
52 |
53 | // ensure all names are present
54 | oddList.forEach((s) => {
55 | expect(actualList[0].includes(s) || actualList[1].includes(s)).toBeTruthy();
56 | });
57 | expect(mockConversations.members).toHaveBeenCalled();
58 | })
59 | it('should pair an empty list', async () => {
60 | const emptyList: string[] = [];
61 | const mockConversations: any = {
62 | members: jest.fn().mockReturnValue({ members: emptyList })
63 | };
64 | mockApp.client.conversations = mockConversations;
65 |
66 | const actualList: string[][] = await generatePairs(mockApp);
67 |
68 | expect(actualList).toStrictEqual([]);
69 | expect(mockConversations.members).toHaveBeenCalled();
70 | })
71 |
72 | // this would never happen hopefully
73 | it('should not pair a list with 1 member', async () => {
74 | // sorry jerry, not even the slack bot wants to talk to you
75 | const jerryList: string[] = ["jerry"];
76 | const mockConversations: any = {
77 | members: jest.fn().mockReturnValue({ members: jerryList })
78 | };
79 | mockApp.client.conversations = mockConversations;
80 |
81 | const actualList: string[][] = await generatePairs(mockApp);
82 |
83 | expect(actualList).toStrictEqual([]);
84 | expect(mockConversations.members).toHaveBeenCalled();
85 | })
86 |
87 | it('should shift member by one', () => {
88 | jest.mock('../utils/data/pairings.json', ()=>({
89 | "1": ["a", "b"],
90 | "2": ["c", "d"],
91 | "3": ["e", "f", "g"]
92 | }))
93 |
94 | const actualList = shiftByOne();
95 |
96 | expect(actualList).toStrictEqual([['c', 'b'], ['g', 'd', 'e'], ['a', 'f']])
97 | })
98 | })
99 |
--------------------------------------------------------------------------------
/database/poolDataManager.ts:
--------------------------------------------------------------------------------
1 | import { DB_CLIENT } from "./dbConfig";
2 |
3 | const POOL_TABLE: string = "boba-buddies-pool";
4 |
5 | export class PoolDataManager {
6 | async getPool(): Promise[]> {
7 | const params = {
8 | TableName: POOL_TABLE
9 | };
10 |
11 | const result = await DB_CLIENT.scan(params).promise();
12 | return result.Items;
13 | }
14 |
15 | async getPoolForUser(user: string): Promise[]> {
16 | const getFilteredParams = {
17 | TableName: POOL_TABLE,
18 | FilterExpression: "(primaryBuddy = :primary) OR (secondaryBuddy = :secondary)",
19 | ExpressionAttributeValues: {
20 | ":primary": user,
21 | ":secondary": user
22 | }
23 | }
24 | const result = await DB_CLIENT.scan(getFilteredParams).promise();
25 | return result.Items;
26 | }
27 |
28 | async addPair(slackUser1: string, slackUser2: string): Promise {
29 | const params = {
30 | TableName: POOL_TABLE,
31 | Item: {
32 | "primaryBuddy": slackUser1,
33 | "secondaryBuddy": slackUser2
34 | }
35 | }
36 |
37 | return await DB_CLIENT.put(params).promise();
38 | }
39 |
40 | async deletePair(pair: Map): Promise {
41 | const delParams = {
42 | TableName: POOL_TABLE,
43 | Key: {
44 | primaryBuddy: pair.get("primaryBuddy"),
45 | secondaryBuddy: pair.get("secondaryBuddy")
46 | }
47 | }
48 | return await DB_CLIENT.delete(delParams).promise();
49 | }
50 |
51 | async popPair(user: string, alreadyPairedList: string[]): Promise> {
52 | const userPool = await this.getPoolForUser(user);
53 | const unusedUserPool = userPool.filter(unusedPair => !this.containsAny(alreadyPairedList, unusedPair));
54 |
55 | console.log(`DEBUG: popping for this user ${user} with an alreadyPairedList of ${alreadyPairedList}`);
56 | console.log(`DEBUG: retrieved an unusedUserPool for pairing ${unusedUserPool}`);
57 |
58 | const randomPair = unusedUserPool[Math.floor(Math.random() * unusedUserPool.length)];
59 | await this.deletePair(new Map(Object.entries(randomPair)));
60 |
61 | return randomPair;
62 | }
63 |
64 | async syncPool(oldSlackUsers: string[], newSlackUsers: string[]): Promise {
65 | const currPool: Map[] = await this.getPool();
66 | if (currPool.length === 0) {
67 | console.log("LOG INFO: the current pool is empty, so now we will populate the pool with all pairings");
68 | await this.permuteAndAddPairs(newSlackUsers);
69 | }
70 |
71 | const toAdd = newSlackUsers.filter(user => !oldSlackUsers.includes(user));
72 | const toDelete: string[] = oldSlackUsers.filter(user => !newSlackUsers.includes(user));
73 |
74 | if (toAdd.length > 0) {
75 | const currentExistingMembers: string[] = newSlackUsers.filter(user => !toAdd.includes(user));
76 | for (const toAddSlackUser of toAdd) {
77 | for (const currentMember of currentExistingMembers) {
78 | await this.addPair(toAddSlackUser, currentMember);
79 | }
80 | }
81 |
82 | await this.permuteAndAddPairs(toAdd);
83 | }
84 |
85 | if (toDelete.length > 0) {
86 | for(const toDeleteUser of toDelete) {
87 | const pairsToDelete: Map[] = await this.getPoolForUser(toDeleteUser);
88 | for (const pairToDelete of pairsToDelete) {
89 | await this.deletePair(new Map(Object.entries(pairToDelete)));
90 | }
91 | }
92 | }
93 |
94 | return;
95 | }
96 |
97 | private async permuteAndAddPairs(slackUsers: string[]): Promise {
98 | for (var i: number = 0; i < slackUsers.length; i++) {
99 | for (var j:number = i + 1; j < slackUsers.length; j++) {
100 | await this.addPair(slackUsers[i], slackUsers[j]);
101 | }
102 | }
103 | }
104 |
105 | private containsAny(listToCheck: string[], pair: Object): boolean {
106 | const values = Object.values(pair);
107 | return values.some(value => listToCheck.includes(value));
108 | }
109 | }
--------------------------------------------------------------------------------
/utils/generatePairs.ts:
--------------------------------------------------------------------------------
1 | import { App } from "@slack/bolt";
2 | import { UsersDataManager } from "../database/usersDataManager";
3 | import { PoolDataManager } from "../database/poolDataManager";
4 |
5 | const CHANNEL_ID = "C04GHB54U30";
6 | export const BOT_USER_ID = "U02J904RH1S";
7 | const userManager = new UsersDataManager();
8 | const poolManager = new PoolDataManager();
9 |
10 | export const generatePairs = async (app: App) => {
11 | const membersResponse = await app.client.conversations.members({channel: CHANNEL_ID})
12 | const memberIDs: string[] = membersResponse.members?.filter((userID: string) => userID !== BOT_USER_ID) as string[]
13 | const oldUserList: string[] = await userManager.getUsers();
14 | const usersFromDb: string[] = shuffle(await userManager.syncUsersTable(memberIDs));
15 | await poolManager.syncPool(oldUserList, usersFromDb);
16 | const pairs: string[][] = [];
17 |
18 | // we shouldn't start any multiuser channels with just a singular person lol
19 | if (usersFromDb.length == 1) {
20 | return pairs;
21 | }
22 |
23 | // retrieve pairings from the pool for every user in usersToBePaired list
24 | let usersToBePaired: string[] = [...usersFromDb];
25 | let usersAlreadyPaired: string[] = [];
26 | while (usersToBePaired.length > 0) {
27 | // pop the user and get the user's pairing for this cycle
28 | const primaryUser = usersToBePaired.pop() ?? "";
29 | const pairMapObject = await poolManager.popPair(primaryUser, usersAlreadyPaired);
30 |
31 | // get the buddy from pairing to remove from usersToBePaired list
32 | const secondaryUser = getBuddy(primaryUser, new Map(Object.entries(pairMapObject)));
33 | usersToBePaired = usersToBePaired.filter(user => user !== secondaryUser);
34 | usersAlreadyPaired.push(primaryUser);
35 | usersAlreadyPaired.push(secondaryUser);
36 |
37 | // add pairing for user and buddy into returned list
38 | pairs.push(Object.values(pairMapObject));
39 |
40 | // if someone is lonely, then group that person with an existing pair
41 | if (usersToBePaired.length === 1) {
42 | const lonelyMember: string = usersToBePaired.pop() ?? "";
43 | const lastPair: string[] = pairs.pop() ?? [];
44 | const newPair = lastPair.concat([lonelyMember]);
45 |
46 | pairs.push(newPair);
47 | }
48 | }
49 |
50 | return pairs;
51 | }
52 |
53 | function getBuddy(user: string, pair: Map): string {
54 | const primaryBuddy = pair.get("primaryBuddy") ?? "";
55 | const secondaryBuddy = pair.get("secondaryBuddy") ?? "";
56 |
57 | if (primaryBuddy === user) {
58 | return secondaryBuddy;
59 | } else {
60 | return primaryBuddy;
61 | }
62 | }
63 |
64 | // stackoverflow said fisher-yates good shuffle algorithm, so i copy pasta away
65 | function shuffle(array: string[]): string[] {
66 | let m = array.length, t, i;
67 |
68 | // While there remain elements to shuffle…
69 | while (m) {
70 |
71 | // Pick a remaining element…
72 | i = Math.floor(Math.random() * m--);
73 |
74 | // And swap it with the current element.
75 | t = array[m];
76 | array[m] = array[i];
77 | array[i] = t;
78 | }
79 |
80 | return array;
81 | }
82 |
83 | // Shift the first person in each group to create new pairs
84 | export const shiftByOne = (): string[][] => {
85 | let prevPairings = require('./data/pairings.json');
86 | let lastPairings: string[][] = Object.values(prevPairings)
87 |
88 | // get first person in each pairing
89 | const firstPersonList = lastPairings.map((pair: string[]) => pair[0])
90 |
91 | // get odd group
92 | const oddGroup = lastPairings.filter((pair: string[]) => pair.length === 3)[0]
93 |
94 | // put first person at end of list (shifting everyone up one)
95 | const firstElem = firstPersonList.shift()
96 | if (firstElem) { // TODO: TS is being a whore about this
97 | firstPersonList.push(firstElem)
98 | }
99 |
100 | // update pairings with new first person
101 | lastPairings = lastPairings.map((pairs: string[], ind: number) => [firstPersonList[ind], pairs[1]])
102 |
103 | // get last person
104 | let oddPersonOut: string;
105 | if (oddGroup) {
106 | oddPersonOut = oddGroup[2];
107 | const oddPersonIndex = Math.floor(Math.random() * lastPairings.length);
108 | const newOddPairing = lastPairings[oddPersonIndex];
109 | newOddPairing.push(oddPersonOut);
110 | [newOddPairing[0], newOddPairing[2]] = [newOddPairing[2], newOddPairing[0]]
111 | }
112 |
113 | return lastPairings;
114 | }
115 |
116 | module.exports = {
117 | shiftByOne, generatePairs
118 | }
119 |
--------------------------------------------------------------------------------
/lambdaFiles/mainLambda.js:
--------------------------------------------------------------------------------
1 | const AWS = require("aws-sdk");
2 | const S3 = new AWS.S3();
3 | const config = require("./config.json");
4 |
5 | const https = require("https"),
6 | qs = require("querystring"),
7 | ACCESS_TOKEN = process.env.BOT_TOKEN;
8 |
9 | const responseSuccess = {
10 | statusCode: 200,
11 | body: JSON.stringify({
12 | message: "ok",
13 | }),
14 | };
15 |
16 | const PAIRS_MET_PATH = "pairsMet.json";
17 |
18 | /**
19 | * Sends a message as boba buddy to the given channel
20 | * @param {string} text the message being sent
21 | * @param {string} channel the channel its being sent to
22 | */
23 | function sendMessage(text, channel) {
24 | const message = { channel, text };
25 |
26 | const query = qs.stringify(message);
27 | const options = {
28 | hostname: "slack.com",
29 | path: `/api/chat.postMessage?${query}`,
30 | headers: { Authorization: `Bearer ${ACCESS_TOKEN}` },
31 | };
32 | https.get(options);
33 | }
34 |
35 | // given user id, gets the user's display name
36 | function getUserDisplayName(userID) {
37 | const options = {
38 | hostname: "slack.com",
39 | path: `/api/users.info?user=${userID}`,
40 | headers: { Authorization: `Bearer ${ACCESS_TOKEN}` },
41 | };
42 |
43 | return new Promise((resolve, reject) => {
44 | https.get(options, (res) => {
45 | res.on("data", (response) => {
46 | response = JSON.parse(response);
47 | resolve(response.user.profile.display_name);
48 | });
49 | res.on("error", (e) => {
50 | console.log("Got error: " + e.message);
51 | reject(e);
52 | });
53 | });
54 | });
55 | }
56 |
57 | function putObjectInS3(body) {
58 | var s3 = new AWS.S3();
59 | var params = {
60 | Bucket: config.S3_BUCKET_NAME,
61 | Key: PAIRS_MET_PATH,
62 | Body: JSON.stringify(body),
63 | ContentType: "application/json; charset=utf-8",
64 | };
65 | s3.putObject(params, (err, data) => {
66 | if (err) console.log(err);
67 | else console.log(data);
68 | });
69 | }
70 |
71 | // fetches file with given name (key). parses file content as JSON
72 | async function getObjectFromS3(key) {
73 | var s3 = new AWS.S3();
74 | var getParams = {
75 | Bucket: config.S3_BUCKET_NAME,
76 | Key: key,
77 | };
78 | await s3.getObject(getParams, (err, data) => {
79 | // callback
80 | if (err) {
81 | console.log(err);
82 | return undefined;
83 | } else {
84 | const response = JSON.parse(data.Body.toString());
85 | return response;
86 | }
87 | });
88 | }
89 |
90 | /**
91 | * resends the direct message being sent to it
92 | * Used for testing lambda/slack connection only
93 | */
94 | function resendText(event, callback) {
95 | // test ensures that message isnt from a bot and is a direct message
96 | if (!event.bot_id && event.channel_type === "im") {
97 | const { text, channel } = event;
98 | sendMessage(text, channel);
99 | }
100 | callback(undefined, responseSuccess);
101 | }
102 |
103 | // updates the checkin message (kekw yes or no buttons) with a message indicating user action
104 | // prevents spamming of kekw buttons bc buttons no longer accessible
105 | async function updateCheckinMessage(responseUrl, user, buttonValue) {
106 | const userDisplayName = await getUserDisplayName(user.id);
107 | var postData = JSON.stringify({
108 | replace_original: "true", // edits original message
109 | text:
110 | buttonValue === "yes"
111 | ? `${userDisplayName} said you met! :happy-panda:`
112 | : `${userDisplayName} said you have not met! SADGE ;-; `, // TODO: make this more specific- who responded? did you meet?
113 | });
114 |
115 | const searchTerm = ".com/";
116 | const indexOfFirst = responseUrl.indexOf(searchTerm);
117 |
118 | const pathSubstring = responseUrl.substring(indexOfFirst + 4);
119 |
120 | var options = {
121 | hostname: "hooks.slack.com",
122 | path: pathSubstring,
123 | method: "POST",
124 | };
125 |
126 | var req = https.request(options, (res) => {
127 | console.log("statusCode:", res.statusCode);
128 |
129 | res.on("data", (d) => {
130 | process.stdout.write(d);
131 | });
132 | });
133 |
134 | req.on("error", (e) => {
135 | console.error(e);
136 | });
137 |
138 | req.write(postData);
139 | req.end();
140 | }
141 |
142 | // handles when users click the Yes or No Kek buttons
143 | async function handleButtonInteraction(payload, callback) {
144 | const buttonValue = payload.actions[0].value; // one of "yes" or "no"
145 | const user = payload.user; // the user who pressed the button.
146 | const response = getObjectFromS3(PAIRS_MET_PATH);
147 | response.then((response) => {
148 | let pairsMet = 0;
149 | // updates pairsMet if we already already exists in file
150 | if (response && response["pairsMet"]) {
151 | pairsMet = response["pairsMet"];
152 | }
153 | if (buttonValue === "yes") {
154 | pairsMet += 1;
155 | }
156 | // update pairsMet value in file
157 | putObjectInS3({ pairsMet: pairsMet });
158 | // update message response
159 | const responseURL = payload["response_url"];
160 | updateCheckinMessage(responseURL, user, buttonValue);
161 | callback(undefined, responseSuccess);
162 | });
163 | }
164 |
165 | // handles all slack "interaction payloads"
166 | // for all interaction payload types, reference slack docs: https://api.slack.com/interactivity/handling
167 | async function handleInteractions(payload, callback) {
168 | if (payload.type === "block_actions") {
169 | // messages with buttons are of type "block_actions"
170 | handleButtonInteraction(payload, callback);
171 | }
172 | }
173 |
174 | exports.handler = (data, context, callback) => {
175 | const resource = data.resource;
176 |
177 | switch (resource) {
178 | // called when messaging Bot
179 | case "/event-handler":
180 | const body = JSON.parse(data.body);
181 | resendText(body["event"], callback);
182 | break;
183 | // called when interactive button pressed
184 | case "/interactive-handler":
185 | const payload = data.body.replace("payload=", "");
186 | const decodedPayload = decodeURIComponent(payload).replace(/\+/g, "%20");
187 | const payLoadJSON = JSON.parse(decodedPayload);
188 | handleInteractions(payLoadJSON, callback);
189 | break;
190 | default:
191 | console.log("unhandled data type");
192 | callback(undefined, responseSuccess);
193 | break;
194 | }
195 | };
196 |
--------------------------------------------------------------------------------
/jest.config.ts:
--------------------------------------------------------------------------------
1 | /*
2 | * For a detailed explanation regarding each configuration property and type check, visit:
3 | * https://jestjs.io/docs/configuration
4 | */
5 |
6 | export default {
7 | // All imported modules in your tests should be mocked automatically
8 | // automock: false,
9 |
10 | // Stop running tests after `n` failures
11 | // bail: 0,
12 |
13 | // Automatically clear mock calls and instances between every test
14 | clearMocks: true,
15 |
16 | // Indicates whether the coverage information should be collected while executing the test
17 | // collectCoverage: false,
18 |
19 | // An array of glob patterns indicating a set of files for which coverage information should be collected
20 | // collectCoverageFrom: undefined,
21 |
22 | // The directory where Jest should output its coverage files
23 | // coverageDirectory: undefined,
24 |
25 | // An array of regexp pattern strings used to skip coverage collection
26 | // coveragePathIgnorePatterns: [
27 | // "\\\\node_modules\\\\"
28 | // ],
29 |
30 | // Indicates which provider should be used to instrument code for coverage
31 | coverageProvider: "babel",
32 |
33 | // A list of reporter names that Jest uses when writing coverage reports
34 | // coverageReporters: [
35 | // "json",
36 | // "text",
37 | // "lcov",
38 | // "clover"
39 | // ],
40 |
41 | // An object that configures minimum threshold enforcement for coverage results
42 | // coverageThreshold: undefined,
43 |
44 | // A path to a custom dependency extractor
45 | // dependencyExtractor: undefined,
46 |
47 | // Make calling deprecated APIs throw helpful error messages
48 | // errorOnDeprecated: false,
49 |
50 | // Force coverage collection from ignored files using an array of glob patterns
51 | // forceCoverageMatch: [],
52 |
53 | // A path to a module which exports an async function that is triggered once before all test suites
54 | // globalSetup: undefined,
55 |
56 | // A path to a module which exports an async function that is triggered once after all test suites
57 | // globalTeardown: undefined,
58 |
59 | // A set of global variables that need to be available in all test environments
60 | // globals: {},
61 |
62 | // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
63 | // maxWorkers: "50%",
64 |
65 | // An array of directory names to be searched recursively up from the requiring module's location
66 | moduleDirectories: [
67 | "node_modules"
68 | ],
69 |
70 | // An array of file extensions your modules use
71 | // moduleFileExtensions: [
72 | // "js",
73 | // "jsx",
74 | // "ts",
75 | // "tsx",
76 | // "json",
77 | // "node"
78 | // ],
79 |
80 | // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
81 | // moduleNameMapper: {},
82 |
83 | // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
84 | // modulePathIgnorePatterns: [],
85 |
86 | // Activates notifications for test results
87 | // notify: false,
88 |
89 | // An enum that specifies notification mode. Requires { notify: true }
90 | // notifyMode: "failure-change",
91 |
92 | // A preset that is used as a base for Jest's configuration
93 | // preset: undefined,
94 |
95 | // Run tests from one or more projects
96 | // projects: undefined,
97 |
98 | // Use this configuration option to add custom reporters to Jest
99 | // reporters: undefined,
100 |
101 | // Automatically reset mock state between every test
102 | // resetMocks: false,
103 |
104 | // Reset the module registry before running each individual test
105 | // resetModules: false,
106 |
107 | // A path to a custom resolver
108 | // resolver: undefined,
109 |
110 | // Automatically restore mock state between every test
111 | // restoreMocks: false,
112 |
113 | // The root directory that Jest should scan for tests and modules within
114 | // rootDir: undefined,
115 |
116 | // A list of paths to directories that Jest should use to search for files in
117 | // roots: [
118 | // ""
119 | // ],
120 |
121 | // Allows you to use a custom runner instead of Jest's default test runner
122 | // runner: "jest-runner",
123 |
124 | // The paths to modules that run some code to configure or set up the testing environment before each test
125 | // setupFiles: [],
126 |
127 | // A list of paths to modules that run some code to configure or set up the testing framework before each test
128 | // setupFilesAfterEnv: [],
129 |
130 | // The number of seconds after which a test is considered as slow and reported as such in the results.
131 | // slowTestThreshold: 5,
132 |
133 | // A list of paths to snapshot serializer modules Jest should use for snapshot testing
134 | // snapshotSerializers: [],
135 |
136 | // The test environment that will be used for testing
137 | // testEnvironment: "jest-environment-node",
138 |
139 | // Options that will be passed to the testEnvironment
140 | // testEnvironmentOptions: {},
141 |
142 | // Adds a location field to test results
143 | // testLocationInResults: false,
144 |
145 | // The glob patterns Jest uses to detect test files
146 | testMatch: [
147 | "**/__tests__/**/*.[jt]s?(x)",
148 | "**/?(*.)+(spec|test).[tj]s?(x)"
149 | ],
150 |
151 | // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
152 | testPathIgnorePatterns: [
153 | "\\\\node_modules\\\\"
154 | ],
155 |
156 | // The regexp pattern or array of patterns that Jest uses to detect test files
157 | // testRegex: [],
158 |
159 | // This option allows the use of a custom results processor
160 | // testResultsProcessor: undefined,
161 |
162 | // This option allows use of a custom test runner
163 | // testRunner: "jest-circus/runner",
164 |
165 | // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
166 | // testURL: "http://localhost",
167 |
168 | // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
169 | // timers: "real",
170 |
171 | // A map from regular expressions to paths to transformers
172 | // transform: undefined,
173 |
174 | // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
175 | // transformIgnorePatterns: [
176 | // "\\\\node_modules\\\\",
177 | // "\\.pnp\\.[^\\\\]+$"
178 | // ],
179 |
180 | // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
181 | // unmockedModulePathPatterns: undefined,
182 |
183 | // Indicates whether each individual test should be reported during the run
184 | // verbose: undefined,
185 |
186 | // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
187 | // watchPathIgnorePatterns: [],
188 |
189 | // Whether to use watchman for file crawling
190 | // watchman: true,
191 | };
192 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 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 General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------