All files / microfrontends index.ts

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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/*
 * Copyright 2021 Harness Inc. All rights reserved.
 * Use of this source code is governed by the PolyForm Shield 1.0.0 license
 * that can be found in the licenses directory at the root of this repository, also available at
 * https://polyformproject.org/wp-content/uploads/2020/06/PolyForm-Shield-1.0.0.txt.
 */
 
// eslint-disable-next-line import/order
import type React from 'react'
import type ReactMonacoEditor from 'react-monaco-editor'
import type { MonacoDiffEditor } from 'react-monaco-editor'
import type { PermissionsContextProps } from 'framework/rbac/PermissionsContext'
import type { LicenseStoreContextProps } from 'framework/LicenseStore/LicenseStoreContext'
import type { AppStoreContextProps } from 'framework/AppStore/AppStoreContext'
import type { NGBreadcrumbsProps } from '@common/components/NGBreadcrumbs/NGBreadcrumbs'
import { ResourceType } from '@rbac/interfaces/ResourceType'
import { PermissionIdentifier } from '@rbac/interfaces/PermissionIdentifier'
import type { ButtonProps } from '@rbac/components/Button/Button'
import type { RbacMenuItemProps } from '@rbac/components/MenuItem/MenuItem'
import type { Title, UseDocumentTitleReturn } from '@common/hooks/useDocumentTitle'
import type { ExtendedMonacoEditorProps } from '@common/components/MonacoEditor/MonacoEditor'
import type { ExtendedMonacoDiffEditorProps } from '@common/components/MonacoDiffEditor/MonacoDiffEditor'
import type { YamlBuilderProps } from '@common/interfaces/YAMLBuilderProps'
import type { GitOpsCustomMicroFrontendProps } from '@cd/interfaces/GitOps.types'
 
export interface Scope {
  accountId?: string
  orgIdentifier?: string
  projectIdentifier?: string
}
 
export interface CommonComponents {
  NGBreadcrumbs: React.ComponentType<Partial<NGBreadcrumbsProps>>
  RbacButton: React.ComponentType<ButtonProps>
  RbacMenuItem: React.ComponentType<RbacMenuItemProps>
  MonacoEditor: React.ForwardRefExoticComponent<ExtendedMonacoEditorProps & React.RefAttributes<ReactMonacoEditor>>
  YAMLBuilder: React.FC<YamlBuilderProps>
  MonacoDiffEditor: React.ForwardRefExoticComponent<
    ExtendedMonacoDiffEditorProps & React.RefAttributes<MonacoDiffEditor>
  >
}
 
export interface Hooks {
  useDocumentTitle(title: Title): UseDocumentTitleReturn
}
 
/**
 * Parent contexts which consists of all the context used in the parent app
 */
export interface ParentContext {
  appStoreContext: React.Context<AppStoreContextProps>
  permissionsContext: React.Context<PermissionsContextProps>
  licenseStoreProvider: React.Context<LicenseStoreContextProps>
}
 
export interface ChildAppProps {
  parentContextObj: ParentContext
  renderUrl: string
  matchPath: string
  scope: Scope
  components: CommonComponents
  hooks: Hooks
  on401: () => void
}
 
/**
 * function to render child app inside the parent
 */
export type ChildAppComponent = React.ComponentType<ChildAppProps>
 
export {
  AppStoreContextProps,
  LicenseStoreContextProps,
  PermissionsContextProps,
  ResourceType,
  PermissionIdentifier,
  GitOpsCustomMicroFrontendProps
}