@discordeno/gateway 18.0.0-next.ad17926

package/README.md

@@ -0,0 +1,61 @@
+# Standalone WS / Proxy WS
+
+This WS service is meant for ADVANCED DEVELOPERS ONLY!
+
+## Benefits
+
+- **Zero Downtime Updates**:
+
+  - Your bot can be updated in a matter of seconds. With normal sharding, you have to restart which also has to process
+    identifying all your shards with a 1/~5s rate limit. With WS handling moved to a proxy process, this allows you to
+    instantly get the bot code restarted without any concerns of delays. If you have a bot on 200,000 servers normally
+    this would mean a 20 minute delay to restart your bot if you made a small change and restarted.
+
+- **Zero Downtime Resharding**:
+
+  - Discord stops letting your bot get added to new servers at certain points in time. For example, suppose you had
+    150,000 servers running 150 shards. The maximum amount of servers your shards could hold is 150 \* 2500 = 375,000.
+    If your bot reaches this, it can no longer join new servers until it re-shards.
+  - DD proxy provides 2 types of re-sharding. Automated and manual. You can also have both.
+    - `Automated`: This system will automatically begin a Zero-downtime resharding process behind the scenes when you
+      reach 80% of your maximum servers allowed by your shards. For example, since 375,000 was the max, at 300,000 we
+      would begin re-sharding behind the scenes with `ZERO DOWNTIME`.
+      - 80% of maximum servers reached (The % of 80% is customizable.)
+      - Identify limits have room to allow re-sharding. (Also customizable)
+    - `Manual`: You can also trigger this manually should you choose.
+
+- **Horizontal Scaling**:
+
+  - The proxy system allows you to scale the bot horizontally. When you reach a huge size, you can either keep spending
+    more money to keep beefing up your server or you can buy several cheaper servers and scale horizontally. The proxy
+    means you can have WS handling on a completely separate system.
+
+- **No Loss Restarts**:
+
+  - When you restart a bot without the proxy system, normally you would lose many events. Users may be using commands or
+    messages are sent that will not be filtered. As your bot's grow this number rises dramatically. Users may join who
+    wont get the auto-roles or any other actions your bot should take. With the proxy system, you can keep restarting
+    your bot and never lose any events. Events will be put into a queue while your bot is down(max size of queue is
+    customizable), once the bot is available the queue will begin processing all events.
+
+- **Controllers**:
+
+  - The controller aspect gives you full control over everything inside the proxy. You can provide a function to simply
+    override the handler. For example, if you would like a certain function to do something different, instead of having
+    to fork and maintain your fork, you can just provide a function to override.
+
+- **Clustering With Workers**:
+  - Take full advantage of all your CPU cores by using workers to spread the load. Control how many shards per worker
+    and how many workers to maximize efficiency!
+
+## Usage
+
+```ts
+createGatewayManager({
+  // TODO: (docs) Fill this out
+});
+```
+
+## API/Docs
+
+// TODO: (docs) Fill this out. List all props/methods.

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from '@discordeno/types';
+export * from '@discordeno/utils';
+export * from './manager/index.js';
+export * from './shard/index.js';
+export * from './utils/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA;AAClC,cAAc,kBAAkB,CAAA;AAChC,cAAc,kBAAkB,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export*from"@discordeno/types";export*from"@discordeno/utils";export*from"./manager/index.js";export*from"./shard/index.js";export*from"./utils/index.js";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9pbmRleC50cyJdLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tICdAZGlzY29yZGVuby90eXBlcydcbmV4cG9ydCAqIGZyb20gJ0BkaXNjb3JkZW5vL3V0aWxzJ1xuZXhwb3J0ICogZnJvbSAnLi9tYW5hZ2VyL2luZGV4LmpzJ1xuZXhwb3J0ICogZnJvbSAnLi9zaGFyZC9pbmRleC5qcydcbmV4cG9ydCAqIGZyb20gJy4vdXRpbHMvaW5kZXguanMnXG4iXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsV0FBYyxtQkFBbUIsQUFDakMsWUFBYyxtQkFBbUIsQUFDakMsWUFBYyxvQkFBb0IsQUFDbEMsWUFBYyxrQkFBa0IsQUFDaEMsWUFBYyxrQkFBa0IifQ==

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@discordeno/gateway",
+  "version": "18.0.0-next.ad17926",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/discordeno/discordeno.git"
+  },
+  "scripts": {
+    "build": "swc src --out-dir dist",
+    "build:type": "tsc --declaration --emitDeclarationOnly --declarationDir dist",
+    "release-build": "yarn build && yarn build:type",
+    "fmt": "prettier -w ./src",
+    "lint": "eslint \"src/**/*.ts*\"",
+    "test:unit": "c8 mocha --no-warnings 'tests/**/*.spec.ts'",
+    "test:unit:watch": "mocha --no-warnings --watch --parallel 'tests/**/*.spec.ts'",
+    "test:type": "tsc --noEmit",
+    "test:test-type": "tsc --project tsconfig.test.json"
+  },
+  "devDependencies": {
+    "@discordeno/types": "18.0.0-alpha.1",
+    "@discordeno/utils": "18.0.0-alpha.1",
+    "@swc/cli": "^0.1.57",
+    "@swc/core": "^1.3.21",
+    "@types/chai": "^4",
+    "@types/mocha": "^10",
+    "@types/node": "^18.11.9",
+    "@types/sinon": "^10.0.13",
+    "@types/ws": "^8.5.3",
+    "c8": "^7.12.0",
+    "chai": "^4.3.7",
+    "eslint": "^8.0.1",
+    "eslint-config-discordeno": "*",
+    "mocha": "^10.1.0",
+    "sinon": "^15.0.0",
+    "tsconfig": "*",
+    "typescript": "^4.9.3"
+  },
+  "dependencies": {
+    "ws": "^8.11.0"
+  }
+}