@learnpack/learnpack 5.0.15 → 5.0.16

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/5.0.15 win32-x64 node-v20.16.0
+@learnpack/learnpack/5.0.16 win32-x64 node-v20.16.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -75,7 +75,7 @@ DESCRIPTION
        12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)
 ```
 
-_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.15/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.16/src\commands\audit.ts)_
 
 ## `learnpack clean`
 
@@ -90,7 +90,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.15/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.16/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -108,7 +108,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.15/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.16/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -137,9 +137,10 @@ USAGE
 
 OPTIONS
   -h, --grading  show CLI help
+  -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.15/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.16/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -157,7 +158,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.15/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.16/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -175,7 +176,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.15/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.16/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -306,7 +307,7 @@ OPTIONS
   -h, --help  show CLI help
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.15/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.16/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -325,9 +326,10 @@ OPTIONS
   -p, --port=port                     server port
   -v, --version=version               E.g: 1.0.1
   -w, --watch                         Watch for file changes
+  -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.15/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.16/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -339,9 +341,12 @@ USAGE
 
 ARGUMENTS
   EXERCISESLUG  The name of the exercise to test
+
+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.15/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.16/src\commands\test.ts)_
 
 ## `learnpack translate`
 
@@ -350,9 +355,12 @@ List all the lessons, the user is able of select many of them to translate to th
 ```
 USAGE
   $ learnpack translate
+
+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.15/src\commands\translate.ts)_
+_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.16/src\commands\translate.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/init.d.ts

@@ -3,6 +3,7 @@ declare class InitComand extends BaseCommand {
     static description: string;
     static flags: {
         grading: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+        yes: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
     };
     run(): Promise<void>;
 }

package/lib/commands/init.js

@@ -6,11 +6,13 @@ const BaseCommand_1 = require("../utils/BaseCommand");
 const fs = require("fs-extra");
 const prompts = require("prompts");
 const cli_ux_1 = require("cli-ux");
+const eta = require("eta");
 const api_1 = require("../utils/api");
 const console_1 = require("../utils/console");
 const errors_1 = require("../utils/errors");
 const path = require("path");
 const rigoActions_1 = require("../utils/rigoActions");
+const api_2 = require("../utils/api");
 const slugify = (text) => {
     return text
         .toString()
@@ -38,6 +40,24 @@ function extractImagesFromMarkdown(markdown) {
 function getFilenameFromUrl(url) {
     return path.basename(url);
 }
+const makePackageInfo = (choices) => {
+    const packageInfo = {
+        grading: choices.grading,
+        difficulty: choices.difficulty,
+        duration: parseInt(choices.duration),
+        description: {
+            us: choices.description,
+        },
+        title: {
+            us: choices.title,
+        },
+        slug: choices.title
+            .toLowerCase()
+            .replace(/ /g, "-")
+            .replace(/[^\w-]+/g, ""),
+    };
+    return packageInfo;
+};
 async function createPreviewReadme(tutorialDir, packageInfo, rigoToken, readmeContents) {
     const readmeFilename = `README.md`;
     const readmeContent = await (0, rigoActions_1.generateCourseIntroduction)(rigoToken, {
@@ -47,7 +67,7 @@ async function createPreviewReadme(tutorialDir, packageInfo, rigoToken, readmeCo
     fs.writeFileSync(path.join(tutorialDir, readmeFilename), readmeContent.answer);
 }
 const handleAILogic = async (tutorialDir, packageInfo) => {
-    console_1.default.info("Almost there! First you need to login to use the AI creator");
+    console_1.default.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");
     fs.removeSync(path.join(tutorialDir, "exercises", "01-hello-world"));
     const loginPrompts = await prompts([
         {
@@ -77,10 +97,17 @@ const handleAILogic = async (tutorialDir, packageInfo) => {
         return;
     }
     const rigoToken = sessionPayload.rigobot.key;
+    const consumables = await (0, api_2.getConsumables)(sessionPayload.token);
+    if (consumables.ai_tutorial_generation === 0) {
+        console_1.default.error("It seems you cannot generate tutorials with AI. Make sure you creator subscription is up to date here: https://4geeks.com/profile/subscriptions?token=" +
+            sessionPayload.token +
+            ". If you believe there is an issue you can always contact support@4geeks.com");
+        process.exit(1);
+    }
     const isCreator = await (0, rigoActions_1.hasCreatorPermission)(rigoToken);
     if (!isCreator) {
         console_1.default.error("👀 Oops! You need to be a creator to use our specialized AI. Please contact support");
-        return;
+        process.exit(1);
     }
     console_1.default.success("🎉 Let's begin this learning journey!");
     const aiChoices = await prompts([
@@ -161,91 +188,92 @@ const handleAILogic = async (tutorialDir, packageInfo) => {
     await createPreviewReadme(tutorialDir, packageInfo, rigoToken, readmeContents);
     return true;
 };
+const getChoices = async (empty) => {
+    const defaultChoices = {
+        title: "My Interactive Tutorial",
+        description: "",
+        difficulty: "beginner",
+        duration: 1,
+        useAI: "no",
+        grading: "isolated",
+    };
+    if (empty) {
+        return defaultChoices;
+    }
+    const choices = await prompts([
+        {
+            type: "select",
+            name: "grading",
+            message: "Is the auto-grading going to be isolated or incremental?",
+            choices: [
+                {
+                    title: "Incremental: Build on top of each other like a tutorial",
+                    value: "incremental",
+                },
+                { title: "Isolated: Small separated exercises", value: "isolated" },
+                {
+                    title: "No grading: No feedback or testing whatsoever",
+                    value: null,
+                },
+            ],
+        },
+        {
+            type: "text",
+            name: "title",
+            initial: "My Interactive Tutorial",
+            message: "Title for your tutorial? Press enter to leave as it is",
+        },
+        {
+            type: "text",
+            name: "description",
+            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) => {
+                const n = Math.floor(Number(value));
+                return n !== Number.POSITIVE_INFINITY && String(n) === value && n >= 0;
+            },
+        },
+        {
+            type: "select",
+            name: "useAI",
+            message: "Want a little bit of AI magic to help you? Our AI can craft the tutorial for you",
+            choices: [
+                {
+                    title: "Yes, please help me",
+                    value: "yes",
+                },
+                { title: "No, thanks, I prefer to do it manually", value: "no" },
+            ],
+        },
+    ]);
+    return choices;
+};
 class InitComand extends BaseCommand_1.default {
     async run() {
         const { flags } = this.parse(InitComand);
         await alreadyInitialized();
-        const choices = await prompts([
-            {
-                type: "select",
-                name: "grading",
-                message: "Is the auto-grading going to be isolated or incremental?",
-                choices: [
-                    {
-                        title: "Incremental: Build on top of each other like a tutorial",
-                        value: "incremental",
-                    },
-                    { title: "Isolated: Small separated exercises", value: "isolated" },
-                    {
-                        title: "No grading: No feedback or testing whatsoever",
-                        value: null,
-                    },
-                ],
-            },
-            {
-                type: "text",
-                name: "title",
-                initial: "My Interactive Tutorial",
-                message: "Title for your tutorial? Press enter to leave as it is",
-            },
-            {
-                type: "text",
-                name: "description",
-                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) => {
-                    const n = Math.floor(Number(value));
-                    return n !== Number.POSITIVE_INFINITY && String(n) === value && n >= 0;
-                },
-            },
-            {
-                type: "select",
-                name: "useAI",
-                message: "Want a little bit of AI magic to help you? Our AI can craft the tutorial for you",
-                choices: [
-                    {
-                        title: "Yes, please help me",
-                        value: "yes",
-                    },
-                    { title: "No, thanks, I prefer to do it manually", value: "no" },
-                ],
-            },
-        ]);
-        const packageInfo = {
-            grading: choices.grading,
-            difficulty: choices.difficulty,
-            duration: parseInt(choices.duration),
-            description: {
-                us: choices.description,
-            },
-            title: {
-                us: choices.title,
-            },
-            slug: choices.title
-                .toLowerCase()
-                .replace(/ /g, "-")
-                .replace(/[^\w-]+/g, ""),
-        };
+        const choices = await getChoices(flags.yes);
+        const packageInfo = makePackageInfo(choices);
         const tutorialDir = `./${packageInfo.slug}`;
         fs.ensureDirSync(tutorialDir);
         const templatesDir = path.resolve(__dirname, "../../src/utils/templates/" + (choices.grading || "no-grading"));
@@ -259,25 +287,16 @@ class InitComand extends BaseCommand_1.default {
         // Creating README files
         for (const language of languages) {
             const readmeFilename = `README${language !== "en" ? `.${language}` : ""}`;
-            // const readmeTemplatePath = path.resolve(
-            //   templatesDir,
-            //   `${readmeFilename}.ejs`
-            // )
-            // const readmeObject = {
-            //   title: packageInfo.title.us,
-            //   description: packageInfo.description.us,
-            //   grading: packageInfo.grading,
-            //   difficulty: packageInfo.difficulty,
-            //   duration: packageInfo.duration,
-            // }
-            // const readmeContent = eta.render(
-            //   fs.readFileSync(readmeTemplatePath, "utf-8"),
-            //   readmeObject
-            // )
-            // fs.writeFileSync(
-            //   path.join(tutorialDir, `${readmeFilename}.md`),
-            //   readmeContent
-            // )
+            const readmeTemplatePath = path.resolve(templatesDir, `${readmeFilename}.ejs`);
+            const readmeObject = {
+                title: packageInfo.title.us,
+                description: packageInfo.description.us,
+                grading: packageInfo.grading,
+                difficulty: packageInfo.difficulty,
+                duration: packageInfo.duration,
+            };
+            const readmeContent = eta.render(fs.readFileSync(readmeTemplatePath, "utf-8"), readmeObject);
+            fs.writeFileSync(path.join(tutorialDir, `${readmeFilename}.md`), readmeContent);
             if (fs.existsSync(path.join(tutorialDir, `${readmeFilename}.ejs`)))
                 fs.removeSync(path.join(tutorialDir, `${readmeFilename}.ejs`));
         }
@@ -289,6 +308,7 @@ class InitComand extends BaseCommand_1.default {
         console_1.default.success(`😋 Package initialized successfully in ${tutorialDir}`);
         console_1.default.help(`Get inside the tutorial with the command: $ cd ${tutorialDir}`);
         console_1.default.help(`Start the exercises by running the following command on your terminal: $ learnpack start`);
+        process.exit(0);
     }
 }
 InitComand.description = "Create a new learning package: Book, Tutorial or Exercise";

package/lib/utils/BaseCommand.d.ts

@@ -3,6 +3,9 @@ declare class BaseCommand extends Command {
     catch(err: any): Promise<void>;
     init(): Promise<void>;
     finally(): Promise<void>;
+    static flags: {
+        yes: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+    };
     run(): Promise<void>;
 }
 export default BaseCommand;

package/lib/utils/BaseCommand.js

@@ -38,4 +38,11 @@ class BaseCommand extends command_1.Command {
         // console.log('running my command')
     }
 }
+BaseCommand.flags = {
+    yes: command_1.flags.boolean({
+        char: "y",
+        description: "Skip all prompts and initialize an empty project",
+        default: false,
+    }),
+};
 exports.default = BaseCommand;

package/lib/utils/api.d.ts

@@ -1,3 +1,6 @@
+type TConsumableSlug = "ai-conversation-message" | "ai-compilation" | "ai-tutorial-generation";
+export declare const countConsumables: (consumables: any, consumableSlug?: TConsumableSlug) => any;
+export declare const getConsumables: (token: string) => Promise<any>;
 declare const _default: {
     login: (identification: string, password: string) => Promise<any>;
     publish: (config: any) => Promise<any>;

package/lib/utils/api.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConsumables = exports.countConsumables = void 0;
 const console_1 = require("../utils/console");
 const storage = require("node-persist");
 const cli_ux_1 = require("cli-ux");
+const axios_1 = require("axios");
 const HOST = "https://breathecode.herokuapp.com";
 const RIGOBOT_HOST = "https://rigobot.herokuapp.com";
 // const RIGOBOT_HOST = "https://8000-charlytoc-rigobot-bmwdeam7cev.ws-us116.gitpod.io"
@@ -249,6 +251,29 @@ const sendStreamTelemetry = async function (url, body) {
         console_1.default.debug("Error while sending stream Telemetry", error);
     });
 };
+const countConsumables = (consumables, consumableSlug = "ai-tutorial-generation") => {
+    // Find the void that matches the consumableSlug
+    const consumable = consumables.voids.find((voidItem) => voidItem.slug === consumableSlug);
+    // Return the available units or 0 if not found
+    return consumable ? consumable.balance.unit : 0;
+};
+exports.countConsumables = countConsumables;
+const getConsumables = async (token) => {
+    const url = `${HOST}/v1/payments/me/service/consumable?virtual=true`;
+    const headers = {
+        Authorization: `Token ${token}`,
+    };
+    try {
+        const response = await axios_1.default.get(url, { headers });
+        const ai_tutorial_generation = (0, exports.countConsumables)(response.data, "ai-tutorial-generation");
+        return { ai_tutorial_generation };
+    }
+    catch (error) {
+        console.error("Error fetching consumables:", error);
+        throw error;
+    }
+};
+exports.getConsumables = getConsumables;
 exports.default = {
     login,
     publish,

package/oclif.manifest.json

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

package/src/commands/init.ts

@@ -19,7 +19,7 @@ import {
   downloadImage,
   generateCourseIntroduction,
 } from "../utils/rigoActions"
-
+import { getConsumables } from "../utils/api"
 const slugify = (text: string) => {
   return text
     .toString()
@@ -53,6 +53,25 @@ function getFilenameFromUrl(url: string) {
   return path.basename(url)
 }
 
+const makePackageInfo = (choices: any) => {
+  const packageInfo = {
+    grading: choices.grading,
+    difficulty: choices.difficulty,
+    duration: parseInt(choices.duration),
+    description: {
+      us: choices.description,
+    },
+    title: {
+      us: choices.title,
+    },
+    slug: choices.title
+      .toLowerCase()
+      .replace(/ /g, "-")
+      .replace(/[^\w-]+/g, ""),
+  }
+  return packageInfo
+}
+
 async function createPreviewReadme(
   tutorialDir: string,
   packageInfo: PackageInfo,
@@ -81,7 +100,9 @@ type PackageInfo = {
 }
 
 const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
-  Console.info("Almost there! First you need to login to use the AI creator")
+  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"
+  )
 
   fs.removeSync(path.join(tutorialDir, "exercises", "01-hello-world"))
 
@@ -115,12 +136,23 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
 
   const rigoToken = sessionPayload.rigobot.key
 
+  const consumables = await getConsumables(sessionPayload.token)
+
+  if (consumables.ai_tutorial_generation === 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?token=" +
+        sessionPayload.token +
+        ". If you believe there is an issue you can always contact support@4geeks.com"
+    )
+    process.exit(1)
+  }
+
   const isCreator = await hasCreatorPermission(rigoToken)
   if (!isCreator) {
     Console.error(
       "👀 Oops! You need to be a creator to use our specialized AI. Please contact support"
     )
-    return
+    process.exit(1)
   }
 
   Console.success("🎉 Let's begin this learning journey!")
@@ -236,6 +268,91 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
   return true
 }
 
+const getChoices = async (empty: boolean) => {
+  const defaultChoices = {
+    title: "My Interactive Tutorial",
+    description: "",
+    difficulty: "beginner",
+    duration: 1,
+    useAI: "no",
+    grading: "isolated",
+  }
+
+  if (empty) {
+    return defaultChoices
+  }
+
+  const choices = await prompts([
+    {
+      type: "select",
+      name: "grading",
+      message: "Is the auto-grading going to be isolated or incremental?",
+      choices: [
+        {
+          title: "Incremental: Build on top of each other like a tutorial",
+          value: "incremental",
+        },
+        { title: "Isolated: Small separated exercises", value: "isolated" },
+        {
+          title: "No grading: No feedback or testing whatsoever",
+          value: null,
+        },
+      ],
+    },
+    {
+      type: "text",
+      name: "title",
+      initial: "My Interactive Tutorial",
+      message: "Title for your tutorial? Press enter to leave as it is",
+    },
+    {
+      type: "text",
+      name: "description",
+      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",
+      message:
+        "Want a little bit of AI magic to help you? Our AI can craft the tutorial for you",
+      choices: [
+        {
+          title: "Yes, please help me",
+          value: "yes",
+        },
+        { title: "No, thanks, I prefer to do it manually", value: "no" },
+      ],
+    },
+  ])
+
+  return choices
+}
+
 class InitComand extends BaseCommand {
   static description =
     "Create a new learning package: Book, Tutorial or Exercise"
@@ -250,89 +367,9 @@ class InitComand extends BaseCommand {
 
     await alreadyInitialized()
 
-    const choices = await prompts([
-      {
-        type: "select",
-        name: "grading",
-        message: "Is the auto-grading going to be isolated or incremental?",
-        choices: [
-          {
-            title: "Incremental: Build on top of each other like a tutorial",
-            value: "incremental",
-          },
-          { title: "Isolated: Small separated exercises", value: "isolated" },
-          {
-            title: "No grading: No feedback or testing whatsoever",
-            value: null,
-          },
-        ],
-      },
-      {
-        type: "text",
-        name: "title",
-        initial: "My Interactive Tutorial",
-        message: "Title for your tutorial? Press enter to leave as it is",
-      },
-      {
-        type: "text",
-        name: "description",
-        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",
-        message:
-          "Want a little bit of AI magic to help you? Our AI can craft the tutorial for you",
-        choices: [
-          {
-            title: "Yes, please help me",
-            value: "yes",
-          },
-          { title: "No, thanks, I prefer to do it manually", value: "no" },
-        ],
-      },
-    ])
-
-    const packageInfo = {
-      grading: choices.grading,
-      difficulty: choices.difficulty,
-      duration: parseInt(choices.duration),
-      description: {
-        us: choices.description,
-      },
-      title: {
-        us: choices.title,
-      },
-      slug: choices.title
-        .toLowerCase()
-        .replace(/ /g, "-")
-        .replace(/[^\w-]+/g, ""),
-    }
+    const choices = await getChoices(flags.yes)
+
+    const packageInfo = makePackageInfo(choices)
 
     const tutorialDir = `./${packageInfo.slug}`
     fs.ensureDirSync(tutorialDir)
@@ -354,26 +391,26 @@ class InitComand extends BaseCommand {
     // Creating README files
     for (const language of languages) {
       const readmeFilename = `README${language !== "en" ? `.${language}` : ""}`
-      // const readmeTemplatePath = path.resolve(
-      //   templatesDir,
-      //   `${readmeFilename}.ejs`
-      // )
-
-      // const readmeObject = {
-      //   title: packageInfo.title.us,
-      //   description: packageInfo.description.us,
-      //   grading: packageInfo.grading,
-      //   difficulty: packageInfo.difficulty,
-      //   duration: packageInfo.duration,
-      // }
-      // const readmeContent = eta.render(
-      //   fs.readFileSync(readmeTemplatePath, "utf-8"),
-      //   readmeObject
-      // )
-      // fs.writeFileSync(
-      //   path.join(tutorialDir, `${readmeFilename}.md`),
-      //   readmeContent
-      // )
+      const readmeTemplatePath = path.resolve(
+        templatesDir,
+        `${readmeFilename}.ejs`
+      )
+
+      const readmeObject = {
+        title: packageInfo.title.us,
+        description: packageInfo.description.us,
+        grading: packageInfo.grading,
+        difficulty: packageInfo.difficulty,
+        duration: packageInfo.duration,
+      }
+      const readmeContent = eta.render(
+        fs.readFileSync(readmeTemplatePath, "utf-8"),
+        readmeObject
+      )
+      fs.writeFileSync(
+        path.join(tutorialDir, `${readmeFilename}.md`),
+        readmeContent
+      )
       if (fs.existsSync(path.join(tutorialDir, `${readmeFilename}.ejs`)))
         fs.removeSync(path.join(tutorialDir, `${readmeFilename}.ejs`))
     }
@@ -398,6 +435,7 @@ class InitComand extends BaseCommand {
     Console.help(
       `Start the exercises by running the following command on your terminal: $ learnpack start`
     )
+    process.exit(0)
   }
 }
 

package/src/utils/BaseCommand.ts

@@ -1,48 +1,56 @@
-import { Command } from "@oclif/command"
-import Console from "./console"
-import { createInterface } from "readline"
-// import SessionManager from '../managers/session'
-
-class BaseCommand extends Command {
-  async catch(err: any) {
-    Console.debug("COMMAND CATCH", err)
-
-    throw err
-  }
-
-  async init() {
-    const { flags, args } = this.parse(BaseCommand)
-    Console.debug("COMMAND INIT")
-    Console.debug("These are your flags: ", flags)
-    Console.debug("These are your args: ", args)
-
-    // quick fix for listening to the process termination on windows
-    if (process.platform === "win32") {
-      const rl = createInterface({
-        input: process.stdin,
-        output: process.stdout,
-      })
-
-      rl.on("SIGINT", function () {
-        // process.emit('SIGINT')
-        // process.emit('SIGINT')
-      })
-    }
-
-    process.on("SIGINT", function () {
-      Console.debug("Terminated (SIGINT)")
-      process.exit()
-    })
-  }
-
-  async finally() {
-    Console.debug("COMMAND FINALLY")
-    // called after run and catch regardless of whether or not the command errored
-  }
-
-  async run() {
-    // console.log('running my command')
-  }
-}
-
-export default BaseCommand
+import { Command, flags } from "@oclif/command"
+import Console from "./console"
+import { createInterface } from "readline"
+// import SessionManager from '../managers/session'
+
+class BaseCommand extends Command {
+  async catch(err: any) {
+    Console.debug("COMMAND CATCH", err)
+
+    throw err
+  }
+
+  async init() {
+    const { flags, args } = this.parse(BaseCommand)
+    Console.debug("COMMAND INIT")
+    Console.debug("These are your flags: ", flags)
+    Console.debug("These are your args: ", args)
+
+    // quick fix for listening to the process termination on windows
+    if (process.platform === "win32") {
+      const rl = createInterface({
+        input: process.stdin,
+        output: process.stdout,
+      })
+
+      rl.on("SIGINT", function () {
+        // process.emit('SIGINT')
+        // process.emit('SIGINT')
+      })
+    }
+
+    process.on("SIGINT", function () {
+      Console.debug("Terminated (SIGINT)")
+      process.exit()
+    })
+  }
+
+  async finally() {
+    Console.debug("COMMAND FINALLY")
+    // called after run and catch regardless of whether or not the command errored
+  }
+
+  static flags = {
+    yes: flags.boolean({
+      char: "y",
+      description: "Skip all prompts and initialize an empty project",
+      default: false,
+    }),
+  }
+
+  async run() {
+    // console.log('running my command')
+  }
+}
+
+export default BaseCommand

package/src/utils/api.ts

@@ -1,6 +1,7 @@
 import Console from "../utils/console"
 import * as storage from "node-persist"
 import cli from "cli-ux"
+import axios from "axios"
 const HOST = "https://breathecode.herokuapp.com"
 const RIGOBOT_HOST = "https://rigobot.herokuapp.com"
 // const RIGOBOT_HOST = "https://8000-charlytoc-rigobot-bmwdeam7cev.ws-us116.gitpod.io"
@@ -299,6 +300,47 @@ const sendStreamTelemetry = async function (url: string, body: object) {
     })
 }
 
+type TConsumableSlug =
+  | "ai-conversation-message"
+  | "ai-compilation"
+  | "ai-tutorial-generation"
+
+export const countConsumables = (
+  consumables: any,
+  consumableSlug: TConsumableSlug = "ai-tutorial-generation"
+) => {
+  // Find the void that matches the consumableSlug
+
+  const consumable = consumables.voids.find(
+    (voidItem: any) => voidItem.slug === consumableSlug
+  )
+
+  // Return the available units or 0 if not found
+  return consumable ? consumable.balance.unit : 0
+}
+
+export const getConsumables = async (token: string): Promise<any> => {
+  const url = `${HOST}/v1/payments/me/service/consumable?virtual=true`
+
+  const headers = {
+    Authorization: `Token ${token}`,
+  }
+
+  try {
+    const response = await axios.get(url, { headers })
+
+    const ai_tutorial_generation = countConsumables(
+      response.data,
+      "ai-tutorial-generation"
+    )
+
+    return { ai_tutorial_generation }
+  } catch (error) {
+    console.error("Error fetching consumables:", error)
+    throw error
+  }
+}
+
 export default {
   login,
   publish,