@mintlify/common 1.0.1057 → 1.0.1059

package/dist/validateCustomDomainBasePath.d.ts

@@ -0,0 +1,4 @@
+export declare const RESERVED_BASE_PATHS: string[];
+export declare const normalizeCustomDomainBasePath: (basePath: string) => string;
+export declare const isReservedBasePath: (basePath: string) => boolean;
+export declare const validateCustomDomainBasePath: (basePath: string) => string | undefined;

package/dist/validateCustomDomainBasePath.js

@@ -0,0 +1,52 @@
+export const RESERVED_BASE_PATHS = [
+    '/_next',
+    '/_mintlify',
+    '/_sites',
+    '/_live-preview',
+    '/api',
+    '/login',
+    '/logout',
+    '/mcp',
+    '/feedback',
+    '/openapi-specs.download',
+    '/llms.txt',
+    '/llms-full.txt',
+    '/sitemap.xml',
+    '/robots.txt',
+    '/skill.md',
+    '/.well-known',
+];
+export const normalizeCustomDomainBasePath = (basePath) => {
+    const trimmedBasePath = basePath.trim();
+    if (trimmedBasePath === '/')
+        return trimmedBasePath;
+    return trimmedBasePath.replace(/\/+$/, '');
+};
+export const isReservedBasePath = (basePath) => RESERVED_BASE_PATHS.some((reservedBasePath) => basePath === reservedBasePath || basePath.startsWith(`${reservedBasePath}/`));
+export const validateCustomDomainBasePath = (basePath) => {
+    const trimmedBasePath = basePath.trim();
+    const normalizedBasePath = normalizeCustomDomainBasePath(basePath);
+    if (trimmedBasePath.length === 0)
+        return 'Enter a base path.';
+    if (!trimmedBasePath.startsWith('/'))
+        return 'Base path must start with /.';
+    if (trimmedBasePath === '/')
+        return 'Base path must include a path segment.';
+    if (trimmedBasePath.length > 128)
+        return 'Base path must be at most 128 characters.';
+    if (trimmedBasePath.startsWith('//') || trimmedBasePath.includes('://')) {
+        return 'Base path cannot be an absolute URL.';
+    }
+    if (trimmedBasePath.includes('//'))
+        return 'Base path cannot contain consecutive slashes.';
+    if (/\s/.test(trimmedBasePath))
+        return 'Base path cannot contain spaces.';
+    if (/[?#]/.test(trimmedBasePath))
+        return 'Base path cannot include a query string or hash.';
+    if (trimmedBasePath.split('/').some((segment) => segment === '.' || segment === '..')) {
+        return 'Base path cannot contain "." or ".." segments.';
+    }
+    if (isReservedBasePath(normalizedBasePath))
+        return 'Base path is reserved.';
+    return undefined;
+};

package/dist/validateCustomDomainBasePath.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/validateCustomDomainBasePath.test.js

@@ -0,0 +1,22 @@
+import { describe, expect, it } from 'vitest';
+import { validateCustomDomainBasePath } from './validateCustomDomainBasePath.js';
+describe('validateCustomDomainBasePath', () => {
+    it.each([
+        ['', 'Enter a base path.'],
+        ['docs', 'Base path must start with /.'],
+        ['/', 'Base path must include a path segment.'],
+        ['//docs', 'Base path cannot be an absolute URL.'],
+        ['https://example.com/docs', 'Base path must start with /.'],
+        ['/docs//api', 'Base path cannot contain consecutive slashes.'],
+        ['/docs api', 'Base path cannot contain spaces.'],
+        ['/docs?version=1', 'Base path cannot include a query string or hash.'],
+        ['/docs/../api', 'Base path cannot contain "." or ".." segments.'],
+        ['/docs/.', 'Base path cannot contain "." or ".." segments.'],
+        ['/api/reference', 'Base path is reserved.'],
+    ])('rejects invalid base path %s', (basePath, error) => {
+        expect(validateCustomDomainBasePath(basePath)).toBe(error);
+    });
+    it('accepts custom base paths', () => {
+        expect(validateCustomDomainBasePath('/resources')).toBeUndefined();
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/common",
-  "version": "1.0.1057",
+  "version": "1.0.1059",
   "description": "Commonly shared code within Mintlify",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -71,7 +71,7 @@
     "@mintlify/mdx": "4.0.1",
     "@mintlify/models": "0.0.344",
     "@mintlify/openapi-parser": "0.0.8",
-    "@mintlify/validation": "0.1.808",
+    "@mintlify/validation": "0.1.809",
     "@sindresorhus/slugify": "2.2.0",
     "@types/mdast": "4.0.4",
     "acorn": "8.11.2",
@@ -129,5 +129,5 @@
     "typescript": "5.5.3",
     "vitest": "2.1.9"
   },
-  "gitHead": "1b7774aa5f93b4b4bf0229a41cf2bb94512f704d"
+  "gitHead": "01132fcdea1229b4af02723b1cd62a2bae73ecf6"
 }