@sanity/diff 5.8.1-next.13 → 5.8.1-next.2

package/lib/index.d.ts

@@ -1,101 +1,31 @@
 /**
- * Options available for doing diffs. Currently no options are defined.
- *
- * @public
- */
-type DiffOptions = Record<string, never>;
-/**
- * The recognized diff value types
- *
- * @public
- */
-type ValueType = 'array' | 'boolean' | 'null' | 'number' | 'object' | 'string' | 'undefined';
-/**
- * An "input" holds the _type_ of the value, the actual value, an optional annotation,
- * along with potential helper methods and properties, which vary dependending on the type
- *
- * @public
- */
-type Input<T> = NumberInput<T> | BooleanInput<T> | StringInput<T> | NullInput<T> | ObjectInput<T> | ArrayInput<T>;
-/**
- * Shared properties for all input types
+ * Diff for something that has been added - eg a property in an object,
+ * an item in an array, a segment of a string or similar.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
+ * @typeParam V - Value. The type of the destination (eg `after` or `to`) value.
  * @public
  */
-interface BaseInput<A> {
+export declare interface AddedDiff<A, V> {
+  action: "added";
+  isChanged: true;
+  fromValue: null | undefined;
+  toValue: V;
   annotation: A;
 }
+
 /**
- * Input type for strings, which supports slicing parts of the string while maintaining the
- * annotation of the parent.
- *
- * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
- * @public
- */
-interface StringInput<A> extends BaseInput<A> {
-  type: 'string';
-  value: string;
-  sliceAnnotation(start: number, end: number): {
-    text: string;
-    annotation: A;
-  }[];
-}
-/**
- * Input type for numbers.
- *
- * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
- * @public
- */
-interface NumberInput<A> extends BaseInput<A> {
-  type: 'number';
-  value: number;
-}
-/**
- * Input type for booleans.
- *
- * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
- * @public
- */
-interface BooleanInput<A> extends BaseInput<A> {
-  type: 'boolean';
-  value: boolean;
-}
-/**
- * Input type for `null` values.
- *
- * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
- * @public
- */
-interface NullInput<A> extends BaseInput<A> {
-  type: 'null';
-  value: null;
-}
-/**
- * Input type for object values. Caches the available keys, and allows retrieval of properties,
- * while automatically wrapping the retrieved property in a typed input container.
+ * Diff for an array value.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
+ * @typeParam V - Item value type.
  * @public
  */
-interface ObjectInput<A> extends BaseInput<A> {
-  type: 'object';
-  /**
-   * The actual object value
-   */
-  value: Record<string, unknown>;
-  /**
-   * The keys of the object
-   */
-  keys: string[];
-  /**
-   * Retrieve the property with the given `key`, automatically wrapping it in an input container.
-   *
-   * @param key - The key of the property you want to retrieve.
-   * @returns Typed input container, or `undefined` if the property does not exist
-   */
-  get(key: string): Input<A> | undefined;
-}
+export declare type ArrayDiff<A, V = unknown> = FullDiff<A, V[]> & {
+  type: "array";
+  items: ItemDiff<A>[];
+};
+
 /**
  * Input type for array values. Helper functions are available for getting the item and/or
  * annotation at a given index.
@@ -103,8 +33,8 @@ interface ObjectInput<A> extends BaseInput<A> {
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
  * @public
  */
-interface ArrayInput<A> extends BaseInput<A> {
-  type: 'array';
+export declare interface ArrayInput<A> extends BaseInput<A> {
+  type: "array";
   /**
    * The actual array value
    */
@@ -128,36 +58,38 @@ interface ArrayInput<A> extends BaseInput<A> {
    */
   annotationAt(index: number): A;
 }
+
 /**
- * Diff for something that has been added - eg a property in an object,
- * an item in an array, a segment of a string or similar.
+ * Shared properties for all input types
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
- * @typeParam V - Value. The type of the destination (eg `after` or `to`) value.
  * @public
  */
-interface AddedDiff<A, V> {
-  action: 'added';
-  isChanged: true;
-  fromValue: null | undefined;
-  toValue: V;
+export declare interface BaseInput<A> {
   annotation: A;
 }
+
 /**
- * Diff for something that has been removed - eg a property in an object,
- * an item in an array, a segment of a string or similar.
+ * Diff of a boolean.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
- * @typeParam V - Value. The type of the source (eg `before` or `from`) value.
  * @public
  */
-interface RemovedDiff<A, V> {
-  action: 'removed';
-  isChanged: true;
-  fromValue: V;
-  toValue: null | undefined;
-  annotation: A;
+export declare type BooleanDiff<A> = FullDiff<A, boolean> & {
+  type: "boolean";
+};
+
+/**
+ * Input type for booleans.
+ *
+ * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
+ * @public
+ */
+export declare interface BooleanInput<A> extends BaseInput<A> {
+  type: "boolean";
+  value: boolean;
 }
+
 /**
  * Diff for something that has changed - eg it was not added or removed, but the
  * value has changed "in place". Note that {@link TypeChangeDiff} is used for values that change
@@ -168,26 +100,51 @@ interface RemovedDiff<A, V> {
  * @typeParam V - Value. The type of the value.
  * @public
  */
-interface ChangedDiff<A, V> {
-  action: 'changed';
+export declare interface ChangedDiff<A, V> {
+  action: "changed";
   isChanged: true;
   fromValue: V;
   toValue: V;
   annotation: A;
 }
+
 /**
- * Diff (or lack thereof, in this case) for a value that has _not_ changed.
+ * Diff for any value type.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
- * @typeParam V - Value. The type of the destination (eg `after`) value.
  * @public
  */
-interface UnchangedDiff<A, V> {
-  action: 'unchanged';
-  isChanged: false;
-  fromValue: V;
-  toValue: V;
-}
+export declare type Diff<A> =
+  | NullDiff<A>
+  | StringDiff<A>
+  | NumberDiff<A>
+  | BooleanDiff<A>
+  | ObjectDiff<A>
+  | ArrayDiff<A>
+  | TypeChangeDiff<A>;
+
+/**
+ * Takes a `from` and `to` input and calulates a diff between the two
+ *
+ * @param fromInput - The source (`from`) input - use {@link wrap | the wrap() method} to generate an "input"
+ * @param toInput - The destination (`to`) input - use {@link wrap | the wrap() method} to generate an "input"
+ * @param options - Options for the diffing process - currently no options are defined
+ * @returns A diff object representing the change
+ * @public
+ */
+export declare function diffInput<A>(
+  fromInput: Input<A>,
+  toInput: Input<A>,
+  options?: DiffOptions,
+): Diff<A>;
+
+/**
+ * Options available for doing diffs. Currently no options are defined.
+ *
+ * @public
+ */
+export declare type DiffOptions = Record<string, never>;
+
 /**
  * Diff with all the possible diff types.
  *
@@ -195,59 +152,87 @@ interface UnchangedDiff<A, V> {
  * @typeParam V - Value. Type of the value repesented in the diff.
  * @public
  */
-type FullDiff<A, V> = AddedDiff<A, V> | RemovedDiff<A, V> | ChangedDiff<A, V> | UnchangedDiff<A, V>;
+export declare type FullDiff<A, V> =
+  | AddedDiff<A, V>
+  | RemovedDiff<A, V>
+  | ChangedDiff<A, V>
+  | UnchangedDiff<A, V>;
+
 /**
- * Diff of a string. Holds an additional array of string _segments_,
- * indicating which portions of the string is changed/unchanged.
+ * An "input" holds the _type_ of the value, the actual value, an optional annotation,
+ * along with potential helper methods and properties, which vary dependending on the type
+ *
+ * @public
+ */
+export declare type Input<T> =
+  | NumberInput<T>
+  | BooleanInput<T>
+  | StringInput<T>
+  | NullInput<T>
+  | ObjectInput<T>
+  | ArrayInput<T>;
+
+/**
+ * Diff of an item in an array, representing whether or not it has moved within the array,
+ * and if so, which index it was moved from/to.
+ *
+ * If not moved, `fromIndex` and `toIndex` will have the same value.
+ * If the item was added, `fromIndex` will be `undefined`.
+ * If the item was removed, `toIndex` will be `undefined`.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
  * @public
  */
-type StringDiff<A> = FullDiff<A, string> & {
-  type: 'string';
-  segments: StringDiffSegment<A>[];
-};
+export declare interface ItemDiff<A> {
+  fromIndex: number | undefined;
+  toIndex: number | undefined;
+  hasMoved: boolean;
+  diff: Diff<A>;
+  annotation: A;
+}
+
 /**
- * Diff of a number.
+ * Diff for a `null` value.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
  * @public
  */
-type NumberDiff<A> = FullDiff<A, number> & {
-  type: 'number';
+export declare type NullDiff<A> = FullDiff<A, null> & {
+  type: "null";
 };
+
 /**
- * Diff of a boolean.
+ * Input type for `null` values.
+ *
+ * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
+ * @public
+ */
+export declare interface NullInput<A> extends BaseInput<A> {
+  type: "null";
+  value: null;
+}
+
+/**
+ * Diff of a number.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
  * @public
  */
-type BooleanDiff<A> = FullDiff<A, boolean> & {
-  type: 'boolean';
+export declare type NumberDiff<A> = FullDiff<A, number> & {
+  type: "number";
 };
+
 /**
- * Diff for a value that has changed from one type to another.
- * For example, an object property going from `null` to `string`.
+ * Input type for numbers.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
  * @public
  */
-interface TypeChangeDiff<A> {
-  type: 'typeChange';
-  action: 'changed';
-  isChanged: true;
-  fromType: string;
-  fromValue: unknown;
-  fromDiff: Diff<A> & {
-    action: 'removed';
-  };
-  toType: string;
-  toValue: unknown;
-  toDiff: Diff<A> & {
-    action: 'added';
-  };
-  annotation: A;
+export declare interface NumberInput<A> extends BaseInput<A> {
+  type: "number";
+  value: number;
 }
+
 /**
  * Diff for an object value.
  *
@@ -255,94 +240,173 @@ interface TypeChangeDiff<A> {
  * @typeParam T - Value type.
  * @public
  */
-type ObjectDiff<A, T extends object = Record<string, any>> = FullDiff<A, T> & {
-  type: 'object';
+export declare type ObjectDiff<
+  A,
+  T extends object = Record<string, any>,
+> = FullDiff<A, T> & {
+  type: "object";
   fields: Record<keyof T, Diff<A>>;
 };
+
 /**
- * Diff for an array value.
+ * Input type for object values. Caches the available keys, and allows retrieval of properties,
+ * while automatically wrapping the retrieved property in a typed input container.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
- * @typeParam V - Item value type.
  * @public
  */
-type ArrayDiff<A, V = unknown> = FullDiff<A, V[]> & {
-  type: 'array';
-  items: ItemDiff<A>[];
-};
+export declare interface ObjectInput<A> extends BaseInput<A> {
+  type: "object";
+  /**
+   * The actual object value
+   */
+  value: Record<string, unknown>;
+  /**
+   * The keys of the object
+   */
+  keys: string[];
+  /**
+   * Retrieve the property with the given `key`, automatically wrapping it in an input container.
+   *
+   * @param key - The key of the property you want to retrieve.
+   * @returns Typed input container, or `undefined` if the property does not exist
+   */
+  get(key: string): Input<A> | undefined;
+}
+
 /**
- * Diff for a `null` value.
+ * Diff for something that has been removed - eg a property in an object,
+ * an item in an array, a segment of a string or similar.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
+ * @typeParam V - Value. The type of the source (eg `before` or `from`) value.
  * @public
  */
-type NullDiff<A> = FullDiff<A, null> & {
-  type: 'null';
-};
+export declare interface RemovedDiff<A, V> {
+  action: "removed";
+  isChanged: true;
+  fromValue: V;
+  toValue: null | undefined;
+  annotation: A;
+}
+
 /**
- * Diff for any value type.
+ * Diff of a string. Holds an additional array of string _segments_,
+ * indicating which portions of the string is changed/unchanged.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
  * @public
  */
-type Diff<A> = NullDiff<A> | StringDiff<A> | NumberDiff<A> | BooleanDiff<A> | ObjectDiff<A> | ArrayDiff<A> | TypeChangeDiff<A>;
+export declare type StringDiff<A> = FullDiff<A, string> & {
+  type: "string";
+  segments: StringDiffSegment<A>[];
+};
+
 /**
  * Diff of a string segment (eg a portion/slice), and whether or not it was changed or unchanged.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
  * @public
  */
-type StringDiffSegment<A> = StringSegmentChanged<A> | StringSegmentUnchanged;
+export declare type StringDiffSegment<A> =
+  | StringSegmentChanged<A>
+  | StringSegmentUnchanged;
+
+/**
+ * Input type for strings, which supports slicing parts of the string while maintaining the
+ * annotation of the parent.
+ *
+ * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
+ * @public
+ */
+export declare interface StringInput<A> extends BaseInput<A> {
+  type: "string";
+  value: string;
+  sliceAnnotation(
+    start: number,
+    end: number,
+  ): {
+    text: string;
+    annotation: A;
+  }[];
+}
+
 /**
  * Diff of a string segment that has changed.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
  * @public
  */
-interface StringSegmentChanged<A> {
-  type: 'stringSegment';
-  action: 'added' | 'removed';
+export declare interface StringSegmentChanged<A> {
+  type: "stringSegment";
+  action: "added" | "removed";
   text: string;
   annotation: A;
 }
+
 /**
  * Diff of a string segment that is unchanged.
  *
  * @public
  */
-interface StringSegmentUnchanged {
-  type: 'stringSegment';
-  action: 'unchanged';
+export declare interface StringSegmentUnchanged {
+  type: "stringSegment";
+  action: "unchanged";
   text: string;
 }
+
 /**
- * Diff of an item in an array, representing whether or not it has moved within the array,
- * and if so, which index it was moved from/to.
- *
- * If not moved, `fromIndex` and `toIndex` will have the same value.
- * If the item was added, `fromIndex` will be `undefined`.
- * If the item was removed, `toIndex` will be `undefined`.
+ * Diff for a value that has changed from one type to another.
+ * For example, an object property going from `null` to `string`.
  *
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
  * @public
  */
-interface ItemDiff<A> {
-  fromIndex: number | undefined;
-  toIndex: number | undefined;
-  hasMoved: boolean;
-  diff: Diff<A>;
+export declare interface TypeChangeDiff<A> {
+  type: "typeChange";
+  action: "changed";
+  isChanged: true;
+  fromType: string;
+  fromValue: unknown;
+  fromDiff: Diff<A> & {
+    action: "removed";
+  };
+  toType: string;
+  toValue: unknown;
+  toDiff: Diff<A> & {
+    action: "added";
+  };
   annotation: A;
 }
+
 /**
- * Takes a `from` and `to` input and calulates a diff between the two
+ * Diff (or lack thereof, in this case) for a value that has _not_ changed.
+ *
+ * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
+ * @typeParam V - Value. The type of the destination (eg `after`) value.
+ * @public
+ */
+export declare interface UnchangedDiff<A, V> {
+  action: "unchanged";
+  isChanged: false;
+  fromValue: V;
+  toValue: V;
+}
+
+/**
+ * The recognized diff value types
  *
- * @param fromInput - The source (`from`) input - use {@link wrap | the wrap() method} to generate an "input"
- * @param toInput - The destination (`to`) input - use {@link wrap | the wrap() method} to generate an "input"
- * @param options - Options for the diffing process - currently no options are defined
- * @returns A diff object representing the change
  * @public
  */
-declare function diffInput<A>(fromInput: Input<A>, toInput: Input<A>, options?: DiffOptions): Diff<A>;
+export declare type ValueType =
+  | "array"
+  | "boolean"
+  | "null"
+  | "number"
+  | "object"
+  | "string"
+  | "undefined";
+
 /**
  * Takes an input (any JSON-serializable value) and an annotation, and generates an input
  * object for it, to be used with {@link diffInput | the diffInput() method} and others.
@@ -353,5 +417,6 @@ declare function diffInput<A>(fromInput: Input<A>, toInput: Input<A>, options?:
  * @throws if `input` is not a JSON-serializable type
  * @public
  */
-declare function wrap<A>(input: unknown, annotation: A): Input<A>;
-export { AddedDiff, ArrayDiff, ArrayInput, BaseInput, BooleanDiff, BooleanInput, ChangedDiff, Diff, DiffOptions, FullDiff, Input, ItemDiff, NullDiff, NullInput, NumberDiff, NumberInput, ObjectDiff, ObjectInput, RemovedDiff, StringDiff, StringDiffSegment, StringInput, StringSegmentChanged, StringSegmentUnchanged, TypeChangeDiff, UnchangedDiff, ValueType, diffInput, wrap };
+export declare function wrap<A>(input: unknown, annotation: A): Input<A>;
+
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/diff",
-  "version": "5.8.1-next.13+cef58129bb",
+  "version": "5.8.1-next.2+d50c281353",
   "description": "Generates diffs between documents and primitive types",
   "keywords": [
     "cms",
@@ -40,9 +40,9 @@
     "@typescript/native-preview": "7.0.0-dev.20260112.1",
     "eslint": "^9.39.2",
     "rimraf": "^5.0.10",
-    "@repo/eslint-config": "5.8.1-next.13+cef58129bb",
-    "@repo/tsconfig": "5.8.1-next.13+cef58129bb",
-    "@repo/package.config": "5.8.1-next.13+cef58129bb"
+    "@repo/eslint-config": "5.8.1-next.2+d50c281353",
+    "@repo/package.config": "5.8.1-next.2+d50c281353",
+    "@repo/tsconfig": "5.8.1-next.2+d50c281353"
   },
   "engines": {
     "node": ">=20.19 <22 || >=22.12"