@learnpack/learnpack 5.0.357 → 5.0.359

package/lib/utils/assetSync.js

@@ -0,0 +1,267 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLocalizedValue = void 0;
+exports.syncPackageAssets = syncPackageAssets;
+/**
+ * Creates or updates the Breathecode assets of a published package, one per
+ * language, and writes the resulting ids back to the Rigobot package.
+ *
+ * Kept free of fs, oclif and express so the whole decision table can be
+ * exercised with HTTP mocks alone; `publish` and `serve` only supply the
+ * readme of each language and the tokens.
+ */
+const api_1 = require("./api");
+const console_1 = require("./console");
+const creatorUtilities_1 = require("./creatorUtilities");
+const assetResolver_1 = require("./assetResolver");
+/**
+ * Localized value with the same fallbacks the publish flow always used.
+ * @param translations - A learn.json map such as `title` or `description`.
+ * @param lang - Preferred language key.
+ * @returns The value for `lang`, else "en"/"us", else the first one, else "".
+ */
+const getLocalizedValue = (translations, lang) => {
+    if (!translations || typeof translations !== "object")
+        return "";
+    const direct = translations[lang];
+    if (typeof direct === "string" && direct.trim().length > 0)
+        return direct;
+    for (const fb of ["en", "us"]) {
+        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 : "";
+};
+exports.getLocalizedValue = getLocalizedValue;
+const packageError = (detail) => ({
+    kind: "package_error",
+    error: { detail },
+});
+const langError = (lang, detail) => ({
+    kind: "lang_error",
+    lang,
+    error: { detail },
+});
+const errorDetail = (error) => {
+    const err = error;
+    if (typeof (err === null || err === void 0 ? void 0 : err.detail) === "string")
+        return err.detail;
+    if (typeof (err === null || err === void 0 ? void 0 : err.message) === "string")
+        return err.message;
+    try {
+        return JSON.stringify(err);
+    }
+    catch (_a) {
+        return String(err);
+    }
+};
+/**
+ * Synchronises every language of a package with Breathecode.
+ * @param input - Tokens, package data, deploy url and readme provider.
+ * @returns Per-language errors (the publish itself is never blocked), warnings worth logging, and what was written.
+ */
+async function syncPackageAssets(input) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    const warnings = [];
+    const errors = [];
+    const synced = [];
+    const user = await api_1.default.validateToken(input.bcToken);
+    if (!user || typeof user.id !== "number") {
+        return {
+            errors: [packageError("Invalid Breathecode token; assets not synced.")],
+            warnings,
+            synced,
+        };
+    }
+    const resolution = (_a = input.resolution) !== null && _a !== void 0 ? _a : (await (0, assetResolver_1.resolvePackageAssets)({
+        bcToken: input.bcToken,
+        rigoToken: input.rigoToken,
+        packageSlug: input.packageSlug,
+        learnJson: input.learnJson,
+    }));
+    warnings.push(...resolution.warnings);
+    if (resolution.packageState === "unknown") {
+        return {
+            errors: [
+                packageError(`${(_b = resolution.packageError) !== null && _b !== void 0 ? _b : "Existing assets could not be checked"}; nothing was created or updated to avoid duplicates.`),
+            ],
+            warnings,
+            synced,
+        };
+    }
+    const learnpackId = resolution.learnpackId;
+    if (learnpackId === null) {
+        return {
+            errors: [
+                packageError("Could not resolve Learnpack package id; assets not synced to Breathecode."),
+            ],
+            warnings,
+            synced,
+        };
+    }
+    // Decide every language before touching anything, so all_translations can
+    // name the full set up front (the PUT replaces the relation, it does not add).
+    const langs = (0, assetResolver_1.dedupeLangs)((0, assetResolver_1.getAvailableLangs)(input.learnJson));
+    const plans = [];
+    for (const lang of langs) {
+        const title = (0, exports.getLocalizedValue)((_c = input.learnJson) === null || _c === void 0 ? void 0 : _c.title, lang);
+        if (!title) {
+            plans.push({
+                lang,
+                kind: "skip",
+                detail: `Missing learn.json title for language "${lang}"`,
+            });
+            continue;
+        }
+        const entry = resolution.byLang.get((0, assetResolver_1.canonicalLang)(lang));
+        if (!entry || entry.status === "unknown") {
+            plans.push({
+                lang,
+                kind: "skip",
+                detail: `${(entry === null || entry === void 0 ? void 0 : entry.status) === "unknown" ?
+                    entry.error :
+                    "Existing asset could not be checked"}; nothing was created or updated for this language to avoid duplicates.`,
+            });
+        }
+        else if (entry.status === "ambiguous") {
+            plans.push({
+                lang,
+                kind: "skip",
+                detail: (0, assetResolver_1.describeAmbiguity)(lang, entry.candidates),
+            });
+        }
+        else if (entry.status === "found") {
+            if (entry.asset.ownerId !== null && entry.asset.ownerId !== user.id) {
+                plans.push({
+                    lang,
+                    kind: "skip",
+                    detail: `Asset #${entry.asset.id} ${entry.asset.slug} belongs to another user (owner ${entry.asset.ownerId}); it was not updated and no duplicate was created.`,
+                });
+            }
+            else {
+                plans.push({
+                    lang,
+                    kind: "update",
+                    asset: entry.asset,
+                    slug: entry.asset.slug,
+                });
+            }
+        }
+        else {
+            plans.push({ lang, kind: "create", slug: (0, creatorUtilities_1.buildAssetSlug)(title, lang) });
+        }
+    }
+    const allTranslations = plans
+        .filter(p => p.kind !== "skip")
+        .map(p => p.slug);
+    const rigoToken = input.rigoToken.trim();
+    const createdOrUpdatedIds = [];
+    for (const plan of plans) {
+        if (plan.kind === "skip") {
+            errors.push(langError(plan.lang, plan.detail));
+            continue;
+        }
+        const title = (0, exports.getLocalizedValue)((_d = input.learnJson) === null || _d === void 0 ? void 0 : _d.title, plan.lang);
+        const description = (0, exports.getLocalizedValue)((_e = input.learnJson) === null || _e === void 0 ? void 0 : _e.description, plan.lang);
+        try {
+            if (plan.kind === "update") {
+                // Never send lang or slug: the language of an existing asset is not
+                // ours to change, and a slug would rename it.
+                const updatePayload = {
+                    graded: true,
+                    learnpack_deploy_url: input.deployUrl,
+                    title,
+                    category: "uncategorized",
+                    description,
+                    all_translations: allTranslations,
+                    learnpack_id: learnpackId,
+                };
+                if (plan.asset.academyId === null && input.academyId !== undefined) {
+                    updatePayload.academy_id = input.academyId;
+                }
+                console_1.default.info(`Asset exists for "${plan.lang}" (#${plan.asset.id} ${plan.slug}), updating it`);
+                // eslint-disable-next-line no-await-in-loop
+                const asset = await api_1.default.updateAsset(input.bcToken, plan.asset.id, updatePayload);
+                const id = typeof (asset === null || asset === void 0 ? void 0 : asset.id) === "number" ? asset.id : plan.asset.id;
+                createdOrUpdatedIds.push(id);
+                synced.push({
+                    lang: plan.lang,
+                    action: "updated",
+                    asset: { id, slug: (_f = asset === null || asset === void 0 ? void 0 : asset.slug) !== null && _f !== void 0 ? _f : plan.slug },
+                });
+                continue;
+            }
+            // eslint-disable-next-line no-await-in-loop
+            const readme = await input.readReadme(plan.lang);
+            const assetPayload = {
+                slug: plan.slug,
+                title,
+                lang: plan.lang,
+                graded: true,
+                description,
+                learnpack_deploy_url: input.deployUrl,
+                technologies: [],
+                url: input.deployUrl,
+                category: "uncategorized",
+                owner: user.id,
+                author: user.id,
+                preview: (_g = input.learnJson) === null || _g === void 0 ? void 0 : _g.preview,
+                readme_raw: Buffer.from(readme).toString("base64"),
+                all_translations: allTranslations,
+                learnpack_id: learnpackId,
+            };
+            if (input.academyId !== undefined) {
+                assetPayload.academy_id = input.academyId;
+            }
+            console_1.default.info(`No asset for "${plan.lang}", creating ${plan.slug}`);
+            // eslint-disable-next-line no-await-in-loop
+            const asset = await api_1.default.createAsset(input.bcToken, assetPayload);
+            createdOrUpdatedIds.push(asset.id);
+            synced.push({
+                lang: plan.lang,
+                action: "created",
+                asset: { id: asset.id, slug: (_h = asset.slug) !== null && _h !== void 0 ? _h : plan.slug },
+            });
+            // Record the id right away: a stale Breathecode cache could hide the
+            // new slug from the next publish, but the id never lies.
+            try {
+                // eslint-disable-next-line no-await-in-loop
+                await api_1.default.updateRigoPackage(rigoToken, input.packageSlug, {
+                    asset_id: asset.id,
+                });
+            }
+            catch (error) {
+                warnings.push(`Could not record asset #${asset.id} in the Rigobot package: ${errorDetail(error)}`);
+            }
+        }
+        catch (error) {
+            const errorData = error && typeof error === "object" && "response" in error ?
+                ((_j = error.response) === null || _j === void 0 ? void 0 : _j.data) || error :
+                error;
+            console_1.default.error(`Error syncing asset for language ${plan.lang}:`, error);
+            errors.push(langError(plan.lang, errorDetail(errorData)));
+        }
+    }
+    // Final list: everything Rigobot knew that still exists and is ours, plus
+    // whatever this run touched. Ids that 404 or belong to another package are
+    // the only ones that fall off; duplicates awaiting a manual decision stay.
+    const finalIds = [
+        ...new Set([
+            ...resolution.knownAssetIds,
+            ...resolution.orphanIds,
+            ...createdOrUpdatedIds,
+        ]),
+    ];
+    try {
+        await api_1.default.updateRigoPackage(rigoToken, input.packageSlug, {
+            asset_ids: finalIds,
+        });
+    }
+    catch (error) {
+        warnings.push(`Could not write asset_ids ${JSON.stringify(finalIds)} to the Rigobot package: ${errorDetail(error)}`);
+    }
+    return { errors, warnings, synced };
+}

package/lib/utils/branding.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Branding used by link previews (Open Graph / Twitter cards).
+ *
+ * Both the draft server and the publish pipeline need an absolute image URL for
+ * `og:image`, and drafts additionally need copy that says nothing about the
+ * course they belong to.
+ */
+/**
+ * Where `learnpack serve` runs in production. It is only a fallback: the server
+ * itself already has the real origin in `process.env.HOST` (it uses it to build
+ * webhook URLs). The `publish` command, however, runs on the author's machine
+ * with no such variable, and still has to write an absolute `og:image` into the
+ * package it uploads.
+ */
+export declare const PRODUCTION_PUBLIC_HOST = "https://app.learnpack.co";
+/**
+ * Public origin of the app server, without a trailing slash.
+ *
+ * Only an absolute http(s) origin is accepted. `HOST` is also the conventional
+ * name for a bind address, so a deployment that sets it to `0.0.0.0` would
+ * otherwise yield a relative `og:image` — which no crawler can resolve, and
+ * which would be baked into every package published from that machine.
+ * @returns The origin to build absolute preview URLs from.
+ */
+export declare function getPublicHost(): string;
+/**
+ * Neutral brand card, used as `og:image` when a course has no preview of its own.
+ *
+ * It has to be a raster image: no unfurl crawler renders SVG. The previous
+ * fallback pointed at `learnpack.svg` on raw.githubusercontent.com, which fails
+ * twice over — SVG is unsupported, and that host serves it as `text/plain` with
+ * `X-Content-Type-Options: nosniff`.
+ */
+export declare function getFallbackPreviewUrl(): string;
+/**
+ * Copy for the link preview of a draft course.
+ *
+ * A draft is unlisted work in progress, so the card carries branding only: it
+ * must not disclose the title, the description or anything else about the
+ * course, and the pages that use it are served `noindex`.
+ */
+export declare const DRAFT_PREVIEW_TITLE = "LearnPack \u2014 Draft course";
+export declare const DRAFT_PREVIEW_DESCRIPTION = "This course is still a draft and is not published yet.";

package/lib/utils/branding.js

@@ -0,0 +1,75 @@
+"use strict";
+/**
+ * Branding used by link previews (Open Graph / Twitter cards).
+ *
+ * Both the draft server and the publish pipeline need an absolute image URL for
+ * `og:image`, and drafts additionally need copy that says nothing about the
+ * course they belong to.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DRAFT_PREVIEW_DESCRIPTION = exports.DRAFT_PREVIEW_TITLE = exports.PRODUCTION_PUBLIC_HOST = void 0;
+exports.getPublicHost = getPublicHost;
+exports.getFallbackPreviewUrl = getFallbackPreviewUrl;
+/**
+ * Where `learnpack serve` runs in production. It is only a fallback: the server
+ * itself already has the real origin in `process.env.HOST` (it uses it to build
+ * webhook URLs). The `publish` command, however, runs on the author's machine
+ * with no such variable, and still has to write an absolute `og:image` into the
+ * package it uploads.
+ */
+exports.PRODUCTION_PUBLIC_HOST = "https://app.learnpack.co";
+/**
+ * Strips what `.env` files routinely smuggle in — a trailing comment, quotes,
+ * stray whitespace, a trailing slash — the same way `serve` sanitises `HOST`.
+ * @param raw - The raw environment value, if set.
+ * @returns The cleaned value, or an empty string.
+ */
+function normalizeOrigin(raw) {
+    if (!raw) {
+        return "";
+    }
+    return raw
+        .trim()
+        .split(/\s+#/)[0]
+        .trim()
+        .replace(/["']/g, "")
+        .replace(/\/+$/, "");
+}
+/**
+ * Public origin of the app server, without a trailing slash.
+ *
+ * Only an absolute http(s) origin is accepted. `HOST` is also the conventional
+ * name for a bind address, so a deployment that sets it to `0.0.0.0` would
+ * otherwise yield a relative `og:image` — which no crawler can resolve, and
+ * which would be baked into every package published from that machine.
+ * @returns The origin to build absolute preview URLs from.
+ */
+function getPublicHost() {
+    for (const raw of [process.env.PUBLIC_HOST, process.env.HOST]) {
+        const cleaned = normalizeOrigin(raw);
+        if (/^https?:\/\/\S+$/.test(cleaned)) {
+            return cleaned;
+        }
+    }
+    return exports.PRODUCTION_PUBLIC_HOST;
+}
+/**
+ * Neutral brand card, used as `og:image` when a course has no preview of its own.
+ *
+ * It has to be a raster image: no unfurl crawler renders SVG. The previous
+ * fallback pointed at `learnpack.svg` on raw.githubusercontent.com, which fails
+ * twice over — SVG is unsupported, and that host serves it as `text/plain` with
+ * `X-Content-Type-Options: nosniff`.
+ */
+function getFallbackPreviewUrl() {
+    return `${getPublicHost()}/og-image.png`;
+}
+/**
+ * Copy for the link preview of a draft course.
+ *
+ * A draft is unlisted work in progress, so the card carries branding only: it
+ * must not disclose the title, the description or anything else about the
+ * course, and the pages that use it are served `noindex`.
+ */
+exports.DRAFT_PREVIEW_TITLE = "LearnPack — Draft course";
+exports.DRAFT_PREVIEW_DESCRIPTION = "This course is still a draft and is not published yet.";

package/lib/utils/creatorUtilities.d.ts

@@ -27,6 +27,7 @@ export declare function checkReadability(markdown: string, wordsPerMinute?: numb
     fkglResult: TFKGLResult;
 };
 export declare const slugify: (text: string) => string;
+export declare const buildAssetSlug: (title: string, lang: string) => string;
 export declare const getExInfo: (title: string) => {
     exNumber: string;
     kind: string;

package/lib/utils/creatorUtilities.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getReadmeExtension = exports.appendAIRules = exports.appendContentIndex = exports.saveTranslatedReadme = exports.makePackageInfo = exports.getExInfo = exports.slugify = exports.estimateReadingTime = void 0;
+exports.getReadmeExtension = exports.appendAIRules = exports.appendContentIndex = exports.saveTranslatedReadme = exports.makePackageInfo = exports.getExInfo = exports.buildAssetSlug = exports.slugify = exports.estimateReadingTime = void 0;
 exports.checkReadability = checkReadability;
 exports.extractImagesFromMarkdown = extractImagesFromMarkdown;
 exports.getFilenameFromUrl = getFilenameFromUrl;
@@ -98,6 +98,22 @@ const slugify = (text) => {
         .replace(/^-+|-+$/g, ""); // Trim hyphens from start/end
 };
 exports.slugify = slugify;
+// Builds the slug of the Breathecode asset for a given title and language.
+// The backend only accepts letters, numbers, underscores and hyphens, so the
+// periods that slugify() keeps (e.g. "Next.js") are turned into hyphens here.
+// Hyphens are collapsed and trimmed BEFORE the 47-char cut on purpose: for a
+// title without periods this must yield exactly slugify(title).slice(0, 47),
+// which is the slug every existing asset was created with (a trailing hyphen
+// left by the cut is part of that historical slug and is kept).
+const buildAssetSlug = (title, lang) => {
+    const slug = (0, exports.slugify)(title)
+        .replace(/\./g, "-")
+        .replace(/-+/g, "-")
+        .replace(/^-+|-+$/g, "")
+        .slice(0, 47);
+    return `${slug}-${lang}`;
+};
+exports.buildAssetSlug = buildAssetSlug;
 const getExInfo = (title) => {
     // Example title: '1.0 - Introduction to AI [READ: Small introduction to important concepts such as AI, machine learning, and their applications]'
     let [exNumber, exTitle] = title.split(" - ");

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.357",
+  "version": "5.0.359",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {
@@ -166,7 +166,7 @@
     "audit:package-sources": "ts-node --project ./tsconfig.json ./scripts/audit-package-sources.ts",
     "backfill:package-manifest": "ts-node --project ./tsconfig.json ./scripts/backfill-package-manifest-s3.ts",
     "repair:legacy-packages": "ts-node --project ./tsconfig.json ./scripts/repair-legacy-packages.ts",
-    "copy-assets": "npx cpy src/creatorDist/**/* lib/creatorDist --parents --verbose && npx cpy src/utils/templates/**/* lib/utils/templates --parents --verbose && npx cpy src/lua/**/* lib/lua --parents --verbose",
+    "copy-assets": "npx cpy src/creatorDist/**/* lib/creatorDist --parents --verbose && npx cpy src/utils/templates/**/* lib/utils/templates --parents --verbose && npx cpy src/lua/**/* lib/lua --parents --verbose && npx cpy src/ui/static/**/* lib/ui/static --parents --verbose",
     "tsc": "tsc -b",
     "postpack": "rm -f oclif.manifest.json && eslint . --ext .ts --config .eslintrc",
     "prepack": "rm -rf lib && tsc -b && npm run copy-assets",