@learnpack/learnpack 5.0.42 → 5.0.43

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/5.0.42 win32-x64 node-v22.14.0
+@learnpack/learnpack/5.0.43 win32-x64 node-v22.14.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -79,7 +79,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.42/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\audit.ts)_
 
 ## `learnpack breakToken`
 
@@ -94,7 +94,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.42/src\commands\breakToken.ts)_
+_See code: [src\commands\breakToken.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\breakToken.ts)_
 
 ## `learnpack clean`
 
@@ -109,7 +109,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.42/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -127,7 +127,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.42/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -159,7 +159,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.42/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -177,7 +177,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.42/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -195,7 +195,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.42/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -327,7 +327,7 @@ OPTIONS
   -s, --strict  strict mode
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.42/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -349,7 +349,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.42/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -366,7 +366,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.42/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\test.ts)_
 
 ## `learnpack translate`
 
@@ -380,7 +380,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.42/src\commands\translate.ts)_
+_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\translate.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/init.js

@@ -20,6 +20,13 @@ const durationByKind = {
     quiz: 2,
     read: 1,
 };
+function estimateActivities(estimatedDuration) {
+    const result = {};
+    for (const kind of Object.keys(durationByKind)) {
+        result[kind] = Math.floor(estimatedDuration / durationByKind[kind]);
+    }
+    return result;
+}
 const PARAMS = {
     expected_grade_level: "6",
     max_fkgl: 8,
@@ -154,7 +161,7 @@ const appendContentIndex = async () => {
         },
     ]);
     if (choices.contentIndex) {
-        await (0, creatorUtilities_1.createFileOnDesktop)();
+        await (0, creatorUtilities_1.createFileOnDesktop)("content_index.txt");
         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([
             {
@@ -167,11 +174,38 @@ const appendContentIndex = async () => {
             console_1.default.error("Please make the necessary changes and try again.");
             process.exit(1);
         }
-        const contentIndex = (0, creatorUtilities_1.getContentIndex)();
+        const contentIndex = (0, creatorUtilities_1.getDesktopFile)("content_index.txt");
         return contentIndex;
     }
     return null;
 };
+const appendAIRules = async () => {
+    const choices = await prompts([
+        {
+            type: "confirm",
+            name: "airules",
+            message: "Do you want to add any specific rules for the AI? (e.g. no code exercises, no quizzes, etc, a particular writting style, etc)",
+        },
+    ]);
+    if (choices.airules) {
+        await (0, creatorUtilities_1.createFileOnDesktop)("airules.txt");
+        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 airules = (0, creatorUtilities_1.getDesktopFile)("airules.txt");
+        return airules;
+    }
+    return null;
+};
 const handleAILogic = async (tutorialDir, packageInfo) => {
     fs.removeSync(path.join(tutorialDir, "exercises", "01-hello-world"));
     let sessionPayload = await session_1.default.getPayload();
@@ -206,6 +240,7 @@ const handleAILogic = async (tutorialDir, packageInfo) => {
     console_1.default.success("🎉 Let's begin this learning journey!");
     const { targetAudience, estimatedDuration } = await whichTargetAudienceAndEstimatedDuration();
     const contentIndex = await appendContentIndex();
+    const airules = await appendAIRules();
     let packageContext = `
   \n
   Title: "${packageInfo.title.us}"
@@ -221,12 +256,24 @@ const handleAILogic = async (tutorialDir, packageInfo) => {
       ` :
         ""}
 
-  Keep in mind that depending on the type of exercise, the duration will vary.
-  This is the duration for each type of exercise:
+  This is the duration for each type of step, use it to estimate the number of steps to create:
   ${Object.entries(durationByKind)
         .map(([key, value]) => `${key}: ${value} minutes`)
         .join("\n")}
 
+
+  Within the estimated duration, is possible to have the following activities:
+  ${JSON.stringify(estimateActivities(estimatedDuration))}
+
+  You should create a tutorial that is engaging and fun to follow.
+
+
+  ${airules ?
+        `
+      This is a list of rules you need to follow when creating the tutorial:
+      ${airules}
+      ` :
+        ""}
   `;
     const { steps, title, description, duration, difficulty } = await initializeInteractiveCreation(rigoToken, packageContext);
     packageInfo.title.us = title;

package/lib/commands/publish.js

@@ -159,6 +159,8 @@ class BuildCommand extends SessionCommand_1.default {
         // After copying the _app directory
         const indexHtmlPath = path.join(appDir, "index.html");
         const buildIndexHtmlPath = path.join(buildDir, "index.html");
+        const manifestPWA = path.join(appDir, "manifest.webmanifest");
+        const buildManifestPWA = path.join(buildDir, "manifest.webmanifest");
         if (fs.existsSync(indexHtmlPath)) {
             let indexHtmlContent = fs.readFileSync(indexHtmlPath, "utf-8");
             const description = learnJson.description.us || "LearnPack is awesome!";
@@ -177,6 +179,18 @@ class BuildCommand extends SessionCommand_1.default {
         else {
             this.error("index.html not found in _app directory");
         }
+        if (fs.existsSync(manifestPWA)) {
+            let manifestPWAContent = fs.readFileSync(manifestPWA, "utf-8");
+            manifestPWAContent = manifestPWAContent.replace("{{course_title}}", learnJson.title.us);
+            const courseShortName = await (0, rigoActions_1.generateCourseShortName)(rigoToken, {
+                learnJSON: JSON.stringify(learnJson),
+            });
+            manifestPWAContent = manifestPWAContent.replace("{{course_app_name}}", courseShortName.answer);
+            fs.writeFileSync(buildManifestPWA, manifestPWAContent);
+        }
+        else {
+            this.error("manifest.webmanifest not found in _app directory");
+        }
         // Copy exercises directory
         const exercisesDir = path.join(process.cwd(), "exercises");
         const learnExercisesDir = path.join(process.cwd(), ".learn", "exercises");

package/lib/utils/creatorUtilities.d.ts

@@ -49,8 +49,8 @@ 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 declare function createFileOnDesktop(fileName: string): Promise<void>;
+export declare function getDesktopFile(fileName: string): string;
 export declare function extractTextFromMarkdown(mdContent: string): string;
 export declare const saveTranslatedReadme: (exercise: string, languageCode: string, readme: string) => Promise<void>;
 /**

package/lib/utils/creatorUtilities.js

@@ -6,7 +6,7 @@ exports.extractImagesFromMarkdown = extractImagesFromMarkdown;
 exports.getFilenameFromUrl = getFilenameFromUrl;
 exports.estimateDuration = estimateDuration;
 exports.createFileOnDesktop = createFileOnDesktop;
-exports.getContentIndex = getContentIndex;
+exports.getDesktopFile = getDesktopFile;
 exports.extractTextFromMarkdown = extractTextFromMarkdown;
 exports.extractParagraphs = extractParagraphs;
 exports.splitIntoSyllables = splitIntoSyllables;
@@ -169,10 +169,10 @@ What is an AI Model: Explain what is an AI model and its applications
 How to use an AI Model: Different APIs, local models, etc.
 How to build an AI Model: Fine-tuning, data collection, cleaning and more.
 `;
-async function createFileOnDesktop() {
+async function createFileOnDesktop(fileName) {
     try {
         const desktopPath = (0, path_1.join)((0, os_1.homedir)(), "Desktop");
-        const filePath = (0, path_1.join)(desktopPath, "content_index.txt");
+        const filePath = (0, path_1.join)(desktopPath, fileName);
         const content = example_content.trim();
         await writeFilePromise(filePath, content);
         console.log(`File created successfully at: ${filePath}`);
@@ -202,9 +202,9 @@ async function openFile(filePath) {
         console.error("Error opening the file:", error);
     }
 }
-function getContentIndex() {
+function getDesktopFile(fileName) {
     const desktopPath = (0, path_1.join)((0, os_1.homedir)(), "Desktop");
-    const filePath = (0, path_1.join)(desktopPath, "content_index.txt");
+    const filePath = (0, path_1.join)(desktopPath, fileName);
     const content = fs.readFileSync(filePath, "utf8");
     return content;
 }

package/lib/utils/rigoActions.d.ts

@@ -61,4 +61,8 @@ type TReduceReadmeInputs = {
 };
 export declare function makeReadmeReadable(rigoToken: string, inputs: TReduceReadmeInputs): Promise<any>;
 export declare const isValidRigoToken: (rigobotToken: string) => Promise<boolean>;
+type TGenerateCourseShortNameInputs = {
+    learnJSON: string;
+};
+export declare const generateCourseShortName: (token: string, inputs: TGenerateCourseShortNameInputs) => Promise<any>;
 export {};

package/lib/utils/rigoActions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidRigoToken = exports.readmeCreator = exports.createCodingReadme = exports.createCodeFile = exports.interactiveCreation = exports.generateCourseIntroduction = exports.translateExercise = exports.generateImage = exports.hasCreatorPermission = exports.createReadme = void 0;
+exports.generateCourseShortName = exports.isValidRigoToken = exports.readmeCreator = exports.createCodingReadme = exports.createCodeFile = exports.interactiveCreation = exports.generateCourseIntroduction = exports.translateExercise = exports.generateImage = exports.hasCreatorPermission = exports.createReadme = void 0;
 exports.downloadImage = downloadImage;
 exports.createPreviewReadme = createPreviewReadme;
 exports.makeReadmeReadable = makeReadmeReadable;
@@ -202,3 +202,13 @@ const isValidRigoToken = async (rigobotToken) => {
     return true;
 };
 exports.isValidRigoToken = isValidRigoToken;
+const generateCourseShortName = async (token, inputs) => {
+    const response = await axios_1.default.post(`${RIGOBOT_HOST}/v1/prompting/completion/852/`, { inputs, include_purpose_objective: false, execute_async: false }, {
+        headers: {
+            "Content-Type": "application/json",
+            Authorization: "Token " + token,
+        },
+    });
+    return response.data;
+};
+exports.generateCourseShortName = generateCourseShortName;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"5.0.42","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":{"strict":{"name":"strict","type":"boolean","char":"s","description":"strict mode","allowNo":false}},"args":[]},"breakToken":{"id":"breakToken","description":"Break the token","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"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":{"strict":{"name":"strict","type":"boolean","char":"s","description":"strict mode","allowNo":false},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[]}}}
+{"version":"5.0.43","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":{"strict":{"name":"strict","type":"boolean","char":"s","description":"strict mode","allowNo":false}},"args":[]},"breakToken":{"id":"breakToken","description":"Break the token","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"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":{"strict":{"name":"strict","type":"boolean","char":"s","description":"strict mode","allowNo":false},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"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.42",
+  "version": "5.0.43",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {

package/src/commands/init.ts

@@ -31,8 +31,8 @@ import {
   getFilenameFromUrl,
   makePackageInfo,
   estimateDuration,
-  getContentIndex,
   createFileOnDesktop,
+  getDesktopFile,
 } from "../utils/creatorUtilities"
 import SessionManager from "../managers/session"
 
@@ -42,6 +42,16 @@ const durationByKind: Record<string, number> = {
   read: 1,
 }
 
+function estimateActivities(estimatedDuration: number) {
+  const result: Record<string, number> = {}
+
+  for (const kind of Object.keys(durationByKind)) {
+    result[kind] = Math.floor(estimatedDuration / durationByKind[kind])
+  }
+
+  return result
+}
+
 const PARAMS = {
   expected_grade_level: "6",
   max_fkgl: 8,
@@ -243,7 +253,7 @@ const appendContentIndex = async () => {
     },
   ])
   if (choices.contentIndex) {
-    await createFileOnDesktop()
+    await createFileOnDesktop("content_index.txt")
     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."
     )
@@ -259,13 +269,46 @@ const appendContentIndex = async () => {
       process.exit(1)
     }
 
-    const contentIndex = getContentIndex()
+    const contentIndex = getDesktopFile("content_index.txt")
     return contentIndex
   }
 
   return null
 }
 
+const appendAIRules = async () => {
+  const choices = await prompts([
+    {
+      type: "confirm",
+      name: "airules",
+      message:
+        "Do you want to add any specific rules for the AI? (e.g. no code exercises, no quizzes, etc, a particular writting style, etc)",
+    },
+  ])
+  if (choices.airules) {
+    await createFileOnDesktop("airules.txt")
+    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 airules = getDesktopFile("airules.txt")
+    return airules
+  }
+
+  return null
+}
+
 const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
   fs.removeSync(path.join(tutorialDir, "exercises", "01-hello-world"))
 
@@ -319,6 +362,7 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
   const { targetAudience, estimatedDuration } =
     await whichTargetAudienceAndEstimatedDuration()
   const contentIndex = await appendContentIndex()
+  const airules = await appendAIRules()
 
   let packageContext = `
   \n
@@ -337,12 +381,26 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
       ""
   }
 
-  Keep in mind that depending on the type of exercise, the duration will vary.
-  This is the duration for each type of exercise:
+  This is the duration for each type of step, use it to estimate the number of steps to create:
   ${Object.entries(durationByKind)
     .map(([key, value]) => `${key}: ${value} minutes`)
     .join("\n")}
 
+
+  Within the estimated duration, is possible to have the following activities:
+  ${JSON.stringify(estimateActivities(estimatedDuration))}
+
+  You should create a tutorial that is engaging and fun to follow.
+
+
+  ${
+    airules ?
+      `
+      This is a list of rules you need to follow when creating the tutorial:
+      ${airules}
+      ` :
+      ""
+  }
   `
 
   const { steps, title, description, duration, difficulty } =

package/src/commands/publish.ts

@@ -17,7 +17,7 @@ import {
 } from "../managers/file"
 import api, { getConsumable, TAcademy } from "../utils/api"
 import * as prompts from "prompts"
-import { isValidRigoToken } from "../utils/rigoActions"
+import { generateCourseShortName, isValidRigoToken } from "../utils/rigoActions"
 
 const RIGOBOT_HOST = "https://rigobot.herokuapp.com"
 // const RIGOBOT_HOST =
@@ -217,6 +217,8 @@ class BuildCommand extends SessionCommand {
     // After copying the _app directory
     const indexHtmlPath = path.join(appDir, "index.html")
     const buildIndexHtmlPath = path.join(buildDir, "index.html")
+    const manifestPWA = path.join(appDir, "manifest.webmanifest")
+    const buildManifestPWA = path.join(buildDir, "manifest.webmanifest")
 
     if (fs.existsSync(indexHtmlPath)) {
       let indexHtmlContent = fs.readFileSync(indexHtmlPath, "utf-8")
@@ -241,6 +243,26 @@ class BuildCommand extends SessionCommand {
       this.error("index.html not found in _app directory")
     }
 
+    if (fs.existsSync(manifestPWA)) {
+      let manifestPWAContent = fs.readFileSync(manifestPWA, "utf-8")
+      manifestPWAContent = manifestPWAContent.replace(
+        "{{course_title}}",
+        learnJson.title.us
+      )
+
+      const courseShortName = await generateCourseShortName(rigoToken, {
+        learnJSON: JSON.stringify(learnJson),
+      })
+
+      manifestPWAContent = manifestPWAContent.replace(
+        "{{course_app_name}}",
+        courseShortName.answer
+      )
+      fs.writeFileSync(buildManifestPWA, manifestPWAContent)
+    } else {
+      this.error("manifest.webmanifest not found in _app directory")
+    }
+
     // Copy exercises directory
     const exercisesDir = path.join(process.cwd(), "exercises")
     const learnExercisesDir = path.join(process.cwd(), ".learn", "exercises")

package/src/utils/creatorUtilities.ts

@@ -216,10 +216,10 @@ How to use an AI Model: Different APIs, local models, etc.
 How to build an AI Model: Fine-tuning, data collection, cleaning and more.
 `
 
-export async function createFileOnDesktop() {
+export async function createFileOnDesktop(fileName: string) {
   try {
     const desktopPath = join(homedir(), "Desktop")
-    const filePath = join(desktopPath, "content_index.txt")
+    const filePath = join(desktopPath, fileName)
 
     const content = example_content.trim()
 
@@ -252,9 +252,9 @@ async function openFile(filePath: string) {
   }
 }
 
-export function getContentIndex() {
+export function getDesktopFile(fileName: string) {
   const desktopPath = join(homedir(), "Desktop")
-  const filePath = join(desktopPath, "content_index.txt")
+  const filePath = join(desktopPath, fileName)
 
   const content = fs.readFileSync(filePath, "utf8")
   return content
@@ -390,7 +390,7 @@ export function fleschKincaidGrade(text: string): TFKGLResult {
       fkgl: 0,
     }
   }
-   
+
   const fkgl =
     // eslint-disable-next-line
     0.39 * (numWords / numSentences) + 11.8 * (numSyllables / numWords) - 15.59

package/src/utils/rigoActions.ts

@@ -337,3 +337,25 @@ export const isValidRigoToken = async (rigobotToken: string) => {
 
   return true
 }
+
+type TGenerateCourseShortNameInputs = {
+  learnJSON: string
+}
+
+export const generateCourseShortName = async (
+  token: string,
+  inputs: TGenerateCourseShortNameInputs
+) => {
+  const response = await axios.post(
+    `${RIGOBOT_HOST}/v1/prompting/completion/852/`,
+    { inputs, include_purpose_objective: false, execute_async: false },
+    {
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: "Token " + token,
+      },
+    }
+  )
+
+  return response.data
+}