@atlaskit/ads-mcp 1.11.1 → 1.11.3
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 +15 -0
- package/dist/cjs/tools/get-all-components/components.codegen.js +2 -2
- package/dist/cjs/tools/get-atlaskit-components/atlaskit-components.codegen.js +2 -2
- package/dist/cjs/tools/get-atlaskit-hooks/atlaskit-hooks.codegen.js +282 -82
- package/dist/cjs/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.js +3 -8393
- package/dist/cjs/tools/get-lint-rules/lint-rules-structured-content.codegen.js +22 -14
- package/dist/es2019/tools/get-all-components/components.codegen.js +2 -2
- package/dist/es2019/tools/get-atlaskit-components/atlaskit-components.codegen.js +2 -2
- package/dist/es2019/tools/get-atlaskit-hooks/atlaskit-hooks.codegen.js +282 -82
- package/dist/es2019/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.js +2 -8386
- package/dist/es2019/tools/get-lint-rules/lint-rules-structured-content.codegen.js +22 -14
- package/dist/esm/tools/get-all-components/components.codegen.js +2 -2
- package/dist/esm/tools/get-atlaskit-components/atlaskit-components.codegen.js +2 -2
- package/dist/esm/tools/get-atlaskit-hooks/atlaskit-hooks.codegen.js +282 -82
- package/dist/esm/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.js +2 -8386
- package/dist/esm/tools/get-lint-rules/lint-rules-structured-content.codegen.js +22 -14
- package/dist/types/tools/get-all-components/components.codegen.d.ts +1 -1
- package/dist/types/tools/get-atlaskit-components/atlaskit-components.codegen.d.ts +1 -1
- package/dist/types/tools/get-atlaskit-hooks/atlaskit-hooks.codegen.d.ts +1 -1
- package/dist/types/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.d.ts +1 -1
- package/dist/types/tools/get-lint-rules/lint-rules-structured-content.codegen.d.ts +1 -1
- package/dist/types/tools/types.d.ts +1 -1
- package/package.json +2 -2
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Structured content hooks from design-system *.docs.tsx files
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
6
|
+
* @codegen <<SignedSource::3a2fe9a9152f31ebddcf3fa6102ec30b>>
|
|
7
7
|
* @codegenCommand afm workspace @af/ads-ai-tooling codegen
|
|
8
8
|
*/
|
|
9
9
|
/* eslint-disable @repo/internal/react/boolean-prop-naming-convention -- not our types */
|
|
@@ -320,7 +320,7 @@ export const atlaskitHooks = [{
|
|
|
320
320
|
keywords: ['smart-card', 'hooks', 'useSmartLinkActions', 'actions'],
|
|
321
321
|
category: 'linking',
|
|
322
322
|
package: '@atlaskit/smart-card',
|
|
323
|
-
examples: ["import React, { useCallback } from 'react';\nimport Button from '@atlaskit/button/default/button';\nimport { SmartCardProvider } from '@atlaskit/link-provider/smart-card-provider';\nimport {
|
|
323
|
+
examples: ["import React, { useCallback } from 'react';\nimport Button from '@atlaskit/button/default/button';\nimport { SmartCardProvider } from '@atlaskit/link-provider/smart-card-provider';\nimport {\n\tResolvedClient,\n\tResolvedClientUrl,\n} from '@atlaskit/link-test-helpers/smart-card/mocks/clients';\nimport { Box } from '@atlaskit/primitives/compiled/box';\nimport { Card } from '../../src';\nimport { CardAction } from '../../src/constants';\nimport { useSmartLinkActions } from '../../src/hooks';\nimport ExampleContainer from './example-container';\nconst PreviewButton = ({ url }: { url: string }) => {\n\tconst actions = useSmartLinkActions({ url, appearance: 'block' });\n\t// actions are returned in an array, find the preview action\n\tconst previewAction = actions.find((action) => action.id === 'preview-content');\n\tconst handleClick = useCallback(() => {\n\t\tif (previewAction) {\n\t\t\tpreviewAction.invoke();\n\t\t}\n\t}, [previewAction]);\n\tif (!previewAction) {\n\t\treturn null;\n\t}\n\treturn <Button onClick={handleClick}>{previewAction.text}</Button>;\n};\nconst UseSmartLinkActionsExample = (): React.JSX.Element => (\n\t<ExampleContainer>\n\t\t<SmartCardProvider client={new ResolvedClient()}>\n\t\t\t<Card\n\t\t\t\tappearance=\"block\"\n\t\t\t\turl={ResolvedClientUrl}\n\t\t\t\tactionOptions={{ hide: false, exclude: [CardAction.PreviewAction] }}\n\t\t\t/>\n\t\t\t<Box paddingBlockStart=\"space.200\">\n\t\t\t\t<PreviewButton url={ResolvedClientUrl} />\n\t\t\t</Box>\n\t\t</SmartCardProvider>\n\t</ExampleContainer>\n);\nexport default UseSmartLinkActionsExample;"]
|
|
324
324
|
}, {
|
|
325
325
|
name: 'useSmartLinkEvents',
|
|
326
326
|
description: 'Hook that returns a SmartLinkEvents object for dispatching analytics events for a given URL. Currently supports insertSmartLink.',
|
|
@@ -330,19 +330,15 @@ export const atlaskitHooks = [{
|
|
|
330
330
|
keywords: ['smart-card', 'hooks', 'analytics', 'useSmartLinkEvents', 'events'],
|
|
331
331
|
category: 'linking',
|
|
332
332
|
package: '@atlaskit/smart-card',
|
|
333
|
-
examples: ["import AnalyticsContext from '@atlaskit/analytics-next/AnalyticsContext';\nimport AnalyticsListener from '@atlaskit/analytics-next/AnalyticsListener';\nimport type UIAnalyticsEvent from '@atlaskit/analytics-next/UIAnalyticsEvent';\nimport Heading from '@atlaskit/heading/heading';\nimport { SmartCardProvider } from '@atlaskit/link-provider/smart-card-provider';\nimport {
|
|
333
|
+
examples: ["import AnalyticsContext from '@atlaskit/analytics-next/AnalyticsContext';\nimport AnalyticsListener from '@atlaskit/analytics-next/AnalyticsListener';\nimport type UIAnalyticsEvent from '@atlaskit/analytics-next/UIAnalyticsEvent';\nimport { cssMap } from '@atlaskit/css';\nimport Heading from '@atlaskit/heading/heading';\nimport { SmartCardProvider } from '@atlaskit/link-provider/smart-card-provider';\nimport {\n\tResolvedClient,\n\tResolvedClientUrl,\n} from '@atlaskit/link-test-helpers/smart-card/mocks/clients';\nimport { Box } from '@atlaskit/primitives/compiled/box';\nimport { Text } from '@atlaskit/primitives/compiled/text';\nimport { token } from '@atlaskit/tokens';\nimport { Card } from '../../src';\nconst styles = cssMap({\n\theading: { marginBottom: token('space.100') },\n\tstack: { marginTop: token('space.100') },\n});\ntype ExampleComponentProps = {\n\tsetRecentEvents: React.Dispatch<React.SetStateAction<UIAnalyticsEvent[]>>;\n};\nconst ExampleComponent = ({ setRecentEvents }: ExampleComponentProps): JSX.Element => {\n\tconst handleOnClick = React.useCallback(\n\t\t(e: React.MouseEvent<Element, MouseEvent> | React.KeyboardEvent<Element>) => {\n\t\t\te.preventDefault();\n\t\t\treturn;\n\t\t},\n\t\t[],\n\t);\n\treturn (\n\t\t<AnalyticsListener\n\t\t\tonEvent={(event) => {\n\t\t\t\tsetRecentEvents((prevEvents) => [...prevEvents, event]);\n\t\t\t}}\n\t\t\tchannel=\"*\"\n\t\t>\n\t\t\t<AnalyticsContext\n\t\t\t\tdata={{\n\t\t\t\t\tsource: 'content',\n\t\t\t\t\tattributes: {\n\t\t\t\t\t\tdisplayCategory: 'link',\n\t\t\t\t\t\tdisplay: 'url',\n\t\t\t\t\t\tid: '123',\n\t\t\t\t\t},\n\t\t\t\t}}\n\t\t\t>\n\t\t\t\t<SmartCardProvider client={new ResolvedClient('dev')}>\n\t\t\t\t\t<Card\n\t\t\t\t\t\turl={ResolvedClientUrl}\n\t\t\t\t\t\tappearance=\"inline\"\n\t\t\t\t\t\tplatform=\"web\"\n\t\t\t\t\t\tshowHoverPreview={true}\n\t\t\t\t\t\tonClick={handleOnClick}\n\t\t\t\t\t/>\n\t\t\t\t</SmartCardProvider>\n\t\t\t</AnalyticsContext>\n\t\t</AnalyticsListener>\n\t);\n};\nexport default (): React.JSX.Element => {\n\tconst [recentEvents, setRecentEvents] = React.useState<UIAnalyticsEvent[]>([]);\n\tconst mostRecent10Events = React.useMemo(() => {\n\t\treturn Array.from({ length: 10 }, (_, i) => {\n\t\t\treturn recentEvents.at(recentEvents.length - i - 1);\n\t\t});\n\t}, [recentEvents]);\n\treturn (\n\t\t<Box>\n\t\t\t<Box xcss={styles.heading}>\n\t\t\t\t<Heading size=\"medium\">Interact with the link below and see events being fired</Heading>\n\t\t\t</Box>\n\t\t\t<ExampleComponent setRecentEvents={setRecentEvents} />\n\t\t\t<Box xcss={styles.stack}>\n\t\t\t\t<Heading size=\"small\">The 10 Most Recent Events Fired</Heading>\n\t\t\t\t<ol>\n\t\t\t\t\t{mostRecent10Events.map((event, index) => {\n\t\t\t\t\t\tif (event === undefined) {\n\t\t\t\t\t\t\treturn <li key={index}></li>;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tconst { action, actionSubject, eventType } = event.payload;\n\t\t\t\t\t\treturn (\n\t\t\t\t\t\t\t<li key={index}>\n\t\t\t\t\t\t\t\t<Text\n\t\t\t\t\t\t\t\t\tkey={index}\n\t\t\t\t\t\t\t\t>{`actionSubject: ${actionSubject}, action: ${action}, eventType: ${eventType}`}</Text>\n\t\t\t\t\t\t\t</li>\n\t\t\t\t\t\t);\n\t\t\t\t\t})}\n\t\t\t\t</ol>\n\t\t\t</Box>\n\t\t</Box>\n\t);\n};"]
|
|
334
334
|
}, {
|
|
335
335
|
name: 'useAgentSessions',
|
|
336
336
|
description: 'Reads normalized account-scoped Rovo agent sessions and keeps the Relay result current after lifecycle events.',
|
|
337
337
|
status: 'general-availability',
|
|
338
|
-
usageGuidelines: ['
|
|
338
|
+
usageGuidelines: ['Read inside AgentSessionsScopeProvider and AgentSessionsDataProvider under the host Relay environment. Pass identity only to the scope provider.', 'Render from the ready result and preserve backend session state for product-owned presentation rather than inventing replacement labels.', 'Use the exported types entrypoint for AgentSessionsScope, AgentSessionsResult, and normalized session contracts.'],
|
|
339
339
|
keywords: ['rovo', 'agent sessions', 'relay', 'hooks'],
|
|
340
340
|
category: 'data',
|
|
341
|
-
parameters: [
|
|
342
|
-
name: 'options',
|
|
343
|
-
type: 'AgentSessionsOptions',
|
|
344
|
-
description: 'Account identity plus cloudId or rovoActivationId, with optional pageSize and sort configuration.'
|
|
345
|
-
}],
|
|
341
|
+
parameters: [],
|
|
346
342
|
returns: {
|
|
347
343
|
type: 'AgentSessionsResult',
|
|
348
344
|
description: 'An unavailable result when identity cannot resolve a Rovo workspace, otherwise normalized sessions, pagination, and refetch controls.'
|
|
@@ -352,8 +348,8 @@ export const atlaskitHooks = [{
|
|
|
352
348
|
}, {
|
|
353
349
|
name: 'useChooseObjectExample',
|
|
354
350
|
description: 'Returns object-example selection state for smart-creation prompts.',
|
|
355
|
-
status: '
|
|
356
|
-
usageGuidelines: ['
|
|
351
|
+
status: 'release-candidate',
|
|
352
|
+
usageGuidelines: ['Pass the selected example key and the same examples map used to render the cards. The returned handler inserts that example’s prompt into the editor; it does not submit the prompt.'],
|
|
357
353
|
keywords: ['rovo', 'smart creation', 'object example', 'hook'],
|
|
358
354
|
category: 'rovo',
|
|
359
355
|
returns: {
|
|
@@ -364,8 +360,8 @@ export const atlaskitHooks = [{
|
|
|
364
360
|
}, {
|
|
365
361
|
name: 'useInputHatSelectedAgent',
|
|
366
362
|
description: 'Resolves the selected agent displayed by the refreshed chat input hat.',
|
|
367
|
-
status: '
|
|
368
|
-
usageGuidelines: ['Use
|
|
363
|
+
status: 'release-candidate',
|
|
364
|
+
usageGuidelines: ['Use this hook in the refreshed chat input and pass the active agent and conversation ID from the same chat. It returns no agent when agent selection is disabled or no agent is selected.'],
|
|
369
365
|
keywords: ['rovo', 'chat', 'agent', 'input hat'],
|
|
370
366
|
category: 'rovo',
|
|
371
367
|
returns: {
|
|
@@ -376,8 +372,8 @@ export const atlaskitHooks = [{
|
|
|
376
372
|
}, {
|
|
377
373
|
name: 'usePromptLibraryFilters',
|
|
378
374
|
description: 'Manages prompt-library category, search, and visible prompt filtering.',
|
|
379
|
-
status: '
|
|
380
|
-
usageGuidelines: ['Use when
|
|
375
|
+
status: 'release-candidate',
|
|
376
|
+
usageGuidelines: ['Use this hook when you build your own prompt-library filters. Pass the current prompt cards, render `filteredPromptCards`, and connect the search and filter controls to the returned handlers.'],
|
|
381
377
|
keywords: ['rovo', 'prompt library', 'filter', 'hook'],
|
|
382
378
|
category: 'rovo',
|
|
383
379
|
returns: {
|
|
@@ -407,7 +403,7 @@ export const atlaskitHooks = [{
|
|
|
407
403
|
name: 'useAllAttachmentsStore',
|
|
408
404
|
description: 'Selects all file and external-context attachments for one prompt-input key and exposes attachment actions.',
|
|
409
405
|
status: 'general-availability',
|
|
410
|
-
usageGuidelines: ['
|
|
406
|
+
usageGuidelines: ['Pass the same stable prompt-input key to this selector and its add, update, and remove actions so attachments stay with the right draft.', 'Render the returned file and external-context items in order when the composer presents them as one attachment list.'],
|
|
411
407
|
keywords: ['rovo', 'chat', 'attachments', 'selector'],
|
|
412
408
|
category: 'rovo',
|
|
413
409
|
package: '@atlassian/conversation-assistant-chat-prompt-input',
|
|
@@ -602,11 +598,12 @@ export const atlaskitHooks = [{
|
|
|
602
598
|
name: 'useExternalContextBrowser',
|
|
603
599
|
description: 'Coordinates external context menu items, browser content, and selected prompt contexts.',
|
|
604
600
|
status: 'general-availability',
|
|
605
|
-
usageGuidelines: ['
|
|
601
|
+
usageGuidelines: ['Keep the providers and callbacks in the prompt flow that owns the selected context. Use `currentContexts` when building the prompt and render `currentBrowser` with the menu returned by `getMenuItems`.'],
|
|
606
602
|
keywords: ['rovo', 'chat', 'context', 'browser', 'hook'],
|
|
607
603
|
category: 'rovo',
|
|
608
604
|
returns: {
|
|
609
|
-
type: 'ExternalContextBrowserState'
|
|
605
|
+
type: 'ExternalContextBrowserState',
|
|
606
|
+
description: 'Returns the current browser, selected contexts, and menu-item builder for the supplied context browser configuration.'
|
|
610
607
|
},
|
|
611
608
|
package: '@atlassian/conversation-assistant-external-context',
|
|
612
609
|
examples: []
|
|
@@ -682,6 +679,54 @@ export const atlaskitHooks = [{
|
|
|
682
679
|
},
|
|
683
680
|
package: '@atlassian/conversation-assistant-message-actions',
|
|
684
681
|
examples: []
|
|
682
|
+
}, {
|
|
683
|
+
name: 'useConversationAssistantSpotlightActions',
|
|
684
|
+
description: 'Public hook `useConversationAssistantSpotlightActions` from `@atlassian/conversation-assistant-onboarding/controllers/spotlight`.',
|
|
685
|
+
status: 'general-availability',
|
|
686
|
+
keywords: ['rovo', 'chat', 'ai', 'platform'],
|
|
687
|
+
category: 'rovo',
|
|
688
|
+
package: '@atlassian/conversation-assistant-onboarding',
|
|
689
|
+
examples: []
|
|
690
|
+
}, {
|
|
691
|
+
name: 'useConversationAssistantSpotlightState',
|
|
692
|
+
description: 'Public hook `useConversationAssistantSpotlightState` from `@atlassian/conversation-assistant-onboarding/controllers/spotlight`.',
|
|
693
|
+
status: 'general-availability',
|
|
694
|
+
keywords: ['rovo', 'chat', 'ai', 'platform'],
|
|
695
|
+
category: 'rovo',
|
|
696
|
+
package: '@atlassian/conversation-assistant-onboarding',
|
|
697
|
+
examples: []
|
|
698
|
+
}, {
|
|
699
|
+
name: 'useGettingStartedTourState',
|
|
700
|
+
description: 'Public hook `useGettingStartedTourState` from `@atlassian/conversation-assistant-onboarding/controllers/getting-started-tour`.',
|
|
701
|
+
status: 'general-availability',
|
|
702
|
+
keywords: ['rovo', 'chat', 'ai', 'platform'],
|
|
703
|
+
category: 'rovo',
|
|
704
|
+
package: '@atlassian/conversation-assistant-onboarding',
|
|
705
|
+
examples: []
|
|
706
|
+
}, {
|
|
707
|
+
name: 'useGettingStartedTourStore',
|
|
708
|
+
description: 'Public hook `useGettingStartedTourStore` from `@atlassian/conversation-assistant-onboarding/controllers/getting-started-tour`.',
|
|
709
|
+
status: 'general-availability',
|
|
710
|
+
keywords: ['rovo', 'chat', 'ai', 'platform'],
|
|
711
|
+
category: 'rovo',
|
|
712
|
+
package: '@atlassian/conversation-assistant-onboarding',
|
|
713
|
+
examples: []
|
|
714
|
+
}, {
|
|
715
|
+
name: 'useGettingStartedTourStoreActions',
|
|
716
|
+
description: 'Public hook `useGettingStartedTourStoreActions` from `@atlassian/conversation-assistant-onboarding/controllers/getting-started-tour`.',
|
|
717
|
+
status: 'general-availability',
|
|
718
|
+
keywords: ['rovo', 'chat', 'ai', 'platform'],
|
|
719
|
+
category: 'rovo',
|
|
720
|
+
package: '@atlassian/conversation-assistant-onboarding',
|
|
721
|
+
examples: []
|
|
722
|
+
}, {
|
|
723
|
+
name: 'usePostOfficeCoordination',
|
|
724
|
+
description: 'Public hook `usePostOfficeCoordination` from `@atlassian/conversation-assistant-onboarding/controllers/post-office-migration`.',
|
|
725
|
+
status: 'general-availability',
|
|
726
|
+
keywords: ['rovo', 'chat', 'ai', 'platform'],
|
|
727
|
+
category: 'rovo',
|
|
728
|
+
package: '@atlassian/conversation-assistant-onboarding',
|
|
729
|
+
examples: []
|
|
685
730
|
}, {
|
|
686
731
|
name: 'useProductData',
|
|
687
732
|
description: 'Public useProductData entrypoint for @atlassian/conversation-assistant-preview-card.',
|
|
@@ -802,6 +847,14 @@ export const atlaskitHooks = [{
|
|
|
802
847
|
},
|
|
803
848
|
package: '@atlassian/conversation-assistant-ui-components',
|
|
804
849
|
examples: []
|
|
850
|
+
}, {
|
|
851
|
+
name: 'useChartApiService',
|
|
852
|
+
description: 'Public hook `useChartApiService` from `@atlassian/conversation-assistant-viz/services/chart-api-service`.',
|
|
853
|
+
status: 'general-availability',
|
|
854
|
+
keywords: ['rovo', 'chat', 'ai', 'platform'],
|
|
855
|
+
category: 'rovo',
|
|
856
|
+
package: '@atlassian/conversation-assistant-viz',
|
|
857
|
+
examples: []
|
|
805
858
|
}, {
|
|
806
859
|
name: 'useAutoApplyAvailability',
|
|
807
860
|
description: 'Determines whether auto-apply is available for the current product and conversation context.',
|
|
@@ -815,7 +868,7 @@ export const atlaskitHooks = [{
|
|
|
815
868
|
name: 'useAutoApplyState',
|
|
816
869
|
description: 'Reads and updates the auto-apply preference with backend persistence and a local-storage fallback.',
|
|
817
870
|
status: 'general-availability',
|
|
818
|
-
usageGuidelines: ['
|
|
871
|
+
usageGuidelines: ['Treat the returned state as the last successfully loaded or saved preference. A failed update leaves it unchanged.', 'Show a save error with a retry option when an update fails.'],
|
|
819
872
|
keywords: ['rovo', 'creation', 'auto apply', 'state'],
|
|
820
873
|
category: 'rovo',
|
|
821
874
|
package: '@atlassian/creation-settings',
|
|
@@ -842,7 +895,7 @@ export const atlaskitHooks = [{
|
|
|
842
895
|
name: 'useAiCreateProjectContext',
|
|
843
896
|
description: 'Resolves Jira project context for an AI-assisted creation flow.',
|
|
844
897
|
status: 'general-availability',
|
|
845
|
-
usageGuidelines: ['
|
|
898
|
+
usageGuidelines: ['Render within the app Relay provider. Pass the project fragment, Jira actions, and messageId for this group of drafts.', 'Wait for isStoreReady before reading the initialized drafts. Wait for isHydrationDone before treating user-picker values as fully loaded.'],
|
|
846
899
|
keywords: ['rovo', 'jira', 'project', 'context'],
|
|
847
900
|
category: 'rovo',
|
|
848
901
|
returns: {
|
|
@@ -854,7 +907,7 @@ export const atlaskitHooks = [{
|
|
|
854
907
|
name: 'useAifcAnalytics',
|
|
855
908
|
description: 'Returns analytics helpers for AI-assisted Jira work-item creation.',
|
|
856
909
|
status: 'general-availability',
|
|
857
|
-
usageGuidelines: ['
|
|
910
|
+
usageGuidelines: ['Pass the messageId for the AI-assisted creation flow. The hook adds it to each analytics event; the analytics integration supplies the conversation context.', 'Add attributes specific to the event without repeating the message or conversation IDs.'],
|
|
858
911
|
keywords: ['rovo', 'jira', 'creation', 'analytics'],
|
|
859
912
|
category: 'rovo',
|
|
860
913
|
returns: {
|
|
@@ -866,7 +919,7 @@ export const atlaskitHooks = [{
|
|
|
866
919
|
name: 'useAreAllCreated',
|
|
867
920
|
description: 'Reports whether every draft work item for a message has been created.',
|
|
868
921
|
status: 'general-availability',
|
|
869
|
-
usageGuidelines: ['
|
|
922
|
+
usageGuidelines: ['Pass the messageId used for this group of drafts. The hook returns false before initialization and ignores dismissed drafts when checking whether all items were created.', 'Handle the submission result separately: this value describes draft state and does not prove that a non-empty creation request succeeded.'],
|
|
870
923
|
keywords: ['rovo', 'jira', 'draft work item', 'created'],
|
|
871
924
|
category: 'rovo',
|
|
872
925
|
returns: {
|
|
@@ -878,7 +931,7 @@ export const atlaskitHooks = [{
|
|
|
878
931
|
name: 'useAreAllDismissed',
|
|
879
932
|
description: 'Reports whether every draft work item for a message has been dismissed.',
|
|
880
933
|
status: 'general-availability',
|
|
881
|
-
usageGuidelines: ['
|
|
934
|
+
usageGuidelines: ['Pass the messageId for the draft group being shown; the hook returns false before initialization and becomes true only when every stored draft is dismissed.', 'Keep the empty-state decision separate if a message can start with no drafts, so “nothing to dismiss” is not described as “dismissed”.'],
|
|
882
935
|
keywords: ['rovo', 'jira', 'draft work item', 'dismissed'],
|
|
883
936
|
category: 'rovo',
|
|
884
937
|
returns: {
|
|
@@ -890,7 +943,7 @@ export const atlaskitHooks = [{
|
|
|
890
943
|
name: 'useCreateDraftWorkItems',
|
|
891
944
|
description: 'Creates eligible Jira draft work items and exposes action callbacks.',
|
|
892
945
|
status: 'general-availability',
|
|
893
|
-
usageGuidelines: ['
|
|
946
|
+
usageGuidelines: ['Pass the latest reviewed drafts to the returned callback when the person submits. It checks required fields and removes fields not recognized by the project configuration.', 'Handle onSuccess and onError to update the app. Awaiting the callback is not enough to confirm success; validation and creation failures are reported through those handlers.'],
|
|
894
947
|
keywords: ['rovo', 'jira', 'draft work item', 'create'],
|
|
895
948
|
category: 'rovo',
|
|
896
949
|
returns: {
|
|
@@ -902,7 +955,7 @@ export const atlaskitHooks = [{
|
|
|
902
955
|
name: 'useCreateIssuesSuccessFlags',
|
|
903
956
|
description: 'Returns the success-flag action used after Jira work items are created.',
|
|
904
957
|
status: 'general-availability',
|
|
905
|
-
usageGuidelines: ['
|
|
958
|
+
usageGuidelines: ['Call after creation succeeds. Pass the created Jira issue keys and site URL so View and Copy point to the right site.', 'Show creation failures separately from this success notice.'],
|
|
906
959
|
keywords: ['rovo', 'jira', 'create', 'flag'],
|
|
907
960
|
category: 'rovo',
|
|
908
961
|
returns: {
|
|
@@ -914,7 +967,7 @@ export const atlaskitHooks = [{
|
|
|
914
967
|
name: 'useDraftWorkItems',
|
|
915
968
|
description: 'Returns the current draft work items and their controller state.',
|
|
916
969
|
status: 'general-availability',
|
|
917
|
-
usageGuidelines: ['
|
|
970
|
+
usageGuidelines: ['Read draft records from the draft-work-items store. This hook supplies update handlers; use the same messageId when reading and changing the drafts.', 'Use onFieldChange for edits, removeWorkItem for one draft, and onDismissAllDraftWorkItems for the group. Pass cloudId and conversationId to save edits to the conversation.'],
|
|
918
971
|
keywords: ['rovo', 'jira', 'draft work item', 'hook'],
|
|
919
972
|
category: 'rovo',
|
|
920
973
|
returns: {
|
|
@@ -926,7 +979,7 @@ export const atlaskitHooks = [{
|
|
|
926
979
|
name: 'useGetActiveOrFinishedDraftWorkItemsCount',
|
|
927
980
|
description: 'Returns the number of active or completed draft work items for a message.',
|
|
928
981
|
status: 'general-availability',
|
|
929
|
-
usageGuidelines: ['
|
|
982
|
+
usageGuidelines: ['Pass the same messageId as the draft list to count records for that message.', 'Use useGetDraftWorkItemsToCreate to find the items that can still be created; this count includes other draft states.'],
|
|
930
983
|
keywords: ['rovo', 'jira', 'draft work item', 'count'],
|
|
931
984
|
category: 'rovo',
|
|
932
985
|
returns: {
|
|
@@ -938,7 +991,7 @@ export const atlaskitHooks = [{
|
|
|
938
991
|
name: 'useGetActivePlannedChildInvocationIdsByParent',
|
|
939
992
|
description: 'Groups active planned child invocation identifiers by parent work item.',
|
|
940
993
|
status: 'general-availability',
|
|
941
|
-
usageGuidelines: ['Use
|
|
994
|
+
usageGuidelines: ['Use the map to show which children are still planned beneath each parent; a missing parent key means there are no planned children to report.', 'This map includes planned child invocation IDs only, so do not use it as the full child count or as a signal that creation has finished.'],
|
|
942
995
|
keywords: ['rovo', 'jira', 'draft work item', 'invocation'],
|
|
943
996
|
category: 'rovo',
|
|
944
997
|
returns: {
|
|
@@ -950,7 +1003,7 @@ export const atlaskitHooks = [{
|
|
|
950
1003
|
name: 'useGetDraftWorkItemsToCreate',
|
|
951
1004
|
description: 'Returns the draft work items currently eligible for creation.',
|
|
952
1005
|
status: 'general-availability',
|
|
953
|
-
usageGuidelines: ['
|
|
1006
|
+
usageGuidelines: ['Read this immediately before submission so edits, dismissals, completed items, and parent-child relationships are current.', 'Submit each returned parent with its childWorkItems; do not flatten the tree or add nested children to the top-level payload a second time.'],
|
|
954
1007
|
keywords: ['rovo', 'jira', 'draft work item', 'create'],
|
|
955
1008
|
category: 'rovo',
|
|
956
1009
|
returns: {
|
|
@@ -962,7 +1015,7 @@ export const atlaskitHooks = [{
|
|
|
962
1015
|
name: 'useGetDraftWorkItemsWithHierarchy',
|
|
963
1016
|
description: 'Returns draft work items with their calculated parent-child hierarchy.',
|
|
964
1017
|
status: 'general-availability',
|
|
965
|
-
usageGuidelines: ['Use
|
|
1018
|
+
usageGuidelines: ['Render the returned top-level drafts and their childWorkItems as a tree; do not also render the children as separate top-level rows.', 'Use the same messageId for the draft editor and its updates so the hierarchy reflects the current message rather than another conversation response.'],
|
|
966
1019
|
keywords: ['rovo', 'jira', 'draft work item', 'hierarchy'],
|
|
967
1020
|
category: 'rovo',
|
|
968
1021
|
returns: {
|
|
@@ -974,7 +1027,7 @@ export const atlaskitHooks = [{
|
|
|
974
1027
|
name: 'useHasAppliedDraftEdits',
|
|
975
1028
|
description: 'Reports whether edits have been applied to message-scoped draft work items.',
|
|
976
1029
|
status: 'general-availability',
|
|
977
|
-
usageGuidelines: ['Use to
|
|
1030
|
+
usageGuidelines: ['Use this flag for the message to preserve or label edits when new suggestions arrive.', 'Track edits to all fields, not just changes to the visible summary.'],
|
|
978
1031
|
keywords: ['rovo', 'jira', 'draft work item', 'edits'],
|
|
979
1032
|
category: 'rovo',
|
|
980
1033
|
returns: {
|
|
@@ -986,7 +1039,7 @@ export const atlaskitHooks = [{
|
|
|
986
1039
|
name: 'useRovoBridgeAPI',
|
|
987
1040
|
description: 'Connects Jira draft-work-item creation to the Rovo bridge API.',
|
|
988
1041
|
status: 'general-availability',
|
|
989
|
-
usageGuidelines: ['Use
|
|
1042
|
+
usageGuidelines: ['Use once within the configured content-bridge client, passing its clientId and setupHandler. The hook connects the app to Rovo and disconnects on unmount or page exit.', 'Let this hook manage setup and cleanup instead of calling ready or teardown separately.'],
|
|
990
1043
|
keywords: ['rovo', 'jira', 'bridge', 'api'],
|
|
991
1044
|
category: 'rovo',
|
|
992
1045
|
returns: {
|
|
@@ -998,7 +1051,7 @@ export const atlaskitHooks = [{
|
|
|
998
1051
|
name: 'useValidateIssuesToCreate',
|
|
999
1052
|
description: 'Validates Jira draft work items before they are submitted for creation.',
|
|
1000
1053
|
status: 'general-availability',
|
|
1001
|
-
usageGuidelines: ['
|
|
1054
|
+
usageGuidelines: ['Validate the current draft list before enabling creation; a result with success false contains a user-facing validation error, while undefined means project field configuration was unavailable.', 'Use the returned validated drafts for submission, since the hook removes fields that are not part of the selected Jira issue-type configuration.'],
|
|
1002
1055
|
keywords: ['rovo', 'jira', 'draft work item', 'validation'],
|
|
1003
1056
|
category: 'rovo',
|
|
1004
1057
|
returns: {
|
|
@@ -1246,11 +1299,19 @@ export const atlaskitHooks = [{
|
|
|
1246
1299
|
category: 'rovo',
|
|
1247
1300
|
package: '@atlassian/rovo-conversation-actions',
|
|
1248
1301
|
examples: []
|
|
1302
|
+
}, {
|
|
1303
|
+
name: 'useCaseOptions',
|
|
1304
|
+
description: 'Public hook `useCaseOptions` from `@atlassian/rovo-conversation-actions/prompt-cards`.',
|
|
1305
|
+
status: 'general-availability',
|
|
1306
|
+
keywords: ['rovo', 'chat', 'ai', 'platform'],
|
|
1307
|
+
category: 'rovo',
|
|
1308
|
+
package: '@atlassian/rovo-conversation-actions',
|
|
1309
|
+
examples: ["import React, { useState } from 'react';\nimport { IntlProvider } from 'react-intl';\nimport { Stack } from '@atlaskit/primitives/compiled/stack';\nimport { Text } from '@atlaskit/primitives/compiled/text';\nimport type { PromptCard } from '@atlassian/rovo-conversation-actions/prompt-cards';\nimport { PromptCardsGrid } from '@atlassian/rovo-conversation-actions/prompt-cards-grid';\nconst cards: PromptCard[] = [\n\t{\n\t\tid: 'draft-release-notes',\n\t\ttitle: 'Draft release notes',\n\t\tprompt: 'Draft customer-ready release notes from this week’s completed work.',\n\t\tuseCase: 'Create',\n\t},\n\t{\n\t\tid: 'review-project-risks',\n\t\ttitle: 'Review project risks',\n\t\tprompt: 'Identify risks, owners, and mitigations for this project update.',\n\t\tuseCase: 'Review',\n\t},\n];\nexport default function PromptLibraryGridExample(): React.JSX.Element {\n\tconst [selectedPrompt, setSelectedPrompt] = useState<string>();\n\treturn (\n\t\t<IntlProvider locale=\"en\">\n\t\t\t<Stack space=\"space.150\">\n\t\t\t\t<PromptCardsGrid cards={cards} onCardClick={(card) => setSelectedPrompt(card.title)} />\n\t\t\t\t{selectedPrompt ? <Text>Selected: {selectedPrompt}</Text> : null}\n\t\t\t</Stack>\n\t\t</IntlProvider>\n\t);\n}"]
|
|
1249
1310
|
}, {
|
|
1250
1311
|
name: 'useConversationActionsStore',
|
|
1251
1312
|
description: 'Reads selected Rovo conversation-action store state and actions.',
|
|
1252
1313
|
status: 'general-availability',
|
|
1253
|
-
usageGuidelines: ['Use
|
|
1314
|
+
usageGuidelines: ['Use this combined hook only when the component both reads and updates the action store; use the state-only or actions-only hook when it needs just one side.', 'A store update can rerender this component, so keep it close to the controls that need the state rather than high in the chat tree.'],
|
|
1254
1315
|
keywords: ['rovo', 'conversation actions', 'store', 'hook'],
|
|
1255
1316
|
category: 'rovo',
|
|
1256
1317
|
returns: {
|
|
@@ -1262,7 +1323,7 @@ export const atlaskitHooks = [{
|
|
|
1262
1323
|
name: 'useConversationActionsStoreActions',
|
|
1263
1324
|
description: 'Returns the mutation actions for the Rovo conversation-action store.',
|
|
1264
1325
|
status: 'general-availability',
|
|
1265
|
-
usageGuidelines: ['Use
|
|
1326
|
+
usageGuidelines: ['Use for components that only dispatch store updates so they do not subscribe to every action-state change.', 'Use the conversation-assistant setActiveAction flow for active-action changes; do not call setActiveAction_UNSAFE from a new consumer.'],
|
|
1266
1327
|
keywords: ['rovo', 'conversation actions', 'store', 'actions'],
|
|
1267
1328
|
category: 'rovo',
|
|
1268
1329
|
returns: {
|
|
@@ -1274,7 +1335,7 @@ export const atlaskitHooks = [{
|
|
|
1274
1335
|
name: 'useConversationActionsStoreState',
|
|
1275
1336
|
description: 'Returns the current Rovo conversation-action store state.',
|
|
1276
1337
|
status: 'general-availability',
|
|
1277
|
-
usageGuidelines: ['Use
|
|
1338
|
+
usageGuidelines: ['Use to read store values without updating them. Make changes through the actions hook or an app event handler.', 'Use a selector for a single value when possible so unrelated store changes do not rerender the component.'],
|
|
1278
1339
|
keywords: ['rovo', 'conversation actions', 'store', 'state'],
|
|
1279
1340
|
category: 'rovo',
|
|
1280
1341
|
returns: {
|
|
@@ -1291,15 +1352,6 @@ export const atlaskitHooks = [{
|
|
|
1291
1352
|
category: 'rovo',
|
|
1292
1353
|
package: '@atlassian/rovo-conversation-actions',
|
|
1293
1354
|
examples: []
|
|
1294
|
-
}, {
|
|
1295
|
-
name: 'useCreatePromptInitialData',
|
|
1296
|
-
description: 'Builds initial create-prompt form data for edit and duplicate flows.',
|
|
1297
|
-
status: 'general-availability',
|
|
1298
|
-
usageGuidelines: ['Pass only one source card; duplicate mode prefixes the copied title.'],
|
|
1299
|
-
keywords: ['rovo', 'prompts', 'initial data', 'hook'],
|
|
1300
|
-
category: 'rovo',
|
|
1301
|
-
package: '@atlassian/rovo-conversation-actions',
|
|
1302
|
-
examples: []
|
|
1303
1355
|
}, {
|
|
1304
1356
|
name: 'usePageContextType',
|
|
1305
1357
|
description: 'Tracks browser navigation and returns the current Rovo page context.',
|
|
@@ -1309,11 +1361,19 @@ export const atlaskitHooks = [{
|
|
|
1309
1361
|
category: 'rovo',
|
|
1310
1362
|
package: '@atlassian/rovo-conversation-actions',
|
|
1311
1363
|
examples: []
|
|
1364
|
+
}, {
|
|
1365
|
+
name: 'usePromptCards',
|
|
1366
|
+
description: 'Public hook `usePromptCards` from `@atlassian/rovo-conversation-actions/prompt-cards`.',
|
|
1367
|
+
status: 'general-availability',
|
|
1368
|
+
keywords: ['rovo', 'chat', 'ai', 'platform'],
|
|
1369
|
+
category: 'rovo',
|
|
1370
|
+
package: '@atlassian/rovo-conversation-actions',
|
|
1371
|
+
examples: ["import React, { useState } from 'react';\nimport { IntlProvider } from 'react-intl';\nimport { Stack } from '@atlaskit/primitives/compiled/stack';\nimport { Text } from '@atlaskit/primitives/compiled/text';\nimport type { PromptCard } from '@atlassian/rovo-conversation-actions/prompt-cards';\nimport { PromptCardsGrid } from '@atlassian/rovo-conversation-actions/prompt-cards-grid';\nconst cards: PromptCard[] = [\n\t{\n\t\tid: 'draft-release-notes',\n\t\ttitle: 'Draft release notes',\n\t\tprompt: 'Draft customer-ready release notes from this week’s completed work.',\n\t\tuseCase: 'Create',\n\t},\n\t{\n\t\tid: 'review-project-risks',\n\t\ttitle: 'Review project risks',\n\t\tprompt: 'Identify risks, owners, and mitigations for this project update.',\n\t\tuseCase: 'Review',\n\t},\n];\nexport default function PromptLibraryGridExample(): React.JSX.Element {\n\tconst [selectedPrompt, setSelectedPrompt] = useState<string>();\n\treturn (\n\t\t<IntlProvider locale=\"en\">\n\t\t\t<Stack space=\"space.150\">\n\t\t\t\t<PromptCardsGrid cards={cards} onCardClick={(card) => setSelectedPrompt(card.title)} />\n\t\t\t\t{selectedPrompt ? <Text>Selected: {selectedPrompt}</Text> : null}\n\t\t\t</Stack>\n\t\t</IntlProvider>\n\t);\n}"]
|
|
1312
1372
|
}, {
|
|
1313
1373
|
name: 'usePromptCards',
|
|
1314
1374
|
description: 'Returns the prompt cards and prompt-library loading state available to the user.',
|
|
1315
1375
|
status: 'general-availability',
|
|
1316
|
-
usageGuidelines: ['Use
|
|
1376
|
+
usageGuidelines: ['Use to arrange the built-in prompt cards in your own layout, or pass the cards to PromptCardsGrid for the standard grid.', 'Provide the skill metadata for the current site before rendering; it determines which skill cards are available.'],
|
|
1317
1377
|
keywords: ['rovo', 'prompts', 'cards', 'hook'],
|
|
1318
1378
|
category: 'rovo',
|
|
1319
1379
|
returns: {
|
|
@@ -1325,7 +1385,7 @@ export const atlaskitHooks = [{
|
|
|
1325
1385
|
name: 'useRovoConversationStarters',
|
|
1326
1386
|
description: 'Selects Rovo conversation starters for the current page and product context.',
|
|
1327
1387
|
status: 'general-availability',
|
|
1328
|
-
usageGuidelines: ['
|
|
1388
|
+
usageGuidelines: ['Pass the current product and page details to choose relevant starters. Supply dynamicStartersConfig and assistanceServiceParams when the app supports fetched suggestions.', 'Show loading while suggestions are fetched. Choose whether selection fills the prompt editor or submits the prompt.'],
|
|
1329
1389
|
keywords: ['rovo', 'conversation starters', 'context', 'hook'],
|
|
1330
1390
|
category: 'rovo',
|
|
1331
1391
|
returns: {
|
|
@@ -1337,7 +1397,7 @@ export const atlaskitHooks = [{
|
|
|
1337
1397
|
name: 'useWindowLocation',
|
|
1338
1398
|
description: 'Tracks browser history navigation and returns the full URL or pathname.',
|
|
1339
1399
|
status: 'general-availability',
|
|
1340
|
-
usageGuidelines: ['Use pathname mode
|
|
1400
|
+
usageGuidelines: ['Use pathname mode to follow page routes only. The default follows the whole URL, including query strings and fragments.', 'Use WindowLocationContext in tests or embedded views that should follow an app-supplied location instead of the browser URL.'],
|
|
1341
1401
|
keywords: ['rovo', 'browser', 'location', 'hook'],
|
|
1342
1402
|
category: 'rovo',
|
|
1343
1403
|
package: '@atlassian/rovo-conversation-actions',
|
|
@@ -1391,7 +1451,7 @@ export const atlaskitHooks = [{
|
|
|
1391
1451
|
name: 'useForYouNavigation',
|
|
1392
1452
|
description: 'Returns the combined Rovo For You navigation state and actions.',
|
|
1393
1453
|
status: 'general-availability',
|
|
1394
|
-
usageGuidelines: [
|
|
1454
|
+
usageGuidelines: [],
|
|
1395
1455
|
keywords: ['rovo', 'for you', 'navigation', 'hook'],
|
|
1396
1456
|
category: 'rovo',
|
|
1397
1457
|
returns: {
|
|
@@ -1401,9 +1461,9 @@ export const atlaskitHooks = [{
|
|
|
1401
1461
|
examples: []
|
|
1402
1462
|
}, {
|
|
1403
1463
|
name: 'useForYouNavigationActions',
|
|
1404
|
-
description: 'Returns
|
|
1464
|
+
description: 'Returns the reset action for Rovo For You navigation. The action is currently a no-op because only the threads-list view exists.',
|
|
1405
1465
|
status: 'general-availability',
|
|
1406
|
-
usageGuidelines: [
|
|
1466
|
+
usageGuidelines: [],
|
|
1407
1467
|
keywords: ['rovo', 'for you', 'navigation', 'actions'],
|
|
1408
1468
|
category: 'rovo',
|
|
1409
1469
|
returns: {
|
|
@@ -1415,19 +1475,19 @@ export const atlaskitHooks = [{
|
|
|
1415
1475
|
name: 'useForYouNavigationState',
|
|
1416
1476
|
description: 'Reads the current Rovo For You navigation state.',
|
|
1417
1477
|
status: 'general-availability',
|
|
1418
|
-
usageGuidelines: [
|
|
1478
|
+
usageGuidelines: [],
|
|
1419
1479
|
keywords: ['rovo', 'for you', 'navigation', 'state'],
|
|
1420
1480
|
category: 'rovo',
|
|
1421
1481
|
returns: {
|
|
1422
1482
|
type: 'ForYouNavigationState'
|
|
1423
1483
|
},
|
|
1424
1484
|
package: '@atlassian/rovo-for-you',
|
|
1425
|
-
examples: []
|
|
1485
|
+
examples: ["import { Box } from '@atlaskit/primitives/compiled/box';\nimport { Text } from '@atlaskit/primitives/compiled/text';\nimport {\n\tForYouNavigationProvider,\n\tuseForYouNavigationState,\n} from '@atlassian/rovo-for-you/navigation-store';\nexport default function ForYouNavigationProviderExample(): React.JSX.Element {\n\treturn (\n\t\t<ForYouNavigationProvider>\n\t\t\t<CurrentForYouView />\n\t\t</ForYouNavigationProvider>\n\t);\n}\nfunction CurrentForYouView(): React.JSX.Element {\n\tconst { currentView } = useForYouNavigationState();\n\treturn (\n\t\t<Box padding=\"space.200\">\n\t\t\t<Text>Current view: {currentView.type}</Text>\n\t\t</Box>\n\t);\n}"]
|
|
1426
1486
|
}, {
|
|
1427
1487
|
name: 'useFireInsightCardClicked',
|
|
1428
1488
|
description: 'Returns portable analytics for Rovo Insight card clicks outside the feed lifecycle.',
|
|
1429
1489
|
status: 'general-availability',
|
|
1430
|
-
usageGuidelines: ['Use
|
|
1490
|
+
usageGuidelines: ['Use to record clicks on insight cards outside InsightsFeed, such as a home carousel. Record the click only once when the feed already handles it.'],
|
|
1431
1491
|
keywords: ['rovo', 'insights', 'card', 'analytics'],
|
|
1432
1492
|
category: 'rovo',
|
|
1433
1493
|
returns: {
|
|
@@ -1451,7 +1511,7 @@ export const atlaskitHooks = [{
|
|
|
1451
1511
|
name: 'useInsightsFeed',
|
|
1452
1512
|
description: 'Loads and maps Rovo Insights data into feed-ready state.',
|
|
1453
1513
|
status: 'general-availability',
|
|
1454
|
-
usageGuidelines: ['Use
|
|
1514
|
+
usageGuidelines: ['Use to build a custom feed instead of InsightsFeed. Handle loading, errors, and retries, and navigate from the app when an insight is selected.'],
|
|
1455
1515
|
keywords: ['rovo', 'insights', 'feed', 'data'],
|
|
1456
1516
|
category: 'rovo',
|
|
1457
1517
|
returns: {
|
|
@@ -1463,7 +1523,7 @@ export const atlaskitHooks = [{
|
|
|
1463
1523
|
name: 'useInsightsStatus',
|
|
1464
1524
|
description: 'Loads the current availability and freshness status for Rovo Insights.',
|
|
1465
1525
|
status: 'general-availability',
|
|
1466
|
-
usageGuidelines: ['
|
|
1526
|
+
usageGuidelines: ['Enable the request only on pages where Insights are available. Check availability and freshness before showing a link that requires recent content; missing or invalid generation dates count as stale.'],
|
|
1467
1527
|
keywords: ['rovo', 'insights', 'status', 'availability'],
|
|
1468
1528
|
category: 'rovo',
|
|
1469
1529
|
returns: {
|
|
@@ -1475,7 +1535,7 @@ export const atlaskitHooks = [{
|
|
|
1475
1535
|
name: 'useReportInsightsBannerResolved',
|
|
1476
1536
|
description: 'Resolves banner visibility and reports the decision once per mount.',
|
|
1477
1537
|
status: 'general-availability',
|
|
1478
|
-
usageGuidelines: ['
|
|
1538
|
+
usageGuidelines: ['Pass the same visibility values used to decide whether the banner is shown. The hook reports the outcome once per mount; use one instance for that banner.'],
|
|
1479
1539
|
keywords: ['rovo', 'insights', 'banner', 'analytics'],
|
|
1480
1540
|
category: 'rovo',
|
|
1481
1541
|
returns: {
|
|
@@ -1507,6 +1567,14 @@ export const atlaskitHooks = [{
|
|
|
1507
1567
|
},
|
|
1508
1568
|
package: '@atlassian/rovo-personalization',
|
|
1509
1569
|
examples: []
|
|
1570
|
+
}, {
|
|
1571
|
+
name: 'usePinnedItems',
|
|
1572
|
+
description: 'Public hook `usePinnedItems` from `@atlassian/rovo-pins/store`.',
|
|
1573
|
+
status: 'general-availability',
|
|
1574
|
+
keywords: ['rovo', 'chat', 'ai', 'platform'],
|
|
1575
|
+
category: 'rovo',
|
|
1576
|
+
package: '@atlassian/rovo-pins',
|
|
1577
|
+
examples: ["/**\n * Example: PinnedWorkSection with pinned items.\n *\n * Demos the \"Your team's work\" heading, \"+\" button, and item list shown once at least one\n * epic, project, or goal is pinned. See `01-pinned-work-section.tsx` for the empty-state\n * demo shown before anything is pinned. The last row has a deliberately long title —\n * hovering it shows a tooltip with the full text once it overflows.\n */\nimport React, { useEffect } from 'react';\nimport { IntlProvider } from 'react-intl';\nimport { cssMap } from '@atlaskit/css';\nimport { Box } from '@atlaskit/primitives/compiled/box';\nimport { token } from '@atlaskit/tokens';\nimport { usePinnedItems } from '../src/services/pinned-items-store';\nimport type { SearchWorkItem } from '../src/types';\nimport { PinnedWorkSection } from '../src/ui/pinned-work-section/PinnedWorkSection';\nconst EXAMPLE_CLOUD_ID = 'example-cloud-id';\nconst EXAMPLE_PRODUCT = 'jira';\nconst MOCK_ITEMS: SearchWorkItem[] = [\n\t{\n\t\tari: 'ari:cloud:jira:site/1:epic/1',\n\t\turl: 'https://example.atlassian.net/browse/EPIC-1',\n\t\tpinType: 'JiraIssue',\n\t\tname: 'Your Work tab: Pin objects',\n\t},\n\t{\n\t\tari: 'ari:cloud:jira:site/1:project/1',\n\t\turl: 'https://example.atlassian.net/jira/projects/1',\n\t\tpinType: 'AtlasProject',\n\t\tname: 'Rovo For You',\n\t},\n\t{\n\t\tari: 'ari:cloud:jira:site/1:goal/1',\n\t\turl: 'https://example.atlassian.net/goals/1',\n\t\tpinType: 'AtlasGoal',\n\t\tname: 'Grow Rovo weekly active users',\n\t},\n\t{\n\t\tari: 'ari:cloud:jira:site/1:epic/2',\n\t\turl: 'https://example.atlassian.net/browse/EPIC-2',\n\t\tpinType: 'JiraIssue',\n\t\tname: 'A deliberately very long epic title used to demo single-line overflow clipping',\n\t},\n];\nconst styles = cssMap({\n\twrapper: {\n\t\twidth: '360px',\n\t\tpaddingTop: token('space.300'),\n\t\tpaddingRight: token('space.200'),\n\t\tpaddingBottom: token('space.300'),\n\t\tpaddingLeft: token('space.200'),\n\t},\n});\n/**\n * Pins the mock items once on mount via the real `pin()` action, then renders its children.\n * `usePinnedItems` now calls the real create endpoint, so this demo only shows the populated\n * state when previewed against a live backend for `EXAMPLE_CLOUD_ID` — same `cloudId` as\n * `PinnedWorkSection` below, so both share the same `useQuery` cache entry.\n */\nconst PinMockItemsOnMount = ({ children }: { children: React.ReactNode }): React.JSX.Element => {\n\tconst { pin } = usePinnedItems({ cloudId: EXAMPLE_CLOUD_ID, product: EXAMPLE_PRODUCT });\n\tuseEffect(() => {\n\t\t// pin() prepends each item, so pin in reverse to render top-to-bottom in\n\t\t// MOCK_ITEMS' declared order — matching 02-pinned-item-row.tsx.\n\t\t[...MOCK_ITEMS].reverse().forEach((item) => {\n\t\t\tpin(item);\n\t\t});\n\t\t// Intentionally run once on mount only — MOCK_ITEMS is a static, module-level constant.\n\t}, []);\n\treturn <>{children}</>;\n};\nexport default function PinnedWorkSectionWithItemsExample(): React.JSX.Element {\n\treturn (\n\t\t<IntlProvider locale=\"en\">\n\t\t\t<PinMockItemsOnMount>\n\t\t\t\t<Box xcss={styles.wrapper}>\n\t\t\t\t\t<PinnedWorkSection\n\t\t\t\t\t\tcloudId={EXAMPLE_CLOUD_ID}\n\t\t\t\t\t\tproduct={EXAMPLE_PRODUCT}\n\t\t\t\t\t\tonPinWorkClick={() => {}}\n\t\t\t\t\t\tonStartChat={() => {}}\n\t\t\t\t\t/>\n\t\t\t\t</Box>\n\t\t\t</PinMockItemsOnMount>\n\t\t</IntlProvider>\n\t);\n}"]
|
|
1510
1578
|
}, {
|
|
1511
1579
|
name: 'useInfiniteScroll',
|
|
1512
1580
|
description: 'Coordinates loading more inline-browse results when a scroll sentinel enters view.',
|
|
@@ -1540,11 +1608,20 @@ export const atlaskitHooks = [{
|
|
|
1540
1608
|
category: 'rovo',
|
|
1541
1609
|
package: '@atlassian/rovo-prompt-of-the-day',
|
|
1542
1610
|
examples: []
|
|
1611
|
+
}, {
|
|
1612
|
+
name: 'usePromptOfTheDayWithFallback',
|
|
1613
|
+
description: 'Reads the same shared suggestions, keeps showing the last stored ones while new ones load or if that request fails, and can remove a used suggestion.',
|
|
1614
|
+
status: 'general-availability',
|
|
1615
|
+
usageGuidelines: ['Use when an empty surface is worse than yesterday’s suggestions; status is stale when a refresh failed.', 'maxAgeMs can only keep an entry past its expiry; a value shorter than the time left to expiry has no effect.', 'Call removePrompt once a suggestion is used, so no surface offers it again before the entry regenerates.'],
|
|
1616
|
+
keywords: ['rovo', 'prompt of the day', 'suggestions', 'cache', 'fallback', 'stale'],
|
|
1617
|
+
category: 'rovo',
|
|
1618
|
+
package: '@atlassian/rovo-prompt-of-the-day',
|
|
1619
|
+
examples: []
|
|
1543
1620
|
}, {
|
|
1544
1621
|
name: 'useIsRovoSettingsModalProviderMounted',
|
|
1545
1622
|
description: 'Reports whether a Rovo settings modal provider is mounted above the caller.',
|
|
1546
1623
|
status: 'general-availability',
|
|
1547
|
-
usageGuidelines: ['
|
|
1624
|
+
usageGuidelines: ['Check this before showing controls that require RovoSettingsModalProvider. It reports whether the component is within that provider.'],
|
|
1548
1625
|
keywords: ['rovo', 'settings', 'provider', 'hook'],
|
|
1549
1626
|
category: 'rovo',
|
|
1550
1627
|
returns: {
|
|
@@ -1556,31 +1633,31 @@ export const atlaskitHooks = [{
|
|
|
1556
1633
|
name: 'useRovoSettingsConfig',
|
|
1557
1634
|
description: 'Reads the configuration supplied for the current Rovo settings experience.',
|
|
1558
1635
|
status: 'general-availability',
|
|
1559
|
-
usageGuidelines: ['
|
|
1636
|
+
usageGuidelines: ['Read the product, site, and settings configuration from the nearest provider. RovoSettingsModalProvider supplies these values for the standard settings flow.'],
|
|
1560
1637
|
keywords: ['rovo', 'settings', 'config', 'hook'],
|
|
1561
1638
|
category: 'rovo',
|
|
1562
1639
|
returns: {
|
|
1563
1640
|
type: 'RovoSettingsConfig'
|
|
1564
1641
|
},
|
|
1565
1642
|
package: '@atlassian/rovo-settings-modal',
|
|
1566
|
-
examples: []
|
|
1643
|
+
examples: ["import { IntlProvider } from 'react-intl';\nimport { Stack } from '@atlaskit/primitives/compiled/stack';\nimport { Text } from '@atlaskit/primitives/compiled/text';\nimport {\n\tRovoSettingsConfigProvider,\n\tuseIsRovoSettingsModalProviderMounted,\n\tuseRovoSettingsConfig,\n} from '@atlassian/rovo-settings-modal/common/utils/rovo-settings-config';\nconst SettingsContextSummary = (): React.JSX.Element => {\n\tconst { product, siteId, experienceId } = useRovoSettingsConfig();\n\tconst isModalProviderMounted = useIsRovoSettingsModalProviderMounted();\n\treturn (\n\t\t<Stack space=\"space.050\">\n\t\t\t<Text>Product: {product}</Text>\n\t\t\t<Text>Site: {siteId}</Text>\n\t\t\t<Text>Experience: {experienceId}</Text>\n\t\t\t<Text>Settings modal provider mounted: {isModalProviderMounted ? 'yes' : 'no'}</Text>\n\t\t</Stack>\n\t);\n};\nexport default function RovoSettingsConfigExample(): React.JSX.Element {\n\treturn (\n\t\t<IntlProvider locale=\"en\">\n\t\t\t<RovoSettingsConfigProvider\n\t\t\t\tvalue={{\n\t\t\t\t\tproduct: 'confluence',\n\t\t\t\t\tsiteId: 'example-cloud-id',\n\t\t\t\t\texperienceId: 'ai-mate',\n\t\t\t\t\tsurface: 'profile-menu',\n\t\t\t\t}}\n\t\t\t>\n\t\t\t\t<SettingsContextSummary />\n\t\t\t</RovoSettingsConfigProvider>\n\t\t</IntlProvider>\n\t);\n}"]
|
|
1567
1644
|
}, {
|
|
1568
1645
|
name: 'useRovoSettingsModal',
|
|
1569
1646
|
description: 'Returns controls for opening and closing the nearest Rovo settings modal.',
|
|
1570
1647
|
status: 'general-availability',
|
|
1571
|
-
usageGuidelines: ['
|
|
1648
|
+
usageGuidelines: ['Call this hook within RovoSettingsModalProvider. Use RovoSettingsModal when your app has no provider and only needs a trigger to open settings.'],
|
|
1572
1649
|
keywords: ['rovo', 'settings', 'modal', 'hook'],
|
|
1573
1650
|
category: 'rovo',
|
|
1574
1651
|
returns: {
|
|
1575
1652
|
type: '{ open: (options?: RovoSettingsModalOpenOptions) => void; close: () => void }'
|
|
1576
1653
|
},
|
|
1577
1654
|
package: '@atlassian/rovo-settings-modal',
|
|
1578
|
-
examples: []
|
|
1655
|
+
examples: ["import { IntlProvider } from 'react-intl';\nimport Button from '@atlaskit/button/default/button';\nimport {\n\tRovoSettingsModalProvider,\n\tuseRovoSettingsModal,\n} from '@atlassian/rovo-settings-modal/ui/rovo-settings-modal-provider';\ntype RovoSettingsModalProviderExampleProps = {\n\tcloudId: string;\n};\nconst SettingsAction = (): React.JSX.Element => {\n\tconst { open } = useRovoSettingsModal();\n\treturn (\n\t\t<Button appearance=\"subtle\" onClick={() => open({ defaultTab: 'connected-apps' })}>\n\t\t\tManage connected apps\n\t\t</Button>\n\t);\n};\nexport default function RovoSettingsModalProviderExample({\n\tcloudId,\n}: RovoSettingsModalProviderExampleProps): React.JSX.Element {\n\treturn (\n\t\t<IntlProvider locale=\"en\">\n\t\t\t<RovoSettingsModalProvider product=\"confluence\" cloudId={cloudId}>\n\t\t\t\t<SettingsAction />\n\t\t\t</RovoSettingsModalProvider>\n\t\t</IntlProvider>\n\t);\n}"]
|
|
1579
1656
|
}, {
|
|
1580
1657
|
name: 'useAddSpaceSource',
|
|
1581
1658
|
description: 'Adds a source to a space and mirrors the successful result into the space store.',
|
|
1582
1659
|
status: 'general-availability',
|
|
1583
|
-
usageGuidelines: ['
|
|
1660
|
+
usageGuidelines: ['Call addSource with the resolved source URL and any available name, ARI, and type. The hook updates the space store on success; use its error and isAdding state to keep the picker feedback in sync.'],
|
|
1584
1661
|
keywords: ['rovo', 'spaces', 'source', 'mutation'],
|
|
1585
1662
|
category: 'rovo',
|
|
1586
1663
|
returns: {
|
|
@@ -1592,7 +1669,7 @@ export const atlaskitHooks = [{
|
|
|
1592
1669
|
name: 'useCreateSpace',
|
|
1593
1670
|
description: 'Creates a Rovo space and exposes mutation, submission, and error state.',
|
|
1594
1671
|
status: 'general-availability',
|
|
1595
|
-
usageGuidelines: ['
|
|
1672
|
+
usageGuidelines: ['Pass the current cloud, product, and experience values. Call mutate when the form submits.', 'Set form loading and errors from isSubmitting and error. Update navigation from onSuccess after creation.'],
|
|
1596
1673
|
keywords: ['rovo', 'spaces', 'create', 'mutation'],
|
|
1597
1674
|
category: 'rovo',
|
|
1598
1675
|
returns: {
|
|
@@ -1604,7 +1681,7 @@ export const atlaskitHooks = [{
|
|
|
1604
1681
|
name: 'useDeleteSpace',
|
|
1605
1682
|
description: 'Deletes a space with optimistic store removal and rollback on failure.',
|
|
1606
1683
|
status: 'general-availability',
|
|
1607
|
-
usageGuidelines: ['
|
|
1684
|
+
usageGuidelines: ['Call deleteSpace only after the person confirms deletion. The hook removes the space optimistically and restores it if the request fails, so keep the error visible and let the person retry.'],
|
|
1608
1685
|
keywords: ['rovo', 'spaces', 'delete', 'mutation'],
|
|
1609
1686
|
category: 'rovo',
|
|
1610
1687
|
returns: {
|
|
@@ -1616,7 +1693,7 @@ export const atlaskitHooks = [{
|
|
|
1616
1693
|
name: 'useDeleteSpaceSource',
|
|
1617
1694
|
description: 'Removes a source from a space and mirrors the deletion into the space store.',
|
|
1618
1695
|
status: 'general-availability',
|
|
1619
|
-
usageGuidelines: ['
|
|
1696
|
+
usageGuidelines: ['Call deleteSource with the source ID after confirmation. The hook updates the space store on success and rejects on failure; use isDeleting and error to prevent duplicate submits and report failures.'],
|
|
1620
1697
|
keywords: ['rovo', 'spaces', 'source', 'delete'],
|
|
1621
1698
|
category: 'rovo',
|
|
1622
1699
|
returns: {
|
|
@@ -1628,14 +1705,14 @@ export const atlaskitHooks = [{
|
|
|
1628
1705
|
name: 'useSpaceSourcePlugins',
|
|
1629
1706
|
description: 'Creates the Link Picker plugins used to select supported space sources.',
|
|
1630
1707
|
status: 'general-availability',
|
|
1631
|
-
usageGuidelines: ['
|
|
1708
|
+
usageGuidelines: ['Build the picker plugins with the cloud ID from the active site, then pass them into the authenticated Link Picker context. The hook supplies Confluence, Jira, Atlas, and Loom sources.'],
|
|
1632
1709
|
keywords: ['rovo', 'spaces', 'source', 'link picker'],
|
|
1633
1710
|
category: 'rovo',
|
|
1634
1711
|
returns: {
|
|
1635
1712
|
type: 'LinkPickerPlugin[]'
|
|
1636
1713
|
},
|
|
1637
1714
|
package: '@atlassian/rovo-spaces',
|
|
1638
|
-
examples: []
|
|
1715
|
+
examples: ["import React, { useState } from 'react';\nimport { IntlProvider } from 'react-intl';\nimport Button from '@atlaskit/button/default/button';\nimport { SmartCardProvider } from '@atlaskit/link-provider/smart-card-provider';\nimport { Stack } from '@atlaskit/primitives/compiled/stack';\nimport { Text } from '@atlaskit/primitives/compiled/text';\nimport { SourceLinkPickerPopup } from '@atlassian/rovo-spaces/ui/SpaceLandingPage/SourceLinkPickerPopup';\nimport type { SpaceSource } from '@atlassian/rovo-spaces/ui/SpaceLandingPage/types';\nimport { useSpaceSourcePlugins } from '@atlassian/rovo-spaces/ui/SpaceLandingPage/useSpaceSourcePlugins';\ntype SourceLinkPickerPopupExampleProps = {\n\t/** Cloud ID from the host's authenticated Link Picker integration context. */\n\tcloudId: string;\n\t/** Persist this source and then pass the updated source list back to the picker. */\n\tonPersistSource: (source: SpaceSource) => Promise<void>;\n};\nexport default function SourceLinkPickerPopupExample({\n\tcloudId,\n\tonPersistSource,\n}: SourceLinkPickerPopupExampleProps): React.JSX.Element {\n\tconst plugins = useSpaceSourcePlugins(cloudId);\n\tconst [sources, setSources] = useState<SpaceSource[]>([]);\n\tconst [message, setMessage] = useState<string>();\n\tconst handleSourceAdded = (source: SpaceSource) => {\n\t\t// The picker resolves a link; the host owns authorization and persistence.\n\t\tvoid onPersistSource(source).then(\n\t\t\t() => setSources((current) => [...current, source]),\n\t\t\t() => setMessage(`Could not add ${source.title}`),\n\t\t);\n\t};\n\treturn (\n\t\t<IntlProvider locale=\"en\">\n\t\t\t<SmartCardProvider>\n\t\t\t\t<Stack space=\"space.150\">\n\t\t\t\t\t<SourceLinkPickerPopup\n\t\t\t\t\t\tcloudId={cloudId}\n\t\t\t\t\t\tplugins={plugins}\n\t\t\t\t\t\tsources={sources}\n\t\t\t\t\t\tonSourceAdded={handleSourceAdded}\n\t\t\t\t\t\ttrigger={({ onClick, ...triggerProps }) => (\n\t\t\t\t\t\t\t<Button {...triggerProps} onClick={onClick}>\n\t\t\t\t\t\t\t\tAdd a source\n\t\t\t\t\t\t\t</Button>\n\t\t\t\t\t\t)}\n\t\t\t\t\t/>\n\t\t\t\t\t{sources.map((source) => (\n\t\t\t\t\t\t<Text key={source.id} size=\"small\">\n\t\t\t\t\t\t\t{source.title}\n\t\t\t\t\t\t</Text>\n\t\t\t\t\t))}\n\t\t\t\t\t{message && (\n\t\t\t\t\t\t<Text size=\"small\" role=\"status\">\n\t\t\t\t\t\t\t{message}\n\t\t\t\t\t\t</Text>\n\t\t\t\t\t)}\n\t\t\t\t</Stack>\n\t\t\t</SmartCardProvider>\n\t\t</IntlProvider>\n\t);\n}"]
|
|
1639
1716
|
}, {
|
|
1640
1717
|
name: 'useActionInvocationStatuses',
|
|
1641
1718
|
description: 'Returns live action-invocation statuses for a set of Rovo plan steps.',
|
|
@@ -1742,7 +1819,7 @@ export const atlaskitHooks = [{
|
|
|
1742
1819
|
name: 'useRovoProjectCreationCategories',
|
|
1743
1820
|
description: 'Returns localized feedback categories for Rovo project creation.',
|
|
1744
1821
|
status: 'general-availability',
|
|
1745
|
-
usageGuidelines: ['Use to
|
|
1822
|
+
usageGuidelines: ['Use to show the same translated project-creation categories as SmartCreateFeedback.', 'Display the translated labels and save the stable category IDs with feedback.'],
|
|
1746
1823
|
keywords: ['rovo', 'project creation', 'feedback', 'categories'],
|
|
1747
1824
|
category: 'rovo',
|
|
1748
1825
|
returns: {
|
|
@@ -1754,7 +1831,7 @@ export const atlaskitHooks = [{
|
|
|
1754
1831
|
name: 'useCurrentDisplayMessage',
|
|
1755
1832
|
description: 'Returns the assistant message currently selected by preview history.',
|
|
1756
1833
|
status: 'general-availability',
|
|
1757
|
-
usageGuidelines: ['Use
|
|
1834
|
+
usageGuidelines: ['Use this message when rendering the preview after undo or redo; it follows the message selected in the staging-area history rather than always returning the newest message.'],
|
|
1758
1835
|
keywords: ['rovo', 'smart creation', 'message', 'history'],
|
|
1759
1836
|
category: 'rovo',
|
|
1760
1837
|
returns: {
|
|
@@ -1790,7 +1867,7 @@ export const atlaskitHooks = [{
|
|
|
1790
1867
|
name: 'useLatestActionMessage',
|
|
1791
1868
|
description: 'Returns the latest Smart Creation action messages and preview statuses.',
|
|
1792
1869
|
status: 'general-availability',
|
|
1793
|
-
usageGuidelines: ['Use
|
|
1870
|
+
usageGuidelines: ['Use this for the latest create or update action and ask-question state. It reads the active conversation, so provide the product’s Smart Creation chat-store hook for that conversation.'],
|
|
1794
1871
|
keywords: ['rovo', 'smart creation', 'action', 'message'],
|
|
1795
1872
|
category: 'rovo',
|
|
1796
1873
|
returns: {
|
|
@@ -1802,7 +1879,7 @@ export const atlaskitHooks = [{
|
|
|
1802
1879
|
name: 'useSelectedPreview',
|
|
1803
1880
|
description: 'Returns the message, content, title, and status selected for preview.',
|
|
1804
1881
|
status: 'general-availability',
|
|
1805
|
-
usageGuidelines: ['Use when a
|
|
1882
|
+
usageGuidelines: ['Use this when the preview should follow the action the person selected, including a specific action within a message. Provide the active conversation’s chat-store hook so the selected message can be resolved.'],
|
|
1806
1883
|
keywords: ['rovo', 'smart creation', 'selected preview', 'message'],
|
|
1807
1884
|
category: 'rovo',
|
|
1808
1885
|
returns: {
|
|
@@ -1814,7 +1891,7 @@ export const atlaskitHooks = [{
|
|
|
1814
1891
|
name: 'useStagingAreaContext',
|
|
1815
1892
|
description: 'Returns the current Smart Creation staging-area context.',
|
|
1816
1893
|
status: 'general-availability',
|
|
1817
|
-
usageGuidelines: ['Call
|
|
1894
|
+
usageGuidelines: ['Call within StagingAreaContextProvider. Read the selected preview and status from the current conversation instead of keeping another copy in component state.'],
|
|
1818
1895
|
keywords: ['rovo', 'smart creation', 'staging area', 'context'],
|
|
1819
1896
|
category: 'rovo',
|
|
1820
1897
|
returns: {
|
|
@@ -1826,7 +1903,7 @@ export const atlaskitHooks = [{
|
|
|
1826
1903
|
name: 'useUndoRedoHistory',
|
|
1827
1904
|
description: 'Builds undo and redo navigation from ephemeral creation-action messages.',
|
|
1828
1905
|
status: 'general-availability',
|
|
1829
|
-
usageGuidelines: ['
|
|
1906
|
+
usageGuidelines: ['Enable history only for previews that can be revisited, and cache each message’s embed URL as it loads. The hook returns controls only when there is more than one supported generated version.'],
|
|
1830
1907
|
keywords: ['rovo', 'smart creation', 'undo', 'redo'],
|
|
1831
1908
|
category: 'rovo',
|
|
1832
1909
|
returns: {
|
|
@@ -1852,16 +1929,139 @@ export const atlaskitHooks = [{
|
|
|
1852
1929
|
category: 'rovo',
|
|
1853
1930
|
package: '@atlassian/store-rovo',
|
|
1854
1931
|
examples: []
|
|
1932
|
+
}, {
|
|
1933
|
+
name: 'useBrowseAgentCategoryUpdates',
|
|
1934
|
+
description: 'Public hook `useBrowseAgentCategoryUpdates` exported by `@atlassian/studio-agent-browse/ui/browse-agent/useBrowseAgentCategoryUpdates`.',
|
|
1935
|
+
status: 'general-availability',
|
|
1936
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
1937
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
1938
|
+
category: 'studio',
|
|
1939
|
+
package: '@atlassian/studio-agent-browse',
|
|
1940
|
+
examples: []
|
|
1855
1941
|
}, {
|
|
1856
1942
|
name: 'useBrowseAgentView',
|
|
1857
|
-
description: '
|
|
1943
|
+
description: 'Public hook `useBrowseAgentView` exported by `@atlassian/studio-agent-browse/browse-agent/use-browse-agent-view`.',
|
|
1858
1944
|
status: 'general-availability',
|
|
1859
|
-
usageGuidelines: ['
|
|
1860
|
-
keywords: ['
|
|
1861
|
-
category: '
|
|
1862
|
-
|
|
1863
|
-
|
|
1864
|
-
|
|
1865
|
-
|
|
1945
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
1946
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
1947
|
+
category: 'studio',
|
|
1948
|
+
package: '@atlassian/studio-agent-browse',
|
|
1949
|
+
examples: []
|
|
1950
|
+
}, {
|
|
1951
|
+
name: 'useAgentKnowledgeSourcesMutation',
|
|
1952
|
+
description: 'Public hook `useAgentKnowledgeSourcesMutation` exported by `@atlassian/studio-agent-editor/domains/knowledge-sources/mutations`.',
|
|
1953
|
+
status: 'general-availability',
|
|
1954
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
1955
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
1956
|
+
category: 'studio',
|
|
1957
|
+
package: '@atlassian/studio-agent-editor',
|
|
1958
|
+
examples: []
|
|
1959
|
+
}, {
|
|
1960
|
+
name: 'useAgentSkillsMutation',
|
|
1961
|
+
description: 'Public hook `useAgentSkillsMutation` exported by `@atlassian/studio-agent-editor/domains/skills/mutations`.',
|
|
1962
|
+
status: 'general-availability',
|
|
1963
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
1964
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
1965
|
+
category: 'studio',
|
|
1966
|
+
package: '@atlassian/studio-agent-editor',
|
|
1967
|
+
examples: []
|
|
1968
|
+
}, {
|
|
1969
|
+
name: 'useAgentToolConfigurationMutation',
|
|
1970
|
+
description: 'Public hook `useAgentToolConfigurationMutation` exported by `@atlassian/studio-agent-editor/domains/tools/mutations`.',
|
|
1971
|
+
status: 'general-availability',
|
|
1972
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
1973
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
1974
|
+
category: 'studio',
|
|
1975
|
+
package: '@atlassian/studio-agent-editor',
|
|
1976
|
+
examples: []
|
|
1977
|
+
}, {
|
|
1978
|
+
name: 'useAgentToolsMutation',
|
|
1979
|
+
description: 'Public hook `useAgentToolsMutation` exported by `@atlassian/studio-agent-editor/domains/tools/mutations`.',
|
|
1980
|
+
status: 'general-availability',
|
|
1981
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
1982
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
1983
|
+
category: 'studio',
|
|
1984
|
+
package: '@atlassian/studio-agent-editor',
|
|
1985
|
+
examples: []
|
|
1986
|
+
}, {
|
|
1987
|
+
name: 'useKnowledgeSourcesUpdater',
|
|
1988
|
+
description: 'Public hook `useKnowledgeSourcesUpdater` exported by `@atlassian/studio-agent-editor/domains/knowledge-sources/updaters`.',
|
|
1989
|
+
status: 'general-availability',
|
|
1990
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
1991
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
1992
|
+
category: 'studio',
|
|
1993
|
+
package: '@atlassian/studio-agent-editor',
|
|
1994
|
+
examples: []
|
|
1995
|
+
}, {
|
|
1996
|
+
name: 'useScenarioToolsMutation',
|
|
1997
|
+
description: 'Public hook `useScenarioToolsMutation` exported by `@atlassian/studio-agent-editor/domains/tools/mutations`.',
|
|
1998
|
+
status: 'general-availability',
|
|
1999
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
2000
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
2001
|
+
category: 'studio',
|
|
2002
|
+
package: '@atlassian/studio-agent-editor',
|
|
2003
|
+
examples: []
|
|
2004
|
+
}, {
|
|
2005
|
+
name: 'useSkillsUpdater',
|
|
2006
|
+
description: 'Public hook `useSkillsUpdater` exported by `@atlassian/studio-agent-editor/domains/skills/updaters`.',
|
|
2007
|
+
status: 'general-availability',
|
|
2008
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
2009
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
2010
|
+
category: 'studio',
|
|
2011
|
+
package: '@atlassian/studio-agent-editor',
|
|
2012
|
+
examples: []
|
|
2013
|
+
}, {
|
|
2014
|
+
name: 'useToolConfigurationUpdater',
|
|
2015
|
+
description: 'Public hook `useToolConfigurationUpdater` exported by `@atlassian/studio-agent-editor/domains/tools/updaters`.',
|
|
2016
|
+
status: 'general-availability',
|
|
2017
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
2018
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
2019
|
+
category: 'studio',
|
|
2020
|
+
package: '@atlassian/studio-agent-editor',
|
|
2021
|
+
examples: []
|
|
2022
|
+
}, {
|
|
2023
|
+
name: 'useToolsUpdater',
|
|
2024
|
+
description: 'Public hook `useToolsUpdater` exported by `@atlassian/studio-agent-editor/domains/tools/updaters`.',
|
|
2025
|
+
status: 'general-availability',
|
|
2026
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
2027
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
2028
|
+
category: 'studio',
|
|
2029
|
+
package: '@atlassian/studio-agent-editor',
|
|
2030
|
+
examples: []
|
|
2031
|
+
}, {
|
|
2032
|
+
name: 'useUpdateAgentDetailsMutation',
|
|
2033
|
+
description: 'Public hook `useUpdateAgentDetailsMutation` exported by `@atlassian/studio-agent-editor/domains/agent-details/mutations`.',
|
|
2034
|
+
status: 'general-availability',
|
|
2035
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
2036
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
2037
|
+
category: 'studio',
|
|
2038
|
+
package: '@atlassian/studio-agent-editor',
|
|
2039
|
+
examples: []
|
|
2040
|
+
}, {
|
|
2041
|
+
name: 'useAgentProfileViewNavigation',
|
|
2042
|
+
description: 'Public hook `useAgentProfileViewNavigation` exported by `@atlassian/studio-agent-profile/ui/agent-profile/components/AgentProfileViewNavigationProvider`.',
|
|
2043
|
+
status: 'general-availability',
|
|
2044
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
2045
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
2046
|
+
category: 'studio',
|
|
2047
|
+
package: '@atlassian/studio-agent-profile',
|
|
2048
|
+
examples: []
|
|
2049
|
+
}, {
|
|
2050
|
+
name: 'useAvailableConfigsByTier',
|
|
2051
|
+
description: 'Public hook `useAvailableConfigsByTier` exported by `@atlassian/studio-agent-profile/agent-reasoning/use-available-configs-by-tier`.',
|
|
2052
|
+
status: 'general-availability',
|
|
2053
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
2054
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
2055
|
+
category: 'studio',
|
|
2056
|
+
package: '@atlassian/studio-agent-profile',
|
|
2057
|
+
examples: []
|
|
2058
|
+
}, {
|
|
2059
|
+
name: 'useVisibleExecutionTierOptions',
|
|
2060
|
+
description: 'Public hook `useVisibleExecutionTierOptions` exported by `@atlassian/studio-agent-profile/agent-reasoning/use-visible-execution-tier-options`.',
|
|
2061
|
+
status: 'general-availability',
|
|
2062
|
+
usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
|
|
2063
|
+
keywords: ['studio', 'rovo', 'agent'],
|
|
2064
|
+
category: 'studio',
|
|
2065
|
+
package: '@atlassian/studio-agent-profile',
|
|
1866
2066
|
examples: []
|
|
1867
2067
|
}];
|