@sanity-labs/client-fake-for-test 0.7.0 → 0.8.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-export declare type Action = ReleaseAction | VersionAction;
+export declare type Action = ReleaseAction | VersionAction | DocumentAction;
 
 /** Options for `action()`. Only `tag` is meaningful to the fake. */
 export declare interface ActionOptions {
@@ -202,6 +202,26 @@ export declare function defaultAclPath(
   dataset: string,
 ): string;
 
+/**
+ * Draft↔published document actions — `sanity.action.document.publish`
+ * promotes the draft onto the published id (and deletes the draft);
+ * `sanity.action.document.unpublish` retracts the published document into a
+ * draft (keeping an existing draft untouched) and deletes the published one.
+ */
+export declare type DocumentAction =
+  | {
+      actionType: "sanity.action.document.publish";
+      draftId: string;
+      publishedId: string;
+      ifDraftRevisionId?: string;
+      ifPublishedRevisionId?: string;
+    }
+  | {
+      actionType: "sanity.action.document.unpublish";
+      draftId: string;
+      publishedId: string;
+    };
+
 /**
  * Document body accepted by `version.create` / `createVersion`. The id
  * is derived from `releaseId + publishedId` so callers may omit `_id`
@@ -387,11 +407,13 @@ export declare interface MultipleMutationResult {
  * A pluggable write interceptor, configured via
  * `createTestClient({ mutationGuard })`. It runs on each write through the
  * document mutation API — `create` / `createOrReplace` / `createIfNotExists` /
- * `patch` / `delete` and the equivalent `transaction()` operations — before the
- * store changes; **throw to reject the write** (the throw propagates out of the
- * client call, exactly as a real lake rejection would). The release/version
- * action API (`client.action`, `client.releases.*`, `createVersion`) is **not**
- * intercepted.
+ * `patch` / `delete` and the equivalent `transaction()` operations — and on the
+ * document publish/unpublish actions (`sanity.action.document.publish` /
+ * `.unpublish` via `client.action`) — before the store changes; **throw to
+ * reject the write** (the throw propagates out of the client call, exactly as
+ * a real lake rejection would). The release/version action API
+ * (`client.releases.*`, `createVersion`, the `sanity.action.release.*` and
+ * `*.version.*` action types) is **not** intercepted.
  *
  * The client itself has no opinion about *what* a guard is — it only provides
  * the seam and the before/after/identity context. Callers (e.g. a workflow test
@@ -404,13 +426,21 @@ export declare type MutationGuard = (
 ) => void | Promise<void>;
 
 /** The kind of write a {@link MutationGuard} is asked to vet. */
-export declare type MutationGuardAction = "create" | "update" | "delete";
+export declare type MutationGuardAction =
+  | "create"
+  | "update"
+  | "delete"
+  | "publish"
+  | "unpublish";
 
 /**
  * The before/after image of a single document write, handed to a
  * {@link MutationGuard} before it is applied.
  *
- * - `before` is null on create; `after` is null on delete.
+ * - `before` is null on create and on a publish with no live published
+ *   document; `after` is null on delete and unpublish.
+ * - On publish/unpublish both images are of the *published* document —
+ *   `after` on publish is the draft's content promoted onto the published id.
  * - `identity` is the acting user — the id bound to the client's token
  *   (its `accessControl.currentUser`), or undefined when the client has no
  *   identity configured.
@@ -789,9 +819,11 @@ export declare interface TestClient {
     options?: TxnCommitOptions,
   ) => Promise<TxnCommitResult>;
   /**
-   * Dispatch one or more release / version actions against the store.
-   * Returns a synthetic `transactionId`. Multi-action arrays are applied
-   * atomically — any failure rolls back the batch.
+   * Dispatch one or more release / version / document actions against the
+   * store. Returns a synthetic `transactionId`. Multi-action arrays are
+   * applied atomically — any failure rolls back the batch. The document
+   * publish/unpublish actions run through the access gate and the
+   * `mutationGuard` seam; release/version actions apply unhooked.
    */
   action: (
     action: Action | Action[],

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export declare type Action = ReleaseAction | VersionAction;
+export declare type Action = ReleaseAction | VersionAction | DocumentAction;
 
 /** Options for `action()`. Only `tag` is meaningful to the fake. */
 export declare interface ActionOptions {
@@ -202,6 +202,26 @@ export declare function defaultAclPath(
   dataset: string,
 ): string;
 
+/**
+ * Draft↔published document actions — `sanity.action.document.publish`
+ * promotes the draft onto the published id (and deletes the draft);
+ * `sanity.action.document.unpublish` retracts the published document into a
+ * draft (keeping an existing draft untouched) and deletes the published one.
+ */
+export declare type DocumentAction =
+  | {
+      actionType: "sanity.action.document.publish";
+      draftId: string;
+      publishedId: string;
+      ifDraftRevisionId?: string;
+      ifPublishedRevisionId?: string;
+    }
+  | {
+      actionType: "sanity.action.document.unpublish";
+      draftId: string;
+      publishedId: string;
+    };
+
 /**
  * Document body accepted by `version.create` / `createVersion`. The id
  * is derived from `releaseId + publishedId` so callers may omit `_id`
@@ -387,11 +407,13 @@ export declare interface MultipleMutationResult {
  * A pluggable write interceptor, configured via
  * `createTestClient({ mutationGuard })`. It runs on each write through the
  * document mutation API — `create` / `createOrReplace` / `createIfNotExists` /
- * `patch` / `delete` and the equivalent `transaction()` operations — before the
- * store changes; **throw to reject the write** (the throw propagates out of the
- * client call, exactly as a real lake rejection would). The release/version
- * action API (`client.action`, `client.releases.*`, `createVersion`) is **not**
- * intercepted.
+ * `patch` / `delete` and the equivalent `transaction()` operations — and on the
+ * document publish/unpublish actions (`sanity.action.document.publish` /
+ * `.unpublish` via `client.action`) — before the store changes; **throw to
+ * reject the write** (the throw propagates out of the client call, exactly as
+ * a real lake rejection would). The release/version action API
+ * (`client.releases.*`, `createVersion`, the `sanity.action.release.*` and
+ * `*.version.*` action types) is **not** intercepted.
  *
  * The client itself has no opinion about *what* a guard is — it only provides
  * the seam and the before/after/identity context. Callers (e.g. a workflow test
@@ -404,13 +426,21 @@ export declare type MutationGuard = (
 ) => void | Promise<void>;
 
 /** The kind of write a {@link MutationGuard} is asked to vet. */
-export declare type MutationGuardAction = "create" | "update" | "delete";
+export declare type MutationGuardAction =
+  | "create"
+  | "update"
+  | "delete"
+  | "publish"
+  | "unpublish";
 
 /**
  * The before/after image of a single document write, handed to a
  * {@link MutationGuard} before it is applied.
  *
- * - `before` is null on create; `after` is null on delete.
+ * - `before` is null on create and on a publish with no live published
+ *   document; `after` is null on delete and unpublish.
+ * - On publish/unpublish both images are of the *published* document —
+ *   `after` on publish is the draft's content promoted onto the published id.
  * - `identity` is the acting user — the id bound to the client's token
  *   (its `accessControl.currentUser`), or undefined when the client has no
  *   identity configured.
@@ -789,9 +819,11 @@ export declare interface TestClient {
     options?: TxnCommitOptions,
   ) => Promise<TxnCommitResult>;
   /**
-   * Dispatch one or more release / version actions against the store.
-   * Returns a synthetic `transactionId`. Multi-action arrays are applied
-   * atomically — any failure rolls back the batch.
+   * Dispatch one or more release / version / document actions against the
+   * store. Returns a synthetic `transactionId`. Multi-action arrays are
+   * applied atomically — any failure rolls back the batch. The document
+   * publish/unpublish actions run through the access gate and the
+   * `mutationGuard` seam; release/version actions apply unhooked.
    */
   action: (
     action: Action | Action[],