Rewrite $alias into Typescript + subcommand structure

.gitignore

@@ -4,7 +4,7 @@ config.json
 .nyc_output
 .yarn
 yarn-error.log
-coverage
+.coverage
 build
 
 docker-compose.yml

classes/channel.ts

@@ -1,11 +1,11 @@
 import EventEmitter from "node:events";
-import { SupiError, SupiDate } from "supi-core";
+import { SupiError, type SupiDate } from "supi-core";
 
 import {
 	Platform,
-	Like as PlatformLike,
-	GenericSendOptions,
-	PrepareMessageOptions
+	type Like as PlatformLike,
+	type GenericSendOptions,
+	type PrepareMessageOptions
 } from "../platforms/template.js";
 
 import {
@@ -17,10 +17,10 @@ import {
 	saveChannelDataProperty
 } from "./custom-data-properties.js";
 
-import { User } from "./user.js";
+import type { User } from "./user.js";
 import createMessageLoggingTable from "../utils/create-db-table.js";
 import { TemplateWithId } from "./template.js";
-import { Emote } from "../@types/globals.js";
+import type { Emote } from "../@types/globals.js";
 
 export const privateMessageChannelSymbol /* : unique symbol */ = Symbol("private-message-channel");
 

classes/chat-module.ts

@@ -1,9 +1,9 @@
 import { SupiError } from "supi-core";
 
 import { TemplateWithoutId } from "./template.js";
-import { Channel, Like as ChannelLike } from "./channel.js";
-import { User } from "./user.js";
+import { Channel, type Like as ChannelLike } from "./channel.js";
 
+import type { User } from "./user.js";
 import { Platform } from "../platforms/template.js";
 import type { SimpleGenericData, XOR } from "../@types/globals.d.ts";
 import type { TwitchPlatform } from "../platforms/twitch.js";

classes/command.ts

@@ -16,26 +16,22 @@ import { getConfig } from "../config.js";
 
 type DiscordEmbeds = BaseMessageOptions["embeds"];
 
-import { TemplateWithoutId, TemplateDefinition } from "./template.js";
+import { TemplateWithoutId, type TemplateDefinition } from "./template.js";
 
-import Banphrase from "./banphrase.js";
+import { Banphrase } from "./banphrase.js";
 import { Filter } from "./filter.js";
-import {
-	User,
-	permissions as userPermissions,
-	permissionNames as userPermissionNames,
-	type PermissionNumbers
-} from "./user.js";
-import { Channel, privateMessageChannelSymbol } from "./channel.js";
-import { Platform, type GetEmoteOptions } from "../platforms/template.js";
-import CooldownManager from "../utils/cooldown-manager.js";
-import { type Language, getLanguage } from "../utils/languages.js";
+import { type Channel, privateMessageChannelSymbol } from "./channel.js";
+import { permissions as userPermissions, permissionNames as userPermissionNames, type PermissionNumbers, type User } from "./user.js";
 
+import type { Platform, GetEmoteOptions } from "../platforms/template.js";
 import type { MessageData as TwitchAppendData } from "../platforms/twitch.js";
 import type { MessageData as DiscordAppendData } from "../platforms/discord.js";
 
+import CooldownManager from "../utils/cooldown-manager.js";
+import { type Language, getLanguage } from "../utils/languages.js";
+
 import { whitespaceRegex } from "../utils/regexes.js";
-import { Emote } from "../@types/globals.js";
+import type { Emote } from "../@types/globals.js";
 
 const { values: configValues, modules: modulesConfig, responses: configResponses } = getConfig();
 const COMMAND_PREFIX = modulesConfig.commands.prefix;
@@ -108,19 +104,24 @@ export type ContextData<T extends ParameterDefinitions = ParameterDefinitions> =
 	params?: Context<T>["params"];
 };
 export type ContextAppendData = {
-	tee?: Invocation[];
-	pipe?: boolean;
+	alias?: boolean;
+	aliasArgs?: readonly string[];
 	aliasCount?: number;
-	commandList?: Command["Name"][];
 	aliasStack?: Command["Name"][];
+	aliasTry?: {
+		userName?: User["Name"];
+	};
+	badges?: unknown;
+	commandList?: Command["Name"][];
+	emotes?: unknown;
 	flags?: unknown;
 	id?: string;
 	messageID?: string;
-	badges?: unknown;
-	emotes?: unknown;
-	skipPending?: boolean;
-	privateMessage?: boolean;
+	pipe?: boolean;
 	platform?: never; // @todo this is a temporary check for refactor purposes
+	privateMessage?: boolean;
+	skipPending?: boolean;
+	tee?: Invocation[];
 };
 export type ContextPlatformSpecificData = TwitchAppendData | DiscordAppendData | null;
 
@@ -294,7 +295,7 @@ export type DescriptionFunction = (this: Command, prefix: string) => string[] |
 export type CustomInitFunction = (this: Command) => Promise<void> | void;
 export type CustomDestroyFunction = (this: Command) => void;
 
-type ExecuteOptions = {
+export type ExecuteOptions = ContextAppendData & {
 	skipPending?: boolean;
 	privateMessage?: boolean;
 	skipBanphrases?: boolean;
@@ -325,13 +326,6 @@ export interface SubcommandDefinition<T extends CommandDefinition = CommandDefin
 	flags?: Record<string, boolean>;
 	execute: (this: Command, context: Context<T["Params"]>, ...args: string[]) => StrictResult | Promise<StrictResult>;
 }
-
-export const createSubcommandBinding = <
-	T extends CommandDefinition
-> () => <
-	D extends SubcommandDefinition<T>
-> (def: D) => def;
-
 export class SubcommandCollection {
 	public readonly name: string;
 	public readonly names: readonly string[];
@@ -393,7 +387,7 @@ export class Command extends TemplateWithoutId {
 	readonly Aliases: string[];
 	readonly Description: string | null;
 	readonly Cooldown: number | null;
-	readonly Flags: Readonly<Flag[]>;
+	readonly Flags: readonly Flag[];
 	readonly Params: ParameterDefinitions = [];
 	readonly Whitelist_Response: string | null;
 	readonly Code: ExecuteFunction;

classes/custom-data-properties.ts

@@ -3,7 +3,7 @@ import type { User } from "./user.js";
 import type { SimpleGenericData } from "../@types/globals.js";
 import type { Query } from "supi-core";
 
-import { flags as twitchLottoFlags } from "../commands/twitchlotto/definitions.js";
+import type { flags as twitchLottoFlags } from "../commands/twitchlotto/definitions.js";
 type TwitchLottoFlagName = typeof twitchLottoFlags[number]["name"];
 
 type PoolConnection = Awaited<ReturnType<Query["getTransaction"]>>;

classes/filter.ts

@@ -1,9 +1,9 @@
 import { SupiError } from "supi-core";
 import { TemplateWithId } from "./template.js";
 
-import { Channel, isChannel, privateMessageChannelSymbol } from "./channel.js";
-import User from "./user.js";
-import type Platform from "../platforms/template.js";
+import { type Channel, isChannel, privateMessageChannelSymbol } from "./channel.js";
+import { User } from "./user.js";
+import type { Platform } from "../platforms/template.js";
 import type { Command } from "./command.js";
 import type { XOR } from "../@types/globals.d.ts";
 import { TWITCH_ANTIPING_CHARACTER } from "../utils/command-utils.js";

classes/user.ts

@@ -256,6 +256,18 @@ export class User extends TemplateWithIdString {
 		}
 	}
 
+	static async getAsserted (identifier: string | number): Promise<User> {
+		const userData = await User.get(identifier, true);
+		if (!userData) {
+			throw new SupiError({
+			    message: "Assert error: User.getAsserted did not find User",
+				args: { identifier }
+			});
+		}
+
+		return userData;
+	}
+
 	static async getMultiple (identifiers: Like[]) {
 		const result: User[] = [];
 		const toFetch: (string | number)[] = [];

commands/about/index.ts

@@ -1,4 +1,4 @@
-import { SupiDate, SupiError } from "supi-core";
+import { type SupiDate, SupiError } from "supi-core";
 import { declare } from "../../classes/command.js";
 
 export default declare({