@atlaskit/code 14.6.1 → 14.6.3

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

@@ -0,0 +1,7 @@
+import type { Theme } from '@atlaskit/theme/types';
+import type { CodeBlockTheme, CodeTheme } from './types';
+export declare const getBaseTheme: (theme: Theme) => CodeTheme;
+export declare const defaultBaseTheme: CodeTheme;
+export declare const getColorPalette: import("memoize-one").MemoizedFn<(theme: Theme) => CodeBlockTheme>;
+declare const getTheme: (theme: Theme) => CodeBlockTheme;
+export default getTheme;

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

@@ -0,0 +1,27 @@
+import type { CSSObject } from '@emotion/react';
+import type { Theme } from '@atlaskit/theme/types';
+import type { CodeBlockTheme, CodeTheme } from './types';
+export declare const getLineNumWidth: (numLines: number) => string;
+/**
+ * Styles applied at the root element level, common across code/codeblock
+ */
+export declare const getBaseCodeStyles: (theme: CodeTheme) => {
+    fontSize: number;
+    fontFamily: string | undefined;
+    fontWeight: string;
+    backgroundColor: string;
+    color: string | undefined;
+    borderStyle: string;
+    borderRadius: string;
+};
+/**
+ * Takes an implemented CodeBlock theme, and returns styles required for
+ * react-syntax-highlighter.
+ *
+ * @param theme
+ */
+export declare const getCodeBlockStyles: (theme: CodeBlockTheme) => (highlightedStartText: string, highlightedEndText: string, showLineNumbers: boolean, shouldWrapLongLines: boolean) => CSSObject;
+export declare const getCodeStyles: (globalTheme: Theme | {
+    theme: Theme;
+}) => CSSObject;
+export declare const getCodeBlockTheme: (globalTheme: Theme, maxLines?: number) => CodeBlockTheme;

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

@@ -0,0 +1,57 @@
+export interface CodeTheme {
+    backgroundColor?: string;
+    textColor?: string;
+    fontFamilyItalic?: string;
+    fontFamily?: string;
+    lineNumberColor?: string;
+    lineNumberBgColor?: string;
+}
+export interface CodeBlockTheme extends CodeTheme {
+    substringColor?: string;
+    keywordColor?: string;
+    attributeColor?: string;
+    selectorTagColor?: string;
+    docTagColor?: string;
+    nameColor?: string;
+    builtInColor?: string;
+    literalColor?: string;
+    bulletColor?: string;
+    codeColor?: string;
+    additionColor?: string;
+    regexpColor?: string;
+    symbolColor?: string;
+    variableColor?: string;
+    templateVariableColor?: string;
+    linkColor?: string;
+    selectorAttributeColor?: string;
+    selectorPseudoColor?: string;
+    typeColor?: string;
+    stringColor?: string;
+    selectorIdColor?: string;
+    selectorClassColor?: string;
+    quoteColor?: string;
+    templateTagColor?: string;
+    deletionColor?: string;
+    titleColor?: string;
+    sectionColor?: string;
+    commentColor?: string;
+    metaKeywordColor?: string;
+    metaColor?: string;
+    functionColor?: string;
+    numberColor?: string;
+    prologColor?: string;
+    cdataColor?: string;
+    punctuationColor?: string;
+    propertyColor?: string;
+    constantColor?: string;
+    deletedColor?: string;
+    booleanColor?: string;
+    charColor?: string;
+    insertedColor?: string;
+    operatorColor?: string;
+    atruleColor?: string;
+    importantColor?: string;
+    highlightedLineBgColor?: string;
+    highlightedLineBorderColor?: string;
+    lineNumberWidth?: string | number;
+}

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

@@ -0,0 +1,70 @@
+import type { SupportedLanguages } from '../constants';
+export interface CodeBlockProps {
+    /**
+     * The code to be formatted.
+     */
+    text: string;
+    /**
+     * A unique string that appears as a data attribute `data-testid` in the
+     * rendered code. Serves as a hook for automated tests.
+     */
+    testId?: string;
+    /**
+     *  Sets whether to display code line numbers or not.
+     *  @default true
+     */
+    showLineNumbers?: boolean;
+    /**
+     * Language reference designed to be populated from `SUPPORTED_LANGUAGES` in
+     * `design-system/code`. Run against language grammars from PrismJS (full list
+     * available at [PrismJS documentation](https://prismjs.com/#supported-languages)).
+     *
+     * When set to "text" will not perform highlighting. If unsupported language
+     * provided - code will be treated as "text" with no highlighting.
+     *
+     * @default 'text'
+     */
+    language?: SupportedLanguages;
+    /**
+     * Comma delimited lines to highlight.
+     *
+     * Example uses:
+     * - To highlight one line `highlight="3"`
+     * - To highlight a group of lines `highlight="1-5"`
+     * - To highlight multiple groups `highlight="1-5,7,10,15-20"`
+     */
+    highlight?: string;
+    /**
+     * Screen reader text for the start of a highlighted line.
+     */
+    highlightedStartText?: string;
+    /**
+     * Screen reader text for the end of a highlighted line.
+     */
+    highlightedEndText?: string;
+    /**
+     * When set to `false`, disables code decorating with bidi warnings.
+     * @default true
+     */
+    codeBidiWarnings?: 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.'
+     */
+    codeBidiWarningLabel?: string;
+    /**
+     * 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
+     */
+    codeBidiWarningTooltipEnabled?: boolean;
+    /**
+     * Sets whether long lines will create a horizontally scrolling container.
+     * When set to `true`, these lines will visually wrap instead.
+     * @default false
+     */
+    shouldWrapLongLines?: boolean;
+}
+export type { SupportedLanguages, LanguageAlias, Language } from '../constants';
+export type { CodeBlockTheme, CodeTheme } from './theme/types';

package/dist/types-ts4.5/internal/utils/get-normalized-language.d.ts

@@ -0,0 +1,2 @@
+import { SupportedLanguages } from '../types';
+export declare const normalizeLanguage: import("memoize-one").MemoizedFn<(language?: SupportedLanguages) => string>;

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

@@ -0,0 +1,3 @@
+import { SyntaxHighlighter } from './types';
+declare const _default: typeof SyntaxHighlighter;
+export default _default;

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

@@ -0,0 +1,36 @@
+/**
+ * Original library: https://github.com/react-syntax-highlighter/react-syntax-highlighter
+ * All modifications by Atlassian
+ */
+/**
+ * MIT License
+ *
+ * Copyright (c) 2019 Conor Hastings
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * __Syntax Highlighter__
+ *
+ * A syntax highlighter based on top of [refractor](https://github.com/wooorm/refractor).
+ * @atlaskit/code uses this under-the-hood, but it is not intended for public consumption.
+ * You should be using @atlaskit/code directly.
+ */
+import SyntaxHighlighter from './async';
+export default SyntaxHighlighter;

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

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { SyntaxHighlighterProps } from '../types';
+/**
+ * Takes in a code string and (in the default behaviour):
+ * - Uses refractor to turn it into a tree structure with highlighting metadata
+ * - Collapses this tree into lines for a renderer
+ * - Passes these lines to a React renderer
+ *
+ * In future, the final step could have a custom renderer.
+ */
+declare const Highlight: import("react").NamedExoticComponent<SyntaxHighlighterProps>;
+export default Highlight;

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

@@ -0,0 +1,9 @@
+import { AST, RefractorNode, SyntaxHighlighterLineProps } from '../../types';
+export type CreateLineElementProps = {
+    children: RefractorNode[];
+    lineNumber: number;
+    showLineNumbers?: boolean;
+    lineProps?: SyntaxHighlighterLineProps;
+    className?: string[];
+};
+export default function createLineElement({ children, lineNumber, showLineNumbers, lineProps, className, }: CreateLineElementProps): AST.Element;

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

@@ -0,0 +1,3 @@
+import { RefractorNode, SyntaxHighlighterLineProps } from '../../types';
+declare function createLineGenerator(lineProps: SyntaxHighlighterLineProps, shouldCreateParentElementForLines: boolean, showLineNumbers: boolean): (children: RefractorNode[], lineNumber: number, className?: string[]) => RefractorNode | RefractorNode[];
+export default createLineGenerator;

package/dist/types-ts4.5/syntax-highlighter/lib/process/flatten-code-tree.d.ts

@@ -0,0 +1,2 @@
+import { RefractorNode } from '../../types';
+export default function flattenCodeTree(tree: RefractorNode[], offset?: number, className?: string[]): RefractorNode[];

package/dist/types-ts4.5/syntax-highlighter/lib/process/get-code-tree.d.ts

@@ -0,0 +1,2 @@
+import { AstGenerator, RefractorNode } from '../../types';
+export default function getCodeTree(language: string, code: string, astGenerator?: AstGenerator): RefractorNode[];

package/dist/types-ts4.5/syntax-highlighter/lib/process/get-inline-line-number.d.ts

@@ -0,0 +1,2 @@
+import { RefractorNode } from '../../types';
+export default function getInlineLineNumber(lineNumber: number): RefractorNode;

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

@@ -0,0 +1,17 @@
+import { AstGenerator, RefractorNode, SyntaxHighlighterLineProps } from '../../types';
+interface ProcessLines {
+    astGenerator: AstGenerator;
+    code: string;
+    language: string;
+    shouldCreateParentElementForLines: boolean;
+    lineProps: SyntaxHighlighterLineProps;
+    showLineNumbers: boolean;
+}
+/**
+ * __Line Processor__
+ *
+ * A line processor, that uses refractor to turn code into a tree structure
+ * with highlighting metadata and collapses this tree into lines for a renderer.
+ */
+export default function processLines({ astGenerator, code, language, shouldCreateParentElementForLines, lineProps, showLineNumbers, }: ProcessLines): RefractorNode[];
+export {};

package/dist/types-ts4.5/syntax-highlighter/lib/react-renderer/create-children.d.ts

@@ -0,0 +1,3 @@
+import { ReactNode } from 'react';
+import { CodeBidiWarningConfig, RefractorNode } from '../../types';
+export default function createChildren(codeBidiWarningConfig: CodeBidiWarningConfig): (children: RefractorNode[]) => ReactNode[];

package/dist/types-ts4.5/syntax-highlighter/lib/react-renderer/create-element.d.ts

@@ -0,0 +1,7 @@
+import { ReactNode } from 'react';
+import { CodeBidiWarningConfig, RefractorNode } from '../../types';
+export default function createElement({ node, codeBidiWarningConfig, key, }: {
+    node: RefractorNode;
+    codeBidiWarningConfig: CodeBidiWarningConfig;
+    key: string;
+}): ReactNode;

package/dist/types-ts4.5/syntax-highlighter/lib/react-renderer/index.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import { CodeBidiWarningConfig, RefractorNode } from '../../types';
+/**
+ * __React Renderer__
+ *
+ * A component that receives processed code lines and renders them into the code
+ * rows inside the wrapping span and nested code tag, applying passed props and
+ * code bidi warning config settings.
+ */
+export default function ReactRenderer({ containerProps, codeTagProps, rows, codeBidiWarningConfig, }: {
+    containerProps: React.HTMLProps<HTMLElement>;
+    codeTagProps: React.HTMLProps<HTMLElement>;
+    rows: RefractorNode[];
+    codeBidiWarningConfig: CodeBidiWarningConfig;
+}): JSX.Element;

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

@@ -0,0 +1,129 @@
+import React from 'react';
+import { SerializedStyles } from '@emotion/react';
+import { AST, RefractorNode } from 'refractor';
+export type { AST, RefractorNode } from 'refractor';
+export declare class SyntaxHighlighter extends React.PureComponent<SyntaxHighlighterProps> {
+}
+/**
+ * Function that receives current line number as argument and returns a
+ * line props object to be applied to each `span` wrapping code line.
+ */
+type lineTagPropsFunction = (lineNumber?: number) => AST.Properties;
+/**
+ * Props to be passed to the `span` wrapping each code line. Can be an
+ * object or a function that receives current line number as argument and
+ * returns a props object.
+ */
+export type SyntaxHighlighterLineProps = lineTagPropsFunction | AST.Properties;
+export interface SyntaxHighlighterProps {
+    /**
+     * A unique string that appears as a data attribute `data-testid`
+     * in the rendered code. Serves as a hook for automated tests.
+     */
+    testId?: string;
+    /**
+     * Language reference designed to be populated from `SUPPORTED_LANGUAGES` in
+     * `design-system/code`. Run against language grammars from PrismJS (full list
+     * available at [PrismJS documentation](https://prismjs.com/#supported-languages)).
+     *
+     * When set to "text" will not perform highlighting. If unsupported language
+     * provided - code will be treated as "text" with no highlighting.
+     * @default 'text'
+     */
+    language?: string;
+    /**
+     * Props to be passed to the `span` wrapping each line if
+     * `shouldCreateParentElementForLines` is `true`. Can be an object or a function
+     * that receives current line number as argument and returns a props object.
+     */
+    lineProps?: SyntaxHighlighterLineProps;
+    /**
+     * Props to be passed to the `code` element that is the parent of all lines of code.
+     */
+    codeTagProps?: React.HTMLProps<HTMLElement>;
+    /**
+     * Sets whether to display code line numbers or not. Defaults to `true`
+     */
+    showLineNumbers?: boolean;
+    /**
+     * Determines whether or not each line of code should be wrapped in a parent
+     * element.
+     *
+     * When set to false, can not take action on an element on the line level,
+     * meaning, for example, that props will not be passed down.
+     *
+     * @default false
+     */
+    shouldCreateParentElementForLines?: boolean;
+    /**
+     * Sets whether long lines will create a horizontally scrolling container.
+     * When set to `true`, these lines will visually wrap instead.
+     *
+     * @default false
+     */
+    shouldWrapLongLines?: boolean;
+    /**
+     * Serialized styles returned from Emotion's `css()` function.
+     */
+    styles?: SerializedStyles;
+    /**
+     * `codeBidiWarnings` is set via a prop on @atlaskit/code/CodeBlock.
+     *
+     * When set to `false`, disables code decorating with bidi warnings.
+     *
+     * @default true
+     */
+    codeBidiWarnings?: CodeBidiWarningConfig['codeBidiWarnings'];
+    /**
+     * `codeBidiWarningLabel` is set via a prop on @atlaskit/code/CodeBlock.
+     *
+     * Label for the bidi warning tooltip.
+     *
+     * @default 'Bidirectional characters change the order that text is rendered. This could be used to obscure malicious code.'
+     */
+    codeBidiWarningLabel?: CodeBidiWarningConfig['codeBidiWarningLabel'];
+    /**
+     * `codeBidiWarningTooltipEnabled` is set via a prop on @atlaskit/code/CodeBlock.
+     *
+     * 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
+     */
+    codeBidiWarningTooltipEnabled?: CodeBidiWarningConfig['codeBidiWarningTooltipEnabled'];
+    /**
+     * Code to render; equivalent of `text` prop on @atlaskit/code/CodeBlock.
+     */
+    text?: string;
+    [spread: string]: any;
+}
+export interface CodeBidiWarningConfig {
+    /**
+     * `codeBidiWarnings` is set via a prop on @atlaskit/code/CodeBlock.
+     *
+     * When set to `false`, disables code decorating with bidi warnings.
+     * @default true
+     */
+    codeBidiWarnings?: boolean;
+    /**
+     * `codeBidiWarningLabel` is set via a prop on @atlaskit/code/CodeBlock.
+     *
+     * Label for the bidi warning tooltip.
+     *
+     * @default 'Bidirectional characters change the order that text is rendered. This could be used to obscure malicious code.'
+     */
+    codeBidiWarningLabel?: string;
+    /**
+     * `codeBidiWarningTooltipEnabled` is set via a prop on @atlaskit/code/CodeBlock.
+     *
+     * 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
+     */
+    codeBidiWarningTooltipEnabled?: boolean;
+}
+interface IAstGenerator {
+    highlight: (code: string, language: string) => RefractorNode[];
+}
+export type AstGenerator = IAstGenerator | null;

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

@@ -0,0 +1,31 @@
+import type { HTMLProps, ReactNode } from 'react';
+export type { SupportedLanguages, Language, LanguageAlias, CodeBlockProps, } from './internal/types';
+export interface CodeProps extends HTMLProps<HTMLElement> {
+    /**
+     * A unique string that appears as a data attribute `data-testid`
+     * in the rendered code. Serves as a hook for automated tests.
+     */
+    testId?: string;
+    /**
+     * Content to be rendered in the inline code block.
+     */
+    children?: ReactNode;
+    /**
+     * When set to `false`, disables code decorating with bidi warnings. Defaults to `true`.
+     */
+    codeBidiWarnings?: boolean;
+    /**
+     Label for the bidi warning tooltip.
+  
+     Defaults to `Bidirectional characters change the order that text is rendered.
+     This could be used to obscure malicious code.`
+     */
+    codeBidiWarningLabel?: string;
+    /**
+     * 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`.
+     */
+    codeBidiWarningTooltipEnabled?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/code",
-  "version": "14.6.1",
+  "version": "14.6.3",
   "description": "Code highlights short strings of code snippets inline with body text.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"