@myst-theme/common 0.4.1

package/README.md

@@ -0,0 +1,3 @@
+# @myst-theme/common
+
+Common utilities and types for working with the MyST Theme and sites

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './utils.js';
+export * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './utils.js';
+export * from './types.js';

package/dist/types.d.ts

@@ -0,0 +1,54 @@
+import type { Root } from 'mdast';
+import type { Dependency, SourceFileKind } from 'myst-spec-ext';
+import type { References } from 'myst-common';
+import type { SiteManifest } from 'myst-config';
+import type { PageFrontmatter } from 'myst-frontmatter';
+export declare enum Theme {
+    light = "light",
+    dark = "dark"
+}
+export declare enum ErrorStatus {
+    noSite = "Site was not found",
+    noArticle = "Article was not found"
+}
+export type Heading = {
+    slug?: string;
+    path?: string;
+    title: string;
+    short_title?: string;
+    level: number | 'index';
+    group?: string;
+};
+export type SiteLoader = {
+    theme: Theme;
+    config?: SiteManifest;
+    CONTENT_CDN_PORT?: string | number;
+    MODE?: 'app' | 'static';
+    BASE_URL?: string;
+};
+export type NavigationLink = {
+    group?: string;
+    title: string;
+    url: string;
+    short_title?: string;
+};
+export type FooterLinks = {
+    navigation?: {
+        prev?: NavigationLink;
+        next?: NavigationLink;
+    };
+};
+export type PageLoader = {
+    kind: SourceFileKind;
+    file: string;
+    sha256: string;
+    slug: string;
+    domain: string;
+    project: string;
+    frontmatter: PageFrontmatter;
+    mdast: Root;
+    references: References;
+    footer?: FooterLinks;
+    dependencies?: Dependency[];
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD,oBAAY,KAAK;IACf,KAAK,UAAU;IACf,IAAI,SAAS;CACd;AAED,oBAAY,WAAW;IACrB,MAAM,uBAAuB;IAC7B,SAAS,0BAA0B;CACpC;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,IAAI,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,UAAU,CAAC,EAAE;QACX,IAAI,CAAC,EAAE,cAAc,CAAC;QACtB,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,eAAe,CAAC;IAC7B,KAAK,EAAE,IAAI,CAAC;IACZ,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB,YAAY,CAAC,EAAE,UAAU,EAAE,CAAC;CAC7B,CAAC"}

package/dist/types.js

@@ -0,0 +1,10 @@
+export var Theme;
+(function (Theme) {
+    Theme["light"] = "light";
+    Theme["dark"] = "dark";
+})(Theme || (Theme = {}));
+export var ErrorStatus;
+(function (ErrorStatus) {
+    ErrorStatus["noSite"] = "Site was not found";
+    ErrorStatus["noArticle"] = "Article was not found";
+})(ErrorStatus || (ErrorStatus = {}));

package/dist/utils.d.ts

@@ -0,0 +1,14 @@
+import type { SiteManifest } from 'myst-config';
+import type { FooterLinks, Heading, PageLoader } from './types.js';
+type ManifestProject = Required<SiteManifest>['projects'][0];
+export declare function getProject(config?: SiteManifest, projectSlug?: string): ManifestProject | undefined;
+export declare function getProjectHeadings(config: SiteManifest, projectSlug?: string, opts?: {
+    addGroups: boolean;
+}): Heading[] | undefined;
+export declare function getFooterLinks(config?: SiteManifest, projectSlug?: string, slug?: string): FooterLinks;
+type UpdateUrl = (url: string) => string;
+export declare function updateSiteManifestStaticLinksInplace(data: SiteManifest, updateUrl: UpdateUrl): SiteManifest;
+export declare function updatePageStaticLinksInplace(data: PageLoader, updateUrl: UpdateUrl): PageLoader;
+export declare function isFlatSite(config?: SiteManifest): boolean;
+export {};
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAGhD,OAAO,KAAK,EAAE,WAAW,EAAE,OAAO,EAAkB,UAAU,EAAE,MAAM,YAAY,CAAC;AAMnF,KAAK,eAAe,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAG7D,wBAAgB,UAAU,CACxB,MAAM,CAAC,EAAE,YAAY,EACrB,WAAW,CAAC,EAAE,MAAM,GACnB,eAAe,GAAG,SAAS,CAK7B;AAED,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,YAAY,EACpB,WAAW,CAAC,EAAE,MAAM,EACpB,IAAI,GAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAyB,GAClD,OAAO,EAAE,GAAG,SAAS,CA0BvB;AAeD,wBAAgB,cAAc,CAC5B,MAAM,CAAC,EAAE,YAAY,EACrB,WAAW,CAAC,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,MAAM,GACZ,WAAW,CAab;AAED,KAAK,SAAS,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;AAEzC,wBAAgB,oCAAoC,CAClD,IAAI,EAAE,YAAY,EAClB,SAAS,EAAE,SAAS,GACnB,YAAY,CA6Bd;AAED,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,UAAU,CA4C/F;AAED,wBAAgB,UAAU,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAEzD"}

package/dist/utils.js

@@ -0,0 +1,164 @@
+import { walkOutputs } from 'nbtx';
+import { selectAll } from 'unist-util-select';
+export function getProject(config, projectSlug) {
+    var _a, _b;
+    if (!config)
+        return undefined;
+    if (!projectSlug)
+        return (_a = config.projects) === null || _a === void 0 ? void 0 : _a[0];
+    const project = (_b = config.projects) === null || _b === void 0 ? void 0 : _b.find((p) => p.slug === projectSlug);
+    return project;
+}
+export function getProjectHeadings(config, projectSlug, opts = { addGroups: false }) {
+    const project = getProject(config, projectSlug);
+    if (!project)
+        return undefined;
+    const headings = [
+        {
+            title: project.title,
+            short_title: project.short_title,
+            slug: project.index,
+            path: project.slug ? `/${project.slug}` : '/',
+            level: 'index',
+        },
+        ...project.pages.map((p) => {
+            if (!('slug' in p))
+                return p;
+            return { ...p, path: projectSlug ? `/${project.slug}/${p.slug}` : `/${p.slug}` };
+        }),
+    ];
+    if (opts.addGroups) {
+        let lastTitle = project.short_title || project.title;
+        return headings.map((heading) => {
+            if (!heading.slug || heading.level === 'index') {
+                lastTitle = heading.short_title || heading.title;
+            }
+            return { ...heading, group: lastTitle };
+        });
+    }
+    return headings;
+}
+function getHeadingLink(currentSlug, headings) {
+    if (!headings)
+        return undefined;
+    const linkIndex = headings.findIndex(({ slug }) => !!slug && slug !== currentSlug);
+    const link = headings[linkIndex];
+    if (!(link === null || link === void 0 ? void 0 : link.path))
+        return undefined;
+    return {
+        title: link.title,
+        short_title: link.short_title,
+        url: link.path,
+        group: link.group,
+    };
+}
+export function getFooterLinks(config, projectSlug, slug) {
+    var _a;
+    if (!slug || !config)
+        return {};
+    const pages = getProjectHeadings(config, projectSlug, {
+        addGroups: true,
+    });
+    const found = (_a = pages === null || pages === void 0 ? void 0 : pages.findIndex(({ slug: s }) => s === slug)) !== null && _a !== void 0 ? _a : -1;
+    if (found === -1)
+        return {};
+    const prev = getHeadingLink(slug, pages === null || pages === void 0 ? void 0 : pages.slice(0, found).reverse());
+    const next = getHeadingLink(slug, pages === null || pages === void 0 ? void 0 : pages.slice(found + 1));
+    const footer = {
+        navigation: { prev, next },
+    };
+    return footer;
+}
+export function updateSiteManifestStaticLinksInplace(data, updateUrl) {
+    var _a, _b;
+    (_a = data.actions) === null || _a === void 0 ? void 0 : _a.forEach((action) => {
+        if (!action.static)
+            return;
+        action.url = updateUrl(action.url);
+    });
+    // TODO: this needs to be based on the template.yml in the future
+    if (data.logo)
+        data.logo = updateUrl(data.logo);
+    if (data.logo_dark)
+        data.logo_dark = updateUrl(data.logo_dark);
+    // Update the thumbnails to point at the CDN
+    (_b = data.projects) === null || _b === void 0 ? void 0 : _b.forEach((project) => {
+        if (project.banner)
+            project.banner = updateUrl(project.banner);
+        if (project.bannerOptimized)
+            project.bannerOptimized = updateUrl(project.bannerOptimized);
+        if (project.thumbnail)
+            project.thumbnail = updateUrl(project.thumbnail);
+        if (project.thumbnailOptimized)
+            project.thumbnailOptimized = updateUrl(project.thumbnailOptimized);
+        if (project === null || project === void 0 ? void 0 : project.exports) {
+            project.exports = project.exports.map((exp) => {
+                if (!exp.url)
+                    return exp;
+                return { ...exp, url: updateUrl(exp.url) };
+            });
+        }
+        project.pages
+            .filter((page) => 'slug' in page)
+            .forEach((page) => {
+            if (page.thumbnail)
+                page.thumbnail = updateUrl(page.thumbnail);
+            if (page.thumbnailOptimized)
+                page.thumbnailOptimized = updateUrl(page.thumbnailOptimized);
+        });
+    });
+    return data;
+}
+export function updatePageStaticLinksInplace(data, updateUrl) {
+    var _a, _b, _c, _d, _e;
+    if ((_a = data === null || data === void 0 ? void 0 : data.frontmatter) === null || _a === void 0 ? void 0 : _a.thumbnail) {
+        data.frontmatter.thumbnail = updateUrl(data.frontmatter.thumbnail);
+    }
+    if ((_b = data === null || data === void 0 ? void 0 : data.frontmatter) === null || _b === void 0 ? void 0 : _b.thumbnailOptimized) {
+        data.frontmatter.thumbnailOptimized = updateUrl(data.frontmatter.thumbnailOptimized);
+    }
+    if ((_c = data === null || data === void 0 ? void 0 : data.frontmatter) === null || _c === void 0 ? void 0 : _c.banner) {
+        data.frontmatter.banner = updateUrl(data.frontmatter.banner);
+    }
+    if ((_d = data === null || data === void 0 ? void 0 : data.frontmatter) === null || _d === void 0 ? void 0 : _d.bannerOptimized) {
+        data.frontmatter.bannerOptimized = updateUrl(data.frontmatter.bannerOptimized);
+    }
+    if ((_e = data === null || data === void 0 ? void 0 : data.frontmatter) === null || _e === void 0 ? void 0 : _e.exports) {
+        data.frontmatter.exports = data.frontmatter.exports.map((exp) => {
+            if (!exp.url)
+                return exp;
+            return { ...exp, url: updateUrl(exp.url) };
+        });
+    }
+    // Fix all of the images to point to the CDN
+    const images = selectAll('image', data.mdast);
+    images.forEach((node) => {
+        node.url = updateUrl(node.url);
+        if (node.urlOptimized) {
+            node.urlOptimized = updateUrl(node.urlOptimized);
+        }
+    });
+    const links = selectAll('link,linkBlock,card', data.mdast);
+    const staticLinks = links.filter((node) => node.static);
+    staticLinks.forEach((node) => {
+        // These are static links to thinks like PDFs or other referenced files
+        node.url = updateUrl(node.url);
+    });
+    const outputs = selectAll('output', data.mdast);
+    outputs.forEach((node) => {
+        if (!node.data)
+            return;
+        walkOutputs(node.data, (obj) => {
+            // The path will be defined from output of myst
+            // Here we are re-assigning it to the current domain
+            if (!obj.path)
+                return;
+            obj.path = updateUrl(obj.path);
+        });
+    });
+    return data;
+}
+export function isFlatSite(config) {
+    var _a;
+    return ((_a = config === null || config === void 0 ? void 0 : config.projects) === null || _a === void 0 ? void 0 : _a.length) === 1 && !config.projects[0].slug;
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@myst-theme/common",
+  "version": "0.4.1",
+  "type": "module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "license": "MIT",
+  "sideEffects": false,
+  "scripts": {
+    "clean": "rimraf dist",
+    "lint": "eslint \"src/**/*.ts*\" -c ./.eslintrc.cjs",
+    "lint:format": "prettier --check \"src/**/*.{ts,tsx,md}\"",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "build:esm": "tsc --project ./tsconfig.json --module es2015   --outDir dist --declaration",
+    "build": "npm-run-all -l clean -p build:esm"
+  },
+  "dependencies": {
+    "myst-common": "^1.1.0",
+    "myst-config": "^1.1.0",
+    "myst-spec-ext": "^1.1.0",
+    "nbtx": "^0.2.3",
+    "unist-util-select": "^4.0.3"
+  }
+}