json-diff-ts 4.10.0 → 5.0.0-alpha.0

package/dist/index.d.ts

@@ -25,6 +25,9 @@ interface IAtomicChange {
     oldValue?: any;
 }
 interface Options {
+    /** Identify array elements by a stable key instead of index. */
+    arrayIdentityKeys?: EmbeddedObjKeysType | EmbeddedObjKeysMapType;
+    /** @deprecated Use `arrayIdentityKeys` instead. */
     embeddedObjKeys?: EmbeddedObjKeysType | EmbeddedObjKeysMapType;
     keysToSkip?: readonly string[];
     treatTypeChangeAsReplace?: boolean;
@@ -119,4 +122,99 @@ declare const enrich: (object: any) => IComparisonEnrichedNode;
 declare const applyChangelist: (object: IComparisonEnrichedNode, changelist: IAtomicChange[]) => IComparisonEnrichedNode;
 declare const compare: (oldObject: any, newObject: any) => IComparisonEnrichedNode;
 
-export { type Changeset, CompareOperation, type EmbeddedObjKeysMapType, type EmbeddedObjKeysType, type IAtomicChange, type IChange, type IComparisonEnrichedNode, Operation, type Options, applyChangelist, applyChangeset, atomizeChangeset, compare, createContainer, createValue, diff, enrich, getTypeOfObj, revertChangeset, unatomizeChangeset };
+type DeltaPathSegment = {
+    type: 'root';
+} | {
+    type: 'property';
+    name: string;
+} | {
+    type: 'index';
+    index: number;
+} | {
+    type: 'keyFilter';
+    property: string;
+    value: unknown;
+} | {
+    type: 'valueFilter';
+    value: unknown;
+};
+/**
+ * Format a value as a canonical JSON Delta filter literal.
+ * Strings → single-quoted with doubled-quote escaping.
+ * Numbers, booleans, null → plain JSON representation.
+ */
+declare function formatFilterLiteral(value: unknown): string;
+/**
+ * Parse a filter literal string into a typed JS value.
+ * Reverse of formatFilterLiteral.
+ */
+declare function parseFilterLiteral(s: string): unknown;
+/**
+ * Parse a JSON Delta Path string into an array of typed segments.
+ * Follows the grammar from the JSON Delta spec Section 5.1.
+ */
+declare function parseDeltaPath(path: string): DeltaPathSegment[];
+/**
+ * Build a canonical JSON Delta Path string from an array of segments.
+ */
+declare function buildDeltaPath(segments: DeltaPathSegment[]): string;
+
+type DeltaOp = 'add' | 'remove' | 'replace';
+interface IDeltaOperation {
+    op: DeltaOp;
+    path: string;
+    value?: any;
+    oldValue?: any;
+    [key: string]: any;
+}
+interface IJsonDelta {
+    format: 'json-delta';
+    version: number;
+    operations: IDeltaOperation[];
+    [key: string]: any;
+}
+interface DeltaOptions extends Options {
+    /** Include oldValue for reversibility. Default: true */
+    reversible?: boolean;
+}
+declare function validateDelta(delta: unknown): {
+    valid: boolean;
+    errors: string[];
+};
+/**
+ * Compute a canonical JSON Delta between two objects.
+ * This is the spec-conformant delta producer.
+ */
+declare function diffDelta(oldObj: any, newObj: any, options?: DeltaOptions): IJsonDelta;
+/**
+ * Convert an existing v4 changeset or atomic changes to a JSON Delta document.
+ * Best-effort bridge — filter literals will always be string-quoted.
+ * Use `diffDelta()` for canonical spec-conformant output.
+ */
+declare function toDelta(changeset: Changeset | IAtomicChange[], options?: {
+    reversible?: boolean;
+}): IJsonDelta;
+/**
+ * Convert a JSON Delta document to v4 atomic changes.
+ * Returns IAtomicChange[] — one atom per delta operation.
+ * Use `unatomizeChangeset(fromDelta(delta))` if you need a hierarchical Changeset.
+ */
+declare function fromDelta(delta: IJsonDelta): IAtomicChange[];
+/**
+ * Compute the inverse of a JSON Delta document (spec Section 9.2).
+ * Requires all replace/remove operations to have oldValue.
+ */
+declare function invertDelta(delta: IJsonDelta): IJsonDelta;
+/**
+ * Apply a JSON Delta document to an object.
+ * Processes operations sequentially. Handles root operations directly.
+ * Returns the result (MUST use return value for root primitive replacements).
+ */
+declare function applyDelta(obj: any, delta: IJsonDelta): any;
+/**
+ * Revert a JSON Delta by computing its inverse and applying it.
+ * Requires all replace/remove operations to have oldValue.
+ */
+declare function revertDelta(obj: any, delta: IJsonDelta): any;
+
+export { type Changeset, CompareOperation, type DeltaOp, type DeltaOptions, type DeltaPathSegment, type EmbeddedObjKeysMapType, type EmbeddedObjKeysType, type IAtomicChange, type IChange, type IComparisonEnrichedNode, type IDeltaOperation, type IJsonDelta, Operation, type Options, applyChangelist, applyChangeset, applyDelta, atomizeChangeset, buildDeltaPath, compare, createContainer, createValue, diff, diffDelta, enrich, formatFilterLiteral, fromDelta, getTypeOfObj, invertDelta, parseDeltaPath, parseFilterLiteral, revertChangeset, revertDelta, toDelta, unatomizeChangeset, validateDelta };