new: optionals support

Author: Andrei

src/index.ts

@@ -1,19 +1,12 @@
-import path from "path";
 import fs from "fs-extra"
 import { Command } from "commander";
 import logger from "./utils/logger";
 import Invoice from "./utils/invoice";
 import minimist from "minimist"
 import { getConfig, getInvoiceDirectory, getVersion, openConfigDirectory, openConfigurationFile, openInvoicesDirectory, timeout } from "./utils";
-import * as os from "os"
 import inquirer from "inquirer";
 import type { Config } from "./types/types";
-
-export const DEFAULT_DIR = path.join(os.homedir(), ".config", "icli/");
-export const DEFAULT_INVOICES_DIR = path.join(os.homedir(), "Documents", "Invoices/")
-export const DEFAULT_PATH = path.join(os.homedir(), ".config", "icli/icli.json");
-export const INVOICE_PATH = path.join(path.dirname(DEFAULT_PATH), "invoices.json");
-
+import { DEFAULT_OPTION_PROMPTS, DEFAULT_PATH } from "./utils/constants";
 
 async function init() {
 
@@ -47,7 +40,8 @@ async function init() {
   await timeout(200)
 
   let unset = []
-  for (const defaultOption of Object.keys(Invoice.defaultOptionPrompts)) {
+  const requiredValues = Object.entries(DEFAULT_OPTION_PROMPTS).filter(([_, v]) => v.required).map(([k]) => k)
+  for (const defaultOption of requiredValues) {
     if (config?.default_values?.[defaultOption as keyof typeof config.default_values]) continue
 
     unset.push(defaultOption.toLowerCase())

src/types/types.d.ts

@@ -7,6 +7,7 @@ export interface Config {
 }
 
 export interface DefaultOption<T extends 'input' | 'number' = 'input'> {
+  required: boolean;
   type: T
   message: string
   validate: (value: T extends 'number' ? number : string) => void
@@ -32,8 +33,8 @@ export interface DefaultOptionPrompts {
   fullName: DefaultOption
   address: DefaultOption
   postcode: DefaultOption
+  email: DefaultOption
   logo?: DefaultOption
-  email?: DefaultOption
 }
 
 export interface InvoiceItem {

src/utils/constants.ts

@@ -0,0 +1,90 @@
+import path from "path"
+import os from "os"
+import type { DefaultOptionPrompts } from "../types/types";
+import axios from "axios";
+
+export const DEFAULT_DIR = path.join(os.homedir(), ".config", "icli/");
+export const DEFAULT_INVOICES_DIR = path.join(os.homedir(), "Documents", "Invoices/")
+export const DEFAULT_PATH = path.join(os.homedir(), ".config", "icli/icli.json");
+export const INVOICE_PATH = path.join(path.dirname(DEFAULT_PATH), "invoices.json");
+
+export const DEFAULT_OPTION_PROMPTS: DefaultOptionPrompts = {
+  sortCode: {
+    required: true,
+    type: "input",
+    message: "Enter your sort code",
+    validate: val => {
+      const sortCodePattern = /^\d{2}-\d{2}-\d{2}$/;
+      return sortCodePattern.test(val) || "Sort code must be in the format XX-XX-XX (e.g., 12-34-56)";
+    }
+  },
+  bankNum: {
+    required: true,
+    type: "number",
+    message: "Enter your bank account number",
+    validate: num => {
+      const bankNumStr = num.toString();
+      return /^\d{8}$/.test(bankNumStr) || "Bank account number must be exactly 8 digits long";
+    }
+  },
+  fullName: {
+    required: true,
+    type: "input",
+    message: "Enter your full name",
+    validate: str => {
+      const fullNamePattern = /^[a-zA-Z]+([ '-][a-zA-Z]+)+$/;
+      return fullNamePattern.test(str) || "Full name must contain at least two parts (e.g., John Doe) and only letters, spaces, hyphens, or apostrophes";
+    }
+  },
+  address: {
+    required: true,
+    type: "input",
+    message: "Enter your line of address",
+    validate: str => {
+      const addressPattern = /^[a-zA-Z0-9\s,.\-]+$/;
+      return (str.length >= 5 && addressPattern.test(str)) || "Address must be at least 5 characters long and can contain letters, numbers, spaces, commas, and periods.";
+    }
+  },
+  email: {
+    required: true,
+    type: "input",
+    message: "Enter your email address",
+    validate: str => {
+      if (!str) return "Email cannot be empty"
+
+      const email = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+      if (!email.test(str)) return "Please insert a valid email address."
+
+      return true
+    }
+  },
+  postcode: {
+    required: true,
+    type: "input",
+    message: "Enter your postcode",
+    validate: str => {
+      const postcodePattern = /^([A-Z]{1,2}\d{1,2}|[A-Z]{1,2}\d{1,2}[A-Z]?)\s?\d[A-Z]{2}$/i;
+      return postcodePattern.test(str) || "Postcode must be in a valid format (e.g., AB1 2CD).";
+    }
+  },
+  logo: {
+    required: false,
+    type: "input",
+    message: "Enter your logo source",
+    validate: async str => {
+      if (!str) return 'Logo source cannot be empty'
+      
+      const url = /^(ftp|http|https):\/\/[^ "]+$/;
+      if (!url.test(str)) return "Please enter a valid URL"
+
+      try {
+        const res = await axios.head(str)
+        return res.status === 200 ? true : "The URL must point to a valid image"
+      } catch (e) {
+        return "Unable to access URL."
+      }
+    }
+  }
+
+};
+

src/utils/index.ts

@@ -3,11 +3,11 @@ import { exec } from "child_process"
 import * as os from "os"
 import path from "path"
 import logger from "./logger"
-import { DEFAULT_INVOICES_DIR, DEFAULT_PATH, mainMenu } from ".."
 import inquirer from "inquirer"
 import fs from "fs-extra"
 import type { Config } from "../types/types"
 import axios from "axios"
+import { DEFAULT_INVOICES_DIR, DEFAULT_PATH } from "./constants"
 
 export const timeout = async (t: number) => new Promise(r => setTimeout(r, t))
 
@@ -173,7 +173,7 @@ export function getConfig(): Config {
 
 export async function getVersion(): Promise<string> {
   try {
-    const res = await axios.get(`https://api/.github.com/repos/itzcodex24/cli/contents/package.json`)
+    const res = await axios.get(`https://api.github.com/repos/itzcodex24/cli/contents/package.json`)
     if (res.data && res.data.content) {
       const jsonPackage = JSON.parse(Buffer.from(res.data.content, 'base64').toString('utf-8'))
 

src/utils/invoice.ts

@@ -1,59 +1,15 @@
 import inquirer from "inquirer";
-import { INVOICE_PATH, DEFAULT_PATH, DEFAULT_DIR, mainMenu } from "..";
 import logger from "./logger";
 import fs from "fs-extra";
 import path from "path"
 import HTML from "./html";
 import chalk from "chalk";
 import type { DefaultOptionPrompts, TInvoice } from "../types/types";
 import { getConfig } from ".";
+import { DEFAULT_DIR, DEFAULT_OPTION_PROMPTS, DEFAULT_PATH, INVOICE_PATH } from "./constants";
+import { mainMenu } from "..";
 
 class Invoice {
-
-  defaultOptionPrompts: DefaultOptionPrompts = {
-    sortCode: {
-      type: "input",
-      message: "Enter your sort code",
-      validate: val => {
-        const sortCodePattern = /^\d{2}-\d{2}-\d{2}$/;
-        return sortCodePattern.test(val) || "Sort code must be in the format XX-XX-XX (e.g., 12-34-56)";
-      }
-    },
-    bankNum: {
-      type: "number",
-      message: "Enter your bank account number",
-      validate: num => {
-        const bankNumStr = num.toString();
-        return /^\d{8}$/.test(bankNumStr) || "Bank account number must be exactly 8 digits long";
-      }
-    },
-    fullName: {
-      type: "input",
-      message: "Enter your full name",
-      validate: str => {
-        const fullNamePattern = /^[a-zA-Z]+([ '-][a-zA-Z]+)+$/;
-        return fullNamePattern.test(str) || "Full name must contain at least two parts (e.g., John Doe) and only letters, spaces, hyphens, or apostrophes";
-      }
-    },
-    address: {
-      type: "input",
-      message: "Enter your line of address",
-      validate: str => {
-        const addressPattern = /^[a-zA-Z0-9\s,.\-]+$/;
-        return (str.length >= 5 && addressPattern.test(str)) || "Address must be at least 5 characters long and can contain letters, numbers, spaces, commas, and periods.";
-      }
-    },
-    postcode: {
-      type: "input",
-      message: "Enter your postcode",
-      validate: str => {
-        const postcodePattern = /^([A-Z]{1,2}\d{1,2}|[A-Z]{1,2}\d{1,2}[A-Z]?)\s?\d[A-Z]{2}$/i;
-        return postcodePattern.test(str) || "Postcode must be in a valid format (e.g., AB1 2CD).";
-      }
-    }
-    
-  };
-
   async createInvoice(useDefaultValues = true) {
     try {
       const templatePath = path.dirname(DEFAULT_PATH);
@@ -167,7 +123,7 @@ class Invoice {
     const value = await inquirer.prompt([
       {
         name: key,
-        ...this.defaultOptionPrompts[key]
+        ...DEFAULT_OPTION_PROMPTS[key]
       }
     ])
     return value[key]
@@ -176,10 +132,10 @@ class Invoice {
   async setupDefaultValues(args?: string[]) {
     const config = getConfig()
 
-    args = args?.length ? args : Object.keys(this.defaultOptionPrompts).map(o => o.toLowerCase())
+    args = args?.length ? args : Object.entries(DEFAULT_OPTION_PROMPTS).filter(([_, v]) => v.required).map(([k]) => k)
 
     for (const arg of args) {
-      const key = Object.keys(this.defaultOptionPrompts).find(o => o.toLowerCase() === arg)
+      const key = Object.keys(DEFAULT_OPTION_PROMPTS).find(o => o.toLowerCase() === arg)
       if (!key) {
         logger.error(`Can't edit a value that doesn't exist: ${arg}`)
         continue