@docusaurus/utils 2.0.0-beta.15a2b59f9 → 2.0.0-beta.17

package/lib/tags.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export declare type Tag = {
+    label: string;
+    permalink: string;
+};
+export declare type FrontMatterTag = string | Tag;
+export declare function normalizeFrontMatterTag(tagsPath: string, frontMatterTag: FrontMatterTag): Tag;
+export declare function normalizeFrontMatterTags(tagsPath: string, frontMatterTags?: FrontMatterTag[] | undefined): Tag[];
+export declare type TaggedItemGroup<Item> = {
+    tag: Tag;
+    items: Item[];
+};
+/**
+ * Permits to group docs/blogPosts by tag (provided by front matter)
+ * Note: groups are indexed by permalink, because routes must be unique in the
+ * end. Labels may vary on 2 md files but they are normalized. Docs with
+ * label='some label' and label='some-label' should end-up in the same
+ * group/page in the end. We can't create 2 routes /some-label because one would
+ * override the other
+ */
+export declare function groupTaggedItems<Item>(items: Item[], getItemTags: (item: Item) => Tag[]): Record<string, TaggedItemGroup<Item>>;
+//# sourceMappingURL=tags.d.ts.map

package/lib/tags.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.d.ts","sourceRoot":"","sources":["../src/tags.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,oBAAY,GAAG,GAAG;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,oBAAY,cAAc,GAAG,MAAM,GAAG,GAAG,CAAC;AAE1C,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,cAAc,GAC7B,GAAG,CAyBL;AAED,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,MAAM,EAChB,eAAe,GAAE,cAAc,EAAE,GAAG,SAAc,GACjD,GAAG,EAAE,CAMP;AAED,oBAAY,eAAe,CAAC,IAAI,IAAI;IAClC,GAAG,EAAE,GAAG,CAAC;IACT,KAAK,EAAE,IAAI,EAAE,CAAC;CACf,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EACnC,KAAK,EAAE,IAAI,EAAE,EACb,WAAW,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,GAAG,EAAE,GACjC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC,CA8BvC"}

package/lib/tags.js

@@ -0,0 +1,76 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.groupTaggedItems = exports.normalizeFrontMatterTags = exports.normalizeFrontMatterTag = void 0;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const urlUtils_1 = require("./urlUtils");
+function normalizeFrontMatterTag(tagsPath, frontMatterTag) {
+    function toTagObject(tagString) {
+        return {
+            label: tagString,
+            permalink: lodash_1.default.kebabCase(tagString),
+        };
+    }
+    // TODO maybe make ensure the permalink is valid url path?
+    function normalizeTagPermalink(permalink) {
+        // note: we always apply tagsPath on purpose. For versioned docs, v1/doc.md
+        // and v2/doc.md tags with custom permalinks don't lead to the same created
+        // page. tagsPath is different for each doc version
+        return (0, urlUtils_1.normalizeUrl)([tagsPath, permalink]);
+    }
+    const tag = typeof frontMatterTag === 'string'
+        ? toTagObject(frontMatterTag)
+        : frontMatterTag;
+    return {
+        label: tag.label,
+        permalink: normalizeTagPermalink(tag.permalink),
+    };
+}
+exports.normalizeFrontMatterTag = normalizeFrontMatterTag;
+function normalizeFrontMatterTags(tagsPath, frontMatterTags = []) {
+    const tags = frontMatterTags.map((tag) => normalizeFrontMatterTag(tagsPath, tag));
+    return lodash_1.default.uniqBy(tags, (tag) => tag.permalink);
+}
+exports.normalizeFrontMatterTags = normalizeFrontMatterTags;
+/**
+ * Permits to group docs/blogPosts by tag (provided by front matter)
+ * Note: groups are indexed by permalink, because routes must be unique in the
+ * end. Labels may vary on 2 md files but they are normalized. Docs with
+ * label='some label' and label='some-label' should end-up in the same
+ * group/page in the end. We can't create 2 routes /some-label because one would
+ * override the other
+ */
+function groupTaggedItems(items, getItemTags) {
+    const result = {};
+    function handleItemTag(item, tag) {
+        // Init missing tag groups
+        // TODO: it's not really clear what should be the behavior if 2 items have
+        // the same tag but the permalink is different for each
+        // For now, the first tag found wins
+        result[tag.permalink] = result[tag.permalink] ?? {
+            tag,
+            items: [],
+        };
+        // Add item to group
+        result[tag.permalink].items.push(item);
+    }
+    items.forEach((item) => {
+        getItemTags(item).forEach((tag) => {
+            handleItemTag(item, tag);
+        });
+    });
+    // If user add twice the same tag to a md doc (weird but possible),
+    // we don't want the item to appear twice in the list...
+    Object.values(result).forEach((group) => {
+        group.items = lodash_1.default.uniq(group.items);
+    });
+    return result;
+}
+exports.groupTaggedItems = groupTaggedItems;
+//# sourceMappingURL=tags.js.map

package/lib/tags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.js","sourceRoot":"","sources":["../src/tags.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,4DAAuB;AACvB,yCAAwC;AASxC,SAAgB,uBAAuB,CACrC,QAAgB,EAChB,cAA8B;IAE9B,SAAS,WAAW,CAAC,SAAiB;QACpC,OAAO;YACL,KAAK,EAAE,SAAS;YAChB,SAAS,EAAE,gBAAC,CAAC,SAAS,CAAC,SAAS,CAAC;SAClC,CAAC;IACJ,CAAC;IAED,0DAA0D;IAC1D,SAAS,qBAAqB,CAAC,SAAiB;QAC9C,2EAA2E;QAC3E,2EAA2E;QAC3E,mDAAmD;QACnD,OAAO,IAAA,uBAAY,EAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,GAAG,GACP,OAAO,cAAc,KAAK,QAAQ;QAChC,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC;QAC7B,CAAC,CAAC,cAAc,CAAC;IAErB,OAAO;QACL,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,SAAS,EAAE,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC;KAChD,CAAC;AACJ,CAAC;AA5BD,0DA4BC;AAED,SAAgB,wBAAwB,CACtC,QAAgB,EAChB,kBAAgD,EAAE;IAElD,MAAM,IAAI,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACvC,uBAAuB,CAAC,QAAQ,EAAE,GAAG,CAAC,CACvC,CAAC;IAEF,OAAO,gBAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAChD,CAAC;AATD,4DASC;AAOD;;;;;;;GAOG;AACH,SAAgB,gBAAgB,CAC9B,KAAa,EACb,WAAkC;IAElC,MAAM,MAAM,GAA0C,EAAE,CAAC;IAEzD,SAAS,aAAa,CAAC,IAAU,EAAE,GAAQ;QACzC,0BAA0B;QAC1B,0EAA0E;QAC1E,uDAAuD;QACvD,oCAAoC;QACpC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI;YAC/C,GAAG;YACH,KAAK,EAAE,EAAE;SACV,CAAC;QAEF,oBAAoB;QACpB,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAChC,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,mEAAmE;IACnE,wDAAwD;IACxD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACtC,KAAK,CAAC,KAAK,GAAG,gBAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAjCD,4CAiCC"}

package/lib/urlUtils.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export declare function normalizeUrl(rawUrls: string[]): string;
+export declare function getEditUrl(fileRelativePath: string, editUrl?: string): string | undefined;
+/**
+ * Convert filepath to url path.
+ * Example: 'index.md' -> '/', 'foo/bar.js' -> '/foo/bar',
+ */
+export declare function fileToPath(file: string): string;
+export declare function encodePath(userPath: string): string;
+export declare function isValidPathname(str: string): boolean;
+export declare function resolvePathname(to: string, from?: string): string;
+export declare function addLeadingSlash(str: string): string;
+export declare function addTrailingSlash(str: string): string;
+export declare function removeTrailingSlash(str: string): string;
+//# sourceMappingURL=urlUtils.d.ts.map

package/lib/urlUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"urlUtils.d.ts","sourceRoot":"","sources":["../src/urlUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CA8EtD;AAED,wBAAgB,UAAU,CACxB,gBAAgB,EAAE,MAAM,EACxB,OAAO,CAAC,EAAE,MAAM,GACf,MAAM,GAAG,SAAS,CAKpB;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQ/C;AAED,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAKnD;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAWpD;AAGD,wBAAgB,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAEjE;AACD,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEnD;AAGD,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEpD;AACD,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEvD"}

package/lib/urlUtils.js

@@ -0,0 +1,136 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeTrailingSlash = exports.addTrailingSlash = exports.addLeadingSlash = exports.resolvePathname = exports.isValidPathname = exports.encodePath = exports.fileToPath = exports.getEditUrl = exports.normalizeUrl = void 0;
+const tslib_1 = require("tslib");
+const jsUtils_1 = require("./jsUtils");
+const resolve_pathname_1 = tslib_1.__importDefault(require("resolve-pathname"));
+function normalizeUrl(rawUrls) {
+    const urls = [...rawUrls];
+    const resultArray = [];
+    let hasStartingSlash = false;
+    let hasEndingSlash = false;
+    // If the first part is a plain protocol, we combine it with the next part.
+    if (urls[0].match(/^[^/:]+:\/*$/) && urls.length > 1) {
+        const first = urls.shift();
+        if (first.startsWith('file:') && urls[0].startsWith('/')) {
+            // Force a double slash here, else we lose the information that the next
+            // segment is an absolute path
+            urls[0] = `${first}//${urls[0]}`;
+        }
+        else {
+            urls[0] = first + urls[0];
+        }
+    }
+    // There must be two or three slashes in the file protocol,
+    // two slashes in anything else.
+    const replacement = urls[0].match(/^file:\/\/\//) ? '$1:///' : '$1://';
+    urls[0] = urls[0].replace(/^(?<protocol>[^/:]+):\/*/, replacement);
+    for (let i = 0; i < urls.length; i += 1) {
+        let component = urls[i];
+        if (typeof component !== 'string') {
+            throw new TypeError(`Url must be a string. Received ${typeof component}`);
+        }
+        if (component === '') {
+            if (i === urls.length - 1 && hasEndingSlash) {
+                resultArray.push('/');
+            }
+            // eslint-disable-next-line no-continue
+            continue;
+        }
+        if (component !== '/') {
+            if (i > 0) {
+                // Removing the starting slashes for each component but the first.
+                component = component.replace(/^[/]+/, 
+                // Special case where the first element of rawUrls is empty
+                // ["", "/hello"] => /hello
+                component[0] === '/' && !hasStartingSlash ? '/' : '');
+            }
+            hasEndingSlash = component[component.length - 1] === '/';
+            // Removing the ending slashes for each component but the last. For the
+            // last component we will combine multiple slashes to a single one.
+            component = component.replace(/[/]+$/, i < urls.length - 1 ? '' : '/');
+        }
+        hasStartingSlash = true;
+        resultArray.push(component);
+    }
+    let str = resultArray.join('/');
+    // Each input component is now separated by a single slash
+    // except the possible first plain protocol part.
+    // Remove trailing slash before parameters or hash.
+    str = str.replace(/\/(?<search>\?|&|#[^!])/g, '$1');
+    // Replace ? in parameters with &.
+    const parts = str.split('?');
+    str = parts.shift() + (parts.length > 0 ? '?' : '') + parts.join('&');
+    // Dedupe forward slashes in the entire path, avoiding protocol slashes.
+    str = str.replace(/(?<textBefore>[^:/]\/)\/+/g, '$1');
+    // Dedupe forward slashes at the beginning of the path.
+    str = str.replace(/^\/+/g, '/');
+    return str;
+}
+exports.normalizeUrl = normalizeUrl;
+function getEditUrl(fileRelativePath, editUrl) {
+    return editUrl
+        ? // Don't use posixPath for this: we need to force a forward slash path
+            normalizeUrl([editUrl, fileRelativePath.replace(/\\/g, '/')])
+        : undefined;
+}
+exports.getEditUrl = getEditUrl;
+/**
+ * Convert filepath to url path.
+ * Example: 'index.md' -> '/', 'foo/bar.js' -> '/foo/bar',
+ */
+function fileToPath(file) {
+    const indexRE = /(?<dirname>^|.*\/)index\.(?:mdx?|jsx?|tsx?)$/i;
+    const extRE = /\.(?:mdx?|jsx?|tsx?)$/;
+    if (indexRE.test(file)) {
+        return file.replace(indexRE, '/$1');
+    }
+    return `/${file.replace(extRE, '').replace(/\\/g, '/')}`;
+}
+exports.fileToPath = fileToPath;
+function encodePath(userPath) {
+    return userPath
+        .split('/')
+        .map((item) => encodeURIComponent(item))
+        .join('/');
+}
+exports.encodePath = encodePath;
+function isValidPathname(str) {
+    if (!str.startsWith('/')) {
+        return false;
+    }
+    try {
+        // weird, but is there a better way?
+        const parsedPathname = new URL(str, 'https://domain.com').pathname;
+        return parsedPathname === str || parsedPathname === encodeURI(str);
+    }
+    catch {
+        return false;
+    }
+}
+exports.isValidPathname = isValidPathname;
+// resolve pathname and fail fast if resolution fails
+function resolvePathname(to, from) {
+    return (0, resolve_pathname_1.default)(to, from);
+}
+exports.resolvePathname = resolvePathname;
+function addLeadingSlash(str) {
+    return str.startsWith('/') ? str : `/${str}`;
+}
+exports.addLeadingSlash = addLeadingSlash;
+// TODO deduplicate: also present in @docusaurus/utils-common
+function addTrailingSlash(str) {
+    return str.endsWith('/') ? str : `${str}/`;
+}
+exports.addTrailingSlash = addTrailingSlash;
+function removeTrailingSlash(str) {
+    return (0, jsUtils_1.removeSuffix)(str, '/');
+}
+exports.removeTrailingSlash = removeTrailingSlash;
+//# sourceMappingURL=urlUtils.js.map

package/lib/urlUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"urlUtils.js","sourceRoot":"","sources":["../src/urlUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,uCAAuC;AACvC,gFAAqD;AAErD,SAAgB,YAAY,CAAC,OAAiB;IAC5C,MAAM,IAAI,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC;IAC1B,MAAM,WAAW,GAAG,EAAE,CAAC;IAEvB,IAAI,gBAAgB,GAAG,KAAK,CAAC;IAC7B,IAAI,cAAc,GAAG,KAAK,CAAC;IAE3B,2EAA2E;IAC3E,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QACpD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,KAAM,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACzD,wEAAwE;YACxE,8BAA8B;YAC9B,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;SAClC;aAAM;YACL,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;SAC3B;KACF;IAED,2DAA2D;IAC3D,gCAAgC;IAChC,MAAM,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC;IACvE,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,0BAA0B,EAAE,WAAW,CAAC,CAAC;IAEnE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;QACvC,IAAI,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAExB,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACjC,MAAM,IAAI,SAAS,CAAC,kCAAkC,OAAO,SAAS,EAAE,CAAC,CAAC;SAC3E;QAED,IAAI,SAAS,KAAK,EAAE,EAAE;YACpB,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,cAAc,EAAE;gBAC3C,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACvB;YACD,uCAAuC;YACvC,SAAS;SACV;QAED,IAAI,SAAS,KAAK,GAAG,EAAE;YACrB,IAAI,CAAC,GAAG,CAAC,EAAE;gBACT,kEAAkE;gBAClE,SAAS,GAAG,SAAS,CAAC,OAAO,CAC3B,OAAO;gBACP,2DAA2D;gBAC3D,2BAA2B;gBAC3B,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CACrD,CAAC;aACH;YAED,cAAc,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC;YACzD,uEAAuE;YACvE,mEAAmE;YACnE,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SACxE;QAED,gBAAgB,GAAG,IAAI,CAAC;QACxB,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KAC7B;IAED,IAAI,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChC,0DAA0D;IAC1D,iDAAiD;IAEjD,mDAAmD;IACnD,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAAC;IAEpD,kCAAkC;IAClC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEtE,wEAAwE;IACxE,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,4BAA4B,EAAE,IAAI,CAAC,CAAC;IAEtD,uDAAuD;IACvD,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAEhC,OAAO,GAAG,CAAC;AACb,CAAC;AA9ED,oCA8EC;AAED,SAAgB,UAAU,CACxB,gBAAwB,EACxB,OAAgB;IAEhB,OAAO,OAAO;QACZ,CAAC,CAAC,sEAAsE;YACtE,YAAY,CAAC,CAAC,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AARD,gCAQC;AAED;;;GAGG;AACH,SAAgB,UAAU,CAAC,IAAY;IACrC,MAAM,OAAO,GAAG,+CAA+C,CAAC;IAChE,MAAM,KAAK,GAAG,uBAAuB,CAAC;IAEtC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;KACrC;IACD,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;AAC3D,CAAC;AARD,gCAQC;AAED,SAAgB,UAAU,CAAC,QAAgB;IACzC,OAAO,QAAQ;SACZ,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;SACvC,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AALD,gCAKC;AAED,SAAgB,eAAe,CAAC,GAAW;IACzC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACxB,OAAO,KAAK,CAAC;KACd;IACD,IAAI;QACF,oCAAoC;QACpC,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC,QAAQ,CAAC;QACnE,OAAO,cAAc,KAAK,GAAG,IAAI,cAAc,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC;KACpE;IAAC,MAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAXD,0CAWC;AAED,qDAAqD;AACrD,SAAgB,eAAe,CAAC,EAAU,EAAE,IAAa;IACvD,OAAO,IAAA,0BAAqB,EAAC,EAAE,EAAE,IAAI,CAAC,CAAC;AACzC,CAAC;AAFD,0CAEC;AACD,SAAgB,eAAe,CAAC,GAAW;IACzC,OAAO,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC;AAC/C,CAAC;AAFD,0CAEC;AAED,6DAA6D;AAC7D,SAAgB,gBAAgB,CAAC,GAAW;IAC1C,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;AAC7C,CAAC;AAFD,4CAEC;AACD,SAAgB,mBAAmB,CAAC,GAAW;IAC7C,OAAO,IAAA,sBAAY,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAChC,CAAC;AAFD,kDAEC"}

package/lib/webpackUtils.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { RuleSetRule } from 'webpack';
+declare type AssetFolder = 'images' | 'files' | 'fonts' | 'medias';
+declare type FileLoaderUtils = {
+    loaders: {
+        file: (options: {
+            folder: AssetFolder;
+        }) => RuleSetRule;
+        url: (options: {
+            folder: AssetFolder;
+        }) => RuleSetRule;
+        inlineMarkdownImageFileLoader: string;
+        inlineMarkdownLinkFileLoader: string;
+    };
+    rules: {
+        images: () => RuleSetRule;
+        fonts: () => RuleSetRule;
+        media: () => RuleSetRule;
+        svg: () => RuleSetRule;
+        otherAssets: () => RuleSetRule;
+    };
+};
+export declare function getFileLoaderUtils(): FileLoaderUtils;
+export {};
+//# sourceMappingURL=webpackUtils.d.ts.map

package/lib/webpackUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webpackUtils.d.ts","sourceRoot":"","sources":["../src/webpackUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AAQzC,aAAK,WAAW,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE3D,aAAK,eAAe,GAAG;IACrB,OAAO,EAAE;QACP,IAAI,EAAE,CAAC,OAAO,EAAE;YAAC,MAAM,EAAE,WAAW,CAAA;SAAC,KAAK,WAAW,CAAC;QACtD,GAAG,EAAE,CAAC,OAAO,EAAE;YAAC,MAAM,EAAE,WAAW,CAAA;SAAC,KAAK,WAAW,CAAC;QACrD,6BAA6B,EAAE,MAAM,CAAC;QACtC,4BAA4B,EAAE,MAAM,CAAC;KACtC,CAAC;IACF,KAAK,EAAE;QACL,MAAM,EAAE,MAAM,WAAW,CAAC;QAC1B,KAAK,EAAE,MAAM,WAAW,CAAC;QACzB,KAAK,EAAE,MAAM,WAAW,CAAC;QACzB,GAAG,EAAE,MAAM,WAAW,CAAC;QACvB,WAAW,EAAE,MAAM,WAAW,CAAC;KAChC,CAAC;CACH,CAAC;AAGF,wBAAgB,kBAAkB,IAAI,eAAe,CA+GpD"}

package/lib/webpackUtils.js

@@ -0,0 +1,112 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFileLoaderUtils = void 0;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const pathUtils_1 = require("./pathUtils");
+const constants_1 = require("./constants");
+// Inspired by https://github.com/gatsbyjs/gatsby/blob/8e6e021014da310b9cc7d02e58c9b3efe938c665/packages/gatsby/src/utils/webpack-utils.ts#L447
+function getFileLoaderUtils() {
+    // files/images < urlLoaderLimit will be inlined as base64 strings directly in
+    // the html
+    const urlLoaderLimit = constants_1.WEBPACK_URL_LOADER_LIMIT;
+    // defines the path/pattern of the assets handled by webpack
+    const fileLoaderFileName = (folder) => `${constants_1.OUTPUT_STATIC_ASSETS_DIR_NAME}/${folder}/[name]-[contenthash].[ext]`;
+    const loaders = {
+        file: (options) => ({
+            loader: require.resolve(`file-loader`),
+            options: {
+                name: fileLoaderFileName(options.folder),
+            },
+        }),
+        url: (options) => ({
+            loader: require.resolve('url-loader'),
+            options: {
+                limit: urlLoaderLimit,
+                name: fileLoaderFileName(options.folder),
+                fallback: require.resolve('file-loader'),
+            },
+        }),
+        // TODO avoid conflicts with the ideal-image plugin
+        // TODO this may require a little breaking change for ideal-image users?
+        // Maybe with the ideal image plugin, all md images should be "ideal"?
+        // This is used to force url-loader+file-loader on markdown images
+        // https://webpack.js.org/concepts/loaders/#inline
+        inlineMarkdownImageFileLoader: `!${(0, pathUtils_1.escapePath)(require.resolve('url-loader'))}?limit=${urlLoaderLimit}&name=${fileLoaderFileName('images')}&fallback=${(0, pathUtils_1.escapePath)(require.resolve('file-loader'))}!`,
+        inlineMarkdownLinkFileLoader: `!${(0, pathUtils_1.escapePath)(require.resolve('file-loader'))}?name=${fileLoaderFileName('files')}!`,
+    };
+    const rules = {
+        /**
+         * Loads image assets, inlines images via a data URI if they are below
+         * the size threshold
+         */
+        images: () => ({
+            use: [loaders.url({ folder: 'images' })],
+            test: /\.(?:ico|jpe?g|png|gif|webp)(?:\?.*)?$/i,
+        }),
+        fonts: () => ({
+            use: [loaders.url({ folder: 'fonts' })],
+            test: /\.(?:woff2?|eot|ttf|otf)$/i,
+        }),
+        /**
+         * Loads audio and video and inlines them via a data URI if they are below
+         * the size threshold
+         */
+        media: () => ({
+            use: [loaders.url({ folder: 'medias' })],
+            test: /\.(?:mp4|webm|ogv|wav|mp3|m4a|aac|oga|flac)$/i,
+        }),
+        svg: () => ({
+            test: /\.svg$/i,
+            oneOf: [
+                {
+                    use: [
+                        {
+                            loader: require.resolve('@svgr/webpack'),
+                            options: {
+                                prettier: false,
+                                svgo: true,
+                                svgoConfig: {
+                                    plugins: [
+                                        {
+                                            name: 'preset-default',
+                                            params: {
+                                                overrides: {
+                                                    removeTitle: false,
+                                                    removeViewBox: false,
+                                                },
+                                            },
+                                        },
+                                    ],
+                                },
+                                titleProp: true,
+                                ref: ![path_1.default],
+                            },
+                        },
+                    ],
+                    // We don't want to use SVGR loader for non-React source code
+                    // ie we don't want to use SVGR for CSS files...
+                    issuer: {
+                        and: [/\.(?:tsx?|jsx?|mdx?)$/i],
+                    },
+                },
+                {
+                    use: [loaders.url({ folder: 'images' })],
+                },
+            ],
+        }),
+        otherAssets: () => ({
+            use: [loaders.file({ folder: 'files' })],
+            test: /\.(?:pdf|docx?|xlsx?|zip|rar)$/i,
+        }),
+    };
+    return { loaders, rules };
+}
+exports.getFileLoaderUtils = getFileLoaderUtils;
+//# sourceMappingURL=webpackUtils.js.map

package/lib/webpackUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webpackUtils.js","sourceRoot":"","sources":["../src/webpackUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAGH,wDAAwB;AACxB,2CAAuC;AACvC,2CAGqB;AAoBrB,+IAA+I;AAC/I,SAAgB,kBAAkB;IAChC,8EAA8E;IAC9E,WAAW;IACX,MAAM,cAAc,GAAG,oCAAwB,CAAC;IAEhD,4DAA4D;IAC5D,MAAM,kBAAkB,GAAG,CAAC,MAAmB,EAAE,EAAE,CACjD,GAAG,yCAA6B,IAAI,MAAM,6BAA6B,CAAC;IAE1E,MAAM,OAAO,GAA+B;QAC1C,IAAI,EAAE,CAAC,OAA8B,EAAE,EAAE,CAAC,CAAC;YACzC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;YACtC,OAAO,EAAE;gBACP,IAAI,EAAE,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC;aACzC;SACF,CAAC;QACF,GAAG,EAAE,CAAC,OAA8B,EAAE,EAAE,CAAC,CAAC;YACxC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC;YACrC,OAAO,EAAE;gBACP,KAAK,EAAE,cAAc;gBACrB,IAAI,EAAE,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC;gBACxC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;aACzC;SACF,CAAC;QAEF,mDAAmD;QACnD,wEAAwE;QACxE,sEAAsE;QACtE,kEAAkE;QAClE,kDAAkD;QAClD,6BAA6B,EAAE,IAAI,IAAA,sBAAU,EAC3C,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAC9B,UAAU,cAAc,SAAS,kBAAkB,CAClD,QAAQ,CACT,aAAa,IAAA,sBAAU,EAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,GAAG;QAC3D,4BAA4B,EAAE,IAAI,IAAA,sBAAU,EAC1C,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAC/B,SAAS,kBAAkB,CAAC,OAAO,CAAC,GAAG;KACzC,CAAC;IAEF,MAAM,KAAK,GAA6B;QACtC;;;WAGG;QACH,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;YACb,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,EAAC,MAAM,EAAE,QAAQ,EAAC,CAAC,CAAC;YACtC,IAAI,EAAE,yCAAyC;SAChD,CAAC;QAEF,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;YACZ,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,EAAC,MAAM,EAAE,OAAO,EAAC,CAAC,CAAC;YACrC,IAAI,EAAE,4BAA4B;SACnC,CAAC;QAEF;;;WAGG;QACH,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;YACZ,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,EAAC,MAAM,EAAE,QAAQ,EAAC,CAAC,CAAC;YACtC,IAAI,EAAE,+CAA+C;SACtD,CAAC;QAEF,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;YACV,IAAI,EAAE,SAAS;YACf,KAAK,EAAE;gBACL;oBACE,GAAG,EAAE;wBACH;4BACE,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;4BACxC,OAAO,EAAE;gCACP,QAAQ,EAAE,KAAK;gCACf,IAAI,EAAE,IAAI;gCACV,UAAU,EAAE;oCACV,OAAO,EAAE;wCACP;4CACE,IAAI,EAAE,gBAAgB;4CACtB,MAAM,EAAE;gDACN,SAAS,EAAE;oDACT,WAAW,EAAE,KAAK;oDAClB,aAAa,EAAE,KAAK;iDACrB;6CACF;yCACF;qCACF;iCACF;gCACD,SAAS,EAAE,IAAI;gCACf,GAAG,EAAE,CAAC,CAAC,cAAI,CAAC;6BACb;yBACF;qBACF;oBACD,6DAA6D;oBAC7D,gDAAgD;oBAChD,MAAM,EAAE;wBACN,GAAG,EAAE,CAAC,wBAAwB,CAAC;qBAChC;iBACF;gBACD;oBACE,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,EAAC,MAAM,EAAE,QAAQ,EAAC,CAAC,CAAC;iBACvC;aACF;SACF,CAAC;QAEF,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC;YAClB,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAC,MAAM,EAAE,OAAO,EAAC,CAAC,CAAC;YACtC,IAAI,EAAE,iCAAiC;SACxC,CAAC;KACH,CAAC;IAEF,OAAO,EAAC,OAAO,EAAE,KAAK,EAAC,CAAC;AAC1B,CAAC;AA/GD,gDA+GC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/utils",
-  "version": "2.0.0-beta.15a2b59f9",
+  "version": "2.0.0-beta.17",
   "description": "Node utility functions for Docusaurus packages.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -18,22 +18,32 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/types": "2.0.0-beta.15a2b59f9",
-    "@types/github-slugger": "^1.3.0",
-    "chalk": "^4.1.1",
-    "escape-string-regexp": "^4.0.0",
-    "fs-extra": "^10.0.0",
+    "@docusaurus/logger": "2.0.0-beta.17",
+    "@svgr/webpack": "^6.0.0",
+    "file-loader": "^6.2.0",
+    "fs-extra": "^10.0.1",
+    "github-slugger": "^1.4.0",
+    "globby": "^11.0.4",
     "gray-matter": "^4.0.3",
-    "lodash": "^4.17.20",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
+    "micromatch": "^4.0.4",
     "resolve-pathname": "^3.0.0",
-    "tslib": "^2.2.0"
+    "shelljs": "^0.8.5",
+    "tslib": "^2.3.1",
+    "url-loader": "^4.1.1",
+    "webpack": "^5.69.1"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=14"
   },
   "devDependencies": {
+    "@docusaurus/types": "2.0.0-beta.17",
     "@types/dedent": "^0.7.0",
+    "@types/github-slugger": "^1.3.0",
+    "@types/micromatch": "^4.0.2",
+    "@types/react-dom": "^17.0.11",
     "dedent": "^0.7.0"
   },
-  "gitHead": "34881586224092fb9b5b2f455a46e19b3eee7f08"
+  "gitHead": "0032c0b0480083227af2e1b4da2d3ee6ce992403"
 }

package/src/constants.ts

@@ -0,0 +1,38 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+export const NODE_MAJOR_VERSION = parseInt(
+  process.versions.node.split('.')[0],
+  10,
+);
+export const NODE_MINOR_VERSION = parseInt(
+  process.versions.node.split('.')[1],
+  10,
+);
+
+// Can be overridden with cli option --out-dir
+export const DEFAULT_BUILD_DIR_NAME = 'build';
+
+// Can be overridden with cli option --config
+export const DEFAULT_CONFIG_FILE_NAME = 'docusaurus.config.js';
+
+export const BABEL_CONFIG_FILE_NAME =
+  process.env.DOCUSAURUS_BABEL_CONFIG_FILE_NAME || 'babel.config.js';
+
+export const GENERATED_FILES_DIR_NAME =
+  process.env.DOCUSAURUS_GENERATED_FILES_DIR_NAME || '.docusaurus';
+
+export const SRC_DIR_NAME = 'src';
+export const STATIC_DIR_NAME = 'static';
+export const OUTPUT_STATIC_ASSETS_DIR_NAME = 'assets'; // files handled by webpack, hashed (can be cached aggressively)
+export const THEME_PATH = `${SRC_DIR_NAME}/theme`;
+export const DEFAULT_PORT = 3000;
+export const DEFAULT_PLUGIN_ID = 'default';
+
+// Temporary fix for https://github.com/facebook/docusaurus/issues/5493
+export const WEBPACK_URL_LOADER_LIMIT =
+  process.env.WEBPACK_URL_LOADER_LIMIT ?? 10000;

package/src/dataFileUtils.ts

@@ -0,0 +1,90 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import fs from 'fs-extra';
+import Yaml from 'js-yaml';
+import path from 'path';
+import {findAsyncSequential} from './index';
+import type {ContentPaths} from './markdownLinks';
+import logger from '@docusaurus/logger';
+
+type DataFileParams = {
+  filePath: string;
+  contentPaths: ContentPaths;
+};
+
+export async function getDataFilePath({
+  filePath,
+  contentPaths,
+}: DataFileParams): Promise<string | undefined> {
+  // Loads a localized data file in priority
+  const contentPath = await findFolderContainingFile(
+    getContentPathList(contentPaths),
+    filePath,
+  );
+  if (contentPath) {
+    return path.join(contentPath, filePath);
+  }
+  return undefined;
+}
+
+/**
+ * Looks up for a data file in the content paths, returns the normalized object.
+ * Throws when validation fails; returns undefined when file not found
+ */
+export async function getDataFileData<T>(
+  params: DataFileParams & {fileType: string},
+  validate: (content: unknown) => T,
+): Promise<T | undefined> {
+  const filePath = await getDataFilePath(params);
+  if (!filePath) {
+    return undefined;
+  }
+  try {
+    const contentString = await fs.readFile(filePath, {encoding: 'utf8'});
+    const unsafeContent = Yaml.load(contentString);
+    return validate(unsafeContent);
+  } catch (err) {
+    // TODO replace later by error cause, see https://v8.dev/features/error-cause
+    logger.error`The ${params.fileType} file at path=${filePath} looks invalid.`;
+    throw err;
+  }
+}
+
+// Order matters: we look in priority in localized folder
+export function getContentPathList(contentPaths: ContentPaths): string[] {
+  return [contentPaths.contentPathLocalized, contentPaths.contentPath];
+}
+
+// return the first folder path in which the file exists in
+export async function findFolderContainingFile(
+  folderPaths: string[],
+  relativeFilePath: string,
+): Promise<string | undefined> {
+  return findAsyncSequential(folderPaths, (folderPath) =>
+    fs.pathExists(path.join(folderPath, relativeFilePath)),
+  );
+}
+
+export async function getFolderContainingFile(
+  folderPaths: string[],
+  relativeFilePath: string,
+): Promise<string> {
+  const maybeFolderPath = await findFolderContainingFile(
+    folderPaths,
+    relativeFilePath,
+  );
+  // should never happen, as the source was read from the FS anyway...
+  if (!maybeFolderPath) {
+    throw new Error(
+      `File "${relativeFilePath}" does not exist in any of these folders:\n- ${folderPaths.join(
+        '\n- ',
+      )}]`,
+    );
+  }
+  return maybeFolderPath;
+}

package/src/deps.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+declare module 'resolve-pathname' {
+  export default function resolvePathname(to: string, from?: string): string;
+}