@mintlify/common 1.0.1160 → 1.0.1161

package/dist/index.d.ts

@@ -42,3 +42,4 @@ export * from './knownMcpClients.js';
 export * from './live-preview.js';
 export * from './paths/isEqualIgnoringLeadingSlash.js';
 export * from './sdk/index.js';
+export * from './seo/resolveSeoMetatags.js';

package/dist/index.js

@@ -42,3 +42,4 @@ export * from './knownMcpClients.js';
 export * from './live-preview.js';
 export * from './paths/isEqualIgnoringLeadingSlash.js';
 export * from './sdk/index.js';
+export * from './seo/resolveSeoMetatags.js';

package/dist/seo/resolveSeoMetatags.d.ts

@@ -0,0 +1,12 @@
+export type SeoMetatagsConfig = {
+    metatags?: Record<string, string>;
+    paths?: {
+        path: string;
+        metatags: Record<string, string>;
+    }[];
+};
+/**
+ * Merges `seo.metatags` with every `seo.paths` entry whose folder contains the page.
+ * Shorter paths apply first, so the most specific folder wins.
+ */
+export declare function resolveSeoMetatags(seo: SeoMetatagsConfig | undefined, href: string | undefined): Record<string, string>;

package/dist/seo/resolveSeoMetatags.js

@@ -0,0 +1,18 @@
+function toPagePath(href) {
+    return href.split(/[?#]/)[0].replace(/^\/+/, '').replace(/\/+$/, '');
+}
+/**
+ * Merges `seo.metatags` with every `seo.paths` entry whose folder contains the page.
+ * Shorter paths apply first, so the most specific folder wins.
+ */
+export function resolveSeoMetatags(seo, href) {
+    var _a, _b;
+    const siteMetatags = (_a = seo === null || seo === void 0 ? void 0 : seo.metatags) !== null && _a !== void 0 ? _a : {};
+    if (!((_b = seo === null || seo === void 0 ? void 0 : seo.paths) === null || _b === void 0 ? void 0 : _b.length) || !href)
+        return Object.assign({}, siteMetatags);
+    const pagePath = toPagePath(href);
+    const matches = seo.paths
+        .filter(({ path }) => pagePath === path || pagePath.startsWith(`${path}/`))
+        .sort((a, b) => a.path.length - b.path.length);
+    return Object.assign({}, siteMetatags, ...matches.map(({ metatags }) => metatags));
+}

package/dist/seo/resolveSeoMetatags.test.d.ts

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

package/dist/seo/resolveSeoMetatags.test.js

@@ -0,0 +1,81 @@
+import { describe, expect, it } from 'vitest';
+import { resolveSeoMetatags } from './resolveSeoMetatags.js';
+const seo = {
+    metatags: { tenant: 'Acme', product: 'Docs' },
+    paths: [
+        { path: 'guides/v2', metatags: { 'doc-version': '2', latest: 'true' } },
+        { path: 'guides', metatags: { latest: 'false', should_index: 'true' } },
+        { path: 'sdk', metatags: { product: 'SDK' } },
+    ],
+};
+describe('resolveSeoMetatags', () => {
+    it('returns site metatags when no path matches', () => {
+        expect(resolveSeoMetatags(seo, '/changelog')).toEqual({ tenant: 'Acme', product: 'Docs' });
+    });
+    it('returns an empty object without seo config', () => {
+        expect(resolveSeoMetatags(undefined, '/guides/intro')).toEqual({});
+    });
+    it('returns site metatags without an href', () => {
+        expect(resolveSeoMetatags(seo, undefined)).toEqual({ tenant: 'Acme', product: 'Docs' });
+    });
+    it('applies a matching folder on top of site metatags', () => {
+        expect(resolveSeoMetatags(seo, '/guides/intro')).toEqual({
+            tenant: 'Acme',
+            product: 'Docs',
+            latest: 'false',
+            should_index: 'true',
+        });
+    });
+    it('lets the longest path win regardless of declaration order', () => {
+        expect(resolveSeoMetatags(seo, '/guides/v2/install')).toEqual({
+            tenant: 'Acme',
+            product: 'Docs',
+            'doc-version': '2',
+            latest: 'true',
+            should_index: 'true',
+        });
+    });
+    it('lets a folder override a site metatag', () => {
+        expect(resolveSeoMetatags(seo, 'sdk/node')).toEqual({ tenant: 'Acme', product: 'SDK' });
+    });
+    it('only matches on whole path segments', () => {
+        expect(resolveSeoMetatags(seo, '/guides/v20/install')).toEqual({
+            tenant: 'Acme',
+            product: 'Docs',
+            latest: 'false',
+            should_index: 'true',
+        });
+        expect(resolveSeoMetatags(seo, '/sdk-legacy/node')).toEqual({
+            tenant: 'Acme',
+            product: 'Docs',
+        });
+    });
+    it('matches a page whose href equals the path', () => {
+        expect(resolveSeoMetatags(seo, '/sdk')).toEqual({ tenant: 'Acme', product: 'SDK' });
+    });
+    it.each([
+        ['a query string', '/sdk?ref=nav'],
+        ['a fragment', '/sdk#overview'],
+        ['a query string and fragment', '/sdk?ref=nav#overview'],
+        ['a trailing slash', '/sdk/'],
+    ])('matches a folder href with %s', (_label, href) => {
+        expect(resolveSeoMetatags(seo, href)).toEqual({ tenant: 'Acme', product: 'SDK' });
+    });
+    it('matches a nested page whose href carries a query string or fragment', () => {
+        expect(resolveSeoMetatags(seo, '/sdk/node?ref=nav#install')).toEqual({
+            tenant: 'Acme',
+            product: 'SDK',
+        });
+    });
+    it('does not match a different folder that shares a prefix', () => {
+        expect(resolveSeoMetatags(seo, '/sdk-legacy?ref=nav')).toEqual({
+            tenant: 'Acme',
+            product: 'Docs',
+        });
+    });
+    it('does not mutate the config', () => {
+        const before = JSON.stringify(seo);
+        resolveSeoMetatags(seo, '/guides/v2/install');
+        expect(JSON.stringify(seo)).toBe(before);
+    });
+});