diff --git a/.gitignore b/.gitignore index 6704566..d0f5e81 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,9 @@ +*.json +!package.json +!tsconfig.json +src/config.ts + + # Logs logs *.log diff --git a/package.json b/package.json new file mode 100644 index 0000000..27efc86 --- /dev/null +++ b/package.json @@ -0,0 +1,28 @@ +{ + "name": "bit-stats-tracker", + "version": "1.0.0", + "description": "Tracks bit donation information in a specific Twitch channel.", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/Tyler-A/bit-stats-tracker.git" + }, + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/Tyler-A/bit-stats-tracker/issues" + }, + "homepage": "https://github.com/Tyler-A/bit-stats-tracker#readme", + "dependencies": { + "@types/node": "^13.1.4", + "@types/request": "^2.48.4", + "@types/request-promise-native": "^1.0.17", + "@types/tmi.js": "^1.4.0", + "request": "^2.88.0", + "request-promise-native": "^1.0.8", + "tmi.js": "^1.5.0" + } +} diff --git a/src/Twitch.ts b/src/Twitch.ts new file mode 100644 index 0000000..2c925f6 --- /dev/null +++ b/src/Twitch.ts @@ -0,0 +1,119 @@ +// +// Twitch.ts +// +// Written by: Tyler Akins (2020/01/06 - 2020/01/08) +// + + +import * as requests from "request-promise-native"; +import * as tmi from "tmi.js"; + +import { TWITCH_URI } from "./constants"; +import * as config from "./config"; +import { + GET_FORMATTED_DATE, + WRITE_DATA, + LOAD_DATA +} from "./utils"; + + +const IS_LIVE = async (): Promise => { + + // Fetch the data from the Twitch API to check if the user is live + let response = await requests.get( + TWITCH_URI, + { + qs: { + "user_login": config.CHANNEL + }, + headers: { + "Client-ID": config.CLIENT_ID + }, + json: true + } + ); + + return response.data.length !== 0; +}; + + + + +export const START_BOT = async () => { + + const client = tmi.Client({ + options: { + debug: false, + clientId: config.CLIENT_ID + }, + connection: { + secure: true, + reconnect: true + }, + identity: { + username: config.USERNAME, + password: config.OAUTH_TOKEN + }, + channels: [config.CHANNEL] + }); + + + client.on("cheer", (ch: string, ctx: tmi.Userstate, msg: string) => { + + let bits: number = parseInt(ctx.bits); + let donator: string = ctx.username; + let date: string = GET_FORMATTED_DATE() + + let data: data = LOAD_DATA(); + + + IS_LIVE() + .then((response: boolean) => { + + // Ensure the user is live + if (response) { + data["offline"].total_bits += bits; + data["offline"].donations.push(bits); + data["offline"].donators.push(donator) + } else { + + // Data already exists + if (data[date]) { + + // Check if the donator has already donated + if (!data[date].donators.includes(donator)) { + data[date].donators.push(donator); + }; + + // Add the bits to the total and the array of donations + data[date].total_bits += bits; + data[date].donations.push(bits); + } + + // Making new data point + else { + data[date] = { + total_bits: bits, + donators: [donator], + donations: [bits] + }; + }; + }; + + WRITE_DATA(data); + }) + .catch((err) => {throw err;}) + }); + + + client.on("disconnected", (reason: string) => { + console.log(`* Disconnected from Twitch w/ reason: ${reason}`) + }); + + + client.on("connected", (addr: string, port: number) => { + console.log(`* Connected to Twitch on ${addr}:${port}`) + }); + + client.connect().catch((_) => {}); +}; \ No newline at end of file diff --git a/src/config.template.ts b/src/config.template.ts new file mode 100644 index 0000000..54c4359 --- /dev/null +++ b/src/config.template.ts @@ -0,0 +1,8 @@ +export const CHANNEL: string = ""; + + +export const CLIENT_ID: string = ""; + + +export const USERNAME: string = ""; +export const OAUTH_TOKEN: string = ""; \ No newline at end of file diff --git a/src/constants.ts b/src/constants.ts new file mode 100644 index 0000000..e131d3d --- /dev/null +++ b/src/constants.ts @@ -0,0 +1,10 @@ +// +// constants.ts +// +// Written by: Tyler Akins (2020/01/06) +// + + +export const TWITCH_URI: string = "https://api.twitch.tv/helix/streams"; + +export const DATAFILE: string = "data.temp.json"; \ No newline at end of file diff --git a/src/main.ts b/src/main.ts new file mode 100644 index 0000000..c9fd810 --- /dev/null +++ b/src/main.ts @@ -0,0 +1,17 @@ +// +// main.ts +// +// Written by: Tyler Akins (2020/01/06 - 2020/01/07) +// + + +import { START_BOT } from "./Twitch" + + + +const MAIN = async () => { + START_BOT(); +}; + + +MAIN() \ No newline at end of file diff --git a/src/types.d.ts b/src/types.d.ts new file mode 100644 index 0000000..7d8e33c --- /dev/null +++ b/src/types.d.ts @@ -0,0 +1,14 @@ +// +// types.d.ts +// +// Written by: Tyler Akins (2020/01/06) +// + + +interface data { + [key: string]: { + total_bits: number; + donators: string[]; + donations: number[]; + }; +} \ No newline at end of file diff --git a/src/utils.ts b/src/utils.ts new file mode 100644 index 0000000..e4a503e --- /dev/null +++ b/src/utils.ts @@ -0,0 +1,42 @@ +// +// utils.ts +// +// Written by: Tyler Akins (2020/01/06 - 2020/01/08) +// + + +import { readFileSync, writeFileSync } from "fs" +import { INDENT_DEPTH } from "./config"; +import { DATAFILE } from "./constants"; + + + +export const GET_FORMATTED_DATE = () => { + let date = new Date(); + + let year = date.getFullYear(); + let month = date.getMonth() + 1; + let day = date.getDate(); + + return `${year}` + + `-${month < 10 ? `0${month}` : month}` + + `-${day < 10 ? `0${day}` : day}` +}; + + + +export const LOAD_DATA = (): data => { + let buffer = readFileSync(DATAFILE); + + // @ts-ignore + return JSON.parse(buffer); +}; + + + +export const WRITE_DATA = (data: data) => { + writeFileSync( + DATAFILE, + JSON.stringify(data, null, INDENT_DEPTH) + ); +}; \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..ca796a6 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,69 @@ +{ + "compilerOptions": { + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */ + "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */ + // "lib": [], /* Specify library files to be included in the compilation. */ + // "allowJs": true, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ + // "declaration": true, /* Generates corresponding '.d.ts' file. */ + // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + // "sourceMap": true, /* Generates corresponding '.map' file. */ + // "outFile": "./", /* Concatenate and emit output to single file. */ + "outDir": "./dist", /* Redirect output structure to the directory. */ + // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ + // "removeComments": true, /* Do not emit comments to output. */ + // "noEmit": true, /* Do not emit outputs. */ + // "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + + /* Strict Type-Checking Options */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* Enable strict null checks. */ + // "strictFunctionTypes": true, /* Enable strict checking of function types. */ + // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + + /* Additional Checks */ + // "noUnusedLocals": true, /* Report errors on unused locals. */ + // "noUnusedParameters": true, /* Report errors on unused parameters. */ + // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + + /* Module Resolution Options */ + // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + // "types": [], /* Type declaration files to be included in compilation. */ + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + }, + "include": [ + "src/" + ], + "exclude": [ + "src/config.template.ts" + ] +} \ No newline at end of file