@valiantys/atlassian-app 3.2.0-alpha-11 → 3.2.0-alpha-12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valiantys/atlassian-app",
-  "version": "3.2.0-alpha-11",
+  "version": "3.2.0-alpha-12",
   "description": "This library provides Atlassian Forge components, wrappers, and utilities to support writing Forge apps that can run deployed or in standalone mode",
   "exports": {
     "./frontend-app": {
@@ -93,6 +93,11 @@
       "require": "./ui-app-flags/index.cjs.js",
       "types": "./ui-app-flags/index.d.ts"
     },
+    "./ui-app-flags-forge": {
+      "import": "./ui-app-flags-forge/index.es.js",
+      "require": "./ui-app-flags-forge/index.cjs.js",
+      "types": "./ui-app-flags-forge/index.d.ts"
+    },
     "./ui-atlaskit-forms": {
       "import": "./ui-atlaskit-forms/index.es.js",
       "require": "./ui-atlaskit-forms/index.cjs.js",

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

@@ -0,0 +1,314 @@
+{
+  "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!AppFlagsProviderForge:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function AppFlagsProviderForge({ 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": "../../forge/shared/frontend-ui-app-flags/src/lib/app-flags-provider-forge.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 7
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "{ children }",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "AppFlagsProviderForge"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app!flagsReducer:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function flagsReducer(flags: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string | number, "
+            },
+            {
+              "kind": "Reference",
+              "text": "Flag",
+              "canonicalReference": "@forge/bridge!Flag:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ", action: "
+            },
+            {
+              "kind": "Reference",
+              "text": "AppFlagAction",
+              "canonicalReference": "@valiantys/atlassian-app!~AppFlagAction:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Flags",
+              "canonicalReference": "@valiantys/atlassian-app!~Flags:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../forge/shared/frontend-ui-app-flags/src/lib/app-flags-provider-forge.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 8,
+            "endIndex": 9
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "flags",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "action",
+              "parameterTypeTokenRange": {
+                "startIndex": 6,
+                "endIndex": 7
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "flagsReducer"
+        }
+      ]
+    }
+  ]
+}

package/ui-app-flags-forge/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 { Flag } 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 function AppFlagsProviderForge({ children }: {
+    children: ReactNode;
+}): JSX_2.Element;
+
+// Warning: (ae-forgotten-export) The symbol "AppFlagAction" needs to be exported by the entry point ui-app-flags-forge.d.ts
+// Warning: (ae-forgotten-export) The symbol "Flags" needs to be exported by the entry point ui-app-flags-forge.d.ts
+//
+// @public (undocumented)
+export function flagsReducer(flags: Record<string | number, Flag>, action: AppFlagAction): Flags;
+
+// (No @packageDocumentation comment for this package)
+
+```

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

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

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

@@ -0,0 +1,24 @@
+import { Flag } 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';
+
+declare interface AppFlagAction {
+    type: AppFlagActions;
+    id: string | number;
+    props?: AppFlagTypes;
+}
+
+declare type AppFlagActions = 'add' | 'remove';
+
+export declare function AppFlagsProviderForge({ children }: {
+    children: ReactNode;
+}): JSX_2.Element;
+
+declare type AppFlagTypes = FlagOptions;
+
+declare type Flags = Record<string | number, Flag>;
+
+export declare function flagsReducer(flags: Record<string | number, Flag>, action: AppFlagAction): Flags;
+
+export { }

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

@@ -0,0 +1,5 @@
+import { AppFlagsProviderForge as o, flagsReducer as g } from "../atlassian/forge/shared/frontend-ui-app-flags/src/lib/app-flags-provider-forge/index.es.js";
+export {
+  o as AppFlagsProviderForge,
+  g as flagsReducer
+};

package/ui-app-flags-forge/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"
+    }
+  ]
+}