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

package/ui-modal/atlassian-app-frontend.api.md

@@ -0,0 +1,109 @@
+## 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 { default as default_2 } from 'react';
+import { FullContext } from '@forge/bridge/out/types';
+import { History as History_2 } from 'history';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+import { ReactNode } from 'react';
+
+// @public (undocumented)
+export interface IframeModalContextData {
+    // Warning: (ae-forgotten-export) The symbol "IframeProps" needs to be exported by the entry point ui-modal.d.ts
+    //
+    // (undocumented)
+    iframeProps: IframeProps;
+    // (undocumented)
+    modalHeader?: string;
+}
+
+// @public (undocumented)
+export function ModalContent({ 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<C, P> {
+    // (undocumented)
+    close: (payload?: P) => void;
+    // (undocumented)
+    modalContextData?: C;
+}
+
+// @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 ui-modal.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 ui-modal.d.ts
+//
+// @public (undocumented)
+export function ModalServiceProvider({ children, modalService, }: ModalServiceProviderProps): JSX_2.Element;
+
+// Warning: (ae-forgotten-export) The symbol "MockViewContext" needs to be exported by the entry point ui-modal.d.ts
+//
+// @public (undocumented)
+export class ModalViewContext extends MockViewContext {
+    constructor(context: FullContext, openerOrigin?: string);
+    // (undocumented)
+    close: (payload?: unknown) => Promise<void>;
+    // (undocumented)
+    context: FullContext;
+}
+
+// @public (undocumented)
+export function useModalContentService<C = unknown, P = unknown>(): ModalContentService<C, P>;
+
+// @public (undocumented)
+export const useModalService: () => ModalService;
+
+// @public (undocumented)
+export class WindowModalService implements ModalService {
+    constructor(defaultUrl: string, resourceMap?: Record<string, string>);
+    // (undocumented)
+    open<C, P>(options: ModalOptions<C, P>): Promise<void>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/ui-modal/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/shared/frontend-ui-modal/src/lib/modal-content/index.cjs.js"),t=require("../atlassian/shared/frontend-ui-modal/src/lib/modal-content-iframe/index.cjs.js"),r=require("../atlassian/shared/frontend-ui-modal/src/lib/modal-service/index.cjs.js"),o=require("../atlassian/shared/frontend-ui-modal/src/lib/modal-service-provider/index.cjs.js"),a=require("../atlassian/shared/frontend-ui-modal/src/lib/modal-view-context/index.cjs.js"),i=require("../atlassian/shared/frontend-ui-modal/src/lib/modal-dialog-layout/index.cjs.js");exports.ModalContent=e.ModalContent;exports.useModalContentService=e.useModalContentService;exports.ModalContentIframe=t.ModalContentIframe;exports.WindowModalService=r.WindowModalService;exports.ModalServiceProvider=o.ModalServiceProvider;exports.useModalService=o.useModalService;exports.ModalViewContext=a.ModalViewContext;exports.ModalDialogLayout=i.ModalDialogLayout;

package/ui-modal/index.d.ts

@@ -0,0 +1,121 @@
+import { default as default_2 } from 'react';
+import { FullContext } from '@forge/bridge/out/types';
+import { History as History_2 } from 'history';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+import { ReactNode } from 'react';
+
+export declare interface IframeModalContextData {
+    iframeProps: IframeProps;
+    modalHeader?: string;
+}
+
+declare interface IframeProps {
+    link: string;
+    title?: string;
+    width?: string;
+    height?: string;
+}
+
+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 function useModalContentService<C = unknown, P = unknown>(): ModalContentService<C, P>;
+
+export declare const useModalService: () => ModalService;
+
+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 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 { }

package/ui-modal/index.es.js

@@ -0,0 +1,16 @@
+import { ModalContent as r, useModalContentService as t } from "../atlassian/shared/frontend-ui-modal/src/lib/modal-content/index.es.js";
+import { ModalContentIframe as d } from "../atlassian/shared/frontend-ui-modal/src/lib/modal-content-iframe/index.es.js";
+import { WindowModalService as i } from "../atlassian/shared/frontend-ui-modal/src/lib/modal-service/index.es.js";
+import { ModalServiceProvider as M, useModalService as f } from "../atlassian/shared/frontend-ui-modal/src/lib/modal-service-provider/index.es.js";
+import { ModalViewContext as x } from "../atlassian/shared/frontend-ui-modal/src/lib/modal-view-context/index.es.js";
+import { ModalDialogLayout as v } from "../atlassian/shared/frontend-ui-modal/src/lib/modal-dialog-layout/index.es.js";
+export {
+  r as ModalContent,
+  d as ModalContentIframe,
+  v as ModalDialogLayout,
+  M as ModalServiceProvider,
+  x as ModalViewContext,
+  i as WindowModalService,
+  t as useModalContentService,
+  f as useModalService
+};

package/ui-modal/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.52.8"
+    }
+  ]
+}