@learnpack/learnpack 4.0.10 → 4.0.13

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"4.0.10","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":"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}]},"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.13","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.10",
+  "version": "4.0.13",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {
@@ -22,6 +22,9 @@
     "@oclif/plugin-help": "^3.1.0",
     "@oclif/plugin-plugins": "^1.8.0",
     "@oclif/plugin-warn-if-update-available": "^1.7.0",
+    "@types/archiver": "^6.0.2",
+    "archiver": "^7.0.1",
+    "axios": "^1.7.7",
     "body-parser": "^1.19.0",
     "chalk": "^4.1.0",
     "chokidar": "^3.4.0",
@@ -36,7 +39,7 @@
     "front-matter": "^4.0.2",
     "moment": "^2.27.0",
     "node-emoji": "^1.10.0",
-    "node-fetch": "^2.6.0",
+    "node-fetch": "^2.7.0",
     "node-persist": "^3.1.0",
     "prompts": "^2.3.2",
     "shelljs": "^0.8.4",
@@ -56,7 +59,6 @@
     "@types/mocha": "^5",
     "@types/mock-fs": "^4.13.1",
     "@types/node": "^10.17.60",
-    "@types/node-fetch": "^3.0.3",
     "@types/node-persist": "^3.1.2",
     "@types/prompts": "^2.0.14",
     "@types/shelljs": "^0.8.9",
@@ -82,7 +84,7 @@
     "pre-commit": "^1.2.2",
     "prettier": "^2.4.1",
     "ts-node": "^8",
-    "typescript": "4.0"
+    "typescript": "^5.6.2"
   },
   "engines": {
     "node": ">=14.0.0"

package/src/commands/publish.ts

@@ -1,107 +1,181 @@
-import { prompt } from "enquirer"
-import SessionCommand from "../utils/SessionCommand"
-import Console from "../utils/console"
-import api from "../utils/api"
-import { validURL } from "../utils/validators"
-
-// eslint-disable-next-line
-const fetch = require("node-fetch");
-
-class PublishCommand extends SessionCommand {
-  static description = `Describe the command here
-  ...
-  Extra documentation goes here
-  `
-
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  }
-
-  static args = [
-    {
-      name: "package", // name of arg to show in help and reference with args[name]
-      required: false, // make the arg required with `required: true`
-      description:
-        "The unique string that identifies this package on learnpack", // help description
-      hidden: false, // hide this arg from help
-    },
-  ]
-
-  async init() {
-    const { flags } = this.parse(PublishCommand)
-    await this.initSession(flags, true)
-  }
-
-  async run() {
-    const { flags, args } = this.parse(PublishCommand)
-
-    // avoid annonymus sessions
-    // eslint-disable-next-line
-    if (!this.session) return;
-
-    Console.info(
-      `Session found for ${this.session.payload.email}, publishing the package...`
-    )
-
-    const configObject = this.configManager?.get()
-    if (
-      configObject?.config?.slug === undefined ||
-      !configObject.config?.slug
-    ) {
-      throw new Error(
-        "The package is missing a slug (unique name identifier), please check your learn.json file and make sure it has a 'slug'"
-      )
-    }
-
-    if (!validURL(configObject?.config?.repository ?? "")) {
-      throw new Error(
-        "The package has a missing or invalid 'repository' on the configuration file, it needs to be a Github URL"
-      )
-    } else {
-      const validateResp = await fetch(configObject.config?.repository, {
-        method: "HEAD",
-      })
-      if (!validateResp.ok || validateResp.status !== 200) {
-        throw new Error(
-          `The specified repository URL on the configuration file does not exist or its private, only public repositories are allowed at the moment: ${configObject.config?.repository}`
-        )
-      }
-    }
-
-    // start watching for file changes
-    try {
-      await api.publish({
-        ...configObject,
-        author: this.session.payload.user_id,
-      })
-      Console.success(
-        `Package updated and published successfully: ${configObject.config?.slug}`
-      )
-    } catch (error) {
-      if ((error as any).status === 404) {
-        const answer = await prompt([
-          {
-            type: "confirm",
-            name: "create",
-            message: `Package with slug ${configObject.config?.slug} does not exist, do you want to create it?`,
-          },
-        ])
-        if (answer) {
-          await api.update({
-            ...configObject,
-            author: this.session.payload.user_id,
-          })
-          Console.success(
-            `Package created and published successfully: ${configObject.config?.slug}`
-          )
-        } else {
-          Console.error("No answer from server")
-        }
-      } else {
-        Console.error((error as TypeError).message)
-      }
-    }
-  }
-}
-
-export default PublishCommand
+/* eslint-disable arrow-parens */
+/* eslint-disable unicorn/no-array-for-each */
+import { flags } from "@oclif/command"
+import SessionCommand from "../utils/SessionCommand"
+import SessionManager from "../managers/session"
+import * as fs from "fs"
+import * as path from "path"
+import * as archiver from "archiver"
+import axios from "axios"
+import FormData = require("form-data")
+import Console from "../utils/console"
+
+// const RIGOBOT_HOST = "https://rigobot-test-cca7d841c9d8.herokuapp.com"
+const RIGOBOT_HOST =
+  // "https://8000-charlytoc-rigobot-bmwdeam7cev.ws-us116.gitpod.io"
+  "https://rigobot.herokuapp.com"
+const uploadZipEndpont = RIGOBOT_HOST + "/v1/learnpack/upload"
+
+export default class BuildCommand extends SessionCommand {
+  static description =
+    "Builds the project by copying necessary files and directories into a zip file"
+
+  static flags = {
+    help: flags.help({ char: "h" }),
+  }
+
+  async init() {
+    const { flags } = this.parse(BuildCommand)
+    await this.initSession(flags)
+  }
+
+  async run() {
+    const buildDir = path.join(process.cwd(), "build")
+    const sessionPayload = await SessionManager.getPayload()
+    if (!sessionPayload || !sessionPayload.rigobot) {
+      Console.error(
+        "You must be logged in to upload a LearnPack packge, please run: \n$ learnpack login"
+      )
+      return
+    }
+
+    const rigoToken = sessionPayload.rigobot.key
+    // const rigoToken = "417d612d226a1606ad3a4e94b1881a9f0124b667"
+
+    // Read learn.json to get the slug
+    const learnJsonPath = path.join(process.cwd(), "learn.json")
+    if (!fs.existsSync(learnJsonPath)) {
+      this.error("learn.json not found")
+    }
+
+    const learnJson = JSON.parse(fs.readFileSync(learnJsonPath, "utf-8"))
+
+    const zipFilePath = path.join(process.cwd(), `${learnJson.slug}.zip`)
+
+    // Ensure build directory exists
+    if (!fs.existsSync(buildDir)) {
+      fs.mkdirSync(buildDir)
+    }
+
+    // Copy config.json
+    const configPath = path.join(process.cwd(), ".learn", "config.json")
+    if (fs.existsSync(configPath)) {
+      fs.copyFileSync(configPath, path.join(buildDir, "config.json"))
+    } else {
+      this.error("config.json not found")
+    }
+
+    // Copy .learn/assets directory
+    const assetsDir = path.join(process.cwd(), ".learn", "assets")
+    if (fs.existsSync(assetsDir)) {
+      this.copyDirectory(assetsDir, path.join(buildDir, ".learn", "assets"))
+    } else {
+      this.error(".learn/assets directory not found")
+    }
+
+    // Copy .learn/_app directory files to the same level as config.json
+    const appDir = path.join(process.cwd(), ".learn", "_app")
+    if (fs.existsSync(appDir)) {
+      this.copyDirectory(appDir, buildDir)
+    } else {
+      this.error(".learn/_app directory not found")
+    }
+
+    // Copy exercises directory
+    const exercisesDir = path.join(process.cwd(), "exercises")
+    const learnExercisesDir = path.join(process.cwd(), ".learn", "exercises")
+
+    if (fs.existsSync(exercisesDir)) {
+      this.copyDirectory(exercisesDir, path.join(buildDir, "exercises"))
+    } else if (fs.existsSync(learnExercisesDir)) {
+      this.copyDirectory(learnExercisesDir, path.join(buildDir, "exercises"))
+    } else {
+      this.error("exercises directory not found in either location")
+    }
+
+    // Copy learn.json
+    fs.copyFileSync(learnJsonPath, path.join(buildDir, "learn.json"))
+
+    // Create zip file
+    const output = fs.createWriteStream(zipFilePath)
+    const archive = archiver("zip", {
+      zlib: { level: 9 },
+    })
+
+    output.on("close", async () => {
+      this.log(
+        `Build completed: ${zipFilePath} (${archive.pointer()} total bytes)`
+      )
+      // Remove build directory after zip is created
+      this.removeDirectory(buildDir)
+      console.log("Zip file saved in project root")
+
+      const formData = new FormData()
+      formData.append("file", fs.createReadStream(zipFilePath))
+      formData.append("config", JSON.stringify(learnJson))
+
+      try {
+        const res = await axios.post(uploadZipEndpont, formData, {
+          headers: {
+            ...formData.getHeaders(),
+            Authorization: `Token ${rigoToken}`,
+          },
+        })
+        console.log(res.data)
+      } catch (error) {
+        if (axios.isAxiosError(error)) {
+          if (error.response && error.response.status === 403) {
+            console.error("Error 403:", error.response.data.error)
+          } else if (error.response && error.response.status === 400) {
+            console.error(error.response.data.error)
+          } else {
+            console.error("Error uploading file:", error.message)
+          }
+        } else {
+          console.error("Error uploading file:", error)
+        }
+      }
+    })
+
+    archive.on("error", (err: any) => {
+      throw err
+    })
+
+    archive.pipe(output)
+    archive.directory(buildDir, false)
+    await archive.finalize()
+  }
+
+  copyDirectory(src: string, dest: string) {
+    if (!fs.existsSync(dest)) {
+      fs.mkdirSync(dest, { recursive: true })
+    }
+
+    const entries = fs.readdirSync(src, { withFileTypes: true })
+
+    for (const entry of entries) {
+      const srcPath = path.join(src, entry.name)
+      const destPath = path.join(dest, entry.name)
+
+      if (entry.isDirectory()) {
+        this.copyDirectory(srcPath, destPath)
+      } else {
+        fs.copyFileSync(srcPath, destPath)
+      }
+    }
+  }
+
+  removeDirectory(dir: string) {
+    if (fs.existsSync(dir)) {
+      fs.readdirSync(dir).forEach((file) => {
+        const currentPath = path.join(dir, file)
+        if (fs.lstatSync(currentPath).isDirectory()) {
+          this.removeDirectory(currentPath)
+        } else {
+          fs.unlinkSync(currentPath)
+        }
+      })
+      fs.rmdirSync(dir)
+    }
+  }
+}

package/src/managers/config/index.ts

@@ -367,6 +367,11 @@ return true
       Console.log(result.stdout)
       throw InternalError(`Error installing ${language} exercise engine`)
     },
+    logout: () => {
+      if (configObj.config) {
+        rmSync(configObj.config.dirPath + "/.session")
+      }
+    },
     clean: () => {
       if (configObj.config) {
         if (configObj.config.outputPath) {

package/src/managers/server/routes.ts

@@ -71,6 +71,16 @@ export default async function (
       res.json(payload)
     })
   )
+
+  app.post(
+    "/logout",
+    jsonBodyParser,
+    withHandler(async (req: express.Request, res: express.Response) => {
+      SessionManager.destroy()
+      res.json({ message: "You've logged out from Breathecode and Rigobot" })
+    })
+  )
+
   app.post(
     "/set-rigobot-token",
     jsonBodyParser,