refactor: undo changes on swagger API utils and hide SAML app APIs

packages/core/package.json

@@ -12,7 +12,7 @@
   },
   "scripts": {
     "precommit": "lint-staged",
-    "copy:apidocs": "rsync -a -m --include '*/' --include '*.openapi.json' --exclude '*' src/routes/ build/routes/ && rsync -a -m --include '*/' --include '*.openapi.json' --exclude '*' src/saml-applications/ build/saml-applications/",
+    "copy:apidocs": "rsync -a -m --include '*/' --include '*.openapi.json' --exclude '*' src/routes/ build/routes/",
     "check": "tsc --noEmit",
     "build": "tsup",
     "build:test": "rm -rf build/ && tsc -p tsconfig.test.json --sourcemap && pnpm run copy:apidocs",

packages/core/src/routes/swagger/utils/documents.ts

@@ -47,17 +47,11 @@ const managementApiIdentifiableEntityNames = Object.freeze([
   'organization-role',
   'organization-scope',
   'organization-invitation',
-  'saml-application',
 ]);
 
 /** Additional tags that cannot be inferred from the path. */
 const additionalTags = Object.freeze(
-  condArray<string>(
-    'Organization applications',
-    'Custom UI assets',
-    'Organization users',
-    EnvSet.values.isDevFeaturesEnabled && 'SAML applications'
-  )
+  condArray<string>('Organization applications', 'Custom UI assets', 'Organization users')
 );
 
 export const buildManagementApiBaseDocument = (
@@ -213,7 +207,7 @@ export const buildUserApiBaseDocument = (
 });
 
 export const getSupplementDocuments = async (
-  directory = 'build',
+  directory = 'routes',
   option?: FindSupplementFilesOptions
 ) => {
   // Find supplemental documents

packages/core/src/routes/swagger/utils/general.ts

@@ -35,7 +35,6 @@ const tagMap = new Map([
   ['sso-connectors', 'SSO connectors'],
   ['sso-connector-providers', 'SSO connector providers'],
   ['.well-known', 'Well-known'],
-  ['saml-applications', 'SAML applications'],
 ]);
 
 /**
@@ -68,43 +67,25 @@ export const findSupplementFiles = async (
   option?: FindSupplementFilesOptions
 ) => {
   const result: string[] = [];
-  const files = await fs.readdir(directory);
 
-  for (const file of files) {
-    const fullPath = path.join(directory, file);
-    const stats = await fs.stat(fullPath);
+  for (const file of await fs.readdir(directory)) {
+    const stats = await fs.stat(path.join(directory, file));
+
+    if (
+      // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+      option?.excludeDirectories?.includes(file) ||
+      (option?.includeDirectories && !option.includeDirectories.includes(file))
+    ) {
+      continue;
+    }
 
     if (stats.isDirectory()) {
-      // Skip if the current directory is excluded
-      if (option?.excludeDirectories?.includes(file)) {
-        continue;
-      }
-
-      // Recursively search subdirectories
-      const subFiles = await findSupplementFiles(fullPath, option);
-      result.push(...subFiles);
+      result.push(...(await findSupplementFiles(path.join(directory, file))));
     } else if (file.endsWith('.openapi.json')) {
-      result.push(fullPath);
+      result.push(path.join(directory, file));
     }
   }
 
-  // If `includeDirectories` is specified, only keep files that contain the specified subdirectories
-  if (option?.includeDirectories?.length && option.includeDirectories.length > 0) {
-    return result.filter((filePath) =>
-      // The fallback to empty array will never happen here, as we've already checked the length of option.`includeDirectories` before entering this branch
-      (option.includeDirectories ?? []).some((directory) => filePath.includes(`/${directory}/`))
-    );
-  }
-
-  // If `excludeDirectories` is specified, exclude files that contain the specified subdirectories
-  if (option?.excludeDirectories?.length && option.excludeDirectories.length > 0) {
-    return result.filter(
-      (filePath) =>
-        // The fallback to empty array will never happen here, as we've already checked the length of option.`excludeDirectories` before entering this branch
-        !(option.excludeDirectories ?? []).some((directory) => filePath.includes(`/${directory}/`))
-    );
-  }
-
   return result;
 };
 /* eslint-enable @silverhand/fp/no-mutating-methods, no-await-in-loop */
@@ -157,9 +138,7 @@ const validateSupplementPaths = (
         if (
           isKeyInObject(operation, 'tags') &&
           Array.isArray(operation.tags) &&
-          !operation.tags.every(
-            (tag) => typeof tag === 'string' && [cloudOnlyTag, devFeatureTag].includes(tag)
-          )
+          !operation.tags.every((tag) => typeof tag === 'string' && reservedTags.has(tag))
         ) {
           throw new TypeError(
             `Cannot use \`tags\` in supplement document on path \`${path}\` and operation \`${method}\` except for tag \`${cloudOnlyTag}\` and \`${devFeatureTag}\`. Define tags in the document root instead.`

packages/core/src/routes/swagger/utils/operation.ts

@@ -138,6 +138,9 @@ export const buildRouterObjects = <T extends UnknownRouter>(routers: T[], option
             .map((method) => method.toLowerCase())
             // There is no need to show the HEAD method.
             .filter((method): method is OpenAPIV3.HttpMethods => method !== 'head')
+            // TODO: Remove this and bring back `/saml-applications` routes before release.
+            // Exclude `/saml-applications` routes for now.
+            .filter(() => !routerPath.startsWith('/saml-applications'))
             .map((httpMethod) => {
               const path = normalizePath(routerPath);
               const operation = buildOperation(httpMethod, stack, routerPath, isAuthGuarded);

packages/core/src/routes/well-known/well-known.openapi.ts

@@ -30,7 +30,7 @@ export default function openapiRoutes<T extends AnonymousRouter, R extends Unkno
     const { pathMap, tags } = groupRoutesByPath(managementApiRoutes);
 
     // Find supplemental documents
-    const supplementDocuments = await getSupplementDocuments('build', {
+    const supplementDocuments = await getSupplementDocuments('routes', {
       excludeDirectories: ['experience', 'interaction', 'account', 'verification'],
     });
     const baseDocument = buildManagementApiBaseDocument(pathMap, tags, ctx.request.origin);