@learnpack/learnpack 5.0.27 → 5.0.29

package/src/commands/init.ts

@@ -19,8 +19,9 @@ import {
   createCodeFile,
   readmeCreator,
   createPreviewReadme,
+  reduceReadme,
 } from "../utils/rigoActions"
-import { getConsumables } from "../utils/api"
+import { getConsumable } from "../utils/api"
 import {
   checkReadingTime,
   PackageInfo,
@@ -28,9 +29,18 @@ import {
   extractImagesFromMarkdown,
   getFilenameFromUrl,
   makePackageInfo,
+  estimateDuration,
+  getContentIndex,
+  createFileOnDesktop,
 } from "../utils/creatorUtilities"
 import SessionManager from "../managers/session"
 
+const durationByKind: Record<string, number> = {
+  code: 3,
+  quiz: 2,
+  read: 1,
+}
+
 const initializeInteractiveCreation = async (
   rigoToken: string,
   courseInfo: string
@@ -39,12 +49,16 @@ const initializeInteractiveCreation = async (
   title: string
   description: string
   interactions: string
+  difficulty: string
+  duration: number
 }> => {
   let prevInteractions = ""
   let isReady = false
   let currentSteps = []
   let currentTitle = ""
   let currentDescription = ""
+  let currentDifficulty = ""
+
   while (!isReady) {
     let wholeInfo = courseInfo
     wholeInfo += `
@@ -69,6 +83,10 @@ const initializeInteractiveCreation = async (
       currentDescription = res.parsed.description
     }
 
+    if (res.parsed.difficulty && currentDifficulty !== res.parsed.difficulty) {
+      currentDifficulty = res.parsed.difficulty
+    }
+
     if (!isReady) {
       console.log(currentSteps)
       Console.info(`AI: ${res.parsed.aiMessage}`)
@@ -85,12 +103,47 @@ const initializeInteractiveCreation = async (
     }
   }
 
+  const duration = 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 createFileOnDesktop()
+    Console.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.error("Please make the necessary changes and try again.")
+      process.exit(1)
+    }
+
+    const contentIndex = getContentIndex()
+    return contentIndex
   }
+
+  return null
 }
 
 const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
@@ -98,7 +151,11 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
 
   let sessionPayload = await SessionManager.getPayload()
 
-  if (!sessionPayload || !sessionPayload.rigobot) {
+  if (
+    !sessionPayload ||
+    !sessionPayload.rigobot ||
+    (sessionPayload.token && !(await api.validateToken(sessionPayload.token)))
+  ) {
     Console.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"
     )
@@ -112,16 +169,13 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
 
   const rigoToken = sessionPayload.rigobot.key
 
-  const consumables = await getConsumables(
-    sessionPayload.token,
-    "ai-generation"
-  )
+  const consumable = await getConsumable(sessionPayload.token, "ai-generation")
 
-  if (consumables.ai_generation === 0) {
+  if (consumable.count === 0) {
     Console.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"
+      "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)
+    // process.exit(1)
   }
 
   const isCreator = await hasCreatorPermission(rigoToken)
@@ -134,26 +188,32 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
 
   Console.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")
@@ -179,21 +239,38 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
       kind: kind.toLowerCase(),
     })
 
-    const { exceedsThreshold, newMarkdown } = checkReadingTime(
+    const duration = durationByKind[kind.toLowerCase()]
+    let readingTime = checkReadingTime(
       readme.parsed.content,
-      200
+      200,
+      duration || 1
     )
 
-    if (exceedsThreshold) {
-      Console.error("The reading time exceeds the threshold")
-      Console.info(
-        `Please reduce the reading time of the lesson, current reading time is ${exceedsThreshold} minutes`
-      )
+    if (readingTime.exceedsThreshold) {
+      // Console.info(
+      //   `The reading time for the lesson ${exTitle} exceeds the threshold, reducing it...`
+      // )
+      const reducedReadme = await reduceReadme(rigoToken, {
+        lesson: readingTime.body,
+        number_of_words: readingTime.minutes.toString(),
+        expected_number_words: "200",
+      })
+
+      if (reducedReadme) {
+        readingTime = 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 createCodeFile(rigoToken, {
@@ -210,15 +287,14 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
       )
     }
 
-    return readme.parsed.content
+    return readingTime.newMarkdown
   })
 
-  let imagesArray: any[] = []
-
   const readmeContents = await Promise.all(exercisePromises)
-
   Console.success("Lessons created! 🎉")
+
   Console.info("Generating images for the lessons...")
+  let imagesArray: any[] = []
 
   for (const content of readmeContents) {
     imagesArray = [...imagesArray, ...extractImagesFromMarkdown(content)]
@@ -255,7 +331,7 @@ const getChoices = async (empty: boolean) => {
     title: "My Interactive Tutorial",
     description: "",
     difficulty: "beginner",
-    duration: 1,
+    duration: 5,
     useAI: "no",
     grading: "isolated",
   }
@@ -293,30 +369,7 @@ const getChoices = async (empty: boolean) => {
       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: string) => {
-        const n = Math.floor(Number(value))
-        return n !== Number.POSITIVE_INFINITY && String(n) === value && n >= 0
-      },
-    },
+
     {
       type: "select",
       name: "useAI",
@@ -332,7 +385,12 @@ const getChoices = async (empty: boolean) => {
     },
   ])
 
-  return choices
+  const completeChoices = {
+    ...choices,
+    difficulty: "beginner",
+    duration: 30,
+  }
+  return completeChoices
 }
 
 class InitComand extends BaseCommand {

package/src/commands/publish.ts

@@ -15,6 +15,8 @@ import {
   downloadEditor,
   checkIfDirectoryExists,
 } from "../managers/file"
+import api, { TAcademy } from "../utils/api"
+import * as prompts from "prompts"
 
 const RIGOBOT_HOST = "https://rigobot.herokuapp.com"
 // const RIGOBOT_HOST =
@@ -45,6 +47,29 @@ const runAudit = () => {
   )
 }
 
+const selectAcademy = async (academies: TAcademy[]) => {
+  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.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
+}
+
 export default class BuildCommand extends SessionCommand {
   static description =
     "Builds the project by copying necessary files and directories into a zip file"
@@ -65,7 +90,11 @@ export default class BuildCommand extends SessionCommand {
     const configObject = this.configManager?.get()
 
     let sessionPayload = await SessionManager.getPayload()
-    if (!sessionPayload || !sessionPayload.rigobot) {
+    if (
+      !sessionPayload ||
+      !sessionPayload.rigobot ||
+      (sessionPayload.token && !(await api.validateToken(sessionPayload.token)))
+    ) {
       Console.error("You must be logged in to upload a LearnPack package")
       try {
         sessionPayload = await SessionManager.login()
@@ -87,7 +116,10 @@ export default class BuildCommand extends SessionCommand {
       this.configManager?.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")

package/src/commands/start.ts

@@ -176,10 +176,12 @@ export default class StartCommand extends SessionCommand {
 
           const files = prioritizeHTMLFile(data.files)
 
-          if (config.editor.agent === "os") {
+          if (config.editor.agent !== "os") {
+            // Console.info("Opening files for vscode agent")
             eventManager.enqueue(dispatcher.events.OPEN_FILES, files)
           } else {
-            dispatcher.enqueue(dispatcher.events.OPEN_FILES, files)
+            // dispatcher.enqueue(dispatcher.events.OPEN_FILES, files)
+            Console.debug("Ignoring files for os agent")
           }
 
           socket.ready("Ready to compile...")
@@ -187,10 +189,14 @@ export default class StartCommand extends SessionCommand {
 
         socket.on("open_window", (data: TOpenWindowData) => {
           Console.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")
             eventManager.enqueue(dispatcher.events.OPEN_WINDOW, data)
           } else {
+            console.log("Opening window without XDG")
             dispatcher.enqueue(dispatcher.events.OPEN_WINDOW, data)
           }
 
@@ -249,16 +255,6 @@ export default class StartCommand extends SessionCommand {
           })
         })
 
-        // 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("telemetry_event", (data: any) => {
           const { stepPosition, event, eventData } = data
 
@@ -358,9 +354,9 @@ export default class StartCommand extends SessionCommand {
 
         // 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.emit("file_change", "ready", _filename)
+            socket.emit("file_change", "ready", [_filename, _fileContent])
           })
       }
     }