@sanity/diff-patch 6.0.0 → 7.0.0

package/README.md

@@ -1,6 +1,9 @@
 # @sanity/diff-patch
 
-[![npm version](https://img.shields.io/npm/v/@sanity/diff-patch.svg?style=flat-square)](https://www.npmjs.com/package/@sanity/diff-patch)[![npm bundle size](https://img.shields.io/bundlephobia/minzip/@sanity/diff-patch?style=flat-square)](https://bundlephobia.com/result?p=@sanity/diff-patch)[![npm weekly downloads](https://img.shields.io/npm/dw/@sanity/diff-patch.svg?style=flat-square)](https://www.npmjs.com/package/@sanity/diff-patch)
+[![Latest version](https://npmx.dev/api/registry/badge/version/@sanity/diff-patch?color=69E3EE)](https://npmx.dev/package/@sanity/diff-patch)
+[![Number of dependencies](https://npmx.dev/api/registry/badge/dependencies/@sanity/diff-patch?color=69E3EE)](https://npmx.dev/package/@sanity/diff-patch)
+[![Supported node versions](https://npmx.dev/api/registry/badge/engines/@sanity/diff-patch?color=69E3EE)](https://npmx.dev/package/@sanity/diff-patch)
+[![Downloads per month](https://npmx.dev/api/registry/badge/downloads/@sanity/diff-patch?color=69E3EE)](https://npmx.dev/package/@sanity/diff-patch)
 
 Generate Sanity patch mutations by comparing two documents or values. This library creates conflict-resistant patches designed for collaborative editing environments where multiple users may be editing the same document simultaneously.
 
@@ -15,6 +18,10 @@ Used internally by the Sanity App SDK for its collaborative editing system.
 
 ## Installation
 
+Requires Node.js 22.12.0 or later. This package ships ES modules only.
+
+To work on this repository, use Node.js 24 (`nvm use`) and the pnpm version specified in `package.json`.
+
 ```bash
 npm install @sanity/diff-patch
 ```

package/dist/index.d.ts

@@ -1,195 +1,162 @@
 /**
- * Represents an error that occurred during a diff process.
- * Contains `path`, `value` and `serializedPath` properties,
- * which is helpful for debugging and showing friendly messages.
+ * A segment of a path
  *
  * @public
  */
-export declare class DiffError extends Error {
-  path: Path
-  value: unknown
-  serializedPath: string
-  constructor(message: string, path: Path, value?: unknown)
-}
-
+type PathSegment = string | number | {
+  _key: string;
+} | [number | '', number | ''];
 /**
- * Generates an array of mutations for Sanity, based on the differences between
- * the two passed documents/trees.
+ * An array of path segments representing a path in a document
  *
- * @param source - The first document/tree to compare
- * @param target - The second document/tree to compare
- * @param opts - Options for the diff generation
- * @returns Array of mutations
  * @public
  */
-export declare function diffPatch(
-  source: DocumentStub,
-  target: DocumentStub,
-  options?: PatchOptions,
-): SanityPatchMutation[]
-
+type Path = PathSegment[];
 /**
- * Generates an array of patch operation objects for Sanity, based on the
- * differences between the two passed values
+ * A Sanity `set` patch mutation operation
+ * Replaces the current path, does not merge
  *
- * @param source - The source value to start off with
- * @param target - The target value that the patch operations will aim to create
- * @param basePath - An optional path that will be prefixed to all subsequent patch operations
- * @returns Array of mutations
  * @public
  */
-export declare function diffValue(
-  source: unknown,
-  target: unknown,
-  basePath?: Path,
-): SanityPatchOperations[]
-
+interface SanitySetPatchOperation {
+  set: Record<string, unknown>;
+}
 /**
- * Represents a partial Sanity document (eg a "stub").
+ * A Sanity `unset` patch mutation operation
+ * Unsets the entire value of the given path
  *
  * @public
  */
-export declare interface DocumentStub {
-  _id?: string
-  _type?: string
-  _rev?: string
-  _createdAt?: string
-  _updatedAt?: string
-  [key: string]: unknown
+interface SanityUnsetPatchOperation {
+  unset: string[];
 }
-
 /**
- * Options for the patch generator
+ * A Sanity `insert` patch mutation operation
+ * Inserts the given items at the given path (before/after)
  *
  * @public
  */
-export declare interface PatchOptions {
-  /**
-   * Document ID to apply the patch to.
-   *
-   * @defaultValue `undefined` - tries to extract `_id` from passed document
-   */
-  id?: string
-  /**
-   * Base path to apply the patch to - useful if diffing sub-branches of a document.
-   *
-   * @defaultValue `[]` - eg root of the document
-   */
-  basePath?: Path
-  /**
-   * Only apply the patch if the document revision matches this value.
-   * If the property is the boolean value `true`, it will attempt to extract
-   * the revision from the document `_rev` property.
-   *
-   * @defaultValue `undefined` (do not apply revision check)
-   */
-  ifRevisionID?: string | true
+interface SanityInsertPatchOperation {
+  insert: {
+    before: string;
+    items: unknown[];
+  } | {
+    after: string;
+    items: unknown[];
+  } | {
+    replace: string;
+    items: unknown[];
+  };
 }
-
 /**
- * An array of path segments representing a path in a document
+ * A Sanity `diffMatchPatch` patch mutation operation
+ * Patches the given path with the given unidiff string.
  *
  * @public
  */
-export declare type Path = PathSegment[]
-
+interface SanityDiffMatchPatchOperation {
+  diffMatchPatch: Record<string, string>;
+}
 /**
- * A segment of a path
+ * Serializable patch operations that can be applied to a Sanity document.
  *
  * @public
  */
-export declare type PathSegment =
-  | string
-  | number
-  | {
-      _key: string
-    }
-  | [number | '', number | '']
-
+type SanityPatchOperations = Partial<SanitySetPatchOperation & SanityUnsetPatchOperation & SanityInsertPatchOperation & SanityDiffMatchPatchOperation>;
 /**
- * A Sanity `diffMatchPatch` patch mutation operation
- * Patches the given path with the given unidiff string.
+ * Meant to be used as the body of a {@link SanityPatchMutation}'s `patch` key.
+ *
+ * Contains additional properties to target a particular ID and optionally add
+ * an optimistic lock via [`ifRevisionID`](https://www.sanity.io/docs/content-lake/transactions#k29b2c75639d5).
  *
  * @public
  */
-declare interface SanityDiffMatchPatchOperation {
-  diffMatchPatch: Record<string, string>
+interface SanityPatch extends SanityPatchOperations {
+  id: string;
+  ifRevisionID?: string;
 }
-
 /**
- * A Sanity `insert` patch mutation operation
- * Inserts the given items at the given path (before/after)
+ * A mutation containing a single patch
  *
  * @public
  */
-declare interface SanityInsertPatchOperation {
-  insert:
-    | {
-        before: string
-        items: unknown[]
-      }
-    | {
-        after: string
-        items: unknown[]
-      }
-    | {
-        replace: string
-        items: unknown[]
-      }
+interface SanityPatchMutation {
+  patch: SanityPatch;
 }
-
 /**
- * Meant to be used as the body of a {@link SanityPatchMutation}'s `patch` key.
- *
- * Contains additional properties to target a particular ID and optionally add
- * an optimistic lock via [`ifRevisionID`](https://www.sanity.io/docs/content-lake/transactions#k29b2c75639d5).
+ * Represents a partial Sanity document (eg a "stub").
  *
  * @public
  */
-export declare interface SanityPatch extends SanityPatchOperations {
-  id: string
-  ifRevisionID?: string
+interface DocumentStub {
+  _id?: string;
+  _type?: string;
+  _rev?: string;
+  _createdAt?: string;
+  _updatedAt?: string;
+  [key: string]: unknown;
 }
-
 /**
- * A mutation containing a single patch
+ * Options for the patch generator
  *
  * @public
  */
-export declare interface SanityPatchMutation {
-  patch: SanityPatch
+interface PatchOptions {
+  /**
+   * Document ID to apply the patch to.
+   *
+   * @defaultValue `undefined` - tries to extract `_id` from passed document
+   */
+  id?: string;
+  /**
+   * Base path to apply the patch to - useful if diffing sub-branches of a document.
+   *
+   * @defaultValue `[]` - eg root of the document
+   */
+  basePath?: Path;
+  /**
+   * Only apply the patch if the document revision matches this value.
+   * If the property is the boolean value `true`, it will attempt to extract
+   * the revision from the document `_rev` property.
+   *
+   * @defaultValue `undefined` (do not apply revision check)
+   */
+  ifRevisionID?: string | true;
 }
-
 /**
- * Serializable patch operations that can be applied to a Sanity document.
+ * Generates an array of mutations for Sanity, based on the differences between
+ * the two passed documents/trees.
  *
+ * @param source - The first document/tree to compare
+ * @param target - The second document/tree to compare
+ * @param opts - Options for the diff generation
+ * @returns Array of mutations
  * @public
  */
-export declare type SanityPatchOperations = Partial<
-  SanitySetPatchOperation &
-    SanityUnsetPatchOperation &
-    SanityInsertPatchOperation &
-    SanityDiffMatchPatchOperation
->
-
+export declare function diffPatch(source: DocumentStub, target: DocumentStub, options?: PatchOptions): SanityPatchMutation[];
 /**
- * A Sanity `set` patch mutation operation
- * Replaces the current path, does not merge
+ * Generates an array of patch operation objects for Sanity, based on the
+ * differences between the two passed values
  *
+ * @param source - The source value to start off with
+ * @param target - The target value that the patch operations will aim to create
+ * @param basePath - An optional path that will be prefixed to all subsequent patch operations
+ * @returns Array of mutations
  * @public
  */
-declare interface SanitySetPatchOperation {
-  set: Record<string, unknown>
-}
-
+export declare function diffValue(source: unknown, target: unknown, basePath?: Path): SanityPatchOperations[];
 /**
- * A Sanity `unset` patch mutation operation
- * Unsets the entire value of the given path
+ * Represents an error that occurred during a diff process.
+ * Contains `path`, `value` and `serializedPath` properties,
+ * which is helpful for debugging and showing friendly messages.
  *
  * @public
  */
-declare interface SanityUnsetPatchOperation {
-  unset: string[]
+export declare class DiffError extends Error {
+  path: Path;
+  value: unknown;
+  serializedPath: string;
+  constructor(message: string, path: Path, value?: unknown);
 }
-
-export {}
+export type { DocumentStub, PatchOptions, Path, PathSegment, SanityPatch, SanityPatchMutation, SanityPatchOperations };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/paths.ts","../src/patches.ts","../src/diffPatch.ts","../src/diffError.ts"],"mappings":"AAOA;;;;;KAAY;EAGP;;;;;;;KAQO,OAAO;;;;;;;UC2DF;EACf,KAAK;;;;;;;;UASU;EACf;;;;;;;;UASe;EACf;IACK;IAAgB;;IAChB;IAAe;;IACf;IAAiB;;;;;;;;;UASP;EACf,gBAAgB;;;;;;;KAQN,wBAAwB,QAClC,0BACE,4BACA,6BACA;;;;;;;;;UAWa,oBAAoB;EACnC;EACA;;;;;;;UAQe;EACf,OAAO;;;;;;;UClGQ;EACf;EACA;EACA;EACA;EACA;GACC;;;;;;;UAQc;;;;;;EAMf;;;;;;EAOA,WAAW;;;;;;;;EASX;;;;;;;;;;;;wBAac,UACd,QAAQ,cACR,QAAQ,cACR,UAAS,eACR;;;;;;;;;;;wBA0Ca,UACd,iBACA,iBACA,WAAU,OACT;;;;;;;;qBCzIU,kBAAkB;EACtB,MAAM;EACN;EACA;EAEP,YAAY,iBAAiB,MAAM,MAAM"}