@mintlify/common 1.0.622 → 1.0.623

package/dist/frontmatter/index.d.ts

@@ -0,0 +1,3 @@
+export { parseFrontmatter, hasFrontmatter } from './parseFrontmatter.js';
+export type { FrontmatterAttributes } from './parseFrontmatter.js';
+export type { FrontMatterResult } from 'front-matter';

package/dist/frontmatter/index.js

@@ -0,0 +1 @@
+export { parseFrontmatter, hasFrontmatter } from './parseFrontmatter.js';

package/dist/frontmatter/parseFrontmatter.d.ts

@@ -0,0 +1,34 @@
+import type { FrontMatterResult } from 'front-matter';
+/**
+ * Default type for frontmatter attributes when no specific type is provided.
+ * Represents a flexible object that can contain any valid JSON-like values.
+ */
+export type FrontmatterAttributes = Record<string, string | undefined>;
+/**
+ * Type-safe wrapper for parsing front-matter from markdown content.
+ *
+ * @template T - The expected type of the frontmatter attributes
+ * @param content - The markdown content string to parse
+ * @returns A FrontMatterResult with properly typed attributes
+ *
+ * @example
+ * ```ts
+ * interface MyFrontmatter {
+ *   title: string;
+ *   description?: string;
+ *   tags?: string[];
+ * }
+ *
+ * const result = parseFrontmatter<MyFrontmatter>(content);
+ * // result.attributes is now typed as MyFrontmatter
+ * console.log(result.attributes.title);
+ * ```
+ */
+export declare function parseFrontmatter<T = FrontmatterAttributes>(content: string): FrontMatterResult<T>;
+/**
+ * Tests whether a string contains frontmatter
+ *
+ * @param content - The content to test
+ * @returns true if the content contains frontmatter
+ */
+export declare function hasFrontmatter(content: string): boolean;

package/dist/frontmatter/parseFrontmatter.js

@@ -0,0 +1,35 @@
+import fm from 'front-matter';
+// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+const frontmatter = fm;
+/**
+ * Type-safe wrapper for parsing front-matter from markdown content.
+ *
+ * @template T - The expected type of the frontmatter attributes
+ * @param content - The markdown content string to parse
+ * @returns A FrontMatterResult with properly typed attributes
+ *
+ * @example
+ * ```ts
+ * interface MyFrontmatter {
+ *   title: string;
+ *   description?: string;
+ *   tags?: string[];
+ * }
+ *
+ * const result = parseFrontmatter<MyFrontmatter>(content);
+ * // result.attributes is now typed as MyFrontmatter
+ * console.log(result.attributes.title);
+ * ```
+ */
+export function parseFrontmatter(content) {
+    return frontmatter(content);
+}
+/**
+ * Tests whether a string contains frontmatter
+ *
+ * @param content - The content to test
+ * @returns true if the content contains frontmatter
+ */
+export function hasFrontmatter(content) {
+    return frontmatter.test(content);
+}

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export * from './mdx/index.js';
 export * from './getFileCategory.js';
 export * from './slug/index.js';
 export * from './fs/index.js';
+export * from './frontmatter/index.js';
 export * from './getSecurityOptionsForAuthMethod.js';
 export * from './getFileCategory.js';
 export * from './topologicalSort.js';

package/dist/index.js

@@ -5,6 +5,7 @@ export * from './mdx/index.js';
 export * from './getFileCategory.js';
 export * from './slug/index.js';
 export * from './fs/index.js';
+export * from './frontmatter/index.js';
 export * from './getSecurityOptionsForAuthMethod.js';
 export * from './getFileCategory.js';
 export * from './topologicalSort.js';

package/dist/mdx/snippets/resolveImport/injectToTopOfFile.d.ts

@@ -1,8 +1,4 @@
 import type { Root, RootContent } from 'mdast';
-/**
- * Injects content to the top of a file, but below the frontmatter
- */
-export declare const injectToTopOfFile: (content: string, contentToInject: string) => string;
 /**
  * Injects nodes to the top of a MDX/Markdown AST (Root), but below the frontmatter (YAML node).
  * Modifies the tree in place.

package/dist/mdx/snippets/resolveImport/injectToTopOfFile.js

@@ -1,14 +1,3 @@
-import matter from 'gray-matter';
-const { test: hasFrontmatter } = matter;
-/**
- * Injects content to the top of a file, but below the frontmatter
- */
-export const injectToTopOfFile = (content, contentToInject) => {
-    if (!hasFrontmatter(content))
-        return contentToInject + `\n` + content;
-    const { data: frontmatterData, content: contentWithoutFrontmatter } = matter(content);
-    return matter.stringify(`\n` + contentToInject + `\n` + contentWithoutFrontmatter, frontmatterData);
-};
 /**
  * Injects nodes to the top of a MDX/Markdown AST (Root), but below the frontmatter (YAML node).
  * Modifies the tree in place.

package/dist/slug/getDecoratedNavPageAndSlug.js

@@ -1,6 +1,6 @@
-import matter from 'gray-matter';
 import { getAsyncApiChannelMetadata } from '../asyncapi/getAsyncApiChannelMetadata.js';
 import { prepAsyncApiFrontmatter } from '../asyncapi/prepAsyncApiFrontmatter.js';
+import { parseFrontmatter } from '../frontmatter/index.js';
 import { removeLeadingSlash, optionallyAddLeadingSlash } from '../fs/index.js';
 import { getOpenApiTitleAndDescription } from '../openapi/getOpenApiTitleAndDescription.js';
 import { prepOpenApiFrontmatter } from '../openapi/prepOpenApiFrontmatter.js';
@@ -9,7 +9,7 @@ import { slugToTitle } from './slugToTitle.js';
 export const getDecoratedNavPageAndSlug = (pagePath, pageContent, openApiFiles, asyncApiFiles) => {
     let metadata = {};
     try {
-        metadata = matter(pageContent).data;
+        metadata = parseFrontmatter(pageContent).attributes;
     }
     catch (error) {
         if (error &&