fix: change Awaited to Awaitable

This matches the change made in
sapphiredev/utilities#193

BREAKING CHANGE: `Awaited` type has been renamed to `Awaitable`

Author: favna

package.json

@@ -28,11 +28,11 @@
 		"prepare": "husky install .github/husky"
 	},
 	"dependencies": {
-		"@sapphire/discord-utilities": "^2.1.5",
+		"@sapphire/discord-utilities": "next",
 		"@sapphire/discord.js-utilities": "next",
 		"@sapphire/pieces": "^3.0.0",
-		"@sapphire/ratelimits": "^2.0.1",
-		"@sapphire/utilities": "^2.0.1",
+		"@sapphire/ratelimits": "next",
+		"@sapphire/utilities": "next",
 		"lexure": "^0.17.0",
 		"tslib": "^2.3.1"
 	},
@@ -45,15 +45,15 @@
 		"@sapphire/prettier-config": "^1.1.6",
 		"@sapphire/ts-config": "^3.0.0",
 		"@types/jest": "^27.0.2",
-		"@types/node": "^16.9.1",
+		"@types/node": "^16.10.2",
 		"@types/ws": "^8.2.0",
 		"cz-conventional-changelog": "^3.3.0",
 		"discord.js": "^13.1.0",
 		"gen-esm-wrapper": "^1.1.3",
 		"husky": "^7.0.2",
 		"jest": "^27.2.4",
 		"jest-circus": "^27.2.4",
-		"lint-staged": "^11.1.2",
+		"lint-staged": "^11.2.0",
 		"pretty-quick": "^3.1.1",
 		"rollup": "^2.58.0",
 		"rollup-plugin-version-injector": "^1.3.3",

src/index.ts

@@ -13,7 +13,7 @@ export {
 	StoreRegistry,
 	StoreRegistryEntries
 } from '@sapphire/pieces';
-export type { Awaited } from '@sapphire/utilities';
+export type { Awaitable } from '@sapphire/utilities';
 export * from './lib/errors/ArgumentError';
 export * from './lib/errors/Identifiers';
 export * from './lib/errors/PreconditionError';

src/lib/SapphireClient.ts

@@ -1,5 +1,5 @@
 import { container, Store, StoreRegistry } from '@sapphire/pieces';
-import type { Awaited } from '@sapphire/utilities';
+import type { Awaitable } from '@sapphire/utilities';
 import { Client, ClientOptions, Message, Snowflake } from 'discord.js';
 import { join } from 'path';
 import type { Plugin } from './plugins/Plugin';
@@ -22,7 +22,7 @@ import { Logger } from './utils/logger/Logger';
 export type SapphirePrefix = string | readonly string[] | null;
 
 export interface SapphirePrefixHook {
-	(message: Message): Awaited<SapphirePrefix>;
+	(message: Message): Awaitable<SapphirePrefix>;
 }
 
 export interface SapphireClientOptions {

src/lib/parsers/Result.ts

@@ -1,5 +1,5 @@
+import { Awaitable, isFunction } from '@sapphire/utilities';
 import type * as Lexure from 'lexure';
-import { isFunction, Awaited } from '@sapphire/utilities';
 
 /**
  * A type used to express computations that can fail.
@@ -88,7 +88,7 @@ export function from<T, E = Error>(cb: (...args: unknown[]) => T): Result<T, E>
  * @typeparam T The result's type.
  * @typeparam E The error's type.
  */
-export async function fromAsync<T, E = Error>(promiseOrCb: Awaited<T> | ((...args: unknown[]) => Awaited<T>)): Promise<Result<T, E>> {
+export async function fromAsync<T, E = Error>(promiseOrCb: Awaitable<T> | ((...args: unknown[]) => Awaitable<T>)): Promise<Result<T, E>> {
 	try {
 		return ok(await (isFunction(promiseOrCb) ? promiseOrCb() : promiseOrCb));
 	} catch (error) {

src/lib/plugins/Plugin.ts

@@ -1,4 +1,4 @@
-import type { Awaited } from '@sapphire/utilities';
+import type { Awaitable } from '@sapphire/utilities';
 import type { ClientOptions } from 'discord.js';
 import type { SapphireClient } from '../SapphireClient';
 import { postInitialization, postLogin, preGenericsInitialization, preInitialization, preLogin } from './symbols';
@@ -8,6 +8,6 @@ export abstract class Plugin {
 	public static [preGenericsInitialization]?: (this: SapphireClient, options: ClientOptions) => void;
 	public static [preInitialization]?: (this: SapphireClient, options: ClientOptions) => void;
 	public static [postInitialization]?: (this: SapphireClient, options: ClientOptions) => void;
-	public static [preLogin]?: (this: SapphireClient, options: ClientOptions) => Awaited<void>;
-	public static [postLogin]?: (this: SapphireClient, options: ClientOptions) => Awaited<void>;
+	public static [preLogin]?: (this: SapphireClient, options: ClientOptions) => Awaitable<void>;
+	public static [postLogin]?: (this: SapphireClient, options: ClientOptions) => Awaitable<void>;
 }

src/lib/plugins/PluginManager.ts

@@ -1,4 +1,4 @@
-import type { Awaited } from '@sapphire/utilities';
+import type { Awaitable } from '@sapphire/utilities';
 import type { ClientOptions } from 'discord.js';
 import type { SapphireClient } from '../SapphireClient';
 import { PluginHook } from '../types/Enums';
@@ -7,7 +7,7 @@ import { postInitialization, postLogin, preGenericsInitialization, preInitializa
 
 export type AsyncPluginHooks = PluginHook.PreLogin | PluginHook.PostLogin;
 export interface SapphirePluginAsyncHook {
-	(this: SapphireClient, options: ClientOptions): Awaited<unknown>;
+	(this: SapphireClient, options: ClientOptions): Awaitable<unknown>;
 }
 
 export type SyncPluginHooks = Exclude<PluginHook, AsyncPluginHooks>;

src/lib/resolvers/message.ts

@@ -1,7 +1,7 @@
 import { MessageLinkRegex, SnowflakeRegex } from '@sapphire/discord-utilities';
 import { GuildBasedChannelTypes, isNewsChannel, isTextChannel, TextBasedChannelTypes } from '@sapphire/discord.js-utilities';
 import { container } from '@sapphire/pieces';
-import type { Awaited } from '@sapphire/utilities';
+import type { Awaitable } from '@sapphire/utilities';
 import { Message, Permissions, Snowflake } from 'discord.js';
 import { Identifiers } from '../errors/Identifiers';
 import { err, ok, Result } from '../parsers/Result';
@@ -18,7 +18,7 @@ export async function resolveMessage(parameter: string, options: MessageResolver
 	return err(Identifiers.ArgumentMessageError);
 }
 
-function resolveById(parameter: string, channel: TextBasedChannelTypes): Awaited<Message | null> {
+function resolveById(parameter: string, channel: TextBasedChannelTypes): Awaitable<Message | null> {
 	return SnowflakeRegex.test(parameter) ? channel.messages.fetch(parameter as Snowflake) : null;
 }
 

src/lib/structures/Argument.ts

@@ -1,5 +1,5 @@
 import { AliasPiece, AliasPieceOptions } from '@sapphire/pieces';
-import type { Awaited } from '@sapphire/utilities';
+import type { Awaitable } from '@sapphire/utilities';
 import type { Message } from 'discord.js';
 import type { ArgumentError } from '../errors/ArgumentError';
 import type { UserError } from '../errors/UserError';
@@ -10,7 +10,7 @@ import type { Command, CommandContext } from './Command';
 /**
  * Defines a synchronous result of an {@link Argument}, check {@link AsyncArgumentResult} for the asynchronous version.
  */
-export type ArgumentResult<T> = Awaited<Result<T, UserError>>;
+export type ArgumentResult<T> = Awaitable<Result<T, UserError>>;
 
 /**
  * Defines an asynchronous result of an {@link Argument}, check {@link ArgumentResult} for the synchronous version.

src/lib/structures/Command.ts

@@ -1,5 +1,5 @@
 import { AliasPiece, AliasPieceJSON, AliasPieceOptions, PieceContext } from '@sapphire/pieces';
-import { Awaited, isNullish } from '@sapphire/utilities';
+import { Awaitable, isNullish } from '@sapphire/utilities';
 import { Message, PermissionResolvable, Permissions, Snowflake } from 'discord.js';
 import * as Lexure from 'lexure';
 import { Args } from '../parsers/Args';
@@ -95,7 +95,7 @@ export abstract class Command<T = Args> extends AliasPiece {
 	 * @param parameters The raw parameters as a single string.
 	 * @param context The command-context used in this execution.
 	 */
-	public preParse(message: Message, parameters: string, context: CommandContext): Awaited<T> {
+	public preParse(message: Message, parameters: string, context: CommandContext): Awaitable<T> {
 		const parser = new Lexure.Parser(this.lexer.setInput(parameters).lex()).setUnorderedStrategy(this.strategy);
 		const args = new Lexure.Args(parser.parse());
 		return new Args(message, this as any, args, context) as any;
@@ -142,7 +142,7 @@ export abstract class Command<T = Args> extends AliasPiece {
 	 * @param message The message that triggered the command.
 	 * @param args The value returned by {@link Command.preParse}, by default an instance of {@link Args}.
 	 */
-	public abstract run(message: Message, args: T, context: CommandContext): Awaited<unknown>;
+	public abstract run(message: Message, args: T, context: CommandContext): Awaitable<unknown>;
 
 	/**
 	 * Defines the JSON.stringify behavior of the command.

src/lib/structures/Precondition.ts

@@ -1,13 +1,13 @@
 import { Piece, PieceContext, PieceOptions } from '@sapphire/pieces';
-import type { Awaited } from '@sapphire/utilities';
+import type { Awaitable } from '@sapphire/utilities';
 import type { Message, Permissions } from 'discord.js';
 import type { CooldownContext } from '../../preconditions/Cooldown';
 import { PreconditionError } from '../errors/PreconditionError';
 import type { UserError } from '../errors/UserError';
 import { err, ok, Result } from '../parsers/Result';
 import type { Command } from './Command';
 
-export type PreconditionResult = Awaited<Result<unknown, UserError>>;
+export type PreconditionResult = Awaitable<Result<unknown, UserError>>;
 export type AsyncPreconditionResult = Promise<Result<unknown, UserError>>;
 
 export abstract class Precondition extends Piece {

src/lib/utils/preconditions/IPreconditionContainer.ts

@@ -1,4 +1,4 @@
-import type { Awaited } from '@sapphire/utilities';
+import type { Awaitable } from '@sapphire/utilities';
 import type { Message } from 'discord.js';
 import type { UserError } from '../../errors/UserError';
 import type { Result } from '../../parsers/Result';
@@ -15,7 +15,7 @@ export type PreconditionContainerResult = Result<unknown, UserError>;
  * Defines the return type of the generic {@link IPreconditionContainer.run}.
  * @since 1.0.0
  */
-export type PreconditionContainerReturn = Awaited<PreconditionContainerResult>;
+export type PreconditionContainerReturn = Awaitable<PreconditionContainerResult>;
 
 /**
  * Async-only version of {@link PreconditionContainerReturn}, to be used when the run method is async.