airship-cli 1.0.1 → 1.1.0

package/src/AirshipTypes.ts

@@ -1,63 +1,63 @@
-export type AccountInfo = {
-    refreshToken: string,
-    time: number
-};
-
-export type AirshipUser = {
-    user: {
-        uid: string,
-        username: string,
-        usernameLower: string,
-        statusText: string,
-        profileImageId: string,
-        lastOnlineTime: string
-    }
-};
-
-export type AirshipUserError = {
-    message: string[],
-    error: string,
-    statusCode: number
-};
-
-export type AirshipOrganization = {
-    id: string,
-    slug: string,
-    slugProperCase: string,
-    name: string,
-    description: string | null,
-    iconImageId: string,
-    createdAt: string,
-    adminBanned: boolean
-}
-
-type GameLink = {
-    type: "DISCORD",
-    url: string
-};
-
-export type AirshipGame = {
-    game: {
-        id: string,
-        slug: string | null,
-        slugProperCase: string | null,
-        name: string,
-        description: string | null,
-        iconImageId: string,
-        organizationId: string,
-        createdAt: string,
-        visibility: "PUBLIC" | "UNLISTED" | "PRIVATE",
-        lastVersionUpdate: string,
-        archivedAt: string | null,
-        loadingScreenImageId: string | null,
-        logoImageId: string | null,
-        videoId: string | null,
-        links: GameLink[],
-        plays: number,
-        favorites: number,
-        plays24h: number,
-        uniquePlays24h: number,
-        platforms: string[],
-        organization: AirshipOrganization
-    }
+export type AccountInfo = {
+    refreshToken: string,
+    time: number
+};
+
+export type AirshipUser = {
+    user: {
+        uid: string,
+        username: string,
+        usernameLower: string,
+        statusText: string,
+        profileImageId: string,
+        lastOnlineTime: string
+    }
+};
+
+export type AirshipError = {
+    message: string[],
+    error: string,
+    statusCode: number
+};
+
+export type AirshipOrganization = {
+    id: string,
+    slug: string,
+    slugProperCase: string,
+    name: string,
+    description: string | null,
+    iconImageId: string,
+    createdAt: string,
+    adminBanned: boolean
+}
+
+type GameLink = {
+    type: "DISCORD",
+    url: string
+};
+
+export type AirshipGame = {
+    game: {
+        id: string,
+        slug: string | null,
+        slugProperCase: string | null,
+        name: string,
+        description: string | null,
+        iconImageId: string,
+        organizationId: string,
+        createdAt: string,
+        visibility: "PUBLIC" | "UNLISTED" | "PRIVATE",
+        lastVersionUpdate: string,
+        archivedAt: string | null,
+        loadingScreenImageId: string | null,
+        logoImageId: string | null,
+        videoId: string | null,
+        links: GameLink[],
+        plays: number,
+        favorites: number,
+        plays24h: number,
+        uniquePlays24h: number,
+        platforms: string[],
+        organization: AirshipOrganization
+    }
 };

package/src/cli.ts

@@ -1,49 +1,68 @@
-#!/usr/bin/env node
-
-import { input, select } from '@inquirer/prompts';
-import { PrintHeader, PrintError, PrintTitle } from './util/Styles.js';
-import { AirshipToken } from './util/TokenManager.js';
-import { isInt16Array } from 'node:util/types';
-import { helpCommand } from './commands/help.js';
-import { fetchUserCommand } from './commands/FetchUser.js';
-import { fetchGameCommand } from './commands/FetchGame.js';
-
-export const commandMap = {
-    "Help": helpCommand,
-    "Fetch User": fetchUserCommand,
-    "Fetch Game": fetchGameCommand
-};
-
-export const commandList = [
-    "Help",
-    "Fetch User",
-    "Fetch Game"
-];
-
-export function StartTool() {
-    PrintTitle();
-
-    setTimeout(() => {
-        PromptCommand();
-    }, 250);
-};
-
-StartTool();
-
-async function PromptCommand() {
-    const answer = await select({ message: "What would you like to do?", choices: commandList});
-
-    for (let command of Object.entries(commandMap)) {
-        const cmdName = command[0];
-        const cmdFunction = command[1];
-
-        if (answer === cmdName) {
-            PrintTitle();
-
-            setTimeout(() => {
-                cmdFunction.execute();
-            }, 250);
-            return;
-        };
-    };
-};
+#!/usr/bin/env node
+
+import { confirm, input, select } from '@inquirer/prompts';
+import { PrintHeader, PrintError, PrintTitle } from './util/Styles.js';
+import { AirshipToken } from './util/TokenManager.js';
+import { helpCommand } from './commands/Help.js';
+import { fetchUserCommand } from './commands/FetchUser.js';
+import { fetchGameCommand } from './commands/FetchGame.js';
+import { setTimeout } from 'node:timers/promises';
+
+export const commandMap = {
+    "Help": helpCommand,
+    "Fetch User": fetchUserCommand,
+    "Fetch Game": fetchGameCommand
+};
+
+export async function StartTool() {
+    PrintTitle();
+
+    await setTimeout(250);
+    PromptCommand();
+};
+
+export async function RestartTool() {
+    try {
+        await setTimeout(800);
+        const restartTool = await confirm({ message: "Would you like to anything else?" });
+
+        if (restartTool) {
+            StartTool();
+        };
+    } catch(err) {
+        process.exit(0);
+    };
+};
+
+async function PromptCommand() {
+    try {
+        const answer = await select({ message: "What would you like to do?", choices: Object.keys(commandMap)});
+
+        for (let command of Object.entries(commandMap)) {
+            const cmdName = command[0];
+            const requiresToken = command[1].requiresToken;
+            const cmdFunction = command[1];
+
+            if (answer === cmdName) {
+                if (AirshipToken === undefined && requiresToken) {
+                    PrintError("An authenticated Airship installation is required to run this command!");
+                    process.exit(1);
+                };
+
+                await setTimeout(250);
+                cmdFunction.execute();
+                return;
+            };
+        };
+    } catch(err) {
+        process.exit(0);
+    };
+};
+
+process.on("exit", (signal) => {
+    if (signal === 0) {
+        console.clear();
+    };
+});
+
+StartTool();

package/src/commands/CommandTypes.ts

@@ -1,7 +1,8 @@
-export type CLICommand = {
-    name: string,
-    description: string,
-    usage: string,
-    requiresToken: boolean,
-    execute: () => void
+export type CLICommand = {
+    name: string,
+    displayName: string,
+    description: string,
+    usage: string,
+    requiresToken: boolean,
+    execute: () => void
 };

package/src/commands/FetchGame.ts

@@ -1,61 +1,77 @@
-import type { CLICommand } from "./CommandTypes.js";
-import { input, select, confirm } from '@inquirer/prompts';
-import { PrintHeader, PrintError, PrintTitle } from '../util/Styles.js';
-import { AirshipToken } from '../util/TokenManager.js';
-import type { AirshipGame } from "../AirshipTypes.js";
-import { StartTool } from "../cli.js";
-
-const apiMap = {
-    "Slug": "https://api.airship.gg/content/games/slug/",
-    "GameId": "https://api.airship.gg/content/games/game-id/"
-};
-
-export const fetchGameCommand: CLICommand = {
-    name: "fetch-game",
-    description: "Returns data related to the specified game.",
-    usage: "fetch-game <method: slug | gameId> <identifier: string>",
-    requiresToken: false,
-    execute: async () => {
-        const fetchMethod = await select({ message: "Which method would you like to use?", choices: [
-            "Slug",
-            "GameId"
-        ]});
-
-        const gameIdentifier = await input({ message: `Please enter the ${fetchMethod}:` });
-
-        for (let data of Object.entries(apiMap)) {
-            const method = data[0];
-            const url = data[1];
-
-            if (method === fetchMethod) {
-                fetch(url + gameIdentifier, {
-                    method: "GET"
-                }).then(raw => raw.text().then(data => {
-                    const gameData = JSON.parse(data) as AirshipGame | {};
-                    const entries = Object.entries(gameData);
-
-                    if (entries.length === 0) {
-                        PrintError(`Invalid ${fetchMethod}!`);
-                    } else if (entries.length === 3) {
-                        // const styledError = `${entries[0]?.[1]}`.replaceAll("username", "Username").replaceAll(",", ", ");
-                        // PrintError(styledError);
-                    };
-
-                    console.log(gameData);
-                })).catch((err) => {
-                    PrintError(err);
-                });
-
-                setTimeout(async () => {
-                    const restartTool = await confirm({ message: "Would you like to anything else?" });
-
-                    if (restartTool) {
-                        StartTool();
-                    };
-                }, 1000);
-
-                return;
-            };
-        };
-    }
+import type { CLICommand } from "./CommandTypes.js";
+import { input, select, confirm } from '@inquirer/prompts';
+import { PrintHeader, PrintError, PrintTitle } from '../util/Styles.js';
+import { AirshipToken } from '../util/TokenManager.js';
+import type { AirshipError, AirshipGame } from "../AirshipTypes.js";
+import { RestartTool, StartTool } from "../cli.js";
+import { setTimeout } from "node:timers/promises";
+import chalk from "chalk";
+
+const apiMap = {
+    "Slug": "https://api.airship.gg/content/games/slug/",
+    "GameId": "https://api.airship.gg/content/games/game-id/"
+};
+
+export const fetchGameCommand: CLICommand = {
+    name: "fetch-game",
+    displayName: "Fetch Game",
+    description: "Returns data related to the specified game.",
+    usage: "fetch-game <method: slug | gameId> <identifier: string>",
+    requiresToken: false,
+    execute: async () => {
+        console.clear();
+        PrintHeader("Fetch Game");
+
+        await setTimeout(250);
+
+        const fetchMethod = await select({ message: "Which method would you like to use?", choices: [
+            "Slug",
+            "GameId"
+        ]});
+
+        const gameIdentifier = await input({ message: `Please enter the ${fetchMethod}:` });
+        const dataType = await select({ message: "How would you like your data?", choices: [ "Simple", "Verbose" ] });
+
+        for (let data of Object.entries(apiMap)) {
+            const method = data[0];
+            const url = data[1];
+
+            if (method === fetchMethod) {
+                fetch(url + gameIdentifier, {
+                    method: "GET"
+                }).then(raw => raw.text().then(data => {
+                    const result = JSON.parse(data) as AirshipGame | AirshipError | {};
+                    const keys = Object.keys(result);
+                    const entries = Object.entries(result);
+
+                    if (entries.length === 0 || "error" in result || keys.length === 0) {
+                        PrintError(`Invalid ${fetchMethod}!`);
+                        return;
+                    };
+
+                    switch(dataType) {
+                        case "Simple":
+                            const userData = (result as AirshipGame).game;
+
+                            console.log(`\n${chalk.green("Game Id")}: ${userData.id}`);
+                            console.log(`${chalk.green("Name")}: ${userData.name}`);
+                            console.log(`${chalk.green("Slug")}: ${userData.slug || ""}`);
+                            console.log(`${chalk.green("Developer")}: ${userData.organization.name}`);
+                            console.log(`${chalk.green("Description")}: ${userData.description || ""}\n`);
+                            break;
+                        case "Verbose":
+                            console.dir(result, { depth: null });
+                            console.log();
+                            break;
+                    };
+                })).catch((err) => {
+                    PrintError(err);
+                });
+
+                RestartTool();
+
+                return;
+            };
+        };
+    }
 };

package/src/commands/FetchUser.ts

@@ -1,61 +1,75 @@
-import type { CLICommand } from "./CommandTypes.js";
-import { input, select, confirm } from '@inquirer/prompts';
-import { PrintHeader, PrintError, PrintTitle } from '../util/Styles.js';
-import { AirshipToken } from '../util/TokenManager.js';
-import type { AirshipUser, AirshipUserError } from "../AirshipTypes.js";
-import { StartTool } from "../cli.js";
-
-const apiMap = {
-    "Username": "https://api.airship.gg/game-coordinator/users/user?username=",
-    "UserId": "https://api.airship.gg/game-coordinator/users/uid/"
-};
-
-export const fetchUserCommand: CLICommand = {
-    name: "fetch-user",
-    description: "Returns data related to the specified user.",
-    usage: "fetch-user <method: username | userId> <identifier: string>",
-    requiresToken: false,
-    execute: async () => {
-        const fetchMethod = await select({ message: "Which method would you like to use?", choices: [
-            "Username",
-            "UserId"
-        ]});
-
-        const userIdentifier = await input({ message: `Please enter the ${fetchMethod}:` });
-
-        for (let data of Object.entries(apiMap)) {
-            const method = data[0];
-            const url = data[1];
-
-            if (method === fetchMethod) {
-                fetch(url + userIdentifier, {
-                    method: "GET"
-                }).then(raw => raw.text().then(data => {
-                    const userData = JSON.parse(data) as AirshipUser | AirshipUserError | {};
-                    const entries = Object.entries(userData);
-
-                    if (entries.length === 0) {
-                        PrintError(`Invalid ${fetchMethod}!`);
-                    } else if (entries.length === 3) {
-                        const styledError = `${entries[0]?.[1]}`.replaceAll("username", "Username").replaceAll(",", ", ");
-                        PrintError(styledError);
-                    };
-
-                    console.log(userData);
-                })).catch((err) => {
-                    PrintError(err);
-                });
-
-                setTimeout(async () => {
-                    const restartTool = await confirm({ message: "Would you like to anything else?" });
-
-                    if (restartTool) {
-                        StartTool();
-                    };
-                }, 1000);
-
-                return;
-            };
-        };
-    }
+import type { CLICommand } from "./CommandTypes.js";
+import { input, select, confirm } from '@inquirer/prompts';
+import { PrintError, PrintHeader, PrintTitle } from '../util/Styles.js';
+import { AirshipToken } from '../util/TokenManager.js';
+import type { AirshipUser, AirshipError } from "../AirshipTypes.js";
+import { RestartTool, StartTool } from "../cli.js";
+import chalk from "chalk";
+import { setTimeout } from "node:timers/promises";
+
+const apiMap = {
+    "Username": "https://api.airship.gg/game-coordinator/users/user?username=",
+    "UserId": "https://api.airship.gg/game-coordinator/users/uid/"
+};
+
+export const fetchUserCommand: CLICommand = {
+    name: "fetch-user",
+    displayName: "Fetch User",
+    description: "Returns data related to the specified user.",
+    usage: "fetch-user <method: username | userId> <identifier: string>",
+    requiresToken: false,
+    execute: async () => {
+        console.clear();
+        PrintHeader("Fetch User");
+
+        await setTimeout(250);
+
+        const fetchMethod = await select({ message: "Which method would you like to use?", choices: [
+            "Username",
+            "UserId"
+        ]});
+
+        const userIdentifier = await input({ message: `Please enter the ${fetchMethod}:` });
+        const dataType = await select({ message: "How would you like your data?", choices: [ "Simple", "Verbose" ] });
+
+        for (let data of Object.entries(apiMap)) {
+            const method = data[0];
+            const url = data[1];
+
+            if (method === fetchMethod) {
+                fetch(url + userIdentifier, {
+                    method: "GET"
+                }).then(raw => raw.text().then(data => {
+                    const result = JSON.parse(data) as AirshipUser | AirshipError | {};
+                    const keys = Object.keys(result);
+                    const entries = Object.entries(result);
+
+                    if (entries.length === 0 || "error" in result || keys.length === 0) {
+                        PrintError(`Invalid ${fetchMethod}!`);
+                        return;
+                    };
+
+                    switch(dataType) {
+                        case "Simple":
+                            const userData = (result as AirshipUser).user;
+
+                            console.log(`\n${chalk.green("User Id")}: ${userData.uid}`);
+                            console.log(`${chalk.green("Username")}: ${userData.username}`);
+                            console.log(`${chalk.green("Status Text")}: ${userData.statusText || ""}\n`);
+                            break;
+                        case "Verbose":
+                            console.dir(result, { depth: null });
+                            console.log();
+                            break;
+                    };
+                })).catch((err) => {
+                    PrintError(err);
+                });
+
+                RestartTool();
+
+                return;
+            };
+        };
+    }
 };

package/src/commands/Help.ts

@@ -1,36 +1,37 @@
-import type { CLICommand } from "./CommandTypes.js";
-import chalk from "chalk";
-import { input, select, confirm } from '@inquirer/prompts';
-import { PrintHeader, PrintError, PrintTitle } from '../util/Styles.js';
-import { AirshipToken } from '../util/TokenManager.js';
-import { commandMap, commandList, StartTool } from "../cli.js";
-
-export const helpCommand: CLICommand = {
-    name: "help",
-    description: "Returns the usage of a command.",
-    usage: "help <command: string>",
-    requiresToken: false,
-    execute: async () => {
-        const commandSelect = await select({ message: "Which command do you need help with?", choices: commandList.slice(1) });
-
-        for (let command of Object.entries(commandMap)) {
-            if (command[0] === commandSelect) {
-                console.log(`\n`);
-                console.log(`${chalk.bold(chalk.green(`${commandSelect} Help:`))}`);
-                console.log(`- Description: ${chalk.gray(command[1].description)}`);
-                console.log(`- Usage: ${chalk.gray(command[1].usage)}`);
-                console.log(`\n`);
-
-                setTimeout(async () => {
-                    const restartTool = await confirm({ message: "Would you like to anything else?" });
-
-                    if (restartTool) {
-                        StartTool();
-                    };
-                }, 0);
-
-                return;
-            };
-        };
-    }
+import type { CLICommand } from "./CommandTypes.js";
+import chalk from "chalk";
+import { input, select, confirm } from '@inquirer/prompts';
+import { PrintHeader, PrintError, PrintTitle } from '../util/Styles.js';
+import { AirshipToken } from '../util/TokenManager.js';
+import { commandMap, StartTool } from "../cli.js";
+
+export const helpCommand: CLICommand = {
+    name: "help",
+    displayName: "Help",
+    description: "Returns the usage of a command.",
+    usage: "help <command: string>",
+    requiresToken: false,
+    execute: async () => {
+        const commandSelect = await select({ message: "Which command do you need help with?", choices: Object.keys(commandMap).slice(1) });
+
+        for (let command of Object.entries(commandMap)) {
+            if (command[0] === commandSelect) {
+                console.log(`\n`);
+                console.log(`${chalk.bold(chalk.green(`${commandSelect} Help:`))}`);
+                console.log(`- Description: ${chalk.gray(command[1].description)}`);
+                console.log(`- Usage: ${chalk.gray(command[1].usage)}`);
+                console.log(`\n`);
+
+                setTimeout(async () => {
+                    const restartTool = await confirm({ message: "Would you like to anything else?" });
+
+                    if (restartTool) {
+                        StartTool();
+                    };
+                }, 0);
+
+                return;
+            };
+        };
+    }
 };

package/src/util/Styles.ts

@@ -1,20 +1,20 @@
-import figlet from "figlet";
-import chalk from "chalk";
-
-export async function PrintHeader(message: string) {
-    const textArt = await figlet.text(message);
-    const coloredText = chalk.blue(textArt);
-
-    console.log(chalk.bold(coloredText));
-};
-
-export async function PrintError(message: string) {
-    const coloredText = chalk.red(message);
-
-    console.log(chalk.bold(coloredText));
-};
-
-export function PrintTitle() {
-    console.clear();
-    PrintHeader(`Airship CLI\n\n`);
+import figlet from "figlet";
+import chalk from "chalk";
+
+export async function PrintHeader(message: string) {
+    const textArt = await figlet.text(message);
+    const coloredText = chalk.blue(textArt);
+
+    console.log(chalk.bold(coloredText));
+};
+
+export async function PrintError(message: string) {
+    const coloredText = chalk.red(message);
+
+    console.log(chalk.bold(coloredText));
+};
+
+export function PrintTitle() {
+    console.clear();
+    PrintHeader(`Airship CLI\n\n`);
 };