@guildedts/ws - npm Package Compare versions

Comparing version 0.0.1-pre to 0.0.1

lib/index.js

 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.message = void 0;
-exports.message = 'This package is a placeholder for a future project. This package currently has no functionality.';
+exports.default = void 0;
+var WebsocketManager_1 = require("./WebsocketManager");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return WebsocketManager_1.WebsocketManager; } });
+__exportStar(require("./WebsocketManager"), exports);
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@guildedts/ws",
-  "version": "0.0.1-pre",
-  "description": "The WebSocket manager for Guilded.ts.",
+  "version": "0.0.1",
+  "description": "The Websocket API manager for Guilded.TS.",
   "main": "lib/index.js",
@@ -12,9 +12,5 @@ "types": "typings/index.d.ts",
   "scripts": {
-    "build": "rimraf lib typings && tsc",
-    "prepublishOnly": "rimraf lib typings && tsc"
+    "build": "yarn tsc",
+    "prepublishOnly": "yarn build"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/gamertike/guilded.ts.git"
-  },
   "keywords": [
@@ -25,16 +21,23 @@ "guilded",
     "ts",
-    "types",
-    "websocket",
-    "ws"
+    "types"
   ],
-  "author": "Gamertike",
-  "license": "Apache-2.0",
+  "contributors": [
+    "Gamertike <[e-mail]> (https://gamertike.com)"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GuildedTS/Guilded.TS.git"
+  },
   "bugs": {
-    "url": "https://github.com/gamertike/guilded.ts/issues"
+    "url": "https://github.com/GuildedTS/Guilded.TS/issues"
   },
-  "homepage": "https://github.com/gamertike/guilded.ts#readme",
+  "homepage": "https://guildedts.js.org",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "ws": "^8.5.0"
+  },
   "devDependencies": {
-    "rimraf": "^3.0.2",
+    "guilded-api-typings": "^0.0.1",
     "typescript": "^4.6.3"
   }
-}
+}

README.md

@@ -1,7 +0,58 @@
-# @guildedts/ws
+<div align="center">
+    <br />
+    <a href="https://guildedts.js.org"><img src="https://guildedts.js.org/media/banner.jpg" width="500" alt="Guilded.TS"/></a>
+    <h3><strong>The Websocket API manager for <a href="https://guildedts.js.org">Guilded.TS</a>.</strong></h3>
+    <br />
+    <div>
+        <a href="https://www.npmjs.com/package/@guildedts/ws"><img src="https://img.shields.io/npm/v/@guildedts/ws" alt="Version" /></a>
+        <a href="https://www.npmjs.com/package/@guildedts/ws"><img src="https://img.shields.io/npm/dt/@guildedts/ws" alt="Downloads" /></a>
+        <a href="https://www.npmjs.com/package/@guildedts/ws"><img src="https://img.shields.io/npm/l/@guildedts/ws" alt="License: Apache-2.0">
+    </div>
+</div>
 
-> :warning: This package is a placeholder for a future project. This package currently has no functionality.
+# Links
 
-## About
+-   [Github](https://github.com/GuildedTS/Guilded.TS)
+-   [NPM](https://www.npmjs.com/package/@guildedts/ws)
+-   [Guilded.TS Guilded Server](https://www.guilded.gg/GuildedTS)
+-   [Guilded API Guilded server](https://www.guilded.gg/API-Official)
+-   [Documentation](https://guildedts.js.org)
 
-The WebSocket manager for Guilded.ts.
+# Installation
+
+```
+npm i @guildedts/ws
+yarn add @guildedts/ws
+pnpm add @guildedts/ws
+```
+
+# Contributing
+
+Contributing helps us maintain Guilded.TS. All contributes are greatly appreciated.
+
+We utilize [Yarn](https://yarnpkg.com) and [Turbo](https://turborepo.org) to manage our Monorepo. If you want to contribute we highly recommend knowing the basics of thes two.
+
+## Getting started
+
+To get started, run the following script:
+
+```
+# Install all dependencies
+yarn install
+# Build all local packages
+yarn build
+```
+
+## Commiting your changes
+
+After you have made your desired changes, Make sure you run the following script before commiting your changes:
+
+```
+# Prepare your code
+# Runs prettier along with eslint
+yarn prepare
+```
+
+---
+
+**Maintained by [Gamertike](https://www.gamertike.com). | Inspired by [discord.js](https://discord.js.org).**

typings/index.d.ts

@@ -1,2 +0,3 @@
-export declare const message = "This package is a placeholder for a future project. This package currently has no functionality.";
+export { WebsocketManager as default } from './WebsocketManager';
+export * from './WebsocketManager';
 //# sourceMappingURL=index.d.ts.map

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14247

increased by744.02%

Number of package files

11

increased by83.33%

Lines of code

169

increased by3280%

Number of lines in readme file

59

increased by637.5%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedws@^8.5.0

• + Addedws@8.18.1(transitive)