@atlaskit/renderer 103.0.0 → 103.0.2

package/dist/types-ts4.0/ui/annotations/context.d.ts

@@ -1,27 +0,0 @@
-import React from 'react';
-import { Position } from './types';
-import type { AnnotationProviders } from '@atlaskit/editor-common/types';
-import { AnnotationMarkStates } from '@atlaskit/adf-schema';
-declare type ChildrenProps = {
-    applyAnnotationDraftAt: (position: Position) => void;
-    clearAnnotationDraft: () => void;
-};
-export declare type RenderCallbackType = React.FC<ChildrenProps>;
-declare type Props = {
-    children: RenderCallbackType;
-};
-declare type State = {
-    position: Position | null;
-};
-export declare const AnnotationsDraftContext: React.Context<Position | null>;
-export declare const ProvidersContext: React.Context<AnnotationProviders | null | undefined>;
-export declare const InlineCommentsStateContext: React.Context<Record<string, AnnotationMarkStates | null>>;
-export declare class AnnotationsDraftContextWrapper extends React.Component<Props, State> {
-    state: {
-        position: null;
-    };
-    render(): JSX.Element;
-    applyAnnotationDraftAt: (nextPosition: Position) => void;
-    clearAnnotationDraft: () => void;
-}
-export {};

package/dist/types-ts4.0/ui/annotations/draft/component.d.ts

@@ -1,20 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { InsertDraftPosition, Position } from '../types';
-export declare const AnnotationDraft: React.FC<{
-    draftPosition: Position;
-}>;
-declare type ApplyAnnotationsProps = {
-    texts: string[];
-    shouldApplyAnnotationAt: InsertDraftPosition.INSIDE | InsertDraftPosition.START | InsertDraftPosition.END;
-    draftPosition: Position;
-};
-export declare const getAnnotationIndex: (annotationPosition: InsertDraftPosition, fragmentCount: number) => number;
-export declare const applyAnnotationOnText: ({ texts, shouldApplyAnnotationAt, draftPosition, }: ApplyAnnotationsProps) => JSX.Element[];
-declare type Props = {
-    startPos: number;
-    endPos: number;
-    children: string;
-};
-export declare const TextWithAnnotationDraft: React.FC<Props>;
-export {};

package/dist/types-ts4.0/ui/annotations/draft/dom.d.ts

@@ -1,7 +0,0 @@
-import { Position } from '../types';
-export declare const dataAttributes: ({ from, to }: Position) => {
-    "data-annotation-draft-mark": boolean;
-    "data-draft-start-at": number;
-    "data-draft-end-at": number;
-};
-export declare const updateWindowSelectionAroundDraft: (pos: Position) => boolean;

package/dist/types-ts4.0/ui/annotations/draft/index.d.ts

@@ -1,2 +0,0 @@
-export { updateWindowSelectionAroundDraft } from './dom';
-export { TextWithAnnotationDraft } from './component';

package/dist/types-ts4.0/ui/annotations/draft/position.d.ts

@@ -1,2 +0,0 @@
-import { InsertDraftPosition, Position, TextPosition } from '../types';
-export declare const calcInsertDraftPositionOnText: ({ start: startTextPosition, end: endTextPosition }: TextPosition, position: Position) => InsertDraftPosition | false;

package/dist/types-ts4.0/ui/annotations/draft/text.d.ts

@@ -1,11 +0,0 @@
-import { TextPosition, Position } from '../types';
-declare type Offset = {
-    startOffset: number;
-    endOffset: number;
-};
-export declare const splitText: (text: string, { startOffset, endOffset }: Offset) => string[] | null;
-export declare const calcTextSplitOffset: (position: Position, textPosition: TextPosition, text: string) => {
-    startOffset: number;
-    endOffset: number;
-};
-export {};

package/dist/types-ts4.0/ui/annotations/element/index.d.ts

@@ -1,10 +0,0 @@
-import React from 'react';
-import { AnnotationId, AnnotationDataAttributes, AnnotationTypes } from '@atlaskit/adf-schema';
-declare type MarkElementProps = {
-    id: AnnotationId;
-    annotationParentIds: AnnotationId[];
-    dataAttributes: AnnotationDataAttributes;
-    annotationType: AnnotationTypes;
-};
-declare const MarkElement: React.FC<MarkElementProps>;
-export { MarkElement };

package/dist/types-ts4.0/ui/annotations/element/mark.d.ts

@@ -1,14 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import type { OnAnnotationClickPayload } from '@atlaskit/editor-common/types';
-import { AnnotationMarkStates, AnnotationId, AnnotationDataAttributes } from '@atlaskit/adf-schema';
-declare type MarkComponentProps = {
-    id: AnnotationId;
-    annotationParentIds: AnnotationId[];
-    dataAttributes: AnnotationDataAttributes;
-    state: AnnotationMarkStates | null;
-    hasFocus: boolean;
-    onClick: (props: OnAnnotationClickPayload) => void;
-};
-export declare const MarkComponent: React.FC<MarkComponentProps>;
-export {};

package/dist/types-ts4.0/ui/annotations/hooks/index.d.ts

@@ -1,3 +0,0 @@
-export { useHasFocusEvent, useAnnotationClickEvent } from './use-events';
-export { useInlineCommentsFilter } from './use-inline-comments-filter';
-export { useInlineCommentSubscriberContext } from './use-inline-comment-subscriber';

package/dist/types-ts4.0/ui/annotations/hooks/use-events.d.ts

@@ -1,18 +0,0 @@
-import { AnnotationUpdateEmitter } from '@atlaskit/editor-common/types';
-import type { InlineCommentViewComponentProps } from '@atlaskit/editor-common/types';
-import { AnnotationMarkStates, AnnotationId, AnnotationTypes } from '@atlaskit/adf-schema';
-import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-declare type ListenEventProps = {
-    id: AnnotationId;
-    updateSubscriber: AnnotationUpdateEmitter | null;
-    createAnalyticsEvent?: CreateUIAnalyticsEvent;
-};
-declare type UseAnnotationUpdateSatteByEventProps = {
-    type: AnnotationTypes;
-    updateSubscriber: AnnotationUpdateEmitter | null;
-};
-export declare const useAnnotationStateByTypeEvent: ({ type, updateSubscriber, }: UseAnnotationUpdateSatteByEventProps) => Record<string, AnnotationMarkStates | null>;
-export declare const useHasFocusEvent: ({ id, updateSubscriber, }: ListenEventProps) => boolean;
-declare type AnnotationsWithClickTarget = Pick<InlineCommentViewComponentProps, 'annotations' | 'clickElementTarget'> | null;
-export declare const useAnnotationClickEvent: (props: Pick<ListenEventProps, 'updateSubscriber' | 'createAnalyticsEvent'>) => AnnotationsWithClickTarget;
-export {};

package/dist/types-ts4.0/ui/annotations/hooks/use-inline-comment-subscriber.d.ts

@@ -1 +0,0 @@
-export declare const useInlineCommentSubscriberContext: () => import("@atlaskit/editor-common/types").AnnotationUpdateEmitter | null;

package/dist/types-ts4.0/ui/annotations/hooks/use-inline-comments-filter.d.ts

@@ -1,9 +0,0 @@
-import { AnnotationId, AnnotationMarkStates } from '@atlaskit/adf-schema';
-declare type Props = {
-    annotationIds: AnnotationId[];
-    filter: {
-        state: AnnotationMarkStates;
-    };
-};
-export declare const useInlineCommentsFilter: ({ annotationIds, filter: { state: stateFilter }, }: Props) => string[];
-export {};

package/dist/types-ts4.0/ui/annotations/hooks/use-load-annotations.d.ts

@@ -1,6 +0,0 @@
-import { JSONDocNode } from '@atlaskit/editor-json-transformer';
-declare type Props = {
-    adfDocument: JSONDocNode;
-};
-export declare const useLoadAnnotations: ({ adfDocument }: Props) => void;
-export {};

package/dist/types-ts4.0/ui/annotations/hooks/user-selection.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="react" />
-declare type Props = {
-    rendererRef: React.RefObject<HTMLDivElement>;
-};
-export declare const useUserSelectionRange: (props: Props) => [
-    Range | null,
-    () => void
-];
-export {};

package/dist/types-ts4.0/ui/annotations/hooks/utils.d.ts

@@ -1,2 +0,0 @@
-/** Exists in its own module to allow mocking in unit tests */
-export declare const isRangeInsideOfRendererContainer: (rendererDOM: HTMLElement, range: Range) => boolean;

package/dist/types-ts4.0/ui/annotations/index.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-import { AnnotationsWrapperProps } from './types';
-export declare const AnnotationsWrapper: React.FC<AnnotationsWrapperProps>;
-export { TextWithAnnotationDraft } from './draft';
-export { MarkElement as AnnotationMark } from './element';

package/dist/types-ts4.0/ui/annotations/selection/index.d.ts

@@ -1 +0,0 @@
-export { Wrapper as SelectionComponentWrapper } from './wrapper';

package/dist/types-ts4.0/ui/annotations/selection/mounter.d.ts

@@ -1,20 +0,0 @@
-import React from 'react';
-import type { AnnotationByMatches, InlineCommentSelectionComponentProps } from '@atlaskit/editor-common/types';
-import { ApplyAnnotation } from '../../../actions/index';
-import { Position } from '../types';
-import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-declare type Props = {
-    range: Range;
-    component: React.ComponentType<InlineCommentSelectionComponentProps>;
-    wrapperDOM: React.RefObject<HTMLDivElement>;
-    documentPosition: Position | false;
-    isAnnotationAllowed: boolean;
-    onClose: () => void;
-    applyAnnotation: ApplyAnnotation;
-    applyAnnotationDraftAt: (position: Position) => void;
-    clearAnnotationDraft: () => void;
-    createAnalyticsEvent?: CreateUIAnalyticsEvent;
-    generateIndexMatch?: (pos: Position) => false | AnnotationByMatches;
-};
-export declare const SelectionInlineCommentMounter: React.FC<Props>;
-export {};

package/dist/types-ts4.0/ui/annotations/selection/range-validator.d.ts

@@ -1,13 +0,0 @@
-import React from 'react';
-import { Position } from '../types';
-import type { InlineCommentSelectionComponentProps } from '@atlaskit/editor-common/types';
-import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-declare type Props = {
-    selectionComponent: React.ComponentType<InlineCommentSelectionComponentProps>;
-    rendererRef: React.RefObject<HTMLDivElement>;
-    applyAnnotationDraftAt: (position: Position) => void;
-    clearAnnotationDraft: () => void;
-    createAnalyticsEvent?: CreateUIAnalyticsEvent;
-};
-export declare const SelectionRangeValidator: React.FC<Props>;
-export {};

package/dist/types-ts4.0/ui/annotations/selection/wrapper.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-declare type Props = {
-    rendererRef: React.RefObject<HTMLDivElement>;
-    createAnalyticsEvent?: CreateUIAnalyticsEvent;
-};
-export declare const Wrapper: (props: React.PropsWithChildren<Props>) => JSX.Element;
-export {};

package/dist/types-ts4.0/ui/annotations/types.d.ts

@@ -1,22 +0,0 @@
-/// <reference types="react" />
-import { JSONDocNode } from '@atlaskit/editor-json-transformer';
-import type { AnnotationProviders } from '@atlaskit/editor-common/types';
-export declare enum InsertDraftPosition {
-    AROUND_TEXT = "AROUND_TEXT",
-    START = "START",
-    END = "END",
-    INSIDE = "INSIDE"
-}
-export declare type Position = {
-    from: number;
-    to: number;
-};
-export declare type AnnotationsWrapperProps = {
-    adfDocument: JSONDocNode;
-    annotationProvider: AnnotationProviders | null | undefined;
-    rendererRef: React.RefObject<HTMLDivElement>;
-};
-export declare type TextPosition = {
-    start: number;
-    end: number;
-};

package/dist/types-ts4.0/ui/annotations/view/index.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-declare type Props = {
-    createAnalyticsEvent?: CreateUIAnalyticsEvent;
-};
-declare const AnnotationView: React.FC<Props>;
-export { AnnotationView };

package/dist/types-ts4.0/ui/index.d.ts

@@ -1 +0,0 @@
-export { default as Renderer } from './Renderer';

package/dist/types-ts4.0/ui/renderer-props.d.ts

@@ -1,100 +0,0 @@
-/// <reference types="react" />
-import { Schema } from 'prosemirror-model';
-import type { ExtensionHandlers } from '@atlaskit/editor-common/extensions';
-import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
-import type { ADFStage } from '@atlaskit/editor-common/validator';
-import type { AnnotationProviders } from '@atlaskit/editor-common/types';
-import type { EventHandlers } from '@atlaskit/editor-common/ui';
-import type { UnsupportedContentLevelsTracking } from '@atlaskit/editor-common/utils';
-import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-import { RendererContext } from '../';
-import { RenderOutputStat } from '../render-document';
-import { RendererAppearance, StickyHeaderProps, HeadingAnchorLinksProps, NodeComponentsProps } from './Renderer/types';
-import { MediaOptions } from '../types/mediaOptions';
-import { SmartLinksOptions } from '../types/smartLinksOptions';
-import { ACTION_SUBJECT } from '../analytics/enums';
-export interface RawObjectFeatureFlags {
-    ['renderer-render-tracking']: string;
-}
-export interface NormalizedObjectFeatureFlags {
-    rendererRenderTracking: {
-        [ACTION_SUBJECT.RENDERER]: {
-            enabled: boolean;
-            useShallow: boolean;
-        };
-    };
-}
-export interface RendererProps {
-    document: any;
-    dataProviders?: ProviderFactory;
-    eventHandlers?: EventHandlers;
-    extensionHandlers?: ExtensionHandlers;
-    enableSsrInlineScripts?: boolean;
-    onComplete?: (stat: RenderOutputStat) => void;
-    onError?: (error: any) => void;
-    portal?: HTMLElement;
-    rendererContext?: RendererContext;
-    schema?: Schema;
-    appearance?: RendererAppearance;
-    adfStage?: ADFStage;
-    disableHeadingIDs?: boolean;
-    disableActions?: boolean;
-    allowHeadingAnchorLinks?: HeadingAnchorLinksProps;
-    allowPlaceholderText?: boolean;
-    maxHeight?: number;
-    fadeOutHeight?: number;
-    truncated?: boolean;
-    createAnalyticsEvent?: CreateUIAnalyticsEvent;
-    allowColumnSorting?: boolean;
-    shouldOpenMediaViewer?: boolean;
-    allowAltTextOnImages?: boolean;
-    stickyHeaders?: StickyHeaderProps;
-    media?: MediaOptions;
-    smartLinks?: SmartLinksOptions;
-    allowAnnotations?: boolean;
-    annotationProvider?: AnnotationProviders | null;
-    innerRef?: React.RefObject<HTMLDivElement>;
-    useSpecBasedValidator?: boolean;
-    allowCopyToClipboard?: boolean;
-    allowCustomPanels?: boolean;
-    analyticsEventSeverityTracking?: {
-        enabled: boolean;
-        severityNormalThreshold: number;
-        severityDegradedThreshold: number;
-    };
-    allowUgcScrubber?: boolean;
-    allowSelectAllTrap?: boolean;
-    unsupportedContentLevelsTracking?: UnsupportedContentLevelsTracking;
-    nodeComponents?: NodeComponentsProps;
-    /**
-     * @default undefined
-     * @description
-     * Short lived feature flags for experiments and gradual rollouts
-     * Flags are expected to follow these rules or they are filtered out
-     *
-     * 1. cased in kebab-case (match [a-z-])
-     * 2. have boolean values or object {} values
-     *
-     * @example
-     * ```tsx
-     * (<Renderer featureFlags={{ 'my-feature': true }} />);
-     * getFeatureFlags()?.myFeature === true;
-     * ```
-     *
-     * @example
-     * ```tsx
-     * (<Renderer featureFlags={{ 'my-feature': 'thing' }} />);
-     * getFeatureFlags()?.myFeature === undefined;
-     * ```
-     *
-     * @example
-     * ```tsx
-     * (<Renderer featureFlags={{ 'product.my-feature': false }} />);
-     * getFeatureFlags()?.myFeature === undefined;
-     * getFeatureFlags()?.productMyFeature === undefined;
-     * ```
-     */
-    featureFlags?: {
-        [featureFlag: string]: boolean;
-    } | Partial<RawObjectFeatureFlags>;
-}

package/dist/types-ts4.0/use-feature-flags.d.ts

@@ -1,2 +0,0 @@
-import { RendererContextProps } from './renderer-context';
-export declare const useFeatureFlags: () => RendererContextProps['featureFlags'] | undefined;

package/dist/types-ts4.0/utils.d.ts

@@ -1,24 +0,0 @@
-import type { Schema } from 'prosemirror-model';
-import type { ADNode } from '@atlaskit/editor-common/validator';
-import type { EventHandlers } from '@atlaskit/editor-common/ui';
-import type { Transformer } from '@atlaskit/editor-common/types';
-import type { Node as PMNode } from 'prosemirror-model';
-import type { RendererAppearance } from './ui/Renderer/types';
-export declare type TransformerProvider<T> = (schema: Schema) => Transformer<T>;
-export declare class ADFEncoder<T> {
-    encode: (value: T) => any;
-    constructor(createTransformerWithSchema: TransformerProvider<T>);
-}
-export declare const getText: (node: PMNode | ADNode) => string;
-export declare const getEventHandler: (eventHandlers?: EventHandlers | undefined, type?: keyof EventHandlers | undefined, eventName?: string) => any;
-export declare const getPlatform: (rendererAppearance: RendererAppearance) => "mobile" | "web";
-/**
- * Traverse through parent elements of element. Return element for which evaluate(element) returns
- * true. If topElement is reached before evaluate returns true, return false. Does not run evaluate
- * on topElement.
- * @param element Starting HTMLElement
- * @param topElement HTMLElement to end search at. evaluate is not called on this element
- * @param evaluate Function which returns true or false based on the given element. eg: Checks if
- * element has desired classname.
- */
-export declare function findInTree(element: HTMLElement, topElement: HTMLElement, evaluate: (element: HTMLElement) => boolean): boolean;