@tolinax/ayoune-cli 2024.2.1

package/lib/helpers/handleResponseFormatOptions.js

@@ -0,0 +1,43 @@
+import yaml from "js-yaml";
+export function handleResponseFormatOptions(opts, res) {
+    let plainResult;
+    let result;
+    let meta = {};
+    let content;
+    if (opts.responseFormat && opts.responseFormat === "yaml") {
+        plainResult = yaml.load(res);
+        result = plainResult.payload;
+        meta = plainResult.meta;
+        content = yaml.dump(result);
+        console.log("\n");
+        console.log(content);
+        console.log("\n");
+    }
+    if (opts.responseFormat && opts.responseFormat === "csv") {
+        plainResult = res;
+        result = res.payload;
+        meta = res.meta;
+        content = result;
+        console.log("\n");
+        console.log(content);
+        console.log("\n");
+    }
+    if (opts.responseFormat && opts.responseFormat === "table") {
+        plainResult = res;
+        result = res.payload;
+        meta = res.meta;
+        content = result;
+        console.log("\n");
+        console.log(res);
+        console.log("\n");
+    }
+    if (opts.responseFormat && opts.responseFormat === "json") {
+        result = res.payload;
+        meta = res.meta;
+        content = JSON.stringify(result, null, 4);
+        console.log("\n");
+        console.table(result);
+        console.log("\n");
+    }
+    return { plainResult, result, meta, content };
+}

package/lib/helpers/initializeSettings.js

@@ -0,0 +1,14 @@
+//Initializes settings for system environment and inquirer
+import inquirer from "inquirer";
+import inquirerFuzzyPath from "inquirer-fuzzy-path";
+import inquirerSearchList from "inquirer-search-list";
+import inquirerFileTreeSelection from "inquirer-file-tree-selection-prompt";
+import inquirerTableInput from "inquirer-table-input";
+import InterruptedPrompt from "inquirer-interrupted-prompt";
+export function initializeSettings() {
+    inquirer.registerPrompt("fuzzypath", inquirerFuzzyPath);
+    inquirer.registerPrompt("search-list", inquirerSearchList);
+    inquirer.registerPrompt("file-tree-selection", inquirerFileTreeSelection);
+    inquirer.registerPrompt("table-input", inquirerTableInput);
+    InterruptedPrompt.fromAll(inquirer);
+}

package/lib/helpers/localStorage.js

@@ -0,0 +1,4 @@
+import { LocalStorage } from "node-localstorage";
+import path from "path";
+import os from "os";
+export const localStorage = new LocalStorage(path.join(os.homedir(), "aYOUne", "storage"));

package/lib/helpers/parseInt.js

@@ -0,0 +1,9 @@
+export function parseInteger(value, dummyPrevious) {
+    // parseInt takes a string and a radix
+    console.log(value);
+    const parsedValue = parseInt(value, 10);
+    if (isNaN(parsedValue)) {
+        throw new Error("Not a number.");
+    }
+    return parsedValue;
+}

package/lib/helpers/saveFile.js

@@ -0,0 +1,39 @@
+import { mkdirp } from "mkdirp";
+import moment from "moment";
+import path from "path";
+import { writeFile } from "fs/promises";
+import { spinner } from "../../index.js";
+export async function saveFile(type, opts, result) {
+    if (opts.save) {
+        await mkdirp(opts.outPath);
+        const fileName = opts.name
+            ? opts.name
+            : type +
+                "_page_" +
+                result.meta.pageInfo.page +
+                "_" +
+                moment().format("YYYY_DD_MM_HH_mm_ss");
+        const pathToWrite = path.join(opts.outPath, `${fileName}`).toString();
+        console.log(pathToWrite);
+        spinner.start({
+            text: `Saving operation as ${pathToWrite}.${opts.responseFormat}`,
+            color: "yellow",
+        });
+        await writeFile(`${pathToWrite}.${opts.responseFormat}`, result.content, {
+            encoding: "utf8",
+        });
+        spinner.success({
+            text: `File written: ${pathToWrite}.${opts.responseFormat}`,
+        });
+        if (opts.debug) {
+            spinner.start({
+                text: `Saving operation as ${pathToWrite}.meta.json`,
+                color: "yellow",
+            });
+            await writeFile(`${pathToWrite}.meta.json`, JSON.stringify(result.meta, null, 4), {
+                encoding: "utf8",
+            });
+            spinner.success({ text: `File written: ${pathToWrite}.meta.json` });
+        }
+    }
+}

package/lib/models/getCollections.js

@@ -0,0 +1,15 @@
+import { modelsAndRights } from "@tolinax/ayoune-models/data/modelsAndRights.js";
+import { addSpacesToCamelCase } from "../helpers/addSpacesToCamelCase.js";
+const getCollections = () => {
+    return modelsAndRights
+        .filter((el) => {
+        return el.module !== "su";
+    })
+        .map((el) => {
+        return {
+            name: addSpacesToCamelCase(el.plural),
+            value: el.plural.toLowerCase(),
+        };
+    });
+};
+export { getCollections };

package/lib/models/getModelsInModules.js

@@ -0,0 +1,13 @@
+import _ from "lodash";
+import { addSpacesToCamelCase } from "../helpers/addSpacesToCamelCase.js";
+import { modelsAndRights } from "@tolinax/ayoune-models/data/modelsAndRights.js";
+const getModelsInModules = (module) => {
+    const m = _.filter(modelsAndRights, { module });
+    return m.map((el) => {
+        return {
+            name: addSpacesToCamelCase(el.plural),
+            value: el.plural.toLowerCase(),
+        };
+    });
+};
+export { getModelsInModules };

package/lib/models/getModuleFromCollection.js

@@ -0,0 +1,7 @@
+import _ from "lodash";
+import { modelsAndRights } from "@tolinax/ayoune-models/data/modelsAndRights.js";
+const getModuleFromCollection = (collection) => {
+    const m = _.find(modelsAndRights, (el) => el.plural.toLowerCase() === collection);
+    return m;
+};
+export { getModuleFromCollection };

package/lib/operations/handleAuditOperation.js

@@ -0,0 +1,22 @@
+// Operation handling functions
+import { spinner } from "../../index.js";
+import { handleResponseFormatOptions } from "../helpers/handleResponseFormatOptions.js";
+import { localStorage } from "../helpers/localStorage.js";
+import { auditCallHandler } from "../api/auditCallHandler.js";
+export async function handleAuditOperation(collection, id, opts) {
+    spinner.start({
+        text: `Getting audit for ${id} in [${collection}]`,
+        color: "magenta",
+    });
+    let res = await auditCallHandler(`${collection.toLowerCase()}/${id}`, "get", null, {
+        responseFormat: opts.responseFormat,
+        verbosity: opts.verbosity,
+    });
+    let { plainResult, result, meta, content } = handleResponseFormatOptions({ ...opts }, res);
+    spinner.success({
+        text: `Got Audit ${id} in ${collection}`,
+    });
+    spinner.stop();
+    localStorage.setItem("lastId", result._id);
+    return { data: plainResult, content, result, meta };
+}

package/lib/operations/handleCollectionOperation.js

@@ -0,0 +1,27 @@
+// All the remaining operations are classified here
+import { apiCallHandler } from "../api/apiCallHandler.js";
+import { handleEditOperation } from "./handleEditOperation.js";
+import { handleEditRawOperation } from "./handleEditRawOperation.js";
+import { spinner } from "../../index.js";
+import { promptDefaultAction } from "../prompts/promptDefaultAction.js";
+export async function handleCollectionOperation(module, collection, entry, operation) {
+    spinner.start({ text: "", color: "magenta" });
+    const res = await apiCallHandler(`${module}/${collection.toLowerCase()}/${entry}?responseFormat=table`);
+    const editContent = res.payload;
+    console.log(editContent);
+    spinner.success({
+        text: `Got entry ${res.payload.name} - Took ${res.meta.responseTime} ms`,
+    });
+    spinner.stop();
+    const action = await promptDefaultAction();
+    switch (action) {
+        case "edit":
+            await handleEditOperation(module, collection, editContent);
+            break;
+        case "edit raw":
+            await handleEditRawOperation(module, collection, editContent);
+            break;
+        default:
+            break;
+    }
+}

package/lib/operations/handleCopySingleOperation.js

@@ -0,0 +1,22 @@
+// Operation handling functions
+import { apiCallHandler } from "../api/apiCallHandler.js";
+import { spinner } from "../../index.js";
+import { handleResponseFormatOptions } from "../helpers/handleResponseFormatOptions.js";
+import { localStorage } from "../helpers/localStorage.js";
+export async function handleCopySingleOperation(module, collection, id, opts) {
+    spinner.start({
+        text: `Copying entry ${id} in [${collection}]`,
+        color: "magenta",
+    });
+    let res = await apiCallHandler(`${module}/${collection.toLowerCase()}/${id}/copy`, "post", null, {
+        responseFormat: opts.responseFormat,
+        verbosity: opts.verbosity,
+    });
+    let { plainResult, result, meta, content } = handleResponseFormatOptions({ ...opts }, res);
+    spinner.success({
+        text: `Copied entry ${id} in ${collection}: New ID [${result._id}]`,
+    });
+    spinner.stop();
+    localStorage.setItem("lastId", result._id);
+    return { data: plainResult, content, result, meta };
+}

package/lib/operations/handleCreateSingleOperation.js

@@ -0,0 +1,27 @@
+// Operation handling functions
+import { apiCallHandler } from "../api/apiCallHandler.js";
+import { spinner } from "../../index.js";
+import { handleResponseFormatOptions } from "../helpers/handleResponseFormatOptions.js";
+import { localStorage } from "../helpers/localStorage.js";
+export async function handleCreateSingleOperation(module, collection, name, opts) {
+    spinner.start({
+        text: `Creating entry in [${collection}]`,
+        color: "magenta",
+    });
+    let res = await apiCallHandler(`${module}/${collection.toLowerCase()}`, "post", {
+        name,
+        title: name,
+        subject: name,
+        summary: name,
+    }, {
+        responseFormat: opts.responseFormat,
+        verbosity: opts.verbosity,
+    });
+    let { plainResult, result, meta, content } = handleResponseFormatOptions({ ...opts }, res);
+    spinner.success({
+        text: `Created entry [${result._id}] in ${collection}`,
+    });
+    spinner.stop();
+    localStorage.setItem("lastId", result._id);
+    return { data: plainResult, content, result, meta };
+}

package/lib/operations/handleDescribeSingleOperation.js

@@ -0,0 +1,20 @@
+// Operation handling functions
+import { apiCallHandler } from "../api/apiCallHandler.js";
+import { spinner } from "../../index.js";
+import { handleResponseFormatOptions } from "../helpers/handleResponseFormatOptions.js";
+export async function handleDescribeSingleOperation(module, collection, id, opts) {
+    spinner.start({
+        text: `Getting entry in [${collection}]`,
+        color: "magenta",
+    });
+    let res = await apiCallHandler(`${module}/${collection.toLowerCase()}/${id}`, "get", null, {
+        responseFormat: "yaml",
+        verbosity: opts.verbosity,
+    });
+    let { plainResult, result, meta, content } = handleResponseFormatOptions({ ...opts, responseFormat: "yaml" }, res);
+    spinner.success({
+        text: `Got entry in ${collection}`,
+    });
+    spinner.stop();
+    return { data: plainResult, content, result, meta };
+}

package/lib/operations/handleEditOperation.js

@@ -0,0 +1,51 @@
+import inquirer from "inquirer";
+import chalk from "chalk";
+import { apiCallHandler } from "../api/apiCallHandler.js";
+import { spinner } from "../../index.js";
+export async function handleEditOperation(module, collection, editContent) {
+    console.log(editContent);
+    const { edits } = await inquirer.prompt([
+        {
+            type: "table-input",
+            name: "edits",
+            message: "EDIT MODE",
+            infoMessage: `Navigate and Edit`,
+            hideInfoWhenKeyPressed: true,
+            freezeColumns: 1,
+            decimalPoint: ".",
+            decimalPlaces: 2,
+            selectedColor: chalk.yellow,
+            editableColor: chalk.bgYellow.bold,
+            editingColor: chalk.bgGreen.bold,
+            columns: editContent.columns.map((column) => ({
+                ...column,
+                name: column.editable
+                    ? chalk.cyan.bold(column.name)
+                    : chalk.red.bold(column.name),
+            })),
+            rows: editContent.rows,
+            validate: () => false,
+        },
+    ]);
+    console.log(edits);
+    const { save } = await inquirer.prompt([
+        {
+            type: "confirm",
+            name: "save",
+            message: "Save changes",
+        },
+    ]);
+    if (save) {
+        spinner.start({
+            text: `Attempting to save`,
+            color: "magenta",
+        });
+        const res = await apiCallHandler(`${module}/${collection.toLowerCase()}`, "put", edits.result);
+        const result = res.payload;
+        console.log(result);
+        spinner.success({
+            text: `Saved - Took ${res.meta.responseTime} ms`,
+        });
+        spinner.stop();
+    }
+}

package/lib/operations/handleEditRawOperation.js

@@ -0,0 +1,35 @@
+import inquirer from "inquirer";
+import { apiCallHandler } from "../api/apiCallHandler.js";
+import { spinner } from "../../index.js";
+export async function handleEditRawOperation(module, collection, result) {
+    const { content } = await inquirer.prompt([
+        {
+            type: "editor",
+            name: "content",
+            postfix: ".json",
+            message: "Edit",
+            default: JSON.stringify(result, null, 4),
+        },
+    ]);
+    const contentToSave = JSON.parse(content);
+    const { save } = await inquirer.prompt([
+        {
+            type: "confirm",
+            name: "save",
+            message: "Save changes",
+        },
+    ]);
+    if (save) {
+        spinner.start({
+            text: `Attempting to save [${contentToSave.name}]`,
+            color: "magenta",
+        });
+        const res = await apiCallHandler(`${module}/${collection.toLowerCase()}`, "put", JSON.parse(content));
+        result = res.payload;
+        console.log(result);
+        spinner.success({
+            text: `Saved [${contentToSave.name}] - Took ${res.meta.responseTime} ms`,
+        });
+        spinner.stop();
+    }
+}

package/lib/operations/handleGetOperation.js

@@ -0,0 +1,25 @@
+// Operation handling functions
+import { apiCallHandler } from "../api/apiCallHandler.js";
+import { spinner } from "../../index.js";
+import { handleResponseFormatOptions } from "../helpers/handleResponseFormatOptions.js";
+export async function handleGetOperation(module, collection, opts) {
+    spinner.start({
+        text: `Getting entries in [${collection}]`,
+        color: "magenta",
+    });
+    let res = await apiCallHandler(`${module}/${collection.toLowerCase()}`, "get", null, {
+        page: opts.page,
+        responseFormat: opts.responseFormat,
+        limit: opts.limit,
+        from: opts.from,
+        fields: opts.fields,
+        hideMeta: opts.hideMeta,
+        verbosity: opts.verbosity,
+    });
+    let { plainResult, result, meta, content } = handleResponseFormatOptions(opts, res);
+    spinner.success({
+        text: `Got ${opts.limit} entries of ${meta.pageInfo.totalEntries} : Page ${meta.pageInfo.page} of ${meta.pageInfo.totalPages}`,
+    });
+    spinner.stop();
+    return { data: plainResult, content, result, meta };
+}

package/lib/operations/handleGetSingleOperation.js

@@ -0,0 +1,20 @@
+// Operation handling functions
+import { apiCallHandler } from "../api/apiCallHandler.js";
+import { spinner } from "../../index.js";
+import { handleResponseFormatOptions } from "../helpers/handleResponseFormatOptions.js";
+export async function handleGetSingleOperation(module, collection, id, opts) {
+    spinner.start({
+        text: `Getting entry in [${collection}]`,
+        color: "magenta",
+    });
+    let res = await apiCallHandler(`${module}/${collection.toLowerCase()}/${id}`, "get", null, {
+        responseFormat: "table",
+        verbosity: opts.verbosity,
+    });
+    let { plainResult, result, meta, content } = handleResponseFormatOptions({ ...opts, responseFormat: "table" }, res);
+    spinner.success({
+        text: `Got entry in ${collection}`,
+    });
+    spinner.stop();
+    return { data: plainResult, content, result, meta };
+}

package/lib/operations/handleListOperation.js

@@ -0,0 +1,24 @@
+// Operation handling functions
+import { apiCallHandler } from "../api/apiCallHandler.js";
+import { spinner } from "../../index.js";
+import { handleResponseFormatOptions } from "../helpers/handleResponseFormatOptions.js";
+export async function handleListOperation(module, collection, opts) {
+    spinner.start({
+        text: `Listing entries in [${collection}]`,
+        color: "magenta",
+    });
+    let res = await apiCallHandler(`${module}/${collection.toLowerCase()}/list`, "get", null, {
+        page: opts.page,
+        responseFormat: opts.responseFormat,
+        limit: opts.limit,
+        from: opts.from,
+        hideMeta: opts.hideMeta,
+        verbosity: opts.verbosity,
+    });
+    let { plainResult, result, meta, content } = handleResponseFormatOptions(opts, res);
+    spinner.success({
+        text: `Got ${opts.limit} entries of ${meta.pageInfo.totalEntries} : Page ${meta.pageInfo.page} of ${meta.pageInfo.totalPages}`,
+    });
+    spinner.stop();
+    return { data: plainResult, content, result, meta };
+}

package/lib/operations/handleSingleAuditOperation.js

@@ -0,0 +1,27 @@
+// Operation handling functions
+import { spinner } from "../../index.js";
+import { handleResponseFormatOptions } from "../helpers/handleResponseFormatOptions.js";
+import { localStorage } from "../helpers/localStorage.js";
+import { auditCallHandler } from "../api/auditCallHandler.js";
+export async function handleSingleAuditOperation(collection, id, auditId, opts) {
+    spinner.start({
+        text: `Getting audit [${auditId}] for [${id}] in [${collection}]`,
+        color: "magenta",
+    });
+    let res = await auditCallHandler(`${collection.toLowerCase()}/${id}/${auditId}`, "get", null, {
+        responseFormat: opts.responseFormat,
+        verbosity: opts.verbosity,
+    });
+    let { plainResult, result, meta, content } = handleResponseFormatOptions({ ...opts }, res);
+    spinner.success({
+        text: `Got audit [${auditId}] for [${id}] in [${collection}]`,
+    });
+    spinner.stop();
+    localStorage.setItem("lastId", result._id);
+    return {
+        singleData: plainResult,
+        singleContent: content,
+        singleResult: result,
+        singleMeta: meta,
+    };
+}

package/lib/prompts/promptAudits.js

@@ -0,0 +1,15 @@
+import inquirer from "inquirer";
+export async function promptAudits(result) {
+    const { audit } = await inquirer.prompt([
+        {
+            type: "list",
+            name: "audit",
+            message: "Choose a audit:",
+            choices: result.map((el) => ({
+                name: `${el.action} at ${el.ts} by ${el._userID.first_name} ${el._userID.last_name}`,
+                value: el._id,
+            })),
+        },
+    ]);
+    return audit;
+}

package/lib/prompts/promptCollection.js

@@ -0,0 +1,13 @@
+import inquirer from "inquirer";
+import { getCollections } from "../models/getCollections.js";
+async function promptCollection() {
+    const { collection } = await inquirer.prompt([
+        {
+            type: "list",
+            name: "collection",
+            message: "Choose a collection:",
+            choices: getCollections(),
+        },
+    ]);
+    return collection;
+}

package/lib/prompts/promptCollectionInModule.js

@@ -0,0 +1,13 @@
+import inquirer from "inquirer";
+import { getModelsInModules } from "../models/getModelsInModules.js";
+export async function promptCollectionInModule(module) {
+    const { collection } = await inquirer.prompt([
+        {
+            type: "list",
+            name: "collection",
+            message: "Choose a collection:",
+            choices: getModelsInModules(module),
+        },
+    ]);
+    return collection;
+}

package/lib/prompts/promptCollectionWithModule.js

@@ -0,0 +1,15 @@
+import { promptModule } from "./promptModule.js";
+import inquirer from "inquirer";
+import { getModelsInModules } from "../models/getModelsInModules.js";
+export async function promptCollectionWithModule() {
+    const module = await promptModule();
+    const { collection } = await inquirer.prompt([
+        {
+            type: "list",
+            name: "collection",
+            message: "Choose a collection:",
+            choices: getModelsInModules(module),
+        },
+    ]);
+    return collection;
+}

package/lib/prompts/promptDefaultAction.js

@@ -0,0 +1,13 @@
+import inquirer from "inquirer";
+import { defaultActions } from "../../data/defaultActions.js";
+export async function promptDefaultAction() {
+    const { action } = await inquirer.prompt([
+        {
+            type: "list",
+            name: "action",
+            message: "Choose a action:",
+            choices: defaultActions,
+        },
+    ]);
+    return action;
+}

package/lib/prompts/promptEntry.js

@@ -0,0 +1,12 @@
+import inquirer from "inquirer";
+export async function promptEntry(result) {
+    const { entry } = await inquirer.prompt([
+        {
+            type: "list",
+            name: "entry",
+            message: "Choose a entry:",
+            choices: result.map((el) => ({ name: el.label, value: el._id })),
+        },
+    ]);
+    return entry;
+}

package/lib/prompts/promptModule.js

@@ -0,0 +1,19 @@
+// Prompt functions
+import inquirer from "inquirer";
+import { aYOUneModules } from "@tolinax/ayoune-models/data/modules.js";
+export async function promptModule() {
+    const { module } = await inquirer.prompt([
+        {
+            type: "list",
+            name: "module",
+            message: "Choose a module:",
+            choices: aYOUneModules.map((el) => {
+                return {
+                    name: el.label,
+                    value: el.module,
+                };
+            }),
+        },
+    ]);
+    return module;
+}

package/lib/prompts/promptName.js

@@ -0,0 +1,11 @@
+import inquirer from "inquirer";
+export async function promptName() {
+    const { name } = await inquirer.prompt([
+        {
+            type: "text",
+            name: "name",
+            message: "Give your new entry a name:",
+        },
+    ]);
+    return name;
+}

package/lib/prompts/promptOperation.js

@@ -0,0 +1,13 @@
+import inquirer from "inquirer";
+import { operations } from "../../data/operations.js";
+export async function promptOperation() {
+    const { operation } = await inquirer.prompt([
+        {
+            type: "list",
+            name: "operation",
+            message: "Choose a operation:",
+            choices: operations,
+        },
+    ]);
+    return operation;
+}

package/lib/socket/customerSocketClient.js

@@ -0,0 +1,12 @@
+import { io } from "socket.io-client";
+export const customerSocket = (user) => {
+    return io(`https://notifier.ayoune.app`, {
+        transports: ["websocket"],
+        autoConnect: true,
+        reconnection: true,
+        query: {
+            customer: user._customerID,
+            username: user._id,
+        },
+    });
+};

package/lib/socket/socketClient.js

@@ -0,0 +1,11 @@
+import { io } from "socket.io-client";
+export const socket = (token) => {
+    return io(`https://notifier.ayoune.app`, {
+        transports: ["websocket"],
+        autoConnect: true,
+        reconnection: true,
+        query: {
+            cli: token,
+        },
+    });
+};