BREAKING!: merge routers with rest

README.md

@@ -34,7 +34,6 @@ Cordis is cut up in the form of multiple packages/libraries:
 - [`@cordis/queue`](https://github.com/cordis-lib/cordis/tree/main/libs/queue) - A simple and compact sequential queue for async operations
 - [`@cordis/redis-store`](https://github.com/cordis-lib/cordis/tree/main/libs/redis-store) - A Redis implementation of `@cordis/store`
 - [`@cordis/rest`](https://github.com/cordis-lib/cordis/tree/main/libs/rest) - Tooling for making HTTP requests to Discord, with rate limiting handling
-- [`@cordis/routers`](https://github.com/cordis-lib/cordis/tree/main/libs/routers) - Make API requests with ease using simple dynamic JavaScript property accessing
 - [`@cordis/store`](https://github.com/cordis-lib/cordis/tree/main/libs/store) - A simple map-like interface for holding key-value pairs - ships with an in-memory implementation
 
 # Contributing

libs/gateway/src/websocket/Cluster.ts

@@ -6,7 +6,7 @@ import {
   WebsocketConnectionDestroyOptions
 } from './WebsocketConnection';
 import { stripIndent } from 'common-tags';
-import { RestManager, MemoryMutex, RedisMutex } from '@cordis/rest';
+import { Rest, MemoryMutex, RedisMutex } from '@cordis/rest';
 import {
   APIUser,
   GatewayDispatchPayload,
@@ -117,7 +117,7 @@ export class Cluster extends EventEmitter {
   /**
    * REST instance
    */
-  public readonly rest: RestManager;
+  public readonly rest: Rest;
 
   /**
    * First shard ID for this cluster
@@ -185,7 +185,7 @@ export class Cluster extends EventEmitter {
       ...shardOptions
     } = options;
 
-    this.rest = new RestManager(auth, { mutex: redis ? new RedisMutex(redis) : new MemoryMutex() });
+    this.rest = new Rest(auth, { mutex: redis ? new RedisMutex(redis) : new MemoryMutex() });
     this.shardCount = shardCount;
     this.startingShard = startingShard;
     this.totalShardCount = totalShardCount;

libs/rest/README.md

@@ -15,18 +15,23 @@ Note: Props to https://github.com/spec-tacles/spectacles.js for the Mutex logic.
 
 ## Example Usage
 ```ts
-const { RestManager } = require('@cordis/rest');
+const { Rest, buildRestRouter } = require('@cordis/rest');
 
 const main = async () => {
-  const rest = new RestManager('token');
+  const rest = new Rest('token');
+  const router = buildRestRouter(rest);
 
+  // using the rest manager itself
   const someUser = await rest.get('/users/223703707118731264');
   const someOtherUser = await rest.make({
     path: '/users/198536269586890752',
     method: 'get'
   });
 
-  console.log(someUser, someOtherUser);
+  // using the router utility
+  const someOtherOtherUser = await router.users["223703707118731264"].get();
+
+  console.log(someUser, someOtherUser, someOtherOtherUser);
 };
 
 main();

libs/rest/src/Bucket.ts

@@ -1,7 +1,7 @@
 import { discordFetch, DiscordFetchOptions } from './Fetch';
 import { CordisRestError, HTTPError } from './Error';
 import { halt } from '@cordis/common';
-import type { RestManager } from './RestManager';
+import type { Rest } from './Rest';
 
 /**
  * Data held to represent ratelimit state for a Bucket
@@ -39,7 +39,7 @@ export class Bucket {
    * @param route The identifier of this bucket
    */
   public constructor(
-    public readonly manager: RestManager,
+    public readonly manager: Rest,
     public readonly route: string
   ) {}
 

libs/routers/src/IRouter.ts → libs/rest/src/IRouter.ts

@@ -1,4 +1,4 @@
-import type { File, StringRecord, RequestBodyData } from '@cordis/rest';
+import type { File, StringRecord, RequestBodyData } from './';
 
 export type IRouter = {
   get<T, Q = StringRecord>(options?: { query?: Q }): Promise<T>;

libs/rest/src/RestManager.ts → libs/rest/src/Rest.ts

@@ -9,7 +9,7 @@ import type { DiscordFetchOptions, File, RequestBodyData, StringRecord } from '.
 /**
  * Options for constructing a rest manager
  */
-export interface RestManagerOptions {
+export interface RestOptions {
   /**
    * How many times to retry making a request before giving up
    */
@@ -25,7 +25,7 @@ export interface RestManagerOptions {
   mutex?: Mutex;
 }
 
-export interface RestManager {
+export interface Rest {
   /**
    * Fired when a request is being started (pre-ratelimit checking)
    * @event
@@ -105,7 +105,7 @@ export interface RequestOptions<D, Q> {
  * Base REST class used for making requests
  * @noInheritDoc
  */
-export class RestManager extends EventEmitter {
+export class Rest extends EventEmitter {
   /**
    * Current active rate limiting Buckets
    */
@@ -121,7 +121,7 @@ export class RestManager extends EventEmitter {
    */
   public constructor(
     public readonly auth: string,
-    options: RestManagerOptions = {}
+    options: RestOptions = {}
   ) {
     super();
     const {

libs/rest/src/index.ts

@@ -3,4 +3,6 @@ export * from './Bucket';
 export * from './Constants';
 export * from './Error';
 export * from './Fetch';
-export * from './RestManager';
+export * from './Rest';
+export * from './IRouter';
+export * from './restRouter';

libs/rest/src/rest.test.ts

@@ -2,7 +2,7 @@ import fetch, { Response, Headers } from 'node-fetch';
 import Blob from 'fetch-blob';
 import { Bucket } from './Bucket';
 import { CordisRestError, HTTPError } from './Error';
-import { RequestOptions, RestManager } from './RestManager';
+import { RequestOptions, Rest } from './Rest';
 
 jest.mock('node-fetch', () => {
   const fetch: typeof import('node-fetch') = jest.requireActual('node-fetch');
@@ -32,10 +32,10 @@ jest.mock('@cordis/common', () => {
 
 const mockedFetch = fetch as any as jest.Mock<Promise<Response>>;
 
-let rest: RestManager;
+let rest: Rest;
 
 beforeEach(() => {
-  rest = new RestManager('token');
+  rest = new Rest('token');
 });
 
 describe('buckets and rate limiting', () => {

libs/routers/src/restRouter.test.ts → libs/rest/src/restRouter.test.ts

@@ -1,16 +1,9 @@
 import { buildRestRouter } from './restRouter';
-import { RestManager } from '@cordis/rest';
+import type { Rest } from './Rest';
 
-const manager = RestManager as any as RestManager;
-const mockedMake = manager.make as any as jest.Mock;
-
-jest.mock('@cordis/rest', () => ({
-  RestManager: {
-    make: jest.fn()
-  }
-}));
-
-const router = buildRestRouter(manager);
+const mockedMake = jest.fn();
+const rest = { make: mockedMake } as any as Rest;
+const router = buildRestRouter(rest);
 
 afterEach(() => {
   mockedMake.mockClear();

libs/routers/src/restRouter.ts → libs/rest/src/restRouter.ts

@@ -1,4 +1,4 @@
-import type { RestManager } from '@cordis/rest';
+import type { Rest } from './Rest';
 import type { IRouter } from './IRouter';
 
 /**
@@ -16,7 +16,7 @@ import type { IRouter } from './IRouter';
  * ```
  * @param manager REST manager
  */
-export const buildRestRouter = (manager: RestManager) => {
+export const buildRestRouter = (manager: Rest) => {
   const method: string[] = [''];
   const handler: ProxyHandler<IRouter> = {
     get(_, property) {

libs/util/src/restUtils.ts

@@ -1,7 +1,7 @@
 /* istanbul ignore file */
 
 import { Routes } from 'discord-api-types/v8';
-import type { RestManager } from '@cordis/rest';
+import type { Rest } from '@cordis/rest';
 // eslint-disable-next-line no-duplicate-imports
 import type {
   Snowflake,
@@ -137,7 +137,7 @@ import type {
 
 interface webhookIdOrToken { webhookID: Snowflake; webhookToken?: string }
 
-export const makeRestUtils = (rest: RestManager) => ({
+export const makeRestUtils = (rest: Rest) => ({
   createGuild: (data: RESTPostAPIGuildsJSONBody) => rest.post<RESTPostAPIGuildsResult, RESTPostAPIGuildsJSONBody>(Routes.guilds(), { data }),
   fetchGuild: (...args: Parameters<typeof Routes.guild>) => rest.get<RESTGetAPIGuildResult>(Routes.guild(...args)),
   fetchGuildPreview: (...args: Parameters<typeof Routes.guildPreview>) => rest.get<APIGuildPreview>(Routes.guildPreview(...args)),