@mintlify/common 1.0.1008 → 1.0.1010

package/dist/slug/addTrailingSlash.d.ts

@@ -0,0 +1,20 @@
+export type AddTrailingSlashOptions = {
+    /**
+     * Skip paths whose last segment looks like a file (e.g. `/images/logo.png`).
+     * Enabled by default for generic callers. Callers that know their input is
+     * always a page URL (canonical, sitemap) should pass `false` so valid page
+     * slugs with dots (e.g. `/release.v1`, `/api.beta`) still get a slash.
+     */
+    skipFileExtensions?: boolean;
+};
+/**
+ * Appends a trailing slash to a URL's path while preserving any query string or
+ * hash fragment. Handles both absolute URLs (e.g. `https://host/docs/page`) and
+ * root-relative paths (e.g. `/docs/page`). Paths that already end in `/` are
+ * returned unchanged.
+ *
+ * By default, file-like paths (e.g. `/logo.png`) are left unchanged. Pass
+ * `skipFileExtensions: false` when the input is guaranteed to be a page URL so
+ * that page slugs containing dots are handled correctly.
+ */
+export declare function addTrailingSlash(url: string, options?: AddTrailingSlashOptions): string;

package/dist/slug/addTrailingSlash.js

@@ -0,0 +1,45 @@
+function looksLikeFilePath(pathname) {
+    var _a, _b;
+    const lastSegment = (_a = pathname.split('/').pop()) !== null && _a !== void 0 ? _a : '';
+    const extension = lastSegment.includes('.') ? ((_b = lastSegment.split('.').pop()) !== null && _b !== void 0 ? _b : '') : '';
+    return /[a-zA-Z]/.test(extension);
+}
+function ensurePathTrailingSlash(pathname, skipFileExtensions) {
+    if (pathname === '')
+        return '/';
+    if (pathname.endsWith('/'))
+        return pathname;
+    if (skipFileExtensions && looksLikeFilePath(pathname))
+        return pathname;
+    return `${pathname}/`;
+}
+/**
+ * Appends a trailing slash to a URL's path while preserving any query string or
+ * hash fragment. Handles both absolute URLs (e.g. `https://host/docs/page`) and
+ * root-relative paths (e.g. `/docs/page`). Paths that already end in `/` are
+ * returned unchanged.
+ *
+ * By default, file-like paths (e.g. `/logo.png`) are left unchanged. Pass
+ * `skipFileExtensions: false` when the input is guaranteed to be a page URL so
+ * that page slugs containing dots are handled correctly.
+ */
+export function addTrailingSlash(url, options = {}) {
+    var _a, _b, _c;
+    if (typeof url !== 'string' || url === '')
+        return url;
+    const skipFileExtensions = (_a = options.skipFileExtensions) !== null && _a !== void 0 ? _a : true;
+    if (/^https?:\/\//i.test(url)) {
+        try {
+            const parsed = new URL(url);
+            parsed.pathname = ensurePathTrailingSlash(parsed.pathname, skipFileExtensions);
+            return parsed.toString();
+        }
+        catch (_d) {
+            return url;
+        }
+    }
+    const match = /^([^?#]*)([?#].*)?$/.exec(url);
+    const pathname = (_b = match === null || match === void 0 ? void 0 : match[1]) !== null && _b !== void 0 ? _b : url;
+    const suffix = (_c = match === null || match === void 0 ? void 0 : match[2]) !== null && _c !== void 0 ? _c : '';
+    return `${ensurePathTrailingSlash(pathname, skipFileExtensions)}${suffix}`;
+}

package/dist/slug/index.d.ts

@@ -2,3 +2,4 @@ export * from './slugToTitle.js';
 export * from './getDecoratedNavPageAndSlug.js';
 export * from './pagePathToSlug.js';
 export * from './replaceSlashIndex.js';
+export * from './addTrailingSlash.js';

package/dist/slug/index.js

@@ -2,3 +2,4 @@ export * from './slugToTitle.js';
 export * from './getDecoratedNavPageAndSlug.js';
 export * from './pagePathToSlug.js';
 export * from './replaceSlashIndex.js';
+export * from './addTrailingSlash.js';