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

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

@@ -0,0 +1,636 @@
+{
+  "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!AtlassianApp:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function AtlassianApp({ children, appName, doCheckWorkspace, embeddedConfig, standaloneConfig, }: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropsWithChildren",
+              "canonicalReference": "@types/react!React.PropsWithChildren:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "AtlassianAppConfig",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppConfig: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/atlassian-app.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 6,
+            "endIndex": 8
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "{ children, appName, doCheckWorkspace, embeddedConfig, standaloneConfig, }",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "AtlassianApp"
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppConfig:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface AtlassianAppConfig "
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-feature-atlassian-app/src/lib/atlassian-app-config.d.ts",
+          "releaseTag": "Public",
+          "name": "AtlassianAppConfig",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppConfig#appName:member",
+              "docComment": "/**\n * Name used to prefix any local storage settings.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "appName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "appName",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppConfig#doCheckWorkspace:member",
+              "docComment": "/**\n * Workspace is required for any API calls involving Assets\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "doCheckWorkspace?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "doCheckWorkspace",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppConfig#embeddedConfig:member",
+              "docComment": "/**\n * Configuration needed when app is deployed and running inside an Atlassian context (embedded in Jira).\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "embeddedConfig?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        invokeRemoteImpl?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "InvokeRemoteSignature",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~InvokeRemoteSignature:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n        useAtlasKitFlags?: boolean;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "embeddedConfig",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppConfig#standaloneConfig:member",
+              "docComment": "/**\n * Configuration needed when app is running in standalone mode, outside of jira.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "standaloneConfig?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AtlassianAppStandaloneConfig",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppStandaloneConfig:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "standaloneConfig",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppStandaloneConfig:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface AtlassianAppStandaloneConfig "
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-feature-atlassian-app/src/lib/atlassian-app-config.d.ts",
+          "releaseTag": "Public",
+          "name": "AtlassianAppStandaloneConfig",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppStandaloneConfig#backendUrl:member",
+              "docComment": "/**\n * Url for invoking backend functions\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "backendUrl?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "backendUrl",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppStandaloneConfig#initialMockViewContext:member",
+              "docComment": "/**\n * Mock data for the context normally returned by @forge/bridge View.getContext()\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "initialMockViewContext?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Partial",
+                  "canonicalReference": "!Partial:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FullContext",
+                  "canonicalReference": "@forge/bridge!FullContext:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "initialMockViewContext",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppStandaloneConfig#modalContextConfig:member",
+              "docComment": "/**\n * config for an app that is opened in a @forge/bridge Modal\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "modalContextConfig?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        openerOrigin: string;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "modalContextConfig",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppStandaloneConfig#modalOpenerConfig:member",
+              "docComment": "/**\n * config for an app that opens @forge/bridge Modals\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "modalOpenerConfig?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        resourceMap?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Record",
+                  "canonicalReference": "!Record:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string, string>;\n        defaultUrl: string;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "modalOpenerConfig",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppStandaloneConfig#oauthConfig:member",
+              "docComment": "/**\n * OAuth configuration for authenticating users against Jira.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "oauthConfig?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AtlassianAppStandaloneOauthConfig",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppStandaloneOauthConfig:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "oauthConfig",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppStandaloneConfig#remoteUrl:member",
+              "docComment": "/**\n * Url for invoking remote APIs\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "remoteUrl?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "remoteUrl",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppStandaloneOauthConfig:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type AtlassianAppStandaloneOauthConfig = "
+            },
+            {
+              "kind": "Reference",
+              "text": "OAuthProviderProps",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!~OAuthProviderProps:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " & {\n    doCheckResource?: boolean;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-feature-atlassian-app/src/lib/atlassian-app-config.d.ts",
+          "releaseTag": "Public",
+          "name": "AtlassianAppStandaloneOauthConfig",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!IS_STANDALONE:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "IS_STANDALONE: "
+            },
+            {
+              "kind": "Content",
+              "text": "boolean"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-feature-atlassian-app/src/lib/atlassian-app.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "IS_STANDALONE",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        }
+      ]
+    }
+  ]
+}

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

@@ -0,0 +1,56 @@
+## 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 { FullContext } from '@forge/bridge/out/types';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+
+// @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?: AtlassianAppStandaloneConfig;
+}
+
+// @public (undocumented)
+export interface AtlassianAppStandaloneConfig {
+    backendUrl?: string;
+    initialMockViewContext?: Partial<FullContext>;
+    modalContextConfig?: {
+        openerOrigin: string;
+    };
+    modalOpenerConfig?: {
+        resourceMap?: Record<string, string>;
+        defaultUrl: string;
+    };
+    oauthConfig?: AtlassianAppStandaloneOauthConfig;
+    remoteUrl?: string;
+}
+
+// Warning: (ae-forgotten-export) The symbol "OAuthProviderProps" needs to be exported by the entry point atlassian-app.d.ts
+//
+// @public (undocumented)
+export type AtlassianAppStandaloneOauthConfig = OAuthProviderProps & {
+    doCheckResource?: boolean;
+};
+
+// @public (undocumented)
+export const IS_STANDALONE: boolean;
+
+// Warnings were encountered during analysis:
+//
+// /Users/chris.hardin/code/od/engineering-monorepo/atlassian/shared/frontend-feature-atlassian-app/src/lib/atlassian-app-config.d.ts:65:9 - (ae-forgotten-export) The symbol "InvokeRemoteSignature" needs to be exported by the entry point atlassian-app.d.ts
+
+// (No @packageDocumentation comment for this package)
+
+```

package/atlassian-app/index.cjs.js

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