@mintlify/scraping 4.0.687 → 4.0.689

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/scraping",
-  "version": "4.0.687",
+  "version": "4.0.689",
   "description": "Scrape documentation frameworks to Mintlify docs",
   "engines": {
     "node": ">=18.0.0"
@@ -43,7 +43,7 @@
     "format:check": "prettier . --check"
   },
   "dependencies": {
-    "@mintlify/common": "1.0.824",
+    "@mintlify/common": "1.0.826",
     "@mintlify/openapi-parser": "^0.0.8",
     "fs-extra": "11.1.1",
     "hast-util-to-mdast": "10.1.0",
@@ -82,5 +82,5 @@
     "typescript": "5.5.3",
     "vitest": "2.1.9"
   },
-  "gitHead": "dbb1d51caa0d27cb7ab44f8a5e237b0782bb96d4"
+  "gitHead": "43cfc30e331c3b552d21f17953dd83cecbbdf2f4"
 }

package/src/asyncapi/generateAsyncApiPagesForDocsConfig.ts

@@ -1,8 +1,8 @@
 import { AsyncAPIDocumentInterface, AsyncAPIChannel, validateAsyncApi } from '@mintlify/common';
+import { findNavGroup } from '@mintlify/common';
 import { DecoratedNavigationPage } from '@mintlify/models';
 import { DecoratedGroupsConfig, GroupsConfig } from '@mintlify/validation';
 
-import { findNavGroup } from '../apiPages/common.js';
 import { getAsyncApiDefinition } from './getAsyncApiDefinition.js';
 import { processAsyncApiChannel } from './processAsyncApiChannel.js';
 

package/src/asyncapi/processAsyncApiChannel.ts

@@ -1,4 +1,10 @@
-import { optionallyAddLeadingSlash, camelToSentenceCase } from '@mintlify/common';
+import {
+  optionallyAddLeadingSlash,
+  camelToSentenceCase,
+  prepareStringToBeValidFilename,
+  generateUniqueFilenameWithoutExtension,
+  DEFAULT_WEBSOCKETS_GROUP_NAME,
+} from '@mintlify/common';
 import { AsyncAPIChannel } from '@mintlify/common';
 import { DecoratedNavigationPage, NavigationEntry } from '@mintlify/models';
 import {
@@ -11,12 +17,6 @@ import fse from 'fs-extra';
 import { outputFile } from 'fs-extra';
 import { join, resolve } from 'path';
 
-import {
-  DEFAULT_WEBSOCKETS_GROUP_NAME,
-  prepareStringToBeValidFilename,
-  generateUniqueFilenameWithoutExtension,
-} from '../apiPages/common.js';
-
 type GenerateAsyncApiPagesOptions = {
   asyncApiFilePath?: string;
   version?: string;

package/src/openapi/common.ts

@@ -7,6 +7,8 @@ import {
   isAllowedLocalSchemaUrl,
   buildOpenApiMetaTag,
   registerXMintContent,
+  prepareStringToBeValidFilename,
+  generateUniqueFilenameWithoutExtension,
 } from '@mintlify/common';
 import type { DecoratedNavigationPage, PageMetaTags } from '@mintlify/models';
 import { XMint } from '@mintlify/validation';
@@ -17,10 +19,6 @@ import yaml from 'js-yaml';
 import { OpenAPI, OpenAPIV3 } from 'openapi-types';
 import path, { join, parse, posix } from 'path';
 
-import {
-  prepareStringToBeValidFilename,
-  generateUniqueFilenameWithoutExtension,
-} from '../apiPages/common.js';
 import { fetchOpenApi } from '../utils/network.js';
 
 export type OpenApiExtensions = {

package/src/openapi/generateOpenApiPages.ts

@@ -1,4 +1,4 @@
-import { validate } from '@mintlify/common';
+import { validate, DEFAULT_API_GROUP_NAME } from '@mintlify/common';
 import type {
   DecoratedNavigation,
   DecoratedNavigationGroup,
@@ -8,7 +8,6 @@ import type {
 } from '@mintlify/models';
 import { OpenAPI } from 'openapi-types';
 
-import { DEFAULT_API_GROUP_NAME } from '../apiPages/common.js';
 import {
   getOpenApiDefinition,
   GenerateOpenApiPagesOptions,

package/src/openapi/generateOpenApiPagesForDocsConfig.ts

@@ -1,9 +1,8 @@
-import { validate } from '@mintlify/common';
+import { validate, findNavGroup } from '@mintlify/common';
 import { DecoratedNavigationPage } from '@mintlify/models';
 import { DecoratedGroupsConfig, GroupsConfig } from '@mintlify/validation';
 import { OpenAPI } from 'openapi-types';
 
-import { findNavGroup } from '../apiPages/common.js';
 import {
   getOpenApiDefinition,
   GenerateOpenApiPagesOptions,

package/tsconfig.json

@@ -7,6 +7,6 @@
     "declaration": true,
     "types": ["vitest/globals"]
   },
-  "include": ["**/*.ts"],
+  "include": ["**/*.ts", "../common/__test__/openapi/prepareStringToBeValidFilename.test.ts"],
   "exclude": ["node_modules", "bin"]
 }

package/__test__/prepareStringToBeValidFilename.test.ts

@@ -1,67 +0,0 @@
-import { prepareStringToBeValidFilename } from '../src/apiPages/common.js';
-
-describe('prepareStringToBeValidFilename', () => {
-  it('should replace spaces with dashes', () => {
-    expect(prepareStringToBeValidFilename('hello world')).toBe('hello-world');
-  });
-  it('should be all lowercase', () => {
-    expect(prepareStringToBeValidFilename('Hello World')).toBe('hello-world');
-  });
-  it('Remove periods', () => {
-    expect(prepareStringToBeValidFilename('Get-a-list-of-all-shelves-in-the-repo.')).toBe(
-      'get-a-list-of-all-shelves-in-the-repo'
-    );
-  });
-  it('Remove path params', () => {
-    expect(prepareStringToBeValidFilename('get-repos-{repo_id}-commits-bulk')).toBe(
-      'get-repos--commits-bulk'
-    );
-  });
-  it('Remove trailing dash', () => {
-    expect(prepareStringToBeValidFilename('get-repos-{repo_id}-commits-')).toBe(
-      'get-repos--commits'
-    );
-  });
-  it('Remove leading dash', () => {
-    expect(prepareStringToBeValidFilename('-get-repos-{repo_id}-commits-')).toBe(
-      'get-repos--commits'
-    );
-  });
-  it('Remove parentheses', () => {
-    expect(
-      prepareStringToBeValidFilename(
-        'Compare-a-ref-(commitbranchworkspacetagtree)-to-this-workspace'
-      )
-    ).toBe('compare-a-ref-commitbranchworkspacetagtree-to-this-workspace');
-  });
-  it('Remove slashes', () => {
-    expect(
-      prepareStringToBeValidFilename(
-        'Compare-a-ref-commit/branch/workspace/tag/tree-to-this-workspace'
-      )
-    ).toBe('compare-a-ref-commitbranchworkspacetagtree-to-this-workspace');
-  });
-  it('Remove newline', () => {
-    expect(
-      prepareStringToBeValidFilename(
-        'Get-file-entry.-Either-one-of-workspace-branch-or-commit-ID-needs-to-be-specified.-This-api-supports-providing-download-url-for-large-files.\n'
-      )
-    ).toBe(
-      'get-file-entry-either-one-of-workspace-branch-or-commit-id-needs-to-be-specified-this-api-supports-providing-download-url-for-large-files'
-    );
-  });
-  it('Remove comma', () => {
-    expect(
-      prepareStringToBeValidFilename(
-        'Get-file-entry.-Either-one-of-workspace,-branch-or-commit-ID-needs-to-be-specified.-This-api-supports-providing-download-url-for-large-files.'
-      )
-    ).toBe(
-      'get-file-entry-either-one-of-workspace-branch-or-commit-id-needs-to-be-specified-this-api-supports-providing-download-url-for-large-files'
-    );
-  });
-  it('Remove apostrophe', () => {
-    expect(prepareStringToBeValidFilename("List-user's-repositories")).toBe(
-      'list-users-repositories'
-    );
-  });
-});

package/bin/apiPages/common.d.ts

@@ -1,8 +0,0 @@
-import { NavigationEntry } from '@mintlify/models';
-import { DecoratedGroupsConfig, DecoratedPagesConfig, GroupsConfig, PagesConfig } from '@mintlify/validation';
-export declare const DEFAULT_API_GROUP_NAME = "API Reference";
-export declare const DEFAULT_WEBSOCKETS_GROUP_NAME = "Websockets";
-export declare function findNavGroup(nav: GroupsConfig, groupName?: string): PagesConfig;
-export declare function findNavGroup(nav: DecoratedGroupsConfig, groupName?: string): DecoratedPagesConfig;
-export declare const prepareStringToBeValidFilename: (str?: string) => string | undefined;
-export declare const generateUniqueFilenameWithoutExtension: (pages: NavigationEntry[], base: string) => string;

package/bin/apiPages/common.js

@@ -1,41 +0,0 @@
-export const DEFAULT_API_GROUP_NAME = 'API Reference';
-export const DEFAULT_WEBSOCKETS_GROUP_NAME = 'Websockets';
-export function findNavGroup(nav, groupName = DEFAULT_API_GROUP_NAME) {
-    const group = nav.find((fileOrGroup) => typeof fileOrGroup === 'object' && 'group' in fileOrGroup && fileOrGroup.group === groupName);
-    if (group === undefined || !('pages' in group)) {
-        const newGroup = {
-            group: groupName,
-            pages: [],
-        };
-        nav.push(newGroup);
-        return newGroup.pages;
-    }
-    if (Array.isArray(group.pages)) {
-        return group.pages;
-    }
-    return [];
-}
-export const prepareStringToBeValidFilename = (str) => str
-    ? str
-        .replaceAll(' ', '-')
-        .replace(/\{.*?\}/g, '-') // remove path parameters
-        .replace(/^-/, '')
-        .replace(/-$/, '')
-        .replace(/[{}(),.'\n\/]/g, '') // remove special characters
-        .replaceAll(/--/g, '-') // replace double hyphens
-        .toLowerCase()
-    : undefined;
-// returns a filename that is unique within the given array of pages
-export const generateUniqueFilenameWithoutExtension = (pages, base) => {
-    let filename = base;
-    if (pages.includes(filename)) {
-        let extension = 1;
-        filename = `${base}-${extension}`;
-        while (pages.includes(filename)) {
-            extension += 1;
-            filename = `${base}-${extension}`;
-        }
-    }
-    return filename.toLowerCase();
-};
-//# sourceMappingURL=common.js.map

package/bin/apiPages/common.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/apiPages/common.ts"],"names":[],"mappings":"AASA,MAAM,CAAC,MAAM,sBAAsB,GAAG,eAAe,CAAC;AACtD,MAAM,CAAC,MAAM,6BAA6B,GAAG,YAAY,CAAC;AAI1D,MAAM,UAAU,YAAY,CAC1B,GAAyC,EACzC,YAAoB,sBAAsB;IAE1C,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CACpB,CAAC,WAAW,EAAE,EAAE,CACd,OAAO,WAAW,KAAK,QAAQ,IAAI,OAAO,IAAI,WAAW,IAAI,WAAW,CAAC,KAAK,KAAK,SAAS,CAC/F,CAAC;IACF,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,OAAO,IAAI,KAAK,CAAC,EAAE,CAAC;QAC/C,MAAM,QAAQ,GAAG;YACf,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,EAAE;SACV,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnB,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,GAAY,EAAE,EAAE,CAC7D,GAAG;IACD,CAAC,CAAC,GAAG;SACA,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;SACpB,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,yBAAyB;SAClD,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;SACjB,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;SACjB,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,4BAA4B;SAC1D,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,yBAAyB;SAChD,WAAW,EAAE;IAClB,CAAC,CAAC,SAAS,CAAC;AAEhB,oEAAoE;AACpE,MAAM,CAAC,MAAM,sCAAsC,GAAG,CACpD,KAAwB,EACxB,IAAY,EACJ,EAAE;IACV,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,IAAI,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,QAAQ,GAAG,GAAG,IAAI,IAAI,SAAS,EAAE,CAAC;QAClC,OAAO,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,SAAS,IAAI,CAAC,CAAC;YACf,QAAQ,GAAG,GAAG,IAAI,IAAI,SAAS,EAAE,CAAC;QACpC,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;AAChC,CAAC,CAAC"}

package/src/apiPages/common.ts

@@ -1,64 +0,0 @@
-// Functions used for both OpenAPI and AsyncAPI page generation
-import { NavigationEntry } from '@mintlify/models';
-import {
-  DecoratedGroupsConfig,
-  DecoratedPagesConfig,
-  GroupsConfig,
-  PagesConfig,
-} from '@mintlify/validation';
-
-export const DEFAULT_API_GROUP_NAME = 'API Reference';
-export const DEFAULT_WEBSOCKETS_GROUP_NAME = 'Websockets';
-
-export function findNavGroup(nav: GroupsConfig, groupName?: string): PagesConfig;
-export function findNavGroup(nav: DecoratedGroupsConfig, groupName?: string): DecoratedPagesConfig;
-export function findNavGroup(
-  nav: GroupsConfig | DecoratedGroupsConfig,
-  groupName: string = DEFAULT_API_GROUP_NAME
-): PagesConfig | DecoratedPagesConfig {
-  const group = nav.find(
-    (fileOrGroup) =>
-      typeof fileOrGroup === 'object' && 'group' in fileOrGroup && fileOrGroup.group === groupName
-  );
-  if (group === undefined || !('pages' in group)) {
-    const newGroup = {
-      group: groupName,
-      pages: [],
-    };
-    nav.push(newGroup);
-    return newGroup.pages;
-  }
-  if (Array.isArray(group.pages)) {
-    return group.pages;
-  }
-  return [];
-}
-
-export const prepareStringToBeValidFilename = (str?: string) =>
-  str
-    ? str
-        .replaceAll(' ', '-')
-        .replace(/\{.*?\}/g, '-') // remove path parameters
-        .replace(/^-/, '')
-        .replace(/-$/, '')
-        .replace(/[{}(),.'\n\/]/g, '') // remove special characters
-        .replaceAll(/--/g, '-') // replace double hyphens
-        .toLowerCase()
-    : undefined;
-
-// returns a filename that is unique within the given array of pages
-export const generateUniqueFilenameWithoutExtension = (
-  pages: NavigationEntry[],
-  base: string
-): string => {
-  let filename = base;
-  if (pages.includes(filename)) {
-    let extension = 1;
-    filename = `${base}-${extension}`;
-    while (pages.includes(filename)) {
-      extension += 1;
-      filename = `${base}-${extension}`;
-    }
-  }
-  return filename.toLowerCase();
-};