@civitai/blocks-react 0.67.0 → 0.68.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +386 -13
- package/dist/hooks/useBatchEstimate.d.ts +190 -0
- package/dist/hooks/useBatchEstimate.js +195 -0
- package/dist/hooks/useBlockAnalytics.d.ts +46 -4
- package/dist/hooks/useBlockAnalytics.js +41 -4
- package/dist/hooks/useBuzzWorkflow.d.ts +4 -1
- package/dist/hooks/useBuzzWorkflow.js +4 -1
- package/dist/hooks/useResourcePicker.d.ts +98 -37
- package/dist/hooks/useResourcePicker.js +77 -7
- package/dist/hooks/useSharedStorage.d.ts +24 -0
- package/dist/hooks/useSharedStorage.js +55 -0
- package/dist/hooks/useUploadImageBytes.d.ts +2 -6
- package/dist/hooks/useUploadImageBytes.js +2 -6
- package/dist/index.d.ts +5 -3
- package/dist/index.js +3 -2
- package/dist/internal/liveHost.d.ts +27 -2
- package/dist/internal/liveHost.js +133 -15
- package/dist/internal/mockHost.d.ts +81 -2
- package/dist/internal/mockHost.js +308 -78
- package/dist/internal/pickerOverlay.d.ts +32 -0
- package/dist/internal/pickerOverlay.js +99 -2
- package/dist/internal/trackEventCheck.d.ts +34 -0
- package/dist/internal/trackEventCheck.js +194 -0
- package/dist/transport/requestTimeouts.js +3 -0
- package/dist/transport/validate.d.ts +49 -6
- package/dist/transport/validate.js +132 -28
- package/package.json +4 -4
|
@@ -1,4 +1,28 @@
|
|
|
1
1
|
import type { SharedStorageValue } from '@civitai/app-sdk/blocks';
|
|
2
|
+
/**
|
|
3
|
+
* A shared-storage write the server REFUSED because a per-(viewer, app) budget
|
|
4
|
+
* is empty — thrown by `append`, `update`, `vote`, `unvote`, `withdraw` and
|
|
5
|
+
* `report` when the host's refusal carries retry metadata.
|
|
6
|
+
*
|
|
7
|
+
* It EXTENDS `Error`, the class every other shared-storage refusal is thrown
|
|
8
|
+
* as, so existing `catch` code keeps working unchanged: `.message` is still the
|
|
9
|
+
* host's refusal text (for example `Too many submissions — retry in 312s`).
|
|
10
|
+
* Branch on `instanceof SharedStorageRateLimitError` to render the wait from
|
|
11
|
+
* {@link SharedStorageRateLimitError.retryAt} instead of parsing the message.
|
|
12
|
+
*
|
|
13
|
+
* Not thrown when the refusal carries no metadata — a host that predates it, or
|
|
14
|
+
* a refusal that is not a rate limit. Those stay a plain `Error`.
|
|
15
|
+
*/
|
|
16
|
+
export declare class SharedStorageRateLimitError extends Error {
|
|
17
|
+
/** Whole seconds until a retry can succeed, as of when the server refused. At least 1. */
|
|
18
|
+
readonly retryAfterSeconds: number;
|
|
19
|
+
/** ISO-8601 instant at which a retry can succeed. Prefer this for a countdown. */
|
|
20
|
+
readonly retryAt: string;
|
|
21
|
+
constructor(message: string, rateLimit: {
|
|
22
|
+
retryAfterSeconds: number;
|
|
23
|
+
retryAt: string;
|
|
24
|
+
});
|
|
25
|
+
}
|
|
2
26
|
/**
|
|
3
27
|
* The value a viewer contributes to the SHARED store: a required `title`, an
|
|
4
28
|
* optional long-form `body`, and an optional opaque app-owned `data` blob.
|
|
@@ -2,6 +2,50 @@ import { useMemo } from 'react';
|
|
|
2
2
|
import { getTransport } from '../transport/singleton.js';
|
|
3
3
|
import { throwOnFailedReply, throwOnReplyError } from '../internal/replyError.js';
|
|
4
4
|
import { sendTypedRequest } from '../transport/transport.js';
|
|
5
|
+
import { parseSharedStorageRateLimit } from '../transport/validate.js';
|
|
6
|
+
/**
|
|
7
|
+
* A shared-storage write the server REFUSED because a per-(viewer, app) budget
|
|
8
|
+
* is empty — thrown by `append`, `update`, `vote`, `unvote`, `withdraw` and
|
|
9
|
+
* `report` when the host's refusal carries retry metadata.
|
|
10
|
+
*
|
|
11
|
+
* It EXTENDS `Error`, the class every other shared-storage refusal is thrown
|
|
12
|
+
* as, so existing `catch` code keeps working unchanged: `.message` is still the
|
|
13
|
+
* host's refusal text (for example `Too many submissions — retry in 312s`).
|
|
14
|
+
* Branch on `instanceof SharedStorageRateLimitError` to render the wait from
|
|
15
|
+
* {@link SharedStorageRateLimitError.retryAt} instead of parsing the message.
|
|
16
|
+
*
|
|
17
|
+
* Not thrown when the refusal carries no metadata — a host that predates it, or
|
|
18
|
+
* a refusal that is not a rate limit. Those stay a plain `Error`.
|
|
19
|
+
*/
|
|
20
|
+
export class SharedStorageRateLimitError extends Error {
|
|
21
|
+
/** Whole seconds until a retry can succeed, as of when the server refused. At least 1. */
|
|
22
|
+
retryAfterSeconds;
|
|
23
|
+
/** ISO-8601 instant at which a retry can succeed. Prefer this for a countdown. */
|
|
24
|
+
retryAt;
|
|
25
|
+
constructor(message, rateLimit) {
|
|
26
|
+
super(message);
|
|
27
|
+
this.name = 'SharedStorageRateLimitError';
|
|
28
|
+
this.retryAfterSeconds = rateLimit.retryAfterSeconds;
|
|
29
|
+
this.retryAt = rateLimit.retryAt;
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Throw {@link SharedStorageRateLimitError} when a write reply is a refusal (a
|
|
34
|
+
* PRESENT `error`, the same test as `throwOnReplyError`) that carries valid
|
|
35
|
+
* `rateLimit`. Otherwise returns, and the caller's usual reply check throws the
|
|
36
|
+
* plain `Error` as before.
|
|
37
|
+
*
|
|
38
|
+
* Parses `rateLimit` rather than trusting it: the transport delivers it as the
|
|
39
|
+
* host sent it, so a malformed value is ignored here and the caller's plain
|
|
40
|
+
* `Error` is thrown instead.
|
|
41
|
+
*/
|
|
42
|
+
function throwOnSharedRateLimit(result, fallback) {
|
|
43
|
+
if (result.error === undefined)
|
|
44
|
+
return;
|
|
45
|
+
const rateLimit = parseSharedStorageRateLimit(result.rateLimit);
|
|
46
|
+
if (rateLimit)
|
|
47
|
+
throw new SharedStorageRateLimitError(result.error || fallback, rateLimit);
|
|
48
|
+
}
|
|
5
49
|
/**
|
|
6
50
|
* App-scoped, append-only, community-votable SHARED datastore. Sibling of
|
|
7
51
|
* {@link useAppStorage} (the per-viewer KV store) — same postMessage bridge,
|
|
@@ -15,6 +59,11 @@ import { sendTypedRequest } from '../transport/transport.js';
|
|
|
15
59
|
* / `getCount(s)`) and a hard reject on mutations (`append`/`vote`/`unvote`/
|
|
16
60
|
* `withdraw`).
|
|
17
61
|
*
|
|
62
|
+
* Writes are budgeted per (viewer, app) server-side. A write refused for that
|
|
63
|
+
* reason rejects with {@link SharedStorageRateLimitError} (a subclass of the
|
|
64
|
+
* plain `Error` every other refusal is) carrying `retryAfterSeconds` and
|
|
65
|
+
* `retryAt`, whenever the host sends the metadata.
|
|
66
|
+
*
|
|
18
67
|
* The hook is stable across renders — it returns the same object identity once
|
|
19
68
|
* the transport singleton is created, so it's safe in `useEffect`/`useMemo`
|
|
20
69
|
* dependency arrays.
|
|
@@ -71,6 +120,7 @@ export function useSharedStorage() {
|
|
|
71
120
|
},
|
|
72
121
|
async report(key, reason) {
|
|
73
122
|
const result = await sendTypedRequest(transport, { type: 'SHARED_REPORT', payload: { key, reason } }, 'SHARED_REPORT_RESULT');
|
|
123
|
+
throwOnSharedRateLimit(result, 'shared report failed');
|
|
74
124
|
throwOnFailedReply(result, 'shared report failed');
|
|
75
125
|
},
|
|
76
126
|
async getCount(key) {
|
|
@@ -85,25 +135,30 @@ export function useSharedStorage() {
|
|
|
85
135
|
},
|
|
86
136
|
async append(value) {
|
|
87
137
|
const result = await sendTypedRequest(transport, { type: 'SHARED_APPEND', payload: { value } }, 'SHARED_APPEND_RESULT');
|
|
138
|
+
throwOnSharedRateLimit(result, 'shared append failed');
|
|
88
139
|
throwOnReplyError(result, 'shared append failed');
|
|
89
140
|
return { key: result.key };
|
|
90
141
|
},
|
|
91
142
|
async update(key, value) {
|
|
92
143
|
const result = await sendTypedRequest(transport, { type: 'SHARED_UPDATE', payload: { key, value } }, 'SHARED_UPDATE_RESULT');
|
|
144
|
+
throwOnSharedRateLimit(result, 'shared update failed');
|
|
93
145
|
throwOnFailedReply(result, 'shared update failed');
|
|
94
146
|
},
|
|
95
147
|
async vote(key) {
|
|
96
148
|
const result = await sendTypedRequest(transport, { type: 'SHARED_VOTE', payload: { key } }, 'SHARED_VOTE_RESULT');
|
|
149
|
+
throwOnSharedRateLimit(result, 'shared vote failed');
|
|
97
150
|
throwOnReplyError(result, 'shared vote failed');
|
|
98
151
|
return result.count;
|
|
99
152
|
},
|
|
100
153
|
async unvote(key) {
|
|
101
154
|
const result = await sendTypedRequest(transport, { type: 'SHARED_UNVOTE', payload: { key } }, 'SHARED_UNVOTE_RESULT');
|
|
155
|
+
throwOnSharedRateLimit(result, 'shared unvote failed');
|
|
102
156
|
throwOnReplyError(result, 'shared unvote failed');
|
|
103
157
|
return result.count;
|
|
104
158
|
},
|
|
105
159
|
async withdraw(key) {
|
|
106
160
|
const result = await sendTypedRequest(transport, { type: 'SHARED_WITHDRAW', payload: { key } }, 'SHARED_WITHDRAW_RESULT');
|
|
161
|
+
throwOnSharedRateLimit(result, 'shared withdraw failed');
|
|
107
162
|
throwOnFailedReply(result, 'shared withdraw failed');
|
|
108
163
|
// `deleted` is optional on the wire type because an error reply omits
|
|
109
164
|
// it. On the success path the validator requires a boolean, so this is
|
|
@@ -62,12 +62,8 @@ export interface UseUploadImageBytes {
|
|
|
62
62
|
* - The buffer is COPIED across `postMessage`, never transferred, so the block
|
|
63
63
|
* can keep displaying it. Pass an `ArrayBuffer` (`await blob.arrayBuffer()`),
|
|
64
64
|
* not a `Blob` or a typed array, which the host refuses.
|
|
65
|
-
* -
|
|
66
|
-
*
|
|
67
|
-
* `the host returned no uploaded image` on a dismiss. It needs
|
|
68
|
-
* civitai/civitai#5639 merged and deployed to civitai.com; that PR is still
|
|
69
|
-
* changing, so no intermediate head of it is enough. Do not ship a block
|
|
70
|
-
* relying on this before then.
|
|
65
|
+
* - Ships in `@civitai/blocks-react` 0.67.0; the `bytes` payload type it sends
|
|
66
|
+
* is in `@civitai/app-sdk` 0.62.0.
|
|
71
67
|
*
|
|
72
68
|
* Under `createMockHost` / `Harness` the host's admission rules are modelled
|
|
73
69
|
* (see `MockHostOptions.uploadImageBytesResult`). `dev:live` has no bytes
|
|
@@ -28,12 +28,8 @@ export const UPLOAD_IMAGE_BYTES_NO_IMAGE_ERROR = 'the host returned no uploaded
|
|
|
28
28
|
* - The buffer is COPIED across `postMessage`, never transferred, so the block
|
|
29
29
|
* can keep displaying it. Pass an `ArrayBuffer` (`await blob.arrayBuffer()`),
|
|
30
30
|
* not a `Blob` or a typed array, which the host refuses.
|
|
31
|
-
* -
|
|
32
|
-
*
|
|
33
|
-
* `the host returned no uploaded image` on a dismiss. It needs
|
|
34
|
-
* civitai/civitai#5639 merged and deployed to civitai.com; that PR is still
|
|
35
|
-
* changing, so no intermediate head of it is enough. Do not ship a block
|
|
36
|
-
* relying on this before then.
|
|
31
|
+
* - Ships in `@civitai/blocks-react` 0.67.0; the `bytes` payload type it sends
|
|
32
|
+
* is in `@civitai/app-sdk` 0.62.0.
|
|
37
33
|
*
|
|
38
34
|
* Under `createMockHost` / `Harness` the host's admission rules are modelled
|
|
39
35
|
* (see `MockHostOptions.uploadImageBytesResult`). `dev:live` has no bytes
|
package/dist/index.d.ts
CHANGED
|
@@ -27,6 +27,8 @@ export { useHostOrigin } from './hooks/useHostOrigin.js';
|
|
|
27
27
|
export type { UseHostOrigin } from './hooks/useHostOrigin.js';
|
|
28
28
|
export { DEFAULT_WATCH_WAIT_SECONDS, useBuzzWorkflow, WorkflowEstimateError, WorkflowSubmitError, } from './hooks/useBuzzWorkflow.js';
|
|
29
29
|
export type { SubmitWorkflowOptions, UseBuzzWorkflow, WatchWorkflowOptions, WorkflowSubmitErrorCode, } from './hooks/useBuzzWorkflow.js';
|
|
30
|
+
export { BATCH_ESTIMATE_MAX_CELLS, BatchEstimateError, useBatchEstimate, } from './hooks/useBatchEstimate.js';
|
|
31
|
+
export type { BatchEstimateCell, BatchEstimateErrorCode, BatchEstimateResult, BlockEstimateBatchAggregate, EstimateBatchOptions, UseBatchEstimate, } from './hooks/useBatchEstimate.js';
|
|
30
32
|
export { useEntitlements } from './hooks/useEntitlements.js';
|
|
31
33
|
export type { UseEntitlements, Entitlement } from './hooks/useEntitlements.js';
|
|
32
34
|
export { useGoodPurchase, GoodPurchaseRefusal } from './hooks/useGoodPurchase.js';
|
|
@@ -74,8 +76,8 @@ export type { UseRunTraining, QuotedTrainingBody, RunTrainingErrorCode, BlockRun
|
|
|
74
76
|
export type { BlockBuzzTransaction, BlockBuzzAccount, BlockDailyCompensationResource, BlockWildcardPack, BlockWildcardPackErrorCode, AppWorkflow, AppWorkflowImage, AppWorkflowsParams, BlockGatedImage, BlockCollectionFollowErrorCode, BlockCollectionFollowResult, } from '@civitai/app-sdk/blocks';
|
|
75
77
|
export { useCheckpointPicker } from './hooks/useCheckpointPicker.js';
|
|
76
78
|
export type { UseCheckpointPicker } from './hooks/useCheckpointPicker.js';
|
|
77
|
-
export { useResourcePicker } from './hooks/useResourcePicker.js';
|
|
78
|
-
export type { UseResourcePicker } from './hooks/useResourcePicker.js';
|
|
79
|
+
export { useResourcePicker, RESOURCE_PICKER_MULTIPLE_MAX } from './hooks/useResourcePicker.js';
|
|
80
|
+
export type { UseResourcePicker, ResourcePickerOpenOptions, ResourcePickerMultiple, } from './hooks/useResourcePicker.js';
|
|
79
81
|
export { useImageUpload } from './hooks/useImageUpload.js';
|
|
80
82
|
export type { UseImageUpload, UseImageUploadAsyncScan, UseImageUploadGenerationSource, UseImageUploadOptions, } from './hooks/useImageUpload.js';
|
|
81
83
|
export { useUploadImageBytes } from './hooks/useUploadImageBytes.js';
|
|
@@ -108,6 +110,6 @@ export { useNestedDocument } from './hooks/useNestedDocument.js';
|
|
|
108
110
|
export type { NestedDocumentStatus, UseNestedDocument, UseNestedDocumentOptions, } from './hooks/useNestedDocument.js';
|
|
109
111
|
export { useAppStorage } from './hooks/useAppStorage.js';
|
|
110
112
|
export type { AppStorageKeyEntry, AppStorageListResult, AppStorageQuota, UseAppStorage, } from './hooks/useAppStorage.js';
|
|
111
|
-
export { useSharedStorage } from './hooks/useSharedStorage.js';
|
|
113
|
+
export { useSharedStorage, SharedStorageRateLimitError } from './hooks/useSharedStorage.js';
|
|
112
114
|
export type { SharedAppendValue, SharedListItem, SharedListResult, UseSharedStorage, } from './hooks/useSharedStorage.js';
|
|
113
115
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
CHANGED
|
@@ -31,6 +31,7 @@ export { useBlockSettings } from './hooks/useBlockSettings.js';
|
|
|
31
31
|
export { useBlockToken } from './hooks/useBlockToken.js';
|
|
32
32
|
export { useHostOrigin } from './hooks/useHostOrigin.js';
|
|
33
33
|
export { DEFAULT_WATCH_WAIT_SECONDS, useBuzzWorkflow, WorkflowEstimateError, WorkflowSubmitError, } from './hooks/useBuzzWorkflow.js';
|
|
34
|
+
export { BATCH_ESTIMATE_MAX_CELLS, BatchEstimateError, useBatchEstimate, } from './hooks/useBatchEstimate.js';
|
|
34
35
|
export { useEntitlements } from './hooks/useEntitlements.js';
|
|
35
36
|
export { useGoodPurchase, GoodPurchaseRefusal } from './hooks/useGoodPurchase.js';
|
|
36
37
|
export { useTip } from './hooks/useTip.js';
|
|
@@ -62,7 +63,7 @@ export { useCreatePostFromApp, CreatePostError, CREATE_POST_ERROR_CODES, isCreat
|
|
|
62
63
|
export { usePrepareTrainingDataset, PrepareTrainingDatasetError, PREPARE_TRAINING_DATASET_ERROR_CODES, isPrepareTrainingDatasetErrorCode, } from './hooks/usePrepareTrainingDataset.js';
|
|
63
64
|
export { useRunTraining, RunTrainingError, RUN_TRAINING_ERROR_CODES, isRunTrainingErrorCode, } from './hooks/useRunTraining.js';
|
|
64
65
|
export { useCheckpointPicker } from './hooks/useCheckpointPicker.js';
|
|
65
|
-
export { useResourcePicker } from './hooks/useResourcePicker.js';
|
|
66
|
+
export { useResourcePicker, RESOURCE_PICKER_MULTIPLE_MAX } from './hooks/useResourcePicker.js';
|
|
66
67
|
export { useImageUpload } from './hooks/useImageUpload.js';
|
|
67
68
|
export { useUploadImageBytes } from './hooks/useUploadImageBytes.js';
|
|
68
69
|
export { useGenerationResources } from './hooks/useGenerationResources.js';
|
|
@@ -84,5 +85,5 @@ export { hostToRunUrl, DIRECT_LOAD_TIMEOUT_MS } from './transport/directLoad.js'
|
|
|
84
85
|
// `@civitai/app-sdk`'s `src/blocks/nestedDocument.ts` header.
|
|
85
86
|
export { useNestedDocument } from './hooks/useNestedDocument.js';
|
|
86
87
|
export { useAppStorage } from './hooks/useAppStorage.js';
|
|
87
|
-
export { useSharedStorage } from './hooks/useSharedStorage.js';
|
|
88
|
+
export { useSharedStorage, SharedStorageRateLimitError } from './hooks/useSharedStorage.js';
|
|
88
89
|
//# sourceMappingURL=index.js.map
|
|
@@ -46,8 +46,8 @@
|
|
|
46
46
|
* --- BEGIN DERIVED ---
|
|
47
47
|
* fetch chokepoints ..... 2
|
|
48
48
|
* REST endpoints ........ GET /api/v1/blocks/me
|
|
49
|
-
* tRPC procedures .......
|
|
50
|
-
* switch case labels ....
|
|
49
|
+
* tRPC procedures ....... 29 = blocks.* (14) + apps.shared.* (10) + apps.storage.* (5)
|
|
50
|
+
* switch case labels .... 48, of which 10 REFUSE (enumerated under SCOPE below)
|
|
51
51
|
* --- END DERIVED ---
|
|
52
52
|
*
|
|
53
53
|
* PICKERS (Phase 1 of "make dev:live a faithful local host"): the live host
|
|
@@ -83,6 +83,12 @@
|
|
|
83
83
|
* the switch's `default: return` with no reply at all, so `useSharedStorage()`
|
|
84
84
|
* hung to the 30s protocol timeout in dev:live for code that worked in dev:mock.
|
|
85
85
|
*
|
|
86
|
+
* TRACK_EVENT: recorded only in production, so the live host forwards nothing
|
|
87
|
+
* and replies nothing (production replies nothing either). What it does is
|
|
88
|
+
* CHECK each event against the manifest passed as `options.manifest` and warn
|
|
89
|
+
* once per distinct problem production would silently drop — see
|
|
90
|
+
* `trackEventCheck.ts`.
|
|
91
|
+
*
|
|
86
92
|
* 🔴 SCOPE — the capabilities live mode still cannot SERVE. Each REFUSES on its
|
|
87
93
|
* own reply channel — `logOnce` (or `console.info`) plus an honest error, never
|
|
88
94
|
* a fabricated success and never silence. Two guards stand behind this list:
|
|
@@ -186,6 +192,25 @@ export interface LiveHostOptions {
|
|
|
186
192
|
* `dev:live` run this is omitted — the dev clicks a card in the overlay.
|
|
187
193
|
*/
|
|
188
194
|
onPickerReady?: (handle: PickerOverlayHandle) => void;
|
|
195
|
+
/**
|
|
196
|
+
* The app's manifest — pass `block.manifest.json` as the harness imported it.
|
|
197
|
+
* Used for one thing: each `TRACK_EVENT` is checked against its
|
|
198
|
+
* `analytics.events` declaration, and the console warns ONCE per distinct
|
|
199
|
+
* problem production would silently drop — an undeclared event, an
|
|
200
|
+
* undeclared property, a value that does not match the declared type or enum.
|
|
201
|
+
* A declared, valid event logs nothing. The check never throws, never blocks
|
|
202
|
+
* the block, and sends no reply (production sends none either). Omit it and
|
|
203
|
+
* the first `TRACK_EVENT` says the check is off.
|
|
204
|
+
*
|
|
205
|
+
* Typed `unknown` because an imported JSON file widens its string literals
|
|
206
|
+
* (`"type": "enum"` reads as `string`), which a stricter type would reject.
|
|
207
|
+
*
|
|
208
|
+
* @example
|
|
209
|
+
* // `manifest` = your block.manifest.json, imported as JSON — every
|
|
210
|
+
* // `starters/examples/*` harness does this.
|
|
211
|
+
* createLiveHost({ blockToken, manifest });
|
|
212
|
+
*/
|
|
213
|
+
manifest?: unknown;
|
|
189
214
|
}
|
|
190
215
|
/**
|
|
191
216
|
* The reply both training bridges get in dev:live — see their handlers. One
|
|
@@ -46,8 +46,8 @@
|
|
|
46
46
|
* --- BEGIN DERIVED ---
|
|
47
47
|
* fetch chokepoints ..... 2
|
|
48
48
|
* REST endpoints ........ GET /api/v1/blocks/me
|
|
49
|
-
* tRPC procedures .......
|
|
50
|
-
* switch case labels ....
|
|
49
|
+
* tRPC procedures ....... 29 = blocks.* (14) + apps.shared.* (10) + apps.storage.* (5)
|
|
50
|
+
* switch case labels .... 48, of which 10 REFUSE (enumerated under SCOPE below)
|
|
51
51
|
* --- END DERIVED ---
|
|
52
52
|
*
|
|
53
53
|
* PICKERS (Phase 1 of "make dev:live a faithful local host"): the live host
|
|
@@ -83,6 +83,12 @@
|
|
|
83
83
|
* the switch's `default: return` with no reply at all, so `useSharedStorage()`
|
|
84
84
|
* hung to the 30s protocol timeout in dev:live for code that worked in dev:mock.
|
|
85
85
|
*
|
|
86
|
+
* TRACK_EVENT: recorded only in production, so the live host forwards nothing
|
|
87
|
+
* and replies nothing (production replies nothing either). What it does is
|
|
88
|
+
* CHECK each event against the manifest passed as `options.manifest` and warn
|
|
89
|
+
* once per distinct problem production would silently drop — see
|
|
90
|
+
* `trackEventCheck.ts`.
|
|
91
|
+
*
|
|
86
92
|
* 🔴 SCOPE — the capabilities live mode still cannot SERVE. Each REFUSES on its
|
|
87
93
|
* own reply channel — `logOnce` (or `console.info`) plus an honest error, never
|
|
88
94
|
* a fabricated success and never silence. Two guards stand behind this list:
|
|
@@ -129,6 +135,8 @@
|
|
|
129
135
|
import { consentUnavailablePayload, resolveUngrantableConsentNotice } from './consent.js';
|
|
130
136
|
import { hostContextWithTheme } from '../transport/transport.js';
|
|
131
137
|
import { isRoutableRequestId } from '../transport/requestId.js';
|
|
138
|
+
import { parseSharedStorageRateLimit } from '../transport/validate.js';
|
|
139
|
+
import { createTrackEventChecker } from './trackEventCheck.js';
|
|
132
140
|
import { openPickerOverlay, } from './pickerOverlay.js';
|
|
133
141
|
/** Default civitai backend the live host forwards to. */
|
|
134
142
|
const DEFAULT_BACKEND_BASE_URL = 'https://civitai.com';
|
|
@@ -225,6 +233,9 @@ function errorSnapshot(error) {
|
|
|
225
233
|
* deploy (the dev token is fine; the pod just hasn't loaded the verifier yet) —
|
|
226
234
|
* the exact blip the round-5 dogfood hit. Anything ≥ 500, plus 408 (timeout)
|
|
227
235
|
* and 429 (rate-limit), is also transient.
|
|
236
|
+
*
|
|
237
|
+
* Only {@link pollWithRetry} reads `transient`; a shared-storage 429 is a
|
|
238
|
+
* write-budget refusal whose wait is minutes, so it must never be retried.
|
|
228
239
|
*/
|
|
229
240
|
function isTransientHttpStatus(status) {
|
|
230
241
|
return status >= 500 || status === 408 || status === 429 || status === 401;
|
|
@@ -323,6 +334,8 @@ export function createLiveHost(options) {
|
|
|
323
334
|
'likely minted from an OAuth login. Real generation needs a full-scope personal API key: ' +
|
|
324
335
|
'`civitai login --token <key>` (https://civitai.com/user/account), then re-mint the dev token.');
|
|
325
336
|
}
|
|
337
|
+
// `TRACK_EVENT` vs the manifest's `analytics.events`; dedupes its own warnings.
|
|
338
|
+
const trackEventChecker = createTrackEventChecker(options.manifest);
|
|
326
339
|
// One-time "not supported in live v1" log gating per capability.
|
|
327
340
|
const loggedOnce = new Set();
|
|
328
341
|
const logOnce = (key, message) => {
|
|
@@ -377,7 +390,12 @@ export function createLiveHost(options) {
|
|
|
377
390
|
}
|
|
378
391
|
if (!res.ok) {
|
|
379
392
|
const msg = extractTrpcError(parsed) ?? `${procedure} failed: HTTP ${res.status}`;
|
|
380
|
-
|
|
393
|
+
const rateLimit = parseSharedStorageRateLimit(extractTrpcErrorData(parsed)?.rateLimit);
|
|
394
|
+
return {
|
|
395
|
+
error: msg,
|
|
396
|
+
transient: isTransientHttpStatus(res.status),
|
|
397
|
+
...(rateLimit ? { rateLimit } : {}),
|
|
398
|
+
};
|
|
381
399
|
}
|
|
382
400
|
return { parsed };
|
|
383
401
|
}
|
|
@@ -411,8 +429,13 @@ export function createLiveHost(options) {
|
|
|
411
429
|
*/
|
|
412
430
|
async function callTrpcData(procedure, input, method) {
|
|
413
431
|
const raw = await rawTrpcCall(procedure, input, method);
|
|
414
|
-
if (raw.error !== undefined)
|
|
415
|
-
return {
|
|
432
|
+
if (raw.error !== undefined) {
|
|
433
|
+
return {
|
|
434
|
+
error: raw.error,
|
|
435
|
+
transient: raw.transient,
|
|
436
|
+
...(raw.rateLimit ? { rateLimit: raw.rateLimit } : {}),
|
|
437
|
+
};
|
|
438
|
+
}
|
|
416
439
|
const data = extractData(raw.parsed);
|
|
417
440
|
if (data === undefined) {
|
|
418
441
|
return { error: `${procedure}: malformed response (no data)` };
|
|
@@ -659,16 +682,32 @@ export function createLiveHost(options) {
|
|
|
659
682
|
fetchImpl,
|
|
660
683
|
...(params.baseModelGroup != null ? { baseModelGroup: params.baseModelGroup } : {}),
|
|
661
684
|
...(params.currentVersionId != null ? { currentVersionId: params.currentVersionId } : {}),
|
|
685
|
+
...(params.multiple ? { multiple: params.multiple } : {}),
|
|
662
686
|
...(win.document ? { document: win.document } : {}),
|
|
663
687
|
...(options.onPickerReady ? { onReady: options.onPickerReady } : {}),
|
|
664
688
|
onResolve: (selection) => {
|
|
665
689
|
openOverlays.delete(handle);
|
|
666
690
|
if (torn)
|
|
667
691
|
return;
|
|
692
|
+
if (params.multiple) {
|
|
693
|
+
// MULTI-select: the reply shape follows the REQUEST — always a list,
|
|
694
|
+
// `[]` on dismissal, and never `selected` (the production contract).
|
|
695
|
+
dispatchToBlock({
|
|
696
|
+
type: resultType,
|
|
697
|
+
payload: {
|
|
698
|
+
requestId,
|
|
699
|
+
selectedResources: selection && 'selectedResources' in selection ? selection.selectedResources : [],
|
|
700
|
+
},
|
|
701
|
+
});
|
|
702
|
+
return;
|
|
703
|
+
}
|
|
668
704
|
dispatchToBlock({
|
|
669
705
|
type: resultType,
|
|
670
706
|
// A dismissal omits `selected` (the hooks resolve to undefined/null).
|
|
671
|
-
payload: {
|
|
707
|
+
payload: {
|
|
708
|
+
requestId,
|
|
709
|
+
...(selection && 'selected' in selection ? { selected: selection.selected } : {}),
|
|
710
|
+
},
|
|
672
711
|
});
|
|
673
712
|
},
|
|
674
713
|
});
|
|
@@ -723,6 +762,27 @@ export function createLiveHost(options) {
|
|
|
723
762
|
});
|
|
724
763
|
return;
|
|
725
764
|
}
|
|
765
|
+
case 'ESTIMATE_WORKFLOW_BATCH': {
|
|
766
|
+
// Forwarded to the token-bound `blocks.estimateWorkflowBatch`, the
|
|
767
|
+
// batch twin of the estimate above. Its reply is a plain
|
|
768
|
+
// `{ snapshots, aggregate }` (unwrapped with `callTrpcData`); a
|
|
769
|
+
// whole-call failure is FREE-TEXT `error`, a per-cell failure rides in
|
|
770
|
+
// `snapshots`. Estimate only — nothing is submitted. Unroutable
|
|
771
|
+
// without a requestId. Against a civitai that predates the procedure
|
|
772
|
+
// the server's own not-found error comes back here as `error`.
|
|
773
|
+
if (!isRoutableRequestId(requestId))
|
|
774
|
+
return;
|
|
775
|
+
void callTrpcData('blocks.estimateWorkflowBatch', { blockToken: rawToken, bodies: typed.payload?.bodies }, 'POST').then((r) => {
|
|
776
|
+
const data = r.data;
|
|
777
|
+
dispatchToBlock({
|
|
778
|
+
type: 'ESTIMATE_BATCH_RESULT',
|
|
779
|
+
payload: data && Array.isArray(data.snapshots) && data.aggregate
|
|
780
|
+
? { requestId, snapshots: data.snapshots, aggregate: data.aggregate }
|
|
781
|
+
: { requestId, error: r.error ?? 'batch estimate failed' },
|
|
782
|
+
});
|
|
783
|
+
});
|
|
784
|
+
return;
|
|
785
|
+
}
|
|
726
786
|
case 'SUBMIT_WORKFLOW': {
|
|
727
787
|
const body = typed.payload?.body;
|
|
728
788
|
// 🔴 KNOWN GAP, DELIBERATELY NOT CHANGED HERE — see below before
|
|
@@ -1158,11 +1218,37 @@ export function createLiveHost(options) {
|
|
|
1158
1218
|
// (or no `selected` on dismissal). DISCOVERY ONLY — re-priced +
|
|
1159
1219
|
// re-validated server-side at estimate/submit.
|
|
1160
1220
|
const resourceType = typed.payload?.resourceType === 'Checkpoint' ? 'Checkpoint' : 'LORA';
|
|
1221
|
+
// MULTI-select (`multiple: { max }`) — the production host's rules:
|
|
1222
|
+
// LoRA only, `max` a whole number ≥ 1 clamped to 5, and a refusal is
|
|
1223
|
+
// ANSWERED with `error` (the hook throws on it) rather than opening
|
|
1224
|
+
// a single-pick overlay the block did not ask for.
|
|
1225
|
+
const rawMultiple = typed.payload?.multiple;
|
|
1226
|
+
let multiple;
|
|
1227
|
+
if (rawMultiple !== undefined && rawMultiple !== null) {
|
|
1228
|
+
const max = typeof rawMultiple === 'object' ? rawMultiple.max : undefined;
|
|
1229
|
+
const refusal = resourceType === 'Checkpoint'
|
|
1230
|
+
? 'OPEN_RESOURCE_PICKER: multiple is only supported for LoRA-family resource types, not Checkpoint.'
|
|
1231
|
+
: typeof max !== 'number' || !Number.isInteger(max) || max < 1
|
|
1232
|
+
? 'OPEN_RESOURCE_PICKER: multiple.max must be a whole number of at least 1.'
|
|
1233
|
+
: null;
|
|
1234
|
+
if (refusal !== null) {
|
|
1235
|
+
// A refusal nobody can route is not worth sending.
|
|
1236
|
+
if (!isRoutableRequestId(requestId))
|
|
1237
|
+
return;
|
|
1238
|
+
dispatchToBlock({
|
|
1239
|
+
type: 'RESOURCE_PICKER_RESULT',
|
|
1240
|
+
payload: { requestId, error: refusal },
|
|
1241
|
+
});
|
|
1242
|
+
return;
|
|
1243
|
+
}
|
|
1244
|
+
multiple = { max: Math.min(max, 5) };
|
|
1245
|
+
}
|
|
1161
1246
|
openPicker({
|
|
1162
1247
|
type: resourceType,
|
|
1163
1248
|
...(typeof typed.payload?.baseModelGroup === 'string'
|
|
1164
1249
|
? { baseModelGroup: typed.payload.baseModelGroup }
|
|
1165
1250
|
: {}),
|
|
1251
|
+
...(multiple ? { multiple } : {}),
|
|
1166
1252
|
}, 'RESOURCE_PICKER_RESULT', requestId ?? '');
|
|
1167
1253
|
return;
|
|
1168
1254
|
}
|
|
@@ -1523,7 +1609,7 @@ export function createLiveHost(options) {
|
|
|
1523
1609
|
if (r.error) {
|
|
1524
1610
|
dispatchToBlock({
|
|
1525
1611
|
type: 'SHARED_APPEND_RESULT',
|
|
1526
|
-
payload: { requestId: requestId ?? '', key: '',
|
|
1612
|
+
payload: { requestId: requestId ?? '', key: '', ...sharedRefusal(r) },
|
|
1527
1613
|
});
|
|
1528
1614
|
return;
|
|
1529
1615
|
}
|
|
@@ -1542,7 +1628,7 @@ export function createLiveHost(options) {
|
|
|
1542
1628
|
dispatchToBlock({
|
|
1543
1629
|
type: 'SHARED_UPDATE_RESULT',
|
|
1544
1630
|
payload: r.error
|
|
1545
|
-
? { requestId: requestId ?? '', ok: false,
|
|
1631
|
+
? { requestId: requestId ?? '', ok: false, ...sharedRefusal(r) }
|
|
1546
1632
|
: { requestId: requestId ?? '', ok: true },
|
|
1547
1633
|
});
|
|
1548
1634
|
});
|
|
@@ -1554,7 +1640,7 @@ export function createLiveHost(options) {
|
|
|
1554
1640
|
if (r.error) {
|
|
1555
1641
|
dispatchToBlock({
|
|
1556
1642
|
type: 'SHARED_VOTE_RESULT',
|
|
1557
|
-
payload: { requestId: requestId ?? '', count: 0,
|
|
1643
|
+
payload: { requestId: requestId ?? '', count: 0, ...sharedRefusal(r) },
|
|
1558
1644
|
});
|
|
1559
1645
|
return;
|
|
1560
1646
|
}
|
|
@@ -1572,7 +1658,7 @@ export function createLiveHost(options) {
|
|
|
1572
1658
|
if (r.error) {
|
|
1573
1659
|
dispatchToBlock({
|
|
1574
1660
|
type: 'SHARED_UNVOTE_RESULT',
|
|
1575
|
-
payload: { requestId: requestId ?? '', count: 0,
|
|
1661
|
+
payload: { requestId: requestId ?? '', count: 0, ...sharedRefusal(r) },
|
|
1576
1662
|
});
|
|
1577
1663
|
return;
|
|
1578
1664
|
}
|
|
@@ -1594,7 +1680,7 @@ export function createLiveHost(options) {
|
|
|
1594
1680
|
requestId: requestId ?? '',
|
|
1595
1681
|
ok: false,
|
|
1596
1682
|
deleted: false,
|
|
1597
|
-
|
|
1683
|
+
...sharedRefusal(r),
|
|
1598
1684
|
},
|
|
1599
1685
|
});
|
|
1600
1686
|
return;
|
|
@@ -1632,7 +1718,7 @@ export function createLiveHost(options) {
|
|
|
1632
1718
|
dispatchToBlock({
|
|
1633
1719
|
type: 'SHARED_REPORT_RESULT',
|
|
1634
1720
|
payload: r.error
|
|
1635
|
-
? { requestId: requestId ?? '', ok: false,
|
|
1721
|
+
? { requestId: requestId ?? '', ok: false, ...sharedRefusal(r) }
|
|
1636
1722
|
: { requestId: requestId ?? '', ok: true },
|
|
1637
1723
|
});
|
|
1638
1724
|
});
|
|
@@ -1865,9 +1951,19 @@ export function createLiveHost(options) {
|
|
|
1865
1951
|
return;
|
|
1866
1952
|
}
|
|
1867
1953
|
case 'TRACK_EVENT':
|
|
1954
|
+
// Fire-and-forget, no reply — as in production, where the host
|
|
1955
|
+
// forwards it and the ingest keeps only what the manifest's
|
|
1956
|
+
// `analytics.events` declares. Nothing is sent anywhere from here;
|
|
1957
|
+
// the only effect is a once-per-problem console warning for what
|
|
1958
|
+
// production would drop (see `trackEventCheck.ts`).
|
|
1959
|
+
for (const message of trackEventChecker.check(typed.payload)) {
|
|
1960
|
+
// eslint-disable-next-line no-console
|
|
1961
|
+
console.warn(`[createLiveHost] ${message}`);
|
|
1962
|
+
}
|
|
1963
|
+
return;
|
|
1868
1964
|
case 'REQUEST_SIGN_IN':
|
|
1869
1965
|
case 'BLOCK_ERROR':
|
|
1870
|
-
// No-op.
|
|
1966
|
+
// No-op. BLOCK_ERROR is fire-and-forget; REQUEST_SIGN_IN
|
|
1871
1967
|
// can't open a login in dev (the viewer comes from the token — a
|
|
1872
1968
|
// failed viewer fetch already warns in resolveViewer).
|
|
1873
1969
|
return;
|
|
@@ -2051,6 +2147,21 @@ function extractData(parsed) {
|
|
|
2051
2147
|
* `{ error: { message } }`. Returns undefined when no message is found.
|
|
2052
2148
|
*/
|
|
2053
2149
|
function extractTrpcError(parsed) {
|
|
2150
|
+
const message = trpcErrorShape(parsed)?.message;
|
|
2151
|
+
return typeof message === 'string' ? message : undefined;
|
|
2152
|
+
}
|
|
2153
|
+
/**
|
|
2154
|
+
* The `data` object of a tRPC error response (`{ error: { json: { data } } }`
|
|
2155
|
+
* or `{ error: { data } }`), or undefined. The platform's error formatter puts
|
|
2156
|
+
* machine-readable refusal fields here — `rateLimit` on a rate-limited
|
|
2157
|
+
* shared-storage write — which {@link extractTrpcError} alone dropped.
|
|
2158
|
+
*/
|
|
2159
|
+
function extractTrpcErrorData(parsed) {
|
|
2160
|
+
const data = trpcErrorShape(parsed)?.data;
|
|
2161
|
+
return typeof data === 'object' && data !== null ? data : undefined;
|
|
2162
|
+
}
|
|
2163
|
+
/** The unwrapped tRPC error shape (superjson `{ json }` or plain), or undefined. */
|
|
2164
|
+
function trpcErrorShape(parsed) {
|
|
2054
2165
|
if (typeof parsed !== 'object' || parsed === null)
|
|
2055
2166
|
return undefined;
|
|
2056
2167
|
const error = parsed.error;
|
|
@@ -2059,7 +2170,14 @@ function extractTrpcError(parsed) {
|
|
|
2059
2170
|
const inner = 'json' in error ? error.json : error;
|
|
2060
2171
|
if (typeof inner !== 'object' || inner === null)
|
|
2061
2172
|
return undefined;
|
|
2062
|
-
|
|
2063
|
-
|
|
2173
|
+
return inner;
|
|
2174
|
+
}
|
|
2175
|
+
/**
|
|
2176
|
+
* The error fields of a shared-storage WRITE reply — `error`, plus `rateLimit`
|
|
2177
|
+
* only when the refusal carried it. The dev-host twin of the production host's
|
|
2178
|
+
* `sharedStorageErrorReply`, so the six write bridges build the refusal one way.
|
|
2179
|
+
*/
|
|
2180
|
+
function sharedRefusal(r) {
|
|
2181
|
+
return { error: r.error ?? '', ...(r.rateLimit ? { rateLimit: r.rateLimit } : {}) };
|
|
2064
2182
|
}
|
|
2065
2183
|
//# sourceMappingURL=liveHost.js.map
|