@civitai/blocks-react 0.67.0 → 0.68.0

package/dist/internal/mockHost.d.ts

@@ -93,6 +93,23 @@ export interface MockGenerationScenario {
      * a `(body) => number`. Overrides the legacy top-level `cost`. Default `8`.
      */
     costPerGen?: CostSpec;
+    /**
+     * The app author's per-generation fee, itemised as `cost.authorFee` on a
+     * QUOTE — the `ESTIMATE_RESULT` and the {@link submitCapRefusal} reply — and
+     * added into that quote's `cost.total` on top of {@link costPerGen}, as the
+     * real host does. A number, or a `(body) => number`. Default `0`, which is
+     * reported as `authorFee: 0` ("no fee on this request").
+     *
+     * Like the real host, only a `textToImage` or registered-`step` body is
+     * itemised; `customComfy`, pass-through `step` and `training` quotes carry no
+     * `authorFee`. The succeeded snapshot's `cost.total` stays {@link costPerGen}
+     * (a submitted workflow reports the generation's own cost), while a simulated
+     * {@link MockBuzzScenario.balance} is debited `costPerGen + authorFee`.
+     *
+     * `false` simulates a host that PREDATES the field: `authorFee` is omitted
+     * everywhere and no fee is added — use it to test your "not itemised" branch.
+     */
+    authorFee?: CostSpec | false;
     /**
      * Synthetic latency before the SUBMITTED→succeeded transition lands, in ms.
      * A single number, or a `[min, max]` range (uniform random). Applied to the
@@ -149,6 +166,35 @@ export interface MockGenerationScenario {
      * resource-compatibility rejection) to check how your block renders one.
      */
     failEstimateMessage?: string;
+    /**
+     * How the mock answers `ESTIMATE_WORKFLOW_BATCH` (`useBatchEstimate()`), so a
+     * block can exercise its per-cell fallback locally.
+     *
+     * - `'supported'` (default) — prices each cell exactly as an
+     *   `ESTIMATE_WORKFLOW` of that body would be priced (`costPerGen`,
+     *   `failEstimate` and the training rules all apply per cell) and replies with
+     *   the snapshots in order plus the host's aggregate.
+     * - `'unsupported'` — replies `{ error: 'unsupported on this host' }`, the
+     *   host's generic answer for a message it has no handler for.
+     *   `estimateBatch()` rejects with `BatchEstimateError` code `'unsupported'`.
+     * - `'silent'` — never replies, which is what a host that PREDATES the message
+     *   does. `estimateBatch()` rejects with code `'timeout'` once its wait ends;
+     *   pass a short `timeoutMs` to it in a test.
+     *
+     * Live-tunable via `setScenario({ generation: { batchEstimate } })`.
+     */
+    batchEstimate?: 'supported' | 'unsupported' | 'silent';
+    /**
+     * Indices of batch cells the mock answers as NOT PRICED IN TIME — the snapshot
+     * the host returns for a cell when the call's time budget runs out before that
+     * cell priced: `{ workflowId:'failed', status:'failed', error:'estimate timed out' }`
+     * (the host's string, held once in `BATCH_ESTIMATE_CELL_TIMEOUT_ERROR`).
+     * The other cells price normally and the call still resolves, so this tests a
+     * PARTIAL grid: the cell is `ok: false`, `timedOut: true`, with
+     * `WorkflowEstimateError` code `'failed'`. Applies only with
+     * `batchEstimate: 'supported'`. Default: unset (no cell times out).
+     */
+    batchEstimateTimedOutCells?: number[];
     /**
      * Force every SUBMIT to come back as a caught server EXCEPTION — the host's
      * real `failureSnapshot(err)` shape: `{ workflowId:'failed', status:'failed',
@@ -424,6 +470,27 @@ export interface MockSharedScenario {
      * error UX.
      */
     failNext?: number;
+    /**
+     * Refuse the next N shared WRITES (`append`/`update`/`vote`/`unvote`/
+     * `withdraw`/`report`) as RATE-LIMITED (counts down), the way the platform
+     * does when a per-(viewer, app) budget is empty: the reply carries the
+     * server's refusal text plus `rateLimit` metadata, so the hook rejects with
+     * `SharedStorageRateLimitError`. Checked before {@link failNext}, as the
+     * server checks the budget before attempting the write. Live-tunable via
+     * `setScenario({ shared: { rateLimitNext } })`.
+     */
+    rateLimitNext?: number;
+    /**
+     * The metadata a {@link rateLimitNext} refusal carries. `retryAfterSeconds`
+     * defaults to 60; `retryAt` defaults to now + `retryAfterSeconds`, computed
+     * when each refusal is sent. Pass a malformed value to exercise a block's
+     * fallback: the hook parses it, ignores the malformed value and throws a plain
+     * `Error`.
+     */
+    rateLimit?: {
+        retryAfterSeconds?: number;
+        retryAt?: string;
+    };
 }
 /**
  * Drives `createMockHost`. Every field is optional with a sensible default so
@@ -477,6 +544,18 @@ export interface MockHostOptions {
      * for that type. Defaults to a curated Checkpoint + LoRA pick.
      */
     cannedPicks?: Partial<Record<BlockResourcePickerType, CannedPick | null>>;
+    /**
+     * What a MULTI-select `OPEN_RESOURCE_PICKER` (`multiple: { max }`, LoRA only)
+     * answers with: these picks, in this order, cut to the request's `max` (itself
+     * clamped to 5) — the real host's `selectedResources`. `null` or `[]`
+     * simulates a dismissed picker (→ an empty list). Defaults to two curated
+     * LoRAs, or to `[]` when `cannedPicks.LORA` is `null`, so one "the viewer
+     * dismissed" setting covers both pick modes.
+     *
+     * The mock applies the real host's refusals too: `multiple` with a Checkpoint,
+     * or a `max` that is not a whole number ≥ 1, is answered with an `error`.
+     */
+    cannedMultiPicks?: CannedPick[] | null;
     /**
      * The canned moderated image returned from `OPEN_IMAGE_UPLOAD` when the block
      * requests `purpose:'display'` (the default) — what `useImageUpload().open()`
@@ -1054,7 +1133,7 @@ export interface MockHostOptions {
  * {@link MockHost.setTheme}, which pushes a real `THEME_CHANGE` — the mock of
  * the viewer toggling dark mode with the block already mounted.)
  */
-export type MockHostScenarioPatch = Pick<MockHostOptions, 'consentGrantable' | 'failMode' | 'cost' | 'pollsUntilDone' | 'cannedPicks' | 'cannedImageUpload' | 'cannedGenerationSourceUpload' | 'cannedImageScan' | 'generation' | 'buzz' | 'storage' | 'shared' | 'buzzBalanceError' | 'viewerResult' | 'viewerError' | 'buzzTransactions' | 'buzzAccounts' | 'dailyCompensation' | 'buzzReadError' | 'wildcardPack' | 'wildcardPackError' | 'collectionFollowError' | 'createPostResult' | 'createPostError' | 'trainingDatasetRejected' | 'trainingDatasetError' | 'trainingQuoteTotal' | 'runTrainingError' | 'runTrainingCapRefusal' | 'appWorkflows' | 'appWorkflowsError' | 'publishImageIds' | 'publishError' | 'gatedImages' | 'gatedImagesError' | 'disallowedAccountTypes' | 'saveImageError' | 'uploadImageBytesResult' | 'uploadImageBytesError'>;
+export type MockHostScenarioPatch = Pick<MockHostOptions, 'consentGrantable' | 'failMode' | 'cost' | 'pollsUntilDone' | 'cannedPicks' | 'cannedMultiPicks' | 'cannedImageUpload' | 'cannedGenerationSourceUpload' | 'cannedImageScan' | 'generation' | 'buzz' | 'storage' | 'shared' | 'buzzBalanceError' | 'viewerResult' | 'viewerError' | 'buzzTransactions' | 'buzzAccounts' | 'dailyCompensation' | 'buzzReadError' | 'wildcardPack' | 'wildcardPackError' | 'collectionFollowError' | 'createPostResult' | 'createPostError' | 'trainingDatasetRejected' | 'trainingDatasetError' | 'trainingQuoteTotal' | 'runTrainingError' | 'runTrainingCapRefusal' | 'appWorkflows' | 'appWorkflowsError' | 'publishImageIds' | 'publishError' | 'gatedImages' | 'gatedImagesError' | 'disallowedAccountTypes' | 'saveImageError' | 'uploadImageBytesResult' | 'uploadImageBytesError'>;
 /** Runtime Buzz-balance handle exposed on {@link MockHost.buzz}. */
 export interface MockBuzzHandle {
     /** Current simulated balance, or `undefined` when balance isn't simulated. */
@@ -1099,7 +1178,7 @@ export declare function disallowedAccountError(accountType: BuzzAccountType): st
 /**
  * Reads the URL query toggles the gen-matrix dev harness uses, so a starter's
  * dev harness keeps working with `?viewer/?consent/?fail/?theme/?pick/?pickCkpt`.
- * Layer-1 additions: `?balance/?latency/?costPerGen/?failNext/?failRate/?seed`
+ * Layer-1 additions: `?balance/?latency/?costPerGen/?authorFee/?failNext/?failRate/?seed`
  * map onto the new scenario groups so a dev can flip out-of-Buzz /
  * failures / latency without editing code. `?capRefusal=1` (or `=<text>`) sets
  * {@link MockGenerationScenario.submitCapRefusal}.