@valiantys/atlassian-app 3.2.0-alpha-1

package/ui-iframe/atlassian-app.api.md

@@ -0,0 +1,43 @@
+## API Report File for "@valiantys/atlassian-app"
+
+> 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';
+
+// @public (undocumented)
+export interface IframeProps {
+    // (undocumented)
+    height?: string;
+    // (undocumented)
+    link: string;
+    // (undocumented)
+    title?: string;
+    // (undocumented)
+    width?: string;
+}
+
+// @public (undocumented)
+export const IframeWrapper: default_2.ForwardRefExoticComponent<Readonly<IframeWrapperProps> & default_2.RefAttributes<unknown>>;
+
+// @public (undocumented)
+export interface IframeWrapperProps {
+    // (undocumented)
+    iframeProps: IframeProps;
+    // (undocumented)
+    messageCallback?: (eventData: any) => void;
+    // (undocumented)
+    onMouseOut?: () => void;
+}
+
+// @public (undocumented)
+export interface IframeWrapperRef {
+    // (undocumented)
+    focusContentWindow: () => void;
+    reloadContentWindow: () => void;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/ui-iframe/index.cjs.js

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

package/ui-iframe/index.d.ts

@@ -0,0 +1,24 @@
+import { default as default_2 } from 'react';
+
+export declare interface IframeProps {
+    link: string;
+    title?: string;
+    width?: string;
+    height?: string;
+}
+
+export declare const IframeWrapper: default_2.ForwardRefExoticComponent<Readonly<IframeWrapperProps> & default_2.RefAttributes<unknown>>;
+
+export declare interface IframeWrapperProps {
+    iframeProps: IframeProps;
+    messageCallback?: (eventData: any) => void;
+    onMouseOut?: () => void;
+}
+
+export declare interface IframeWrapperRef {
+    /** reload will only work in a same-origin frame **/
+    reloadContentWindow: () => void;
+    focusContentWindow: () => void;
+}
+
+export { }

package/ui-iframe/index.es.js

@@ -0,0 +1,4 @@
+import { IframeWrapper as p } from "../atlassian/shared/frontend-ui-iframe/src/lib/iframe-wrapper/index.es.js";
+export {
+  p as IframeWrapper
+};

package/ui-iframe/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-load-data-hook/atlassian-app-ui-load-data-hook.api.json

@@ -0,0 +1,329 @@
+{
+  "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!",
+  "docComment": "",
+  "name": "@valiantys/atlassian-app",
+  "preserveMemberOrder": false,
+  "members": [
+    {
+      "kind": "EntryPoint",
+      "canonicalReference": "@valiantys/atlassian-app!",
+      "name": "",
+      "preserveMemberOrder": false,
+      "members": [
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app!useLoadDataEffect:function(1)",
+          "docComment": "/**\n * Example usage: export function MyComponent({ id }) {\n *\n * const requestFunction = useCallback( () => fetch(`/data/${id}`), [id] )\n *\n * const { data, loading, error } = useLoadDataEffect<MyDataType>(requestFunction)\n *\n * if (error) return <ErrorScreen /> if (loading) return <Spinner /> return <div>{data.property}</div> }\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function useLoadDataEffect<T>(requestFunc: "
+            },
+            {
+              "kind": "Content",
+              "text": "() => "
+            },
+            {
+              "kind": "Reference",
+              "text": "Promise",
+              "canonicalReference": "!Promise:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<T>"
+            },
+            {
+              "kind": "Content",
+              "text": ", errorHandler?: "
+            },
+            {
+              "kind": "Content",
+              "text": "typeof "
+            },
+            {
+              "kind": "Reference",
+              "text": "defaultErrorHandler",
+              "canonicalReference": "@valiantys/atlassian-app!~defaultErrorHandler:function"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    data: T | undefined;\n    loading: boolean;\n    error: string | undefined;\n    setData: import('react')."
+            },
+            {
+              "kind": "Reference",
+              "text": "Dispatch",
+              "canonicalReference": "@types/react!React.Dispatch:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<import('react')."
+            },
+            {
+              "kind": "Reference",
+              "text": "SetStateAction",
+              "canonicalReference": "@types/react!React.SetStateAction:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<T | undefined>>;\n    setLoading: import('react')."
+            },
+            {
+              "kind": "Reference",
+              "text": "Dispatch",
+              "canonicalReference": "@types/react!React.Dispatch:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<import('react')."
+            },
+            {
+              "kind": "Reference",
+              "text": "SetStateAction",
+              "canonicalReference": "@types/react!React.SetStateAction:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<boolean>>;\n    setError: import('react')."
+            },
+            {
+              "kind": "Reference",
+              "text": "Dispatch",
+              "canonicalReference": "@types/react!React.Dispatch:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<import('react')."
+            },
+            {
+              "kind": "Reference",
+              "text": "SetStateAction",
+              "canonicalReference": "@types/react!React.SetStateAction:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string | undefined>>;\n    manualTrigger: () => "
+            },
+            {
+              "kind": "Reference",
+              "text": "Promise",
+              "canonicalReference": "!Promise:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<T | undefined>;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../../shared/frontend-ui-load-data-hook/src/lib/load-data-hook.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 8,
+            "endIndex": 23
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "requestFunc",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "errorHandler",
+              "parameterTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 7
+              },
+              "isOptional": true
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "useLoadDataEffect"
+        }
+      ]
+    }
+  ]
+}

package/ui-load-data-hook/atlassian-app.api.md

@@ -0,0 +1,25 @@
+## API Report File for "@valiantys/atlassian-app"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Dispatch } from 'react';
+import { SetStateAction } from 'react';
+
+// Warning: (ae-forgotten-export) The symbol "defaultErrorHandler" needs to be exported by the entry point ui-load-data-hook.d.ts
+//
+// @public
+export function useLoadDataEffect<T>(requestFunc: () => Promise<T>, errorHandler?: typeof defaultErrorHandler): {
+    data: T | undefined;
+    loading: boolean;
+    error: string | undefined;
+    setData: Dispatch<SetStateAction<T | undefined>>;
+    setLoading: Dispatch<SetStateAction<boolean>>;
+    setError: Dispatch<SetStateAction<string | undefined>>;
+    manualTrigger: () => Promise<T | undefined>;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```

package/ui-load-data-hook/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../shared/frontend-ui-load-data-hook/src/lib/load-data-hook/index.cjs.js");exports.useLoadDataEffect=e.useLoadDataEffect;

package/ui-load-data-hook/index.d.ts

@@ -0,0 +1,38 @@
+import { Dispatch } from 'react';
+import { SetStateAction } from 'react';
+
+/**
+ * Logs the error and returns `Error Occurred: ${e.message || e}`
+ */
+declare function defaultErrorHandler(e: {
+    message?: string;
+}): string;
+
+/**
+ * Example usage:
+ * export function MyComponent({ id }) {
+ *
+ *   const requestFunction = useCallback(
+ *     () => fetch(`/data/${id}`),
+ *     [id]
+ *   )
+ *
+ *   const { data, loading, error } = useLoadDataEffect<MyDataType>(requestFunction)
+ *
+ *   if (error) return <ErrorScreen />
+ *   if (loading) return <Spinner />
+ *   return <div>{data.property}</div>
+ * }
+ *
+ */
+export declare function useLoadDataEffect<T>(requestFunc: () => Promise<T>, errorHandler?: typeof defaultErrorHandler): {
+    data: T | undefined;
+    loading: boolean;
+    error: string | undefined;
+    setData: Dispatch<SetStateAction<T | undefined>>;
+    setLoading: Dispatch<SetStateAction<boolean>>;
+    setError: Dispatch<SetStateAction<string | undefined>>;
+    manualTrigger: () => Promise<T | undefined>;
+};
+
+export { }

package/ui-load-data-hook/index.es.js

@@ -0,0 +1,4 @@
+import { useLoadDataEffect as f } from "../shared/frontend-ui-load-data-hook/src/lib/load-data-hook/index.es.js";
+export {
+  f as useLoadDataEffect
+};

package/ui-load-data-hook/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"
+    }
+  ]
+}