@learnpack/learnpack 5.0.28 → 5.0.30

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/5.0.28 win32-x64 node-v20.16.0
+@learnpack/learnpack/5.0.30 win32-x64 node-v20.16.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -76,7 +76,7 @@ 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.28/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.30/src\commands\audit.ts)_
 
 ## `learnpack breakToken`
 
@@ -91,7 +91,7 @@ OPTIONS
   -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.28/src\commands\breakToken.ts)_
+_See code: [src\commands\breakToken.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.30/src\commands\breakToken.ts)_
 
 ## `learnpack clean`
 
@@ -106,7 +106,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.28/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.30/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -124,7 +124,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.28/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.30/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -156,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.28/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.30/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -174,7 +174,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.28/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.30/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -192,7 +192,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.28/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.30/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -323,7 +323,7 @@ OPTIONS
   -h, --help  show CLI help
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.28/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.30/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -345,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.28/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.30/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -362,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.28/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.30/src\commands\test.ts)_
 
 ## `learnpack translate`
 
@@ -376,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.28/src\commands\translate.ts)_
+_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.30/src\commands\translate.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/breakToken.js

@@ -2,12 +2,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const command_1 = require("@oclif/command");
 const BaseCommand_1 = require("../utils/BaseCommand");
-const session_1 = require("../managers/session");
+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 session_1.default.breakToken();
-        process.exit(0);
+        // 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";

package/lib/commands/init.js

@@ -15,12 +15,18 @@ const rigoActions_1 = require("../utils/rigoActions");
 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 += `
@@ -41,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}`);
@@ -56,13 +65,43 @@ 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();
@@ -90,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");
@@ -126,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,
@@ -140,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)];
     }
@@ -173,7 +227,7 @@ const getChoices = async (empty) => {
         title: "My Interactive Tutorial",
         description: "",
         difficulty: "beginner",
-        duration: 1,
+        duration: 5,
         useAI: "no",
         grading: "isolated",
     };
@@ -209,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",
@@ -246,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/logout.js

@@ -1,27 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// import  {Command, flags} from '@oclif/command'
-// import { prompt } from "enquirer"
-// import fetch from 'node-fetch'
 const SessionCommand_1 = require("../utils/SessionCommand");
 const session_1 = require("../managers/session");
-// import Console from '../utils/console'
-// import { replace } from 'node-emoji'
-// import { validURL } from "../utils/validators"
-// const BaseCommand from '../utils/BaseCommand');
+const console_1 = require("../utils/console");
 class LogoutCommand extends SessionCommand_1.default {
     async init() {
         const { flags } = this.parse(LogoutCommand);
-        await this.initSession(flags);
+        // await this.initSession(flags)
+        console_1.default.debug("Logout command");
     }
     async run() {
         // const {flags, args} = this.parse(LogoutCommand)
         session_1.default.destroy();
     }
 }
-LogoutCommand.description = `Describe the command here
-  ...
-  Extra documentation goes here
+LogoutCommand.description = `Describe the command here
+  ...
+  Extra documentation goes here
   `;
 LogoutCommand.flags = {
 // name: flags.string({char: 'n', description: 'name to print'}),

package/lib/commands/publish.js

@@ -92,7 +92,7 @@ class BuildCommand extends SessionCommand_1.default {
             (_c = this.configManager) === null || _c === void 0 ? void 0 : _c.buildIndex();
         }
         // const academies = await api.listUserAcademies(sessionPayload.token)
-        // console.log(academies, "academies")
+        // // console.log(academies, "academies")
         // const academy = await selectAcademy(academies)
         // console.log(academy, "academy")
         // Read learn.json to get the slug

package/lib/commands/start.js

@@ -82,11 +82,13 @@ 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...");
                 });
@@ -142,14 +144,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 +216,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]);
                     });
             }
         }

package/lib/managers/config/index.js

@@ -372,6 +372,31 @@ exports.default = async ({ grading, mode, disableGrading, version, }) => {
                     [(0, exercise_1.exercise)(((_b = configObj === null || configObj === void 0 ? void 0 : configObj.config) === null || _b === void 0 ? void 0 : _b.exercisesPath) || "", 0, configObj)];
             this.save();
         },
+        createExercise: (slug, content, language) => {
+            var _a;
+            try {
+                const dirPath = `${(_a = configObj.config) === null || _a === void 0 ? void 0 : _a.exercisesPath}/${slug}`;
+                if (!fs.existsSync(dirPath))
+                    fs.mkdirSync(dirPath, { recursive: true });
+                const isEnglish = language === "us" || language === "en";
+                const fileName = isEnglish ? "README.md" : `README.${language}.md`;
+                fs.writeFileSync(`${dirPath}/${fileName}`, content);
+                return true;
+            }
+            catch (error) {
+                console_1.default.error("Error creating exercise: ", error);
+                return false;
+            }
+        },
+        deleteExercise: (slug) => {
+            var _a;
+            const dirPath = `${(_a = configObj.config) === null || _a === void 0 ? void 0 : _a.exercisesPath}/${slug}`;
+            if (fs.existsSync(dirPath)) {
+                fs.rmSync(dirPath, { recursive: true, force: true });
+                return true;
+            }
+            return false;
+        },
         watchIndex: function (onChange) {
             var _a;
             if (configObj.config && !configObj.config.exercisesPath)

package/lib/managers/file.js

@@ -92,7 +92,7 @@ const download = (url, dest) => {
                 });
                 file.on("error", err => {
                     file.close();
-                    if (err.code === "EEXIST") {
+                    if (err.name === "EEXIST") {
                         console_1.default.debug("File already exists");
                         resolve("File already exists");
                     }

package/lib/managers/server/routes.js

@@ -11,7 +11,6 @@ const fileQueue_1 = require("../../utils/fileQueue");
 const exercise_1 = require("../config/exercise");
 const session_1 = require("../../managers/session");
 const telemetry_1 = require("../telemetry");
-const osOperations_1 = require("../../utils/osOperations");
 const withHandler = (func) => (req, res) => {
     try {
         func(req, res);
@@ -200,10 +199,7 @@ async function default_1(app, configObject, configManager) {
         if (exercise.position) {
             telemetry_1.default.registerStepEvent(exercise.position, "open_step", {});
         }
-        if (((_a = configObject.config) === null || _a === void 0 ? void 0 : _a.editor.agent) === "os") {
-            osOperations_1.eventManager.enqueue(dispatcher.events.START_EXERCISE, exercise);
-        }
-        else {
+        if (((_a = configObject.config) === null || _a === void 0 ? void 0 : _a.editor.agent) !== "os") {
             dispatcher.enqueue(dispatcher.events.START_EXERCISE, req.params.slug);
         }
         const entries = new Set(Object.keys(config === null || config === void 0 ? void 0 : config.entries).map(lang => config === null || config === void 0 ? void 0 : config.entries[lang]));
@@ -269,6 +265,36 @@ async function default_1(app, configObject, configManager) {
             res.end();
         }
     }));
+    app.delete("/exercise/:slug/delete", withHandler(async (req, res) => {
+        const exerciseDeleted = configManager.deleteExercise(req.params.slug);
+        if (exerciseDeleted) {
+            configManager.buildIndex();
+            res.json({ status: "ok" });
+        }
+        else {
+            res.status(500).json({ error: "Failed to delete exercise" });
+        }
+    }));
+    app.post("/exercise/:slug/create", jsonBodyParser, withHandler(async (req, res) => {
+        const { title, readme, language } = req.body;
+        const { slug } = req.params;
+        if (!title || !readme || !language) {
+            return res.status(400).json({ error: "Missing required fields" });
+        }
+        try {
+            const exerciseCreated = await configManager.createExercise(slug, readme, language);
+            if (exerciseCreated) {
+                configManager.buildIndex();
+                res.json({ status: "ok" });
+            }
+            else {
+                res.status(500).json({ error: "Failed to create exercise" });
+            }
+        }
+        catch (_a) {
+            res.status(500).json({ error: "Failed to create exercise" });
+        }
+    }));
     const textBodyParser = bodyParser.text();
     app.put("/exercise/:slug/file/:fileName", textBodyParser, withHandler((req, res) => {
         const exercise = configManager.getExercise(req.params.slug);

package/lib/managers/session.js

@@ -134,6 +134,9 @@ const Session = {
         }
     },
     destroy: async function () {
+        if (!this.sessionStarted) {
+            await this.initialize();
+        }
         await storage.clear();
         this.token = null;
         console_1.default.success("You have logged out");

package/lib/models/config-manager.d.ts

@@ -13,6 +13,8 @@ export interface IConfigManager {
     getExercise: (slug: string | undefined) => IExercise;
     startExercise: (slug: string) => IExercise;
     reset: (slug: string) => void;
+    createExercise: (slug: string, content: string, language: string) => boolean;
+    deleteExercise: (slug: string) => boolean;
     buildIndex: () => boolean | void;
     watchIndex: (onChange: (...args: Array<any>) => void) => void;
     save: () => void;

package/lib/utils/creatorUtilities.d.ts

@@ -14,9 +14,11 @@ export type PackageInfo = {
         us: string;
     };
 };
-export declare function checkReadingTime(markdown: string, wordsPerMinute?: number): {
+export declare function checkReadingTime(markdown: string, wordsPerMinute?: number, maxMinutes?: number): {
     newMarkdown: string;
     exceedsThreshold: boolean;
+    minutes: number;
+    body: string;
 };
 export declare const getExInfo: (title: string) => {
     exNumber: string;
@@ -31,7 +33,7 @@ export declare function extractImagesFromMarkdown(markdown: string): {
 export declare function getFilenameFromUrl(url: string): string;
 export declare const makePackageInfo: (choices: any) => {
     grading: any;
-    difficulty: any;
+    difficulty: string;
     duration: number;
     description: {
         us: any;
@@ -41,4 +43,7 @@ export declare const makePackageInfo: (choices: any) => {
     };
     slug: any;
 };
+export declare function estimateDuration(listOfSteps: string[]): number;
+export declare function createFileOnDesktop(): Promise<void>;
+export declare function getContentIndex(): string;
 export {};