@learnpack/learnpack 4.0.10 → 4.0.13

package/lib/utils/api.d.ts

@@ -1,14 +1,14 @@
-declare const _default: {
-    login: (identification: string, password: string) => Promise<any>;
-    publish: (config: any) => Promise<any>;
-    update: (config: any) => Promise<any>;
-    getPackage: (slug: string) => Promise<any>;
-    getLangs: () => Promise<any>;
-    getAllPackages: ({ lang, slug, }: {
-        lang?: string | undefined;
-        slug?: string | undefined;
-    }) => Promise<any>;
-    sendBatchTelemetry: (url: string, body: object) => Promise<void>;
-    sendStreamTelemetry: (url: string, body: object) => Promise<void>;
-};
-export default _default;
+declare const _default: {
+    login: (identification: string, password: string) => Promise<any>;
+    publish: (config: any) => Promise<any>;
+    update: (config: any) => Promise<any>;
+    getPackage: (slug: string) => Promise<any>;
+    getLangs: () => Promise<any>;
+    getAllPackages: ({ lang, slug, }: {
+        lang?: string;
+        slug?: string;
+    }) => Promise<any>;
+    sendBatchTelemetry: (url: string, body: object) => Promise<void>;
+    sendStreamTelemetry: (url: string, body: object) => Promise<void>;
+};
+export default _default;

package/lib/utils/api.js

@@ -1,255 +1,255 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const console_1 = require("../utils/console");
-const storage = require("node-persist");
-const cli_ux_1 = require("cli-ux");
-const HOST = "https://breathecode.herokuapp.com";
-const RIGOBOT_HOST = "https://rigobot.herokuapp.com";
-// eslint-disable-next-line
-const _fetch = require("node-fetch");
-const fetch = async (url, options = {}, returnAsJson = true) => {
-    const headers = { "Content-Type": "application/json" };
-    console_1.default.debug(`Fetching ${url}`);
-    let session = null;
-    try {
-        session = await storage.getItem("bc-payload");
-        if (session.token && session.token !== "" && !url.includes("/token"))
-            headers.Authorization = "Token " + session.token;
-    }
-    catch (_a) { }
-    try {
-        const resp = await _fetch(url, Object.assign(Object.assign({}, options), { headers: Object.assign(Object.assign({}, headers), options.headers) }));
-        if (resp.status >= 200 && resp.status < 300) {
-            return returnAsJson ? await resp.json() : await resp.text();
-        }
-        if (resp.status === 401)
-            console_1.default.debug("Invalid authentication credentials", `Code: 401`);
-        // throw APIError("Invalid authentication credentials", 401)
-        else if (resp.status === 404)
-            throw APIError("Package not found", 404);
-        else if (resp.status >= 500)
-            throw APIError("Impossible to connect with the server", 500);
-        else if (resp.status >= 400) {
-            const error = await resp.json();
-            if (error.detail || error.error) {
-                throw APIError(error.detail || error.error);
-            }
-            else if (error.nonFieldErrors) {
-                throw APIError(error.nonFieldErrors[0], error);
-            }
-            else if (typeof error === "object") {
-                if (Object.keys(error).length > 0) {
-                    const key = error[Object.keys(error)[0]];
-                    throw APIError(`${key}: ${error[key][0]}`, error);
-                }
-            }
-            else {
-                throw APIError("Uknown error");
-            }
-        }
-        else
-            throw APIError("Uknown error");
-    }
-    catch (error) {
-        console_1.default.error(error.message);
-        throw error;
-    }
-};
-const login = async (identification, password) => {
-    try {
-        cli_ux_1.default.action.start(`Looking for credentials with ${identification}`);
-        await cli_ux_1.default.wait(1000);
-        const url = `${HOST}/v1/auth/login/`;
-        const data = await fetch(url, {
-            body: JSON.stringify({
-                email: identification,
-                password: password,
-            }),
-            method: "post",
-        });
-        cli_ux_1.default.action.stop("ready");
-        let rigoPayload = null;
-        try {
-            rigoPayload = await loginRigo(data.token);
-        }
-        catch (_a) {
-            return Object.assign(Object.assign({}, data), { rigobot: null });
-        }
-        return Object.assign(Object.assign({}, data), { rigobot: rigoPayload });
-    }
-    catch (error) {
-        cli_ux_1.default.action.stop("error");
-        console_1.default.error(error.message);
-        console_1.default.debug(error);
-    }
-};
-const loginRigo = async (token) => {
-    try {
-        const rigoUrl = `${RIGOBOT_HOST}/v1/auth/me/token?breathecode_token=${token}`;
-        const rigoResp = await _fetch(rigoUrl);
-        const rigobotJson = await rigoResp.json();
-        return rigobotJson;
-    }
-    catch (error) {
-        // Handle the error as needed, for example log it or return a custom error message
-        console_1.default.error("Error logging in to Rigo, did you already accepted Rigobot?:", error);
-        throw new Error("Failed to log in to Rigo");
-    }
-};
-const publish = async (config) => {
-    const keys = [
-        "difficulty",
-        "language",
-        "skills",
-        "technologies",
-        "slug",
-        "repository",
-        "author",
-        "title",
-    ];
-    const payload = {};
-    for (const k of keys)
-        config[k] ? (payload[k] = config[k]) : null;
-    try {
-        console.log("Package to publish:", payload);
-        cli_ux_1.default.action.start("Updating package information...");
-        await cli_ux_1.default.wait(1000);
-        const data = await fetch(`${HOST}/v1/package/${config.slug}`, {
-            method: "PUT",
-            body: JSON.stringify(payload),
-        });
-        cli_ux_1.default.action.stop("ready");
-        return data;
-    }
-    catch (error) {
-        console_1.default.error(error.message);
-        console_1.default.debug(error);
-        throw error;
-    }
-};
-const update = async (config) => {
-    try {
-        cli_ux_1.default.action.start("Updating package information...");
-        await cli_ux_1.default.wait(1000);
-        const data = await fetch(`${HOST}/v1/package/`, {
-            method: "POST",
-            body: JSON.stringify(config),
-        });
-        cli_ux_1.default.action.stop("ready");
-        return data;
-    }
-    catch (error) {
-        console_1.default.error(error.message);
-        console_1.default.debug(error);
-        throw error;
-    }
-};
-const getPackage = async (slug) => {
-    try {
-        cli_ux_1.default.action.start("Downloading package information...");
-        await cli_ux_1.default.wait(1000);
-        const data = await fetch(`${HOST}/v1/package/${slug}`);
-        cli_ux_1.default.action.stop("ready");
-        return data;
-    }
-    catch (error) {
-        if (error.status === 404)
-            console_1.default.error(`Package ${slug} does not exist`);
-        else
-            console_1.default.error(`Package ${slug} does not exist`);
-        console_1.default.debug(error);
-        throw error;
-    }
-};
-const getLangs = async () => {
-    try {
-        cli_ux_1.default.action.start("Downloading language options...");
-        await cli_ux_1.default.wait(1000);
-        const data = await fetch(`${HOST}/v1/package/language`);
-        cli_ux_1.default.action.stop("ready");
-        return data;
-    }
-    catch (error) {
-        if (error.status === 404)
-            console_1.default.error("Package slug does not exist");
-        else
-            console_1.default.error("Package slug does not exist");
-        console_1.default.debug(error);
-        throw error;
-    }
-};
-const getAllPackages = async ({ lang = "", slug = "", }) => {
-    try {
-        cli_ux_1.default.action.start("Downloading packages...");
-        await cli_ux_1.default.wait(1000);
-        const data = await fetch(`${HOST}/v1/package/all?limit=100&language=${lang}&slug=${slug}`);
-        cli_ux_1.default.action.stop("ready");
-        return data;
-    }
-    catch (error) {
-        console_1.default.error(`Package ${slug} does not exist`);
-        console_1.default.debug(error);
-        throw error;
-    }
-};
-const APIError = (error, code) => {
-    const message = error.message || error;
-    const _err = new Error(message);
-    _err.status = code || 400;
-    return _err;
-};
-const sendBatchTelemetry = async function (url, body) {
-    if (!url) {
-        return;
-    }
-    const session = await storage.getItem("bc-payload");
-    if (!session ||
-        !Object.prototype.hasOwnProperty.call(session, "token") ||
-        session.token === "") {
-        console_1.default.debug("No token found, skipping stream telemetry delivery");
-        return;
-    }
-    fetch(url, {
-        method: "POST",
-        body: JSON.stringify(body),
-    }, false)
-        .then(response => {
-        console_1.default.debug("Telemetry sent successfully");
-        return response.text();
-    })
-        .catch(error => {
-        console_1.default.debug("Error while sending batch Telemetry", error);
-    });
-};
-const sendStreamTelemetry = async function (url, body) {
-    if (!url) {
-        return;
-    }
-    const session = await storage.getItem("bc-payload");
-    if (!session ||
-        !Object.prototype.hasOwnProperty.call(session, "token") ||
-        session.token === "") {
-        console_1.default.debug("No token found, skipping stream telemetry delivery");
-        return;
-    }
-    fetch(url, {
-        method: "POST",
-        body: JSON.stringify(body),
-    }, false)
-        .then(response => {
-        return response;
-    })
-        .catch(error => {
-        console_1.default.debug("Error while sending stream Telemetry", error);
-    });
-};
-exports.default = {
-    login,
-    publish,
-    update,
-    getPackage,
-    getLangs,
-    getAllPackages,
-    sendBatchTelemetry,
-    sendStreamTelemetry,
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const console_1 = require("../utils/console");
+const storage = require("node-persist");
+const cli_ux_1 = require("cli-ux");
+const HOST = "https://breathecode.herokuapp.com";
+const RIGOBOT_HOST = "https://rigobot.herokuapp.com";
+// eslint-disable-next-line
+const _fetch = require("node-fetch");
+const fetch = async (url, options = {}, returnAsJson = true) => {
+    const headers = { "Content-Type": "application/json" };
+    console_1.default.debug(`Fetching ${url}`);
+    let session = null;
+    try {
+        session = await storage.getItem("bc-payload");
+        if (session.token && session.token !== "" && !url.includes("/token"))
+            headers.Authorization = "Token " + session.token;
+    }
+    catch (_a) { }
+    try {
+        const resp = await _fetch(url, Object.assign(Object.assign({}, options), { headers: Object.assign(Object.assign({}, headers), options.headers) }));
+        if (resp.status >= 200 && resp.status < 300) {
+            return returnAsJson ? await resp.json() : await resp.text();
+        }
+        if (resp.status === 401)
+            console_1.default.debug("Invalid authentication credentials", `Code: 401`);
+        // throw APIError("Invalid authentication credentials", 401)
+        else if (resp.status === 404)
+            throw APIError("Package not found", 404);
+        else if (resp.status >= 500)
+            throw APIError("Impossible to connect with the server", 500);
+        else if (resp.status >= 400) {
+            const error = await resp.json();
+            if (error.detail || error.error) {
+                throw APIError(error.detail || error.error);
+            }
+            else if (error.nonFieldErrors) {
+                throw APIError(error.nonFieldErrors[0], error);
+            }
+            else if (typeof error === "object") {
+                if (Object.keys(error).length > 0) {
+                    const key = error[Object.keys(error)[0]];
+                    throw APIError(`${key}: ${error[key][0]}`, error);
+                }
+            }
+            else {
+                throw APIError("Uknown error");
+            }
+        }
+        else
+            throw APIError("Uknown error");
+    }
+    catch (error) {
+        console_1.default.error(error.message);
+        throw error;
+    }
+};
+const login = async (identification, password) => {
+    try {
+        cli_ux_1.default.action.start(`Looking for credentials with ${identification}`);
+        await cli_ux_1.default.wait(1000);
+        const url = `${HOST}/v1/auth/login/`;
+        const data = await fetch(url, {
+            body: JSON.stringify({
+                email: identification,
+                password: password,
+            }),
+            method: "post",
+        });
+        cli_ux_1.default.action.stop("ready");
+        let rigoPayload = null;
+        try {
+            rigoPayload = await loginRigo(data.token);
+        }
+        catch (_a) {
+            return Object.assign(Object.assign({}, data), { rigobot: null });
+        }
+        return Object.assign(Object.assign({}, data), { rigobot: rigoPayload });
+    }
+    catch (error) {
+        cli_ux_1.default.action.stop("error");
+        console_1.default.error(error.message);
+        console_1.default.debug(error);
+    }
+};
+const loginRigo = async (token) => {
+    try {
+        const rigoUrl = `${RIGOBOT_HOST}/v1/auth/me/token?breathecode_token=${token}`;
+        const rigoResp = await _fetch(rigoUrl);
+        const rigobotJson = await rigoResp.json();
+        return rigobotJson;
+    }
+    catch (error) {
+        // Handle the error as needed, for example log it or return a custom error message
+        console_1.default.error("Error logging in to Rigo, did you already accepted Rigobot?:", error);
+        throw new Error("Failed to log in to Rigo");
+    }
+};
+const publish = async (config) => {
+    const keys = [
+        "difficulty",
+        "language",
+        "skills",
+        "technologies",
+        "slug",
+        "repository",
+        "author",
+        "title",
+    ];
+    const payload = {};
+    for (const k of keys)
+        config[k] ? (payload[k] = config[k]) : null;
+    try {
+        console.log("Package to publish:", payload);
+        cli_ux_1.default.action.start("Updating package information...");
+        await cli_ux_1.default.wait(1000);
+        const data = await fetch(`${HOST}/v1/package/${config.slug}`, {
+            method: "PUT",
+            body: JSON.stringify(payload),
+        });
+        cli_ux_1.default.action.stop("ready");
+        return data;
+    }
+    catch (error) {
+        console_1.default.error(error.message);
+        console_1.default.debug(error);
+        throw error;
+    }
+};
+const update = async (config) => {
+    try {
+        cli_ux_1.default.action.start("Updating package information...");
+        await cli_ux_1.default.wait(1000);
+        const data = await fetch(`${HOST}/v1/package/`, {
+            method: "POST",
+            body: JSON.stringify(config),
+        });
+        cli_ux_1.default.action.stop("ready");
+        return data;
+    }
+    catch (error) {
+        console_1.default.error(error.message);
+        console_1.default.debug(error);
+        throw error;
+    }
+};
+const getPackage = async (slug) => {
+    try {
+        cli_ux_1.default.action.start("Downloading package information...");
+        await cli_ux_1.default.wait(1000);
+        const data = await fetch(`${HOST}/v1/package/${slug}`);
+        cli_ux_1.default.action.stop("ready");
+        return data;
+    }
+    catch (error) {
+        if (error.status === 404)
+            console_1.default.error(`Package ${slug} does not exist`);
+        else
+            console_1.default.error(`Package ${slug} does not exist`);
+        console_1.default.debug(error);
+        throw error;
+    }
+};
+const getLangs = async () => {
+    try {
+        cli_ux_1.default.action.start("Downloading language options...");
+        await cli_ux_1.default.wait(1000);
+        const data = await fetch(`${HOST}/v1/package/language`);
+        cli_ux_1.default.action.stop("ready");
+        return data;
+    }
+    catch (error) {
+        if (error.status === 404)
+            console_1.default.error("Package slug does not exist");
+        else
+            console_1.default.error("Package slug does not exist");
+        console_1.default.debug(error);
+        throw error;
+    }
+};
+const getAllPackages = async ({ lang = "", slug = "", }) => {
+    try {
+        cli_ux_1.default.action.start("Downloading packages...");
+        await cli_ux_1.default.wait(1000);
+        const data = await fetch(`${HOST}/v1/package/all?limit=100&language=${lang}&slug=${slug}`);
+        cli_ux_1.default.action.stop("ready");
+        return data;
+    }
+    catch (error) {
+        console_1.default.error(`Package ${slug} does not exist`);
+        console_1.default.debug(error);
+        throw error;
+    }
+};
+const APIError = (error, code) => {
+    const message = error.message || error;
+    const _err = new Error(message);
+    _err.status = code || 400;
+    return _err;
+};
+const sendBatchTelemetry = async function (url, body) {
+    if (!url) {
+        return;
+    }
+    const session = await storage.getItem("bc-payload");
+    if (!session ||
+        !Object.prototype.hasOwnProperty.call(session, "token") ||
+        session.token === "") {
+        console_1.default.debug("No token found, skipping stream telemetry delivery");
+        return;
+    }
+    fetch(url, {
+        method: "POST",
+        body: JSON.stringify(body),
+    }, false)
+        .then(response => {
+        console_1.default.debug("Telemetry sent successfully");
+        return response.text();
+    })
+        .catch(error => {
+        console_1.default.debug("Error while sending batch Telemetry", error);
+    });
+};
+const sendStreamTelemetry = async function (url, body) {
+    if (!url) {
+        return;
+    }
+    const session = await storage.getItem("bc-payload");
+    if (!session ||
+        !Object.prototype.hasOwnProperty.call(session, "token") ||
+        session.token === "") {
+        console_1.default.debug("No token found, skipping stream telemetry delivery");
+        return;
+    }
+    fetch(url, {
+        method: "POST",
+        body: JSON.stringify(body),
+    }, false)
+        .then(response => {
+        return response;
+    })
+        .catch(error => {
+        console_1.default.debug("Error while sending stream Telemetry", error);
+    });
+};
+exports.default = {
+    login,
+    publish,
+    update,
+    getPackage,
+    getLangs,
+    getAllPackages,
+    sendBatchTelemetry,
+    sendStreamTelemetry,
+};

package/lib/utils/audit.d.ts

@@ -1,16 +1,16 @@
-import { IAuditErrors } from "../models/audit";
-import { IConfigObj } from "../models/config";
-import { ICounter } from "../models/counter";
-import { IFindings } from "../models/findings";
-import { IExercise } from "../models/exercise-obj";
-declare const _default: {
-    isUrl: (url: string, errors: IAuditErrors[], counter: ICounter) => Promise<boolean>;
-    checkForEmptySpaces: (str: string) => boolean;
-    checkLearnpackClean: (configObj: IConfigObj, errors: IAuditErrors[]) => void;
-    findInFile: (types: string[], content: string) => IFindings;
-    checkUrl: (config: IConfigObj, filePath: string, fileName: string, exercise: IExercise | undefined, errors: IAuditErrors[], warnings: IAuditErrors[], counter: ICounter | undefined) => Promise<boolean>;
-    writeFile: (content: string, filePath: string) => Promise<void>;
-    showErrors: (errors: IAuditErrors[], counter: ICounter | undefined) => Promise<unknown>;
-    showWarnings: (warnings: IAuditErrors[]) => Promise<unknown>;
-};
-export default _default;
+import { IAuditErrors } from "../models/audit";
+import { IConfigObj } from "../models/config";
+import { ICounter } from "../models/counter";
+import { IFindings } from "../models/findings";
+import { IExercise } from "../models/exercise-obj";
+declare const _default: {
+    isUrl: (url: string, errors: IAuditErrors[], counter: ICounter) => Promise<boolean>;
+    checkForEmptySpaces: (str: string) => boolean;
+    checkLearnpackClean: (configObj: IConfigObj, errors: IAuditErrors[]) => void;
+    findInFile: (types: string[], content: string) => IFindings;
+    checkUrl: (config: IConfigObj, filePath: string, fileName: string, exercise: IExercise | undefined, errors: IAuditErrors[], warnings: IAuditErrors[], counter: ICounter | undefined) => Promise<boolean>;
+    writeFile: (content: string, filePath: string) => Promise<void>;
+    showErrors: (errors: IAuditErrors[], counter: ICounter | undefined) => Promise<unknown>;
+    showWarnings: (warnings: IAuditErrors[]) => Promise<unknown>;
+};
+export default _default;