@learnpack/learnpack 4.0.14 → 4.0.16

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/4.0.14 win32-x64 node-v20.16.0
+@learnpack/learnpack/4.0.16 win32-x64 node-v20.16.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -74,7 +74,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/v4.0.14/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.16/src\commands\audit.ts)_
 
 ## `learnpack clean`
 
@@ -89,7 +89,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.14/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.16/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -107,7 +107,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.14/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.16/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -138,7 +138,7 @@ OPTIONS
   -h, --grading  show CLI help
 ```
 
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.14/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.16/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -156,7 +156,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.14/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.16/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -174,7 +174,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.14/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.16/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -305,7 +305,7 @@ OPTIONS
   -h, --help  show CLI help
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.14/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.16/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -326,7 +326,7 @@ OPTIONS
   -w, --watch                         Watch for file changes
 ```
 
-_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.14/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.16/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -340,7 +340,7 @@ ARGUMENTS
   EXERCISESLUG  The name of the exercise to test
 ```
 
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.14/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.16/src\commands\test.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/managers/server/routes.js

@@ -77,15 +77,11 @@ async function default_1(app, configObject, configManager) {
     }));
     app.post("/set-tab-hash", jsonBodyParser, withHandler(async (req, res) => {
         const hash = req.body.hash;
-        // Ensure token is provided in the request body
-        console_1.default.error("TRYINH YO SET TAB HASH IN CLI");
-        console_1.default.success(hash);
         if (!hash) {
             return res.status(400).json({ error: "Token is required" });
         }
         try {
             const hashSaved = await session_1.default.setTabHash(hash);
-            // Check if the token was saved successfully
             if (hashSaved) {
                 res.json({ status: "ok" });
             }
@@ -94,7 +90,43 @@ async function default_1(app, configObject, configManager) {
             }
         }
         catch (_a) {
-            // Handle any unexpected errors during the process
+            res.status(500).json({ error: "Internal server error" });
+        }
+    }));
+    app.post("/set-session-key", jsonBodyParser, withHandler(async (req, res) => {
+        const sessionKey = req.body.sessionKey;
+        if (!sessionKey) {
+            return res.status(400).json({ error: "Token is required" });
+        }
+        try {
+            const sessionSaved = await session_1.default.setSessionKey(sessionKey);
+            if (sessionSaved) {
+                res.json({ status: "ok" });
+            }
+            else {
+                res.status(500).json({ error: "Failed to save the token" });
+            }
+        }
+        catch (_a) {
+            res.status(500).json({ error: "Internal server error" });
+        }
+    }));
+    app.post("/set-session", jsonBodyParser, withHandler(async (req, res) => {
+        const payload = req.body.payload;
+        if (!payload) {
+            return res.status(400).json({ error: "Token is required" });
+        }
+        try {
+            const payloadSaved = await session_1.default.setPayload(payload);
+            if (payloadSaved) {
+                res.json({ status: "ok" });
+                socket_1.default.sessionRefreshed(payload);
+            }
+            else {
+                res.status(500).json({ error: "Failed to save the token" });
+            }
+        }
+        catch (_a) {
             res.status(500).json({ error: "Internal server error" });
         }
     }));
@@ -227,15 +259,6 @@ async function default_1(app, configObject, configManager) {
             res.end();
         }
     }));
-    /*
-    app.post(
-      "/exercise/:slug/file/:fileName",
-      withHandler((req: express.Request, res: express.Response) => {
-        get tokens but also, add allowed action for 'generate'
-        use the sessionManager to keep compatibility with the cli login command.
-      })
-    );
-    */
     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

@@ -37,7 +37,14 @@ const Session = {
         await this.initialize();
         const payload = await storage.getItem("bc-payload");
         await storage.setItem("bc-payload", Object.assign(Object.assign({}, payload), { tabHash: hash }));
-        console_1.default.debug("Rigobot token successfuly set");
+        console_1.default.debug("tabHash successfuly set");
+        return true;
+    },
+    setSessionKey: async function (value) {
+        await this.initialize();
+        const payload = await storage.getItem("bc-payload");
+        await storage.setItem("bc-payload", Object.assign(Object.assign({}, payload), { sessionKey: value }));
+        console_1.default.debug("sessionKey successfuly set");
         return true;
     },
     setPayload: async function (value) {

package/lib/managers/socket.js

@@ -103,6 +103,9 @@ const SocketManager = {
             });
         });
     },
+    sessionRefreshed: function (data) {
+        this.emit("session-refreshed", "", [data]);
+    },
     reload: function (files = null, exercises = null) {
         this.emit("reload", (files === null || files === void 0 ? void 0 : files.join("")) || "", exercises);
     },

package/lib/models/action.d.ts

@@ -1,2 +1,2 @@
-export type TAction = "test" | "log" | "reload" | "ready" | "clean" | "ask" | "file_change" | "dialog";
+export type TAction = "test" | "log" | "reload" | "ready" | "clean" | "ask" | "file_change" | "dialog" | "session-refreshed";
 export type ICallback = (...agrs: any[]) => any;

package/lib/models/session.d.ts

@@ -19,6 +19,7 @@ export interface ISession {
     initialize: () => Promise<boolean>;
     setRigoToken: (token: string) => Promise<boolean>;
     setTabHash: (hash: string) => Promise<boolean>;
+    setSessionKey: (value: string) => Promise<boolean>;
     setPayload: (value: IPayload) => Promise<boolean>;
     getPayload: () => Promise<any>;
     isActive: () => boolean;

package/lib/models/socket.d.ts

@@ -20,6 +20,7 @@ export interface ISocket {
     clean: (_: string, logs: Array<any>) => void;
     complete: () => void;
     ask: (questions: Array<string>) => void;
+    sessionRefreshed: (data: any) => void;
     reload: (files: Array<string> | null, exercises: Array<string>) => void;
     openWindow: (id: string) => void;
     log: (status: TStatus, messages?: string | Array<string>, report?: Array<string>, data?: any) => void;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"4.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}]}}}
+{"version":"4.0.16","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}]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@learnpack/learnpack",
   "description": "Create, sell or download and take learning amazing learning packages",
-  "version": "4.0.14",
+  "version": "4.0.16",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {

package/src/managers/server/routes.ts

@@ -110,28 +110,66 @@ export default async function (
     jsonBodyParser,
     withHandler(async (req: express.Request, res: express.Response) => {
       const hash = req.body.hash
-      // Ensure token is provided in the request body
-
-      Console.error("TRYINH YO SET TAB HASH IN CLI")
-      Console.success(hash)
       if (!hash) {
         return res.status(400).json({ error: "Token is required" })
       }
 
       try {
         const hashSaved = await SessionManager.setTabHash(hash)
-        // Check if the token was saved successfully
         if (hashSaved) {
           res.json({ status: "ok" })
         } else {
           res.status(500).json({ error: "Failed to save the token" })
         }
       } catch {
-        // Handle any unexpected errors during the process
         res.status(500).json({ error: "Internal server error" })
       }
     })
   )
+  app.post(
+    "/set-session-key",
+    jsonBodyParser,
+    withHandler(async (req: express.Request, res: express.Response) => {
+      const sessionKey = req.body.sessionKey
+      if (!sessionKey) {
+        return res.status(400).json({ error: "Token is required" })
+      }
+
+      try {
+        const sessionSaved = await SessionManager.setSessionKey(sessionKey)
+        if (sessionSaved) {
+          res.json({ status: "ok" })
+        } else {
+          res.status(500).json({ error: "Failed to save the token" })
+        }
+      } catch {
+        res.status(500).json({ error: "Internal server error" })
+      }
+    })
+  )
+  app.post(
+    "/set-session",
+    jsonBodyParser,
+    withHandler(async (req: express.Request, res: express.Response) => {
+      const payload = req.body.payload
+      if (!payload) {
+        return res.status(400).json({ error: "Token is required" })
+      }
+
+      try {
+        const payloadSaved = await SessionManager.setPayload(payload)
+        if (payloadSaved) {
+          res.json({ status: "ok" })
+          socket.sessionRefreshed(payload)
+        } else {
+          res.status(500).json({ error: "Failed to save the token" })
+        }
+      } catch {
+        res.status(500).json({ error: "Internal server error" })
+      }
+    })
+  )
+
   app.get(
     "/check/rigo/status",
     withHandler(async (_: express.Request, res: express.Response) => {
@@ -333,16 +371,6 @@ throw new Error("File not found: " + filePath)
     })
   )
 
-  /*
-  app.post(
-    "/exercise/:slug/file/:fileName",
-    withHandler((req: express.Request, res: express.Response) => {
-      get tokens but also, add allowed action for 'generate'
-      use the sessionManager to keep compatibility with the cli login command.
-    })
-  );
-  */
-
   const textBodyParser = bodyParser.text()
   app.put(
     "/exercise/:slug/file/:fileName",

package/src/managers/session.ts

@@ -51,7 +51,17 @@ const Session: ISession = {
       ...payload,
       tabHash: hash,
     })
-    Console.debug("Rigobot token successfuly set")
+    Console.debug("tabHash successfuly set")
+    return true
+  },
+  setSessionKey: async function (value: string) {
+    await this.initialize()
+    const payload = await storage.getItem("bc-payload")
+    await storage.setItem("bc-payload", {
+      ...payload,
+      sessionKey: value,
+    })
+    Console.debug("sessionKey successfuly set")
     return true
   },
   setPayload: async function (value: IPayload) {

package/src/managers/socket.ts

@@ -140,6 +140,10 @@ actions = [actions]
       })
     })
   },
+  sessionRefreshed: function (data) {
+    this.emit("session-refreshed", "", [data])
+  },
+
   reload: function (
     files: Array<string> | null = null,
     exercises: Array<string> | null = null

package/src/models/action.ts

@@ -6,6 +6,7 @@ export type TAction =
   | "clean"
   | "ask"
   | "file_change"
-  | "dialog";
+  | "dialog"
+  | "session-refreshed"
 
-export type ICallback = (...agrs: any[]) => any;
+export type ICallback = (...agrs: any[]) => any

package/src/models/session.ts

@@ -23,6 +23,7 @@ export interface ISession {
   initialize: () => Promise<boolean>
   setRigoToken: (token: string) => Promise<boolean>
   setTabHash: (hash: string) => Promise<boolean>
+  setSessionKey: (value: string) => Promise<boolean>
   setPayload: (value: IPayload) => Promise<boolean>
   getPayload: () => Promise<any>
   isActive: () => boolean

package/src/models/socket.ts

@@ -9,7 +9,7 @@ export type TPossibleActions =
   | "test"
   | "reset"
   | "tutorial"
-  | "generate";
+  | "generate"
 
 export interface ISocket {
   socket: Server<
@@ -17,27 +17,28 @@ export interface ISocket {
     DefaultEventsMap,
     DefaultEventsMap,
     any
-  > | null;
-  config: IConfig | null;
-  allowedActions: Array<TPossibleActions>;
-  actionCallBacks: { [key: string]: ICallback };
-  possibleActions: Array<TPossibleActions>;
-  isTestingEnvironment: boolean;
-  addAllowed: (actions: any) => void;
-  removeAllowed: (actions: any) => void;
-  start: (config: IConfig, server: any, isTestingEnvironment: boolean) => void;
-  on: (action: any, callBack: any) => void;
-  clean: (_: string, logs: Array<any>) => void;
-  complete: () => void;
-  ask: (questions: Array<string>) => void;
-  reload: (files: Array<string> | null, exercises: Array<string>) => void;
-  openWindow: (id: string) => void;
+  > | null
+  config: IConfig | null
+  allowedActions: Array<TPossibleActions>
+  actionCallBacks: { [key: string]: ICallback }
+  possibleActions: Array<TPossibleActions>
+  isTestingEnvironment: boolean
+  addAllowed: (actions: any) => void
+  removeAllowed: (actions: any) => void
+  start: (config: IConfig, server: any, isTestingEnvironment: boolean) => void
+  on: (action: any, callBack: any) => void
+  clean: (_: string, logs: Array<any>) => void
+  complete: () => void
+  ask: (questions: Array<string>) => void
+  sessionRefreshed: (data: any) => void
+  reload: (files: Array<string> | null, exercises: Array<string>) => void
+  openWindow: (id: string) => void
   log: (
     status: TStatus,
     messages?: string | Array<string>,
     report?: Array<string>,
     data?: any
-  ) => void;
+  ) => void
   emit: (
     action: TAction,
     status: TStatus | string,
@@ -45,16 +46,16 @@ export interface ISocket {
     inputs?: Array<string>,
     report?: Array<string>,
     data?: any
-  ) => void;
-  ready: (message: string) => void;
-  error: (type: any, stdout: string) => void;
-  fatal: (msg: string) => void;
-  dialog: (message: string) => void;
-  success: (type: any, stdout: string) => void;
-  onTestingFinished: (obj: any) => void;
+  ) => void
+  ready: (message: string) => void
+  error: (type: any, stdout: string) => void
+  fatal: (msg: string) => void
+  dialog: (message: string) => void
+  success: (type: any, stdout: string) => void
+  onTestingFinished: (obj: any) => void
 }
 
 export type TOpenWindowData = {
-  url: string;
-  exerciseSlug: string;
-};
+  url: string
+  exerciseSlug: string
+}