@atlaskit/ads-mcp 1.11.1 → 1.11.2

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.
Files changed (23) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist/cjs/tools/get-all-components/components.codegen.js +2 -2
  3. package/dist/cjs/tools/get-atlaskit-components/atlaskit-components.codegen.js +2 -2
  4. package/dist/cjs/tools/get-atlaskit-hooks/atlaskit-hooks.codegen.js +282 -82
  5. package/dist/cjs/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.js +3 -8393
  6. package/dist/cjs/tools/get-lint-rules/lint-rules-structured-content.codegen.js +20 -12
  7. package/dist/es2019/tools/get-all-components/components.codegen.js +2 -2
  8. package/dist/es2019/tools/get-atlaskit-components/atlaskit-components.codegen.js +2 -2
  9. package/dist/es2019/tools/get-atlaskit-hooks/atlaskit-hooks.codegen.js +282 -82
  10. package/dist/es2019/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.js +2 -8386
  11. package/dist/es2019/tools/get-lint-rules/lint-rules-structured-content.codegen.js +20 -12
  12. package/dist/esm/tools/get-all-components/components.codegen.js +2 -2
  13. package/dist/esm/tools/get-atlaskit-components/atlaskit-components.codegen.js +2 -2
  14. package/dist/esm/tools/get-atlaskit-hooks/atlaskit-hooks.codegen.js +282 -82
  15. package/dist/esm/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.js +2 -8386
  16. package/dist/esm/tools/get-lint-rules/lint-rules-structured-content.codegen.js +20 -12
  17. package/dist/types/tools/get-all-components/components.codegen.d.ts +1 -1
  18. package/dist/types/tools/get-atlaskit-components/atlaskit-components.codegen.d.ts +1 -1
  19. package/dist/types/tools/get-atlaskit-hooks/atlaskit-hooks.codegen.d.ts +1 -1
  20. package/dist/types/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.d.ts +1 -1
  21. package/dist/types/tools/get-lint-rules/lint-rules-structured-content.codegen.d.ts +1 -1
  22. package/dist/types/tools/types.d.ts +1 -1
  23. package/package.json +2 -2
@@ -9,7 +9,7 @@ exports.atlaskitHooks = void 0;
9
9
  *
10
10
  * Structured content hooks from design-system *.docs.tsx files
11
11
  *
12
- * @codegen <<SignedSource::3b66faaf90a123fa4bc5856ae6f6a17f>>
12
+ * @codegen <<SignedSource::3a2fe9a9152f31ebddcf3fa6102ec30b>>
13
13
  * @codegenCommand afm workspace @af/ads-ai-tooling codegen
14
14
  */
15
15
  /* eslint-disable @repo/internal/react/boolean-prop-naming-convention -- not our types */
@@ -326,7 +326,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
326
326
  keywords: ['smart-card', 'hooks', 'useSmartLinkActions', 'actions'],
327
327
  category: 'linking',
328
328
  package: '@atlaskit/smart-card',
329
- examples: ["import React, { useCallback } from 'react';\nimport Button from '@atlaskit/button/default/button';\nimport { SmartCardProvider } from '@atlaskit/link-provider/smart-card-provider';\nimport { ResolvedClient, ResolvedClientUrl } from '@atlaskit/link-test-helpers';\nimport { Box } from '@atlaskit/primitives/compiled';\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;"]
329
+ 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;"]
330
330
  }, {
331
331
  name: 'useSmartLinkEvents',
332
332
  description: 'Hook that returns a SmartLinkEvents object for dispatching analytics events for a given URL. Currently supports insertSmartLink.',
@@ -336,19 +336,15 @@ var atlaskitHooks = exports.atlaskitHooks = [{
336
336
  keywords: ['smart-card', 'hooks', 'analytics', 'useSmartLinkEvents', 'events'],
337
337
  category: 'linking',
338
338
  package: '@atlaskit/smart-card',
339
- 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 { ResolvedClient, ResolvedClientUrl } from '@atlaskit/link-test-helpers';\nimport { Box, Text, xcss } from '@atlaskit/primitives';\nimport { Card } from '../../src';\nconst headingBoxStyles = xcss({\n\tmarginBottom: 'space.100',\n});\nconst stackBoxStyles = xcss({\n\tmarginTop: '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={headingBoxStyles}>\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={stackBoxStyles}>\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};"]
339
+ 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};"]
340
340
  }, {
341
341
  name: 'useAgentSessions',
342
342
  description: 'Reads normalized account-scoped Rovo agent sessions and keeps the Relay result current after lifecycle events.',
343
343
  status: 'general-availability',
344
- usageGuidelines: ['Call inside a RelayEnvironmentProvider and pass accountId with cloudId unless the host already has a Rovo activation ID.', '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 AgentSessionsOptions, AgentSessionsResult, and normalized session contracts.'],
344
+ 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.'],
345
345
  keywords: ['rovo', 'agent sessions', 'relay', 'hooks'],
346
346
  category: 'data',
347
- parameters: [{
348
- name: 'options',
349
- type: 'AgentSessionsOptions',
350
- description: 'Account identity plus cloudId or rovoActivationId, with optional pageSize and sort configuration.'
351
- }],
347
+ parameters: [],
352
348
  returns: {
353
349
  type: 'AgentSessionsResult',
354
350
  description: 'An unavailable result when identity cannot resolve a Rovo workspace, otherwise normalized sessions, pagination, and refetch controls.'
@@ -358,8 +354,8 @@ var atlaskitHooks = exports.atlaskitHooks = [{
358
354
  }, {
359
355
  name: 'useChooseObjectExample',
360
356
  description: 'Returns object-example selection state for smart-creation prompts.',
361
- status: 'general-availability',
362
- usageGuidelines: ['Use within object-aware smart-creation example selection.'],
357
+ status: 'release-candidate',
358
+ 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.'],
363
359
  keywords: ['rovo', 'smart creation', 'object example', 'hook'],
364
360
  category: 'rovo',
365
361
  returns: {
@@ -370,8 +366,8 @@ var atlaskitHooks = exports.atlaskitHooks = [{
370
366
  }, {
371
367
  name: 'useInputHatSelectedAgent',
372
368
  description: 'Resolves the selected agent displayed by the refreshed chat input hat.',
373
- status: 'general-availability',
374
- usageGuidelines: ['Use when composing the package refreshed input-hat experience.'],
369
+ status: 'release-candidate',
370
+ 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.'],
375
371
  keywords: ['rovo', 'chat', 'agent', 'input hat'],
376
372
  category: 'rovo',
377
373
  returns: {
@@ -382,8 +378,8 @@ var atlaskitHooks = exports.atlaskitHooks = [{
382
378
  }, {
383
379
  name: 'usePromptLibraryFilters',
384
380
  description: 'Manages prompt-library category, search, and visible prompt filtering.',
385
- status: 'general-availability',
386
- usageGuidelines: ['Use when building a custom prompt-library presentation.'],
381
+ status: 'release-candidate',
382
+ 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.'],
387
383
  keywords: ['rovo', 'prompt library', 'filter', 'hook'],
388
384
  category: 'rovo',
389
385
  returns: {
@@ -413,7 +409,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
413
409
  name: 'useAllAttachmentsStore',
414
410
  description: 'Selects all file and external-context attachments for one prompt-input key and exposes attachment actions.',
415
411
  status: 'general-availability',
416
- usageGuidelines: ['Use when rendering a unified ordered attachment surface for one prompt input.'],
412
+ 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.'],
417
413
  keywords: ['rovo', 'chat', 'attachments', 'selector'],
418
414
  category: 'rovo',
419
415
  package: '@atlassian/conversation-assistant-chat-prompt-input',
@@ -608,11 +604,12 @@ var atlaskitHooks = exports.atlaskitHooks = [{
608
604
  name: 'useExternalContextBrowser',
609
605
  description: 'Coordinates external context menu items, browser content, and selected prompt contexts.',
610
606
  status: 'general-availability',
611
- usageGuidelines: ['Use in a Rovo prompt integration that accepts context from one or more product providers.'],
607
+ 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`.'],
612
608
  keywords: ['rovo', 'chat', 'context', 'browser', 'hook'],
613
609
  category: 'rovo',
614
610
  returns: {
615
- type: 'ExternalContextBrowserState'
611
+ type: 'ExternalContextBrowserState',
612
+ description: 'Returns the current browser, selected contexts, and menu-item builder for the supplied context browser configuration.'
616
613
  },
617
614
  package: '@atlassian/conversation-assistant-external-context',
618
615
  examples: []
@@ -688,6 +685,54 @@ var atlaskitHooks = exports.atlaskitHooks = [{
688
685
  },
689
686
  package: '@atlassian/conversation-assistant-message-actions',
690
687
  examples: []
688
+ }, {
689
+ name: 'useConversationAssistantSpotlightActions',
690
+ description: 'Public hook `useConversationAssistantSpotlightActions` from `@atlassian/conversation-assistant-onboarding/controllers/spotlight`.',
691
+ status: 'general-availability',
692
+ keywords: ['rovo', 'chat', 'ai', 'platform'],
693
+ category: 'rovo',
694
+ package: '@atlassian/conversation-assistant-onboarding',
695
+ examples: []
696
+ }, {
697
+ name: 'useConversationAssistantSpotlightState',
698
+ description: 'Public hook `useConversationAssistantSpotlightState` from `@atlassian/conversation-assistant-onboarding/controllers/spotlight`.',
699
+ status: 'general-availability',
700
+ keywords: ['rovo', 'chat', 'ai', 'platform'],
701
+ category: 'rovo',
702
+ package: '@atlassian/conversation-assistant-onboarding',
703
+ examples: []
704
+ }, {
705
+ name: 'useGettingStartedTourState',
706
+ description: 'Public hook `useGettingStartedTourState` from `@atlassian/conversation-assistant-onboarding/controllers/getting-started-tour`.',
707
+ status: 'general-availability',
708
+ keywords: ['rovo', 'chat', 'ai', 'platform'],
709
+ category: 'rovo',
710
+ package: '@atlassian/conversation-assistant-onboarding',
711
+ examples: []
712
+ }, {
713
+ name: 'useGettingStartedTourStore',
714
+ description: 'Public hook `useGettingStartedTourStore` from `@atlassian/conversation-assistant-onboarding/controllers/getting-started-tour`.',
715
+ status: 'general-availability',
716
+ keywords: ['rovo', 'chat', 'ai', 'platform'],
717
+ category: 'rovo',
718
+ package: '@atlassian/conversation-assistant-onboarding',
719
+ examples: []
720
+ }, {
721
+ name: 'useGettingStartedTourStoreActions',
722
+ description: 'Public hook `useGettingStartedTourStoreActions` from `@atlassian/conversation-assistant-onboarding/controllers/getting-started-tour`.',
723
+ status: 'general-availability',
724
+ keywords: ['rovo', 'chat', 'ai', 'platform'],
725
+ category: 'rovo',
726
+ package: '@atlassian/conversation-assistant-onboarding',
727
+ examples: []
728
+ }, {
729
+ name: 'usePostOfficeCoordination',
730
+ description: 'Public hook `usePostOfficeCoordination` from `@atlassian/conversation-assistant-onboarding/controllers/post-office-migration`.',
731
+ status: 'general-availability',
732
+ keywords: ['rovo', 'chat', 'ai', 'platform'],
733
+ category: 'rovo',
734
+ package: '@atlassian/conversation-assistant-onboarding',
735
+ examples: []
691
736
  }, {
692
737
  name: 'useProductData',
693
738
  description: 'Public useProductData entrypoint for @atlassian/conversation-assistant-preview-card.',
@@ -808,6 +853,14 @@ var atlaskitHooks = exports.atlaskitHooks = [{
808
853
  },
809
854
  package: '@atlassian/conversation-assistant-ui-components',
810
855
  examples: []
856
+ }, {
857
+ name: 'useChartApiService',
858
+ description: 'Public hook `useChartApiService` from `@atlassian/conversation-assistant-viz/services/chart-api-service`.',
859
+ status: 'general-availability',
860
+ keywords: ['rovo', 'chat', 'ai', 'platform'],
861
+ category: 'rovo',
862
+ package: '@atlassian/conversation-assistant-viz',
863
+ examples: []
811
864
  }, {
812
865
  name: 'useAutoApplyAvailability',
813
866
  description: 'Determines whether auto-apply is available for the current product and conversation context.',
@@ -821,7 +874,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
821
874
  name: 'useAutoApplyState',
822
875
  description: 'Reads and updates the auto-apply preference with backend persistence and a local-storage fallback.',
823
876
  status: 'general-availability',
824
- usageGuidelines: ['Use the package root import; the auto-apply subpath exposes the same hook.', 'Handle rejected setEnabled calls when the host needs to surface persistence failures.'],
877
+ 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.'],
825
878
  keywords: ['rovo', 'creation', 'auto apply', 'state'],
826
879
  category: 'rovo',
827
880
  package: '@atlassian/creation-settings',
@@ -848,7 +901,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
848
901
  name: 'useAiCreateProjectContext',
849
902
  description: 'Resolves Jira project context for an AI-assisted creation flow.',
850
903
  status: 'general-availability',
851
- usageGuidelines: ['Use when draft creation needs hydrated Jira project context.'],
904
+ 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.'],
852
905
  keywords: ['rovo', 'jira', 'project', 'context'],
853
906
  category: 'rovo',
854
907
  returns: {
@@ -860,7 +913,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
860
913
  name: 'useAifcAnalytics',
861
914
  description: 'Returns analytics helpers for AI-assisted Jira work-item creation.',
862
915
  status: 'general-availability',
863
- usageGuidelines: ['Use within package-integrated creation UI that emits AIFC analytics.'],
916
+ 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.'],
864
917
  keywords: ['rovo', 'jira', 'creation', 'analytics'],
865
918
  category: 'rovo',
866
919
  returns: {
@@ -872,7 +925,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
872
925
  name: 'useAreAllCreated',
873
926
  description: 'Reports whether every draft work item for a message has been created.',
874
927
  status: 'general-availability',
875
- usageGuidelines: ['Use to derive completion state for a message-scoped creation flow.'],
928
+ 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.'],
876
929
  keywords: ['rovo', 'jira', 'draft work item', 'created'],
877
930
  category: 'rovo',
878
931
  returns: {
@@ -884,7 +937,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
884
937
  name: 'useAreAllDismissed',
885
938
  description: 'Reports whether every draft work item for a message has been dismissed.',
886
939
  status: 'general-availability',
887
- usageGuidelines: ['Use to derive dismissed state for a message-scoped creation flow.'],
940
+ 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”.'],
888
941
  keywords: ['rovo', 'jira', 'draft work item', 'dismissed'],
889
942
  category: 'rovo',
890
943
  returns: {
@@ -896,7 +949,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
896
949
  name: 'useCreateDraftWorkItems',
897
950
  description: 'Creates eligible Jira draft work items and exposes action callbacks.',
898
951
  status: 'general-availability',
899
- usageGuidelines: ['Use to connect creation UI to the draft-work-item submission flow.'],
952
+ 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.'],
900
953
  keywords: ['rovo', 'jira', 'draft work item', 'create'],
901
954
  category: 'rovo',
902
955
  returns: {
@@ -908,7 +961,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
908
961
  name: 'useCreateIssuesSuccessFlags',
909
962
  description: 'Returns the success-flag action used after Jira work items are created.',
910
963
  status: 'general-availability',
911
- usageGuidelines: ['Use to show package-standard success feedback after creation.'],
964
+ 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.'],
912
965
  keywords: ['rovo', 'jira', 'create', 'flag'],
913
966
  category: 'rovo',
914
967
  returns: {
@@ -920,7 +973,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
920
973
  name: 'useDraftWorkItems',
921
974
  description: 'Returns the current draft work items and their controller state.',
922
975
  status: 'general-availability',
923
- usageGuidelines: ['Use as the main draft-work-item data source for creation UI.'],
976
+ 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.'],
924
977
  keywords: ['rovo', 'jira', 'draft work item', 'hook'],
925
978
  category: 'rovo',
926
979
  returns: {
@@ -932,7 +985,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
932
985
  name: 'useGetActiveOrFinishedDraftWorkItemsCount',
933
986
  description: 'Returns the number of active or completed draft work items for a message.',
934
987
  status: 'general-availability',
935
- usageGuidelines: ['Use for progress and summary counts in creation UI.'],
988
+ 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.'],
936
989
  keywords: ['rovo', 'jira', 'draft work item', 'count'],
937
990
  category: 'rovo',
938
991
  returns: {
@@ -944,7 +997,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
944
997
  name: 'useGetActivePlannedChildInvocationIdsByParent',
945
998
  description: 'Groups active planned child invocation identifiers by parent work item.',
946
999
  status: 'general-availability',
947
- usageGuidelines: ['Use when parent work-item state depends on active planned children.'],
1000
+ 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.'],
948
1001
  keywords: ['rovo', 'jira', 'draft work item', 'invocation'],
949
1002
  category: 'rovo',
950
1003
  returns: {
@@ -956,7 +1009,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
956
1009
  name: 'useGetDraftWorkItemsToCreate',
957
1010
  description: 'Returns the draft work items currently eligible for creation.',
958
1011
  status: 'general-availability',
959
- usageGuidelines: ['Use to build the payload submitted by a draft-work-item creation action.'],
1012
+ 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.'],
960
1013
  keywords: ['rovo', 'jira', 'draft work item', 'create'],
961
1014
  category: 'rovo',
962
1015
  returns: {
@@ -968,7 +1021,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
968
1021
  name: 'useGetDraftWorkItemsWithHierarchy',
969
1022
  description: 'Returns draft work items with their calculated parent-child hierarchy.',
970
1023
  status: 'general-availability',
971
- usageGuidelines: ['Use when rendering or validating hierarchical draft work items.'],
1024
+ 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.'],
972
1025
  keywords: ['rovo', 'jira', 'draft work item', 'hierarchy'],
973
1026
  category: 'rovo',
974
1027
  returns: {
@@ -980,7 +1033,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
980
1033
  name: 'useHasAppliedDraftEdits',
981
1034
  description: 'Reports whether edits have been applied to message-scoped draft work items.',
982
1035
  status: 'general-availability',
983
- usageGuidelines: ['Use to distinguish original drafts from user-edited drafts.'],
1036
+ 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.'],
984
1037
  keywords: ['rovo', 'jira', 'draft work item', 'edits'],
985
1038
  category: 'rovo',
986
1039
  returns: {
@@ -992,7 +1045,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
992
1045
  name: 'useRovoBridgeAPI',
993
1046
  description: 'Connects Jira draft-work-item creation to the Rovo bridge API.',
994
1047
  status: 'general-availability',
995
- usageGuidelines: ['Use where the creation flow exchanges state with a Rovo host.'],
1048
+ 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.'],
996
1049
  keywords: ['rovo', 'jira', 'bridge', 'api'],
997
1050
  category: 'rovo',
998
1051
  returns: {
@@ -1004,7 +1057,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1004
1057
  name: 'useValidateIssuesToCreate',
1005
1058
  description: 'Validates Jira draft work items before they are submitted for creation.',
1006
1059
  status: 'general-availability',
1007
- usageGuidelines: ['Use before enabling or invoking the create-work-items action.'],
1060
+ 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.'],
1008
1061
  keywords: ['rovo', 'jira', 'draft work item', 'validation'],
1009
1062
  category: 'rovo',
1010
1063
  returns: {
@@ -1252,11 +1305,19 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1252
1305
  category: 'rovo',
1253
1306
  package: '@atlassian/rovo-conversation-actions',
1254
1307
  examples: []
1308
+ }, {
1309
+ name: 'useCaseOptions',
1310
+ description: 'Public hook `useCaseOptions` from `@atlassian/rovo-conversation-actions/prompt-cards`.',
1311
+ status: 'general-availability',
1312
+ keywords: ['rovo', 'chat', 'ai', 'platform'],
1313
+ category: 'rovo',
1314
+ package: '@atlassian/rovo-conversation-actions',
1315
+ 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}"]
1255
1316
  }, {
1256
1317
  name: 'useConversationActionsStore',
1257
1318
  description: 'Reads selected Rovo conversation-action store state and actions.',
1258
1319
  status: 'general-availability',
1259
- usageGuidelines: ['Use for components that need a selected combination of conversation-action state and actions.'],
1320
+ 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.'],
1260
1321
  keywords: ['rovo', 'conversation actions', 'store', 'hook'],
1261
1322
  category: 'rovo',
1262
1323
  returns: {
@@ -1268,7 +1329,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1268
1329
  name: 'useConversationActionsStoreActions',
1269
1330
  description: 'Returns the mutation actions for the Rovo conversation-action store.',
1270
1331
  status: 'general-availability',
1271
- usageGuidelines: ['Use when a component updates conversation-action state without subscribing to values.'],
1332
+ 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.'],
1272
1333
  keywords: ['rovo', 'conversation actions', 'store', 'actions'],
1273
1334
  category: 'rovo',
1274
1335
  returns: {
@@ -1280,7 +1341,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1280
1341
  name: 'useConversationActionsStoreState',
1281
1342
  description: 'Returns the current Rovo conversation-action store state.',
1282
1343
  status: 'general-availability',
1283
- usageGuidelines: ['Use when a component reads conversation-action state without dispatching actions.'],
1344
+ 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.'],
1284
1345
  keywords: ['rovo', 'conversation actions', 'store', 'state'],
1285
1346
  category: 'rovo',
1286
1347
  returns: {
@@ -1297,15 +1358,6 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1297
1358
  category: 'rovo',
1298
1359
  package: '@atlassian/rovo-conversation-actions',
1299
1360
  examples: []
1300
- }, {
1301
- name: 'useCreatePromptInitialData',
1302
- description: 'Builds initial create-prompt form data for edit and duplicate flows.',
1303
- status: 'general-availability',
1304
- usageGuidelines: ['Pass only one source card; duplicate mode prefixes the copied title.'],
1305
- keywords: ['rovo', 'prompts', 'initial data', 'hook'],
1306
- category: 'rovo',
1307
- package: '@atlassian/rovo-conversation-actions',
1308
- examples: []
1309
1361
  }, {
1310
1362
  name: 'usePageContextType',
1311
1363
  description: 'Tracks browser navigation and returns the current Rovo page context.',
@@ -1315,11 +1367,19 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1315
1367
  category: 'rovo',
1316
1368
  package: '@atlassian/rovo-conversation-actions',
1317
1369
  examples: []
1370
+ }, {
1371
+ name: 'usePromptCards',
1372
+ description: 'Public hook `usePromptCards` from `@atlassian/rovo-conversation-actions/prompt-cards`.',
1373
+ status: 'general-availability',
1374
+ keywords: ['rovo', 'chat', 'ai', 'platform'],
1375
+ category: 'rovo',
1376
+ package: '@atlassian/rovo-conversation-actions',
1377
+ 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}"]
1318
1378
  }, {
1319
1379
  name: 'usePromptCards',
1320
1380
  description: 'Returns the prompt cards and prompt-library loading state available to the user.',
1321
1381
  status: 'general-availability',
1322
- usageGuidelines: ['Use when composing a custom Rovo prompt-library surface.'],
1382
+ 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.'],
1323
1383
  keywords: ['rovo', 'prompts', 'cards', 'hook'],
1324
1384
  category: 'rovo',
1325
1385
  returns: {
@@ -1331,7 +1391,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1331
1391
  name: 'useRovoConversationStarters',
1332
1392
  description: 'Selects Rovo conversation starters for the current page and product context.',
1333
1393
  status: 'general-availability',
1334
- usageGuidelines: ['Use when a Rovo chat surface needs contextual starter prompts.'],
1394
+ 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.'],
1335
1395
  keywords: ['rovo', 'conversation starters', 'context', 'hook'],
1336
1396
  category: 'rovo',
1337
1397
  returns: {
@@ -1343,7 +1403,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1343
1403
  name: 'useWindowLocation',
1344
1404
  description: 'Tracks browser history navigation and returns the full URL or pathname.',
1345
1405
  status: 'general-availability',
1346
- usageGuidelines: ['Use pathname mode when query and hash changes should not affect the consumer.'],
1406
+ 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.'],
1347
1407
  keywords: ['rovo', 'browser', 'location', 'hook'],
1348
1408
  category: 'rovo',
1349
1409
  package: '@atlassian/rovo-conversation-actions',
@@ -1397,7 +1457,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1397
1457
  name: 'useForYouNavigation',
1398
1458
  description: 'Returns the combined Rovo For You navigation state and actions.',
1399
1459
  status: 'general-availability',
1400
- usageGuidelines: ['Use when a component needs both the current For You view and navigation actions.'],
1460
+ usageGuidelines: [],
1401
1461
  keywords: ['rovo', 'for you', 'navigation', 'hook'],
1402
1462
  category: 'rovo',
1403
1463
  returns: {
@@ -1407,9 +1467,9 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1407
1467
  examples: []
1408
1468
  }, {
1409
1469
  name: 'useForYouNavigationActions',
1410
- description: 'Returns actions for changing Rovo For You navigation state.',
1470
+ description: 'Returns the reset action for Rovo For You navigation. The action is currently a no-op because only the threads-list view exists.',
1411
1471
  status: 'general-availability',
1412
- usageGuidelines: ['Use within ForYouNavigationProvider to navigate between For You views.'],
1472
+ usageGuidelines: [],
1413
1473
  keywords: ['rovo', 'for you', 'navigation', 'actions'],
1414
1474
  category: 'rovo',
1415
1475
  returns: {
@@ -1421,19 +1481,19 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1421
1481
  name: 'useForYouNavigationState',
1422
1482
  description: 'Reads the current Rovo For You navigation state.',
1423
1483
  status: 'general-availability',
1424
- usageGuidelines: ['Use within ForYouNavigationProvider when rendering the active internal view.'],
1484
+ usageGuidelines: [],
1425
1485
  keywords: ['rovo', 'for you', 'navigation', 'state'],
1426
1486
  category: 'rovo',
1427
1487
  returns: {
1428
1488
  type: 'ForYouNavigationState'
1429
1489
  },
1430
1490
  package: '@atlassian/rovo-for-you',
1431
- examples: []
1491
+ 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}"]
1432
1492
  }, {
1433
1493
  name: 'useFireInsightCardClicked',
1434
1494
  description: 'Returns portable analytics for Rovo Insight card clicks outside the feed lifecycle.',
1435
1495
  status: 'general-availability',
1436
- usageGuidelines: ['Use for Insight cards opened from external surfaces such as a home carousel.'],
1496
+ 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.'],
1437
1497
  keywords: ['rovo', 'insights', 'card', 'analytics'],
1438
1498
  category: 'rovo',
1439
1499
  returns: {
@@ -1457,7 +1517,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1457
1517
  name: 'useInsightsFeed',
1458
1518
  description: 'Loads and maps Rovo Insights data into feed-ready state.',
1459
1519
  status: 'general-availability',
1460
- usageGuidelines: ['Use when composing a custom surface from the standard Insights feed data lifecycle.'],
1520
+ 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.'],
1461
1521
  keywords: ['rovo', 'insights', 'feed', 'data'],
1462
1522
  category: 'rovo',
1463
1523
  returns: {
@@ -1469,7 +1529,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1469
1529
  name: 'useInsightsStatus',
1470
1530
  description: 'Loads the current availability and freshness status for Rovo Insights.',
1471
1531
  status: 'general-availability',
1472
- usageGuidelines: ['Use before presenting Insights UI that depends on backend availability or freshness.'],
1532
+ 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.'],
1473
1533
  keywords: ['rovo', 'insights', 'status', 'availability'],
1474
1534
  category: 'rovo',
1475
1535
  returns: {
@@ -1481,7 +1541,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1481
1541
  name: 'useReportInsightsBannerResolved',
1482
1542
  description: 'Resolves banner visibility and reports the decision once per mount.',
1483
1543
  status: 'general-availability',
1484
- usageGuidelines: ['Use when rendering an Insights banner so shown and hidden outcomes are observable.'],
1544
+ 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.'],
1485
1545
  keywords: ['rovo', 'insights', 'banner', 'analytics'],
1486
1546
  category: 'rovo',
1487
1547
  returns: {
@@ -1513,6 +1573,14 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1513
1573
  },
1514
1574
  package: '@atlassian/rovo-personalization',
1515
1575
  examples: []
1576
+ }, {
1577
+ name: 'usePinnedItems',
1578
+ description: 'Public hook `usePinnedItems` from `@atlassian/rovo-pins/store`.',
1579
+ status: 'general-availability',
1580
+ keywords: ['rovo', 'chat', 'ai', 'platform'],
1581
+ category: 'rovo',
1582
+ package: '@atlassian/rovo-pins',
1583
+ 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}"]
1516
1584
  }, {
1517
1585
  name: 'useInfiniteScroll',
1518
1586
  description: 'Coordinates loading more inline-browse results when a scroll sentinel enters view.',
@@ -1546,11 +1614,20 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1546
1614
  category: 'rovo',
1547
1615
  package: '@atlassian/rovo-prompt-of-the-day',
1548
1616
  examples: []
1617
+ }, {
1618
+ name: 'usePromptOfTheDayWithFallback',
1619
+ 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.',
1620
+ status: 'general-availability',
1621
+ 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.'],
1622
+ keywords: ['rovo', 'prompt of the day', 'suggestions', 'cache', 'fallback', 'stale'],
1623
+ category: 'rovo',
1624
+ package: '@atlassian/rovo-prompt-of-the-day',
1625
+ examples: []
1549
1626
  }, {
1550
1627
  name: 'useIsRovoSettingsModalProviderMounted',
1551
1628
  description: 'Reports whether a Rovo settings modal provider is mounted above the caller.',
1552
1629
  status: 'general-availability',
1553
- usageGuidelines: ['Use to avoid rendering controls that require an unavailable settings provider.'],
1630
+ usageGuidelines: ['Check this before showing controls that require RovoSettingsModalProvider. It reports whether the component is within that provider.'],
1554
1631
  keywords: ['rovo', 'settings', 'provider', 'hook'],
1555
1632
  category: 'rovo',
1556
1633
  returns: {
@@ -1562,31 +1639,31 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1562
1639
  name: 'useRovoSettingsConfig',
1563
1640
  description: 'Reads the configuration supplied for the current Rovo settings experience.',
1564
1641
  status: 'general-availability',
1565
- usageGuidelines: ['Use below RovoSettingsConfigProvider to access host-specific settings configuration.'],
1642
+ usageGuidelines: ['Read the product, site, and settings configuration from the nearest provider. RovoSettingsModalProvider supplies these values for the standard settings flow.'],
1566
1643
  keywords: ['rovo', 'settings', 'config', 'hook'],
1567
1644
  category: 'rovo',
1568
1645
  returns: {
1569
1646
  type: 'RovoSettingsConfig'
1570
1647
  },
1571
1648
  package: '@atlassian/rovo-settings-modal',
1572
- examples: []
1649
+ 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}"]
1573
1650
  }, {
1574
1651
  name: 'useRovoSettingsModal',
1575
1652
  description: 'Returns controls for opening and closing the nearest Rovo settings modal.',
1576
1653
  status: 'general-availability',
1577
- usageGuidelines: ['Use within RovoSettingsModalProvider to trigger settings from product UI.'],
1654
+ usageGuidelines: ['Call this hook within RovoSettingsModalProvider. Use RovoSettingsModal when your app has no provider and only needs a trigger to open settings.'],
1578
1655
  keywords: ['rovo', 'settings', 'modal', 'hook'],
1579
1656
  category: 'rovo',
1580
1657
  returns: {
1581
1658
  type: '{ open: (options?: RovoSettingsModalOpenOptions) => void; close: () => void }'
1582
1659
  },
1583
1660
  package: '@atlassian/rovo-settings-modal',
1584
- examples: []
1661
+ 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}"]
1585
1662
  }, {
1586
1663
  name: 'useAddSpaceSource',
1587
1664
  description: 'Adds a source to a space and mirrors the successful result into the space store.',
1588
1665
  status: 'general-availability',
1589
- usageGuidelines: ['Use when a React surface lets people attach a source to a space.'],
1666
+ 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.'],
1590
1667
  keywords: ['rovo', 'spaces', 'source', 'mutation'],
1591
1668
  category: 'rovo',
1592
1669
  returns: {
@@ -1598,7 +1675,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1598
1675
  name: 'useCreateSpace',
1599
1676
  description: 'Creates a Rovo space and exposes mutation, submission, and error state.',
1600
1677
  status: 'general-availability',
1601
- usageGuidelines: ['Use to connect a custom creation interface to the space service.'],
1678
+ 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.'],
1602
1679
  keywords: ['rovo', 'spaces', 'create', 'mutation'],
1603
1680
  category: 'rovo',
1604
1681
  returns: {
@@ -1610,7 +1687,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1610
1687
  name: 'useDeleteSpace',
1611
1688
  description: 'Deletes a space with optimistic store removal and rollback on failure.',
1612
1689
  status: 'general-availability',
1613
- usageGuidelines: ['Use to connect a deletion confirmation flow to the space service.'],
1690
+ 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.'],
1614
1691
  keywords: ['rovo', 'spaces', 'delete', 'mutation'],
1615
1692
  category: 'rovo',
1616
1693
  returns: {
@@ -1622,7 +1699,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1622
1699
  name: 'useDeleteSpaceSource',
1623
1700
  description: 'Removes a source from a space and mirrors the deletion into the space store.',
1624
1701
  status: 'general-availability',
1625
- usageGuidelines: ['Use when a React surface lets people detach a source from a space.'],
1702
+ 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.'],
1626
1703
  keywords: ['rovo', 'spaces', 'source', 'delete'],
1627
1704
  category: 'rovo',
1628
1705
  returns: {
@@ -1634,14 +1711,14 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1634
1711
  name: 'useSpaceSourcePlugins',
1635
1712
  description: 'Creates the Link Picker plugins used to select supported space sources.',
1636
1713
  status: 'general-availability',
1637
- usageGuidelines: ['Use to configure a space source Link Picker for the current cloud.'],
1714
+ 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.'],
1638
1715
  keywords: ['rovo', 'spaces', 'source', 'link picker'],
1639
1716
  category: 'rovo',
1640
1717
  returns: {
1641
1718
  type: 'LinkPickerPlugin[]'
1642
1719
  },
1643
1720
  package: '@atlassian/rovo-spaces',
1644
- examples: []
1721
+ 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}"]
1645
1722
  }, {
1646
1723
  name: 'useActionInvocationStatuses',
1647
1724
  description: 'Returns live action-invocation statuses for a set of Rovo plan steps.',
@@ -1748,7 +1825,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1748
1825
  name: 'useRovoProjectCreationCategories',
1749
1826
  description: 'Returns localized feedback categories for Rovo project creation.',
1750
1827
  status: 'general-availability',
1751
- usageGuidelines: ['Use to keep project-creation feedback categories consistent across entry points.'],
1828
+ usageGuidelines: ['Use to show the same translated project-creation categories as SmartCreateFeedback.', 'Display the translated labels and save the stable category IDs with feedback.'],
1752
1829
  keywords: ['rovo', 'project creation', 'feedback', 'categories'],
1753
1830
  category: 'rovo',
1754
1831
  returns: {
@@ -1760,7 +1837,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1760
1837
  name: 'useCurrentDisplayMessage',
1761
1838
  description: 'Returns the assistant message currently selected by preview history.',
1762
1839
  status: 'general-availability',
1763
- usageGuidelines: ['Use when a preview must follow the current undo or redo position.'],
1840
+ 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.'],
1764
1841
  keywords: ['rovo', 'smart creation', 'message', 'history'],
1765
1842
  category: 'rovo',
1766
1843
  returns: {
@@ -1796,7 +1873,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1796
1873
  name: 'useLatestActionMessage',
1797
1874
  description: 'Returns the latest Smart Creation action messages and preview statuses.',
1798
1875
  status: 'general-availability',
1799
- usageGuidelines: ['Use to derive current create, update, and ask-question action state.'],
1876
+ 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.'],
1800
1877
  keywords: ['rovo', 'smart creation', 'action', 'message'],
1801
1878
  category: 'rovo',
1802
1879
  returns: {
@@ -1808,7 +1885,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1808
1885
  name: 'useSelectedPreview',
1809
1886
  description: 'Returns the message, content, title, and status selected for preview.',
1810
1887
  status: 'general-availability',
1811
- usageGuidelines: ['Use when a staging area follows the user-selected creation action.'],
1888
+ 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.'],
1812
1889
  keywords: ['rovo', 'smart creation', 'selected preview', 'message'],
1813
1890
  category: 'rovo',
1814
1891
  returns: {
@@ -1820,7 +1897,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1820
1897
  name: 'useStagingAreaContext',
1821
1898
  description: 'Returns the current Smart Creation staging-area context.',
1822
1899
  status: 'general-availability',
1823
- usageGuidelines: ['Call inside StagingAreaContextProvider-backed components.'],
1900
+ usageGuidelines: ['Call within StagingAreaContextProvider. Read the selected preview and status from the current conversation instead of keeping another copy in component state.'],
1824
1901
  keywords: ['rovo', 'smart creation', 'staging area', 'context'],
1825
1902
  category: 'rovo',
1826
1903
  returns: {
@@ -1832,7 +1909,7 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1832
1909
  name: 'useUndoRedoHistory',
1833
1910
  description: 'Builds undo and redo navigation from ephemeral creation-action messages.',
1834
1911
  status: 'general-availability',
1835
- usageGuidelines: ['Use when a preview supports navigating previous generated versions.'],
1912
+ 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.'],
1836
1913
  keywords: ['rovo', 'smart creation', 'undo', 'redo'],
1837
1914
  category: 'rovo',
1838
1915
  returns: {
@@ -1858,16 +1935,139 @@ var atlaskitHooks = exports.atlaskitHooks = [{
1858
1935
  category: 'rovo',
1859
1936
  package: '@atlassian/store-rovo',
1860
1937
  examples: []
1938
+ }, {
1939
+ name: 'useBrowseAgentCategoryUpdates',
1940
+ description: 'Public hook `useBrowseAgentCategoryUpdates` exported by `@atlassian/studio-agent-browse/ui/browse-agent/useBrowseAgentCategoryUpdates`.',
1941
+ status: 'general-availability',
1942
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
1943
+ keywords: ['studio', 'rovo', 'agent'],
1944
+ category: 'studio',
1945
+ package: '@atlassian/studio-agent-browse',
1946
+ examples: []
1861
1947
  }, {
1862
1948
  name: 'useBrowseAgentView',
1863
- description: 'Returns controls for opening and closing nested views in the Rovo agent browser.',
1949
+ description: 'Public hook `useBrowseAgentView` exported by `@atlassian/studio-agent-browse/browse-agent/use-browse-agent-view`.',
1864
1950
  status: 'general-availability',
1865
- usageGuidelines: ['Use within BrowseAgentView to open agent, template, or other nested detail content.'],
1866
- keywords: ['rovo', 'agent', 'browse', 'hook'],
1867
- category: 'rovo',
1868
- returns: {
1869
- type: 'ReturnType<typeof useBrowseAgentView>'
1870
- },
1871
- package: '@atlassian/studio-browse-kit',
1951
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
1952
+ keywords: ['studio', 'rovo', 'agent'],
1953
+ category: 'studio',
1954
+ package: '@atlassian/studio-agent-browse',
1955
+ examples: []
1956
+ }, {
1957
+ name: 'useAgentKnowledgeSourcesMutation',
1958
+ description: 'Public hook `useAgentKnowledgeSourcesMutation` exported by `@atlassian/studio-agent-editor/domains/knowledge-sources/mutations`.',
1959
+ status: 'general-availability',
1960
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
1961
+ keywords: ['studio', 'rovo', 'agent'],
1962
+ category: 'studio',
1963
+ package: '@atlassian/studio-agent-editor',
1964
+ examples: []
1965
+ }, {
1966
+ name: 'useAgentSkillsMutation',
1967
+ description: 'Public hook `useAgentSkillsMutation` exported by `@atlassian/studio-agent-editor/domains/skills/mutations`.',
1968
+ status: 'general-availability',
1969
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
1970
+ keywords: ['studio', 'rovo', 'agent'],
1971
+ category: 'studio',
1972
+ package: '@atlassian/studio-agent-editor',
1973
+ examples: []
1974
+ }, {
1975
+ name: 'useAgentToolConfigurationMutation',
1976
+ description: 'Public hook `useAgentToolConfigurationMutation` exported by `@atlassian/studio-agent-editor/domains/tools/mutations`.',
1977
+ status: 'general-availability',
1978
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
1979
+ keywords: ['studio', 'rovo', 'agent'],
1980
+ category: 'studio',
1981
+ package: '@atlassian/studio-agent-editor',
1982
+ examples: []
1983
+ }, {
1984
+ name: 'useAgentToolsMutation',
1985
+ description: 'Public hook `useAgentToolsMutation` exported by `@atlassian/studio-agent-editor/domains/tools/mutations`.',
1986
+ status: 'general-availability',
1987
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
1988
+ keywords: ['studio', 'rovo', 'agent'],
1989
+ category: 'studio',
1990
+ package: '@atlassian/studio-agent-editor',
1991
+ examples: []
1992
+ }, {
1993
+ name: 'useKnowledgeSourcesUpdater',
1994
+ description: 'Public hook `useKnowledgeSourcesUpdater` exported by `@atlassian/studio-agent-editor/domains/knowledge-sources/updaters`.',
1995
+ status: 'general-availability',
1996
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
1997
+ keywords: ['studio', 'rovo', 'agent'],
1998
+ category: 'studio',
1999
+ package: '@atlassian/studio-agent-editor',
2000
+ examples: []
2001
+ }, {
2002
+ name: 'useScenarioToolsMutation',
2003
+ description: 'Public hook `useScenarioToolsMutation` exported by `@atlassian/studio-agent-editor/domains/tools/mutations`.',
2004
+ status: 'general-availability',
2005
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
2006
+ keywords: ['studio', 'rovo', 'agent'],
2007
+ category: 'studio',
2008
+ package: '@atlassian/studio-agent-editor',
2009
+ examples: []
2010
+ }, {
2011
+ name: 'useSkillsUpdater',
2012
+ description: 'Public hook `useSkillsUpdater` exported by `@atlassian/studio-agent-editor/domains/skills/updaters`.',
2013
+ status: 'general-availability',
2014
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
2015
+ keywords: ['studio', 'rovo', 'agent'],
2016
+ category: 'studio',
2017
+ package: '@atlassian/studio-agent-editor',
2018
+ examples: []
2019
+ }, {
2020
+ name: 'useToolConfigurationUpdater',
2021
+ description: 'Public hook `useToolConfigurationUpdater` exported by `@atlassian/studio-agent-editor/domains/tools/updaters`.',
2022
+ status: 'general-availability',
2023
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
2024
+ keywords: ['studio', 'rovo', 'agent'],
2025
+ category: 'studio',
2026
+ package: '@atlassian/studio-agent-editor',
2027
+ examples: []
2028
+ }, {
2029
+ name: 'useToolsUpdater',
2030
+ description: 'Public hook `useToolsUpdater` exported by `@atlassian/studio-agent-editor/domains/tools/updaters`.',
2031
+ status: 'general-availability',
2032
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
2033
+ keywords: ['studio', 'rovo', 'agent'],
2034
+ category: 'studio',
2035
+ package: '@atlassian/studio-agent-editor',
2036
+ examples: []
2037
+ }, {
2038
+ name: 'useUpdateAgentDetailsMutation',
2039
+ description: 'Public hook `useUpdateAgentDetailsMutation` exported by `@atlassian/studio-agent-editor/domains/agent-details/mutations`.',
2040
+ status: 'general-availability',
2041
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
2042
+ keywords: ['studio', 'rovo', 'agent'],
2043
+ category: 'studio',
2044
+ package: '@atlassian/studio-agent-editor',
2045
+ examples: []
2046
+ }, {
2047
+ name: 'useAgentProfileViewNavigation',
2048
+ description: 'Public hook `useAgentProfileViewNavigation` exported by `@atlassian/studio-agent-profile/ui/agent-profile/components/AgentProfileViewNavigationProvider`.',
2049
+ status: 'general-availability',
2050
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
2051
+ keywords: ['studio', 'rovo', 'agent'],
2052
+ category: 'studio',
2053
+ package: '@atlassian/studio-agent-profile',
2054
+ examples: []
2055
+ }, {
2056
+ name: 'useAvailableConfigsByTier',
2057
+ description: 'Public hook `useAvailableConfigsByTier` exported by `@atlassian/studio-agent-profile/agent-reasoning/use-available-configs-by-tier`.',
2058
+ status: 'general-availability',
2059
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
2060
+ keywords: ['studio', 'rovo', 'agent'],
2061
+ category: 'studio',
2062
+ package: '@atlassian/studio-agent-profile',
2063
+ examples: []
2064
+ }, {
2065
+ name: 'useVisibleExecutionTierOptions',
2066
+ description: 'Public hook `useVisibleExecutionTierOptions` exported by `@atlassian/studio-agent-profile/agent-reasoning/use-visible-execution-tier-options`.',
2067
+ status: 'general-availability',
2068
+ usageGuidelines: ['Import from this explicit public entrypoint rather than a source-internal path.', 'Keep host lifecycle, permissions, and network orchestration at the integration boundary.'],
2069
+ keywords: ['studio', 'rovo', 'agent'],
2070
+ category: 'studio',
2071
+ package: '@atlassian/studio-agent-profile',
1872
2072
  examples: []
1873
2073
  }];