@sanity/mutator 5.8.1-next.9 → 5.8.2-next.1

package/lib/index.d.ts

@@ -1,122 +1,87 @@
-import { CreateIfNotExistsMutation } from "@sanity/types";
-import { CreateMutation } from "@sanity/types";
-import { CreateOrReplaceMutation } from "@sanity/types";
-import { DeleteMutation } from "@sanity/types";
-import { PatchMutation } from "@sanity/types";
-import { Path } from "@sanity/types";
-
+import { CreateIfNotExistsMutation, CreateMutation, CreateOrReplaceMutation, DeleteMutation, PatchMutation, Path } from "@sanity/types";
 /**
- * Converts a path in array form to a JSONPath string
+ * Sanity document with a guaranteed `_id` and `_type`
  *
- * @param pathArray - Array of path segments
- * @returns String representation of the path
  * @internal
  */
-export declare function arrayToJSONMatchPath(pathArray: Path): string;
-
+interface Doc {
+  _id: string;
+  _type: string;
+  _rev?: string;
+  _updatedAt?: string;
+  _createdAt?: string;
+  [attribute: string]: unknown;
+}
 /**
+ * Internal mutation body representation - note that theoretically a
+ * mutation can only hold one of these operations each, but for sake
+ * of simpler code it is bundled together as one here
+ *
  * @internal
  */
-export declare class BufferedDocument {
-  private mutations;
-  /**
-   * The Document we are wrapping
-   */
-  document: Document_2;
-  /**
-   * The Document with local changes applied
-   */
-  LOCAL: Doc | null;
-  /**
-   * Commits that are waiting to be delivered to the server
-   */
-  private commits;
-  /**
-   * Local mutations that are not scheduled to be committed yet
-   */
-  buffer: SquashingBuffer;
-  /**
-   * Assignable event handler for when the buffered document applies a mutation
-   */
-  onMutation?: (message: {
-    mutation: Mutation;
-    document: Doc | null;
-    remote: boolean;
-  }) => void;
-  /**
-   * Assignable event handler for when a remote mutation happened
-   */
-  onRemoteMutation?: Document_2["onRemoteMutation"];
-  /**
-   * Assignable event handler for when the buffered document rebased
-   */
-  onRebase?: (
-    localDoc: Doc | null,
-    remoteMutations: Mut[],
-    localMutations: Mut[],
-  ) => void;
-  /**
-   * Assignable event handler for when the document is deleted
-   */
-  onDelete?: (doc: Doc | null) => void;
-  /**
-   * Assignable event handler for when the state of consistency changed
-   */
-  onConsistencyChanged?: (isConsistent: boolean) => void;
-  /**
-   * Assignable event handler for when the buffered document should commit changes
-   */
-  commitHandler?: (msg: CommitHandlerMessage) => void;
-  /**
-   * Whether or not we are currently commiting
-   */
-  committerRunning: boolean;
-  constructor(doc: Doc | null);
-  reset(doc: Doc | null): void;
-  add(mutation: Mutation): void;
-  arrive(mutation: Mutation): void;
-  commit(): Promise<void>;
-  performCommits(): void;
-  _cycleCommitter(): void;
-  handleDocRebase(
-    edge: Doc | null,
-    remoteMutations: Mutation[],
-    localMutations: Mutation[],
-  ): void;
-  handleDocumentDeleted(): void;
-  handleDocMutation(msg: {
-    mutation: Mutation;
-    document: Doc | null;
-    remote: boolean;
-  }): void;
-  rebase(remoteMutations: Mutation[], localMutations: Mutation[]): void;
-  handleDocConsistencyChanged(isConsistent: boolean): void;
+interface Mut {
+  create?: CreateMutation['create'];
+  createIfNotExists?: CreateIfNotExistsMutation['createIfNotExists'];
+  createOrReplace?: CreateOrReplaceMutation['createOrReplace'];
+  delete?: DeleteMutation['delete'];
+  patch?: PatchMutation['patch'];
 }
-
 /**
+ * Parameters attached to the mutation
+ *
  * @internal
  */
-export declare interface CommitHandlerMessage {
-  mutation: Mutation;
-  success: () => void;
-  failure: () => void;
-  cancel: (error: Error) => void;
+interface MutationParams {
+  transactionId?: string;
+  transition?: string;
+  identity?: string;
+  previousRev?: string;
+  resultRev?: string;
+  mutations: Mut[];
+  timestamp?: string;
+  effects?: {
+    apply: unknown;
+    revert: unknown;
+  };
 }
-
 /**
- * Sanity document with a guaranteed `_id` and `_type`
+ * A mutation describing a number of operations on a single document.
+ * This should be considered an immutable structure. Mutations are compiled
+ * on first application, and any changes in properties will not effectively
+ * change its behavior after that.
  *
  * @internal
  */
-export declare interface Doc {
-  _id: string;
-  _type: string;
-  _rev?: string;
-  _updatedAt?: string;
-  _createdAt?: string;
-  [attribute: string]: unknown;
+declare class Mutation {
+  params: MutationParams;
+  compiled?: (doc: Doc | null) => Doc | null;
+  _appliesToMissingDocument: boolean | undefined;
+  constructor(options: MutationParams);
+  get transactionId(): string | undefined;
+  get transition(): string | undefined;
+  get identity(): string | undefined;
+  get previousRev(): string | undefined;
+  get resultRev(): string | undefined;
+  get mutations(): Mut[];
+  get timestamp(): Date | undefined;
+  get effects(): {
+    apply: unknown;
+    revert: unknown;
+  } | undefined;
+  assignRandomTransactionId(): void;
+  appliesToMissingDocument(): boolean;
+  compile(): void;
+  apply(document: Doc | null): Doc | null;
+  static applyAll(document: Doc | null, mutations: Mutation[]): Doc | null;
+  static squash(document: Doc | null, mutations: Mutation[]): Mutation;
+}
+/**
+ * @internal
+ */
+interface SubmissionResponder {
+  success: () => void;
+  failure: () => void;
 }
-
 /**
  * Models a document as it is changed by our own local patches and remote patches coming in from
  * the server. Consolidates incoming patches with our own submitted patches and maintains two
@@ -129,7 +94,7 @@ export declare interface Doc {
  *
  * @internal
  */
-declare class Document_2 {
+declare class Document {
   /**
    * Incoming patches from the server waiting to be applied to HEAD
    */
@@ -160,11 +125,7 @@ declare class Document_2 {
    * I.e. when EDGE changes because the order of mutations has changed in relation to our
    * optimistic predictions.
    */
-  onRebase?: (
-    edge: Doc | null,
-    incomingMutations: Mutation[],
-    pendingMutations: Mutation[],
-  ) => void;
+  onRebase?: (edge: Doc | null, incomingMutations: Mutation[], pendingMutations: Mutation[]) => void;
   /**
    * Called when we receive a patch in the normal order of things, but the mutation is not ours
    */
@@ -225,102 +186,6 @@ declare class Document_2 {
   pendingFailed(pendingTxnId: string): void;
   rebase(incomingMutations: Mutation[]): void;
 }
-export { Document_2 as Document };
-
-/**
- * Extracts values matching the given JsonPath
- *
- * @param path - Path to extract
- * @param value - Value to extract from
- * @returns An array of values matching the given path
- * @public
- */
-export declare function extract(path: string, value: unknown): unknown[];
-
-/**
- * Extracts a value for the given JsonPath, and includes the specific path of where it was found
- *
- * @param path - Path to extract
- * @param value - Value to extract from
- * @returns An array of objects with `path` and `value` keys
- * @internal
- */
-export declare function extractWithPath(
-  path: string,
-  value: unknown,
-): {
-  path: (string | number)[];
-  value: unknown;
-}[];
-
-/**
- * Internal mutation body representation - note that theoretically a
- * mutation can only hold one of these operations each, but for sake
- * of simpler code it is bundled together as one here
- *
- * @internal
- */
-export declare interface Mut {
-  create?: CreateMutation["create"];
-  createIfNotExists?: CreateIfNotExistsMutation["createIfNotExists"];
-  createOrReplace?: CreateOrReplaceMutation["createOrReplace"];
-  delete?: DeleteMutation["delete"];
-  patch?: PatchMutation["patch"];
-}
-
-/**
- * A mutation describing a number of operations on a single document.
- * This should be considered an immutable structure. Mutations are compiled
- * on first application, and any changes in properties will not effectively
- * change its behavior after that.
- *
- * @internal
- */
-export declare class Mutation {
-  params: MutationParams;
-  compiled?: (doc: Doc | null) => Doc | null;
-  _appliesToMissingDocument: boolean | undefined;
-  constructor(options: MutationParams);
-  get transactionId(): string | undefined;
-  get transition(): string | undefined;
-  get identity(): string | undefined;
-  get previousRev(): string | undefined;
-  get resultRev(): string | undefined;
-  get mutations(): Mut[];
-  get timestamp(): Date | undefined;
-  get effects():
-    | {
-        apply: unknown;
-        revert: unknown;
-      }
-    | undefined;
-  assignRandomTransactionId(): void;
-  appliesToMissingDocument(): boolean;
-  compile(): void;
-  apply(document: Doc | null): Doc | null;
-  static applyAll(document: Doc | null, mutations: Mutation[]): Doc | null;
-  static squash(document: Doc | null, mutations: Mutation[]): Mutation;
-}
-
-/**
- * Parameters attached to the mutation
- *
- * @internal
- */
-export declare interface MutationParams {
-  transactionId?: string;
-  transition?: string;
-  identity?: string;
-  previousRev?: string;
-  resultRev?: string;
-  mutations: Mut[];
-  timestamp?: string;
-  effects?: {
-    apply: unknown;
-    revert: unknown;
-  };
-}
-
 /**
  * Implements a buffer for mutations that incrementally optimises the mutations by
  * eliminating set-operations that overwrite earlier set-operations, and rewrite
@@ -328,7 +193,7 @@ export declare interface MutationParams {
  *
  * @internal
  */
-export declare class SquashingBuffer {
+declare class SquashingBuffer {
   /**
    * The document forming the basis of this squash
    */
@@ -372,13 +237,12 @@ export declare class SquashingBuffer {
   purge(txnId?: string): Mutation | null;
   addOperation(op: Mut): void;
   /**
-     * Attempt to perform one single set operation in an optimised manner, return value
-     * reflects whether or not the operation could be performed.
-
-     * @param path - The JSONPath to the set operation in question
-     * @param nextValue - The value to be set
-     * @returns True of optimized, false otherwise
-     */
+   * Attempt to perform one single set operation in an optimised manner, return value
+   * reflects whether or not the operation could be performed.
+      * @param path - The JSONPath to the set operation in question
+   * @param nextValue - The value to be set
+   * @returns True of optimized, false otherwise
+   */
   optimiseSetOperation(path: string, nextValue: unknown): boolean;
   stashStagedOperations(): void;
   /**
@@ -389,13 +253,112 @@ export declare class SquashingBuffer {
    */
   rebase(newBasis: Doc | null): Doc | null;
 }
-
 /**
  * @internal
  */
-export declare interface SubmissionResponder {
+interface CommitHandlerMessage {
+  mutation: Mutation;
   success: () => void;
   failure: () => void;
+  cancel: (error: Error) => void;
+}
+/**
+ * @internal
+ */
+declare class BufferedDocument {
+  private mutations;
+  /**
+   * The Document we are wrapping
+   */
+  document: Document;
+  /**
+   * The Document with local changes applied
+   */
+  LOCAL: Doc | null;
+  /**
+   * Commits that are waiting to be delivered to the server
+   */
+  private commits;
+  /**
+   * Local mutations that are not scheduled to be committed yet
+   */
+  buffer: SquashingBuffer;
+  /**
+   * Assignable event handler for when the buffered document applies a mutation
+   */
+  onMutation?: (message: {
+    mutation: Mutation;
+    document: Doc | null;
+    remote: boolean;
+  }) => void;
+  /**
+   * Assignable event handler for when a remote mutation happened
+   */
+  onRemoteMutation?: Document['onRemoteMutation'];
+  /**
+   * Assignable event handler for when the buffered document rebased
+   */
+  onRebase?: (localDoc: Doc | null, remoteMutations: Mut[], localMutations: Mut[]) => void;
+  /**
+   * Assignable event handler for when the document is deleted
+   */
+  onDelete?: (doc: Doc | null) => void;
+  /**
+   * Assignable event handler for when the state of consistency changed
+   */
+  onConsistencyChanged?: (isConsistent: boolean) => void;
+  /**
+   * Assignable event handler for when the buffered document should commit changes
+   */
+  commitHandler?: (msg: CommitHandlerMessage) => void;
+  /**
+   * Whether or not we are currently commiting
+   */
+  committerRunning: boolean;
+  constructor(doc: Doc | null);
+  reset(doc: Doc | null): void;
+  add(mutation: Mutation): void;
+  arrive(mutation: Mutation): void;
+  commit(): Promise<void>;
+  performCommits(): void;
+  _cycleCommitter(): void;
+  handleDocRebase(edge: Doc | null, remoteMutations: Mutation[], localMutations: Mutation[]): void;
+  handleDocumentDeleted(): void;
+  handleDocMutation(msg: {
+    mutation: Mutation;
+    document: Doc | null;
+    remote: boolean;
+  }): void;
+  rebase(remoteMutations: Mutation[], localMutations: Mutation[]): void;
+  handleDocConsistencyChanged(isConsistent: boolean): void;
 }
-
-export {};
+/**
+ * Converts a path in array form to a JSONPath string
+ *
+ * @param pathArray - Array of path segments
+ * @returns String representation of the path
+ * @internal
+ */
+declare function arrayToJSONMatchPath(pathArray: Path): string;
+/**
+ * Extracts values matching the given JsonPath
+ *
+ * @param path - Path to extract
+ * @param value - Value to extract from
+ * @returns An array of values matching the given path
+ * @public
+ */
+declare function extract(path: string, value: unknown): unknown[];
+/**
+ * Extracts a value for the given JsonPath, and includes the specific path of where it was found
+ *
+ * @param path - Path to extract
+ * @param value - Value to extract from
+ * @returns An array of objects with `path` and `value` keys
+ * @internal
+ */
+declare function extractWithPath(path: string, value: unknown): {
+  path: (string | number)[];
+  value: unknown;
+}[];
+export { BufferedDocument, type CommitHandlerMessage, type Doc, type Document, type Mut, Mutation, type MutationParams, type SquashingBuffer, type SubmissionResponder, arrayToJSONMatchPath, extract, extractWithPath };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/mutator",
-  "version": "5.8.1-next.9+d88907264b",
+  "version": "5.8.2-next.1+7a166946ce",
   "description": "A set of models to make it easier to utilize the powerful real time collaborative features of Sanity",
   "keywords": [
     "cms",
@@ -37,7 +37,7 @@
     "@sanity/uuid": "^3.0.2",
     "debug": "^4.4.3",
     "lodash-es": "^4.17.22",
-    "@sanity/types": "5.8.0"
+    "@sanity/types": "5.8.1"
   },
   "devDependencies": {
     "@sanity/pkg-utils": "^10.4.4",
@@ -48,10 +48,10 @@
     "eslint": "^9.39.2",
     "rimraf": "^5.0.10",
     "vitest": "^4.0.18",
-    "@repo/eslint-config": "5.8.1-next.9+d88907264b",
-    "@repo/package.config": "5.8.1-next.9+d88907264b",
-    "@repo/tsconfig": "5.8.1-next.9+d88907264b",
-    "@repo/test-config": "5.8.1-next.9+d88907264b"
+    "@repo/package.config": "5.8.2-next.1+7a166946ce",
+    "@repo/eslint-config": "5.8.2-next.1+7a166946ce",
+    "@repo/test-config": "5.8.2-next.1+7a166946ce",
+    "@repo/tsconfig": "5.8.2-next.1+7a166946ce"
   },
   "scripts": {
     "build": "pkg-utils build --strict --check --clean",