@valiantys/atlassian-app-frontend 1.0.0

package/atlassian-app-frontend.api.md

@@ -0,0 +1,740 @@
+## API Report File for "@valiantys/atlassian-app-frontend"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Context } from 'react';
+import { default as default_2 } from 'react';
+import { Dispatch } from 'react';
+import { FlagAction } from '@forge/bridge/out/flag/flag';
+import { FlagAppearance } from '@forge/bridge/out/flag/flag';
+import { FlagOptions } from '@forge/bridge/out/flag/flag';
+import { FullContext } from '@forge/bridge/out/types';
+import { HeadingSize } from '@atlaskit/heading/dist/types/heading.partial';
+import { History as History_2 } from 'history';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+import { ReactElement } from 'react';
+import { ReactNode } from 'react';
+import { SetStateAction } from 'react';
+
+// @public (undocumented)
+export interface AccountContext {
+    // (undocumented)
+    accountId: string;
+}
+
+// @public (undocumented)
+export type ActionsType = FlagAction[];
+
+// @public (undocumented)
+export function addAuthHeader(authToken: string, headers: HeadersInit): {
+    Authorization: string;
+};
+
+// @public (undocumented)
+export type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
+
+// @public (undocumented)
+export type AppearanceTypes = FlagAppearance;
+
+// @public (undocumented)
+export interface AppFlagAction {
+    // (undocumented)
+    id: string | number;
+    // (undocumented)
+    props?: AppFlagTypes;
+    // (undocumented)
+    type: AppFlagActions;
+}
+
+// @public (undocumented)
+export type AppFlagActions = 'add' | 'remove';
+
+// @public (undocumented)
+export const AppFlagsDispatchContext: Context<Dispatch<AppFlagAction> | undefined>;
+
+// @public (undocumented)
+export function AppFlagsProviderAtlasKit({ children, }: {
+    children: ReactNode;
+}): JSX_2.Element;
+
+// @public (undocumented)
+export type AppFlagTypes = FlagOptions;
+
+// @public (undocumented)
+export function AtlassianApp({ children, appName, doCheckWorkspace, embeddedConfig, standaloneConfig, }: PropsWithChildren<AtlassianAppConfig>): JSX_2.Element;
+
+// @public (undocumented)
+export interface AtlassianAppConfig {
+    appName: string;
+    doCheckWorkspace?: boolean;
+    embeddedConfig?: {
+        invokeRemoteImpl?: InvokeRemoteSignature;
+        useAtlasKitFlags?: boolean;
+    };
+    standaloneConfig?: {
+        oauthConfig?: OAuthProviderProps & {
+            doCheckResource?: boolean;
+        };
+        initialMockViewContext?: Partial<FullContext>;
+        backendUrl?: string;
+        remoteUrl?: string;
+        modalOpenerConfig?: {
+            resourceMap?: Record<string, string>;
+            defaultUrl: string;
+        };
+        modalContextConfig?: {
+            openerOrigin: string;
+        };
+    };
+}
+
+// @public (undocumented)
+export function AtlassianAppTest({ mockContext, invoke, invokeRemote, jiraFetchService, confluenceFetchService, bitbucketFetchService, hostRouter, children, }: PropsWithChildren<AtlassianAppTestProps>): JSX_2.Element;
+
+// @public (undocumented)
+export interface AtlassianAppTestProps {
+    // (undocumented)
+    bitbucketFetchService?: AtlassianProductFetchService<'bitbucket'>;
+    // (undocumented)
+    confluenceFetchService?: AtlassianProductFetchService<'confluence'>;
+    // (undocumented)
+    hostRouter: HostRouter;
+    // (undocumented)
+    invoke: InvokeSignature;
+    // (undocumented)
+    invokeRemote: InvokeRemoteSignature;
+    // (undocumented)
+    jiraFetchService?: AtlassianProductFetchService<'jira'>;
+    // (undocumented)
+    mockContext: FullContext;
+}
+
+// @public (undocumented)
+export function atlassianOAuthBitbucketFetch(authToken: string): AtlassianProductFetchService<'bitbucket'>;
+
+// @public (undocumented)
+export function atlassianOAuthConfluenceFetch(authToken: string, cloudId: string): AtlassianProductFetchService<'confluence'>;
+
+// @public (undocumented)
+export function atlassianOAuthJiraFetch(authToken: string, cloudId: string): AtlassianProductFetchService<'jira'>;
+
+// @public (undocumented)
+export function atlassianOAuthRawFetch<P extends Product>(authToken: string, domain: string, productType: P): AtlassianProductFetchService<P>;
+
+// @public (undocumented)
+export type AtlassianOAuthScopes = 'read:me' | 'read:jira-user' | 'read:jira-work' | 'read:servicedesk-request' | 'write:servicedesk-request' | 'read:cmdb-schema:jira' | 'write:cmdb-schema:jira' | 'read:cmdb-type:jira' | 'write:cmdb-type:jira' | 'read:cmdb-object:jira' | 'write:cmdb-object:jira' | 'delete:cmdb-object:jira' | 'read:cmdb-attribute:jira' | 'write:cmdb-attribute:jira' | 'read:cmdb-icon:jira';
+
+// @public (undocumented)
+export interface AtlassianProductFetchService<P extends Product> {
+    // (undocumented)
+    fetch: <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+    // (undocumented)
+    fullUrl: (path: string) => string;
+    // (undocumented)
+    productType: P;
+    // (undocumented)
+    rawFetch: (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
+    // (undocumented)
+    route: (template: TemplateStringsArray, ...parameters: (string | number | URLSearchParams | FetchRoute)[]) => FetchRoute;
+}
+
+// @public (undocumented)
+export interface AtlassianUserResource {
+    // (undocumented)
+    avatarUrl: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    scopes: string[];
+    // (undocumented)
+    url: string;
+}
+
+// @public (undocumented)
+export class AtlassianUserResourceService {
+    // (undocumented)
+    checkUserChosenResource(authToken: string, resourceId?: string): Promise<{
+        hasChosen: true;
+        resource: {
+            name: string;
+            id: string;
+        };
+    } | {
+        hasChosen: false;
+        resources: {
+            name: string;
+            id: string;
+        }[];
+    }>;
+    // (undocumented)
+    getAtlassianUserResources(authToken: string): Promise<AtlassianUserResource[]>;
+    // (undocumented)
+    readonly userResourcesUrl = "https://api.atlassian.com/oauth/token/accessible-resources";
+}
+
+// @public (undocumented)
+export class AtlassianUserWorkspaceService {
+    constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
+    // (undocumented)
+    checkUserChosenWorkspace(workspaceId?: string): Promise<WorkspaceChoices>;
+    // Warning: (ae-forgotten-export) The symbol "AssetsWorkspace" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    getAllUserWorkspaces(): Promise<AssetsWorkspace[]>;
+    // (undocumented)
+    readonly workspaceApiUrl: string;
+}
+
+// Warning: (ae-forgotten-export) The symbol "BackendAdapterProviderProps" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export function BackendAdapterProvider({ children, invokeImplementation, }: BackendAdapterProviderProps): JSX_2.Element;
+
+// @public (undocumented)
+export function bearerAuthFetch<T>(authToken: string, url: string, method: FetchMethod, body?: Record<string, unknown>, responseType?: 'json' | 'text', headers?: Record<string, string>): Promise<T>;
+
+// @public (undocumented)
+export function bearerAuthFetchRaw(authToken: string, url: string, init: RequestInit): Promise<Response>;
+
+// @public (undocumented)
+export class CommonResolverPaths {
+    // (undocumented)
+    static getOauthToken: string;
+}
+
+// @public (undocumented)
+export function defaultProps(makeMockFunction: () => any): AtlassianAppTestProps;
+
+// @public (undocumented)
+export function FeatureChosenResourceCheck({ checkResource, children, }: FeatureChosenResourceCheckProps): ReactElement;
+
+// @public (undocumented)
+export interface FeatureChosenResourceCheckProps {
+    // (undocumented)
+    checkResource: (resourceId?: string) => Promise<{
+        hasChosen: true;
+    } | {
+        hasChosen: false;
+        resources: Resource[];
+    }>;
+    // (undocumented)
+    children: ReactElement;
+}
+
+// @public (undocumented)
+export function FeatureChosenWorkspaceCheck({ appName, children, }: PropsWithChildren<FeatureChosenWorkspaceCheckProps>): ReactElement;
+
+// @public (undocumented)
+export interface FeatureChosenWorkspaceCheckProps {
+    // (undocumented)
+    appName?: string;
+}
+
+// @public (undocumented)
+export class FetchError {
+    constructor(message: string);
+    // (undocumented)
+    message: string;
+}
+
+// @public (undocumented)
+export type FetchMethod = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH';
+
+// @public (undocumented)
+export interface FetchRequest {
+    // (undocumented)
+    allowExperimental?: boolean;
+    // (undocumented)
+    method: FetchMethod;
+    // (undocumented)
+    responseType?: 'json' | 'text';
+    // (undocumented)
+    url: FetchRoute;
+}
+
+// @public (undocumented)
+export type FetchRoute = {
+    readonly value: string;
+};
+
+// @public (undocumented)
+export interface ForgeRequest<T, U extends AccountContext = AccountContext> {
+    // (undocumented)
+    context: U;
+    // (undocumented)
+    payload: T;
+}
+
+// @public (undocumented)
+export type ForgeResolverFunction<P, R, C extends AccountContext = AccountContext> = (request: ForgeRequest<P, C>) => Promise<R> | R;
+
+// @public (undocumented)
+export function getAtlassianOAuthToken(grant_type: string, client_id: string, client_secret: string, code: string, redirect_uri: string): Promise<unknown>;
+
+// @public (undocumented)
+export function getAtlassianUserDetails(authToken: string): Promise<OAuthUser>;
+
+// @public (undocumented)
+export function getOauthFetchInvokeImpl(urlBase: string, // serverUrl + ':' + serverPort + '/api/'
+authToken: string, resourceId: string): InvokeSignature;
+
+// @public (undocumented)
+export interface GlobalPageContext extends AccountContext {
+    // (undocumented)
+    cloudId: string;
+    // (undocumented)
+    environmentId: string;
+    // (undocumented)
+    environmentType: string;
+    // (undocumented)
+    extension: {
+        type: string;
+    };
+    // (undocumented)
+    installContext: string;
+    // (undocumented)
+    localId: string;
+    // (undocumented)
+    moduleKey: string;
+    // (undocumented)
+    siteUrl: string;
+}
+
+// @public (undocumented)
+export interface HostRouter {
+    // (undocumented)
+    navigate(url: string): Promise<void>;
+    // (undocumented)
+    open(url: string): Promise<void>;
+    // (undocumented)
+    reload(): Promise<void>;
+}
+
+// Warning: (ae-forgotten-export) The symbol "HostRouterProviderProps" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export function HostRouterProvider({ children, hostRouter, }: HostRouterProviderProps): JSX_2.Element;
+
+// @public (undocumented)
+export interface IframeProps {
+    // (undocumented)
+    height?: string;
+    // (undocumented)
+    link: string;
+    // (undocumented)
+    title?: string;
+    // (undocumented)
+    width?: string;
+}
+
+// @public (undocumented)
+export type InvokePayload = {
+    [key in number | string]: unknown;
+};
+
+// @public (undocumented)
+export interface InvokeRemoteResponse<T> {
+    // (undocumented)
+    body?: T;
+    // (undocumented)
+    headers?: Record<string, string>;
+    // (undocumented)
+    status: number;
+}
+
+// @public (undocumented)
+export type InvokeRemoteSignature = <T, U>(input: {
+    path: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    headers?: Record<string, string>;
+    body?: U;
+}) => Promise<InvokeRemoteResponse<T>>;
+
+// @public (undocumented)
+export type InvokeSignature = <T = unknown, U = InvokePayload>(action: string, data?: U) => Promise<T>;
+
+// @public (undocumented)
+export const IS_STANDALONE: boolean;
+
+// @public (undocumented)
+export interface IssueContext extends AccountContext {
+    // (undocumented)
+    extension: {
+        issue: {
+            key: string;
+        };
+    };
+}
+
+// @public (undocumented)
+export interface JiraIssueExtensionData {
+    // (undocumented)
+    issue: {
+        key: string;
+        id: string;
+        type: string;
+        typeId: string;
+    };
+    // (undocumented)
+    project: {
+        id: string;
+        key: string;
+        type: string;
+    };
+    // (undocumented)
+    type: string;
+}
+
+// @public (undocumented)
+export function JiraWorkspaceProvider({ children, workspaceId, }: PropsWithChildren<{
+    workspaceId?: string;
+}>): JSX_2.Element;
+
+// @public (undocumented)
+export function jsonFetch<T, U = Record<string, unknown>>(url: string, method: FetchMethod, headers?: Record<string, string>, body?: U, responseType?: 'json' | 'text'): Promise<T>;
+
+// @public (undocumented)
+export class MockViewContext implements ViewContext {
+    constructor(context: FullContext);
+    // (undocumented)
+    close(_payload?: unknown): Promise<void>;
+    // (undocumented)
+    context: FullContext;
+    // (undocumented)
+    createHistory(): Promise<History_2>;
+    // (undocumented)
+    getContext(): Promise<FullContext>;
+    // (undocumented)
+    refresh(): Promise<void>;
+    // (undocumented)
+    submit(_payload: unknown): Promise<void>;
+    // (undocumented)
+    theme: {
+        enable(): Promise<void>;
+    };
+}
+
+// @public (undocumented)
+export function ModalContent<T>({ children }: PropsWithChildren): JSX_2.Element;
+
+// @public (undocumented)
+export function ModalContentIframe<T>({ messageCallback, closeOnMouseOut, }: {
+    messageCallback?: (eventData: T, iframeProps?: IframeProps) => {
+        newHeight?: string;
+    };
+    closeOnMouseOut?: boolean;
+}): JSX_2.Element;
+
+// @public (undocumented)
+export interface ModalContentService<T> {
+    // (undocumented)
+    close: (payload?: unknown) => void;
+    // (undocumented)
+    modalContextData?: T;
+}
+
+// @public
+export function ModalDialogLayout({ title, buttonGroup, children, }: PropsWithChildren<ModalDialogLayoutProps>): JSX_2.Element;
+
+// @public (undocumented)
+export interface ModalDialogLayoutProps {
+    // (undocumented)
+    buttonGroup: default_2.ReactNode;
+    // (undocumented)
+    title: string;
+}
+
+// @public (undocumented)
+export interface ModalOptions<C, P> {
+    // (undocumented)
+    closeOnEscape?: boolean;
+    // (undocumented)
+    closeOnOverlayClick?: boolean;
+    // (undocumented)
+    context?: C;
+    // (undocumented)
+    onClose?: (payload?: P) => any;
+    // (undocumented)
+    resource?: string | null;
+    // Warning: (ae-forgotten-export) The symbol "ModalSize" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    size?: ModalSize;
+}
+
+// @public (undocumented)
+export interface ModalService {
+    // (undocumented)
+    open<C, P>(options: ModalOptions<C, P>): Promise<void>;
+}
+
+// Warning: (ae-forgotten-export) The symbol "ModalServiceProviderProps" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export function ModalServiceProvider({ children, modalService, }: ModalServiceProviderProps): JSX_2.Element;
+
+// @public (undocumented)
+export class ModalViewContext extends MockViewContext {
+    constructor(context: FullContext, openerOrigin?: string);
+    // (undocumented)
+    close: (payload?: unknown) => Promise<void>;
+    // (undocumented)
+    context: FullContext;
+}
+
+// @public (undocumented)
+export interface OAuth {
+    // (undocumented)
+    getAuthToken: () => string;
+}
+
+// @public (undocumented)
+export function oauthFetchInvokeRemote(baseUrl: string, authToken?: string): InvokeRemoteSignature;
+
+// @public (undocumented)
+export function OAuthProvider({ children, ...config }: PropsWithChildren<OAuthProviderProps>): JSX_2.Element;
+
+// @public (undocumented)
+export interface OAuthProviderProps {
+    appName: string;
+    // (undocumented)
+    clientId: string;
+    // (undocumented)
+    codeTokenExchangeUrl: string;
+    // (undocumented)
+    oAuthScopes: AtlassianOAuthScopes[];
+}
+
+// @public (undocumented)
+export interface OAuthUser {
+    // (undocumented)
+    account_id: string;
+    // (undocumented)
+    account_status: string;
+    // (undocumented)
+    account_type: string;
+    // (undocumented)
+    characteristics: {
+        not_mentionable: boolean;
+    };
+    // (undocumented)
+    email: string;
+    // (undocumented)
+    email_verified: boolean;
+    // (undocumented)
+    extended_profile: {
+        job_title: string;
+        organization: string;
+        location: string;
+        phone_numbers: number[];
+    };
+    // (undocumented)
+    last_updated: string;
+    // (undocumented)
+    locale: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    nickname: string;
+    // (undocumented)
+    picture: string;
+    // (undocumented)
+    zoneinfo: string;
+}
+
+// @public (undocumented)
+export interface PagedResponseValues<T> {
+    // (undocumented)
+    isLast: boolean;
+    // (undocumented)
+    maxResults: number;
+    // (undocumented)
+    startAt: number;
+    // (undocumented)
+    total: number;
+    // (undocumented)
+    values: T[];
+}
+
+// @public (undocumented)
+export function PageLoadingView({ label, loadingError, labelSize, }: {
+    label: string;
+    loadingError?: string;
+    labelSize?: HeadingSize;
+}): JSX_2.Element;
+
+// @public (undocumented)
+export type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
+
+// Warning: (ae-forgotten-export) The symbol "RemoteAdapterProviderProps" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export function RemoteAdapterProvider({ children, invokeRemoteImplementation, }: RemoteAdapterProviderProps): JSX_2.Element;
+
+// Warning: (ae-forgotten-export) The symbol "RequestBitbucketProviderProps" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export function RequestBitbucketProvider({ children, requestBitbucketImplementation, }: RequestBitbucketProviderProps): JSX_2.Element;
+
+// Warning: (ae-forgotten-export) The symbol "RequestConfluenceProviderProps" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export function RequestConfluenceProvider({ children, requestConfluenceImplementation, }: RequestConfluenceProviderProps): JSX_2.Element;
+
+// Warning: (ae-forgotten-export) The symbol "RequestJiraProviderProps" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export function RequestJiraProvider({ children, requestJiraImplementation, }: RequestJiraProviderProps): JSX_2.Element;
+
+// @public (undocumented)
+export interface RequestObject {
+    // Warning: (ae-forgotten-export) The symbol "InvokePayload_2" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    context: InvokePayload_2['context'];
+    // (undocumented)
+    payload: RequestPayload;
+}
+
+// @public (undocumented)
+export type RequestPayload = {
+    [key in number | string]: unknown;
+};
+
+// Warning: (ae-forgotten-export) The symbol "Response_2" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export type ResolverFunction = (request: RequestObject) => Promise<Response_2> | Response_2;
+
+// @public (undocumented)
+export interface Resource {
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+}
+
+// @public (undocumented)
+export interface ResponseObject {
+    // (undocumented)
+    [key: string]: unknown;
+}
+
+// @public (undocumented)
+export function route(template: TemplateStringsArray, ...parameters: (string | number | URLSearchParams | FetchRoute)[]): FetchRoute;
+
+// @public (undocumented)
+export function useAppFlagsDispatch(): Dispatch<AppFlagAction>;
+
+// @public (undocumented)
+export function useAppFlagsDispatchMethods(): {
+    addFlag: (props: AppFlagTypes) => void;
+    removeFlag: (flagId: string) => void;
+    addErrorFlag: (flagId: string, title: string, error?: unknown, actions?: ActionsType) => void;
+};
+
+// Warning: (ae-forgotten-export) The symbol "BackendAdapterService" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export const useBackendAdapter: () => BackendAdapterService;
+
+// @public (undocumented)
+export const useHostRouter: () => HostRouter;
+
+// Warning: (ae-forgotten-export) The symbol "defaultErrorHandler" needs to be exported by the entry point index.d.ts
+//
+// @public
+export function useLoadDataEffect<T>(requestFunc: () => Promise<T>, errorHandler?: typeof defaultErrorHandler): {
+    data: T | undefined;
+    loading: boolean;
+    error: string | undefined;
+    setData: Dispatch<SetStateAction<T | undefined>>;
+    setLoading: Dispatch<SetStateAction<boolean>>;
+    setError: Dispatch<SetStateAction<string | undefined>>;
+    manualTrigger: () => Promise<T | undefined>;
+};
+
+// @public (undocumented)
+export function useModalContentService<T>(): ModalContentService<T>;
+
+// @public (undocumented)
+export const useModalService: () => ModalService;
+
+// @public (undocumented)
+export const useOAuth: () => OAuth;
+
+// Warning: (ae-forgotten-export) The symbol "RemoteAdapterService" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export const useRemoteAdapter: () => RemoteAdapterService;
+
+// @public (undocumented)
+export const useRequestBitbucket: () => AtlassianProductFetchService<"bitbucket">;
+
+// @public (undocumented)
+export const useRequestConfluence: () => AtlassianProductFetchService<"confluence">;
+
+// @public (undocumented)
+export const useRequestJira: () => AtlassianProductFetchService<"jira">;
+
+// @public (undocumented)
+export const useViewContext: () => ViewContext;
+
+// @public (undocumented)
+export const useWorkspaceId: () => string | undefined;
+
+// @public (undocumented)
+export interface ViewContext {
+    close(payload?: unknown): Promise<void>;
+    // (undocumented)
+    createHistory(): Promise<History_2>;
+    // (undocumented)
+    getContext(): Promise<FullContext>;
+    // (undocumented)
+    refresh(): Promise<void>;
+    submit(payload: unknown): Promise<void>;
+    // (undocumented)
+    theme: {
+        enable(): Promise<void>;
+    };
+}
+
+// Warning: (ae-forgotten-export) The symbol "ViewContextProviderProps" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export function ViewContextProvider({ children, viewContext, }: ViewContextProviderProps): JSX_2.Element;
+
+// @public (undocumented)
+export class WindowHostRouter implements HostRouter {
+    // (undocumented)
+    navigate(url: string): Promise<void>;
+    // (undocumented)
+    open(url: string): Promise<void>;
+    // (undocumented)
+    reload(): Promise<void>;
+}
+
+// @public (undocumented)
+export class WindowModalService implements ModalService {
+    constructor(defaultUrl: string, resourceMap?: Record<string, string>);
+    // (undocumented)
+    open<C, P>(options: ModalOptions<C, P>): Promise<void>;
+}
+
+// @public (undocumented)
+export type WorkspaceChoices = {
+    hasChosen: true;
+    workspace: string;
+} | {
+    hasChosen: false;
+    workspaces: AssetsWorkspace[];
+};
+
+// (No @packageDocumentation comment for this package)
+
+```