@learnpack/learnpack 5.0.12 → 5.0.14

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/5.0.12 win32-x64 node-v20.16.0
+@learnpack/learnpack/5.0.14 win32-x64 node-v20.16.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -75,7 +75,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.12/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.14/src\commands\audit.ts)_
 
 ## `learnpack clean`
 
@@ -90,7 +90,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.12/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.14/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -108,7 +108,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.12/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.14/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -139,7 +139,7 @@ OPTIONS
   -h, --grading  show CLI help
 ```
 
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.12/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.14/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -157,7 +157,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.12/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.14/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -175,7 +175,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.12/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.14/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -306,7 +306,7 @@ OPTIONS
   -h, --help  show CLI help
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.12/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.14/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -327,7 +327,7 @@ OPTIONS
   -w, --watch                         Watch for file changes
 ```
 
-_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.12/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.14/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -341,7 +341,7 @@ ARGUMENTS
   EXERCISESLUG  The name of the exercise to test
 ```
 
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.12/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.14/src\commands\test.ts)_
 
 ## `learnpack translate`
 
@@ -352,7 +352,7 @@ USAGE
   $ learnpack translate
 ```
 
-_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.12/src\commands\translate.ts)_
+_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.14/src\commands\translate.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/start.js

@@ -68,8 +68,8 @@ class StartCommand extends SessionCommand_1.default {
                         ai_interactions: [],
                         compilations: [],
                         tests: [],
-                        is_testeable: e.graded || false,
                         quiz_submissions: [],
+                        is_testeable: e.graded || false,
                     }));
                     if (path && steps.length > 0) {
                         telemetry_1.default.start(agent, steps, path, tutorialSlug);
@@ -142,11 +142,15 @@ class StartCommand extends SessionCommand_1.default {
                         telemetry: telemetry_1.default,
                     });
                 });
-                socket_1.default.on("quiz_submission", (data) => {
-                    const { stepPosition, event, eventData } = data;
-                    telemetry_1.default.registerStepEvent(stepPosition, event, eventData);
-                });
-                socket_1.default.on("ai_interaction", (data) => {
+                // 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);
                 });

package/lib/managers/server/routes.js

@@ -130,6 +130,11 @@ async function default_1(app, configObject, configManager) {
             res.status(500).json({ error: "Internal server error" });
         }
     }));
+    app.get("/telemetry/step/:stepPosition", (req, res) => {
+        const stepPosition = parseInt(req.params.stepPosition);
+        const step = telemetry_1.default.getStep(stepPosition);
+        res.json(step);
+    });
     app.get("/check/rigo/status", withHandler(async (_, res) => {
         const payload = await session_1.default.getPayload();
         if (payload && payload.rigobot && payload.rigobot.key) {

package/lib/managers/telemetry.d.ts

@@ -61,7 +61,7 @@ export interface ITelemetryJSONSchema {
     steps: Array<TStep>;
     workout_session: TWorkoutSession[];
 }
-type TStepEvent = "compile" | "test" | "ai_interaction" | "open_step" | "quiz_submission";
+export type TStepEvent = "compile" | "test" | "ai_interaction" | "open_step" | "quiz_submission";
 export type TTelemetryUrls = {
     streaming?: string;
     batch?: string;
@@ -87,6 +87,7 @@ interface ITelemetryManager {
     setStudent: (student: TStudent) => void;
     save: () => void;
     retrieve: () => Promise<ITelemetryJSONSchema | null>;
+    getStep: (stepPosition: number) => TStep | null;
 }
 declare const TelemetryManager: ITelemetryManager;
 export default TelemetryManager;

package/lib/managers/telemetry.js

@@ -198,6 +198,10 @@ const TelemetryManager = {
             });
         });
     },
+    getStep: function (stepPosition) {
+        var _a;
+        return ((_a = this.current) === null || _a === void 0 ? void 0 : _a.steps[stepPosition]) || null;
+    },
     submit: async function () {
         console_1.default.debug("Submitting telemetry...");
         if (!this.current) {

package/lib/utils/checkNotInstalled.js

@@ -160,6 +160,7 @@ const checkNotInstalledDependencies = async (neededPlugins) => {
         await installDependencies(jsPluginsDependencies, "npm");
     }
     if (pytestNeeded) {
+        await exec("python.exe -m pip install --upgrade pip");
         const { stdout, stderr } = await exec("pip list");
         if (stderr) {
             console_1.default.error(`Error executing pip list. Use debug for more info`);

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"5.0.12","commands":{"audit":{"id":"audit","description":"learnpack audit is the command in charge of creating an auditory of the repository\n...\nlearnpack audit checks for the following information in a repository:\n    1. The configuration object has slug, repository and description. (Error)\n    2. The command learnpack clean has been run. (Error)\n    3. If a markdown or test file doesn't have any content. (Error)\n    4. The links are accessing to valid servers. (Error)\n    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)\n    6. The external images are working (If they are pointing to a valid server). (Error)\n    7. The exercises directory names are valid. (Error)\n    8. If an exercise doesn't have a README file. (Error)\n    9. The exercises array (Of the config file) has content. (Error)\n    10. The exercses have the same translations. (Warning)\n    11. The .gitignore file exists. (Warning)\n    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"clean":{"id":"clean","description":"Clean the configuration object\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"download":{"id":"download","description":"Describe the command here\n...\nExtra documentation goes here\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"init":{"id":"init","description":"Create a new learning package: Book, Tutorial or Exercise","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"logout":{"id":"logout","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"publish":{"id":"publish","description":"Builds the project by copying necessary files and directories into a zip file","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"port":{"name":"port","type":"option","char":"p","description":"server port"},"host":{"name":"host","type":"option","char":"h","description":"server host"},"disableGrading":{"name":"disableGrading","type":"boolean","char":"D","description":"disble grading functionality","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watch for file changes","allowNo":false},"editor":{"name":"editor","type":"option","char":"e","description":"[preview, extension]","options":["extension","preview"]},"version":{"name":"version","type":"option","char":"v","description":"E.g: 1.0.1"},"grading":{"name":"grading","type":"option","char":"g","description":"[isolated, incremental]","options":["isolated","incremental"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"debugger mode for more verbage","allowNo":false}},"args":[]},"test":{"id":"test","description":"Test exercises","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]},"translate":{"id":"translate","description":"List all the lessons, the user is able of select many of them to translate to the given languages","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]}}}
+{"version":"5.0.14","commands":{"audit":{"id":"audit","description":"learnpack audit is the command in charge of creating an auditory of the repository\n...\nlearnpack audit checks for the following information in a repository:\n    1. The configuration object has slug, repository and description. (Error)\n    2. The command learnpack clean has been run. (Error)\n    3. If a markdown or test file doesn't have any content. (Error)\n    4. The links are accessing to valid servers. (Error)\n    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)\n    6. The external images are working (If they are pointing to a valid server). (Error)\n    7. The exercises directory names are valid. (Error)\n    8. If an exercise doesn't have a README file. (Error)\n    9. The exercises array (Of the config file) has content. (Error)\n    10. The exercses have the same translations. (Warning)\n    11. The .gitignore file exists. (Warning)\n    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"clean":{"id":"clean","description":"Clean the configuration object\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"download":{"id":"download","description":"Describe the command here\n...\nExtra documentation goes here\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"init":{"id":"init","description":"Create a new learning package: Book, Tutorial or Exercise","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"logout":{"id":"logout","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"publish":{"id":"publish","description":"Builds the project by copying necessary files and directories into a zip file","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"port":{"name":"port","type":"option","char":"p","description":"server port"},"host":{"name":"host","type":"option","char":"h","description":"server host"},"disableGrading":{"name":"disableGrading","type":"boolean","char":"D","description":"disble grading functionality","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watch for file changes","allowNo":false},"editor":{"name":"editor","type":"option","char":"e","description":"[preview, extension]","options":["extension","preview"]},"version":{"name":"version","type":"option","char":"v","description":"E.g: 1.0.1"},"grading":{"name":"grading","type":"option","char":"g","description":"[isolated, incremental]","options":["isolated","incremental"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"debugger mode for more verbage","allowNo":false}},"args":[]},"test":{"id":"test","description":"Test exercises","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]},"translate":{"id":"translate","description":"List all the lessons, the user is able of select many of them to translate to the given languages","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@learnpack/learnpack",
   "description": "Seamlessly build, sell and/or take interactive & auto-graded tutorials, start learning now or build a new tutorial to your audience.",
-  "version": "5.0.12",
+  "version": "5.0.14",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {

package/src/commands/start.ts

@@ -148,7 +148,7 @@ export default class StartCommand extends SessionCommand {
           const path = configObject.config?.dirPath || ""
           const tutorialSlug = configObject.config?.slug || ""
 
-          const steps = configObject.exercises.map(
+          const steps: TStep[] = configObject.exercises.map(
             (e: IExercise, index): TStep => ({
               slug: e.slug,
               position: e.position || index,
@@ -156,8 +156,8 @@ export default class StartCommand extends SessionCommand {
               ai_interactions: [],
               compilations: [],
               tests: [],
-              is_testeable: e.graded || false,
               quiz_submissions: [],
+              is_testeable: e.graded || false,
             })
           )
           if (path && steps.length > 0) {
@@ -249,13 +249,19 @@ export default class StartCommand extends SessionCommand {
           })
         })
 
-        socket.on("quiz_submission", (data: any) => {
-          const { stepPosition, event, eventData } = data
-          TelemetryManager.registerStepEvent(stepPosition, event, eventData)
-        })
+        // 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.on("ai_interaction", (data: any) => {
+        socket.on("telemetry_event", (data: any) => {
           const { stepPosition, event, eventData } = data
+
           TelemetryManager.registerStepEvent(stepPosition, event, eventData)
         })
 

package/src/managers/server/routes.ts

@@ -170,6 +170,12 @@ export default async function (
     })
   )
 
+  app.get("/telemetry/step/:stepPosition", (req, res) => {
+    const stepPosition = parseInt(req.params.stepPosition)
+    const step = TelemetryManager.getStep(stepPosition)
+    res.json(step)
+  })
+
   app.get(
     "/check/rigo/status",
     withHandler(async (_: express.Request, res: express.Response) => {

package/src/managers/telemetry.ts

@@ -87,7 +87,7 @@ export interface ITelemetryJSONSchema {
   // number and start another session
 }
 
-type TStepEvent =
+export type TStepEvent =
   | "compile"
   | "test"
   | "ai_interaction"
@@ -130,6 +130,7 @@ interface ITelemetryManager {
   setStudent: (student: TStudent) => void
   save: () => void
   retrieve: () => Promise<ITelemetryJSONSchema | null>
+  getStep: (stepPosition: number) => TStep | null
 }
 
 const TelemetryManager: ITelemetryManager = {
@@ -358,6 +359,10 @@ const TelemetryManager: ITelemetryManager = {
     })
   },
 
+  getStep: function (stepPosition: number) {
+    return this.current?.steps[stepPosition] || null
+  },
+
   submit: async function () {
     Console.debug("Submitting telemetry...")
 

package/src/utils/checkNotInstalled.ts

@@ -222,6 +222,8 @@ return true
   }
 
   if (pytestNeeded) {
+    await exec("python.exe -m pip install --upgrade pip")
+
     const { stdout, stderr } = await exec("pip list")
     if (stderr) {
       Console.error(`Error executing pip list. Use debug for more info`)