@mintlify/common 1.0.1256 → 1.0.1257

package/dist/navigation/clientNavGuards.d.ts

@@ -0,0 +1,3 @@
+import type { ClientGroupConfig, ClientNavPage, ClientPageOrGroupConfig } from '@mintlify/validation';
+export declare const isClientNavPage: (entry: ClientPageOrGroupConfig) => entry is ClientNavPage;
+export declare const isClientNavGroup: (entry: ClientPageOrGroupConfig) => entry is ClientGroupConfig;

package/dist/navigation/clientNavGuards.js

@@ -0,0 +1,4 @@
+import { isGroup } from './isGroup.js';
+import { isPage } from './isPage.js';
+export const isClientNavPage = (entry) => isPage(entry);
+export const isClientNavGroup = (entry) => isGroup(entry);

package/dist/navigation/clientNavView.d.ts

@@ -1,3 +1,3 @@
-import type { DecoratedPageOrGroupConfig } from '@mintlify/validation';
+import { type DecoratedPageOrGroupConfig } from '@mintlify/validation';
 export declare function clientNavView(entries: DecoratedPageOrGroupConfig[]): unknown[];
 export declare function paginationDescriptions(entries: DecoratedPageOrGroupConfig[], currentPath: string): [unknown, unknown];

package/dist/navigation/clientNavView.js

@@ -9,10 +9,10 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
+import { CLIENT_NAV_PAGE_FIELDS, } from '@mintlify/validation';
 import { isEqualIgnoringLeadingSlash } from '../paths/isEqualIgnoringLeadingSlash.js';
 import { replaceSlashIndex } from '../slug/replaceSlashIndex.js';
 import { isPage } from './isPage.js';
-import { CLIENT_NAV_PAGE_FIELDS } from './trimScopedNavPages.js';
 function clientPage(page) {
     return Object.fromEntries(CLIENT_NAV_PAGE_FIELDS.filter((field) => Object.hasOwn(page, field)).map((field) => [
         field,

package/dist/navigation/index.d.ts

@@ -1,5 +1,6 @@
 export * from './isGroup.js';
 export * from './isPage.js';
+export * from './clientNavGuards.js';
 export * from './generatePathToBreadcrumbsMap.js';
 export * from './getFirstPageFromNavigation.js';
 export * from './generatePathToBreadcrumbsMapForDocsConfig.js';

package/dist/navigation/index.js

@@ -1,5 +1,6 @@
 export * from './isGroup.js';
 export * from './isPage.js';
+export * from './clientNavGuards.js';
 export * from './generatePathToBreadcrumbsMap.js';
 export * from './getFirstPageFromNavigation.js';
 export * from './generatePathToBreadcrumbsMapForDocsConfig.js';

package/dist/navigation/scopeNavToPath.d.ts

@@ -1,10 +1,10 @@
 import { LocaleType } from '@mintlify/models';
-import { type DecoratedNavigationConfig, type DocsConfig } from '@mintlify/validation';
+import { type ClientNavigationConfig, type DecoratedNavigationConfig, type DocsConfig } from '@mintlify/validation';
 import { DivisionMatch } from './updateFirstHrefInDivision.js';
 export declare function scopeDecoratedNavToPath(nav: DecoratedNavigationConfig, currentPath: string, userGroups?: Set<string>): DecoratedNavigationConfig;
 export declare function scopeDocsConfigNavToPath(docsConfig: DocsConfig, currentPath: string): DocsConfig;
 export type ScopedNavForPath = {
-    scopedNav: DecoratedNavigationConfig;
+    scopedNav: ClientNavigationConfig;
     firstHrefInVersion: Map<string | undefined, DivisionMatch>;
     firstHrefInLanguage: Map<LocaleType | undefined, DivisionMatch>;
     currentVersion: string | undefined;

package/dist/navigation/trimScopedNavPages.d.ts

@@ -1,4 +1,3 @@
 type NavNode = Record<string, unknown>;
-export declare const CLIENT_NAV_PAGE_FIELDS: readonly ["href", "title", "hidden", "groups", "sidebarTitle", "url", "icon", "iconType", "tag", "api", "openapi", "asyncapi", "graphql", "deprecated", "hideApiMarker", "mode", "playground", "version"];
 export declare function trimScopedNavPages(nav: NavNode, currentPath: string): NavNode;
 export {};

package/dist/navigation/trimScopedNavPages.js

@@ -1,28 +1,6 @@
+import { CLIENT_NAV_PAGE_FIELDS } from '@mintlify/validation';
 import { normalizeComparablePath } from '../paths/isEqualIgnoringLeadingSlash.js';
 import { replaceSlashIndex } from '../slug/replaceSlashIndex.js';
-function pageFieldAllowlist(fields) {
-    return fields;
-}
-export const CLIENT_NAV_PAGE_FIELDS = pageFieldAllowlist([
-    'href',
-    'title',
-    'hidden',
-    'groups',
-    'sidebarTitle',
-    'url',
-    'icon',
-    'iconType',
-    'tag',
-    'api',
-    'openapi',
-    'asyncapi',
-    'graphql',
-    'deprecated',
-    'hideApiMarker',
-    'mode',
-    'playground',
-    'version',
-]);
 const isNavNode = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
 const isPageNode = (node) => Object.hasOwn(node, 'href') && Object.hasOwn(node, 'title');
 const hrefMatches = (href, target) => typeof href === 'string' && normalizeComparablePath(replaceSlashIndex(href)) === target;