@tolinax/ayoune-cli 2024.2.16 → 2024.2.17

package/lib/helpers/handleResponseFormatOptions.js

@@ -1,43 +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 };
-}
+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/makeRandomToken.js

@@ -0,0 +1,27 @@
+import { randomBytes } from "crypto";
+/** Sync */
+const randomString = (length, chars) => {
+    if (!chars) {
+        throw new Error("Argument 'chars' is undefined");
+    }
+    const charsLength = chars.length;
+    if (charsLength > 256) {
+        throw new Error("Argument 'chars' should not have more than 256 characters" +
+            ", otherwise unpredictability will be broken");
+    }
+    const _randomBytes = randomBytes(length);
+    let result = new Array(length);
+    let cursor = 0;
+    for (let i = 0; i < length; i++) {
+        cursor += _randomBytes[i];
+        result[i] = chars[cursor % charsLength];
+    }
+    return result.join("");
+};
+/** Sync */
+export const randomAsciiString = (length = 32, alphabet = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789") => {
+    if (typeof length === "undefined") {
+        length = 32;
+    }
+    return randomString(length, alphabet);
+};

package/lib/models/getCollections.js

@@ -1,4 +1,4 @@
-import { modelsAndRights } from "@tolinax/ayoune-models/data/modelsAndRights.js";
+import { modelsAndRights } from "../../data/modelsAndRights.js";
 import { addSpacesToCamelCase } from "../helpers/addSpacesToCamelCase.js";
 const getCollections = () => {
     return modelsAndRights

package/lib/models/getModelsInModules.js

@@ -1,6 +1,6 @@
 import _ from "lodash";
 import { addSpacesToCamelCase } from "../helpers/addSpacesToCamelCase.js";
-import { modelsAndRights } from "@tolinax/ayoune-models/data/modelsAndRights.js";
+import { modelsAndRights } from "../../data/modelsAndRights.js";
 const getModelsInModules = (module) => {
     const m = _.filter(modelsAndRights, { module });
     return m.map((el) => {

package/lib/models/getModuleFromCollection.js

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

package/lib/operations/handleCollectionOperation.js

@@ -1,68 +1,68 @@
-// 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";
-import yaml from "js-yaml";
-import { promptFilePath } from "../prompts/promptFilePath.js";
-import { promptFileName } from "../prompts/promptFileName.js";
-import path from "path";
-import { writeFile } from "fs/promises";
-import { mkdirp } from "mkdirp";
-export async function handleCollectionOperation(module, collection, entry, opts) {
-    spinner.start({ text: "", color: "magenta" });
-    let res;
-    let editContent;
-    const action = await promptDefaultAction();
-    switch (action) {
-        case "edit":
-            res = await apiCallHandler(`${module}/${collection.toLowerCase()}/${entry}?responseFormat=table`);
-            spinner.success({
-                text: `Got entry ${res.payload.name} - Took ${res.meta.responseTime} ms`,
-            });
-            spinner.stop();
-            editContent = res.payload;
-            await handleEditOperation(module, collection, editContent);
-            break;
-        case "edit raw":
-            res = await apiCallHandler(`${module}/${collection.toLowerCase()}/${entry}?responseFormat=${opts.responseFormat}`);
-            spinner.success({
-                text: `Got entry ${res.payload.name} - Took ${res.meta.responseTime} ms`,
-            });
-            spinner.stop();
-            editContent = res.payload;
-            await handleEditRawOperation(module, collection, editContent);
-            break;
-        case "describe":
-            res = await apiCallHandler(`${module}/${collection.toLowerCase()}/${entry}?responseFormat=yaml}`);
-            spinner.success({
-                text: `Got entry ${res.payload.name} - Took ${res.meta.responseTime} ms`,
-            });
-            spinner.stop();
-            editContent = res.payload;
-            console.log(yaml.dump(editContent));
-            break;
-        case "download":
-            res = await apiCallHandler(`${module}/${collection.toLowerCase()}/${entry}?responseFormat=${opts.responseFormat}}`);
-            spinner.success({
-                text: `Got entry ${res.payload.name} - Took ${res.meta.responseTime} ms`,
-            });
-            spinner.stop();
-            editContent = res.payload;
-            const folder = await promptFilePath(collection);
-            await mkdirp(folder);
-            const fileName = await promptFileName(`${collection}_${editContent._id}.${opts.responseFormat}`);
-            const contentToWrite = opts.responseFormat === "yaml"
-                ? yaml.dump(editContent)
-                : opts.responseFormat === "csv"
-                    ? editContent
-                    : JSON.stringify(editContent, null, 4);
-            await writeFile(path.join(folder, fileName), contentToWrite, {
-                encoding: "utf8",
-            });
-            break;
-        default:
-            break;
-    }
-}
+// 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";
+import yaml from "js-yaml";
+import { promptFilePath } from "../prompts/promptFilePath.js";
+import { promptFileName } from "../prompts/promptFileName.js";
+import path from "path";
+import { writeFile } from "fs/promises";
+import { mkdirp } from "mkdirp";
+export async function handleCollectionOperation(module, collection, entry, opts) {
+    spinner.start({ text: "", color: "magenta" });
+    let res;
+    let editContent;
+    const action = await promptDefaultAction();
+    switch (action) {
+        case "edit":
+            res = await apiCallHandler(`${module}/${collection.toLowerCase()}/${entry}?responseFormat=table`);
+            spinner.success({
+                text: `Got entry ${res.payload.name} - Took ${res.meta.responseTime} ms`,
+            });
+            spinner.stop();
+            editContent = res.payload;
+            await handleEditOperation(module, collection, editContent);
+            break;
+        case "edit raw":
+            res = await apiCallHandler(`${module}/${collection.toLowerCase()}/${entry}?responseFormat=${opts.responseFormat}`);
+            spinner.success({
+                text: `Got entry ${res.payload.name} - Took ${res.meta.responseTime} ms`,
+            });
+            spinner.stop();
+            editContent = res.payload;
+            await handleEditRawOperation(module, collection, editContent);
+            break;
+        case "describe":
+            res = await apiCallHandler(`${module}/${collection.toLowerCase()}/${entry}?responseFormat=yaml}`);
+            spinner.success({
+                text: `Got entry ${res.payload.name} - Took ${res.meta.responseTime} ms`,
+            });
+            spinner.stop();
+            editContent = res.payload;
+            console.log(yaml.dump(editContent));
+            break;
+        case "download":
+            res = await apiCallHandler(`${module}/${collection.toLowerCase()}/${entry}?responseFormat=${opts.responseFormat}}`);
+            spinner.success({
+                text: `Got entry ${res.payload.name} - Took ${res.meta.responseTime} ms`,
+            });
+            spinner.stop();
+            editContent = res.payload;
+            const folder = await promptFilePath(collection);
+            await mkdirp(folder);
+            const fileName = await promptFileName(`${collection}_${editContent._id}.${opts.responseFormat}`);
+            const contentToWrite = opts.responseFormat === "yaml"
+                ? yaml.dump(editContent)
+                : opts.responseFormat === "csv"
+                    ? editContent
+                    : JSON.stringify(editContent, null, 4);
+            await writeFile(path.join(folder, fileName), contentToWrite, {
+                encoding: "utf8",
+            });
+            break;
+        default:
+            break;
+    }
+}

package/lib/operations/handleCreateSingleOperation.js

@@ -1,27 +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 };
-}
+// 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/handleEditRawOperation.js

@@ -1,35 +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();
-    }
-}
+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

@@ -1,25 +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 };
-}
+// 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/prompts/promptAudits.js

@@ -1,15 +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;
-}
+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/promptFileName.js

@@ -1,12 +1,12 @@
-import inquirer from "inquirer";
-export async function promptFileName(name) {
-    const { fileName } = await inquirer.prompt([
-        {
-            type: "text",
-            name: "fileName",
-            message: "Specify a file name",
-            default: name,
-        },
-    ]);
-    return fileName;
-}
+import inquirer from "inquirer";
+export async function promptFileName(name) {
+    const { fileName } = await inquirer.prompt([
+        {
+            type: "text",
+            name: "fileName",
+            message: "Specify a file name",
+            default: name,
+        },
+    ]);
+    return fileName;
+}

package/lib/prompts/promptFilePath.js

@@ -1,18 +1,18 @@
-import inquirer from "inquirer";
-import os from "os";
-import path from "path";
-export async function promptFilePath(fp) {
-    const { filePath } = await inquirer.prompt([
-        {
-            type: "fuzzypath",
-            name: "filePath",
-            message: "Select a target directory:",
-            itemType: "directory",
-            default: fp,
-            rootPath: path.join(os.homedir(), "aYOUne"),
-            suggestOnly: false,
-            depthLimit: 8,
-        },
-    ]);
-    return filePath;
-}
+import inquirer from "inquirer";
+import os from "os";
+import path from "path";
+export async function promptFilePath(fp) {
+    const { filePath } = await inquirer.prompt([
+        {
+            type: "fuzzypath",
+            name: "filePath",
+            message: "Select a target directory:",
+            itemType: "directory",
+            default: fp,
+            rootPath: path.join(os.homedir(), "aYOUne"),
+            suggestOnly: false,
+            depthLimit: 8,
+        },
+    ]);
+    return filePath;
+}

package/lib/prompts/promptModule.js

@@ -1,6 +1,6 @@
 // Prompt functions
 import inquirer from "inquirer";
-import { aYOUneModules } from "@tolinax/ayoune-models/data/modules.js";
+import { aYOUneModules } from "../../data/modules.js";
 export async function promptModule() {
     const { module } = await inquirer.prompt([
         {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolinax/ayoune-cli",
-  "version": "2024.2.16",
+  "version": "2024.2.17",
   "description": "",
   "type": "module",
   "main": "./index.js",
@@ -102,7 +102,6 @@
     }
   },
   "dependencies": {
-    "@tolinax/ayoune-models": "^2024.2.29",
     "axios": "^1.6.7",
     "axios-retry": "^4.0.0",
     "chalk": "^5.3.0",

package/lib/prompts/prompFilePath.js

@@ -1,11 +0,0 @@
-import inquirer from "inquirer";
-export async function promptFilePath() {
-    const { path } = await inquirer.prompt([
-        {
-            type: "fuzzypath",
-            name: "path",
-            message: "Select a target directory:",
-        },
-    ]);
-    return path;
-}