apply-edit 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,115 @@
+export type Tolerance = 'exact' | 'whitespace' | 'unicode';
+export type Strategy =
+  | 'exact'
+  | 'trailing-whitespace'
+  | 'indent-shift'
+  | 'line-trimmed'
+  | 'whitespace-collapsed'
+  | 'unicode-normalized'
+  | 'escape-tolerant'
+  | `unescaped:${'exact' | 'trailing-whitespace' | 'indent-shift' | 'line-trimmed' | 'whitespace-collapsed' | 'unicode-normalized'}`;
+export type LineEnding = 'lf' | 'crlf' | 'cr';
+export type FailureCode = 'empty-old' | 'no-change' | 'not-found' | 'ambiguous' | 'occurrence-out-of-range' | 'overlap';
+
+export interface Edit {
+  /** Text to find. Matched exactly first, then with whitespace, indentation, Unicode punctuation and escape tolerance. */
+  oldString: string;
+  /** Replacement text. Re-indented to the matched region when a non-exact strategy located it. */
+  newString: string;
+  /** Replace every match instead of refusing ambiguity. Default false. */
+  replaceAll?: boolean;
+  /** Select one match when several exist: 1-based from the start, negative from the end. */
+  occurrence?: number;
+  /** 1-based line where the match is expected; selects among candidates within three lines, otherwise only warns. */
+  line?: number;
+}
+
+export interface Options {
+  /** Loosest strategy allowed: 'exact', 'whitespace' (through whitespace-collapsed) or 'unicode' (default). */
+  tolerance?: Tolerance;
+  /** Recover literal escape sequences such as \n and \" in oldString. Default true. */
+  unescape?: boolean;
+  /** Compute the closest region on not-found. Default true. */
+  diagnostics?: boolean;
+}
+
+export interface Match {
+  /** UTF-16 offsets in the original text, end exclusive. */
+  start: number;
+  end: number;
+  /** 1-based inclusive lines in the original text. */
+  startLine: number;
+  endLine: number;
+}
+
+export interface Candidate {
+  startLine: number;
+  endLine: number;
+}
+
+export interface ClosestRegion {
+  startLine: number;
+  endLine: number;
+  /** Bigram similarity of the trimmed lines, 0 to 1. */
+  similarity: number;
+  /** Line-numbered lines of the closest region. */
+  preview: string;
+  /** First differing lines, at most five. */
+  differences: Array<{line: number; expected: string; actual: string}>;
+}
+
+export interface Failure {
+  ok: false;
+  code: FailureCode;
+  message: string;
+  lineEnding: LineEnding;
+  bom: boolean;
+  strategy?: Strategy;
+  candidates?: Candidate[];
+  closest?: ClosestRegion;
+  /** Index of the failing edit in applyEdits. */
+  index?: number;
+}
+
+export interface ApplyResult {
+  ok: true;
+  text: string;
+  strategy: Strategy;
+  replaced: number;
+  matches: Match[];
+  reindented: boolean;
+  warnings: string[];
+  lineEnding: LineEnding;
+  bom: boolean;
+}
+
+export interface FindResult {
+  ok: true;
+  strategy: Strategy;
+  matches: Match[];
+  lineEnding: LineEnding;
+  bom: boolean;
+}
+
+export interface AppliedEdit {
+  index: number;
+  strategy: Strategy;
+  matches: Match[];
+  reindented: boolean;
+  warnings: string[];
+}
+
+export interface ApplyEditsResult {
+  ok: true;
+  text: string;
+  applied: AppliedEdit[];
+  lineEnding: LineEnding;
+  bom: boolean;
+}
+
+/** Apply one edit. Never applies to more than one location unless replaceAll is set; ambiguity and misses are reported, not guessed. */
+export function applyEdit(text: string, edit: Edit, options?: Options): ApplyResult | Failure;
+/** Resolve every edit against the original text, refuse overlaps, and apply all of them or none. */
+export function applyEdits(text: string, edits: Edit[], options?: Options): ApplyEditsResult | Failure;
+/** Locate oldString without changing anything. */
+export function findEdit(text: string, oldString: string, options?: Options): FindResult | Failure;

package/dist/index.d.mts

@@ -0,0 +1,115 @@
+export type Tolerance = 'exact' | 'whitespace' | 'unicode';
+export type Strategy =
+  | 'exact'
+  | 'trailing-whitespace'
+  | 'indent-shift'
+  | 'line-trimmed'
+  | 'whitespace-collapsed'
+  | 'unicode-normalized'
+  | 'escape-tolerant'
+  | `unescaped:${'exact' | 'trailing-whitespace' | 'indent-shift' | 'line-trimmed' | 'whitespace-collapsed' | 'unicode-normalized'}`;
+export type LineEnding = 'lf' | 'crlf' | 'cr';
+export type FailureCode = 'empty-old' | 'no-change' | 'not-found' | 'ambiguous' | 'occurrence-out-of-range' | 'overlap';
+
+export interface Edit {
+  /** Text to find. Matched exactly first, then with whitespace, indentation, Unicode punctuation and escape tolerance. */
+  oldString: string;
+  /** Replacement text. Re-indented to the matched region when a non-exact strategy located it. */
+  newString: string;
+  /** Replace every match instead of refusing ambiguity. Default false. */
+  replaceAll?: boolean;
+  /** Select one match when several exist: 1-based from the start, negative from the end. */
+  occurrence?: number;
+  /** 1-based line where the match is expected; selects among candidates within three lines, otherwise only warns. */
+  line?: number;
+}
+
+export interface Options {
+  /** Loosest strategy allowed: 'exact', 'whitespace' (through whitespace-collapsed) or 'unicode' (default). */
+  tolerance?: Tolerance;
+  /** Recover literal escape sequences such as \n and \" in oldString. Default true. */
+  unescape?: boolean;
+  /** Compute the closest region on not-found. Default true. */
+  diagnostics?: boolean;
+}
+
+export interface Match {
+  /** UTF-16 offsets in the original text, end exclusive. */
+  start: number;
+  end: number;
+  /** 1-based inclusive lines in the original text. */
+  startLine: number;
+  endLine: number;
+}
+
+export interface Candidate {
+  startLine: number;
+  endLine: number;
+}
+
+export interface ClosestRegion {
+  startLine: number;
+  endLine: number;
+  /** Bigram similarity of the trimmed lines, 0 to 1. */
+  similarity: number;
+  /** Line-numbered lines of the closest region. */
+  preview: string;
+  /** First differing lines, at most five. */
+  differences: Array<{line: number; expected: string; actual: string}>;
+}
+
+export interface Failure {
+  ok: false;
+  code: FailureCode;
+  message: string;
+  lineEnding: LineEnding;
+  bom: boolean;
+  strategy?: Strategy;
+  candidates?: Candidate[];
+  closest?: ClosestRegion;
+  /** Index of the failing edit in applyEdits. */
+  index?: number;
+}
+
+export interface ApplyResult {
+  ok: true;
+  text: string;
+  strategy: Strategy;
+  replaced: number;
+  matches: Match[];
+  reindented: boolean;
+  warnings: string[];
+  lineEnding: LineEnding;
+  bom: boolean;
+}
+
+export interface FindResult {
+  ok: true;
+  strategy: Strategy;
+  matches: Match[];
+  lineEnding: LineEnding;
+  bom: boolean;
+}
+
+export interface AppliedEdit {
+  index: number;
+  strategy: Strategy;
+  matches: Match[];
+  reindented: boolean;
+  warnings: string[];
+}
+
+export interface ApplyEditsResult {
+  ok: true;
+  text: string;
+  applied: AppliedEdit[];
+  lineEnding: LineEnding;
+  bom: boolean;
+}
+
+/** Apply one edit. Never applies to more than one location unless replaceAll is set; ambiguity and misses are reported, not guessed. */
+export function applyEdit(text: string, edit: Edit, options?: Options): ApplyResult | Failure;
+/** Resolve every edit against the original text, refuse overlaps, and apply all of them or none. */
+export function applyEdits(text: string, edits: Edit[], options?: Options): ApplyEditsResult | Failure;
+/** Locate oldString without changing anything. */
+export function findEdit(text: string, oldString: string, options?: Options): FindResult | Failure;