@mintlify/previewing 3.0.3 → 3.1.0

package/dist/constants.d.ts

@@ -0,0 +1,9 @@
+export declare const TARGET_MINT_VERSION = "v0.0.9";
+export declare const INSTALL_PATH: string;
+export declare const HOME_DIR: string;
+export declare const DOT_MINTLIFY: string;
+export declare const VERSION_PATH: string;
+export declare const CLIENT_PATH: string;
+export declare const MINT_PATH: string;
+export declare const CMD_EXEC_PATH: string;
+export declare const SUPPORTED_MEDIA_EXTENSIONS: string[];

package/dist/downloadImage.d.ts

@@ -0,0 +1,4 @@
+export declare function isValidImageSrc(src: string): boolean;
+export declare function removeMetadataFromImageSrc(src: string): string;
+export declare function cleanImageSrc(src: string, origin: string): string;
+export default function downloadImage(imageSrc: string, writePath: string, overwrite?: boolean): Promise<void>;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import dev from "./local-preview/index.js";
+import installDepsCommand from "./local-preview/helper-commands/installDepsCommand.js";
+export { dev, installDepsCommand };

package/dist/local-preview/helper-commands/installDepsCommand.d.ts

@@ -0,0 +1,2 @@
+declare const installDeps: () => Promise<void>;
+export default installDeps;

package/dist/local-preview/index.d.ts

@@ -0,0 +1,3 @@
+import { ArgumentsCamelCase } from "yargs";
+declare const dev: (argv: ArgumentsCamelCase) => Promise<void>;
+export default dev;

package/dist/local-preview/listener/categorize.d.ts

@@ -0,0 +1,8 @@
+import { PotentialFileCategory } from "./utils/types.js";
+export declare const categorizeFiles: (contentDirectoryPath: string) => Promise<{
+    contentFilenames: string[];
+    staticFilenames: string[];
+    openApiFiles: OpenApiFile[];
+    snippets: string[];
+}>;
+export declare const getCategory: (filePath: string) => PotentialFileCategory;

package/dist/local-preview/listener/generate.d.ts

@@ -0,0 +1,12 @@
+type DecoratedMintNavigation = DecoratedMintNavigationEntry[];
+type DecoratedMintNavigationEntry = {
+    group: string;
+    version?: string;
+    pages: DecoratedMintNavigationEntryChild[];
+};
+type DecoratedMintNavigationEntryChild = DecoratedMintNavigationEntry | PageMetadata;
+type PageMetadata = Record<PageMetadataKeys, string>;
+declare const pageMetadataKeys: readonly ["title", "description", "sidebarTitle", "href", "api", "openapi", "contentType", "auth", "version", "mode", "hideFooterPagination", "authors", "lastUpdatedDate", "createdDate", "size"];
+type PageMetadataKeys = typeof pageMetadataKeys[number];
+export declare const generateNav: () => Promise<DecoratedMintNavigation>;
+export {};

package/dist/local-preview/listener/index.d.ts

@@ -0,0 +1,2 @@
+declare const listener: () => void;
+export default listener;

package/dist/local-preview/listener/update.d.ts

@@ -0,0 +1,2 @@
+export declare const updateGeneratedNav: () => Promise<void>;
+export declare const updateOpenApiFiles: () => Promise<void>;

package/dist/local-preview/listener/utils/createPage.d.ts

@@ -0,0 +1,11 @@
+declare const createPage: (pagePath: string, pageContent: string, contentDirectoryPath: string, openApiFiles: OpenApiFile[]) => Promise<{
+    pageMetadata: {
+        href: string;
+        title: string;
+        description: string;
+    };
+    pageContent: string;
+    slug: string;
+}>;
+export declare const slugToTitle: (slug: string) => string;
+export default createPage;

package/dist/local-preview/listener/utils/getOpenApiContext.d.ts

@@ -0,0 +1,21 @@
+export declare const extractMethodAndEndpoint: (api: string) => {
+    method?: string;
+    endpoint: string;
+    filename?: string;
+};
+export declare const getOpenApiOperationMethodAndEndpoint: (openApi: any, openApiMetaField: string) => {
+    operation?: undefined;
+    method?: undefined;
+    endpoint?: undefined;
+} | {
+    operation: any;
+    method: string;
+    endpoint: string;
+};
+export declare const getOpenApiTitleAndDescription: (openApi: any, openApiMetaField: any) => {
+    title?: undefined;
+    description?: undefined;
+} | {
+    title: any;
+    description: any;
+};

package/dist/local-preview/listener/utils/mintConfigFile.d.ts

@@ -0,0 +1,2 @@
+export declare const getConfigPath: (contentDirectoryPath: string) => Promise<string | null>;
+export declare const getConfigObj: (contentDirectoryPath: string) => Promise<any>;

package/dist/local-preview/listener/utils/toTitleCase.d.ts

@@ -0,0 +1 @@
+export declare function toTitleCase(text: string): string;

package/dist/local-preview/listener/utils/types.d.ts

@@ -0,0 +1,2 @@
+export type PotentialFileCategory = "page" | "snippet" | "mintConfig" | "potentialYamlOpenApiSpec" | "potentialJsonOpenApiSpec" | "staticFile";
+export type FileCategory = "page" | "snippet" | "mintConfig" | "openApi" | "staticFile";

package/dist/local-preview/listener/utils.d.ts

@@ -0,0 +1,14 @@
+export declare const getFileExtension: (filename: string) => string;
+export type OpenApiCheckResult = {
+    spec: any;
+    isOpenApi: boolean;
+};
+export declare const openApiCheck: (path: string) => Promise<OpenApiCheckResult>;
+export declare const filterOutNullInGroup: (group: MintNavigation) => {
+    pages: MintNavigationEntry[];
+    group: string;
+    version?: string;
+};
+export declare const getFileList: (dirName: string, og?: string) => Promise<string[]>;
+export declare const isFileSizeValid: (path: string, maxFileSizeInMb: number) => Promise<boolean>;
+export declare function isError(obj: unknown): boolean;

package/dist/util.d.ts

@@ -0,0 +1,28 @@
+import { Ora as OraType } from "ora";
+export declare const MintConfig: (name: string, color: string, ctaName: string, ctaUrl: string, filename: string) => {
+    name: string;
+    logo: string;
+    favicon: string;
+    colors: {
+        primary: string;
+    };
+    topbarLinks: any[];
+    topbarCtaButton: {
+        name: string;
+        url: string;
+    };
+    anchors: any[];
+    navigation: {
+        group: string;
+        pages: string[];
+    }[];
+};
+export declare const Page: (title: string, description?: string, markdown?: string) => string;
+export declare function getOrigin(url: string): string;
+export declare function objToReadableString(objs: MintNavigationEntry[]): string;
+export declare const toFilename: (title: string) => string;
+export declare const addMdx: (fileName: string) => string;
+export declare const buildLogger: (startText?: string) => OraType;
+export declare const getFileExtension: (filename: string) => string;
+export declare const fileBelongsInPagesFolder: (filename: string) => boolean;
+export declare const ensureYarn: (logger: OraType) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/previewing",
-  "version": "3.0.3",
+  "version": "3.1.0",
   "description": "Preview Mintlify docs locally",
   "engines": {
     "node": ">=18.0.0"