@atlaskit/rovo-agent-components 2.7.0 → 2.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # @atlaskit/rovo-agent-components
2
2
 
3
+ ## 2.7.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [#144872](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/144872)
8
+ [`ce47d82258a6d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ce47d82258a6d) -
9
+ Add comments to indicate depreciation; clarification on updated agentNamedId param because BE
10
+ changed to use agentExternalConfigReference
11
+
3
12
  ## 2.7.0
4
13
 
5
14
  ### Minor Changes
@@ -30,6 +30,13 @@ var styles = {
30
30
  var stylesCompiled = {
31
31
  innerShape: "_4t3i1lk2 _1bsb1lk2 _mkrz1k6g"
32
32
  };
33
+ /**
34
+ * Agent avatar components that handles rendering correct avatar for different variations of agent types
35
+ *
36
+ * @param agentNamedId - This is agent.external_config_reference, this value exists for OOTB (out of the box) agents. This id is the first priority to generate avatar because each OOTB agents have its own fixed avatar
37
+ * @param agentIdentityAccountId - This is Atlassian identity account ID for the agent(aaid). This id is prioritised to generate random avatar for non OOTB agents
38
+ * @param agentId - This is agent.id
39
+ */
33
40
  var AgentAvatar = exports.AgentAvatar = function AgentAvatar(_ref) {
34
41
  var imageUrl = _ref.imageUrl,
35
42
  _ref$size = _ref.size,
@@ -17,6 +17,13 @@ const styles = {
17
17
  const stylesCompiled = {
18
18
  innerShape: "_4t3i1lk2 _1bsb1lk2 _mkrz1k6g"
19
19
  };
20
+ /**
21
+ * Agent avatar components that handles rendering correct avatar for different variations of agent types
22
+ *
23
+ * @param agentNamedId - This is agent.external_config_reference, this value exists for OOTB (out of the box) agents. This id is the first priority to generate avatar because each OOTB agents have its own fixed avatar
24
+ * @param agentIdentityAccountId - This is Atlassian identity account ID for the agent(aaid). This id is prioritised to generate random avatar for non OOTB agents
25
+ * @param agentId - This is agent.id
26
+ */
20
27
  export const AgentAvatar = ({
21
28
  imageUrl,
22
29
  size = 'medium',
@@ -20,6 +20,13 @@ var styles = {
20
20
  var stylesCompiled = {
21
21
  innerShape: "_4t3i1lk2 _1bsb1lk2 _mkrz1k6g"
22
22
  };
23
+ /**
24
+ * Agent avatar components that handles rendering correct avatar for different variations of agent types
25
+ *
26
+ * @param agentNamedId - This is agent.external_config_reference, this value exists for OOTB (out of the box) agents. This id is the first priority to generate avatar because each OOTB agents have its own fixed avatar
27
+ * @param agentIdentityAccountId - This is Atlassian identity account ID for the agent(aaid). This id is prioritised to generate random avatar for non OOTB agents
28
+ * @param agentId - This is agent.id
29
+ */
23
30
  export var AgentAvatar = function AgentAvatar(_ref) {
24
31
  var imageUrl = _ref.imageUrl,
25
32
  _ref$size = _ref.size,
@@ -12,5 +12,12 @@ type AgentAvatarProps = {
12
12
  isForgeAgent?: boolean;
13
13
  forgeAgentIconUrl?: string | null;
14
14
  };
15
+ /**
16
+ * Agent avatar components that handles rendering correct avatar for different variations of agent types
17
+ *
18
+ * @param agentNamedId - This is agent.external_config_reference, this value exists for OOTB (out of the box) agents. This id is the first priority to generate avatar because each OOTB agents have its own fixed avatar
19
+ * @param agentIdentityAccountId - This is Atlassian identity account ID for the agent(aaid). This id is prioritised to generate random avatar for non OOTB agents
20
+ * @param agentId - This is agent.id
21
+ */
15
22
  export declare const AgentAvatar: ({ imageUrl, size, label, name, agentId, agentIdentityAccountId, agentNamedId, showBorder, isForgeAgent, forgeAgentIconUrl, }: AgentAvatarProps) => JSX.Element;
16
23
  export {};
@@ -12,5 +12,12 @@ type AgentAvatarProps = {
12
12
  isForgeAgent?: boolean;
13
13
  forgeAgentIconUrl?: string | null;
14
14
  };
15
+ /**
16
+ * Agent avatar components that handles rendering correct avatar for different variations of agent types
17
+ *
18
+ * @param agentNamedId - This is agent.external_config_reference, this value exists for OOTB (out of the box) agents. This id is the first priority to generate avatar because each OOTB agents have its own fixed avatar
19
+ * @param agentIdentityAccountId - This is Atlassian identity account ID for the agent(aaid). This id is prioritised to generate random avatar for non OOTB agents
20
+ * @param agentId - This is agent.id
21
+ */
15
22
  export declare const AgentAvatar: ({ imageUrl, size, label, name, agentId, agentIdentityAccountId, agentNamedId, showBorder, isForgeAgent, forgeAgentIconUrl, }: AgentAvatarProps) => JSX.Element;
16
23
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/rovo-agent-components",
3
- "version": "2.7.0",
3
+ "version": "2.7.1",
4
4
  "description": "This package host public components related to rovo agents, the components here are needed for other public atlaskit packages",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -40,7 +40,7 @@
40
40
  "@atlaskit/avatar": "^25.0.0",
41
41
  "@atlaskit/button": "^23.0.0",
42
42
  "@atlaskit/css": "^0.10.0",
43
- "@atlaskit/dropdown-menu": "^14.0.0",
43
+ "@atlaskit/dropdown-menu": "^14.1.0",
44
44
  "@atlaskit/heading": "^5.2.0",
45
45
  "@atlaskit/icon": "^25.6.0",
46
46
  "@atlaskit/legacy-custom-icons": "^0.22.0",
@@ -48,7 +48,7 @@
48
48
  "@atlaskit/platform-feature-flags": "^1.1.0",
49
49
  "@atlaskit/primitives": "^14.4.0",
50
50
  "@atlaskit/skeleton": "^2.0.0",
51
- "@atlaskit/tokens": "^4.7.0",
51
+ "@atlaskit/tokens": "^4.8.0",
52
52
  "@atlaskit/tooltip": "^20.0.0",
53
53
  "@babel/runtime": "^7.0.0",
54
54
  "@compiled/react": "^0.18.3",