@valiantys/atlassian-app 3.2.0-alpha-1

package/ui-atlaskit-forms/atlassian-app-ui-atlaskit-forms.api.json

@@ -0,0 +1,341 @@
+{
+  "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!getSelectedOption:function(1)",
+          "docComment": "/**\n * Meant to be used with a useState hook, when you are controlling a <select> value directly instead of using a Form to manage it. This works well when you have multiple selects that depend on each other.\n *\n * Will search the list of options for the one that matches the current state value.\n *\n * If no matching option exists, then it will set the state value to undefined and return undefined.\n *\n * If the current state is undefined and there is only one option in the list, it will automatically select that option by setting the state to the option value and returning the lone option.\n *\n * If there is no current valid selection and the options array has more than one item, then it will return undefined as the current value of the select.\n *\n * Example usage:\n *\n * const [widget, setWidget] = useState<Widget | undefined>();\n *\n * const widgetOptions: Option<Widget>[] = allWidgets.map((w) => ({ label: w.title, value: w }));\n *\n * return ( <Label htmlFor=\"select-widget\">Select Widget</Label> <Select inputId=\"select-widget\" options={widgetOptions} value={getSelectedOption( widgetOptions, widget, setWidget )} onChange={(option) => setWidget(option?.value || undefined)} />);\n *\n * @param options - Array of Option objects whose values are of the same type as the state.\n *\n * @param value - Current value from state\n *\n * @param setter - The setState function for this value\n *\n * @param matcher - \n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function getSelectedOption<T>(options: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Option",
+              "canonicalReference": "@valiantys/atlassian-app!Option_2:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<T>[]"
+            },
+            {
+              "kind": "Content",
+              "text": ", value: "
+            },
+            {
+              "kind": "Content",
+              "text": "T | undefined"
+            },
+            {
+              "kind": "Content",
+              "text": ", setter: "
+            },
+            {
+              "kind": "Content",
+              "text": "(val: T | undefined) => void"
+            },
+            {
+              "kind": "Content",
+              "text": ", matcher?: "
+            },
+            {
+              "kind": "Content",
+              "text": "(a: T | undefined, b: T | undefined) => boolean"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Option",
+              "canonicalReference": "@valiantys/atlassian-app!Option_2:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<T> | null"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-ui-atlaskit-forms/src/lib/option.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 10,
+            "endIndex": 12
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "options",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "value",
+              "parameterTypeTokenRange": {
+                "startIndex": 4,
+                "endIndex": 5
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "setter",
+              "parameterTypeTokenRange": {
+                "startIndex": 6,
+                "endIndex": 7
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "matcher",
+              "parameterTypeTokenRange": {
+                "startIndex": 8,
+                "endIndex": 9
+              },
+              "isOptional": true
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "getSelectedOption"
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@valiantys/atlassian-app!Option_2:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type Option<T = "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": "> = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    label: string;\n    value: T;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-ui-atlaskit-forms/src/lib/option.d.ts",
+          "releaseTag": "Public",
+          "name": "Option_2",
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "typeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          }
+        }
+      ]
+    }
+  ]
+}

package/ui-atlaskit-forms/atlassian-app.api.md

@@ -0,0 +1,19 @@
+## 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
+
+// @public
+export function getSelectedOption<T>(options: Option_2<T>[], value: T | undefined, setter: (val: T | undefined) => void, matcher?: (a: T | undefined, b: T | undefined) => boolean): Option_2<T> | null;
+
+// @public (undocumented)
+type Option_2<T = string> = {
+    label: string;
+    value: T;
+};
+export { Option_2 as Option }
+
+// (No @packageDocumentation comment for this package)
+
+```

package/ui-atlaskit-forms/index.cjs.js

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

package/ui-atlaskit-forms/index.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Meant to be used with a useState hook, when you are controlling a <select> value
+ * directly instead of using a Form to manage it. This works well when you have multiple
+ * selects that depend on each other.
+ *
+ * Will search the list of options for the one that matches the current state value.
+ *
+ * If no matching option exists, then it will set the state value to undefined and return undefined.
+ *
+ * If the current state is undefined and there is only one option in the list, it will automatically select
+ * that option by setting the state to the option value and returning the lone option.
+ *
+ * If there is no current valid selection and the options array has more than one item, then it will
+ * return undefined as the current value of the select.
+ *
+ * Example usage:
+ *
+ * const [widget, setWidget] = useState<Widget | undefined>();
+ *
+ * const widgetOptions: Option<Widget>[] = allWidgets.map((w) => ({ label: w.title, value: w }));
+ *
+ * return (  <Label htmlFor="select-widget">Select Widget</Label>
+ *           <Select
+ *             inputId="select-widget"
+ *             options={widgetOptions}
+ *             value={getSelectedOption(
+ *               widgetOptions,
+ *               widget,
+ *               setWidget
+ *             )}
+ *             onChange={(option) => setWidget(option?.value || undefined)}
+ *         />);
+ *
+ *
+ * @param options Array of Option objects whose values are of the same type as the state.
+ * @param value Current value from state
+ * @param setter The setState function for this value
+ * @param matcher
+ */
+export declare function getSelectedOption<T>(options: Option_2<T>[], value: T | undefined, setter: (val: T | undefined) => void, matcher?: (a: T | undefined, b: T | undefined) => boolean): Option_2<T> | null;
+
+declare type Option_2<T = string> = {
+    label: string;
+    value: T;
+};
+export { Option_2 as Option }
+
+export { }

package/ui-atlaskit-forms/index.es.js

@@ -0,0 +1,4 @@
+import { getSelectedOption as o } from "../atlassian/shared/frontend-ui-atlaskit-forms/src/lib/option/index.es.js";
+export {
+  o as getSelectedOption
+};

package/ui-atlaskit-forms/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"
+    }
+  ]
+}