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

package/ui-drop-target/atlassian-app-frontend-ui-drop-target.api.json

@@ -0,0 +1,586 @@
+{
+  "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": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!DropItemBase:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface DropItemBase<T> "
+            }
+          ],
+          "fileUrlPath": "../../../shared/frontend-ui-drop-target/src/lib/drop-item-types.d.ts",
+          "releaseTag": "Public",
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "DropItemBase",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!DropItemBase#dataTransfer:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "dataTransfer: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "T"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "dataTransfer",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!DropTargetBox:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function DropTargetBox<T>({ onDrop, accept, children, }: "
+            },
+            {
+              "kind": "Reference",
+              "text": "DropTargetBoxProps",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!DropTargetBoxProps:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<T> & "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropsWithChildren",
+              "canonicalReference": "@types/react!React.PropsWithChildren:type"
+            },
+            {
+              "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-drop-target/src/lib/drop-target-box.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 7
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "{ onDrop, accept, children, }",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              },
+              "isOptional": false
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "DropTargetBox"
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!DropTargetBoxProps:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface DropTargetBoxProps<T> "
+            }
+          ],
+          "fileUrlPath": "../../../shared/frontend-ui-drop-target/src/lib/drop-target-box.d.ts",
+          "releaseTag": "Public",
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "DropTargetBoxProps",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!DropTargetBoxProps#accept:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "accept: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "TargetType",
+                  "canonicalReference": "dnd-core!TargetType:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "accept",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!DropTargetBoxProps#onDrop:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onDrop: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(item: T) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "onDrop",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!HtmlDropItem:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface HtmlDropItem extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "DropItemBase",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!DropItemBase:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, never>>"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "../../../shared/frontend-ui-drop-target/src/lib/drop-item-types.d.ts",
+          "releaseTag": "Public",
+          "name": "HtmlDropItem",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!HtmlDropItem#html:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "html: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "html",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 5
+            }
+          ]
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!ParsedLink:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface ParsedLink "
+            }
+          ],
+          "fileUrlPath": "../../../shared/frontend-ui-drop-target/src/lib/drop-utils.d.ts",
+          "releaseTag": "Public",
+          "name": "ParsedLink",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!ParsedLink#href:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "href: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "href",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!ParsedLink#text:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "text: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "text",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!parseDroppedHtmlLink:function(1)",
+          "docComment": "/**\n * This function is for parsing html link anchor tags that have been drag/dropped.\n *\n * @param linkItem - A 'text/html' drop item\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function parseDroppedHtmlLink(linkItem: "
+            },
+            {
+              "kind": "Reference",
+              "text": "HtmlDropItem",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!HtmlDropItem:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "ParsedLink",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!ParsedLink:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../../shared/frontend-ui-drop-target/src/lib/drop-utils.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "linkItem",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "parseDroppedHtmlLink"
+        }
+      ]
+    }
+  ]
+}

package/ui-drop-target/atlassian-app-frontend.api.md

@@ -0,0 +1,47 @@
+## 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 { PropsWithChildren } from 'react';
+import { TargetType } from 'dnd-core';
+
+// @public (undocumented)
+export interface DropItemBase<T> {
+    // (undocumented)
+    dataTransfer: T;
+}
+
+// @public (undocumented)
+export function DropTargetBox<T>({ onDrop, accept, children, }: DropTargetBoxProps<T> & PropsWithChildren): JSX_2.Element;
+
+// @public (undocumented)
+export interface DropTargetBoxProps<T> {
+    // (undocumented)
+    accept: TargetType;
+    // (undocumented)
+    onDrop: (item: T) => void;
+}
+
+// @public (undocumented)
+export interface HtmlDropItem extends DropItemBase<Record<string, never>> {
+    // (undocumented)
+    html: string;
+}
+
+// @public (undocumented)
+export interface ParsedLink {
+    // (undocumented)
+    href: string;
+    // (undocumented)
+    text: string;
+}
+
+// @public
+export function parseDroppedHtmlLink(linkItem: HtmlDropItem): ParsedLink;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/ui-drop-target/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("../shared/frontend-ui-drop-target/src/lib/drop-utils/index.cjs.js"),e=require("../shared/frontend-ui-drop-target/src/lib/drop-target-box/index.cjs.js");exports.parseDroppedHtmlLink=r.parseDroppedHtmlLink;exports.DropTargetBox=e.DropTargetBox;

package/ui-drop-target/index.d.ts

@@ -0,0 +1,31 @@
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+import { TargetType } from 'dnd-core';
+
+export declare interface DropItemBase<T> {
+    dataTransfer: T;
+}
+
+export declare function DropTargetBox<T>({ onDrop, accept, children, }: DropTargetBoxProps<T> & PropsWithChildren): JSX_2.Element;
+
+export declare interface DropTargetBoxProps<T> {
+    onDrop: (item: T) => void;
+    accept: TargetType;
+}
+
+export declare interface HtmlDropItem extends DropItemBase<Record<string, never>> {
+    html: string;
+}
+
+export declare interface ParsedLink {
+    href: string;
+    text: string;
+}
+
+/**
+ * This function is for parsing html link anchor tags that have been drag/dropped.
+ * @param linkItem A 'text/html' drop item
+ */
+export declare function parseDroppedHtmlLink(linkItem: HtmlDropItem): ParsedLink;
+
+export { }

package/ui-drop-target/index.es.js

@@ -0,0 +1,6 @@
+import { parseDroppedHtmlLink as p } from "../shared/frontend-ui-drop-target/src/lib/drop-utils/index.es.js";
+import { DropTargetBox as t } from "../shared/frontend-ui-drop-target/src/lib/drop-target-box/index.es.js";
+export {
+  t as DropTargetBox,
+  p as parseDroppedHtmlLink
+};

package/ui-drop-target/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"
+    }
+  ]
+}