@mintlify/common 1.0.1043 → 1.0.1045

package/dist/getRelativeRecordName.d.ts

@@ -0,0 +1,2 @@
+export declare const getApexDomain: (domain: string) => string;
+export declare const getRelativeRecordName: (recordDomain: string, customDomain: string) => string;

package/dist/getRelativeRecordName.js

@@ -0,0 +1,19 @@
+// Approximates the registrable apex as the last two labels — accurate for
+// gTLDs like .com/.io/.dev; ccTLDs like .co.uk are not handled.
+export const getApexDomain = (domain) => {
+    const labels = domain.split('.');
+    if (labels.length < 2)
+        return domain;
+    return labels.slice(-2).join('.');
+};
+// Most DNS providers append the zone (apex) to the Name field automatically,
+// so users only enter the relative portion (e.g. `docs` for `docs.example.com`).
+export const getRelativeRecordName = (recordDomain, customDomain) => {
+    const apex = getApexDomain(customDomain);
+    if (recordDomain === apex)
+        return '@';
+    if (recordDomain.endsWith(`.${apex}`)) {
+        return recordDomain.slice(0, -(apex.length + 1));
+    }
+    return recordDomain;
+};

package/dist/getRelativeRecordName.test.d.ts

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

package/dist/getRelativeRecordName.test.js

@@ -0,0 +1,19 @@
+import { describe, expect, it } from 'vitest';
+import { getRelativeRecordName } from './getRelativeRecordName.js';
+describe('getRelativeRecordName', () => {
+    it('strips the apex from a subdomain CNAME', () => {
+        expect(getRelativeRecordName('docs.example.com', 'docs.example.com')).toBe('docs');
+    });
+    it('strips the apex from a deeper TXT record', () => {
+        expect(getRelativeRecordName('_cf-custom-hostname.docs.example.com', 'docs.example.com')).toBe('_cf-custom-hostname.docs');
+    });
+    it('returns "@" when the record sits at the apex', () => {
+        expect(getRelativeRecordName('example.com', 'example.com')).toBe('@');
+    });
+    it('preserves multi-level subdomains under the apex', () => {
+        expect(getRelativeRecordName('docs.team.example.com', 'docs.team.example.com')).toBe('docs.team');
+    });
+    it('returns the original record when it is outside the apex', () => {
+        expect(getRelativeRecordName('something.elsewhere.com', 'docs.example.com')).toBe('something.elsewhere.com');
+    });
+});

package/dist/index.d.ts

@@ -28,6 +28,7 @@ export * from './truncateAtWordBoundary.js';
 export * from './api-reference/parseApiTargetFromMetadata.js';
 export * from './mintIgnore.js';
 export * from './getDisplayDomain.js';
+export * from './getRelativeRecordName.js';
 export * from './basePaths.js';
 export * from './exponentialBackoff.js';
 export * from './isOrgLessThanTwoWeeksOld.js';

package/dist/index.js

@@ -28,6 +28,7 @@ export * from './truncateAtWordBoundary.js';
 export * from './api-reference/parseApiTargetFromMetadata.js';
 export * from './mintIgnore.js';
 export * from './getDisplayDomain.js';
+export * from './getRelativeRecordName.js';
 export * from './basePaths.js';
 export * from './exponentialBackoff.js';
 export * from './isOrgLessThanTwoWeeksOld.js';