@atlaskit/code 17.2.3 → 17.2.5

package/dist/types/syntax-highlighter/lib/process/create-line-element.d.ts

@@ -2,8 +2,16 @@ import { type AST, type RefractorNode, type SyntaxHighlighterLineProps } from '.
 export type CreateLineElementProps = {
     children: RefractorNode[];
     lineNumber: number;
+    /**
+     * Sets whether to display code line numbers or not.
+     * @deprecated Use `shouldShowLineNumbers` instead
+     */
     showLineNumbers?: boolean;
+    /**
+     * Sets whether to display code line numbers or not.
+     */
+    shouldShowLineNumbers?: boolean;
     lineProps?: SyntaxHighlighterLineProps;
     className?: string[];
 };
-export default function createLineElement({ children, lineNumber, showLineNumbers, lineProps, className, }: CreateLineElementProps): AST.Element;
+export default function createLineElement({ children, lineNumber, showLineNumbers, shouldShowLineNumbers, lineProps, className, }: CreateLineElementProps): AST.Element;

package/dist/types/types.d.ts

@@ -12,8 +12,13 @@ export interface CodeProps extends HTMLProps<HTMLElement> {
     children?: ReactNode;
     /**
      * When set to `false`, disables code decorating with bidi warnings. Defaults to `true`.
+     * @deprecated Use `hasBidiWarnings` instead
      */
     codeBidiWarnings?: boolean;
+    /**
+     * When set to `false`, disables code decorating with bidi warnings. Defaults to `true`.
+     */
+    hasBidiWarnings?: boolean;
     /**
      * Label for the bidi warning tooltip.
      *
@@ -26,6 +31,14 @@ export interface CodeProps extends HTMLProps<HTMLElement> {
      * disabled when used in a mobile view, such as in the editor via mobile
      * bridge, where the tooltip could end up being cut off or otherwise not work
      * as expected. Defaults to `true`.
+     * @deprecated Use `isBidiWarningTooltipEnabled` instead
      */
     codeBidiWarningTooltipEnabled?: boolean;
+    /**
+     * Sets whether to render tooltip with the warning or not. Intended to be
+     * disabled when used in a mobile view, such as in the editor via mobile
+     * bridge, where the tooltip could end up being cut off or otherwise not work
+     * as expected. Defaults to `true`.
+     */
+    isBidiWarningTooltipEnabled?: boolean;
 }

package/dist/types-ts4.5/bidi-warning/ui/index.d.ts

@@ -8,4 +8,4 @@ import { type CodeBidiWarningProps } from './types';
  *
  * See https://hello.atlassian.net/wiki/spaces/PRODSEC/pages/1347434677/PSHELP-2943+Investigate+Trojan+Source+Attack+Vulnerability#1)-Providing-visual-cues-for-our-Customers-in-our-affected-products
  */
-export default function BidiWarning({ testId, bidiCharacter, skipChildren, tooltipEnabled, label, }: CodeBidiWarningProps): React.JSX.Element;
+export default function BidiWarning({ testId, bidiCharacter, skipChildren, shouldSkipChildren, tooltipEnabled, isTooltipEnabled, label, }: CodeBidiWarningProps): React.JSX.Element;

package/dist/types-ts4.5/bidi-warning/ui/types.d.ts

@@ -13,14 +13,29 @@ export type CodeBidiWarningProps = {
      * Intended to be disabled when used in a mobile view, such as in the editor via mobile bridge,
      * where the tooltip could end up being cut off or otherwise not work as expected.
      * @default true
+     * @deprecated Use `isTooltipEnabled` instead
      */
     tooltipEnabled?: boolean;
+    /**
+     * Sets whether to render tooltip with the warning or not.
+     * Intended to be disabled when used in a mobile view, such as in the editor via mobile bridge,
+     * where the tooltip could end up being cut off or otherwise not work as expected.
+     * @default true
+     */
+    isTooltipEnabled?: boolean;
     /**
      * Sets whether bidi character should be wrapped in decorator.
      * Useful when wrapping the bidi character with the decoration is not achievable.
      * @default false
+     * @deprecated Use `shouldSkipChildren` instead
      */
     skipChildren?: boolean;
+    /**
+     * Sets whether bidi character should be wrapped in decorator.
+     * Useful when wrapping the bidi character with the decoration is not achievable.
+     * @default false
+     */
+    shouldSkipChildren?: boolean;
     /**
      * Label for the bidi warning tooltip.
      * @default "Bidirectional characters change the order that text is rendered. This could be used to obscure malicious code."

package/dist/types-ts4.5/code-block.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import type { CodeBlockProps } from './internal/types';
 /**
  * __Code block__

package/dist/types-ts4.5/constants.d.ts

@@ -641,6 +641,13 @@ export declare const SUPPORTED_LANGUAGES: readonly [
         ];
         readonly value: "protobuf";
     },
+    {
+        readonly name: "TOML";
+        readonly alias: readonly [
+            "toml"
+        ];
+        readonly value: "toml";
+    },
     {
         readonly name: "Handlebars";
         readonly alias: readonly [

package/dist/types-ts4.5/internal/hooks/use-highlight.d.ts

@@ -1,6 +1,6 @@
 import { type HTMLProps } from 'react';
 import type { CodeBlockProps } from '../types';
-export declare const useHighlightLines: ({ highlight, testId, }: Pick<CodeBlockProps, 'highlight' | 'testId'>) => {
+export declare const useHighlightLines: ({ highlight, testId, }: Pick<CodeBlockProps, "highlight" | "testId">) => {
     getHighlightStyles: (lineNumber: number, highlightedLines: number[]) => HTMLProps<HTMLElement>;
     highlightedLines: number[];
 };

package/dist/types-ts4.5/internal/types.d.ts

@@ -12,8 +12,14 @@ export interface CodeBlockProps {
     /**
      *  Sets whether to display code line numbers or not.
      *  @default true
+     * @deprecated Use `shouldShowLineNumbers` instead
      */
     showLineNumbers?: boolean;
+    /**
+     * Sets whether to display code line numbers or not.
+     * @default true
+     */
+    shouldShowLineNumbers?: boolean;
     /**
      * Sets the number of the first line, if showLineNumbers is set to true.
      * @default 1
@@ -50,8 +56,14 @@ export interface CodeBlockProps {
     /**
      * When set to `false`, disables code decorating with bidi warnings.
      * @default true
+     * @deprecated Use `hasBidiWarnings` instead
      */
     codeBidiWarnings?: boolean;
+    /**
+     * When set to `false`, disables code decorating with bidi warnings.
+     * @default true
+     */
+    hasBidiWarnings?: boolean;
     /**
      * Label for the bidi warning tooltip.
      * @default 'Bidirectional characters change the order that text is rendered. This could be used to obscure malicious code.'
@@ -62,8 +74,16 @@ export interface CodeBlockProps {
      * Intended to be disabled when used in a mobile view, such as in the editor via mobile bridge,
      * where the tooltip could end up being cut off or otherwise not work as expected.
      * @default true
+     * @deprecated Use `isBidiWarningTooltipEnabled` instead
      */
     codeBidiWarningTooltipEnabled?: boolean;
+    /**
+     * Sets whether to render tooltip with the warning or not.
+     * Intended to be disabled when used in a mobile view, such as in the editor via mobile bridge,
+     * where the tooltip could end up being cut off or otherwise not work as expected.
+     * @default true
+     */
+    isBidiWarningTooltipEnabled?: boolean;
     /**
      * Sets whether long lines will create a horizontally scrolling container.
      * When set to `true`, these lines will visually wrap instead.

package/dist/types-ts4.5/syntax-highlighter/lib/highlight.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { type SyntaxHighlighterProps } from '../types';
 /**
  * Takes in a code string and (in the default behaviour):

package/dist/types-ts4.5/syntax-highlighter/lib/process/create-line-element.d.ts

@@ -2,8 +2,16 @@ import { type AST, type RefractorNode, type SyntaxHighlighterLineProps } from '.
 export type CreateLineElementProps = {
     children: RefractorNode[];
     lineNumber: number;
+    /**
+     * Sets whether to display code line numbers or not.
+     * @deprecated Use `shouldShowLineNumbers` instead
+     */
     showLineNumbers?: boolean;
+    /**
+     * Sets whether to display code line numbers or not.
+     */
+    shouldShowLineNumbers?: boolean;
     lineProps?: SyntaxHighlighterLineProps;
     className?: string[];
 };
-export default function createLineElement({ children, lineNumber, showLineNumbers, lineProps, className, }: CreateLineElementProps): AST.Element;
+export default function createLineElement({ children, lineNumber, showLineNumbers, shouldShowLineNumbers, lineProps, className, }: CreateLineElementProps): AST.Element;

package/dist/types-ts4.5/types.d.ts

@@ -12,8 +12,13 @@ export interface CodeProps extends HTMLProps<HTMLElement> {
     children?: ReactNode;
     /**
      * When set to `false`, disables code decorating with bidi warnings. Defaults to `true`.
+     * @deprecated Use `hasBidiWarnings` instead
      */
     codeBidiWarnings?: boolean;
+    /**
+     * When set to `false`, disables code decorating with bidi warnings. Defaults to `true`.
+     */
+    hasBidiWarnings?: boolean;
     /**
      * Label for the bidi warning tooltip.
      *
@@ -26,6 +31,14 @@ export interface CodeProps extends HTMLProps<HTMLElement> {
      * disabled when used in a mobile view, such as in the editor via mobile
      * bridge, where the tooltip could end up being cut off or otherwise not work
      * as expected. Defaults to `true`.
+     * @deprecated Use `isBidiWarningTooltipEnabled` instead
      */
     codeBidiWarningTooltipEnabled?: boolean;
+    /**
+     * Sets whether to render tooltip with the warning or not. Intended to be
+     * disabled when used in a mobile view, such as in the editor via mobile
+     * bridge, where the tooltip could end up being cut off or otherwise not work
+     * as expected. Defaults to `true`.
+     */
+    isBidiWarningTooltipEnabled?: boolean;
 }

package/inline/package.json

@@ -8,7 +8,7 @@
   ],
   "types": "../dist/types/entry-points/inline.d.ts",
   "typesVersions": {
-    ">=4.5 <5.4": {
+    ">=4.5 <5.9": {
       "*": [
         "../dist/types-ts4.5/entry-points/inline.d.ts"
       ]

package/offerings.json

@@ -0,0 +1,65 @@
+[
+	{
+		"name": "Code",
+		"package": "@atlaskit/code",
+		"import": {
+			"name": "Code",
+			"package": "@atlaskit/code",
+			"type": "named"
+		},
+		"keywords": ["code", "snippet", "inline", "syntax", "programming"],
+		"categories": ["data-display"],
+		"shortDescription": "A component for displaying code snippets.",
+		"status": "general-availability",
+		"accessibilityGuidelines": [
+			"Ensure code content is announced properly by screen readers",
+			"Use appropriate contrast for code readability",
+			"Consider code context and meaning"
+		],
+		"usageGuidelines": [
+			"Use for inline code snippets",
+			"Consider syntax highlighting needs",
+			"Use appropriate font styling",
+			"Consider code block vs inline code"
+		],
+		"contentGuidelines": [
+			"Use clear, readable code examples",
+			"Consider code formatting and indentation",
+			"Use meaningful variable names in examples",
+			"Keep code snippets concise"
+		],
+		"examples": ["./examples/ai/code.tsx"]
+	},
+	{
+		"name": "CodeBlock",
+		"package": "@atlaskit/code",
+		"import": {
+			"name": "CodeBlock",
+			"package": "@atlaskit/code",
+			"type": "named"
+		},
+		"keywords": ["code", "block", "syntax", "highlighting", "multiline"],
+		"categories": ["data-display"],
+		"shortDescription": "A component for displaying multi-line code blocks with syntax highlighting.",
+		"status": "general-availability",
+		"accessibilityGuidelines": [
+			"Ensure code blocks are announced properly by screen readers",
+			"Use appropriate contrast for code readability",
+			"Consider code context and meaning",
+			"Provide proper language identification"
+		],
+		"usageGuidelines": [
+			"Use for multi-line code examples",
+			"Specify appropriate language for syntax highlighting",
+			"Consider code block sizing and scrolling",
+			"Use for code snippets that need formatting"
+		],
+		"contentGuidelines": [
+			"Use clear, readable code examples",
+			"Consider code formatting and indentation",
+			"Use meaningful variable names in examples",
+			"Keep code blocks focused and relevant"
+		],
+		"examples": ["./examples/ai/code-block.tsx"]
+	}
+]

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/code",
-	"version": "17.2.3",
+	"version": "17.2.5",
 	"description": "Code highlights short strings of code snippets inline with body text.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -29,7 +29,7 @@
 	"dependencies": {
 		"@atlaskit/codemod-utils": "^4.2.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tokens": "^6.0.0",
+		"@atlaskit/tokens": "^6.3.0",
 		"@atlaskit/tooltip": "^20.4.0",
 		"@atlaskit/visually-hidden": "^3.0.0",
 		"@babel/runtime": "^7.0.0",
@@ -46,17 +46,17 @@
 		"@af/accessibility-testing": "workspace:^",
 		"@af/integration-testing": "workspace:^",
 		"@af/visual-regression": "workspace:^",
-		"@atlaskit/button": "^23.3.0",
-		"@atlaskit/docs": "^11.0.0",
+		"@atlaskit/button": "^23.4.0",
+		"@atlaskit/docs": "^11.1.0",
 		"@atlaskit/ds-lib": "^5.0.0",
-		"@atlaskit/form": "^12.0.0",
+		"@atlaskit/form": "^12.7.0",
 		"@atlaskit/link": "^3.2.0",
-		"@atlaskit/primitives": "^14.11.0",
-		"@atlaskit/section-message": "^8.5.0",
+		"@atlaskit/primitives": "^14.14.0",
+		"@atlaskit/section-message": "^8.7.0",
 		"@atlaskit/ssr": "workspace:^",
-		"@atlaskit/theme": "^19.0.0",
+		"@atlaskit/theme": "^21.0.0",
 		"@atlaskit/toggle": "^15.1.0",
-		"@atlassian/ssr-tests": "^0.2.0",
+		"@atlassian/ssr-tests": "^0.3.0",
 		"@testing-library/react": "^13.4.0",
 		"@types/jscodeshift": "^0.11.0",
 		"@types/refractor": "^3.0.2",
@@ -64,8 +64,7 @@
 		"css-loader": "^2.0.0",
 		"prismjs": "^1.30.0",
 		"react-dom": "^18.2.0",
-		"style-loader": "^0.16.1",
-		"typescript": "~5.4.2"
+		"style-loader": "^0.16.1"
 	},
 	"keywords": [
 		"atlaskit",
@@ -106,14 +105,5 @@
 			]
 		}
 	},
-	"af:exports": {
-		"./types": "./src/entry-points/types.tsx",
-		".": "./src/index.tsx",
-		"./bidi-warning": "./src/bidi-warning/index.tsx",
-		"./bidi-warning-decorator": "./src/bidi-warning/bidi-warning-decorator.tsx",
-		"./block": "./src/entry-points/block.tsx",
-		"./inline": "./src/entry-points/inline.tsx",
-		"./constants": "./src/entry-points/constants.tsx"
-	},
 	"homepage": "https://atlassian.design/components/code/"
 }

package/types/package.json

@@ -8,7 +8,7 @@
   ],
   "types": "../dist/types/entry-points/types.d.ts",
   "typesVersions": {
-    ">=4.5 <5.4": {
+    ">=4.5 <5.9": {
       "*": [
         "../dist/types-ts4.5/entry-points/types.d.ts"
       ]