docs/src/app/lib/main-context-adapter.ts at 9d548805570fc7082e0a51d8bc4caf1d5b476d72 · github/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
import type { MainContextT } from '@/frame/components/context/MainContext'
import type { AppRouterContext } from '@/app/lib/app-router-context'

/**
 * Adapter to create MainContext-compatible data from App Router context
 * Allows reusing existing components that depend on MainContext
 */
export function adaptAppRouterContextToMainContext(
  appContext: AppRouterContext,
  overrides: Partial<MainContextT> = {},
): MainContextT {
  const baseContext: MainContextT = {
    data: {
      ui: appContext.site.data.ui,
      reusables: {},
      variables: {
        release_candidate: { version: null },
      },
    },

    // Default/fallback values that can be overridden
    allVersions: {},
    breadcrumbs: {
      product: {
        title: '',
        href: undefined,
      },
    },
    communityRedirect: {
      name: '',
      href: '',
    },
    currentPathWithoutLanguage: '',
    currentProduct: undefined,
    currentProductName: '',
    currentProductTree: null,
    currentVersion: appContext.currentVersion,
    enterpriseServerReleases: {
      isOldestReleaseDeprecated: false,
      oldestSupported: '',
      nextDeprecationDate: '',
      supported: [],
      releasesWithOldestDeprecationDate: [],
    },
    enterpriseServerVersions: [],
    error: '',
    featureFlags: {},
    fullUrl: '',
    isHomepageVersion: false,
    nonEnterpriseDefaultVersion: 'free-pro-team@latest',
    page: null,
    relativePath: undefined,
    sidebarTree: null,
    status: 200,
    xHost: '',

    // Apply any overrides
    ...overrides,
  }

  return baseContext
}

/**
 * For components that need MainContext data in App Router,
 * this helper provides a minimal compatible context
 */
export function createMinimalMainContext(
  pageData?: {
    title?: string
    fullTitle?: string
    introPlainText?: string
    topics?: string[]
    documentType?: string
    type?: string
    hidden?: boolean
  },
  appContext?: AppRouterContext,
): MainContextT {
  const defaultAppContext: AppRouterContext = appContext || {
    currentLanguage: 'en',
    currentVersion: 'free-pro-team@latest',
    sitename: 'GitHub Docs',
    site: {
      data: {
        ui: {
          header: { github_docs: 'GitHub Docs' },
          footer: {},
        },
      },
    },
  }

  return adaptAppRouterContextToMainContext(defaultAppContext, {
    page: pageData
      ? {
          documentType: pageData.documentType || 'article',
          type: pageData.type,
          topics: pageData.topics || [],
          title: pageData.title || 'Page Not Found',
          fullTitle: pageData.fullTitle || pageData.title,
          introPlainText: pageData.introPlainText,
          hidden: pageData.hidden || false,
          noEarlyAccessBanner: false,
          applicableVersions: [],
        }
      : null,
  })
}