json-diff-ts 5.0.0-alpha.2 → 5.0.0-alpha.4

package/dist/index.d.cts

@@ -151,7 +151,7 @@ declare const comparisonToFlatList: (node: IComparisonEnrichedNode, options?: {
     includeUnchanged?: boolean;
 }) => IFlatChange[];
 
-type DeltaPathSegment = {
+type AtomPathSegment = {
     type: 'root';
 } | {
     type: 'property';
@@ -168,7 +168,7 @@ type DeltaPathSegment = {
     value: unknown;
 };
 /**
- * Format a value as a canonical JSON Delta filter literal.
+ * Format a value as a canonical JSON Atom filter literal.
  * Strings → single-quoted with doubled-quote escaping.
  * Numbers, booleans, null → plain JSON representation.
  */
@@ -179,127 +179,127 @@ declare function formatFilterLiteral(value: unknown): string;
  */
 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.
+ * Parse a JSON Atom Path string into an array of typed segments.
+ * Follows the grammar from the JSON Atom spec Section 5.1.
  */
-declare function parseDeltaPath(path: string): DeltaPathSegment[];
+declare function parseAtomPath(path: string): AtomPathSegment[];
 /**
- * Build a canonical JSON Delta Path string from an array of segments.
+ * Build a canonical JSON Atom Path string from an array of segments.
  */
-declare function buildDeltaPath(segments: DeltaPathSegment[]): string;
+declare function buildAtomPath(segments: AtomPathSegment[]): string;
 
-type DeltaOp = 'add' | 'remove' | 'replace';
-interface IDeltaOperation {
-    op: DeltaOp;
+type AtomOp = 'add' | 'remove' | 'replace';
+interface IAtomOperation {
+    op: AtomOp;
     path: string;
     value?: any;
     oldValue?: any;
     [key: string]: any;
 }
-interface IJsonDelta {
-    format: 'json-delta';
+interface IJsonAtom {
+    format: 'json-atom';
     version: number;
-    operations: IDeltaOperation[];
+    operations: IAtomOperation[];
     [key: string]: any;
 }
-interface DeltaOptions extends Options {
+interface AtomOptions extends Options {
     /** Include oldValue for reversibility. Default: true */
     reversible?: boolean;
 }
-declare function validateDelta(delta: unknown): {
+declare function validateAtom(atom: unknown): {
     valid: boolean;
     errors: string[];
 };
 /**
- * Compute a canonical JSON Delta between two objects.
- * This is the spec-conformant delta producer.
+ * Compute a canonical JSON Atom between two objects.
+ * This is the spec-conformant atom producer.
  */
-declare function diffDelta(oldObj: any, newObj: any, options?: DeltaOptions): IJsonDelta;
+declare function diffAtom(oldObj: any, newObj: any, options?: AtomOptions): IJsonAtom;
 /**
- * Convert an existing v4 changeset or atomic changes to a JSON Delta document.
+ * Convert an existing v4 changeset or atomic changes to a JSON Atom document.
  * Best-effort bridge — filter literals will always be string-quoted.
- * Use `diffDelta()` for canonical spec-conformant output.
+ * Use `diffAtom()` for canonical spec-conformant output.
  */
-declare function toDelta(changeset: Changeset | IAtomicChange[], options?: {
+declare function toAtom(changeset: Changeset | IAtomicChange[], options?: {
     reversible?: boolean;
-}): IJsonDelta;
+}): IJsonAtom;
 /**
- * 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.
+ * Convert a JSON Atom document to v4 atomic changes.
+ * Returns IAtomicChange[] — one atom per atom operation.
+ * Use `unatomizeChangeset(fromAtom(atom))` if you need a hierarchical Changeset.
  */
-declare function fromDelta(delta: IJsonDelta): IAtomicChange[];
+declare function fromAtom(atom: IJsonAtom): IAtomicChange[];
 /**
- * Compute the inverse of a JSON Delta document (spec Section 9.2).
+ * Compute the inverse of a JSON Atom document (spec Section 9.2).
  * Requires all replace/remove operations to have oldValue.
  */
-declare function invertDelta(delta: IJsonDelta): IJsonDelta;
+declare function invertAtom(atom: IJsonAtom): IJsonAtom;
 /**
- * Apply a JSON Delta document to an object.
+ * Apply a JSON Atom 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;
+declare function applyAtom(obj: any, atom: IJsonAtom): any;
 /**
- * Revert a JSON Delta by computing its inverse and applying it.
+ * Revert a JSON Atom by computing its inverse and applying it.
  * Requires all replace/remove operations to have oldValue.
  */
-declare function revertDelta(obj: any, delta: IJsonDelta): any;
+declare function revertAtom(obj: any, atom: IJsonAtom): any;
 
 /**
  * Returns a copy of the operation containing only spec-defined keys
  * (`op`, `path`, `value`, `oldValue`). Complement of `operationExtensions`.
  */
-declare function operationSpecDict(op: IDeltaOperation): IDeltaOperation;
+declare function operationSpecDict(op: IAtomOperation): IAtomOperation;
 /**
  * Returns a record of non-spec keys from the operation (extension properties).
  * Complement of `operationSpecDict`.
  */
-declare function operationExtensions(op: IDeltaOperation): Record<string, any>;
+declare function operationExtensions(op: IAtomOperation): Record<string, any>;
 /**
  * Returns the terminal property name from the operation's path, or `null`
  * for root, index, and filter segments.
  */
-declare function leafProperty(op: IDeltaOperation): string | null;
+declare function leafProperty(op: IAtomOperation): string | null;
 /**
- * Returns a copy of the delta with only spec-defined keys in the envelope
+ * Returns a copy of the atom with only spec-defined keys in the envelope
  * and each operation. Strips all extension properties.
  */
-declare function deltaSpecDict(delta: IJsonDelta): IJsonDelta;
+declare function atomSpecDict(atom: IJsonAtom): IJsonAtom;
 /**
- * Returns a record of non-spec keys from the delta envelope.
- * Complement of `deltaSpecDict`.
+ * Returns a record of non-spec keys from the atom envelope.
+ * Complement of `atomSpecDict`.
  */
-declare function deltaExtensions(delta: IJsonDelta): Record<string, any>;
+declare function atomExtensions(atom: IJsonAtom): Record<string, any>;
 /**
- * Transforms each operation in the delta using the provided function.
- * Returns a new delta (immutable). Preserves all envelope properties.
+ * Transforms each operation in the atom using the provided function.
+ * Returns a new atom (immutable). Preserves all envelope properties.
  */
-declare function deltaMap(delta: IJsonDelta, fn: (op: IDeltaOperation, index: number) => IDeltaOperation): IJsonDelta;
+declare function atomMap(atom: IJsonAtom, fn: (op: IAtomOperation, index: number) => IAtomOperation): IJsonAtom;
 /**
- * Returns a new delta with the given extension properties merged onto every
- * operation. Immutable — the original delta is not modified.
+ * Returns a new atom with the given extension properties merged onto every
+ * operation. Immutable — the original atom is not modified.
  */
-declare function deltaStamp(delta: IJsonDelta, extensions: Record<string, any>): IJsonDelta;
+declare function atomStamp(atom: IJsonAtom, extensions: Record<string, any>): IJsonAtom;
 /**
- * Groups operations in the delta by the result of `keyFn`. Returns a record
- * mapping each key to a sub-delta containing only the matching operations.
- * Each sub-delta preserves all envelope properties.
+ * Groups operations in the atom by the result of `keyFn`. Returns a record
+ * mapping each key to a sub-atom containing only the matching operations.
+ * Each sub-atom preserves all envelope properties.
  */
-declare function deltaGroupBy(delta: IJsonDelta, keyFn: (op: IDeltaOperation) => string): Record<string, IJsonDelta>;
-interface SquashDeltasOptions extends DeltaOptions {
-    /** Pre-computed final state. When provided with deltas, used instead of computing. */
+declare function atomGroupBy(atom: IJsonAtom, keyFn: (op: IAtomOperation) => string): Record<string, IJsonAtom>;
+interface SquashAtomsOptions extends AtomOptions {
+    /** Pre-computed final state. When provided with atoms, used instead of computing. */
     target?: any;
-    /** Verify that `target` matches sequential application of deltas. Default: true. */
+    /** Verify that `target` matches sequential application of atoms. Default: true. */
     verifyTarget?: boolean;
 }
 /**
- * Compacts multiple deltas into a single net-effect delta. The result is
- * equivalent to applying all deltas sequentially, but expressed as a single
+ * Compacts multiple atoms into a single net-effect atom. The result is
+ * equivalent to applying all atoms sequentially, but expressed as a single
  * `source → final` diff.
  *
- * Envelope extensions from all input deltas are merged (last-wins on conflict).
+ * Envelope extensions from all input atoms are merged (last-wins on conflict).
  */
-declare function squashDeltas(source: any, deltas: IJsonDelta[], options?: SquashDeltasOptions): IJsonDelta;
+declare function squashAtoms(source: any, atoms: IJsonAtom[], options?: SquashAtomsOptions): IJsonAtom;
 
-export { type Changeset, CompareOperation, type DeltaOp, type DeltaOptions, type DeltaPathSegment, type EmbeddedObjKeysMapType, type EmbeddedObjKeysType, type IAtomicChange, type IChange, type IComparisonDict, type IComparisonEnrichedNode, type IDeltaOperation, type IFlatChange, type IJsonDelta, Operation, type Options, type SquashDeltasOptions, applyChangelist, applyChangeset, applyDelta, atomizeChangeset, buildDeltaPath, compare, comparisonToDict, comparisonToFlatList, createContainer, createValue, deltaExtensions, deltaGroupBy, deltaMap, deltaSpecDict, deltaStamp, diff, diffDelta, enrich, formatFilterLiteral, fromDelta, getTypeOfObj, invertDelta, leafProperty, operationExtensions, operationSpecDict, parseDeltaPath, parseFilterLiteral, revertChangeset, revertDelta, squashDeltas, toDelta, unatomizeChangeset, validateDelta };
+export { type AtomOp, type AtomOptions, type AtomPathSegment, type Changeset, CompareOperation, type EmbeddedObjKeysMapType, type EmbeddedObjKeysType, type IAtomOperation, type IAtomicChange, type IChange, type IComparisonDict, type IComparisonEnrichedNode, type IFlatChange, type IJsonAtom, Operation, type Options, type SquashAtomsOptions, applyAtom, applyChangelist, applyChangeset, atomExtensions, atomGroupBy, atomMap, atomSpecDict, atomStamp, atomizeChangeset, buildAtomPath, compare, comparisonToDict, comparisonToFlatList, createContainer, createValue, diff, diffAtom, enrich, formatFilterLiteral, fromAtom, getTypeOfObj, invertAtom, leafProperty, operationExtensions, operationSpecDict, parseAtomPath, parseFilterLiteral, revertAtom, revertChangeset, squashAtoms, toAtom, unatomizeChangeset, validateAtom };

package/dist/index.d.ts

@@ -151,7 +151,7 @@ declare const comparisonToFlatList: (node: IComparisonEnrichedNode, options?: {
     includeUnchanged?: boolean;
 }) => IFlatChange[];
 
-type DeltaPathSegment = {
+type AtomPathSegment = {
     type: 'root';
 } | {
     type: 'property';
@@ -168,7 +168,7 @@ type DeltaPathSegment = {
     value: unknown;
 };
 /**
- * Format a value as a canonical JSON Delta filter literal.
+ * Format a value as a canonical JSON Atom filter literal.
  * Strings → single-quoted with doubled-quote escaping.
  * Numbers, booleans, null → plain JSON representation.
  */
@@ -179,127 +179,127 @@ declare function formatFilterLiteral(value: unknown): string;
  */
 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.
+ * Parse a JSON Atom Path string into an array of typed segments.
+ * Follows the grammar from the JSON Atom spec Section 5.1.
  */
-declare function parseDeltaPath(path: string): DeltaPathSegment[];
+declare function parseAtomPath(path: string): AtomPathSegment[];
 /**
- * Build a canonical JSON Delta Path string from an array of segments.
+ * Build a canonical JSON Atom Path string from an array of segments.
  */
-declare function buildDeltaPath(segments: DeltaPathSegment[]): string;
+declare function buildAtomPath(segments: AtomPathSegment[]): string;
 
-type DeltaOp = 'add' | 'remove' | 'replace';
-interface IDeltaOperation {
-    op: DeltaOp;
+type AtomOp = 'add' | 'remove' | 'replace';
+interface IAtomOperation {
+    op: AtomOp;
     path: string;
     value?: any;
     oldValue?: any;
     [key: string]: any;
 }
-interface IJsonDelta {
-    format: 'json-delta';
+interface IJsonAtom {
+    format: 'json-atom';
     version: number;
-    operations: IDeltaOperation[];
+    operations: IAtomOperation[];
     [key: string]: any;
 }
-interface DeltaOptions extends Options {
+interface AtomOptions extends Options {
     /** Include oldValue for reversibility. Default: true */
     reversible?: boolean;
 }
-declare function validateDelta(delta: unknown): {
+declare function validateAtom(atom: unknown): {
     valid: boolean;
     errors: string[];
 };
 /**
- * Compute a canonical JSON Delta between two objects.
- * This is the spec-conformant delta producer.
+ * Compute a canonical JSON Atom between two objects.
+ * This is the spec-conformant atom producer.
  */
-declare function diffDelta(oldObj: any, newObj: any, options?: DeltaOptions): IJsonDelta;
+declare function diffAtom(oldObj: any, newObj: any, options?: AtomOptions): IJsonAtom;
 /**
- * Convert an existing v4 changeset or atomic changes to a JSON Delta document.
+ * Convert an existing v4 changeset or atomic changes to a JSON Atom document.
  * Best-effort bridge — filter literals will always be string-quoted.
- * Use `diffDelta()` for canonical spec-conformant output.
+ * Use `diffAtom()` for canonical spec-conformant output.
  */
-declare function toDelta(changeset: Changeset | IAtomicChange[], options?: {
+declare function toAtom(changeset: Changeset | IAtomicChange[], options?: {
     reversible?: boolean;
-}): IJsonDelta;
+}): IJsonAtom;
 /**
- * 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.
+ * Convert a JSON Atom document to v4 atomic changes.
+ * Returns IAtomicChange[] — one atom per atom operation.
+ * Use `unatomizeChangeset(fromAtom(atom))` if you need a hierarchical Changeset.
  */
-declare function fromDelta(delta: IJsonDelta): IAtomicChange[];
+declare function fromAtom(atom: IJsonAtom): IAtomicChange[];
 /**
- * Compute the inverse of a JSON Delta document (spec Section 9.2).
+ * Compute the inverse of a JSON Atom document (spec Section 9.2).
  * Requires all replace/remove operations to have oldValue.
  */
-declare function invertDelta(delta: IJsonDelta): IJsonDelta;
+declare function invertAtom(atom: IJsonAtom): IJsonAtom;
 /**
- * Apply a JSON Delta document to an object.
+ * Apply a JSON Atom 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;
+declare function applyAtom(obj: any, atom: IJsonAtom): any;
 /**
- * Revert a JSON Delta by computing its inverse and applying it.
+ * Revert a JSON Atom by computing its inverse and applying it.
  * Requires all replace/remove operations to have oldValue.
  */
-declare function revertDelta(obj: any, delta: IJsonDelta): any;
+declare function revertAtom(obj: any, atom: IJsonAtom): any;
 
 /**
  * Returns a copy of the operation containing only spec-defined keys
  * (`op`, `path`, `value`, `oldValue`). Complement of `operationExtensions`.
  */
-declare function operationSpecDict(op: IDeltaOperation): IDeltaOperation;
+declare function operationSpecDict(op: IAtomOperation): IAtomOperation;
 /**
  * Returns a record of non-spec keys from the operation (extension properties).
  * Complement of `operationSpecDict`.
  */
-declare function operationExtensions(op: IDeltaOperation): Record<string, any>;
+declare function operationExtensions(op: IAtomOperation): Record<string, any>;
 /**
  * Returns the terminal property name from the operation's path, or `null`
  * for root, index, and filter segments.
  */
-declare function leafProperty(op: IDeltaOperation): string | null;
+declare function leafProperty(op: IAtomOperation): string | null;
 /**
- * Returns a copy of the delta with only spec-defined keys in the envelope
+ * Returns a copy of the atom with only spec-defined keys in the envelope
  * and each operation. Strips all extension properties.
  */
-declare function deltaSpecDict(delta: IJsonDelta): IJsonDelta;
+declare function atomSpecDict(atom: IJsonAtom): IJsonAtom;
 /**
- * Returns a record of non-spec keys from the delta envelope.
- * Complement of `deltaSpecDict`.
+ * Returns a record of non-spec keys from the atom envelope.
+ * Complement of `atomSpecDict`.
  */
-declare function deltaExtensions(delta: IJsonDelta): Record<string, any>;
+declare function atomExtensions(atom: IJsonAtom): Record<string, any>;
 /**
- * Transforms each operation in the delta using the provided function.
- * Returns a new delta (immutable). Preserves all envelope properties.
+ * Transforms each operation in the atom using the provided function.
+ * Returns a new atom (immutable). Preserves all envelope properties.
  */
-declare function deltaMap(delta: IJsonDelta, fn: (op: IDeltaOperation, index: number) => IDeltaOperation): IJsonDelta;
+declare function atomMap(atom: IJsonAtom, fn: (op: IAtomOperation, index: number) => IAtomOperation): IJsonAtom;
 /**
- * Returns a new delta with the given extension properties merged onto every
- * operation. Immutable — the original delta is not modified.
+ * Returns a new atom with the given extension properties merged onto every
+ * operation. Immutable — the original atom is not modified.
  */
-declare function deltaStamp(delta: IJsonDelta, extensions: Record<string, any>): IJsonDelta;
+declare function atomStamp(atom: IJsonAtom, extensions: Record<string, any>): IJsonAtom;
 /**
- * Groups operations in the delta by the result of `keyFn`. Returns a record
- * mapping each key to a sub-delta containing only the matching operations.
- * Each sub-delta preserves all envelope properties.
+ * Groups operations in the atom by the result of `keyFn`. Returns a record
+ * mapping each key to a sub-atom containing only the matching operations.
+ * Each sub-atom preserves all envelope properties.
  */
-declare function deltaGroupBy(delta: IJsonDelta, keyFn: (op: IDeltaOperation) => string): Record<string, IJsonDelta>;
-interface SquashDeltasOptions extends DeltaOptions {
-    /** Pre-computed final state. When provided with deltas, used instead of computing. */
+declare function atomGroupBy(atom: IJsonAtom, keyFn: (op: IAtomOperation) => string): Record<string, IJsonAtom>;
+interface SquashAtomsOptions extends AtomOptions {
+    /** Pre-computed final state. When provided with atoms, used instead of computing. */
     target?: any;
-    /** Verify that `target` matches sequential application of deltas. Default: true. */
+    /** Verify that `target` matches sequential application of atoms. Default: true. */
     verifyTarget?: boolean;
 }
 /**
- * Compacts multiple deltas into a single net-effect delta. The result is
- * equivalent to applying all deltas sequentially, but expressed as a single
+ * Compacts multiple atoms into a single net-effect atom. The result is
+ * equivalent to applying all atoms sequentially, but expressed as a single
  * `source → final` diff.
  *
- * Envelope extensions from all input deltas are merged (last-wins on conflict).
+ * Envelope extensions from all input atoms are merged (last-wins on conflict).
  */
-declare function squashDeltas(source: any, deltas: IJsonDelta[], options?: SquashDeltasOptions): IJsonDelta;
+declare function squashAtoms(source: any, atoms: IJsonAtom[], options?: SquashAtomsOptions): IJsonAtom;
 
-export { type Changeset, CompareOperation, type DeltaOp, type DeltaOptions, type DeltaPathSegment, type EmbeddedObjKeysMapType, type EmbeddedObjKeysType, type IAtomicChange, type IChange, type IComparisonDict, type IComparisonEnrichedNode, type IDeltaOperation, type IFlatChange, type IJsonDelta, Operation, type Options, type SquashDeltasOptions, applyChangelist, applyChangeset, applyDelta, atomizeChangeset, buildDeltaPath, compare, comparisonToDict, comparisonToFlatList, createContainer, createValue, deltaExtensions, deltaGroupBy, deltaMap, deltaSpecDict, deltaStamp, diff, diffDelta, enrich, formatFilterLiteral, fromDelta, getTypeOfObj, invertDelta, leafProperty, operationExtensions, operationSpecDict, parseDeltaPath, parseFilterLiteral, revertChangeset, revertDelta, squashDeltas, toDelta, unatomizeChangeset, validateDelta };
+export { type AtomOp, type AtomOptions, type AtomPathSegment, type Changeset, CompareOperation, type EmbeddedObjKeysMapType, type EmbeddedObjKeysType, type IAtomOperation, type IAtomicChange, type IChange, type IComparisonDict, type IComparisonEnrichedNode, type IFlatChange, type IJsonAtom, Operation, type Options, type SquashAtomsOptions, applyAtom, applyChangelist, applyChangeset, atomExtensions, atomGroupBy, atomMap, atomSpecDict, atomStamp, atomizeChangeset, buildAtomPath, compare, comparisonToDict, comparisonToFlatList, createContainer, createValue, diff, diffAtom, enrich, formatFilterLiteral, fromAtom, getTypeOfObj, invertAtom, leafProperty, operationExtensions, operationSpecDict, parseAtomPath, parseFilterLiteral, revertAtom, revertChangeset, squashAtoms, toAtom, unatomizeChangeset, validateAtom };