@learnpack/learnpack 5.0.357 → 5.0.359

package/lib/commands/publish.d.ts

@@ -1,14 +1,4 @@
 import SessionCommand from "../utils/SessionCommand";
-type ExistingAssetInfo = {
-    lang: string;
-    slug: string;
-    exists: boolean;
-    academyId?: number;
-};
-export declare const handleAssetCreation: (sessionPayload: {
-    token: string;
-    rigobotToken: string;
-}, learnJson: any, selectedLang: string, learnpackDeployUrl: string, b64IndexReadme: string, academyId: number | undefined, learnpackId: number, preflightInfo?: ExistingAssetInfo, all_translations?: string[]) => Promise<any>;
 declare class BuildCommand extends SessionCommand {
     static description: string;
     static flags: {

package/lib/commands/publish.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleAssetCreation = void 0;
 /* eslint-disable arrow-parens */
 /* eslint-disable unicorn/no-array-for-each */
 const child_process_1 = require("child_process");
@@ -19,181 +18,56 @@ const prompts = require("prompts");
 const rigoActions_1 = require("../utils/rigoActions");
 const misc_1 = require("../utils/misc");
 const creatorUtilities_1 = require("../utils/creatorUtilities");
+const branding_1 = require("../utils/branding");
+const assetResolver_1 = require("../utils/assetResolver");
+const assetSync_1 = require("../utils/assetSync");
 const uploadZipEndpont = api_1.RIGOBOT_HOST + "/v1/learnpack/upload";
-const getAvailableLangs = (learnJson) => {
-    const langs = Object.keys((learnJson === null || learnJson === void 0 ? void 0 : learnJson.title) || {});
-    return langs.filter((l) => typeof l === "string" && l.length > 0);
-};
 const getDefaultLang = (learnJson) => {
-    const availableLangs = getAvailableLangs(learnJson);
+    const availableLangs = (0, assetResolver_1.getAvailableLangs)(learnJson);
     if (availableLangs.length === 0)
         return "en";
     return availableLangs.includes("en") ? "en" : availableLangs[0];
 };
-const getLocalizedValue = (translations, lang, fallbackLangs = ["en", "us"]) => {
-    if (!translations || typeof translations !== "object")
-        return "";
-    const direct = translations[lang];
-    if (typeof direct === "string" && direct.trim().length > 0)
-        return direct;
-    for (const fb of fallbackLangs) {
-        const v = translations[fb];
-        if (typeof v === "string" && v.trim().length > 0)
-            return v;
-    }
-    const firstKey = Object.keys(translations)[0];
-    const first = firstKey ? translations[firstKey] : "";
-    return typeof first === "string" ? first : "";
-};
-const getExistingAssetsInfo = async (token, learnJson) => {
-    const availableLangs = getAvailableLangs(learnJson);
-    const results = [];
-    for (const lang of availableLangs) {
-        const assetTitle = getLocalizedValue(learnJson === null || learnJson === void 0 ? void 0 : learnJson.title, lang);
-        if (!assetTitle)
-            continue;
-        let slug = (0, creatorUtilities_1.slugify)(assetTitle).slice(0, 47);
-        slug = `${slug}-${lang}`;
-        // eslint-disable-next-line no-await-in-loop
-        const { exists, academyId } = await api_1.default.doesAssetExists(token, slug);
-        results.push({ lang, slug, exists, academyId });
-    }
-    return results;
-};
-const determinePublishAcademyMode = (existingAssets) => {
-    const academyIds = existingAssets
-        .filter((a) => a.exists && a.academyId !== undefined)
-        .map((a) => a.academyId);
-    const unique = [...new Set(academyIds)];
-    if (unique.length === 0)
-        return { type: "select" };
-    if (unique.length === 1)
-        return { type: "locked", academyId: unique[0] };
-    return { type: "conflict", academies: unique };
-};
-const handleAssetCreation = async (sessionPayload, learnJson, selectedLang, learnpackDeployUrl, b64IndexReadme, academyId, learnpackId, preflightInfo, all_translations = []) => {
-    const category = "uncategorized";
+const readReadmeFromDisk = async (lang) => {
+    const readmePath = path.join(process.cwd(), `README${(0, creatorUtilities_1.getReadmeExtension)(lang)}`);
     try {
-        const user = await api_1.default.validateToken(sessionPayload.token);
-        const assetTitle = getLocalizedValue(learnJson === null || learnJson === void 0 ? void 0 : learnJson.title, selectedLang);
-        const assetDescription = getLocalizedValue(learnJson === null || learnJson === void 0 ? void 0 : learnJson.description, selectedLang);
-        if (!assetTitle) {
-            throw new Error(`Missing learn.json title for language "${selectedLang}"`);
-        }
-        let slug = (0, creatorUtilities_1.slugify)(assetTitle).slice(0, 47);
-        slug = `${slug}-${selectedLang}`;
-        // Use pre-flight info when available to avoid an extra GET request
-        const { exists, academyId: existingAcademyId } = preflightInfo !== null && preflightInfo !== void 0 ? preflightInfo : (await api_1.default.doesAssetExists(sessionPayload.token, slug));
-        // const technologies: unknown[] = Array.isArray(learnJson?.technologies) ?
-        //   learnJson.technologies :
-        //   []
-        if (!exists) {
-            console_1.default.info("Asset does not exist in this academy, creating it");
-            const assetPayload = {
-                slug: slug,
-                title: assetTitle,
-                lang: selectedLang,
-                graded: true,
-                description: assetDescription,
-                learnpack_deploy_url: learnpackDeployUrl,
-                // technologies: technologies.map((tech: unknown) =>
-                //   String(tech).toLowerCase().replace(/\s+/g, "-")
-                // ),
-                technologies: [],
-                url: learnpackDeployUrl,
-                category: category,
-                owner: user.id,
-                author: user.id,
-                preview: learnJson.preview,
-                readme_raw: b64IndexReadme,
-                all_translations,
-                learnpack_id: learnpackId,
-            };
-            if (academyId !== undefined) {
-                assetPayload.academy_id = academyId;
-            }
-            const asset = await api_1.default.createAsset(sessionPayload.token, assetPayload);
-            try {
-                await api_1.default.updateRigoPackage(sessionPayload.rigobotToken.trim(), learnJson.slug, {
-                    asset_id: asset.id,
-                });
-            }
-            catch (error) {
-                console_1.default.error("Error updating Rigo package:", error);
-            }
-            console_1.default.info("Asset created with id", asset.id);
-            return asset;
-        }
-        console_1.default.info("Asset exists, updating it");
-        const updatePayload = {
-            graded: true,
-            learnpack_deploy_url: learnpackDeployUrl,
-            title: assetTitle,
-            category: category,
-            description: assetDescription,
-            all_translations,
-            learnpack_id: learnpackId,
-        };
-        // Only set academy when the asset has none yet and the user selected one
-        if (existingAcademyId === undefined && academyId !== undefined) {
-            updatePayload.academy_id = academyId;
-        }
-        const asset = await api_1.default.updateAsset(sessionPayload.token, slug, updatePayload);
-        try {
-            await api_1.default.updateRigoPackage(sessionPayload.rigobotToken.trim(), learnJson.slug, {
-                asset_id: asset.id,
-            });
-        }
-        catch (error) {
-            console_1.default.error("Error updating Rigo package:", error);
-        }
-        console_1.default.info("Asset updated with id", asset.id);
-        return asset;
+        return fs.existsSync(readmePath) ?
+            fs.readFileSync(readmePath, "utf-8") :
+            "";
     }
     catch (error) {
-        console_1.default.error("Error updating or creating asset:", error);
-        throw error;
+        console_1.default.error("Error reading index readme:", error);
+        return "";
     }
 };
-exports.handleAssetCreation = handleAssetCreation;
-const createMultiLangAssetFromDisk = async (sessionPayload, learnJson, deployUrl, selectedAcademyId, existingAssetsInfo = []) => {
-    const availableLangs = getAvailableLangs(learnJson);
-    if (availableLangs.length === 0) {
+const syncAssetsFromDisk = async (sessionPayload, learnJson, deployUrl, selectedAcademyId, resolution) => {
+    if ((0, assetResolver_1.getAvailableLangs)(learnJson).length === 0) {
         console_1.default.error("No languages found in learn.json.title. Add at least one language (e.g. title.en).");
         return;
     }
-    const learnpackId = await api_1.default.resolveLearnpackPackageId(sessionPayload.rigobotToken, learnJson.slug);
-    if (learnpackId === null) {
-        console_1.default.warning("Breathecode assets skipped: could not resolve Learnpack package id");
-        return;
+    // The pre-upload resolution is reused unless the package did not exist in
+    // Rigobot yet (first publish): the upload has just created it.
+    const result = await (0, assetSync_1.syncPackageAssets)({
+        bcToken: sessionPayload.token,
+        rigoToken: sessionPayload.rigobotToken,
+        packageSlug: learnJson.slug,
+        learnJson,
+        deployUrl,
+        academyId: selectedAcademyId,
+        readReadme: readReadmeFromDisk,
+        resolution: resolution.learnpackId === null ? undefined : resolution,
+    });
+    for (const warning of result.warnings)
+        console_1.default.warning(warning);
+    for (const synced of result.synced) {
+        console_1.default.info(`Asset ${synced.action} for "${synced.lang}": #${synced.asset.id} ${synced.asset.slug}`);
     }
-    const all_translations = [];
-    for (const lang of availableLangs) {
-        const readmePath = path.join(process.cwd(), `README${(0, creatorUtilities_1.getReadmeExtension)(lang)}`);
-        let indexReadmeString = "";
-        try {
-            if (fs.existsSync(readmePath)) {
-                indexReadmeString = fs.readFileSync(readmePath, "utf-8");
-            }
+    for (const error of result.errors) {
+        if (error.kind === "lang_error") {
+            console_1.default.error(`Asset for "${error.lang}": ${error.error.detail}`);
         }
-        catch (error) {
-            console_1.default.error("Error reading index readme:", error);
-            indexReadmeString = "";
-        }
-        const b64IndexReadme = Buffer.from(indexReadmeString).toString("base64");
-        const preflightInfo = existingAssetsInfo.find((a) => a.lang === lang);
-        try {
-            // eslint-disable-next-line no-await-in-loop
-            const asset = await (0, exports.handleAssetCreation)(sessionPayload, learnJson, lang, deployUrl, b64IndexReadme, selectedAcademyId, learnpackId, preflightInfo, all_translations);
-            if (!asset) {
-                console_1.default.debug("Could not create/update asset for lang", lang);
-                continue;
-            }
-            all_translations.push(asset.slug);
-        }
-        catch (error) {
-            console_1.default.error("Error creating asset for language", lang, error);
-            // Continue with other languages
+        else {
+            console_1.default.error(error.error.detail);
         }
     }
 };
@@ -312,8 +186,19 @@ class BuildCommand extends SessionCommand_1.default {
             process.exit(1);
         }
         console_1.default.info("Checking existing assets...");
-        const existingAssetsInfo = await getExistingAssetsInfo(sessionPayload.token, learnJson);
-        const academyMode = determinePublishAcademyMode(existingAssetsInfo);
+        const resolution = await (0, assetResolver_1.resolvePackageAssets)({
+            bcToken: sessionPayload.token,
+            rigoToken: rigoToken,
+            packageSlug: learnJson.slug,
+            learnJson,
+        });
+        for (const warning of resolution.warnings)
+            console_1.default.warning(warning);
+        if (resolution.packageState === "unknown") {
+            console_1.default.error(`${resolution.packageError}. Existing assets cannot be checked, so publishing now could create duplicates. Try again later.`);
+            process.exit(1);
+        }
+        const academyMode = (0, assetResolver_1.determineAcademyMode)(resolution);
         let selectedAcademyId;
         if (academyMode.type === "conflict") {
             console_1.default.warning(`Some of your assets are associated with different academies ` +
@@ -379,12 +264,11 @@ class BuildCommand extends SessionCommand_1.default {
         if (fs.existsSync(indexHtmlPath)) {
             let indexHtmlContent = fs.readFileSync(indexHtmlPath, "utf-8");
             const selectedLang = getDefaultLang(learnJson);
-            const description = getLocalizedValue(learnJson === null || learnJson === void 0 ? void 0 : learnJson.description, selectedLang) ||
+            const description = (0, assetSync_1.getLocalizedValue)(learnJson === null || learnJson === void 0 ? void 0 : learnJson.description, selectedLang) ||
                 "LearnPack is awesome!";
-            const title = getLocalizedValue(learnJson === null || learnJson === void 0 ? void 0 : learnJson.title, selectedLang) ||
+            const title = (0, assetSync_1.getLocalizedValue)(learnJson === null || learnJson === void 0 ? void 0 : learnJson.title, selectedLang) ||
                 "LearnPack: Interactive Learning as a Service";
-            const previewUrl = learnJson.preview ||
-                "https://raw.githubusercontent.com/learnpack/ide/refs/heads/master/public/learnpack.svg";
+            const previewUrl = learnJson.preview || (0, branding_1.getFallbackPreviewUrl)();
             // Replace placeholders and the <title>Old title </title> tag for a new tag with the title
             indexHtmlContent = indexHtmlContent
                 .replace(/{{description}}/g, description)
@@ -402,9 +286,9 @@ class BuildCommand extends SessionCommand_1.default {
         if (fs.existsSync(manifestPWA)) {
             let manifestPWAContent = fs.readFileSync(manifestPWA, "utf-8");
             const selectedLang = getDefaultLang(learnJson);
-            const courseTitle = getLocalizedValue(learnJson === null || learnJson === void 0 ? void 0 : learnJson.title, selectedLang) ||
-                getLocalizedValue(learnJson === null || learnJson === void 0 ? void 0 : learnJson.title, "us") ||
-                getLocalizedValue(learnJson === null || learnJson === void 0 ? void 0 : learnJson.title, "en") ||
+            const courseTitle = (0, assetSync_1.getLocalizedValue)(learnJson === null || learnJson === void 0 ? void 0 : learnJson.title, selectedLang) ||
+                (0, assetSync_1.getLocalizedValue)(learnJson === null || learnJson === void 0 ? void 0 : learnJson.title, "us") ||
+                (0, assetSync_1.getLocalizedValue)(learnJson === null || learnJson === void 0 ? void 0 : learnJson.title, "en") ||
                 "LearnPack";
             manifestPWAContent = manifestPWAContent.replace("{{course_title}}", courseTitle);
             const courseShortName = { answer: "testing-tutorial" };
@@ -461,7 +345,7 @@ class BuildCommand extends SessionCommand_1.default {
                 console.log(res.data);
                 fs.unlinkSync(zipFilePath);
                 this.removeDirectory(buildDir);
-                await createMultiLangAssetFromDisk({ token: sessionPayload.token, rigobotToken: rigoToken }, learnJson, res.data.url, selectedAcademyId, existingAssetsInfo);
+                await syncAssetsFromDisk({ token: sessionPayload.token, rigobotToken: rigoToken }, learnJson, res.data.url, selectedAcademyId, resolution);
             }
             catch (error) {
                 if (axios_1.default.isAxiosError(error)) {