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

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

@@ -0,0 +1,514 @@
+{
+  "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!AtlassianAppTest:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function AtlassianAppTest({ mockContext, invoke, invokeRemote, jiraFetchService, confluenceFetchService, bitbucketFetchService, hostRouter, children, }: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropsWithChildren",
+              "canonicalReference": "@types/react!React.PropsWithChildren:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "AtlassianAppTestProps",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppTestProps: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/test/atlassian-app-test.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 6,
+            "endIndex": 8
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "{ mockContext, invoke, invokeRemote, jiraFetchService, confluenceFetchService, bitbucketFetchService, hostRouter, children, }",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "AtlassianAppTest"
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppTestProps:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface AtlassianAppTestProps "
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-feature-atlassian-app/src/lib/test/atlassian-app-test.d.ts",
+          "releaseTag": "Public",
+          "name": "AtlassianAppTestProps",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppTestProps#bitbucketFetchService:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "bitbucketFetchService?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AtlassianProductFetchService",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~AtlassianProductFetchService:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<'bitbucket'>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "bitbucketFetchService",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppTestProps#confluenceFetchService:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "confluenceFetchService?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AtlassianProductFetchService",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~AtlassianProductFetchService:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<'confluence'>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "confluenceFetchService",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppTestProps#hostRouter:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "hostRouter: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HostRouter",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~HostRouter:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "hostRouter",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppTestProps#invoke:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "invoke: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "InvokeSignature",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~InvokeSignature:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "invoke",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppTestProps#invokeRemote:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "invokeRemote: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "InvokeRemoteSignature",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~InvokeRemoteSignature:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "invokeRemote",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppTestProps#jiraFetchService:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "jiraFetchService?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AtlassianProductFetchService",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~AtlassianProductFetchService:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<'jira'>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "jiraFetchService",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppTestProps#mockContext:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "mockContext: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FullContext",
+                  "canonicalReference": "@forge/bridge!FullContext:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "mockContext",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!defaultProps:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function defaultProps(makeMockFunction: "
+            },
+            {
+              "kind": "Content",
+              "text": "() => any"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "AtlassianAppTestProps",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianAppTestProps:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-feature-atlassian-app/src/lib/test/atlassian-app-test.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "makeMockFunction",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "defaultProps"
+        }
+      ]
+    }
+  ]
+}

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

@@ -0,0 +1,45 @@
+## 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 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'>;
+    // Warning: (ae-forgotten-export) The symbol "HostRouter" needs to be exported by the entry point atlassian-app-test.d.ts
+    //
+    // (undocumented)
+    hostRouter: HostRouter;
+    // Warning: (ae-forgotten-export) The symbol "InvokeSignature" needs to be exported by the entry point atlassian-app-test.d.ts
+    //
+    // (undocumented)
+    invoke: InvokeSignature;
+    // Warning: (ae-forgotten-export) The symbol "InvokeRemoteSignature" needs to be exported by the entry point atlassian-app-test.d.ts
+    //
+    // (undocumented)
+    invokeRemote: InvokeRemoteSignature;
+    // Warning: (ae-forgotten-export) The symbol "AtlassianProductFetchService" needs to be exported by the entry point atlassian-app-test.d.ts
+    //
+    // (undocumented)
+    jiraFetchService?: AtlassianProductFetchService<'jira'>;
+    // (undocumented)
+    mockContext: FullContext;
+}
+
+// @public (undocumented)
+export function defaultProps(makeMockFunction: () => any): AtlassianAppTestProps;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/atlassian-app-test/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/test/atlassian-app-test/index.cjs.js");exports.AtlassianAppTest=t.AtlassianAppTest;exports.defaultProps=t.defaultProps;

package/atlassian-app-test/index.d.ts

@@ -0,0 +1,73 @@
+import { FullContext } from '@forge/bridge/out/types';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+
+declare type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
+
+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;
+}
+
+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 function defaultProps(makeMockFunction: () => any): AtlassianAppTestProps;
+
+declare type FetchMethod = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH';
+
+declare interface FetchRequest {
+    method: FetchMethod;
+    url: FetchRoute;
+    responseType?: 'json' | 'text';
+    allowExperimental?: boolean;
+}
+
+declare type FetchRoute = {
+    readonly value: string;
+};
+
+declare type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+
+declare interface HostRouter {
+    navigate(url: string): Promise<void>;
+    open(url: string): Promise<void>;
+    reload(): Promise<void>;
+}
+
+declare type InvokePayload = {
+    [key in number | string]: unknown;
+};
+
+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>>;
+
+declare type InvokeSignature = <T = unknown, U = InvokePayload, A extends string = string>(action: A, data?: U) => Promise<T>;
+
+declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
+
+declare type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
+
+export { }

package/atlassian-app-test/index.es.js

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

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