guilded.ts - npm Package Compare versions

Comparing version 0.0.2-placeholder to 0.0.2

lib/index.js

@@ -1,5 +0,57 @@
-"use strict";
-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.';
-//# sourceMappingURL=index.js.map
+'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.default = void 0;
+// Default export
+var Client_1 = require('./structures/Client');
+Object.defineProperty(exports, 'default', {
+	enumerable: true,
+	get: function () {
+		return Client_1.Client;
+	},
+});
+// Structures
+__exportStar(require('./structures/Client'), exports);
+__exportStar(require('./structures/CacheCollection'), exports);
+__exportStar(require('./structures/Base'), exports);
+__exportStar(require('./structures/User'), exports);
+__exportStar(require('./structures/Channel'), exports);
+__exportStar(require('./structures/Message'), exports);
+__exportStar(require('./structures/Server'), exports);
+__exportStar(require('./structures/ServerMember'), exports);
+__exportStar(require('./structures/ServerBan'), exports);
+// Managers
+__exportStar(require('./managers/BaseManager'), exports);
+__exportStar(require('./managers/UserManager'), exports);
+__exportStar(require('./managers/ChannelManager'), exports);
+__exportStar(require('./managers/MessageManager'), exports);
+__exportStar(require('./managers/ServerManager'), exports);
+__exportStar(require('./managers/ServerMemberManager'), exports);
+__exportStar(require('./managers/ServerBanManager'), exports);
+//# sourceMappingURL=index.js.map

package.json

 {
   "name": "guilded.ts",
-  "version": "0.0.2-placeholder",
-  "description": "A powerful NPM package for easily interacting with the Guilded API.",
+  "version": "0.0.2",
+  "description": "A powerful NPM module that allows you to easily interact with the Guilded API.",
   "main": "lib/index.js",
   "types": "typings/index.d.ts",
+  "files": [
+    "lib",
+    "typings"
+  ],
   "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": [
@@ -22,12 +22,23 @@ "guilded",
   ],
-  "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": {
+    "@discordjs/collection": "^0.6.0",
+    "@guildedts/rest": "^0.0.2",
+    "@guildedts/ws": "^0.0.2",
+    "guilded-api-typings": "^0.0.1"
+  },
   "devDependencies": {
-    "rimraf": "^3.0.2",
     "typescript": "^4.6.3"
   }
-}
+}

README.md

@@ -1,7 +0,91 @@
-# Guilded.ts
+<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>A powerful NPM module that allows you to easily interact with the <a href="https://www.guilded.gg">Guilded</a> API.</strong></h3>
+    <br />
+    <div>
+        <a href="https://www.npmjs.com/package/guilded.ts"><img src="https://img.shields.io/npm/v/guilded.ts" alt="Version" /></a>
+        <a href="https://www.npmjs.com/package/guilded.ts"><img src="https://img.shields.io/npm/dt/guilded.ts" alt="Downloads" /></a>
+        <a href="https://www.npmjs.com/package/guilded.ts"><img src="https://img.shields.io/npm/l/guilded.ts" 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/guilded.ts)
+-   [Guilded.TS Guilded Server](https://www.guilded.gg/GuildedTS)
+-   [Guilded API Guilded server](https://www.guilded.gg/API-Official)
+-   [Documentation](https://guildedts.js.org)
 
-Guilded.ts is a powerful NPM package for easily interacting with the Guilded API.
+# Packages
+
+-   `guilded.ts` ( [NPM](https://www.npmjs.com/package/guilded.ts) ) - The main package for interacting with the official [Guilded](https://www.guilded.gg) API.
+-   `guilded-api-typings` ( [NPM](https://www.npmjs.com/package/guilded-api-typings) ) - Type definitions for the [Guilded](https://www.guilded.gg) API.
+-   `@guildedts/builders` ( [NPM](https://www.npmjs.com/package/@guildedts/builders) ) - A set of builders for creating a [Guilded](https://www.guilded.gg) bot.
+-   `@guildedts/rest` ( [NPM](https://www.npmjs.com/package/@guildedts/rest) ) - The REST API manager for Guilded.TS.
+-   `@guildedts/ws` ( [NPM](https://www.npmjs.com/package/@guildedts/ws) ) The Websocket API manager for Guilded.TS.
+
+# Installation
+
+```
+npm i guilded.ts
+yarn add guilded.ts
+pnpm add guilded.ts
+```
+
+# Example bot
+
+```js
+// ESM
+import Client from 'guilded.ts';
+// CommonJS
+const { Client } = require('guilded.ts');
+
+// Create a new client
+const client = new Client();
+
+// This event is emitted when your bot is connected to Guilded's Gateway API.
+client.once('ready', () => console.log(`[READY] Logged in as ${client.user.name}.`));
+
+// This event is emitted when a message is sent on Guilded.
+client.on('messageCreate', (message) => {
+	if (message.author?.isBot) return;
+
+	if (message.content === '!ping') message.channel.send('Pong!');
+});
+
+// Log into guilded
+client.login('YOUR_BOT_TOKEN');
+```
+
+# 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,18 @@
-export declare const message = "This package is a placeholder for a future project. This package currently has no functionality.";
-//# sourceMappingURL=index.d.ts.map
+export { Client as default } from './structures/Client';
+export * from './structures/Client';
+export * from './structures/CacheCollection';
+export * from './structures/Base';
+export * from './structures/User';
+export * from './structures/Channel';
+export * from './structures/Message';
+export * from './structures/Server';
+export * from './structures/ServerMember';
+export * from './structures/ServerBan';
+export * from './managers/BaseManager';
+export * from './managers/UserManager';
+export * from './managers/ChannelManager';
+export * from './managers/MessageManager';
+export * from './managers/ServerManager';
+export * from './managers/ServerMemberManager';
+export * from './managers/ServerBanManager';
+//# 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

Improved metrics

Total package byte prevSize

95890

increased by4173.17%

Dev dependency count

1

decreased by-50%

Number of package files

71

increased by688.89%

Lines of code

1663

increased by11778.57%

Number of lines in readme file

92

increased by1050%

Worsened metrics

Dependency count

4

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@discordjs/collection@^0.6.0

• + Added@guildedts/rest@^0.0.2

• + Added@guildedts/ws@^0.0.2

• + Addedguilded-api-typings@^0.0.1

• + Added@discordjs/collection@0.6.0(transitive)

• + Added@guildedts/rest@0.0.2(transitive)

• + Added@guildedts/ws@0.0.2(transitive)

• + Added@types/node@22.13.5(transitive)

• + Added@types/ws@8.5.14(transitive)

• + Addedguilded-api-typings@0.0.1(transitive)

• + Addednode-fetch@2.6.7(transitive)

• + Addedtr46@0.0.3(transitive)

• + Addedundici-types@6.20.0(transitive)

• + Addedwebidl-conversions@3.0.1(transitive)

• + Addedwhatwg-url@5.0.0(transitive)

• + Addedws@8.18.1(transitive)