?HAMA

Edit File Size: 3.92 KB

/home/byroehnu/.trash/node_modules11/prosemirror-transform/src/step.ts

Text Base64

import {ReplaceError, Schema, Slice, Node} from "prosemirror-model"

import {StepMap, Mappable} from "./map"

const stepsByID: {[id: string]: {fromJSON(schema: Schema, json: any): Step}} = Object.create(null)

/// A step object represents an atomic change. It generally applies
/// only to the document it was created for, since the positions
/// stored in it will only make sense for that document.
///
/// New steps are defined by creating classes that extend `Step`,
/// overriding the `apply`, `invert`, `map`, `getMap` and `fromJSON`
/// methods, and registering your class with a unique
/// JSON-serialization identifier using
/// [`Step.jsonID`](#transform.Step^jsonID).
export abstract class Step {
  /// Applies this step to the given document, returning a result
  /// object that either indicates failure, if the step can not be
  /// applied to this document, or indicates success by containing a
  /// transformed document.
  abstract apply(doc: Node): StepResult

/// Get the step map that represents the changes made by this step,
  /// and which can be used to transform between positions in the old
  /// and the new document.
  getMap(): StepMap { return StepMap.empty }

/// Create an inverted version of this step. Needs the document as it
  /// was before the step as argument.
  abstract invert(doc: Node): Step

/// Map this step through a mappable thing, returning either a
  /// version of that step with its positions adjusted, or `null` if
  /// the step was entirely deleted by the mapping.
  abstract map(mapping: Mappable): Step | null

/// 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 { return 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.
  abstract toJSON(): any

/// Deserialize a step from its JSON representation. Will call
  /// through to the step class' own implementation of this method.
  static fromJSON(schema: Schema, json: any): Step {
    if (!json || !json.stepType) throw new RangeError("Invalid input for Step.fromJSON")
    let type = stepsByID[json.stepType]
    if (!type) throw new RangeError(`No step type ${json.stepType} defined`)
    return type.fromJSON(schema, json)
  }

/// To be able to serialize steps to JSON, each step needs a string
  /// ID to attach to its JSON representation. Use this method to
  /// register an ID for your step classes. Try to pick something
  /// that's unlikely to clash with steps from other modules.
  static jsonID(id: string, stepClass: {fromJSON(schema: Schema, json: any): Step}) {
    if (id in stepsByID) throw new RangeError("Duplicate use of step JSON ID " + id)
    stepsByID[id] = stepClass
    ;(stepClass as any).prototype.jsonID = id
    return stepClass
  }
}

/// The result of [applying](#transform.Step.apply) a step. Contains either a
/// new document or a failure value.
export class StepResult {
  /// @internal
  constructor(
    /// The transformed document, if successful.
    readonly doc: Node | null,
    /// The failure message, if unsuccessful.
    readonly failed: string | null
  ) {}

/// Create a successful step result.
  static ok(doc: Node) { return new StepResult(doc, null) }

/// Create a failed step result.
  static fail(message: string) { return new StepResult(null, message) }

/// Call [`Node.replace`](#model.Node.replace) with the given
  /// arguments. Create a successful result if it succeeds, and a
  /// failed one if it throws a `ReplaceError`.
  static fromReplace(doc: Node, from: number, to: number, slice: Slice) {
    try {
      return StepResult.ok(doc.replace(from, to, slice))
    } catch (e) {
      if (e instanceof ReplaceError) return StepResult.fail(e.message)
      throw e
    }
  }
}

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
attr_step.ts	2.61 KB	lrw-r--r--	2026-02-28 00:28:14	Edit Download recursive recursive
index.ts	561 B	lrw-r--r--	2026-02-28 00:28:24	Edit Download recursive recursive
map.ts	10.71 KB	lrw-r--r--	2026-02-28 00:28:26	Edit Download recursive recursive
mark.ts	3.86 KB	lrw-r--r--	2026-02-28 00:28:28	Edit Download recursive recursive
mark_step.ts	7.18 KB	lrw-r--r--	2026-02-28 00:28:28	Edit Download recursive recursive
README.md	1.56 KB	lrw-r--r--	2026-02-28 00:28:08	Edit Download recursive recursive
replace.ts	19.77 KB	lrw-r--r--	2026-02-28 00:28:32	Edit Download recursive recursive
replace_step.ts	7.04 KB	lrw-r--r--	2026-02-28 00:28:30	Edit Download recursive recursive
step.ts	3.92 KB	lrw-r--r--	2026-02-28 00:28:34	Edit Download recursive recursive
structure.ts	15.09 KB	lrw-r--r--	2026-02-28 00:28:36	Edit Download recursive recursive
transform.ts	10.18 KB	lrw-r--r--	2026-02-28 00:28:38	Edit Download recursive recursive

Directory Contents