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

package/ui-app-flags/atlassian-app-frontend-ui-app-flags.api.json

@@ -0,0 +1,587 @@
+{
+  "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": "TypeAlias",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!ActionsType:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type ActionsType = "
+            },
+            {
+              "kind": "Reference",
+              "text": "FlagAction",
+              "canonicalReference": "@forge/bridge!FlagAction:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[]"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-ui-app-flags/src/lib/app-flag-types.d.ts",
+          "releaseTag": "Public",
+          "name": "ActionsType",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!AppearanceTypes:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type AppearanceTypes = "
+            },
+            {
+              "kind": "Reference",
+              "text": "FlagAppearance",
+              "canonicalReference": "@forge/bridge!FlagAppearance:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-ui-app-flags/src/lib/app-flag-types.d.ts",
+          "releaseTag": "Public",
+          "name": "AppearanceTypes",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!AppFlagAction:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface AppFlagAction "
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-ui-app-flags/src/lib/app-flag-action.d.ts",
+          "releaseTag": "Public",
+          "name": "AppFlagAction",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AppFlagAction#id:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "id: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string | number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "id",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AppFlagAction#props:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "props?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AppFlagTypes",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!AppFlagTypes:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "props",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AppFlagAction#type:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "type: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AppFlagActions",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!AppFlagActions:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "type",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!AppFlagActions:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type AppFlagActions = "
+            },
+            {
+              "kind": "Content",
+              "text": "'add' | 'remove'"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-ui-app-flags/src/lib/app-flag-action.d.ts",
+          "releaseTag": "Public",
+          "name": "AppFlagActions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!AppFlagsDispatchContext:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "AppFlagsDispatchContext: "
+            },
+            {
+              "kind": "Content",
+              "text": "import('react')."
+            },
+            {
+              "kind": "Reference",
+              "text": "Context",
+              "canonicalReference": "@types/react!React.Context:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Dispatch",
+              "canonicalReference": "@types/react!React.Dispatch:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "AppFlagAction",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AppFlagAction:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "> | undefined>"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-ui-app-flags/src/lib/app-flags-dispatch.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "AppFlagsDispatchContext",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!AppFlagsProviderAtlasKit:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function AppFlagsProviderAtlasKit({ children, }: "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    children: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ReactNode",
+              "canonicalReference": "@types/react!React.ReactNode:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "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-app-flags/src/lib/app-flags-provider-atlaskit.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 7
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "{ children, }",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "AppFlagsProviderAtlasKit"
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!AppFlagTypes:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type AppFlagTypes = "
+            },
+            {
+              "kind": "Reference",
+              "text": "FlagOptions",
+              "canonicalReference": "@forge/bridge!FlagOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-ui-app-flags/src/lib/app-flag-types.d.ts",
+          "releaseTag": "Public",
+          "name": "AppFlagTypes",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!useAppFlagsDispatch:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function useAppFlagsDispatch(): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Dispatch",
+              "canonicalReference": "@types/react!React.Dispatch:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "AppFlagAction",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AppFlagAction:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-ui-app-flags/src/lib/app-flags-dispatch.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [],
+          "name": "useAppFlagsDispatch"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!useAppFlagsDispatchMethods:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function useAppFlagsDispatchMethods(): "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    addFlag: (props: "
+            },
+            {
+              "kind": "Reference",
+              "text": "AppFlagTypes",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AppFlagTypes:type"
+            },
+            {
+              "kind": "Content",
+              "text": ") => void;\n    removeFlag: (flagId: string) => void;\n    addErrorFlag: (flagId: string, title: string, error?: unknown, actions?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ActionsType",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!ActionsType:type"
+            },
+            {
+              "kind": "Content",
+              "text": ") => void;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-ui-app-flags/src/lib/app-flags-dispatch-methods.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [],
+          "name": "useAppFlagsDispatchMethods"
+        }
+      ]
+    }
+  ]
+}

package/ui-app-flags/atlassian-app-frontend.api.md

@@ -0,0 +1,57 @@
+## 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 { Context } from 'react';
+import { Dispatch } from 'react';
+import { FlagAction } from '@forge/bridge/out/flag/flag';
+import { FlagAppearance } from '@forge/bridge/out/flag/flag';
+import { FlagOptions } from '@forge/bridge/out/flag/flag';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+// @public (undocumented)
+export type ActionsType = FlagAction[];
+
+// @public (undocumented)
+export type AppearanceTypes = FlagAppearance;
+
+// @public (undocumented)
+export interface AppFlagAction {
+    // (undocumented)
+    id: string | number;
+    // (undocumented)
+    props?: AppFlagTypes;
+    // (undocumented)
+    type: AppFlagActions;
+}
+
+// @public (undocumented)
+export type AppFlagActions = 'add' | 'remove';
+
+// @public (undocumented)
+export const AppFlagsDispatchContext: Context<Dispatch<AppFlagAction> | undefined>;
+
+// @public (undocumented)
+export function AppFlagsProviderAtlasKit({ children, }: {
+    children: ReactNode;
+}): JSX_2.Element;
+
+// @public (undocumented)
+export type AppFlagTypes = FlagOptions;
+
+// @public (undocumented)
+export function useAppFlagsDispatch(): Dispatch<AppFlagAction>;
+
+// @public (undocumented)
+export function useAppFlagsDispatchMethods(): {
+    addFlag: (props: AppFlagTypes) => void;
+    removeFlag: (flagId: string) => void;
+    addErrorFlag: (flagId: string, title: string, error?: unknown, actions?: ActionsType) => void;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```

package/ui-app-flags/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("../atlassian/shared/frontend-ui-app-flags/src/lib/app-flags-dispatch/index.cjs.js"),p=require("../atlassian/shared/frontend-ui-app-flags/src/lib/app-flags-dispatch-methods/index.cjs.js"),t=require("../atlassian/shared/frontend-ui-app-flags/src/lib/app-flags-provider-atlaskit/index.cjs.js");exports.AppFlagsDispatchContext=s.AppFlagsDispatchContext;exports.useAppFlagsDispatch=s.useAppFlagsDispatch;exports.useAppFlagsDispatchMethods=p.useAppFlagsDispatchMethods;exports.AppFlagsProviderAtlasKit=t.AppFlagsProviderAtlasKit;

package/ui-app-flags/index.d.ts

@@ -0,0 +1,37 @@
+import { Context } from 'react';
+import { Dispatch } from 'react';
+import { FlagAction } from '@forge/bridge/out/flag/flag';
+import { FlagAppearance } from '@forge/bridge/out/flag/flag';
+import { FlagOptions } from '@forge/bridge/out/flag/flag';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+export declare type ActionsType = FlagAction[];
+
+export declare type AppearanceTypes = FlagAppearance;
+
+export declare interface AppFlagAction {
+    type: AppFlagActions;
+    id: string | number;
+    props?: AppFlagTypes;
+}
+
+export declare type AppFlagActions = 'add' | 'remove';
+
+export declare const AppFlagsDispatchContext: Context<Dispatch<AppFlagAction> | undefined>;
+
+export declare function AppFlagsProviderAtlasKit({ children, }: {
+    children: ReactNode;
+}): JSX_2.Element;
+
+export declare type AppFlagTypes = FlagOptions;
+
+export declare function useAppFlagsDispatch(): Dispatch<AppFlagAction>;
+
+export declare function useAppFlagsDispatchMethods(): {
+    addFlag: (props: AppFlagTypes) => void;
+    removeFlag: (flagId: string) => void;
+    addErrorFlag: (flagId: string, title: string, error?: unknown, actions?: ActionsType) => void;
+};
+
+export { }

package/ui-app-flags/index.es.js

@@ -0,0 +1,9 @@
+import { AppFlagsDispatchContext as t, useAppFlagsDispatch as o } from "../atlassian/shared/frontend-ui-app-flags/src/lib/app-flags-dispatch/index.es.js";
+import { useAppFlagsDispatchMethods as e } from "../atlassian/shared/frontend-ui-app-flags/src/lib/app-flags-dispatch-methods/index.es.js";
+import { AppFlagsProviderAtlasKit as i } from "../atlassian/shared/frontend-ui-app-flags/src/lib/app-flags-provider-atlaskit/index.es.js";
+export {
+  t as AppFlagsDispatchContext,
+  i as AppFlagsProviderAtlasKit,
+  o as useAppFlagsDispatch,
+  e as useAppFlagsDispatchMethods
+};