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

package/atlassian-app/index.d.ts

@@ -0,0 +1,114 @@
+import { FullContext } from '@forge/bridge/out/types';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+
+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 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;
+};
+
+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';
+
+declare interface InvokeRemoteResponse<T> {
+    body?: T;
+    headers?: Record<string, string>;
+    status: number;
+}
+
+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 const IS_STANDALONE: boolean;
+
+declare interface OAuthProviderProps {
+    clientId: string;
+    codeTokenExchangeUrl: string;
+    /**
+     * OAuth App Name
+     */
+    appName: string;
+    oAuthScopes: AtlassianOAuthScopes[];
+}
+
+export { }

package/atlassian-app/index.es.js

@@ -0,0 +1,5 @@
+import { AtlassianApp as a, IS_STANDALONE as o } from "../atlassian/shared/frontend-feature-atlassian-app/src/lib/atlassian-app/index.es.js";
+export {
+  a as AtlassianApp,
+  o as IS_STANDALONE
+};

package/atlassian-app/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"
+    }
+  ]
+}

package/atlassian-app-custom-ui/atlassian-app-frontend-atlassian-app-custom-ui.api.json

@@ -0,0 +1,242 @@
+{
+  "metadata": {
+    "toolPackage": "@microsoft/api-extractor",
+    "toolVersion": "7.52.8",
+    "schemaVersion": 1011,
+    "oldestForwardsCompatibleVersion": 1001,
+    "tsdocConfig": {
+      "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+      "noStandardTags": true,
+      "tagDefinitions": [
+        {
+          "tagName": "@alpha",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@beta",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@defaultValue",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@decorator",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@deprecated",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@eventProperty",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@example",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@experimental",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@inheritDoc",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@internal",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@label",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@link",
+          "syntaxKind": "inline",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@override",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@packageDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@param",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@privateRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@public",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@readonly",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@remarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@returns",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@sealed",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@see",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@throws",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@typeParam",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@virtual",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@betaDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@internalRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@preapproved",
+          "syntaxKind": "modifier"
+        }
+      ],
+      "supportForTags": {
+        "@alpha": true,
+        "@beta": true,
+        "@defaultValue": true,
+        "@decorator": true,
+        "@deprecated": true,
+        "@eventProperty": true,
+        "@example": true,
+        "@experimental": true,
+        "@inheritDoc": true,
+        "@internal": true,
+        "@label": true,
+        "@link": true,
+        "@override": true,
+        "@packageDocumentation": true,
+        "@param": true,
+        "@privateRemarks": true,
+        "@public": true,
+        "@readonly": true,
+        "@remarks": true,
+        "@returns": true,
+        "@sealed": true,
+        "@see": true,
+        "@throws": true,
+        "@typeParam": true,
+        "@virtual": true,
+        "@betaDocumentation": true,
+        "@internalRemarks": true,
+        "@preapproved": true
+      },
+      "reportUnsupportedHtmlElements": false
+    }
+  },
+  "kind": "Package",
+  "canonicalReference": "@valiantys/atlassian-app-frontend!",
+  "docComment": "",
+  "name": "@valiantys/atlassian-app-frontend",
+  "preserveMemberOrder": false,
+  "members": [
+    {
+      "kind": "EntryPoint",
+      "canonicalReference": "@valiantys/atlassian-app-frontend!",
+      "name": "",
+      "preserveMemberOrder": false,
+      "members": [
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppForge:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function AtlassianAppForge({ appName, doCheckWorkspace, invokeRemoteImpl, useAtlasKitFlags, children, }: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropsWithChildren",
+              "canonicalReference": "@types/react!React.PropsWithChildren:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "AtlassianAppForgeProps",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!~AtlassianAppForgeProps:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"react/jsx-runtime\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "JSX.Element",
+              "canonicalReference": "@types/react!JSX.Element:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-feature-atlassian-app/src/lib/custom-ui/atlassian-app-forge.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 6,
+            "endIndex": 8
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "{ appName, doCheckWorkspace, invokeRemoteImpl, useAtlasKitFlags, children, }",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "AtlassianAppForge"
+        }
+      ]
+    }
+  ]
+}

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

@@ -0,0 +1,17 @@
+## 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 { JSX as JSX_2 } from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+
+// Warning: (ae-forgotten-export) The symbol "AtlassianAppForgeProps" needs to be exported by the entry point atlassian-app-custom-ui.d.ts
+//
+// @public (undocumented)
+export function AtlassianAppForge({ appName, doCheckWorkspace, invokeRemoteImpl, useAtlasKitFlags, children, }: PropsWithChildren<AtlassianAppForgeProps>): JSX_2.Element;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/atlassian-app-custom-ui/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/shared/frontend-feature-atlassian-app/src/lib/custom-ui/atlassian-app-forge/index.cjs.js");exports.AtlassianAppForge=e.AtlassianAppForge;

package/atlassian-app-custom-ui/index.d.ts

@@ -0,0 +1,26 @@
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+
+export declare function AtlassianAppForge({ appName, doCheckWorkspace, invokeRemoteImpl, useAtlasKitFlags, children, }: PropsWithChildren<AtlassianAppForgeProps>): JSX_2.Element;
+
+declare interface AtlassianAppForgeProps {
+    appName?: string;
+    doCheckWorkspace?: boolean;
+    invokeRemoteImpl?: InvokeRemoteSignature;
+    useAtlasKitFlags?: boolean;
+}
+
+declare interface InvokeRemoteResponse<T> {
+    body?: T;
+    headers?: Record<string, string>;
+    status: number;
+}
+
+declare type InvokeRemoteSignature = <T, U>(input: {
+    path: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    headers?: Record<string, string>;
+    body?: U;
+}) => Promise<InvokeRemoteResponse<T>>;
+
+export { }

package/atlassian-app-custom-ui/index.es.js

@@ -0,0 +1,4 @@
+import { AtlassianAppForge as r } from "../atlassian/shared/frontend-feature-atlassian-app/src/lib/custom-ui/atlassian-app-forge/index.es.js";
+export {
+  r as AtlassianAppForge
+};

package/{tsdoc-metadata.json → atlassian-app-custom-ui/tsdoc-metadata.json}

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.48.0"
+      "packageVersion": "7.52.8"
     }
   ]
 }

package/atlassian-app-frontend.css

@@ -0,0 +1 @@
+._iframe-wrapper_1b9nc_1{display:flex;flex-direction:column;align-items:center;justify-content:flex-start;width:100%;height:100%;overflow:hidden;position:relative}._iframe-wrapper_1b9nc_1 iframe{border:none;width:100%;min-height:300px;margin:0;padding:0}._drop-target-box_154h8_1{width:100%;height:100%;min-height:150px}