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

package/ui-app-flags/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/ui-atlassian-product-fetch/atlassian-app-frontend-ui-atlassian-product-fetch.api.json

@@ -0,0 +1,418 @@
+{
+  "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!RequestBitbucketProvider:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function RequestBitbucketProvider({ children, requestBitbucketImplementation, }: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RequestBitbucketProviderProps",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!~RequestBitbucketProviderProps:interface"
+            },
+            {
+              "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-ui-atlassian-product-fetch/src/lib/request-bitbucket.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 5
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "{ children, requestBitbucketImplementation, }",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "RequestBitbucketProvider"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!RequestConfluenceProvider:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function RequestConfluenceProvider({ children, requestConfluenceImplementation, }: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RequestConfluenceProviderProps",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!~RequestConfluenceProviderProps:interface"
+            },
+            {
+              "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-ui-atlassian-product-fetch/src/lib/request-confluence.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 5
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "{ children, requestConfluenceImplementation, }",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "RequestConfluenceProvider"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!RequestJiraProvider:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function RequestJiraProvider({ children, requestJiraImplementation, }: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RequestJiraProviderProps",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!~RequestJiraProviderProps:interface"
+            },
+            {
+              "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-ui-atlassian-product-fetch/src/lib/request-jira.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 5
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "{ children, requestJiraImplementation, }",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "RequestJiraProvider"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!useRequestBitbucket:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "useRequestBitbucket: () => "
+            },
+            {
+              "kind": "Reference",
+              "text": "AtlassianProductFetchService",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!~AtlassianProductFetchService:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<\"bitbucket\">"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-ui-atlassian-product-fetch/src/lib/request-bitbucket.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [],
+          "name": "useRequestBitbucket"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!useRequestConfluence:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "useRequestConfluence: () => "
+            },
+            {
+              "kind": "Reference",
+              "text": "AtlassianProductFetchService",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!~AtlassianProductFetchService:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<\"confluence\">"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-ui-atlassian-product-fetch/src/lib/request-confluence.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [],
+          "name": "useRequestConfluence"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!useRequestJira:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "useRequestJira: () => "
+            },
+            {
+              "kind": "Reference",
+              "text": "AtlassianProductFetchService",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!~AtlassianProductFetchService:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<\"jira\">"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-ui-atlassian-product-fetch/src/lib/request-jira.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [],
+          "name": "useRequestJira"
+        }
+      ]
+    }
+  ]
+}

package/ui-atlassian-product-fetch/atlassian-app-frontend.api.md

@@ -0,0 +1,38 @@
+## 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 { ReactNode } from 'react';
+
+// Warning: (ae-forgotten-export) The symbol "RequestBitbucketProviderProps" needs to be exported by the entry point ui-atlassian-product-fetch.d.ts
+//
+// @public (undocumented)
+export function RequestBitbucketProvider({ children, requestBitbucketImplementation, }: RequestBitbucketProviderProps): JSX_2.Element;
+
+// Warning: (ae-forgotten-export) The symbol "RequestConfluenceProviderProps" needs to be exported by the entry point ui-atlassian-product-fetch.d.ts
+//
+// @public (undocumented)
+export function RequestConfluenceProvider({ children, requestConfluenceImplementation, }: RequestConfluenceProviderProps): JSX_2.Element;
+
+// Warning: (ae-forgotten-export) The symbol "RequestJiraProviderProps" needs to be exported by the entry point ui-atlassian-product-fetch.d.ts
+//
+// @public (undocumented)
+export function RequestJiraProvider({ children, requestJiraImplementation, }: RequestJiraProviderProps): JSX_2.Element;
+
+// Warning: (ae-forgotten-export) The symbol "AtlassianProductFetchService" needs to be exported by the entry point ui-atlassian-product-fetch.d.ts
+//
+// @public (undocumented)
+export const useRequestBitbucket: () => AtlassianProductFetchService<"bitbucket">;
+
+// @public (undocumented)
+export const useRequestConfluence: () => AtlassianProductFetchService<"confluence">;
+
+// @public (undocumented)
+export const useRequestJira: () => AtlassianProductFetchService<"jira">;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/ui-atlassian-product-fetch/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/shared/frontend-ui-atlassian-product-fetch/src/lib/request-bitbucket/index.cjs.js"),u=require("../atlassian/shared/frontend-ui-atlassian-product-fetch/src/lib/request-confluence/index.cjs.js"),t=require("../atlassian/shared/frontend-ui-atlassian-product-fetch/src/lib/request-jira/index.cjs.js");exports.RequestBitbucketProvider=e.RequestBitbucketProvider;exports.useRequestBitbucket=e.useRequestBitbucket;exports.RequestConfluenceProvider=u.RequestConfluenceProvider;exports.useRequestConfluence=u.useRequestConfluence;exports.RequestJiraProvider=t.RequestJiraProvider;exports.useRequestJira=t.useRequestJira;

package/ui-atlassian-product-fetch/index.d.ts

@@ -0,0 +1,60 @@
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+declare type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
+
+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;
+}
+
+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 type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
+
+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'>;
+}
+
+declare type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
+
+export declare const useRequestBitbucket: () => AtlassianProductFetchService<"bitbucket">;
+
+export declare const useRequestConfluence: () => AtlassianProductFetchService<"confluence">;
+
+export declare const useRequestJira: () => AtlassianProductFetchService<"jira">;
+
+export { }

package/ui-atlassian-product-fetch/index.es.js

@@ -0,0 +1,11 @@
+import { RequestBitbucketProvider as t, useRequestBitbucket as u } from "../atlassian/shared/frontend-ui-atlassian-product-fetch/src/lib/request-bitbucket/index.es.js";
+import { RequestConfluenceProvider as s, useRequestConfluence as i } from "../atlassian/shared/frontend-ui-atlassian-product-fetch/src/lib/request-confluence/index.es.js";
+import { RequestJiraProvider as R, useRequestJira as f } from "../atlassian/shared/frontend-ui-atlassian-product-fetch/src/lib/request-jira/index.es.js";
+export {
+  t as RequestBitbucketProvider,
+  s as RequestConfluenceProvider,
+  R as RequestJiraProvider,
+  u as useRequestBitbucket,
+  i as useRequestConfluence,
+  f as useRequestJira
+};

package/ui-atlassian-product-fetch/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"
+    }
+  ]
+}