@civitai/app-sdk 0.71.0 → 0.73.0

package/dist/blocks/messages.d.ts

@@ -938,6 +938,25 @@ export type BlockToParentMessage = {
         multiple?: {
             max: number;
         };
+        /**
+         * Offer only images in a published, non-`Private` post: `true`
+         * narrows the `'posted'` library to those. It does not filter by
+         * rating or by any other post setting. The `'generated'` library is
+         * unaffected. OMIT it (or `false`) for today's behaviour, which also
+         * offers images in a `Private` post. Send a boolean or nothing: the
+         * host refuses any other value with `{ requestId, error }`.
+         *
+         * Set it when the pick becomes PUBLIC-FACING, e.g. an App Store
+         * sub-listing card image (`imageId` on
+         * `POST /api/v1/blocks/sub-listings/upsert`, `app.subListings.upsert`
+         * in `@civitai/sdk`), which the store refuses for a non-public image.
+         * Leave it off when the pick is a private input (a generation source).
+         *
+         * 🔴 A HOST THAT PREDATES THIS FIELD IGNORES IT and still offers
+         * `Private`-post images, so an app setting it must still handle the
+         * store's `image_not_public` refusal.
+         */
+        publicOnly?: boolean;
     };
 } | {
     type: 'SET_USER_CHECKPOINT';

package/dist/blocks/scopes.d.ts

@@ -29,6 +29,7 @@ export declare const BLOCK_SCOPES: {
     readonly GOODS_READ_SELF: "goods:read:self";
     readonly GOODS_PURCHASE_SELF: "goods:purchase:self";
     readonly APPS_STORE_ITEMS_WRITE: "apps:store:items:write";
+    readonly SOCIAL_REACT_SELF: "social:react:self";
 };
 export type BlockScopeKey = keyof typeof BLOCK_SCOPES;
 export type BlockScope = (typeof BLOCK_SCOPES)[BlockScopeKey];

package/dist/blocks/scopes.js

@@ -90,6 +90,13 @@ export const BLOCK_SCOPES = {
     // Requires a signed-in (non-anonymous) subject. 4-segment, like the shared
     // storage scopes — see BLOCK_SCOPE_PATTERN below.
     APPS_STORE_ITEMS_WRITE: 'apps:store:items:write',
+    // social:react:self — set the VIEWER'S reaction on an image a block endpoint
+    // served the app (civitai/civitai#6144). SENSITIVE (a public, reward-paying
+    // reaction under the viewer's name, so a declaring manifest MUST carry a
+    // `scopeJustifications` entry) and CONSENT-GATED. Listed here because the
+    // canonical schema's `scopes` enum carries it; the server ships the feature
+    // behind a dark flag, and this package has no reaction helper yet.
+    SOCIAL_REACT_SELF: 'social:react:self',
 };
 /**
  * Format helper for the block-scope shape — 2, 3 OR 4 colon-separated

package/dist/blocks/types.d.ts

@@ -304,6 +304,11 @@ export type BlockGenerationSourceImageInfo = BlockSourceImage;
  *
  * The request's `sources` narrows the picker to one of them; omitting it offers
  * both. Images only — neither library offers video through this picker.
+ *
+ * The request's `publicOnly: true` further narrows `'posted'` to images whose
+ * post is published and not `Private` (for a public-facing pick such as an App
+ * Store sub-listing card image); it does not change `'generated'`. A host that
+ * predates `publicOnly` ignores it.
  */
 export type BlockImagePickerSource = 'posted' | 'generated';
 /**
@@ -314,7 +319,8 @@ export type BlockImagePickerSource = 'posted' | 'generated';
  *
  * WHAT IS PICKABLE is decided by the host, never by the block:
  *  - `'posted'`: the viewer's own images that are in a published post, fully
- *    scanned, not flagged, and rated.
+ *    scanned, not flagged, and rated. A `Private` post counts as published
+ *    here unless the request set `publicOnly: true`, which leaves those out.
  *  - `'generated'`: the viewer's own succeeded generator outputs that carry a
  *    rating the host recognises.
  *  - Either way the image's rating has to be one the VIEWER'S OWN browsing
@@ -2567,7 +2573,8 @@ export interface BlockStorageIndexes {
 /**
  * A PRIVATE collection — a separate key space per viewer, read and written
  * only by that viewer. Carries none of the shared-only fields (`write`,
- * `counters`, `marks`, `showAuthor`, `dailyWritesPerAuthor`); the canonical
+ * `counters`, `marks`, `showAuthor`, `dailyWritesPerAuthor`,
+ * `ownedModelVersions`); the canonical
  * forbids them here. See {@link BlockStorageSharedCollectionDeclaration} for
  * the fields both kinds share.
  */
@@ -2650,6 +2657,32 @@ export interface BlockStorageSharedCollectionDeclaration {
      * collection viewers write (`write` `'own'` or `'anyone'` only).
      */
     dailyWritesPerAuthor?: number;
+    /**
+     * `write` `'own'` collections only — the canonical refuses it under
+     * `'anyone'`, `'owner'` and `'none'`, and on private collections. Fields of a
+     * document's `data` that, when present, must hold the id of a Civitai model
+     * version owned by the viewer writing the document — for example
+     * `['/workflow/modelVersionId']` for a collection where viewers publish their
+     * own workflows.
+     *
+     * 1 to 4 distinct pointers, each 1 to 4 segments of `/` then a letter or `_`
+     * followed by up to 63 letters, digits or `_` (pattern
+     * `^(/[A-Za-z_][A-Za-z0-9_]{0,63}){1,4}$`). A pointer names one field of
+     * nested objects: it never indexes into an array, and a step through an
+     * array or any other non-object finds nothing.
+     *
+     * On every create and update the server resolves each pointer in the new
+     * `data`. An absent field is allowed. A present one must be a positive
+     * integer naming a model version whose model the writer owns; anything else
+     * — someone else's version, a missing or deleted one, a value that is not a
+     * positive integer — is refused 403 `resource_not_owned`, with
+     * `details.pointer` naming the field, before moderation and before any
+     * write budget is spent. If the ownership lookup itself fails, the write is
+     * refused 503 `service_unavailable` (retryable). Ownership is checked only
+     * when a document is written: documents already stored keep the id if the
+     * model later changes hands or is deleted.
+     */
+    ownedModelVersions?: string[];
 }
 /**
  * One collection declaration — see {@link BlockManifestV1.storage}.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@civitai/app-sdk",
-  "version": "0.71.0",
+  "version": "0.73.0",
   "description": "OAuth + PKCE, encrypted-cookie sessions, scopes, and orchestrator helpers for building third-party Civitai apps.",
   "license": "MIT",
   "type": "module",

package/schemas/app-block/v1.json

@@ -104,13 +104,14 @@
           "posts:write:self",
           "goods:read:self",
           "goods:purchase:self",
-          "apps:store:items:write"
+          "apps:store:items:write",
+          "social:react:self"
         ]
       }
     },
     "scopeJustifications": {
       "type": "object",
-      "description": "Per-scope justification: a map of scope-id → free-text rationale explaining WHY the app needs that permission, shown to the moderator during review. REQUIRED for SENSITIVE scopes — any declared scope that can spend or read the viewer's Buzz, read the viewer's private data, or write data other users see (e.g. `ai:write:budgeted`, `social:tip:self`, `goods:purchase:self`, `buzz:read:self`, `collections:read:private`, `apps:storage:shared:write`, `apps:storage:publish`, `posts:write:self`, `apps:store:items:write`) MUST carry a non-empty justification here, or the manifest is rejected at submit time. OPTIONAL for non-sensitive scopes — omit those and the manifest stays valid. Every key MUST be a scope also present in `scopes` (justifications for scopes you don't request are rejected). Each value is a non-empty string of at most 500 characters. The requirement is enforced imperatively by the manifest validator (not expressed as JSON-Schema conditionals here). NOTE: the justification captures the developer's STATED rationale only; the platform does not verify the truth of the claims.",
+      "description": "Per-scope justification: a map of scope-id → free-text rationale explaining WHY the app needs that permission, shown to the moderator during review. REQUIRED for SENSITIVE scopes — any declared scope that can spend or read the viewer's Buzz, read the viewer's private data, or write data other users see (e.g. `ai:write:budgeted`, `social:tip:self`, `goods:purchase:self`, `buzz:read:self`, `collections:read:private`, `apps:storage:shared:write`, `apps:storage:publish`, `posts:write:self`, `apps:store:items:write`, `social:react:self`) MUST carry a non-empty justification here, or the manifest is rejected at submit time. OPTIONAL for non-sensitive scopes — omit those and the manifest stays valid. Every key MUST be a scope also present in `scopes` (justifications for scopes you don't request are rejected). Each value is a non-empty string of at most 500 characters. The requirement is enforced imperatively by the manifest validator (not expressed as JSON-Schema conditionals here). NOTE: the justification captures the developer's STATED rationale only; the platform does not verify the truth of the claims.",
       "additionalProperties": {
         "type": "string",
         "minLength": 1,
@@ -468,6 +469,17 @@
                   "description": "RESERVED — civitai.com refuses this field until per-collection write budgets are enabled, so do not declare it yet. Intended meaning: for a shared collection that viewers write (`write` \"own\" or \"anyone\"; refused with \"owner\" or \"none\"), the per-viewer daily budget for creating and updating documents in this collection in place of the platform default, from 1 to 1000, shown to the moderator at review. The bounds are provisional and may change before the field is enabled.",
                   "minimum": 1,
                   "maximum": 1000
+                },
+                "ownedModelVersions": {
+                  "type": "array",
+                  "description": "Shared collections with `write` \"own\" only. Fields of a document's `data` that, when present, must hold a Civitai model version id owned by the viewer writing the document — for example [\"/workflow/modelVersionId\"] for a collection where viewers publish their own workflows. Each entry is a pointer of 1 to 4 segments, each \"/\" then a letter or _ followed by up to 63 letters, digits or _; 1 to 4 distinct pointers. A pointer names one field of nested objects: it never indexes into an array, and a step through an array or any other non-object finds nothing. On every create and update the server resolves each pointer in the new `data`: a field that is absent is allowed; a field that is present must be a positive integer naming a model version whose model the writer owns, and is otherwise refused with 403 `resource_not_owned` — a version that is someone else's, missing or deleted, and a value that is not a positive integer, are all refused the same way. The check runs before moderation and before any write budget is spent. Ownership is checked when a document is written, not afterwards: if the model later changes hands or is deleted, documents already stored keep the id.",
+                  "minItems": 1,
+                  "maxItems": 4,
+                  "uniqueItems": true,
+                  "items": {
+                    "type": "string",
+                    "pattern": "^(/[A-Za-z_][A-Za-z0-9_]{0,63}){1,4}$"
+                  }
                 }
               },
               "allOf": [
@@ -484,7 +496,8 @@
                       "counters": false,
                       "marks": false,
                       "showAuthor": false,
-                      "dailyWritesPerAuthor": false
+                      "dailyWritesPerAuthor": false,
+                      "ownedModelVersions": false
                     }
                   }
                 },
@@ -504,6 +517,14 @@
                   },
                   "then": { "properties": { "dailyWritesPerAuthor": false } }
                 },
+                {
+                  "$comment": "ownedModelVersions checks the version against the viewer WRITING the document, so it is declared only where that viewer is always the author: shared collections with write:\"own\" (private collections are refused above).",
+                  "if": {
+                    "required": ["write"],
+                    "properties": { "write": { "enum": ["anyone", "owner", "none"] } }
+                  },
+                  "then": { "properties": { "ownedModelVersions": false } }
+                },
                 {
                   "$comment": "A write:\"none\" collection is written only through counters and marks, so it must declare at least one.",
                   "if": {