@sanity/diff 5.8.0 → 5.8.1-next.10

package/lib/index.d.ts

@@ -7,11 +7,11 @@
  * @public
  */
 export declare interface AddedDiff<A, V> {
-  action: 'added'
-  isChanged: true
-  fromValue: null | undefined
-  toValue: V
-  annotation: A
+  action: "added";
+  isChanged: true;
+  fromValue: null | undefined;
+  toValue: V;
+  annotation: A;
 }
 
 /**
@@ -22,9 +22,9 @@ export declare interface AddedDiff<A, V> {
  * @public
  */
 export declare type ArrayDiff<A, V = unknown> = FullDiff<A, V[]> & {
-  type: 'array'
-  items: ItemDiff<A>[]
-}
+  type: "array";
+  items: ItemDiff<A>[];
+};
 
 /**
  * Input type for array values. Helper functions are available for getting the item and/or
@@ -34,29 +34,29 @@ export declare type ArrayDiff<A, V = unknown> = FullDiff<A, V[]> & {
  * @public
  */
 export declare interface ArrayInput<A> extends BaseInput<A> {
-  type: 'array'
+  type: "array";
   /**
    * The actual array value
    */
-  value: unknown[]
+  value: unknown[];
   /**
    * The length of the array
    */
-  length: number
+  length: number;
   /**
    * Retrieve the value at the given `index`, automatically wrapping it in an input container.
    *
    * @param index - The index of the item to retrieve
    * @returns Typed input container, or `undefined` if the item does not exist
    */
-  at(index: number): Input<A>
+  at(index: number): Input<A>;
   /**
    * Retrieve the _annotation_ for an item at the given index
    *
    * @param index - The index of the item to fetch the annotation for
    * @returns The annotation at the given index, or `undefined` if the item does not exist
    */
-  annotationAt(index: number): A
+  annotationAt(index: number): A;
 }
 
 /**
@@ -66,7 +66,7 @@ export declare interface ArrayInput<A> extends BaseInput<A> {
  * @public
  */
 export declare interface BaseInput<A> {
-  annotation: A
+  annotation: A;
 }
 
 /**
@@ -76,8 +76,8 @@ export declare interface BaseInput<A> {
  * @public
  */
 export declare type BooleanDiff<A> = FullDiff<A, boolean> & {
-  type: 'boolean'
-}
+  type: "boolean";
+};
 
 /**
  * Input type for booleans.
@@ -86,8 +86,8 @@ export declare type BooleanDiff<A> = FullDiff<A, boolean> & {
  * @public
  */
 export declare interface BooleanInput<A> extends BaseInput<A> {
-  type: 'boolean'
-  value: boolean
+  type: "boolean";
+  value: boolean;
 }
 
 /**
@@ -101,11 +101,11 @@ export declare interface BooleanInput<A> extends BaseInput<A> {
  * @public
  */
 export declare interface ChangedDiff<A, V> {
-  action: 'changed'
-  isChanged: true
-  fromValue: V
-  toValue: V
-  annotation: A
+  action: "changed";
+  isChanged: true;
+  fromValue: V;
+  toValue: V;
+  annotation: A;
 }
 
 /**
@@ -121,7 +121,7 @@ export declare type Diff<A> =
   | BooleanDiff<A>
   | ObjectDiff<A>
   | ArrayDiff<A>
-  | TypeChangeDiff<A>
+  | TypeChangeDiff<A>;
 
 /**
  * Takes a `from` and `to` input and calulates a diff between the two
@@ -136,14 +136,14 @@ export declare function diffInput<A>(
   fromInput: Input<A>,
   toInput: Input<A>,
   options?: DiffOptions,
-): Diff<A>
+): Diff<A>;
 
 /**
  * Options available for doing diffs. Currently no options are defined.
  *
  * @public
  */
-export declare type DiffOptions = Record<string, never>
+export declare type DiffOptions = Record<string, never>;
 
 /**
  * Diff with all the possible diff types.
@@ -156,7 +156,7 @@ export declare type FullDiff<A, V> =
   | AddedDiff<A, V>
   | RemovedDiff<A, V>
   | ChangedDiff<A, V>
-  | UnchangedDiff<A, V>
+  | UnchangedDiff<A, V>;
 
 /**
  * An "input" holds the _type_ of the value, the actual value, an optional annotation,
@@ -170,7 +170,7 @@ export declare type Input<T> =
   | StringInput<T>
   | NullInput<T>
   | ObjectInput<T>
-  | ArrayInput<T>
+  | ArrayInput<T>;
 
 /**
  * Diff of an item in an array, representing whether or not it has moved within the array,
@@ -184,11 +184,11 @@ export declare type Input<T> =
  * @public
  */
 export declare interface ItemDiff<A> {
-  fromIndex: number | undefined
-  toIndex: number | undefined
-  hasMoved: boolean
-  diff: Diff<A>
-  annotation: A
+  fromIndex: number | undefined;
+  toIndex: number | undefined;
+  hasMoved: boolean;
+  diff: Diff<A>;
+  annotation: A;
 }
 
 /**
@@ -198,8 +198,8 @@ export declare interface ItemDiff<A> {
  * @public
  */
 export declare type NullDiff<A> = FullDiff<A, null> & {
-  type: 'null'
-}
+  type: "null";
+};
 
 /**
  * Input type for `null` values.
@@ -208,8 +208,8 @@ export declare type NullDiff<A> = FullDiff<A, null> & {
  * @public
  */
 export declare interface NullInput<A> extends BaseInput<A> {
-  type: 'null'
-  value: null
+  type: "null";
+  value: null;
 }
 
 /**
@@ -219,8 +219,8 @@ export declare interface NullInput<A> extends BaseInput<A> {
  * @public
  */
 export declare type NumberDiff<A> = FullDiff<A, number> & {
-  type: 'number'
-}
+  type: "number";
+};
 
 /**
  * Input type for numbers.
@@ -229,8 +229,8 @@ export declare type NumberDiff<A> = FullDiff<A, number> & {
  * @public
  */
 export declare interface NumberInput<A> extends BaseInput<A> {
-  type: 'number'
-  value: number
+  type: "number";
+  value: number;
 }
 
 /**
@@ -240,10 +240,13 @@ export declare interface NumberInput<A> extends BaseInput<A> {
  * @typeParam T - Value type.
  * @public
  */
-export declare type ObjectDiff<A, T extends object = Record<string, any>> = FullDiff<A, T> & {
-  type: 'object'
-  fields: Record<keyof T, Diff<A>>
-}
+export declare type ObjectDiff<
+  A,
+  T extends object = Record<string, any>,
+> = FullDiff<A, T> & {
+  type: "object";
+  fields: Record<keyof T, Diff<A>>;
+};
 
 /**
  * Input type for object values. Caches the available keys, and allows retrieval of properties,
@@ -253,22 +256,22 @@ export declare type ObjectDiff<A, T extends object = Record<string, any>> = Full
  * @public
  */
 export declare interface ObjectInput<A> extends BaseInput<A> {
-  type: 'object'
+  type: "object";
   /**
    * The actual object value
    */
-  value: Record<string, unknown>
+  value: Record<string, unknown>;
   /**
    * The keys of the object
    */
-  keys: string[]
+  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
+  get(key: string): Input<A> | undefined;
 }
 
 /**
@@ -280,11 +283,11 @@ export declare interface ObjectInput<A> extends BaseInput<A> {
  * @public
  */
 export declare interface RemovedDiff<A, V> {
-  action: 'removed'
-  isChanged: true
-  fromValue: V
-  toValue: null | undefined
-  annotation: A
+  action: "removed";
+  isChanged: true;
+  fromValue: V;
+  toValue: null | undefined;
+  annotation: A;
 }
 
 /**
@@ -295,9 +298,9 @@ export declare interface RemovedDiff<A, V> {
  * @public
  */
 export declare type StringDiff<A> = FullDiff<A, string> & {
-  type: 'string'
-  segments: StringDiffSegment<A>[]
-}
+  type: "string";
+  segments: StringDiffSegment<A>[];
+};
 
 /**
  * Diff of a string segment (eg a portion/slice), and whether or not it was changed or unchanged.
@@ -305,7 +308,9 @@ export declare type StringDiff<A> = FullDiff<A, string> & {
  * @typeParam A - Annotation. Timestamps, author and similar info is attached by Sanity, but anything is allowed.
  * @public
  */
-export declare 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
@@ -315,15 +320,15 @@ export declare type StringDiffSegment<A> = StringSegmentChanged<A> | StringSegme
  * @public
  */
 export declare interface StringInput<A> extends BaseInput<A> {
-  type: 'string'
-  value: string
+  type: "string";
+  value: string;
   sliceAnnotation(
     start: number,
     end: number,
   ): {
-    text: string
-    annotation: A
-  }[]
+    text: string;
+    annotation: A;
+  }[];
 }
 
 /**
@@ -333,10 +338,10 @@ export declare interface StringInput<A> extends BaseInput<A> {
  * @public
  */
 export declare interface StringSegmentChanged<A> {
-  type: 'stringSegment'
-  action: 'added' | 'removed'
-  text: string
-  annotation: A
+  type: "stringSegment";
+  action: "added" | "removed";
+  text: string;
+  annotation: A;
 }
 
 /**
@@ -345,9 +350,9 @@ export declare interface StringSegmentChanged<A> {
  * @public
  */
 export declare interface StringSegmentUnchanged {
-  type: 'stringSegment'
-  action: 'unchanged'
-  text: string
+  type: "stringSegment";
+  action: "unchanged";
+  text: string;
 }
 
 /**
@@ -358,20 +363,20 @@ export declare interface StringSegmentUnchanged {
  * @public
  */
 export declare interface TypeChangeDiff<A> {
-  type: 'typeChange'
-  action: 'changed'
-  isChanged: true
-  fromType: string
-  fromValue: unknown
+  type: "typeChange";
+  action: "changed";
+  isChanged: true;
+  fromType: string;
+  fromValue: unknown;
   fromDiff: Diff<A> & {
-    action: 'removed'
-  }
-  toType: string
-  toValue: unknown
+    action: "removed";
+  };
+  toType: string;
+  toValue: unknown;
   toDiff: Diff<A> & {
-    action: 'added'
-  }
-  annotation: A
+    action: "added";
+  };
+  annotation: A;
 }
 
 /**
@@ -382,10 +387,10 @@ export declare interface TypeChangeDiff<A> {
  * @public
  */
 export declare interface UnchangedDiff<A, V> {
-  action: 'unchanged'
-  isChanged: false
-  fromValue: V
-  toValue: V
+  action: "unchanged";
+  isChanged: false;
+  fromValue: V;
+  toValue: V;
 }
 
 /**
@@ -394,13 +399,13 @@ export declare interface UnchangedDiff<A, V> {
  * @public
  */
 export declare type ValueType =
-  | 'array'
-  | 'boolean'
-  | 'null'
-  | 'number'
-  | 'object'
-  | 'string'
-  | 'undefined'
+  | "array"
+  | "boolean"
+  | "null"
+  | "number"
+  | "object"
+  | "string"
+  | "undefined";
 
 /**
  * Takes an input (any JSON-serializable value) and an annotation, and generates an input
@@ -412,6 +417,6 @@ export declare type ValueType =
  * @throws if `input` is not a JSON-serializable type
  * @public
  */
-export declare function wrap<A>(input: unknown, annotation: A): Input<A>
+export declare function wrap<A>(input: unknown, annotation: A): Input<A>;
 
-export {}
+export {};

package/package.json

@@ -1,48 +1,48 @@
 {
   "name": "@sanity/diff",
-  "version": "5.8.0",
+  "version": "5.8.1-next.10+8618f8476b",
   "description": "Generates diffs between documents and primitive types",
   "keywords": [
-    "sanity",
     "cms",
+    "content",
+    "diff",
     "headless",
     "realtime",
-    "content",
-    "diff"
+    "sanity"
   ],
   "homepage": "https://www.sanity.io/",
   "bugs": {
     "url": "https://github.com/sanity-io/sanity/issues"
   },
+  "license": "MIT",
+  "author": "Sanity.io <hello@sanity.io>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sanity-io/sanity.git",
     "directory": "packages/@sanity/diff"
   },
-  "license": "MIT",
-  "author": "Sanity.io <hello@sanity.io>",
-  "sideEffects": false,
+  "files": [
+    "lib"
+  ],
   "type": "module",
+  "sideEffects": false,
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "exports": {
     ".": "./lib/index.js",
     "./package.json": "./package.json"
   },
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
-  "files": [
-    "lib"
-  ],
   "dependencies": {
     "@sanity/diff-match-patch": "^3.2.0"
   },
   "devDependencies": {
-    "@sanity/pkg-utils": "^10.4.3",
+    "@sanity/pkg-utils": "^10.4.4",
     "@typescript/native-preview": "7.0.0-dev.20260112.1",
     "eslint": "^9.39.2",
     "rimraf": "^5.0.10",
-    "@repo/eslint-config": "5.8.0",
-    "@repo/package.config": "5.8.0",
-    "@repo/tsconfig": "5.8.0"
+    "@repo/tsconfig": "5.8.1-next.10+8618f8476b",
+    "@repo/eslint-config": "5.8.1-next.10+8618f8476b",
+    "@repo/package.config": "5.8.1-next.10+8618f8476b"
   },
   "engines": {
     "node": ">=20.19 <22 || >=22.12"