@patternfly/patternfly-doc-core 1.15.4 → 1.15.5

package/src/utils/apiIndex/fetch.ts

@@ -0,0 +1,20 @@
+import type { ApiIndex } from './generate'
+
+/**
+ * Fetches the API index from the server as a static asset
+ * Used by API routes at runtime instead of importing the JSON statically
+ *
+ * @param url - The URL object from the API route context
+ * @returns Promise resolving to the API index structure
+ */
+export async function fetchApiIndex(url: URL): Promise<ApiIndex> {
+  const apiIndexUrl = new URL('/apiIndex.json', url.origin)
+  const response = await fetch(apiIndexUrl)
+
+  if (!response.ok) {
+    throw new Error(`Failed to load API index: ${response.status} ${response.statusText}`)
+  }
+
+  const data = (await response.json()) as ApiIndex
+  return data
+}

package/src/utils/apiIndex/generate.ts

@@ -1,10 +1,12 @@
 /* eslint-disable no-console */
 import { join } from 'path'
-import { writeFile } from 'fs/promises'
+import { writeFile, mkdir } from 'fs/promises'
 import { getCollection } from 'astro:content'
 import type { CollectionKey } from 'astro:content'
 import { content } from '../../content'
-import { kebabCase, getDefaultTab, addDemosOrDeprecated } from '../index'
+import { kebabCase, addDemosOrDeprecated } from '../index'
+import { getDefaultTabForApi } from '../packageUtils'
+import { getOutputDir } from '../getOutputDir'
 
 const SOURCE_ORDER: Record<string, number> = {
   react: 1,
@@ -107,7 +109,7 @@ export async function generateApiIndex(): Promise<ApiIndex> {
 
       // Collect tab
       const entryTab =
-        entry.data.tab || entry.data.source || getDefaultTab(entry.filePath)
+        entry.data.tab || entry.data.source || getDefaultTabForApi(entry.filePath)
       const tab = addDemosOrDeprecated(entryTab, entry.id)
       if (!pageTabs[pageKey]) {
         pageTabs[pageKey] = new Set()
@@ -131,15 +133,17 @@ export async function generateApiIndex(): Promise<ApiIndex> {
 }
 
 /**
- * Writes API index to src/apiIndex.json
+ * Writes API index to a apiIndex.json file in the user defined output directory
  * This file is used by server-side API routes to avoid runtime getCollection() calls
  *
  * @param index - The API index structure to write
  */
 export async function writeApiIndex(index: ApiIndex): Promise<void> {
-  const indexPath = join(process.cwd(), 'src', 'apiIndex.json')
+  const outputDir = await getOutputDir()
+  const indexPath = join(outputDir, 'apiIndex.json')
 
   try {
+    await mkdir(outputDir, { recursive: true })
     await writeFile(indexPath, JSON.stringify(index, null, 2))
     console.log(`✓ Generated API index with ${index.versions.length} versions`)
   } catch (error) {

package/src/utils/apiIndex/get.ts

@@ -1,6 +1,7 @@
 import { join } from 'path'
 import { readFile } from 'fs/promises'
 import type { ApiIndex } from './generate'
+import { getOutputDir } from '../getOutputDir'
 
 /**
  * Reads and parses the API index file
@@ -10,7 +11,8 @@ import type { ApiIndex } from './generate'
  * @throws Error if index file is not found, contains invalid JSON, or has invalid structure
  */
 export async function getApiIndex(): Promise<ApiIndex> {
-  const indexPath = join(process.cwd(), 'src', 'apiIndex.json')
+  const outputDir = await getOutputDir()
+  const indexPath = join(outputDir, 'apiIndex.json')
 
   try {
     const content = await readFile(indexPath, 'utf-8')

package/src/utils/getOutputDir.ts

@@ -0,0 +1,19 @@
+import { join } from 'path'
+import { getConfig } from '../../cli/getConfig'
+
+export async function getOutputDir(): Promise<string> {
+  const config = await getConfig(join(process.cwd(), 'pf-docs.config.mjs'))
+  if (!config) {
+    throw new Error(
+      'No config found, please run the `setup` command or manually create a pf-docs.config.mjs file',
+    )
+  }
+
+  if (!config.outputDir) {
+    throw new Error(
+      'No outputDir found in config file, an output directory must be defined in your config file e.g. "dist"',
+    )
+  }
+
+  return config.outputDir
+}

package/src/utils/packageUtils.ts

@@ -61,7 +61,9 @@ export const getDefaultTab = (filePath?: string): string => {
   const packageName = getPackageName(filePath)
   const tabBase = getTabBase(packageName)
 
-  const tab = addDemosOrDeprecated(tabBase, filePath)
-
-  return tab
+  return addDemosOrDeprecated(tabBase, filePath)
 }
+
+// This function is specifically for API routes where we need a fallback tab name
+// to ensure content is always accessible even when the default tab logic doesn't apply
+export const getDefaultTabForApi = (filePath?: string): string => getDefaultTab(filePath) || 'text'

package/tsconfig.json

@@ -7,8 +7,13 @@
     "module": "ESNext",
     "moduleResolution": "bundler",
     "importHelpers": true,
-    "verbatimModuleSyntax": false,
+    "verbatimModuleSyntax": false
   },
-  "include": [".astro/types.d.ts", "**/*"],
-  "exclude": ["dist"]
-}
+  "include": [
+    ".astro/types.d.ts",
+    "**/*"
+  ],
+  "exclude": [
+    "dist"
+  ]
+}

package/dist/docs/_worker.js/chunks/apiIndex_rjiPwa_V.mjs

@@ -1,9 +0,0 @@
-globalThis.process ??= {}; globalThis.process.env ??= {};
-const versions = [];
-const sections = {};
-const pages = {};
-const tabs = {};
-const index = {
-  versions};
-
-export { index as i, pages as p, sections as s, tabs as t, versions as v };