@civitai/blocks-react 0.76.1 → 0.78.0

package/dist/transport/validate.js

@@ -770,6 +770,18 @@ function isPendingUpload(s) {
         return false;
     return true;
 }
+/**
+ * The `purpose:'trainingData'` `IMAGE_UPLOAD_RESULT.selected` shape
+ * (civitai/civitai#6461): `{ images: [{ url, air }] }`, each `url` and `air` a
+ * non-empty string. Mirrors the host's `TrainingDataUpload`. `air` is opaque —
+ * its key format is the host's to check, at the estimate — so only its type is
+ * pinned here.
+ */
+function isTrainingDataUpload(s) {
+    if (!Array.isArray(s.images))
+        return false;
+    return s.images.every((img) => isObject(img) && isNonEmptyString(img.url) && isNonEmptyString(img.air));
+}
 /**
  * Reply to a block-initiated `OPEN_IMAGE_UPLOAD`. `selected` is ABSENT when the
  * user dismissed the upload modal (the block's hook resolves to `null`). When
@@ -779,7 +791,8 @@ function isPendingUpload(s) {
  *     value, `url` non-empty).
  *   • `'generationSource'` → the source `{ url, width, height }` (positive finite
  *     dimensions, non-empty url; no imageId/nsfwLevel).
- * The guard accepts EITHER shape (the result carries no purpose discriminator).
+ *   • `'trainingData'` → `{ images: [{ url, air }] }` (non-empty strings).
+ * The guard accepts ANY of the shapes (the result carries no purpose discriminator).
  * Kept in lockstep with the host's `IMAGE_UPLOAD_RESULT` (civitai/civitai
  * `PageBlockHost.tsx` / `BlockImageUploadModal.tsx` /
  * `BlockGenerationSourceUploadModal.tsx`).
@@ -797,13 +810,18 @@ export function isValidImageUploadResult(p) {
     if (p.error !== undefined && typeof p.error !== 'string')
         return false;
     // `selected` absent → cancelled upload (valid). When present, it must match
-    // one of the purpose-keyed shapes (moderated / generationSource / pending).
+    // one of the purpose-keyed shapes (moderated / generationSource / pending /
+    // trainingData).
     if (p.selected !== undefined) {
         const s = p.selected;
         if (!isObject(s))
             return false;
-        if (!isModeratedUpload(s) && !isGenerationSourceUpload(s) && !isPendingUpload(s))
+        if (!isModeratedUpload(s) &&
+            !isGenerationSourceUpload(s) &&
+            !isPendingUpload(s) &&
+            !isTrainingDataUpload(s)) {
             return false;
+        }
     }
     return true;
 }
@@ -1022,6 +1040,80 @@ export function isValidWildcardPackResult(p) {
         return false;
     return true;
 }
+/**
+ * The CLOSED `RESOURCE_FILE_RESULT` error set, mirroring
+ * `BlockResourceFileErrorCode` (civitai/civitai-app-starters#664).
+ */
+const RESOURCE_FILE_ERROR_CODES = new Set([
+    'not-found',
+    'forbidden',
+    'unauthorized',
+    'too-large',
+    'parse-failed',
+    'busy',
+    'rate-limited',
+]);
+const RESOURCE_FILE_ENTRY_FORMATS = new Set(['ui', 'api', 'unknown']);
+/**
+ * Reply to a block-initiated `GET_RESOURCE_FILE`. Same contract shape as
+ * {@link isValidWildcardPackResult}: EITHER a `file` OR an `error` that is one of
+ * {@link RESOURCE_FILE_ERROR_CODES}; a free-text or unknown `error`, or a reply
+ * with neither, is malformed and dropped. The `file` is checked field by field —
+ * `meta` ids positive integers, names strings, `creatorUsername` a string or
+ * `null`, `truncated` a boolean, and EVERY entry an object with a string `path`,
+ * a known `format` and a `graph` key. `graph` itself is the host's parsed JSON
+ * and may be any JSON value.
+ */
+export function isValidResourceFileResult(p) {
+    if (!isObject(p))
+        return false;
+    if (!isWireRequestIdShape(p.requestId))
+        return false;
+    if (p.error !== undefined) {
+        if (typeof p.error !== 'string' || !RESOURCE_FILE_ERROR_CODES.has(p.error))
+            return false;
+    }
+    if (p.file !== undefined) {
+        const file = p.file;
+        if (!isObject(file))
+            return false;
+        const meta = file.meta;
+        if (!isObject(meta))
+            return false;
+        if (!isPositiveInteger(meta.modelId))
+            return false;
+        if (!isPositiveInteger(meta.modelVersionId))
+            return false;
+        if (!isPositiveInteger(meta.fileId))
+            return false;
+        if (typeof meta.fileName !== 'string')
+            return false;
+        if (typeof meta.modelName !== 'string')
+            return false;
+        if (typeof meta.versionName !== 'string')
+            return false;
+        if (meta.creatorUsername !== null && typeof meta.creatorUsername !== 'string')
+            return false;
+        if (typeof file.truncated !== 'boolean')
+            return false;
+        if (!Array.isArray(file.entries))
+            return false;
+        for (const entry of file.entries) {
+            if (!isObject(entry))
+                return false;
+            if (typeof entry.path !== 'string')
+                return false;
+            if (typeof entry.format !== 'string' || !RESOURCE_FILE_ENTRY_FORMATS.has(entry.format)) {
+                return false;
+            }
+            if (!('graph' in entry))
+                return false;
+        }
+    }
+    if (p.file === undefined && p.error === undefined)
+        return false;
+    return true;
+}
 // ============================================================
 // App generator SUBQUEUE reply validators
 // ============================================================
@@ -1533,48 +1625,6 @@ export function isValidCreatePostResult(p) {
         return false;
     return true;
 }
-/**
- * Reply to `PREPARE_TRAINING_DATASET`. A well-formed reply carries EITHER a
- * `result` (`{ datasetId: non-empty string, count: integer ≥ 0, rejected: [{
- * imageId: number, reason: string }] }`) OR an `error`; one with neither is
- * malformed and dropped.
- *
- * 🔴 `error` IS SHAPE-CHECKED ONLY — the same decision as
- * {@link isValidCreatePostResult}: the host's closed codes share the field with
- * any server message it forwards, and a membership check would drop those
- * replies before correlation, leaving the request to its timer.
- *
- * `rejected[].reason` is checked as a STRING, not against today's six members —
- * the host adding a reason must not make every prepare reply that carries it a
- * dropped one (the forward-compatibility rule in {@link isValidWorkflowSnapshot}).
- */
-export function isValidTrainingDatasetResult(p) {
-    if (!isObject(p))
-        return false;
-    if (!isWireRequestIdShape(p.requestId))
-        return false;
-    if (p.error !== undefined && typeof p.error !== 'string')
-        return false;
-    if (p.result !== undefined) {
-        const r = p.result;
-        if (!isObject(r))
-            return false;
-        if (!isNonEmptyString(r.datasetId))
-            return false;
-        if (!Number.isInteger(r.count) || r.count < 0)
-            return false;
-        if (!Array.isArray(r.rejected))
-            return false;
-        for (const x of r.rejected) {
-            if (!isObject(x) || !isFiniteNumber(x.imageId) || typeof x.reason !== 'string') {
-                return false;
-            }
-        }
-    }
-    if (p.result === undefined && p.error === undefined)
-        return false;
-    return true;
-}
 /**
  * Reply to `RUN_TRAINING`. A well-formed reply carries EITHER a `snapshot` (a
  * valid {@link isValidWorkflowSnapshot} — the block polls its `workflowId`) OR an
@@ -2326,6 +2376,8 @@ export function payloadValidatorFor(type) {
             return isValidDailyCompensationResult;
         case 'WILDCARD_PACK_RESULT':
             return isValidWildcardPackResult;
+        case 'RESOURCE_FILE_RESULT':
+            return isValidResourceFileResult;
         case 'APP_WORKFLOWS_RESULT':
             return isValidAppWorkflowsResult;
         case 'CANCEL_APP_WORKFLOW_RESULT':
@@ -2349,8 +2401,6 @@ export function payloadValidatorFor(type) {
         // Same caveat as CREATE_POST_RESULT: presence is compiler-enforced, the
         // identity is pinned by test (`validate.test.ts`). TRAINING_RESULT settles a
         // charged run.
-        case 'TRAINING_DATASET_RESULT':
-            return isValidTrainingDatasetResult;
         case 'TRAINING_RESULT':
             return isValidTrainingResult;
         // Settles a charged job, like TRAINING_RESULT directly above.

package/dist/version.generated.d.ts

@@ -1,3 +1,3 @@
 /** This package's version, reported to the host as `sdkVersion` in `BLOCK_READY`. */
-export declare const VERSION = "0.76.1";
+export declare const VERSION = "0.78.0";
 //# sourceMappingURL=version.generated.d.ts.map

package/dist/version.generated.js

@@ -1,4 +1,4 @@
 /* AUTOGENERATED from package.json by scripts/gen-version.mjs. DO NOT EDIT. */
 /** This package's version, reported to the host as `sdkVersion` in `BLOCK_READY`. */
-export const VERSION = "0.76.1";
+export const VERSION = "0.78.0";
 //# sourceMappingURL=version.generated.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@civitai/blocks-react",
-  "version": "0.76.1",
+  "version": "0.78.0",
   "description": "React hooks and iframe transport for Civitai Apps. Pairs with @civitai/app-sdk/blocks.",
   "license": "MIT",
   "type": "module",
@@ -58,7 +58,7 @@
     "typescript": "^5.9.2",
     "vite": "^8.0.14",
     "vitest": "^4.1.11",
-    "@civitai/app-sdk": "^0.75.0"
+    "@civitai/app-sdk": "^0.79.0"
   },
   "publishConfig": {
     "access": "public"

package/dist/hooks/usePrepareTrainingDataset.d.ts

@@ -1,99 +0,0 @@
-import type { BlockPrepareTrainingDatasetHostError, BlockTrainingDatasetItem, BlockTrainingDatasetResult, BlockTrainingRejectionReason } from '@civitai/app-sdk/blocks';
-import type { ConsentRetryOptions } from './consentRetryOptions.js';
-export type { BlockPrepareTrainingDatasetHostError, BlockTrainingDatasetItem, BlockTrainingDatasetResult, BlockTrainingRejectionReason, };
-/**
- * The host's CLOSED refusal codes for `PREPARE_TRAINING_DATASET`, as a runtime
- * list. Mirrors civitai/civitai's `PREPARE_TRAINING_DATASET_HOST_ERRORS`.
- *
- * 🔴 THE ERROR CHANNEL IS NOT AN ENUM: it also carries free-text server
- * messages, so "is this a code?" is a membership question at runtime — see
- * {@link isPrepareTrainingDatasetErrorCode}.
- */
-export declare const PREPARE_TRAINING_DATASET_ERROR_CODES: readonly ["review-mode", "block is not ready", "sign in to train", "invalid training dataset", "no block token"];
-/** `true` when `error` is one of the host's closed refusal codes rather than a server message. */
-export declare function isPrepareTrainingDatasetErrorCode(error: string): error is BlockPrepareTrainingDatasetHostError;
-/**
- * A dataset-preparation failure.
- *
- * `.code` is the host's refusal code when the HOST refused, `undefined` for a
- * server message or a transport timeout. Check `.timedOut` before rendering
- * `.message` — a timeout's message is an SDK-internal string.
- *
- * Preparing charges nothing, so no failure here costs the viewer Buzz.
- */
-export declare class PrepareTrainingDatasetError extends Error {
-    /** The closed host refusal code, or `undefined` for a server/transport error. */
-    readonly code?: BlockPrepareTrainingDatasetHostError;
-    /**
-     * No reply arrived within the bound. The server may still have prepared a
-     * dataset; nothing was charged either way, and preparing again simply makes a
-     * new handle.
-     */
-    readonly timedOut: boolean;
-    /**
-     * There is no session — the viewer is signed out (`sign in to train`), or their
-     * session ended (a bare `UNAUTHORIZED`). Route into `useRequestSignIn()`.
-     */
-    readonly signInRequired: boolean;
-    constructor(error: string, opts?: {
-        timedOut?: boolean;
-    });
-}
-/** What {@link usePrepareTrainingDataset} returns. */
-export interface UsePrepareTrainingDataset {
-    /**
-     * Ask the host to prepare a training dataset from the viewer's OWN images.
-     * Resolves with the opaque `datasetId`, the admitted `count` and the
-     * `rejected` images. REJECTS with a {@link PrepareTrainingDatasetError}.
-     *
-     * A resolved result admitted AT LEAST ONE image (`count >= 1`) — when nothing
-     * is admitted the server refuses instead, and this rejects with its message
-     * (`none of the requested images can be used for training` / `… could be
-     * prepared for training`, no `.code`). Read `rejected` for what was left out:
-     * `pending-scan` and `import-unavailable` are retryable; the rest are not.
-     * The per-image reasons are not available when everything was rejected.
-     */
-    prepareDataset: (items: BlockTrainingDatasetItem[], options?: ConsentRetryOptions) => Promise<BlockTrainingDatasetResult>;
-    /** `true` while a request is in flight. */
-    pending: boolean;
-    /** The last request's failure, or `null`. Cleared at the start of the next call. */
-    error: PrepareTrainingDatasetError | null;
-}
-/**
- * Step 1 of the App Blocks `kind: 'training'` flow: turn the viewer's own images
- * and your captions into a dataset handle for `WorkflowBodyTraining.datasetId`,
- * through the host-mediated `PREPARE_TRAINING_DATASET` → `TRAINING_DATASET_RESULT`
- * bridge.
- *
- * 🔴 AVAILABILITY: page apps only, behind the host flag `app-blocks-training-kind`
- * (ships off), with `ai:write:budgeted` declared in the manifest and granted by a
- * signed-in viewer. Refused from `dev:live` and from review sessions — build the
- * flow against the mock host. See `WorkflowBodyTraining` in `@civitai/app-sdk`.
- *
- * Only the viewer's OWN scanned, unflagged images within the page's maturity
- * ceiling are admitted; captions are moderated. Bounds: 1–50 items, captions up
- * to 1,000 characters (`BLOCK_TRAINING_DATASET_MAX_ITEMS`,
- * `BLOCK_TRAINING_CAPTION_MAX_CHARS`); the host refuses anything else with
- * `invalid training dataset` before calling the server.
- *
- * No dialog and no charge. When the token lacks `ai:write:budgeted`, the call
- * opens the host's consent prompt and retries once on a grant (opt out with
- * `{ autoRequestConsent: false }`).
- *
- * Sent under the 120s server-work bound, not the 30s protocol default: the server
- * imports up to 50 images into the orchestrator within its own 60s budget.
- *
- * @example
- * const { prepareDataset } = usePrepareTrainingDataset();
- * try {
- *   const dataset = await prepareDataset(
- *     picked.map((img) => ({ imageId: img.id, caption: img.caption })),
- *   );
- *   if (dataset.rejected.length > 0) showNotice(`${dataset.rejected.length} image(s) left out`);
- * } catch (e) {
- *   // Includes "none of the requested images can be used for training".
- *   if (e instanceof PrepareTrainingDatasetError) showError(e.message);
- * }
- */
-export declare function usePrepareTrainingDataset(): UsePrepareTrainingDataset;
-//# sourceMappingURL=usePrepareTrainingDataset.d.ts.map

package/dist/hooks/usePrepareTrainingDataset.js

@@ -1,159 +0,0 @@
-import { useCallback, useEffect, useRef, useState } from 'react';
-import { BLOCK_SCOPES } from '@civitai/app-sdk/blocks';
-import { withConsentRetry } from '../internal/withConsentRetry.js';
-import { WORKFLOW_REQUEST_TIMEOUT_MS } from '../transport/requestTimeouts.js';
-import { getTransport } from '../transport/singleton.js';
-import { RequestTimeoutError, sendTypedRequest } from '../transport/transport.js';
-import { useTransportConnection } from './useTransportConnection.js';
-/**
- * The consent-gated scope the training flow requires — `ai:write:budgeted`. The
- * server refuses a dataset request from a token without it (it is the spend
- * scope, and preparing is gated exactly like the run it prepares for). From
- * {@link BLOCK_SCOPES}, never a literal: a typo would make the automatic consent
- * prompt silently do nothing.
- */
-const TRAINING_SCOPES = [BLOCK_SCOPES.AI_WRITE_BUDGETED];
-/**
- * The host's CLOSED refusal codes for `PREPARE_TRAINING_DATASET`, as a runtime
- * list. Mirrors civitai/civitai's `PREPARE_TRAINING_DATASET_HOST_ERRORS`.
- *
- * 🔴 THE ERROR CHANNEL IS NOT AN ENUM: it also carries free-text server
- * messages, so "is this a code?" is a membership question at runtime — see
- * {@link isPrepareTrainingDatasetErrorCode}.
- */
-export const PREPARE_TRAINING_DATASET_ERROR_CODES = [
-    'review-mode',
-    'block is not ready',
-    'sign in to train',
-    'invalid training dataset',
-    'no block token',
-];
-const CODE_SET = new Set(PREPARE_TRAINING_DATASET_ERROR_CODES);
-/** `true` when `error` is one of the host's closed refusal codes rather than a server message. */
-export function isPrepareTrainingDatasetErrorCode(error) {
-    return CODE_SET.has(error);
-}
-/**
- * A dataset-preparation failure.
- *
- * `.code` is the host's refusal code when the HOST refused, `undefined` for a
- * server message or a transport timeout. Check `.timedOut` before rendering
- * `.message` — a timeout's message is an SDK-internal string.
- *
- * Preparing charges nothing, so no failure here costs the viewer Buzz.
- */
-export class PrepareTrainingDatasetError extends Error {
-    /** The closed host refusal code, or `undefined` for a server/transport error. */
-    code;
-    /**
-     * No reply arrived within the bound. The server may still have prepared a
-     * dataset; nothing was charged either way, and preparing again simply makes a
-     * new handle.
-     */
-    timedOut;
-    /**
-     * There is no session — the viewer is signed out (`sign in to train`), or their
-     * session ended (a bare `UNAUTHORIZED`). Route into `useRequestSignIn()`.
-     */
-    signInRequired;
-    constructor(error, opts) {
-        super(error);
-        this.name = 'PrepareTrainingDatasetError';
-        this.timedOut = opts?.timedOut === true;
-        if (isPrepareTrainingDatasetErrorCode(error))
-            this.code = error;
-        this.signInRequired = error === 'sign in to train' || error === 'UNAUTHORIZED';
-    }
-}
-/**
- * Step 1 of the App Blocks `kind: 'training'` flow: turn the viewer's own images
- * and your captions into a dataset handle for `WorkflowBodyTraining.datasetId`,
- * through the host-mediated `PREPARE_TRAINING_DATASET` → `TRAINING_DATASET_RESULT`
- * bridge.
- *
- * 🔴 AVAILABILITY: page apps only, behind the host flag `app-blocks-training-kind`
- * (ships off), with `ai:write:budgeted` declared in the manifest and granted by a
- * signed-in viewer. Refused from `dev:live` and from review sessions — build the
- * flow against the mock host. See `WorkflowBodyTraining` in `@civitai/app-sdk`.
- *
- * Only the viewer's OWN scanned, unflagged images within the page's maturity
- * ceiling are admitted; captions are moderated. Bounds: 1–50 items, captions up
- * to 1,000 characters (`BLOCK_TRAINING_DATASET_MAX_ITEMS`,
- * `BLOCK_TRAINING_CAPTION_MAX_CHARS`); the host refuses anything else with
- * `invalid training dataset` before calling the server.
- *
- * No dialog and no charge. When the token lacks `ai:write:budgeted`, the call
- * opens the host's consent prompt and retries once on a grant (opt out with
- * `{ autoRequestConsent: false }`).
- *
- * Sent under the 120s server-work bound, not the 30s protocol default: the server
- * imports up to 50 images into the orchestrator within its own 60s budget.
- *
- * @example
- * const { prepareDataset } = usePrepareTrainingDataset();
- * try {
- *   const dataset = await prepareDataset(
- *     picked.map((img) => ({ imageId: img.id, caption: img.caption })),
- *   );
- *   if (dataset.rejected.length > 0) showNotice(`${dataset.rejected.length} image(s) left out`);
- * } catch (e) {
- *   // Includes "none of the requested images can be used for training".
- *   if (e instanceof PrepareTrainingDatasetError) showError(e.message);
- * }
- */
-export function usePrepareTrainingDataset() {
-    useTransportConnection();
-    const [pending, setPending] = useState(false);
-    const [error, setError] = useState(null);
-    // The consent wait can outlive the component; see `useCreatePostFromApp`.
-    const mountedRef = useRef(true);
-    useEffect(() => {
-        mountedRef.current = true;
-        return () => {
-            mountedRef.current = false;
-        };
-    }, []);
-    /** ONE round-trip + its result contract. Re-invoked verbatim on a consent retry. */
-    const prepareOnce = useCallback(async (items) => {
-        const reply = await sendTypedRequest(getTransport(), { type: 'PREPARE_TRAINING_DATASET', payload: { items } }, 'TRAINING_DATASET_RESULT', { timeoutMs: WORKFLOW_REQUEST_TIMEOUT_MS }).catch((err) => {
-            // Stamped INSIDE the closure `withConsentRetry` re-invokes, so its rule 4
-            // sees it: a 120s wait is not repeated behind a consent prompt.
-            if (err instanceof RequestTimeoutError) {
-                throw new PrepareTrainingDatasetError(err.message, { timedOut: true });
-            }
-            throw err instanceof Error ? err : new Error(String(err));
-        });
-        if (reply.error || !reply.result) {
-            // `||`, not `??`: the validator shape-checks `error`, so `''` is a valid
-            // reply that must not become an Error with an empty message. The
-            // fallback is deliberately NOT a host code — `invalid training dataset`
-            // would claim "nothing reached the server", which an empty error does
-            // not tell us.
-            throw new PrepareTrainingDatasetError(reply.error || 'training dataset could not be prepared');
-        }
-        return reply.result;
-    }, []);
-    const prepareDataset = useCallback(async (items, options) => {
-        if (mountedRef.current) {
-            setPending(true);
-            setError(null);
-        }
-        try {
-            return await withConsentRetry(getTransport(), TRAINING_SCOPES, () => prepareOnce(items), options, () => mountedRef.current);
-        }
-        catch (err) {
-            const wrapped = err instanceof PrepareTrainingDatasetError
-                ? err
-                : new PrepareTrainingDatasetError(err instanceof Error ? err.message : String(err));
-            if (mountedRef.current)
-                setError(wrapped);
-            throw wrapped;
-        }
-        finally {
-            if (mountedRef.current)
-                setPending(false);
-        }
-    }, [prepareOnce]);
-    return { prepareDataset, pending, error };
-}
-//# sourceMappingURL=usePrepareTrainingDataset.js.map