feat: login and logout commands

package.json

@@ -1,5 +1,6 @@
 {
   "name": "storyblok",
+  "type": "module",
   "version": "0.0.0",
   "packageManager": "[email protected]",
   "description": "Storyblok CLI",

src/commands/login/actions.ts

@@ -1,9 +1,8 @@
 import chalk from 'chalk'
 import type { RegionCode } from '../../constants'
 import { regionsDomain } from '../../constants'
-import type { FetchError } from 'ofetch'
-import { ofetch } from 'ofetch'
-import { maskToken } from '../../utils'
+import { FetchError, ofetch } from 'ofetch'
+import { APIError, handleAPIError, maskToken } from '../../utils'
 
 export const loginWithToken = async (token: string, region: RegionCode) => {
   try {
@@ -14,15 +13,19 @@ export const loginWithToken = async (token: string, region: RegionCode) => {
     })
   }
   catch (error) {
-    if ((error as FetchError).response?.status === 401) {
-      throw new Error(`The token provided ${chalk.bold(maskToken(token))} is invalid: ${chalk.bold(`401 ${(error as FetchError).data.error}`)}
+    if (error instanceof FetchError) {
+      const status = error.response?.status
 
-  Please make sure you are using the correct token and try again.`)
+      switch (status) {
+        case 401:
+          throw new APIError('unauthorized', 'login_with_token', error, `The token provided ${chalk.bold(maskToken(token))} is invalid: ${chalk.bold(`401 ${(error as FetchError).data.error}`)}
+        Please make sure you are using the correct token and try again.`)
+        case 422:
+          throw new APIError('invalid_credentials', 'login_with_token', error)
+        default:
+          throw new APIError('network_error', 'login_with_token', error)
+      }
     }
-    if (!(error as FetchError).response) {
-      throw new Error('No response from server, please check if you are correctly connected to internet', error as Error)
-    }
-    throw new Error('Error logging with token', error as Error)
   }
 }
 
@@ -34,7 +37,7 @@ export const loginWithEmailAndPassword = async (email: string, password: string,
     })
   }
   catch (error) {
-    throw new Error('Error logging in with email and password', error as Error)
+    handleAPIError('login_email_password', error as Error)
   }
 }
 
@@ -46,6 +49,6 @@ export const loginWithOtp = async (email: string, password: string, otp: string,
     })
   }
   catch (error) {
-    throw new Error('Error logging in with email, password and otp', error as Error)
+    handleAPIError('login_with_otp', error as Error)
   }
 }

src/commands/login/index.ts

@@ -3,7 +3,7 @@ import { input, password, select } from '@inquirer/prompts'
 import type { RegionCode } from '../../constants'
 import { commands, regionNames, regions, regionsDomain } from '../../constants'
 import { getProgram } from '../../program'
-import { handleError, isRegion, konsola } from '../../utils'
+import { CommandError, handleError, isRegion, konsola } from '../../utils'
 import { loginWithEmailAndPassword, loginWithOtp, loginWithToken } from './actions'
 
 import { session } from '../../session'
@@ -40,9 +40,10 @@ export const loginCommand = program
     token: string
     region: RegionCode
   }) => {
+    konsola.title(` ${commands.LOGIN} `, '#8556D3')
     const { token, region } = options
     if (!isRegion(region)) {
-      handleError(new Error(`The provided region: ${region} is not valid. Please use one of the following values: ${Object.values(regions).join(' | ')}`), true)
+      handleError(new CommandError(`The provided region: ${region} is not valid. Please use one of the following values: ${Object.values(regions).join(' | ')}`))
     }
 
     const { state, updateSession, persistCredentials, initializeSession } = session()
@@ -67,8 +68,6 @@ export const loginCommand = program
       }
     }
     else {
-      konsola.title(` ${commands.LOGIN} `, '#8556D3')
-
       const strategy = await select(loginStrategy)
       try {
         if (strategy === 'login-with-token') {

src/index.ts

@@ -6,6 +6,8 @@
 import { getProgram } from './program'
 import './commands/login'
 import './commands/logout'
+import { APIError } from './utils/error/api-error'
+import { loginWithEmailAndPassword, loginWithToken } from './commands/login/actions'
 
 dotenv.config() // This will load variables from .env into process.env
 const program = getProgram()
@@ -16,15 +18,23 @@
 ${introText} ${messageText}`))
 
 program.option('-s, --space [value]', 'space ID')
+program.option('-v, --verbose', 'Enable verbose output')
 
 program.on('command:*', () => {
   console.error(`Invalid command: ${program.args.join(' ')}`)
   program.help()
   konsola.br() // Add a line break
 })
 
-program.command('test').action(async () => {
-  handleError(new Error('There was an error with credentials'), true)
+program.command('test').action(async (options) => {
+  konsola.title(`Test`, '#8556D3', 'Attempting a test...')
+  try {
+    // await loginWithEmailAndPassword('aw', 'passwrod', 'eu')
+    await loginWithToken('WYSYDHYASDHSYD', 'eu')
+  }
+  catch (error) {
+    handleError(error as Error)
+  }
 })
 
 /* console.log(`

src/utils/error/api-error.ts

@@ -0,0 +1,64 @@
+import { FetchError } from 'ofetch'
+
+export const API_ACTIONS = {
+  login: 'login',
+  login_with_token: 'Failed to log in with token',
+  login_with_otp: 'Failed to log in with email, password and otp',
+  login_email_password: 'Failed to log in with email and password',
+} as const
+
+export const API_ERRORS = {
+  unauthorized: 'The user is not authorized to access the API',
+  network_error: 'No response from server, please check if you are correctly connected to internet',
+  invalid_credentials: 'The provided credentials are invalid',
+  timeout: 'The API request timed out',
+} as const
+
+export function handleAPIError(action: keyof typeof API_ACTIONS, error: Error): void {
+  if (error instanceof FetchError) {
+    const status = error.response?.status
+
+    switch (status) {
+      case 401:
+        throw new APIError('unauthorized', action, error)
+      case 422:
+        throw new APIError('invalid_credentials', action, error)
+      default:
+        throw new APIError('network_error', action, error)
+    }
+  }
+  else if (error.message.includes('NetworkError') || error.message.includes('Failed to fetch')) {
+    throw new APIError('network_error', action, error)
+  }
+  else {
+    throw new APIError('timeout', action, error)
+  }
+}
+
+export class APIError extends Error {
+  errorId: string
+  cause: string
+  code: number
+  messageStack: string[]
+  error: FetchError | undefined
+
+  constructor(errorId: keyof typeof API_ERRORS, action: keyof typeof API_ACTIONS, error?: FetchError, customMessage?: string) {
+    super(customMessage || API_ERRORS[errorId])
+    this.name = 'API Error'
+    this.errorId = errorId
+    this.cause = API_ERRORS[errorId]
+    this.code = error?.response?.status || 0
+    this.messageStack = [API_ACTIONS[action], customMessage || API_ERRORS[errorId]]
+    this.error = error
+  }
+
+  getInfo() {
+    return {
+      name: this.name,
+      message: this.message,
+      cause: this.cause,
+      errorId: this.errorId,
+      stack: this.stack,
+    }
+  }
+}

src/utils/error/command-error.ts

@@ -0,0 +1,14 @@
+export class CommandError extends Error {
+  constructor(message: string) {
+    super(message)
+    this.name = 'Command Error'
+  }
+
+  getInfo() {
+    return {
+      name: this.name,
+      message: this.message,
+      stack: this.stack,
+    }
+  }
+}

src/utils/error/error.ts

@@ -0,0 +1,48 @@
+import { konsola } from '..'
+import { APIError } from './api-error'
+import { CommandError } from './command-error'
+import { FileSystemError } from './filesystem-error'
+
+export function handleError(error: Error, verbose = false): void {
+  // If verbose flag is true and the error has getInfo method
+  if (verbose && typeof (error as any).getInfo === 'function') {
+    const errorDetails = (error as any).getInfo()
+    if (error instanceof CommandError) {
+      konsola.error(`Command Error: ${error.getInfo().message}`, errorDetails)
+    }
+    else if (error instanceof APIError) {
+      console.log('error', error)
+      konsola.error(`API Error: ${error.getInfo().cause}`, errorDetails)
+    }
+    else if (error instanceof FileSystemError) {
+      konsola.error(`File System Error: ${error.getInfo().cause}`, errorDetails)
+    }
+    else {
+      konsola.error(`Unexpected Error: ${error.message}`, errorDetails)
+    }
+  }
+  else {
+    // Print the message stack if it exists
+    if ((error as any).messageStack) {
+      const messageStack = (error as any).messageStack
+      messageStack.forEach((message: string, index: number) => {
+        konsola.error(message, null, {
+          header: index === 0,
+          margin: false,
+        })
+      })
+      konsola.br()
+      konsola.info('For more information about the error, run the command with the `--verbose` flag')
+    }
+    else {
+      konsola.error(error.message, null, {
+        header: true,
+      })
+    }
+  }
+
+  if (!process.env.VITEST) {
+    console.log('') // Add a line break for readability
+    process.exit(1) // Exit process if not in a test environment
+  }
+}

src/utils/error/filesystem-error.ts

@@ -0,0 +1,26 @@
+const FS_ERRORS = {
+  file_not_found: 'The file requested was not found',
+  permission_denied: 'Permission denied while accessing the file',
+}
+
+export class FileSystemError extends Error {
+  errorId: string
+  cause: string
+
+  constructor(message: string, errorId: keyof typeof FS_ERRORS) {
+    super(message)
+    this.name = 'File System Error'
+    this.errorId = errorId
+    this.cause = FS_ERRORS[errorId]
+  }
+
+  getInfo() {
+    return {
+      name: this.name,
+      message: this.message,
+      cause: this.cause,
+      errorId: this.errorId,
+      stack: this.stack,
+    }
+  }
+}

src/utils/error/index.ts

@@ -0,0 +1,4 @@
+export * from './api-error'
+export * from './command-error'
+export * from './error'
+export * from './filesystem-error'

src/utils/index.ts

@@ -3,7 +3,7 @@ import { dirname } from 'pathe'
 import type { RegionCode } from '../constants'
 import { regions } from '../constants'
 
-export * from './error'
+export * from './error/'
 export * from './konsola'
 export const __filename = fileURLToPath(import.meta.url)
 export const __dirname = dirname(__filename)

src/utils/konsola.ts

@@ -1,13 +1,20 @@
 import chalk from 'chalk'
 
+export interface KonsolaFormatOptions {
+  header?: boolean
+  margin?: boolean
+}
+
 export function formatHeader(title: string) {
-  return `${title}
-
-  `
+  return `${title}`
 }
 export const konsola = {
-  title: (message: string, color: string) => {
-    console.log(formatHeader(chalk.bgHex(color).bold.white(` ${message} `)))
+  title: (message: string, color: string, subtitle?: string) => {
+    console.log('') // Add a line break
+    console.log('') // Add a line break
+    console.log(`${formatHeader(chalk.bgHex(color).bold.white(` ${message} `))} ${subtitle || ''}`)
+    console.log('') // Add a line break
+    console.log('') // Add a line break
   },
   br: () => {
     console.log('') // Add a line break
@@ -21,6 +28,21 @@ export const konsola = {
 
     console.log(message ? `${chalk.green('✔')} ${message}` : '')
   },
+  info: (message: string, options: KonsolaFormatOptions = {
+    header: false,
+    margin: true,
+  }) => {
+    if (options.header) {
+      console.log('') // Add a line break
+      const infoHeader = chalk.bgBlue.bold.white(` Info `)
+      console.log(formatHeader(infoHeader))
+    }
+
+    console.log(message ? `${chalk.blue('ℹ')} ${message}` : '')
+    if (options.margin) {
+      console.error('') // Add a line break
+    }
+  },
   warn: (message?: string, header: boolean = false) => {
     if (header) {
       console.log('') // Add a line break
@@ -30,15 +52,19 @@ export const konsola = {
 
     console.warn(message ? `${chalk.yellow('⚠️')} ${message}` : '')
   },
-  error: (err: Error, header: boolean = false) => {
-    if (header) {
-      console.log('') // Add a line break
+  error: (message: string, info: unknown, options: KonsolaFormatOptions = {
+    header: false,
+    margin: true,
+  }) => {
+    if (options.header) {
       const errorHeader = chalk.bgRed.bold.white(` Error `)
       console.error(formatHeader(errorHeader))
-      console.error('a111') // Add a line break
+      console.log('') // Add a line break
     }
 
-    console.error(`${chalk.red('x')} ${err.message || err}`)
-    console.log('') // Add a line break
+    console.error(`${chalk.red.bold('▲ error')} ${message}`, info || '')
+    if (options.margin) {
+      console.error('') // Add a line break
+    }
   },
 }

tsconfig.json

@@ -4,8 +4,7 @@
     "lib": ["esnext", "DOM", "DOM.Iterable"],
     "baseUrl": ".",
     "module": "esnext",
-
-    "moduleResolution": "Node",
+    "moduleResolution": "bundler",
     "resolveJsonModule": true,
     "types": ["node", "vitest/globals"],
     "allowImportingTsExtensions": true,
@@ -16,6 +15,7 @@
     "noUnusedParameters": true,
     "noEmit": true,
     "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
     "isolatedModules": true,
     "skipLibCheck": true
   },