@learnpack/learnpack 5.0.27 → 5.0.29

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/5.0.27 win32-x64 node-v20.16.0
+@learnpack/learnpack/5.0.29 win32-x64 node-v20.16.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -33,6 +33,7 @@ USAGE
 
 <!-- commands -->
 * [`learnpack audit`](#learnpack-audit)
+* [`learnpack breakToken`](#learnpack-breaktoken)
 * [`learnpack clean`](#learnpack-clean)
 * [`learnpack download [PACKAGE]`](#learnpack-download-package)
 * [`learnpack help [COMMAND]`](#learnpack-help-command)
@@ -75,7 +76,22 @@ DESCRIPTION
        12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)
 ```
 
-_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.29/src\commands\audit.ts)_
+
+## `learnpack breakToken`
+
+Break the token
+
+```
+USAGE
+  $ learnpack breakToken
+
+OPTIONS
+  -h, --grading  show CLI help
+  -y, --yes      Skip all prompts and initialize an empty project
+```
+
+_See code: [src\commands\breakToken.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.29/src\commands\breakToken.ts)_
 
 ## `learnpack clean`
 
@@ -90,7 +106,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.29/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -108,7 +124,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.29/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -140,7 +156,7 @@ OPTIONS
   -y, --yes      Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.29/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -158,7 +174,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.29/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -176,7 +192,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.29/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -307,7 +323,7 @@ OPTIONS
   -h, --help  show CLI help
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.29/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -329,7 +345,7 @@ OPTIONS
   -y, --yes                           Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.29/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -346,7 +362,7 @@ OPTIONS
   -y, --yes  Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.29/src\commands\test.ts)_
 
 ## `learnpack translate`
 
@@ -360,7 +376,7 @@ OPTIONS
   -y, --yes  Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\translate.ts)_
+_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.29/src\commands\translate.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/breakToken.d.ts

@@ -0,0 +1,10 @@
+import BaseCommand from "../utils/BaseCommand";
+declare class BreakTokenCommand extends BaseCommand {
+    static description: string;
+    static flags: {
+        grading: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+        yes: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}
+export default BreakTokenCommand;

package/lib/commands/breakToken.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = require("@oclif/command");
+const BaseCommand_1 = require("../utils/BaseCommand");
+const console_1 = require("../utils/console");
+const creatorUtilities_1 = require("../utils/creatorUtilities");
+class BreakTokenCommand extends BaseCommand_1.default {
+    async run() {
+        const { flags } = this.parse(BreakTokenCommand);
+        // await SessionManager.breakToken()
+        await (0, creatorUtilities_1.createFileOnDesktop)();
+        console_1.default.info("File created on desktop, please make the necessary changes and continue when ready");
+        // Wait for user to press enter
+        process.stdin.once("data", () => {
+            console_1.default.info("File content:");
+            console_1.default.info((0, creatorUtilities_1.getContentIndex)());
+            process.exit(0);
+        });
+    }
+}
+BreakTokenCommand.description = "Break the token";
+BreakTokenCommand.flags = Object.assign(Object.assign({}, BaseCommand_1.default.flags), { grading: command_1.flags.help({ char: "h" }) });
+exports.default = BreakTokenCommand;

package/lib/commands/init.js

@@ -7,19 +7,26 @@ const fs = require("fs-extra");
 const prompts = require("prompts");
 const cli_ux_1 = require("cli-ux");
 const eta = require("eta");
+const api_1 = require("../utils/api");
 const console_1 = require("../utils/console");
 const errors_1 = require("../utils/errors");
 const path = require("path");
 const rigoActions_1 = require("../utils/rigoActions");
-const api_1 = require("../utils/api");
+const api_2 = require("../utils/api");
 const creatorUtilities_1 = require("../utils/creatorUtilities");
 const session_1 = require("../managers/session");
+const durationByKind = {
+    code: 3,
+    quiz: 2,
+    read: 1,
+};
 const initializeInteractiveCreation = async (rigoToken, courseInfo) => {
     let prevInteractions = "";
     let isReady = false;
     let currentSteps = [];
     let currentTitle = "";
     let currentDescription = "";
+    let currentDifficulty = "";
     while (!isReady) {
         let wholeInfo = courseInfo;
         wholeInfo += `
@@ -40,6 +47,9 @@ const initializeInteractiveCreation = async (rigoToken, courseInfo) => {
             currentDescription !== res.parsed.description) {
             currentDescription = res.parsed.description;
         }
+        if (res.parsed.difficulty && currentDifficulty !== res.parsed.difficulty) {
+            currentDifficulty = res.parsed.difficulty;
+        }
         if (!isReady) {
             console.log(currentSteps);
             console_1.default.info(`AI: ${res.parsed.aiMessage}`);
@@ -55,17 +65,49 @@ const initializeInteractiveCreation = async (rigoToken, courseInfo) => {
             prevInteractions += `\nUser: ${userMessage.userMessage}`;
         }
     }
+    const duration = (0, creatorUtilities_1.estimateDuration)(currentSteps);
     return {
         steps: currentSteps,
         title: currentTitle,
         description: currentDescription,
         interactions: prevInteractions,
+        difficulty: currentDifficulty,
+        duration,
     };
 };
+const appendContentIndex = async () => {
+    const choices = await prompts([
+        {
+            type: "confirm",
+            name: "contentIndex",
+            message: "Do you have a content index for this tutorial?",
+        },
+    ]);
+    if (choices.contentIndex) {
+        await (0, creatorUtilities_1.createFileOnDesktop)();
+        console_1.default.info("Please make the necessary in the recently created file in your desktop, it should automatically open. Edit the file to match your expectations and save it. Keep the same name and structure as the example file. Continue when ready.");
+        const isReady = await prompts([
+            {
+                type: "confirm",
+                name: "isReady",
+                message: "Are you ready to continue?",
+            },
+        ]);
+        if (!isReady.isReady) {
+            console_1.default.error("Please make the necessary changes and try again.");
+            process.exit(1);
+        }
+        const contentIndex = (0, creatorUtilities_1.getContentIndex)();
+        return contentIndex;
+    }
+    return null;
+};
 const handleAILogic = async (tutorialDir, packageInfo) => {
     fs.removeSync(path.join(tutorialDir, "exercises", "01-hello-world"));
     let sessionPayload = await session_1.default.getPayload();
-    if (!sessionPayload || !sessionPayload.rigobot) {
+    if (!sessionPayload ||
+        !sessionPayload.rigobot ||
+        (sessionPayload.token && !(await api_1.default.validateToken(sessionPayload.token)))) {
         console_1.default.info("Almost there! First you need to login with 4Geeks.com to use AI Generation tool for creators. You can create a new account here: https://4geeks.com/creators");
         try {
             sessionPayload = await session_1.default.login();
@@ -76,10 +118,10 @@ const handleAILogic = async (tutorialDir, packageInfo) => {
         }
     }
     const rigoToken = sessionPayload.rigobot.key;
-    const consumables = await (0, api_1.getConsumables)(sessionPayload.token, "ai-generation");
-    if (consumables.ai_generation === 0) {
-        console_1.default.error("It seems you cannot generate tutorials with AI. Make sure you creator subscription is up to date here: https://4geeks.com/profile/subscriptions? . If you believe there is an issue you can always contact support@4geeks.com");
-        process.exit(1);
+    const consumable = await (0, api_2.getConsumable)(sessionPayload.token, "ai-generation");
+    if (consumable.count === 0) {
+        console_1.default.error("It seems you cannot generate tutorials with AI. Make sure you creator subscription is up to date here: https://4geeks.com/profile/subscriptions. If you believe there is an issue you can always contact support@4geeks.com");
+        // process.exit(1)
     }
     const isCreator = await (0, rigoActions_1.hasCreatorPermission)(rigoToken);
     if (!isCreator) {
@@ -87,21 +129,26 @@ const handleAILogic = async (tutorialDir, packageInfo) => {
         process.exit(1);
     }
     console_1.default.success("🎉 Let's begin this learning journey!");
+    const contentIndex = await appendContentIndex();
     let packageContext = `
   \n
   Title: ${packageInfo.title.us}
   Description: ${packageInfo.description.us}
-  Difficulty: ${packageInfo.difficulty}
-  Duration: ${packageInfo.duration}
+
+  ${contentIndex ?
+        `Content Index submitted by the user, use this to guide your creation: ${contentIndex}` :
+        ""}
+
   `;
-    const { steps, title, description } = await initializeInteractiveCreation(rigoToken, packageContext);
+    const { steps, title, description, duration, difficulty } = await initializeInteractiveCreation(rigoToken, packageContext);
     packageInfo.title.us = title;
     packageInfo.description.us = description;
+    packageInfo.duration = duration;
+    packageInfo.difficulty = difficulty;
     packageContext = `
   Title: ${title}
   Description: ${description}
-  Difficulty: ${packageInfo.difficulty}
-  Estimated duration: ${packageInfo.duration}
+
   List of exercises: ${steps.join(", ")}
   `;
     const exercisesDir = path.join(tutorialDir, "exercises");
@@ -123,13 +170,23 @@ const handleAILogic = async (tutorialDir, packageInfo) => {
             lesson_description: description,
             kind: kind.toLowerCase(),
         });
-        const { exceedsThreshold, newMarkdown } = (0, creatorUtilities_1.checkReadingTime)(readme.parsed.content, 200);
-        if (exceedsThreshold) {
-            console_1.default.error("The reading time exceeds the threshold");
-            console_1.default.info(`Please reduce the reading time of the lesson, current reading time is ${exceedsThreshold} minutes`);
+        const duration = durationByKind[kind.toLowerCase()];
+        let readingTime = (0, creatorUtilities_1.checkReadingTime)(readme.parsed.content, 200, duration || 1);
+        if (readingTime.exceedsThreshold) {
+            // Console.info(
+            //   `The reading time for the lesson ${exTitle} exceeds the threshold, reducing it...`
+            // )
+            const reducedReadme = await (0, rigoActions_1.reduceReadme)(rigoToken, {
+                lesson: readingTime.body,
+                number_of_words: readingTime.minutes.toString(),
+                expected_number_words: "200",
+            });
+            if (reducedReadme) {
+                readingTime = (0, creatorUtilities_1.checkReadingTime)(reducedReadme.parsed.content, 200, duration || 1);
+            }
         }
         const readmeFilename = "README.md";
-        fs.writeFileSync(path.join(exerciseDir, readmeFilename), newMarkdown);
+        fs.writeFileSync(path.join(exerciseDir, readmeFilename), readingTime.newMarkdown);
         if (kind.toLowerCase() === "code") {
             const codeFile = await (0, rigoActions_1.createCodeFile)(rigoToken, {
                 readme: readme.parsed.content,
@@ -137,12 +194,12 @@ const handleAILogic = async (tutorialDir, packageInfo) => {
             });
             fs.writeFileSync(path.join(exerciseDir, `app.${codeFile.parsed.extension.replace(".", "")}`), codeFile.parsed.content);
         }
-        return readme.parsed.content;
+        return readingTime.newMarkdown;
     });
-    let imagesArray = [];
     const readmeContents = await Promise.all(exercisePromises);
     console_1.default.success("Lessons created! 🎉");
     console_1.default.info("Generating images for the lessons...");
+    let imagesArray = [];
     for (const content of readmeContents) {
         imagesArray = [...imagesArray, ...(0, creatorUtilities_1.extractImagesFromMarkdown)(content)];
     }
@@ -170,7 +227,7 @@ const getChoices = async (empty) => {
         title: "My Interactive Tutorial",
         description: "",
         difficulty: "beginner",
-        duration: 1,
+        duration: 5,
         useAI: "no",
         grading: "isolated",
     };
@@ -206,30 +263,6 @@ const getChoices = async (empty) => {
             initial: "",
             message: "Description for your tutorial? Press enter to leave blank",
         },
-        {
-            type: "select",
-            name: "difficulty",
-            message: "How difficulty will be to complete the tutorial?",
-            choices: [
-                { title: "Begginer (no previous experience)", value: "beginner" },
-                { title: "Easy (just a bit of experience required)", value: "easy" },
-                {
-                    title: "Intermediate (you need experience)",
-                    value: "intermediate",
-                },
-                { title: "Hard (master the topic)", value: "hard" },
-            ],
-        },
-        {
-            type: "text",
-            name: "duration",
-            initial: "1",
-            message: "How many hours avg it takes to complete (number)?",
-            validate: (value) => {
-                const n = Math.floor(Number(value));
-                return n !== Number.POSITIVE_INFINITY && String(n) === value && n >= 0;
-            },
-        },
         {
             type: "select",
             name: "useAI",
@@ -243,7 +276,8 @@ const getChoices = async (empty) => {
             ],
         },
     ]);
-    return choices;
+    const completeChoices = Object.assign(Object.assign({}, choices), { difficulty: "beginner", duration: 30 });
+    return completeChoices;
 };
 class InitComand extends BaseCommand_1.default {
     async run() {

package/lib/commands/publish.js

@@ -13,6 +13,8 @@ const axios_1 = require("axios");
 const FormData = require("form-data");
 const console_1 = require("../utils/console");
 const file_1 = require("../managers/file");
+const api_1 = require("../utils/api");
+const prompts = require("prompts");
 const RIGOBOT_HOST = "https://rigobot.herokuapp.com";
 // const RIGOBOT_HOST =
 //   "https://8000-charlytoc-rigobot-bmwdeam7cev.ws-us116.gitpod.io"
@@ -37,6 +39,26 @@ const runAudit = () => {
     // Continuar con el proceso de build solo si `learnpack publish` fue exitoso
     console_1.default.info("Learnpack publish completed successfully. Proceeding with build...");
 };
+const selectAcademy = async (academies) => {
+    if (academies.length === 0) {
+        return null;
+    }
+    if (academies.length === 1) {
+        return academies[0];
+    }
+    // prompts the user to  select an academy to upload the assets
+    console_1.default.info("In which academy do you want to publish the asset?");
+    const response = await prompts({
+        type: "select",
+        name: "academy",
+        message: "Select an academy",
+        choices: academies.map((academy) => ({
+            title: academy.name,
+            value: academy,
+        })),
+    });
+    return response.academy;
+};
 class BuildCommand extends SessionCommand_1.default {
     async init() {
         const { flags } = this.parse(BuildCommand);
@@ -48,7 +70,9 @@ class BuildCommand extends SessionCommand_1.default {
         // this.configManager?.clean()
         const configObject = (_a = this.configManager) === null || _a === void 0 ? void 0 : _a.get();
         let sessionPayload = await session_1.default.getPayload();
-        if (!sessionPayload || !sessionPayload.rigobot) {
+        if (!sessionPayload ||
+            !sessionPayload.rigobot ||
+            (sessionPayload.token && !(await api_1.default.validateToken(sessionPayload.token)))) {
             console_1.default.error("You must be logged in to upload a LearnPack package");
             try {
                 sessionPayload = await session_1.default.login();
@@ -67,7 +91,10 @@ class BuildCommand extends SessionCommand_1.default {
             console_1.default.debug("Building exercises");
             (_c = this.configManager) === null || _c === void 0 ? void 0 : _c.buildIndex();
         }
-        // const rigoToken = "417d612d226a1606ad3a4e94b1881a9f0124b667"
+        // const academies = await api.listUserAcademies(sessionPayload.token)
+        // // console.log(academies, "academies")
+        // const academy = await selectAcademy(academies)
+        // console.log(academy, "academy")
         // Read learn.json to get the slug
         const learnJsonPath = path.join(process.cwd(), "learn.json");
         if (!fs.existsSync(learnJsonPath)) {

package/lib/commands/start.js

@@ -82,21 +82,26 @@ class StartCommand extends SessionCommand_1.default {
                 socket_1.default.on("open", (data) => {
                     console_1.default.debug("Opening these files: ", data);
                     const files = (0, misc_1.prioritizeHTMLFile)(data.files);
-                    if (config.editor.agent === "os") {
+                    if (config.editor.agent !== "os") {
+                        // Console.info("Opening files for vscode agent")
                         osOperations_1.eventManager.enqueue(dispatcher.events.OPEN_FILES, files);
                     }
                     else {
-                        dispatcher.enqueue(dispatcher.events.OPEN_FILES, files);
+                        // dispatcher.enqueue(dispatcher.events.OPEN_FILES, files)
+                        console_1.default.debug("Ignoring files for os agent");
                     }
                     socket_1.default.ready("Ready to compile...");
                 });
                 socket_1.default.on("open_window", (data) => {
                     console_1.default.debug("Opening window: ", data);
+                    console.log("config.os", config.os);
                     // cli.open(data.url); This uses XDG under the ground
                     if (config.os !== "linux" || (config.os === "linux" && hasXDG)) {
+                        console.log("Opening window with XDG");
                         osOperations_1.eventManager.enqueue(dispatcher.events.OPEN_WINDOW, data);
                     }
                     else {
+                        console.log("Opening window without XDG");
                         dispatcher.enqueue(dispatcher.events.OPEN_WINDOW, data);
                     }
                     socket_1.default.log("open_window", "", undefined, data.url);
@@ -142,14 +147,6 @@ class StartCommand extends SessionCommand_1.default {
                         telemetry: telemetry_1.default,
                     });
                 });
-                // socket.on("quiz_submission", (data: any) => {
-                //   const { stepPosition, event, eventData } = data
-                //   TelemetryManager.registerStepEvent(stepPosition, event, eventData)
-                // })
-                // socket.on("ai_interaction", (data: any) => {
-                //   const { stepPosition, event, eventData } = data
-                //   TelemetryManager.registerStepEvent(stepPosition, event, eventData)
-                // })
                 socket_1.default.on("telemetry_event", (data) => {
                     const { stepPosition, event, eventData } = data;
                     telemetry_1.default.registerStepEvent(stepPosition, event, eventData);
@@ -222,9 +219,9 @@ class StartCommand extends SessionCommand_1.default {
                 setTimeout(() => dispatcher.enqueue(dispatcher.events.RUNNING), 1000);
                 // start watching for file changes
                 if (StartCommand.flags.watch)
-                    this.configManager.watchIndex(_filename => {
+                    this.configManager.watchIndex((_filename, _fileContent) => {
                         // Instead of reloading with socket.reload(), I just notify the frontend for the file change
-                        socket_1.default.emit("file_change", "ready", _filename);
+                        socket_1.default.emit("file_change", "ready", [_filename, _fileContent]);
                     });
             }
         }