@atlaskit/ads-mcp 1.11.9 → 1.12.0

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 (33) hide show
  1. package/CHANGELOG.md +20 -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-components/list-get-atlaskit-components-tool.js +1 -1
  5. package/dist/cjs/tools/get-atlaskit-hooks/atlaskit-hooks.codegen.js +55 -7
  6. package/dist/cjs/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.js +2 -2
  7. package/dist/cjs/tools/search-atlaskit-components/list-search-atlaskit-components-tool.js +1 -1
  8. package/dist/cjs/tools/search-atlaskit-components/search-atlaskit-components-tool.js +1 -0
  9. package/dist/cjs/tools/search-components/list-search-components-tool.js +1 -1
  10. package/dist/cjs/tools/search-components/search-components-tool.js +1 -1
  11. package/dist/es2019/tools/get-all-components/components.codegen.js +2 -2
  12. package/dist/es2019/tools/get-atlaskit-components/atlaskit-components.codegen.js +2 -2
  13. package/dist/es2019/tools/get-atlaskit-components/list-get-atlaskit-components-tool.js +4 -2
  14. package/dist/es2019/tools/get-atlaskit-hooks/atlaskit-hooks.codegen.js +55 -7
  15. package/dist/es2019/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.js +2 -2
  16. package/dist/es2019/tools/search-atlaskit-components/list-search-atlaskit-components-tool.js +2 -2
  17. package/dist/es2019/tools/search-atlaskit-components/search-atlaskit-components-tool.js +1 -0
  18. package/dist/es2019/tools/search-components/list-search-components-tool.js +1 -1
  19. package/dist/es2019/tools/search-components/search-components-tool.js +1 -1
  20. package/dist/esm/tools/get-all-components/components.codegen.js +2 -2
  21. package/dist/esm/tools/get-atlaskit-components/atlaskit-components.codegen.js +2 -2
  22. package/dist/esm/tools/get-atlaskit-components/list-get-atlaskit-components-tool.js +1 -1
  23. package/dist/esm/tools/get-atlaskit-hooks/atlaskit-hooks.codegen.js +55 -7
  24. package/dist/esm/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.js +2 -2
  25. package/dist/esm/tools/search-atlaskit-components/list-search-atlaskit-components-tool.js +1 -1
  26. package/dist/esm/tools/search-atlaskit-components/search-atlaskit-components-tool.js +1 -0
  27. package/dist/esm/tools/search-components/list-search-components-tool.js +1 -1
  28. package/dist/esm/tools/search-components/search-components-tool.js +1 -1
  29. package/dist/types/tools/get-all-components/components.codegen.d.ts +1 -1
  30. package/dist/types/tools/get-atlaskit-components/atlaskit-components.codegen.d.ts +1 -1
  31. package/dist/types/tools/get-atlaskit-hooks/atlaskit-hooks.codegen.d.ts +1 -1
  32. package/dist/types/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.d.ts +1 -1
  33. package/package.json +2 -2
@@ -4,10 +4,12 @@ import { z } from 'zod';
4
4
  import { zodToJsonSchema } from '../../helpers';
5
5
  export const listGetAtlaskitComponentsTool = {
6
6
  name: 'atlaskit_get_components',
7
- description: `Returns a compact inventory of public \`@atlaskit/*\` component packages that are not covered by the Atlassian Design System (ADS) component catalog. Output is names and packages only.
7
+ description: `Returns a compact inventory of public \`@atlaskit/*\` and internal \`@atlassian/*\` Platform component packages that are not covered by the Atlassian Design System (ADS) component catalog. Output is names and packages only.
8
8
 
9
9
  WHEN TO USE:
10
- Use this for fallback discovery after ADS component search is not enough, or when you need to see which non-ADS \`@atlaskit/*\` components are available without the full metadata payload. For implementation examples and props, use \`atlaskit_search_components\`.
10
+ Use this for fallback discovery after ADS component search is not enough, or when you need to see which non-ADS components are available without the full metadata payload. For implementation examples and props, use \`atlaskit_search_components\`.
11
+
12
+ Internal Atlassian packages are not available for use outside Atlassian.
11
13
 
12
14
  No parameters.`,
13
15
  annotations: {
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Structured content hooks from design-system *.docs.tsx files
5
5
  *
6
- * @codegen <<SignedSource::3a2fe9a9152f31ebddcf3fa6102ec30b>>
6
+ * @codegen <<SignedSource::569e2db73fed31893c8123b061d19745>>
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 */
@@ -1612,7 +1612,7 @@ export const atlaskitHooks = [{
1612
1612
  name: 'usePromptOfTheDayWithFallback',
1613
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
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.'],
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. Removing the last one asks for new suggestions, which show on the next mount; after a failed request the page does not ask again until it reloads.', 'The hook reads the shared entry when it mounts. A surface that stays mounted can call readStoredPromptsOfTheDay as it opens to see changes made since.'],
1616
1616
  keywords: ['rovo', 'prompt of the day', 'suggestions', 'cache', 'fallback', 'stale'],
1617
1617
  category: 'rovo',
1618
1618
  package: '@atlassian/rovo-prompt-of-the-day',
@@ -2048,20 +2048,68 @@ export const atlaskitHooks = [{
2048
2048
  examples: []
2049
2049
  }, {
2050
2050
  name: 'useAvailableConfigsByTier',
2051
- description: 'Public hook `useAvailableConfigsByTier` exported by `@atlassian/studio-agent-profile/agent-reasoning/use-available-configs-by-tier`.',
2051
+ description: 'Public hook `useAvailableConfigsByTier` exported by `@atlassian/studio-browse-kit/agent-reasoning/use-available-configs-by-tier`.',
2052
2052
  status: 'general-availability',
2053
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
2054
  keywords: ['studio', 'rovo', 'agent'],
2055
2055
  category: 'studio',
2056
- package: '@atlassian/studio-agent-profile',
2056
+ package: '@atlassian/studio-browse-kit',
2057
2057
  examples: []
2058
2058
  }, {
2059
2059
  name: 'useVisibleExecutionTierOptions',
2060
- description: 'Public hook `useVisibleExecutionTierOptions` exported by `@atlassian/studio-agent-profile/agent-reasoning/use-visible-execution-tier-options`.',
2060
+ description: 'Public hook `useVisibleExecutionTierOptions` exported by `@atlassian/studio-browse-kit/agent-reasoning/use-visible-execution-tier-options`.',
2061
2061
  status: 'general-availability',
2062
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
2063
  keywords: ['studio', 'rovo', 'agent'],
2064
2064
  category: 'studio',
2065
- package: '@atlassian/studio-agent-profile',
2066
- examples: []
2065
+ package: '@atlassian/studio-browse-kit',
2066
+ examples: []
2067
+ }, {
2068
+ name: 'useCloseCurrentPanel',
2069
+ description: 'For internal Atlassian use only: Get a callback that closes the current panel inside LayoutWithPanel or PanelsRenderer. Internal Atlassian package; not available for use outside Atlassian.',
2070
+ status: 'open-beta',
2071
+ keywords: ['panel', 'context', 'state', 'close', 'open'],
2072
+ category: 'layout',
2073
+ package: '@atlassian/panel-system',
2074
+ examples: ["import Button from '@atlaskit/button/default/button';\nimport { Main } from '@atlaskit/navigation-system/layout/main';\nimport { PanelLayout } from '@atlaskit/navigation-system/layout/panel-layout';\nimport { Root } from '@atlaskit/navigation-system/layout/root';\nimport { Text } from '@atlaskit/primitives/compiled/text';\nimport { PanelActionClose } from '@atlassian/panel-system/panel-action/close';\nimport { PanelActionGroup } from '@atlassian/panel-system/panel-action/group';\nimport { PanelBody } from '@atlassian/panel-system/panel-body';\nimport { PanelContainer } from '@atlassian/panel-system/panel-container';\nimport { PanelContent } from '@atlassian/panel-system/panel-content';\nimport { useCloseCurrentPanel, useCurrentPanel } from '@atlassian/panel-system/panel-context';\nimport { PanelDisclaimer } from '@atlassian/panel-system/panel-disclaimer';\nimport { PanelFooter } from '@atlassian/panel-system/panel-footer';\nimport { PanelHeader } from '@atlassian/panel-system/panel-header';\nimport { usePanelManager } from '@atlassian/panel-system/panel-manager';\nimport { PanelProvider } from '@atlassian/panel-system/panel-provider';\nimport { PanelRouter } from '@atlassian/panel-system/panel-router';\nimport { PanelTitle } from '@atlassian/panel-system/panel-title';\nimport { PanelsRenderer } from '@atlassian/panel-system/panels-renderer';\nfunction ProjectSummary() {\n\tconst panel = useCurrentPanel<{ summary: string }>();\n\tconst closePanel = useCloseCurrentPanel();\n\treturn (\n\t\t<PanelContainer>\n\t\t\t<PanelHeader>\n\t\t\t\t<PanelTitle>Project summary</PanelTitle>\n\t\t\t\t<PanelActionGroup>\n\t\t\t\t\t<PanelActionClose label=\"Close project summary\" onClick={closePanel} />\n\t\t\t\t</PanelActionGroup>\n\t\t\t</PanelHeader>\n\t\t\t<PanelContent>\n\t\t\t\t<PanelBody>\n\t\t\t\t\t<Text as=\"p\">{panel.params.summary}</Text>\n\t\t\t\t</PanelBody>\n\t\t\t</PanelContent>\n\t\t\t<PanelFooter\n\t\t\t\tdisclaimer={\n\t\t\t\t\t<PanelDisclaimer>AI-generated content. Verify important details.</PanelDisclaimer>\n\t\t\t\t}\n\t\t\t>\n\t\t\t\t<Button onClick={closePanel}>Done</Button>\n\t\t\t</PanelFooter>\n\t\t</PanelContainer>\n\t);\n}\nfunction ProjectContent() {\n\tconst { state, manager } = usePanelManager();\n\treturn (\n\t\t<PanelLayout\n\t\t\tisPanelOpen={state.activePanel !== null}\n\t\t\tpanelKey={state.activePanel?.instanceId}\n\t\t\tpanelLabel=\"Project summary\"\n\t\t\tresizeLabel=\"Resize project summary\"\n\t\t\tpanel={\n\t\t\t\t<PanelsRenderer>\n\t\t\t\t\t<PanelRouter />\n\t\t\t\t</PanelsRenderer>\n\t\t\t}\n\t\t>\n\t\t\t<Button\n\t\t\t\tonClick={() =>\n\t\t\t\t\tmanager.openPanel({\n\t\t\t\t\t\tinstanceId: 'project-summary',\n\t\t\t\t\t\tparams: {\n\t\t\t\t\t\t\tsummary:\n\t\t\t\t\t\t\t\t'The release checklist is ready for review. Two work items remain in progress.',\n\t\t\t\t\t\t},\n\t\t\t\t\t\tpanelContent: <ProjectSummary />,\n\t\t\t\t\t})\n\t\t\t\t}\n\t\t\t>\n\t\t\t\tView project summary\n\t\t\t</Button>\n\t\t</PanelLayout>\n\t);\n}\n// Internal Atlassian package. Prefer LayoutWithPanel for the standard integration.\n// Use this composition when the app needs to own its PanelLayout and PanelRouter.\nexport default function CustomRenderingExample(): React.JSX.Element {\n\treturn (\n\t\t<PanelProvider>\n\t\t\t<Root>\n\t\t\t\t<Main>\n\t\t\t\t\t<ProjectContent />\n\t\t\t\t</Main>\n\t\t\t</Root>\n\t\t</PanelProvider>\n\t);\n}"]
2075
+ }, {
2076
+ name: 'useCurrentPanel',
2077
+ description: 'For internal Atlassian use only: Read the current panel and typed runtime parameters inside LayoutWithPanel or PanelsRenderer. Internal Atlassian package; not available for use outside Atlassian.',
2078
+ status: 'open-beta',
2079
+ keywords: ['panel', 'context', 'state', 'close', 'open'],
2080
+ category: 'layout',
2081
+ package: '@atlassian/panel-system',
2082
+ examples: ["import Button from '@atlaskit/button/default/button';\nimport { Main } from '@atlaskit/navigation-system/layout/main';\nimport { PanelLayout } from '@atlaskit/navigation-system/layout/panel-layout';\nimport { Root } from '@atlaskit/navigation-system/layout/root';\nimport { Text } from '@atlaskit/primitives/compiled/text';\nimport { PanelActionClose } from '@atlassian/panel-system/panel-action/close';\nimport { PanelActionGroup } from '@atlassian/panel-system/panel-action/group';\nimport { PanelBody } from '@atlassian/panel-system/panel-body';\nimport { PanelContainer } from '@atlassian/panel-system/panel-container';\nimport { PanelContent } from '@atlassian/panel-system/panel-content';\nimport { useCloseCurrentPanel, useCurrentPanel } from '@atlassian/panel-system/panel-context';\nimport { PanelDisclaimer } from '@atlassian/panel-system/panel-disclaimer';\nimport { PanelFooter } from '@atlassian/panel-system/panel-footer';\nimport { PanelHeader } from '@atlassian/panel-system/panel-header';\nimport { usePanelManager } from '@atlassian/panel-system/panel-manager';\nimport { PanelProvider } from '@atlassian/panel-system/panel-provider';\nimport { PanelRouter } from '@atlassian/panel-system/panel-router';\nimport { PanelTitle } from '@atlassian/panel-system/panel-title';\nimport { PanelsRenderer } from '@atlassian/panel-system/panels-renderer';\nfunction ProjectSummary() {\n\tconst panel = useCurrentPanel<{ summary: string }>();\n\tconst closePanel = useCloseCurrentPanel();\n\treturn (\n\t\t<PanelContainer>\n\t\t\t<PanelHeader>\n\t\t\t\t<PanelTitle>Project summary</PanelTitle>\n\t\t\t\t<PanelActionGroup>\n\t\t\t\t\t<PanelActionClose label=\"Close project summary\" onClick={closePanel} />\n\t\t\t\t</PanelActionGroup>\n\t\t\t</PanelHeader>\n\t\t\t<PanelContent>\n\t\t\t\t<PanelBody>\n\t\t\t\t\t<Text as=\"p\">{panel.params.summary}</Text>\n\t\t\t\t</PanelBody>\n\t\t\t</PanelContent>\n\t\t\t<PanelFooter\n\t\t\t\tdisclaimer={\n\t\t\t\t\t<PanelDisclaimer>AI-generated content. Verify important details.</PanelDisclaimer>\n\t\t\t\t}\n\t\t\t>\n\t\t\t\t<Button onClick={closePanel}>Done</Button>\n\t\t\t</PanelFooter>\n\t\t</PanelContainer>\n\t);\n}\nfunction ProjectContent() {\n\tconst { state, manager } = usePanelManager();\n\treturn (\n\t\t<PanelLayout\n\t\t\tisPanelOpen={state.activePanel !== null}\n\t\t\tpanelKey={state.activePanel?.instanceId}\n\t\t\tpanelLabel=\"Project summary\"\n\t\t\tresizeLabel=\"Resize project summary\"\n\t\t\tpanel={\n\t\t\t\t<PanelsRenderer>\n\t\t\t\t\t<PanelRouter />\n\t\t\t\t</PanelsRenderer>\n\t\t\t}\n\t\t>\n\t\t\t<Button\n\t\t\t\tonClick={() =>\n\t\t\t\t\tmanager.openPanel({\n\t\t\t\t\t\tinstanceId: 'project-summary',\n\t\t\t\t\t\tparams: {\n\t\t\t\t\t\t\tsummary:\n\t\t\t\t\t\t\t\t'The release checklist is ready for review. Two work items remain in progress.',\n\t\t\t\t\t\t},\n\t\t\t\t\t\tpanelContent: <ProjectSummary />,\n\t\t\t\t\t})\n\t\t\t\t}\n\t\t\t>\n\t\t\t\tView project summary\n\t\t\t</Button>\n\t\t</PanelLayout>\n\t);\n}\n// Internal Atlassian package. Prefer LayoutWithPanel for the standard integration.\n// Use this composition when the app needs to own its PanelLayout and PanelRouter.\nexport default function CustomRenderingExample(): React.JSX.Element {\n\treturn (\n\t\t<PanelProvider>\n\t\t\t<Root>\n\t\t\t\t<Main>\n\t\t\t\t\t<ProjectContent />\n\t\t\t\t</Main>\n\t\t\t</Root>\n\t\t</PanelProvider>\n\t);\n}"]
2083
+ }, {
2084
+ name: 'usePanel',
2085
+ description: 'For internal Atlassian use only: Read the current panel and its close function inside the context supplied by LayoutWithPanel or PanelsRenderer. Internal Atlassian package; not available for use outside Atlassian.',
2086
+ status: 'open-beta',
2087
+ keywords: ['panel', 'context', 'state', 'close', 'open'],
2088
+ category: 'layout',
2089
+ package: '@atlassian/panel-system',
2090
+ examples: ["import React, { useState } from 'react';\nimport Button from '@atlaskit/button/default/button';\nimport { Main } from '@atlaskit/navigation-system/layout/main';\nimport { Root } from '@atlaskit/navigation-system/layout/root';\nimport { Stack } from '@atlaskit/primitives/compiled/stack';\nimport { Text } from '@atlaskit/primitives/compiled/text';\nimport { LayoutWithPanel } from '@atlassian/panel-system/layout-with-panel';\nimport { PanelActionCloseSmart } from '@atlassian/panel-system/panel-action/close-smart';\nimport { PanelActionGroup } from '@atlassian/panel-system/panel-action/group';\nimport { PanelActionNewTab } from '@atlassian/panel-system/panel-action/new-tab';\nimport { PanelBody } from '@atlassian/panel-system/panel-body';\nimport { PanelContainer } from '@atlassian/panel-system/panel-container';\nimport { PanelContent } from '@atlassian/panel-system/panel-content';\nimport { usePanel } from '@atlassian/panel-system/panel-context';\nimport { PanelFooter } from '@atlassian/panel-system/panel-footer';\nimport { PanelHeader } from '@atlassian/panel-system/panel-header';\nimport { usePanelActions, usePanelState } from '@atlassian/panel-system/panel-manager';\nimport { PanelProvider } from '@atlassian/panel-system/panel-provider';\nimport { PanelSubheader } from '@atlassian/panel-system/panel-subheader';\nimport { PanelTitle } from '@atlassian/panel-system/panel-title';\nimport { SubheaderInlineEdit } from '@atlassian/panel-system/subheader-inline-edit';\nfunction WorkItemDetails() {\n\tconst { panel, closePanel } = usePanel<{ title: string }>();\n\tconst [title, setTitle] = useState(panel.params.title);\n\treturn (\n\t\t<PanelContainer>\n\t\t\t<PanelHeader>\n\t\t\t\t<PanelTitle>Work item</PanelTitle>\n\t\t\t\t<PanelActionGroup>\n\t\t\t\t\t<PanelActionNewTab href=\"/browse/PROJ-42\" label=\"Open work item in a new tab\" />\n\t\t\t\t\t<PanelActionCloseSmart label=\"Close work item\" />\n\t\t\t\t</PanelActionGroup>\n\t\t\t</PanelHeader>\n\t\t\t<PanelContent>\n\t\t\t\t<PanelSubheader\n\t\t\t\t\ttitle={title}\n\t\t\t\t\tinlineEdit={\n\t\t\t\t\t\t<SubheaderInlineEdit\n\t\t\t\t\t\t\tdefaultValue={title}\n\t\t\t\t\t\t\tplaceholder=\"Add a work item title\"\n\t\t\t\t\t\t\teditButtonLabel=\"Edit work item title\"\n\t\t\t\t\t\t\tconfirmButtonLabel=\"Confirm title\"\n\t\t\t\t\t\t\tcancelButtonLabel=\"Cancel editing\"\n\t\t\t\t\t\t\tonConfirm={setTitle}\n\t\t\t\t\t\t/>\n\t\t\t\t\t}\n\t\t\t\t/>\n\t\t\t\t<PanelBody>\n\t\t\t\t\t<Stack space=\"space.200\">\n\t\t\t\t\t\t<Text as=\"p\">PROJ-42 · In progress</Text>\n\t\t\t\t\t\t<Text as=\"p\">Review the release checklist with the project team.</Text>\n\t\t\t\t\t\t<Text as=\"p\">\n\t\t\t\t\t\t\tThis example keeps title edits locally. Connect confirmation to your app's save\n\t\t\t\t\t\t\toperation.\n\t\t\t\t\t\t</Text>\n\t\t\t\t\t</Stack>\n\t\t\t\t</PanelBody>\n\t\t\t</PanelContent>\n\t\t\t<PanelFooter>\n\t\t\t\t<Button onClick={closePanel}>Done</Button>\n\t\t\t</PanelFooter>\n\t\t</PanelContainer>\n\t);\n}\nfunction ProjectContent() {\n\tconst manager = usePanelActions();\n\tconst { activePanel } = usePanelState();\n\treturn (\n\t\t<LayoutWithPanel panelLabel=\"Work item details\" resizeLabel=\"Resize work item details\">\n\t\t\t<Button\n\t\t\t\tisSelected={activePanel?.instanceId === 'PROJ-42'}\n\t\t\t\tonClick={() =>\n\t\t\t\t\tmanager.openPanel({\n\t\t\t\t\t\tinstanceId: 'PROJ-42',\n\t\t\t\t\t\tparams: { title: 'Prepare the release checklist' },\n\t\t\t\t\t\tpanelContent: <WorkItemDetails />,\n\t\t\t\t\t})\n\t\t\t\t}\n\t\t\t>\n\t\t\t\tView PROJ-42\n\t\t\t</Button>\n\t\t</LayoutWithPanel>\n\t);\n}\n// Internal Atlassian package. This example uses already-loaded React content.\n// For lazy EntryPoints, prefer Trigger inside the app's Relay environment provider.\nexport default function ContextualDetailsExample(): React.JSX.Element {\n\treturn (\n\t\t<PanelProvider>\n\t\t\t<Root>\n\t\t\t\t<Main>\n\t\t\t\t\t<ProjectContent />\n\t\t\t\t</Main>\n\t\t\t</Root>\n\t\t</PanelProvider>\n\t);\n}"]
2091
+ }, {
2092
+ name: 'usePanelActions',
2093
+ description: 'For internal Atlassian use only: Access stable panel actions when a consumer only needs to open, close, or resize panels. Requires PanelProvider. Internal Atlassian package; not available for use outside Atlassian.',
2094
+ status: 'open-beta',
2095
+ keywords: ['panel', 'context', 'state', 'close', 'open'],
2096
+ category: 'layout',
2097
+ package: '@atlassian/panel-system',
2098
+ examples: ["import React, { useState } from 'react';\nimport Button from '@atlaskit/button/default/button';\nimport { Main } from '@atlaskit/navigation-system/layout/main';\nimport { Root } from '@atlaskit/navigation-system/layout/root';\nimport { Stack } from '@atlaskit/primitives/compiled/stack';\nimport { Text } from '@atlaskit/primitives/compiled/text';\nimport { LayoutWithPanel } from '@atlassian/panel-system/layout-with-panel';\nimport { PanelActionCloseSmart } from '@atlassian/panel-system/panel-action/close-smart';\nimport { PanelActionGroup } from '@atlassian/panel-system/panel-action/group';\nimport { PanelActionNewTab } from '@atlassian/panel-system/panel-action/new-tab';\nimport { PanelBody } from '@atlassian/panel-system/panel-body';\nimport { PanelContainer } from '@atlassian/panel-system/panel-container';\nimport { PanelContent } from '@atlassian/panel-system/panel-content';\nimport { usePanel } from '@atlassian/panel-system/panel-context';\nimport { PanelFooter } from '@atlassian/panel-system/panel-footer';\nimport { PanelHeader } from '@atlassian/panel-system/panel-header';\nimport { usePanelActions, usePanelState } from '@atlassian/panel-system/panel-manager';\nimport { PanelProvider } from '@atlassian/panel-system/panel-provider';\nimport { PanelSubheader } from '@atlassian/panel-system/panel-subheader';\nimport { PanelTitle } from '@atlassian/panel-system/panel-title';\nimport { SubheaderInlineEdit } from '@atlassian/panel-system/subheader-inline-edit';\nfunction WorkItemDetails() {\n\tconst { panel, closePanel } = usePanel<{ title: string }>();\n\tconst [title, setTitle] = useState(panel.params.title);\n\treturn (\n\t\t<PanelContainer>\n\t\t\t<PanelHeader>\n\t\t\t\t<PanelTitle>Work item</PanelTitle>\n\t\t\t\t<PanelActionGroup>\n\t\t\t\t\t<PanelActionNewTab href=\"/browse/PROJ-42\" label=\"Open work item in a new tab\" />\n\t\t\t\t\t<PanelActionCloseSmart label=\"Close work item\" />\n\t\t\t\t</PanelActionGroup>\n\t\t\t</PanelHeader>\n\t\t\t<PanelContent>\n\t\t\t\t<PanelSubheader\n\t\t\t\t\ttitle={title}\n\t\t\t\t\tinlineEdit={\n\t\t\t\t\t\t<SubheaderInlineEdit\n\t\t\t\t\t\t\tdefaultValue={title}\n\t\t\t\t\t\t\tplaceholder=\"Add a work item title\"\n\t\t\t\t\t\t\teditButtonLabel=\"Edit work item title\"\n\t\t\t\t\t\t\tconfirmButtonLabel=\"Confirm title\"\n\t\t\t\t\t\t\tcancelButtonLabel=\"Cancel editing\"\n\t\t\t\t\t\t\tonConfirm={setTitle}\n\t\t\t\t\t\t/>\n\t\t\t\t\t}\n\t\t\t\t/>\n\t\t\t\t<PanelBody>\n\t\t\t\t\t<Stack space=\"space.200\">\n\t\t\t\t\t\t<Text as=\"p\">PROJ-42 · In progress</Text>\n\t\t\t\t\t\t<Text as=\"p\">Review the release checklist with the project team.</Text>\n\t\t\t\t\t\t<Text as=\"p\">\n\t\t\t\t\t\t\tThis example keeps title edits locally. Connect confirmation to your app's save\n\t\t\t\t\t\t\toperation.\n\t\t\t\t\t\t</Text>\n\t\t\t\t\t</Stack>\n\t\t\t\t</PanelBody>\n\t\t\t</PanelContent>\n\t\t\t<PanelFooter>\n\t\t\t\t<Button onClick={closePanel}>Done</Button>\n\t\t\t</PanelFooter>\n\t\t</PanelContainer>\n\t);\n}\nfunction ProjectContent() {\n\tconst manager = usePanelActions();\n\tconst { activePanel } = usePanelState();\n\treturn (\n\t\t<LayoutWithPanel panelLabel=\"Work item details\" resizeLabel=\"Resize work item details\">\n\t\t\t<Button\n\t\t\t\tisSelected={activePanel?.instanceId === 'PROJ-42'}\n\t\t\t\tonClick={() =>\n\t\t\t\t\tmanager.openPanel({\n\t\t\t\t\t\tinstanceId: 'PROJ-42',\n\t\t\t\t\t\tparams: { title: 'Prepare the release checklist' },\n\t\t\t\t\t\tpanelContent: <WorkItemDetails />,\n\t\t\t\t\t})\n\t\t\t\t}\n\t\t\t>\n\t\t\t\tView PROJ-42\n\t\t\t</Button>\n\t\t</LayoutWithPanel>\n\t);\n}\n// Internal Atlassian package. This example uses already-loaded React content.\n// For lazy EntryPoints, prefer Trigger inside the app's Relay environment provider.\nexport default function ContextualDetailsExample(): React.JSX.Element {\n\treturn (\n\t\t<PanelProvider>\n\t\t\t<Root>\n\t\t\t\t<Main>\n\t\t\t\t\t<ProjectContent />\n\t\t\t\t</Main>\n\t\t\t</Root>\n\t\t</PanelProvider>\n\t);\n}"]
2099
+ }, {
2100
+ name: 'usePanelManager',
2101
+ description: 'For internal Atlassian use only: Read both panel state and actions inside PanelProvider. Prefer usePanelActions for action-only consumers. Internal Atlassian package; not available for use outside Atlassian.',
2102
+ status: 'open-beta',
2103
+ keywords: ['panel', 'context', 'state', 'close', 'open'],
2104
+ category: 'layout',
2105
+ package: '@atlassian/panel-system',
2106
+ examples: ["import Button from '@atlaskit/button/default/button';\nimport { Main } from '@atlaskit/navigation-system/layout/main';\nimport { PanelLayout } from '@atlaskit/navigation-system/layout/panel-layout';\nimport { Root } from '@atlaskit/navigation-system/layout/root';\nimport { Text } from '@atlaskit/primitives/compiled/text';\nimport { PanelActionClose } from '@atlassian/panel-system/panel-action/close';\nimport { PanelActionGroup } from '@atlassian/panel-system/panel-action/group';\nimport { PanelBody } from '@atlassian/panel-system/panel-body';\nimport { PanelContainer } from '@atlassian/panel-system/panel-container';\nimport { PanelContent } from '@atlassian/panel-system/panel-content';\nimport { useCloseCurrentPanel, useCurrentPanel } from '@atlassian/panel-system/panel-context';\nimport { PanelDisclaimer } from '@atlassian/panel-system/panel-disclaimer';\nimport { PanelFooter } from '@atlassian/panel-system/panel-footer';\nimport { PanelHeader } from '@atlassian/panel-system/panel-header';\nimport { usePanelManager } from '@atlassian/panel-system/panel-manager';\nimport { PanelProvider } from '@atlassian/panel-system/panel-provider';\nimport { PanelRouter } from '@atlassian/panel-system/panel-router';\nimport { PanelTitle } from '@atlassian/panel-system/panel-title';\nimport { PanelsRenderer } from '@atlassian/panel-system/panels-renderer';\nfunction ProjectSummary() {\n\tconst panel = useCurrentPanel<{ summary: string }>();\n\tconst closePanel = useCloseCurrentPanel();\n\treturn (\n\t\t<PanelContainer>\n\t\t\t<PanelHeader>\n\t\t\t\t<PanelTitle>Project summary</PanelTitle>\n\t\t\t\t<PanelActionGroup>\n\t\t\t\t\t<PanelActionClose label=\"Close project summary\" onClick={closePanel} />\n\t\t\t\t</PanelActionGroup>\n\t\t\t</PanelHeader>\n\t\t\t<PanelContent>\n\t\t\t\t<PanelBody>\n\t\t\t\t\t<Text as=\"p\">{panel.params.summary}</Text>\n\t\t\t\t</PanelBody>\n\t\t\t</PanelContent>\n\t\t\t<PanelFooter\n\t\t\t\tdisclaimer={\n\t\t\t\t\t<PanelDisclaimer>AI-generated content. Verify important details.</PanelDisclaimer>\n\t\t\t\t}\n\t\t\t>\n\t\t\t\t<Button onClick={closePanel}>Done</Button>\n\t\t\t</PanelFooter>\n\t\t</PanelContainer>\n\t);\n}\nfunction ProjectContent() {\n\tconst { state, manager } = usePanelManager();\n\treturn (\n\t\t<PanelLayout\n\t\t\tisPanelOpen={state.activePanel !== null}\n\t\t\tpanelKey={state.activePanel?.instanceId}\n\t\t\tpanelLabel=\"Project summary\"\n\t\t\tresizeLabel=\"Resize project summary\"\n\t\t\tpanel={\n\t\t\t\t<PanelsRenderer>\n\t\t\t\t\t<PanelRouter />\n\t\t\t\t</PanelsRenderer>\n\t\t\t}\n\t\t>\n\t\t\t<Button\n\t\t\t\tonClick={() =>\n\t\t\t\t\tmanager.openPanel({\n\t\t\t\t\t\tinstanceId: 'project-summary',\n\t\t\t\t\t\tparams: {\n\t\t\t\t\t\t\tsummary:\n\t\t\t\t\t\t\t\t'The release checklist is ready for review. Two work items remain in progress.',\n\t\t\t\t\t\t},\n\t\t\t\t\t\tpanelContent: <ProjectSummary />,\n\t\t\t\t\t})\n\t\t\t\t}\n\t\t\t>\n\t\t\t\tView project summary\n\t\t\t</Button>\n\t\t</PanelLayout>\n\t);\n}\n// Internal Atlassian package. Prefer LayoutWithPanel for the standard integration.\n// Use this composition when the app needs to own its PanelLayout and PanelRouter.\nexport default function CustomRenderingExample(): React.JSX.Element {\n\treturn (\n\t\t<PanelProvider>\n\t\t\t<Root>\n\t\t\t\t<Main>\n\t\t\t\t\t<ProjectContent />\n\t\t\t\t</Main>\n\t\t\t</Root>\n\t\t</PanelProvider>\n\t);\n}"]
2107
+ }, {
2108
+ name: 'usePanelState',
2109
+ description: 'For internal Atlassian use only: Read active-panel and preferred-width state inside PanelProvider. Internal Atlassian package; not available for use outside Atlassian.',
2110
+ status: 'open-beta',
2111
+ keywords: ['panel', 'context', 'state', 'close', 'open'],
2112
+ category: 'layout',
2113
+ package: '@atlassian/panel-system',
2114
+ examples: ["import React, { useState } from 'react';\nimport Button from '@atlaskit/button/default/button';\nimport { Main } from '@atlaskit/navigation-system/layout/main';\nimport { Root } from '@atlaskit/navigation-system/layout/root';\nimport { Stack } from '@atlaskit/primitives/compiled/stack';\nimport { Text } from '@atlaskit/primitives/compiled/text';\nimport { LayoutWithPanel } from '@atlassian/panel-system/layout-with-panel';\nimport { PanelActionCloseSmart } from '@atlassian/panel-system/panel-action/close-smart';\nimport { PanelActionGroup } from '@atlassian/panel-system/panel-action/group';\nimport { PanelActionNewTab } from '@atlassian/panel-system/panel-action/new-tab';\nimport { PanelBody } from '@atlassian/panel-system/panel-body';\nimport { PanelContainer } from '@atlassian/panel-system/panel-container';\nimport { PanelContent } from '@atlassian/panel-system/panel-content';\nimport { usePanel } from '@atlassian/panel-system/panel-context';\nimport { PanelFooter } from '@atlassian/panel-system/panel-footer';\nimport { PanelHeader } from '@atlassian/panel-system/panel-header';\nimport { usePanelActions, usePanelState } from '@atlassian/panel-system/panel-manager';\nimport { PanelProvider } from '@atlassian/panel-system/panel-provider';\nimport { PanelSubheader } from '@atlassian/panel-system/panel-subheader';\nimport { PanelTitle } from '@atlassian/panel-system/panel-title';\nimport { SubheaderInlineEdit } from '@atlassian/panel-system/subheader-inline-edit';\nfunction WorkItemDetails() {\n\tconst { panel, closePanel } = usePanel<{ title: string }>();\n\tconst [title, setTitle] = useState(panel.params.title);\n\treturn (\n\t\t<PanelContainer>\n\t\t\t<PanelHeader>\n\t\t\t\t<PanelTitle>Work item</PanelTitle>\n\t\t\t\t<PanelActionGroup>\n\t\t\t\t\t<PanelActionNewTab href=\"/browse/PROJ-42\" label=\"Open work item in a new tab\" />\n\t\t\t\t\t<PanelActionCloseSmart label=\"Close work item\" />\n\t\t\t\t</PanelActionGroup>\n\t\t\t</PanelHeader>\n\t\t\t<PanelContent>\n\t\t\t\t<PanelSubheader\n\t\t\t\t\ttitle={title}\n\t\t\t\t\tinlineEdit={\n\t\t\t\t\t\t<SubheaderInlineEdit\n\t\t\t\t\t\t\tdefaultValue={title}\n\t\t\t\t\t\t\tplaceholder=\"Add a work item title\"\n\t\t\t\t\t\t\teditButtonLabel=\"Edit work item title\"\n\t\t\t\t\t\t\tconfirmButtonLabel=\"Confirm title\"\n\t\t\t\t\t\t\tcancelButtonLabel=\"Cancel editing\"\n\t\t\t\t\t\t\tonConfirm={setTitle}\n\t\t\t\t\t\t/>\n\t\t\t\t\t}\n\t\t\t\t/>\n\t\t\t\t<PanelBody>\n\t\t\t\t\t<Stack space=\"space.200\">\n\t\t\t\t\t\t<Text as=\"p\">PROJ-42 · In progress</Text>\n\t\t\t\t\t\t<Text as=\"p\">Review the release checklist with the project team.</Text>\n\t\t\t\t\t\t<Text as=\"p\">\n\t\t\t\t\t\t\tThis example keeps title edits locally. Connect confirmation to your app's save\n\t\t\t\t\t\t\toperation.\n\t\t\t\t\t\t</Text>\n\t\t\t\t\t</Stack>\n\t\t\t\t</PanelBody>\n\t\t\t</PanelContent>\n\t\t\t<PanelFooter>\n\t\t\t\t<Button onClick={closePanel}>Done</Button>\n\t\t\t</PanelFooter>\n\t\t</PanelContainer>\n\t);\n}\nfunction ProjectContent() {\n\tconst manager = usePanelActions();\n\tconst { activePanel } = usePanelState();\n\treturn (\n\t\t<LayoutWithPanel panelLabel=\"Work item details\" resizeLabel=\"Resize work item details\">\n\t\t\t<Button\n\t\t\t\tisSelected={activePanel?.instanceId === 'PROJ-42'}\n\t\t\t\tonClick={() =>\n\t\t\t\t\tmanager.openPanel({\n\t\t\t\t\t\tinstanceId: 'PROJ-42',\n\t\t\t\t\t\tparams: { title: 'Prepare the release checklist' },\n\t\t\t\t\t\tpanelContent: <WorkItemDetails />,\n\t\t\t\t\t})\n\t\t\t\t}\n\t\t\t>\n\t\t\t\tView PROJ-42\n\t\t\t</Button>\n\t\t</LayoutWithPanel>\n\t);\n}\n// Internal Atlassian package. This example uses already-loaded React content.\n// For lazy EntryPoints, prefer Trigger inside the app's Relay environment provider.\nexport default function ContextualDetailsExample(): React.JSX.Element {\n\treturn (\n\t\t<PanelProvider>\n\t\t\t<Root>\n\t\t\t\t<Main>\n\t\t\t\t\t<ProjectContent />\n\t\t\t\t</Main>\n\t\t\t</Root>\n\t\t</PanelProvider>\n\t);\n}"]
2067
2115
  }];