@mintlify/scraping 4.0.361 → 4.0.362

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/scraping",
-  "version": "4.0.361",
+  "version": "4.0.362",
   "description": "Scrape documentation frameworks to Mintlify docs",
   "engines": {
     "node": ">=18.0.0"
@@ -77,5 +77,5 @@
     "typescript": "^5.5.3",
     "vitest": "^2.0.4"
   },
-  "gitHead": "1d5e4b6d8c14cf8ecff494a4eded6c565d7c2697"
+  "gitHead": "3b4c472d21ffa6f591bbb48886476a5e1b6b3a00"
 }

package/src/openapi/common.ts

@@ -27,6 +27,9 @@ export type OpenApiExtensions = {
   'x-mint'?: XMint;
   'x-excluded'?: boolean;
   'x-hidden'?: boolean;
+  'x-private'?: string;
+  'x-for-clients'?: string[];
+  'x-for-feature-flags'?: string[];
 };
 
 export const getOpenApiDefinition = async (
@@ -160,6 +163,10 @@ export function processOpenApiPath<N, DN>(
         return;
       }
       const xMint = operation?.['x-mint'];
+      const xAuthGroups = getXCustomTagsAllowlist({
+        pathObject: pathItemObject,
+        operationObject: operation,
+      });
 
       if (xMint?.href) {
         xMint.href = optionallyAddLeadingSlash(xMint.href);
@@ -202,12 +209,24 @@ export function processOpenApiPath<N, DN>(
         ],
         openapiMetaTag
       );
+
+      let xMintMetadata = xMint?.metadata;
+      if (xAuthGroups.length > 0) {
+        xMintMetadata = {
+          ...xMintMetadata,
+          groups: [
+            ...(Array.isArray(xMintMetadata?.groups) ? xMintMetadata.groups : []),
+            ...xAuthGroups,
+          ],
+        };
+      }
+
       const page: DecoratedNavigationPage = {
         title: titleTag ?? slugToTitle(filenameWithoutExtension),
         description,
         deprecated: operation?.deprecated,
         version: options.version,
-        ...xMint?.metadata,
+        ...xMintMetadata,
         openapi: openapiMetaTag,
         href: resolve('/', filenameWithoutExtension),
       };
@@ -232,7 +251,7 @@ export function processOpenApiPath<N, DN>(
             openApiMetaTag: openapiMetaTag,
             version: options.version,
             deprecated: operation?.deprecated,
-            metadata: xMint?.metadata,
+            metadata: xMintMetadata,
             extraContent: xMint?.content,
           })
         );
@@ -332,3 +351,50 @@ export function processOpenApiWebhook<N, DN>(
     }
   });
 }
+
+export const getXCustomTagsAllowlist = ({
+  pathObject,
+  operationObject,
+}: {
+  pathObject: OpenAPIV3.PathItemObject<OpenApiExtensions>;
+  operationObject: OpenAPIV3.OperationObject<OpenApiExtensions> | undefined;
+}): string[] => {
+  const allowedGroups: string[] = [];
+  if ('x-private' in pathObject && typeof pathObject['x-private'] === 'string') {
+    allowedGroups.push(pathObject['x-private']);
+  }
+
+  if (
+    operationObject &&
+    'x-private' in operationObject &&
+    typeof operationObject['x-private'] === 'string'
+  ) {
+    allowedGroups.push(operationObject['x-private']);
+  }
+
+  if ('x-for-clients' in pathObject && Array.isArray(pathObject['x-for-clients'])) {
+    allowedGroups.push(...pathObject['x-for-clients']);
+  }
+
+  if (
+    operationObject &&
+    'x-for-clients' in operationObject &&
+    Array.isArray(operationObject['x-for-clients'])
+  ) {
+    allowedGroups.push(...operationObject['x-for-clients']);
+  }
+
+  if ('x-for-feature-flags' in pathObject && Array.isArray(pathObject['x-for-feature-flags'])) {
+    allowedGroups.push(...pathObject['x-for-feature-flags']);
+  }
+
+  if (
+    operationObject &&
+    'x-for-feature-flags' in operationObject &&
+    Array.isArray(operationObject['x-for-feature-flags'])
+  ) {
+    allowedGroups.push(...operationObject['x-for-feature-flags']);
+  }
+
+  return allowedGroups;
+};