@atlaskit/adf-schema 29.1.2 → 30.0.0

package/dist/types/steps/table/add-column.d.ts

@@ -1,88 +0,0 @@
-import { Node as ProseMirrorNode, Schema } from '@atlaskit/editor-prosemirror/model';
-import { Mappable, Step, StepMap, StepResult } from '@atlaskit/editor-prosemirror/transform';
-import { AddColumnStepInfo, AddColumnStepJson } from './types';
-/**
- * Index and positions looks like
- * 0    1    2    3   -> Add Column Index
- * | 5  | 10 | 15 |   -> Table with Positions
- * | 20 | 25 | 30 |
- * 0    1    2    x   -> Remove Column Index
- *
- */
-export declare class AddColumnStep<S extends Schema = any> extends Step {
-    private readonly tablePos;
-    private readonly isDelete;
-    private columnInfo;
-    private sideEffectsHandler;
-    constructor(tablePos: number, addColumnStepInfo: AddColumnStepInfo, isDelete?: boolean);
-    /**
-     * Detect the column based on all the cells step in column info.
-     * Recreate columnInfo based on the current document. We might need to add new cells added by insert row or unmerge cells.
-     * If isDelete
-     *    Decrease colspan if one row has merged cell
-     *    Remove all the cells using columnInfo.cellStep[].from
-     * else
-     *    Increase colspan if one row had merged cell
-     *    Add all new cells at columnInfo.cellStep[].from,
-     *      if there is columnInfo.cellStep[].newCell use it
-     *      else create an empty cell
-     *
-     * @param doc Current document
-     */
-    apply(doc: ProseMirrorNode): StepResult;
-    /**
-     * Update tablePos with the new position. If tablePos doesnt exist any more remove the step
-     * Update all the cellStep inside columnInfo. If cellStep.from position gets deleted removed it from column info
-     * if cellStep.length === 0 remove the step
-     * Create a new step with all the position updated
-     * @param mapping
-     */
-    map(mapping: Mappable): Step | null;
-    /**
-     * if isDelete
-     *    Get the original cell node at columnInfo.cellStep[].from to columnInfo.cellStep[].to
-     *    Create a copy of the node
-     *    Create a new cellStep with the same positions but with the clone node as a content
-     *    return new step inverted
-     * else
-     *    Remove the content from each columnInfo.cellStep[].content
-     *    return new step inverted
-     * @param originalDoc
-     */
-    invert(originalDoc: ProseMirrorNode): Step;
-    /**
-     * StepMap is created based on columnInfo.
-     * ColumnInfo is created on constructor and once is applied (the document could have new cells that weren't part of the original set)
-     * if isDelete
-     *    Create range array based on cell info where each range is [cellStep.from, cellStep.from - cellStep.to, 0]
-     * else
-     *    Create range array base on cell info where each range is [cellStep.from, 0, cellStep.content ? cellStep.content.nodeSize : defaultEmptyCellNodeSize]
-     *
-     * Ranges in ProseMirror are represented by each 3 elements in an array.
-     * As [pos, currentSize, newSize, pos2, currentSize2, newSize2] where:
-     * pos: Position in the document
-     * currentSize: Represent the affected range, this will be pos + currentSize
-     * newSize: Represent the new values, pos + newSize
-     */
-    getMap(): StepMap;
-    /**
-     * Try to merge this step with another one, to be applied directly
-     * after it. Returns the merged step when possible, null if the
-     * steps can't be merged.
-     */
-    merge(other: Step): Step | null;
-    /**
-     * Create a JSON-serializeable representation of this step. When
-     * defining this for a custom subclass, make sure the result object
-     * includes the step type's [JSON id](#transform.Step^jsonID) under
-     * the `stepType` property.
-     */
-    toJSON(): AddColumnStepJson;
-    /**
-     * Deserialize a step from its JSON representation. Will call
-     * through to the step class' own implementation of this method.
-     */
-    static fromJSON<S extends Schema = any>(schema: S, json: AddColumnStepJson): Step;
-    static create(doc: ProseMirrorNode, tablePos: number, column: number, isDelete?: boolean): AddColumnStep<any>;
-    private applyCellSteps;
-}

package/dist/types/steps/table/constants.d.ts

@@ -1,4 +0,0 @@
-export declare enum SortOrder {
-    ASC = "asc",
-    DESC = "desc"
-}

package/dist/types/steps/table/sort-column.d.ts

@@ -1,18 +0,0 @@
-import { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import { ReplaceStep, Step, StepMap, StepResult } from '@atlaskit/editor-prosemirror/transform';
-import { TableColumnOrdering } from './types';
-export declare const tableSortingStepType = "atlaskit-table-sorting-ordering";
-export declare class TableSortStep extends Step {
-    prev: TableColumnOrdering | undefined;
-    next: TableColumnOrdering | undefined;
-    pos: number;
-    constructor(pos: number, prev?: TableColumnOrdering, next?: TableColumnOrdering);
-    invert(): TableSortStep;
-    apply(doc: PMNode): StepResult;
-    map(): null;
-    getMap(): StepMap;
-    toJSON(): {
-        stepType: string;
-    };
-    static fromJSON(): ReplaceStep;
-}

package/dist/types/steps/table/types.d.ts

@@ -1,39 +0,0 @@
-import { Node as ProseMirrorNode } from '@atlaskit/editor-prosemirror/model';
-import { SideEffects, SideEffectsJSON } from './utils/side-effects/types';
-import { SortOrder } from './constants';
-export type ColumnInfo = Map<number, CellStep>;
-export interface AddColumnStepInfo {
-    cells: CellStep[];
-    sideEffects?: SideEffects;
-}
-/**
- * Information about the cell
- * from: where the cell will be added removed
- * to: where the original cell ends
- * newCell?: the content of the new cells if it's added
- */
-export interface CellStep {
-    from: number;
-    to: number;
-    newCell?: ProseMirrorNode;
-    mergeWith?: number;
-}
-export interface CellStepJson {
-    from: number;
-    to: number;
-    newCell?: {
-        [key: string]: any;
-    };
-    mergeWith?: number;
-}
-export interface AddColumnStepJson {
-    stepType: 'ak-add-column';
-    tablePos: number;
-    cells: CellStepJson[];
-    sideEffects?: SideEffectsJSON;
-    isDelete: boolean;
-}
-export interface TableColumnOrdering {
-    columnIndex: number;
-    order: SortOrder;
-}

package/dist/types/steps/table/utils/cell-step.d.ts

@@ -1,47 +0,0 @@
-import { Node as ProseMirrorNode } from '@atlaskit/editor-prosemirror/model';
-import { Cell } from './cells-at-column';
-import { CellStep } from '../types';
-import { Transform, StepMap } from '@atlaskit/editor-prosemirror/transform';
-import { TableRect } from '@atlaskit/editor-tables/table-map';
-/**
- * Given a cell step, this function has to do the specific transformation to executed that step.
- * It returns the applied cellStep and rows that needs to skip (because it was already handled).
- * @param tr
- * @param tableRect
- * @param cell
- * @param cellStep
- * @param isDelete
- * @param column
- */
-export declare function applyCellStep(tr: Transform, tableRect: TableRect, cell: Cell, cellStep: CellStep, isDelete: boolean, column: number): {
-    tr: Transform;
-    skipRows: number;
-    cellStep: CellStep;
-};
-/**
- * Given a cell step, this functions return un StepMap representing this action.
- * [position, oldSize, newSize]
- * @param cellStep
- * @param isDelete
- */
-export declare function getMapFromCellStep(cellStep: CellStep, isDelete: boolean): [number, number, number];
-/**
- * Given a cell step, this function invert that step.
- * @param doc
- * @param getTableRectAndColumn
- * @param cellStep
- * @param isDelete
- * @param stepMap
- */
-export declare function invertCellStep(doc: ProseMirrorNode, getTableRectAndColumn: () => {
-    rect: TableRect;
-    column: number;
-}, cellStep: CellStep, isDelete: boolean, stepMap: StepMap): CellStep;
-/**
- * Create a cell step based on the current cell and operation (add/delete)
- * @param cell
- * @param column
- * @param isDelete
- * @param previousCellStep
- */
-export declare function createCellStep(cell: Cell, column: number, isDelete: boolean, previousCellStep?: CellStep): CellStep;

package/dist/types/steps/table/utils/cells-at-column.d.ts

@@ -1,20 +0,0 @@
-import { TableRect } from '@atlaskit/editor-tables/table-map';
-import { NodeType } from '@atlaskit/editor-prosemirror/model';
-import { CellAttributes } from '../../../schema/nodes/tableNodes';
-export interface Cell {
-    from: number;
-    to: number;
-    row: number;
-    col: number;
-    attrs?: CellAttributes;
-    hasMergedCells: boolean;
-    type: NodeType;
-}
-/**
- * Helper to have a consistent way to iterate for all the cells in a column.
- * You can skip rows by passing the rows to skipped in the next arguments.
- * For example: `iter.next(1)` to skip the next row
- * @param rect
- * @param col
- */
-export declare function cellsAtColumn(rect: TableRect, col: number): Generator<Cell, void, number | undefined>;

package/dist/types/steps/table/utils/find-column.d.ts

@@ -1,8 +0,0 @@
-import { TableRect } from '@atlaskit/editor-tables/table-map';
-import { ColumnInfo } from '../types';
-/**
- * Try to find the right column based on the cell steps in column info..
- * @param columnInfo  - Map of cell positions sorted from lower to greather
- * @param rect - map rect
- */
-export declare function findColumn(columnInfo: ColumnInfo, rect: TableRect): number | null;

package/dist/types/steps/table/utils/get-table-rect-from-doc.d.ts

@@ -1,8 +0,0 @@
-import { Node as ProseMirrorNode } from '@atlaskit/editor-prosemirror/model';
-import { TableRect } from '@atlaskit/editor-tables/table-map';
-/**
- * Util to get the table rect from the docs
- * @param doc
- * @param tablePos
- */
-export declare function getTableRectFromDoc(doc: ProseMirrorNode, tablePos: number): TableRect;

package/dist/types/steps/table/utils/side-effects/rows.d.ts

@@ -1,25 +0,0 @@
-import { Node as ProseMirrorNode, Schema } from '@atlaskit/editor-prosemirror/model';
-import { Mappable, StepMap, Transform } from '@atlaskit/editor-prosemirror/transform';
-import { TableRect } from '@atlaskit/editor-tables/table-map';
-import { RowSideEffect, RowSideEffectJSON } from './types';
-import { Cell } from '../cells-at-column';
-interface RowsHandler {
-    handle: (tr: Transform, rect: TableRect, row: number, col: number, cell: Cell) => {
-        handled: boolean;
-        skipRows?: number;
-    };
-    end: (tr: Transform, rect: TableRect, col: number) => void;
-}
-export declare class RowsSideEffectHandler {
-    rows?: RowSideEffect[];
-    constructor(rowsSideEffect?: RowSideEffect[]);
-    private deleteHandler;
-    private addHandler;
-    start(isDelete: boolean): RowsHandler;
-    addRowRanges(ranges: number[], isDelete: boolean): number[];
-    map(mapping: Mappable): RowSideEffect[];
-    invert(originalDoc: ProseMirrorNode, isDelete: boolean, map: StepMap): RowSideEffect[] | undefined;
-    toJSON(): RowSideEffectJSON[] | undefined;
-    static fromJSON(schema: Schema, json: RowSideEffectJSON[]): RowSideEffect[];
-}
-export {};

package/dist/types/steps/table/utils/side-effects/side-effects.d.ts

@@ -1,15 +0,0 @@
-import { Node as ProseMirrorNode, Schema } from '@atlaskit/editor-prosemirror/model';
-import { Mappable, StepMap } from '@atlaskit/editor-prosemirror/transform';
-import { SideEffects, SideEffectsJSON } from './types';
-import { TableSideEffectHandler } from './table';
-import { RowsSideEffectHandler } from './rows';
-export declare class SideEffectsHandler {
-    table: TableSideEffectHandler;
-    rows: RowsSideEffectHandler;
-    constructor(sideEffects?: SideEffects);
-    getTableMap(isDelete: boolean): StepMap | undefined;
-    map(mapping: Mappable): SideEffects;
-    invert(originalDoc: ProseMirrorNode, isDelete: boolean, map: StepMap): SideEffects;
-    toJSON(): SideEffectsJSON | undefined;
-    static fromJSON(schema: Schema, json: SideEffectsJSON): SideEffects;
-}

package/dist/types/steps/table/utils/side-effects/table.d.ts

@@ -1,16 +0,0 @@
-import { Node as ProseMirrorNode, Schema } from '@atlaskit/editor-prosemirror/model';
-import { Mappable, StepMap, Transform } from '@atlaskit/editor-prosemirror/transform';
-import { TableRect } from '@atlaskit/editor-tables/table-map';
-import { TableSideEffect, TableSideEffectJSON } from './types';
-export declare class TableSideEffectHandler {
-    table?: TableSideEffect;
-    constructor(tableSideEffect?: TableSideEffect);
-    private addTableSideEffect;
-    handleAddTable(tr: Transform, isDelete: boolean): boolean;
-    handleRemoveTable(tr: Transform, tablePos: number, tableRect: TableRect, column: number | null, isDelete: boolean): boolean;
-    getTableMap(isDelete: boolean): StepMap | undefined;
-    map(mapping: Mappable): TableSideEffect | undefined;
-    invert(doc: ProseMirrorNode): TableSideEffect | undefined;
-    toJSON(): TableSideEffectJSON | undefined;
-    static fromJSON(schema: Schema, json: TableSideEffectJSON): TableSideEffect;
-}

package/dist/types/steps/table/utils/side-effects/types.d.ts

@@ -1,33 +0,0 @@
-import { Node as ProseMirrorNode } from '@atlaskit/editor-prosemirror/model';
-export interface TableSideEffect {
-    from: number;
-    to: number;
-    node: ProseMirrorNode;
-}
-export interface RowSideEffect {
-    from: number;
-    to: number;
-    rowNode: ProseMirrorNode;
-}
-export interface TableSideEffectJSON {
-    from: number;
-    to: number;
-    node: {
-        [key: string]: any;
-    };
-}
-export interface RowSideEffectJSON {
-    from: number;
-    to: number;
-    rowNode: {
-        [key: string]: any;
-    };
-}
-export type SideEffects = {
-    table?: TableSideEffect;
-    rows?: RowSideEffect[];
-};
-export type SideEffectsJSON = {
-    table?: TableSideEffectJSON;
-    rows?: RowSideEffectJSON[];
-};

package/dist/types/steps/table/utils/table-map.d.ts

@@ -1,6 +0,0 @@
-import { TableMap } from '@atlaskit/editor-tables/table-map';
-export declare const getCellIndex: (map: TableMap, row: number, col: number) => number;
-export declare function hasMergedColumns(map: TableMap, row: number, col: number): boolean;
-export declare function hasMergedRows(map: TableMap, row: number, col: number): boolean;
-export declare function isRootRow(map: TableMap, row: number, col: number): boolean;
-export declare function isRootCol(map: TableMap, row: number, col: number): boolean;