@valiantys/atlassian-app-frontend 2.0.0 → 3.0.0-alpha-2

package/index.d.ts

@@ -1,702 +0,0 @@
-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 { IconButtonAppearance } from '@atlaskit/button/new';
-import { IconProp } from '@atlaskit/button/new';
-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';
-
-export declare interface AccountContext {
-    accountId: string;
-}
-
-export declare type ActionsType = FlagAction[];
-
-export declare function addAuthHeader(authToken: string, headers: HeadersInit): {
-    Authorization: string;
-};
-
-export declare type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
-
-export declare type AppearanceTypes = FlagAppearance;
-
-export declare interface AppFlagAction {
-    type: AppFlagActions;
-    id: string | number;
-    props?: AppFlagTypes;
-}
-
-export declare type AppFlagActions = 'add' | 'remove';
-
-export declare const AppFlagsDispatchContext: Context<Dispatch<AppFlagAction> | undefined>;
-
-export declare function AppFlagsProviderAtlasKit({ children, }: {
-    children: ReactNode;
-}): JSX_2.Element;
-
-export declare type AppFlagTypes = FlagOptions;
-
-declare interface AssetsWorkspace {
-    workspaceId: string;
-}
-
-export declare function AtlassianApp({ children, appName, doCheckWorkspace, embeddedConfig, standaloneConfig, }: PropsWithChildren<AtlassianAppConfig>): JSX_2.Element;
-
-export declare interface AtlassianAppConfig {
-    /**
-     * Name used to prefix any local storage settings.
-     */
-    appName: string;
-    /**
-     * Workspace is required for any API calls involving Assets
-     */
-    doCheckWorkspace?: boolean;
-    /**
-     * Configuration needed when app is deployed and running inside an Atlassian context (embedded in Jira).
-     */
-    embeddedConfig?: {
-        /**
-         * A custom implementation for making requests directly to remote APIs (fetch).
-         * If left undefined, the @forge/bridge invokeRemote method will be used.
-         */
-        invokeRemoteImpl?: InvokeRemoteSignature;
-        /**
-         * If true, the app will always use it's own AtlasKit FlagGroup to display flags.
-         * These flags will be contained within the borders of the App's iframe.
-         * Otherwise, the app will use the @forge/bridge showFlag API to add any flags to
-         * the host products flag group.
-         *
-         * @default is false
-         */
-        useAtlasKitFlags?: boolean;
-    };
-    /**
-     * Configuration needed when app is running in standalone mode, outside of jira.
-     */
-    standaloneConfig?: AtlassianAppStandaloneConfig;
-}
-
-export declare function AtlassianAppStandalone({ initialMockViewContext, backendUrl, remoteUrl, doCheckWorkspace, appName, doCheckResource, modalOpenerConfig, modalContextConfig, children, }: PropsWithChildren<JiraStandaloneAppWrapperProps>): JSX_2.Element;
-
-export declare interface AtlassianAppStandaloneConfig {
-    /**
-     * OAuth configuration for authenticating users against Jira.
-     */
-    oauthConfig?: AtlassianAppStandaloneOauthConfig;
-    /**
-     * Mock data for the context normally returned by @forge/bridge View.getContext()
-     */
-    initialMockViewContext?: Partial<FullContext>;
-    /**
-     * Url for invoking backend functions
-     */
-    backendUrl?: string;
-    /**
-     * Url for invoking remote APIs
-     */
-    remoteUrl?: string;
-    /**
-     * config for an app that opens @forge/bridge Modals
-     */
-    modalOpenerConfig?: {
-        /**
-         * If the app opens multiple Forge resources in Jira Modals,
-         * then supply a map of resource names to local URLs.
-         */
-        resourceMap?: Record<string, string>;
-        /**
-         * default URL to open in the modal (ex. http://localhost:4201)
-         */
-        defaultUrl: string;
-    };
-    /**
-     * config for an app that is opened in a @forge/bridge Modal
-     */
-    modalContextConfig?: {
-        /**
-         * Standalone URL of the app that opened the modal. (ex. http://localhost:4200)
-         */
-        openerOrigin: string;
-    };
-}
-
-export declare type AtlassianAppStandaloneOauthConfig = OAuthProviderProps & {
-    doCheckResource?: boolean;
-};
-
-export declare function AtlassianAppTest({ mockContext, invoke, invokeRemote, jiraFetchService, confluenceFetchService, bitbucketFetchService, hostRouter, children, }: PropsWithChildren<AtlassianAppTestProps>): JSX_2.Element;
-
-export declare interface AtlassianAppTestProps {
-    mockContext: FullContext;
-    invoke: InvokeSignature;
-    jiraFetchService?: AtlassianProductFetchService<'jira'>;
-    confluenceFetchService?: AtlassianProductFetchService<'confluence'>;
-    bitbucketFetchService?: AtlassianProductFetchService<'bitbucket'>;
-    hostRouter: HostRouter;
-    invokeRemote: InvokeRemoteSignature;
-}
-
-export declare function atlassianOAuthBitbucketFetch(authToken: string): AtlassianProductFetchService<'bitbucket'>;
-
-export declare function atlassianOAuthConfluenceFetch(authToken: string, cloudId: string): AtlassianProductFetchService<'confluence'>;
-
-export declare function atlassianOAuthJiraFetch(authToken: string, cloudId: string): AtlassianProductFetchService<'jira'>;
-
-export declare function atlassianOAuthRawFetch<P extends Product>(authToken: string, domain: string, productType: P): AtlassianProductFetchService<P>;
-
-export declare type AtlassianOAuthScopes = 'read:me' | 'read:jira-user' | 'read:jira-work' | 'write: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';
-
-export declare interface AtlassianProductFetchService<P extends Product> {
-    productType: P;
-    fetch: FetchSignature;
-    route: (template: TemplateStringsArray, ...parameters: (string | number | URLSearchParams | FetchRoute)[]) => FetchRoute;
-    rawFetch: RequestProductMethod;
-    fullUrl: (path: string) => string;
-}
-
-export declare interface AtlassianUserResource {
-    id: string;
-    url: string;
-    name: string;
-    scopes: string[];
-    avatarUrl: string;
-}
-
-export declare class AtlassianUserResourceService {
-    readonly userResourcesUrl = "https://api.atlassian.com/oauth/token/accessible-resources";
-    getAtlassianUserResources(authToken: string): Promise<AtlassianUserResource[]>;
-    checkUserChosenResource(authToken: string, resourceId?: string): Promise<{
-        hasChosen: true;
-        resource: {
-            name: string;
-            id: string;
-        };
-    } | {
-        hasChosen: false;
-        resources: {
-            name: string;
-            id: string;
-        }[];
-    }>;
-}
-
-export declare class AtlassianUserWorkspaceService {
-    private fetchSvc;
-    readonly workspaceApiUrl: string;
-    constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
-    getAllUserWorkspaces(): Promise<AssetsWorkspace[]>;
-    checkUserChosenWorkspace(workspaceId?: string): Promise<WorkspaceChoices>;
-}
-
-export declare function BackendAdapterProvider({ children, invokeImplementation, }: BackendAdapterProviderProps): JSX_2.Element;
-
-declare interface BackendAdapterProviderProps {
-    children: ReactNode;
-    invokeImplementation: InvokeSignature;
-}
-
-declare interface BackendAdapterService {
-    invoke: InvokeSignature;
-}
-
-export declare function bearerAuthFetch<T>(authToken: string, url: string, method: FetchMethod, body?: Record<string, unknown>, responseType?: 'json' | 'text', headers?: Record<string, string>): Promise<T>;
-
-export declare function bearerAuthFetchRaw(authToken: string, url: string, init: RequestInit): Promise<Response>;
-
-export declare class CommonResolverPaths {
-    static getOauthToken: string;
-}
-
-/**
- * Logs the error and returns `Error Occurred: ${e.message || e}`
- */
-declare function defaultErrorHandler(e: {
-    message?: string;
-}): string;
-
-export declare function defaultProps(makeMockFunction: () => any): AtlassianAppTestProps;
-
-export declare function FeatureChosenResourceCheck({ checkResource, children, }: FeatureChosenResourceCheckProps): ReactElement;
-
-export declare interface FeatureChosenResourceCheckProps {
-    checkResource: (resourceId?: string) => Promise<{
-        hasChosen: true;
-    } | {
-        hasChosen: false;
-        resources: Resource[];
-    }>;
-    children: ReactElement;
-}
-
-export declare function FeatureChosenWorkspaceCheck({ appName, children, }: PropsWithChildren<FeatureChosenWorkspaceCheckProps>): ReactElement;
-
-export declare interface FeatureChosenWorkspaceCheckProps {
-    appName?: string;
-}
-
-export declare class FetchError {
-    message: string;
-    constructor(message: string);
-}
-
-export declare type FetchMethod = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH';
-
-export declare interface FetchRequest {
-    method: FetchMethod;
-    url: FetchRoute;
-    responseType?: 'json' | 'text';
-    allowExperimental?: boolean;
-}
-
-export declare type FetchRoute = {
-    readonly value: string;
-};
-
-export declare type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
-
-export declare interface ForgeRequest<T, U extends AccountContext = AccountContext> {
-    payload: T;
-    context: U;
-}
-
-export declare type ForgeResolverFunction<P, R, C extends AccountContext = AccountContext> = (request: ForgeRequest<P, C>) => Promise<R> | R;
-
-export declare function getAtlassianOAuthToken(grant_type: string, client_id: string, client_secret: string, code: string, redirect_uri: string): Promise<unknown>;
-
-export declare function getAtlassianUserDetails(authToken: string): Promise<OAuthUser>;
-
-export declare function getOauthFetchInvokeImpl(urlBase: string, // serverUrl + ':' + serverPort + '/api/'
-authToken: string, resourceId: string): InvokeSignature;
-
-export declare interface GlobalPageContext extends AccountContext {
-    localId: string;
-    cloudId: string;
-    environmentId: string;
-    environmentType: string;
-    moduleKey: string;
-    siteUrl: string;
-    extension: {
-        type: string;
-    };
-    installContext: string;
-}
-
-export declare interface HostRouter {
-    navigate(url: string): Promise<void>;
-    open(url: string): Promise<void>;
-    reload(): Promise<void>;
-}
-
-export declare function HostRouterLink({ url, action, label, linkStyle, buttonIcon, buttonAppearance, }: HostRouterLinkProps): JSX_2.Element;
-
-export declare interface HostRouterLinkProps {
-    url: string;
-    action: 'navigate' | 'open';
-    /** anchor text or button label **/
-    label: string;
-    linkStyle: 'link' | 'button';
-    buttonIcon?: IconProp;
-    buttonAppearance?: IconButtonAppearance;
-}
-
-export declare function HostRouterProvider({ children, hostRouter, }: HostRouterProviderProps): JSX_2.Element;
-
-declare interface HostRouterProviderProps {
-    children: ReactNode;
-    hostRouter: HostRouter;
-}
-
-export declare interface IframeModalContextData {
-    iframeProps: IframeProps;
-    modalHeader?: string;
-}
-
-declare interface IframeProps {
-    link: string;
-    title?: string;
-    width?: string;
-    height?: string;
-}
-
-export declare type InvokePayload = {
-    [key in number | string]: unknown;
-};
-
-declare interface InvokePayload_2 {
-    call: {
-        functionKey: string;
-        payload?: {
-            [key in number | string]: unknown;
-        };
-        jobId?: string;
-    };
-    context: {
-        [key: string]: unknown;
-    };
-}
-
-export declare interface InvokeRemoteResponse<T> {
-    body?: T;
-    headers?: Record<string, string>;
-    status: number;
-}
-
-export declare type InvokeRemoteSignature = <T, U>(input: {
-    path: string;
-    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
-    headers?: Record<string, string>;
-    body?: U;
-}) => Promise<InvokeRemoteResponse<T>>;
-
-export declare type InvokeSignature = <T = unknown, U = InvokePayload, A extends string = string>(action: A, data?: U) => Promise<T>;
-
-export declare const IS_STANDALONE: boolean;
-
-export declare interface IssueContext extends AccountContext {
-    extension: {
-        issue: {
-            key: string;
-        };
-    };
-}
-
-export declare interface JiraIssueExtensionData {
-    issue: {
-        key: string;
-        id: string;
-        type: string;
-        typeId: string;
-    };
-    project: {
-        id: string;
-        key: string;
-        type: string;
-    };
-    type: string;
-}
-
-export declare interface JiraStandaloneAppWrapperProps {
-    initialMockViewContext?: Partial<FullContext>;
-    backendUrl?: string;
-    remoteUrl?: string;
-    doCheckResource?: boolean;
-    /**
-     * Select workspace when calling JSM Assets APIs
-     */
-    doCheckWorkspace?: boolean;
-    modalOpenerConfig?: {
-        resourceMap?: Record<string, string>;
-        defaultUrl: string;
-    };
-    modalContextConfig?: {
-        openerOrigin: string;
-    };
-    appName: string;
-}
-
-export declare function JiraWorkspaceProvider({ children, workspaceId, }: PropsWithChildren<{
-    workspaceId?: string;
-}>): JSX_2.Element;
-
-export declare function jsonFetch<T, U = Record<string, unknown>>(url: string, method: FetchMethod, headers?: Record<string, string>, body?: U, responseType?: 'json' | 'text'): Promise<T>;
-
-export declare class MockViewContext implements ViewContext {
-    context: FullContext;
-    theme: {
-        enable(): Promise<void>;
-    };
-    constructor(context: FullContext);
-    close(_payload?: unknown): Promise<void>;
-    submit(_payload: unknown): Promise<void>;
-    getContext(): Promise<FullContext>;
-    createHistory(): Promise<History_2>;
-    refresh(): Promise<void>;
-}
-
-export declare function ModalContent({ children }: PropsWithChildren): JSX_2.Element;
-
-export declare function ModalContentIframe<T>({ messageCallback, closeOnMouseOut, }: {
-    messageCallback?: (eventData: T, iframeProps?: IframeProps) => {
-        newHeight?: string;
-    };
-    closeOnMouseOut?: boolean;
-}): JSX_2.Element;
-
-export declare interface ModalContentService<C, P> {
-    modalContextData?: C;
-    close: (payload?: P) => void;
-}
-
-/**
- * Make sure you have #root{width:100%;} in your app's global styles
- * @param title
- * @param buttonGroup
- * @param children
- * @constructor
- */
-export declare function ModalDialogLayout({ title, buttonGroup, children, }: PropsWithChildren<ModalDialogLayoutProps>): JSX_2.Element;
-
-export declare interface ModalDialogLayoutProps {
-    title?: string;
-    buttonGroup?: default_2.ReactNode;
-}
-
-export declare interface ModalOptions<C, P> {
-    resource?: string | null;
-    onClose?: (payload?: P) => any;
-    size?: ModalSize;
-    context?: C;
-    closeOnEscape?: boolean;
-    closeOnOverlayClick?: boolean;
-}
-
-export declare interface ModalService {
-    open<C, P>(options: ModalOptions<C, P>): Promise<void>;
-}
-
-export declare function ModalServiceProvider({ children, modalService, }: ModalServiceProviderProps): JSX_2.Element;
-
-declare interface ModalServiceProviderProps {
-    children: ReactNode;
-    modalService: ModalService;
-}
-
-declare type ModalSize = 'small' | 'medium' | 'large' | 'xlarge' | 'max';
-
-export declare class ModalViewContext extends MockViewContext {
-    context: FullContext;
-    private openerOrigin;
-    constructor(context: FullContext, openerOrigin?: string);
-    close: (payload?: unknown) => Promise<void>;
-}
-
-export declare interface OAuth {
-    getAuthToken: () => string;
-}
-
-export declare function oauthFetchInvokeRemote(baseUrl: string, authToken?: string): InvokeRemoteSignature;
-
-export declare function OAuthProvider({ children, ...config }: PropsWithChildren<OAuthProviderProps>): JSX_2.Element;
-
-export declare interface OAuthProviderProps {
-    clientId: string;
-    codeTokenExchangeUrl: string;
-    /**
-     * OAuth App Name
-     */
-    appName: string;
-    oAuthScopes: AtlassianOAuthScopes[];
-}
-
-export declare interface OAuthUser {
-    account_id: string;
-    account_status: string;
-    account_type: string;
-    characteristics: {
-        not_mentionable: boolean;
-    };
-    email: string;
-    email_verified: boolean;
-    extended_profile: {
-        job_title: string;
-        organization: string;
-        location: string;
-        phone_numbers: number[];
-    };
-    last_updated: string;
-    locale: string;
-    name: string;
-    nickname: string;
-    picture: string;
-    zoneinfo: string;
-}
-
-export declare interface PagedResponseValues<T> {
-    startAt: number;
-    maxResults: number;
-    total: number;
-    isLast: boolean;
-    values: T[];
-}
-
-export declare function PageLoadingView({ label, loadingError, labelSize, }: {
-    label: string;
-    loadingError?: string;
-    labelSize?: HeadingSize;
-}): JSX_2.Element;
-
-export declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
-
-export declare function RemoteAdapterProvider({ children, invokeRemoteImplementation, }: RemoteAdapterProviderProps): JSX_2.Element;
-
-declare interface RemoteAdapterProviderProps {
-    children: ReactNode;
-    invokeRemoteImplementation: InvokeRemoteSignature;
-}
-
-declare interface RemoteAdapterService {
-    invokeRemote: InvokeRemoteSignature;
-}
-
-export declare function RequestBitbucketProvider({ children, requestBitbucketImplementation, }: RequestBitbucketProviderProps): JSX_2.Element;
-
-declare interface RequestBitbucketProviderProps {
-    children: ReactNode;
-    requestBitbucketImplementation: AtlassianProductFetchService<'bitbucket'>;
-}
-
-export declare function RequestConfluenceProvider({ children, requestConfluenceImplementation, }: RequestConfluenceProviderProps): JSX_2.Element;
-
-declare interface RequestConfluenceProviderProps {
-    children: ReactNode;
-    requestConfluenceImplementation: AtlassianProductFetchService<'confluence'>;
-}
-
-export declare function RequestJiraProvider({ children, requestJiraImplementation, }: RequestJiraProviderProps): JSX_2.Element;
-
-declare interface RequestJiraProviderProps {
-    children: ReactNode;
-    requestJiraImplementation: AtlassianProductFetchService<'jira'>;
-}
-
-export declare interface RequestObject {
-    payload: RequestPayload;
-    context: InvokePayload_2['context'];
-}
-
-export declare type RequestPayload = {
-    [key in number | string]: unknown;
-};
-
-export declare type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
-
-export declare type ResolverFunction = (request: RequestObject) => Promise<Response_2> | Response_2;
-
-export declare interface Resource {
-    name: string;
-    id: string;
-}
-
-declare type Response_2 = ResponseObject | string | void;
-
-export declare interface ResponseObject {
-    [key: string]: unknown;
-}
-
-export declare function route(template: TemplateStringsArray, ...parameters: (string | number | URLSearchParams | FetchRoute)[]): FetchRoute;
-
-export declare function useAppFlagsDispatch(): Dispatch<AppFlagAction>;
-
-export declare function useAppFlagsDispatchMethods(): {
-    addFlag: (props: AppFlagTypes) => void;
-    removeFlag: (flagId: string) => void;
-    addErrorFlag: (flagId: string, title: string, error?: unknown, actions?: ActionsType) => void;
-};
-
-export declare const useBackendAdapter: () => BackendAdapterService;
-
-export declare const useHostRouter: () => HostRouter;
-
-/**
- * Example usage:
- * export function MyComponent({ id }) {
- *
- *   const requestFunction = useCallback(
- *     () => fetch(`/data/${id}`),
- *     [id]
- *   )
- *
- *   const { data, loading, error } = useLoadDataEffect<MyDataType>(requestFunction)
- *
- *   if (error) return <ErrorScreen />
- *   if (loading) return <Spinner />
- *   return <div>{data.property}</div>
- * }
- *
- */
-export declare 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>;
-};
-
-export declare function useModalContentService<C = unknown, P = unknown>(): ModalContentService<C, P>;
-
-export declare const useModalService: () => ModalService;
-
-export declare const useOAuth: () => OAuth;
-
-export declare const useRemoteAdapter: () => RemoteAdapterService;
-
-export declare const useRequestBitbucket: () => AtlassianProductFetchService<"bitbucket">;
-
-export declare const useRequestConfluence: () => AtlassianProductFetchService<"confluence">;
-
-export declare const useRequestJira: () => AtlassianProductFetchService<"jira">;
-
-export declare const useViewContext: () => ViewContext;
-
-export declare const useWorkspaceId: () => string | undefined;
-
-export declare interface ViewContext {
-    /**
-     * The close method enables you to request the closure of the current view. For example, close a modal.
-     * @param payload
-     */
-    close(payload?: unknown): Promise<void>;
-    /**
-     * The submit method enables you to request form submission on the Jira custom field edit, Jira custom field type edit, and Jira context configuration views.
-     * @param payload
-     */
-    submit(payload: unknown): Promise<void>;
-    getContext(): Promise<FullContext>;
-    createHistory(): Promise<History_2>;
-    refresh(): Promise<void>;
-    theme: {
-        enable(): Promise<void>;
-    };
-}
-
-export declare function ViewContextProvider({ children, viewContext, }: ViewContextProviderProps): JSX_2.Element;
-
-declare interface ViewContextProviderProps {
-    children: ReactNode;
-    viewContext: ViewContext;
-}
-
-export declare class WindowHostRouter implements HostRouter {
-    navigate(url: string): Promise<void>;
-    open(url: string): Promise<void>;
-    reload(): Promise<void>;
-}
-
-export declare class WindowModalService implements ModalService {
-    private readonly defaultUrl;
-    private readonly resourceMap;
-    constructor(defaultUrl: string, resourceMap?: Record<string, string>);
-    open<C, P>(options: ModalOptions<C, P>): Promise<void>;
-    private features;
-}
-
-export declare type WorkspaceChoices = {
-    hasChosen: true;
-    workspace: string;
-} | {
-    hasChosen: false;
-    workspaces: AssetsWorkspace[];
-};
-
-export { }