From 05e556d6d849f5b3bba21ed6411b5cc5b5e58154 Mon Sep 17 00:00:00 2001 From: alexkar598 <25136265+alexkar598@users.noreply.github.com> Date: Tue, 22 Mar 2022 20:43:57 -0400 Subject: [PATCH] (New) initial commit --- .gitignore | 8 ++- dist/.gitkeep | 0 package-lock.json | 30 +++++++++ package.json | 33 +++++++-- src/index.ts | 165 +++++++++++++++++++++++++++++++++++++++++++++ tsconfig.json | 101 +++++++++++++++++++++++++++ typings/index.d.ts | 16 +++++ 7 files changed, 343 insertions(+), 10 deletions(-) create mode 100644 dist/.gitkeep create mode 100644 package-lock.json create mode 100644 src/index.ts create mode 100644 tsconfig.json create mode 100644 typings/index.d.ts diff --git a/.gitignore b/.gitignore index acbaa40..e30d6cf 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ -node_modules/ -jsdoc/ -test.js \ No newline at end of file +node_modules +*.iml +.idea + +dist \ No newline at end of file diff --git a/dist/.gitkeep b/dist/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..a2bcf11 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,30 @@ +{ + "name": "http2byond", + "version": "3.0.0", + "lockfileVersion": 2, + "requires": true, + "packages": { + "": { + "name": "http2byond", + "version": "3.0.0", + "license": "MIT", + "devDependencies": { + "@types/node": "^17.0.22" + } + }, + "node_modules/@types/node": { + "version": "17.0.22", + "resolved": "https://registry.npmjs.org/@types/node/-/node-17.0.22.tgz", + "integrity": "sha512-8FwbVoG4fy+ykY86XCAclKZDORttqE5/s7dyWZKLXTdv3vRy5HozBEinG5IqhvPXXzIZEcTVbuHlQEI6iuwcmw==", + "dev": true + } + }, + "dependencies": { + "@types/node": { + "version": "17.0.22", + "resolved": "https://registry.npmjs.org/@types/node/-/node-17.0.22.tgz", + "integrity": "sha512-8FwbVoG4fy+ykY86XCAclKZDORttqE5/s7dyWZKLXTdv3vRy5HozBEinG5IqhvPXXzIZEcTVbuHlQEI6iuwcmw==", + "dev": true + } + } +} diff --git a/package.json b/package.json index bb5c28f..da8d79c 100644 --- a/package.json +++ b/package.json @@ -1,15 +1,34 @@ { "name": "http2byond", "description": "Communication layer between node.js and BYOND game servers.", - "version": "2.0.1", - "author": "Tigercat2000", - "dependencies": { - "jspack": "0.0.4" - }, + "version": "3.0.0", + "contributors": [ + { + "name": "Tigercat2000", + "email": "nick.pilant2@gmail.com", + "url": "https://github.com/tigercat2000" + }, + { + "name": "alexkar598", + "email": "25136265+alexkar598@users.noreply.github.com", + "url": "https://github.com/alexkar598" + } + ], "keywords": [ "byond" ], "license": "MIT", - "main": "index.js", - "repository": "tigercat2000/http2byond" + "main": "dist/index.js", + "repository": { + "type": "git", + "url": "https://github.com/tigercat2000/http2byond" + }, + "files": [ + "dist", + "types" + ], + "types": "typings/index.d.ts", + "devDependencies": { + "@types/node": "^17.0.22" + } } diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..0917493 --- /dev/null +++ b/src/index.ts @@ -0,0 +1,165 @@ +import { Socket, createConnection } from 'net' + +export interface SocketConfig { + //Domain name or IP to connect to + host: string; + //Port to connect to + port: number; +} +export type SingleRunConfiguration = SocketConfig & { + //URL params to send to BYOND + topic: string; + //Time to wait before aborting connection + timeout?: number; +} +export type TopicReturnType = string | number | null + +export interface TopicConnection { + send: (topic: string) => Promise + destroy: () => void +} + +function _sendTopic(socket: Socket, _topic: string): Promise { + const topic = _topic[0] !== "?" ? + "?" + _topic : + _topic + + return new Promise((resolve, reject) => { + function errorHandler(reason: string) { + return function(originalError?: Error) { + /*reject(new Error(reason, { + cause: originalError + }))*/ + originalError ? + reject(new Error(reason + "\n Caused by: " + originalError)) : + reject(new Error(reason)) + socket.destroy() + } + } + + socket.on("error", errorHandler("Socket errored")) + socket.on("timeout", errorHandler("Connection timeout")) + + let byte = 0 + //type(2) + length(2) + const headerBuffer = Buffer.alloc(4) + let bodyBuffer: Buffer; + + function processResponse() { + const type = bodyBuffer[0]; + switch (type) { + case 0x00: { + return resolve(null) + } + case 0x2a: { + return resolve(bodyBuffer.readFloatLE(1)) + } + case 0x06: { + return resolve(bodyBuffer.subarray(0, -1).toString("utf-8")) + } + } + } + + + socket.on("data", data => { + //Still waiting on a complete header + if(byte < 4) { + const copiedBytes = data.copy(headerBuffer) + data = data.subarray(copiedBytes) + byte += copiedBytes + + //Got the full header! + if(byte >= 4) { + bodyBuffer = Buffer.alloc(headerBuffer.readUint16BE(2)) + //Sucks to be you, maybe you'll get a full header later? + } else { + return + } + } + + //We either just finished reading the header and got more to read, or we just got another body packet + if (data.length) { + const copiedBytes = data.copy(bodyBuffer) + byte += copiedBytes + } + + //expected buffer length + the header length + const fullLength = 4 + bodyBuffer.length + + //We got too many bytes! + if(byte > fullLength) { + errorHandler("Data is larger than expected") + return + } + + //No more data to read + if(byte === fullLength) { + socket.end() + processResponse() + } + }) + + socket.on("ready", () => { + const topicBuffer = Buffer.from(topic) + //type(2) + length(2) + padding(5) + msg(n) + terminator(1) + const dataBuffer = Buffer.alloc(2 + 2 + 5 + topicBuffer.length + 1) + let ptr; + + //Packet type 0x0083 + dataBuffer[0] = 0x00 + dataBuffer[1] = 0x83 + + //Write length of buffer + //padding(5) + msg(n) + terminator(1) + dataBuffer.writeUInt16BE(5 + topicBuffer.length + 1, 2) + + //Write padding + dataBuffer[4] = 0x00 + dataBuffer[5] = 0x00 + dataBuffer[6] = 0x00 + dataBuffer[7] = 0x00 + dataBuffer[8] = 0x00 + + //We're done with the header, we need to write the null terminated string to the 8th byte. + ptr = 9; + topicBuffer.copy(dataBuffer, ptr) + ptr += topicBuffer.length + dataBuffer[ptr] = 0x00 + + socket.write(dataBuffer) + + }) + }) +} + +function sendTopic(config: SingleRunConfiguration): Promise { + const socket = createConnection({ + family: 4, + host: config.host, + port: config.port, + timeout: config.timeout + }) + return _sendTopic(socket, config.topic) +} + +function createTopicConnection(config: SocketConfig): TopicConnection { + let socket = createConnection({ + family: 4, + host: config.host, + port: config.port + }) + return { + send: topic => { + if (socket.destroyed) { + return Promise.reject(new Error("Socket is destroyed")) + } + + return _sendTopic(socket, topic) + }, + destroy: () => { + socket.destroy() + } + } +} + +export { sendTopic, createTopicConnection } \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..a78cf5f --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,101 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig.json to read more about this file */ + + /* Projects */ + // "incremental": true, /* Enable incremental compilation */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */ + // "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + "rootDir": "./src", /* Specify the root folder within your source files. */ + "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "resolveJsonModule": true, /* Enable importing .json files */ + // "noResolve": true, /* Disallow `import`s, `require`s or ``s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */ + + /* Emit */ + "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */ + "outDir": "./dist", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */ + "declarationDir": "./typings", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": false, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */ + // "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */ + // "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +} diff --git a/typings/index.d.ts b/typings/index.d.ts new file mode 100644 index 0000000..a16ec3b --- /dev/null +++ b/typings/index.d.ts @@ -0,0 +1,16 @@ +export interface SocketConfig { + host: string; + port: number; +} +export declare type SingleRunConfiguration = SocketConfig & { + topic: string; + timeout?: number; +}; +export declare type TopicReturnType = string | number | null; +export interface TopicConnection { + send: (topic: string) => Promise; + destroy: () => void; +} +declare function sendTopic(config: SingleRunConfiguration): Promise; +declare function createTopicConnection(config: SocketConfig): TopicConnection; +export { sendTopic, createTopicConnection };