@civitai/sdk 0.15.0 → 0.16.0

package/README.md

@@ -274,7 +274,12 @@ Anonymous viewers may read `shared` collections and nothing else
 (`sign_in_required`). Creating or editing a document in a viewer-written shared
 collection needs the consent-gated `apps:storage:publish`; deleting your own, marks
 and counters need only `apps:storage`. Shared writes pass a minimum-trust gate and
-moderation. Only phase-one operations exist: no batch writes, change feed, TTL or
+moderation. A shared `write: "own"` collection whose manifest declares
+`ownedModelVersions` (pointers such as `/workflow/modelVersionId`) refuses a create
+or `put` whose `data` holds, at one of those fields, anything but a model version
+the viewer owns: `resource_not_owned` (403), `details.pointer` naming the field,
+before moderation and before any write budget. An absent field is allowed;
+ownership is checked only when the document is written. Only phase-one operations exist: no batch writes, change feed, TTL or
 owner-written documents yet.
 
 The legacy stores below keep working, unchanged, while apps move; their methods are
@@ -974,6 +979,13 @@ Where it differs from the server on purpose:
   not a manifest validator otherwise; `civitai app validate` is.
 - A list `nextCursor` is an opaque token, refused for any other collection, sort or
   filter than the query that issued it. Treat it as opaque against the server too.
+- It has no model versions of its own, so a collection's `ownedModelVersions` rule
+  checks writes against the viewer's `modelVersions` — the ids that viewer owns,
+  none by default (so every id is refused, as the server refuses one that is not
+  the writer's):
+  `fake.as({ viewer: { username: 'bob', modelVersions: [4317] } })`. It does not
+  model the server's ownership lookup failing (a retryable 503
+  `service_unavailable`).
 
 `fake.calls` records every request and answer. Options also cover smaller `limits`,
 `consent` (revoked scopes, or `'unavailable'`), `appStatus`, `disabled` and a custom

package/dist/doc-store/fake.d.ts

@@ -25,6 +25,13 @@ export interface FakeStorageViewer {
     trusted?: boolean;
     /** `details.reason` when untrusted. Default `account_too_new`. */
     untrustedReason?: string;
+    /**
+     * Ids of the model versions whose model this viewer owns — what a collection's
+     * `ownedModelVersions` rule checks a write against. Default: none, so every id
+     * at a declared field is refused `resource_not_owned`, as the server refuses a
+     * version that is not the writer's (or does not exist).
+     */
+    modelVersions?: readonly number[];
 }
 /** Who is calling: a viewer (or `null`, anonymous) holding a token of some kind and scopes. */
 export interface FakeStorageCaller {

package/dist/doc-store/fake.js

@@ -18,10 +18,15 @@ import { createDocumentStorage } from './index.js';
  * the fake is CREATED rather than per request; and a list cursor is an opaque token
  * bound to its whole query, not the server's sort-bound keyset string.
  *
+ * A collection's `ownedModelVersions` rule is enforced; the fake has no model
+ * versions of its own, so which ones a viewer owns is `FakeStorageViewer.modelVersions`
+ * (default none).
+ *
  * NOT MODELLED: moderator hides (a hidden document reads as not found on the server;
  * nothing here hides one), moderator exemption from the scanner, the review-preview
- * namespace, and the token middleware's other refusals (revoked instance, context
- * binding, an approval read that fails).
+ * namespace, the token middleware's other refusals (revoked instance, context
+ * binding, an approval read that fails), and a failed ownership lookup (the
+ * server's retryable 503 `service_unavailable`).
  */
 // ---------------------------------------------------------------------------
 // Bounds — the server's, one copy here (the contract run pins the ones it reaches)
@@ -85,6 +90,7 @@ const STATUS = {
     not_eligible: 403,
     not_author: 403,
     write_policy: 403,
+    resource_not_owned: 403,
     not_found: 404,
     collection_not_declared: 404,
     method_not_allowed: 405,
@@ -97,6 +103,11 @@ const STATUS = {
     moderation_unavailable: 503,
     consent_unavailable: 503,
 };
+/** The manifest's `ownedModelVersions` pointer: 1 to 4 plain identifier segments. */
+const OWNED_POINTER = /^(\/[A-Za-z_][A-Za-z0-9_]{0,63}){1,4}$/u;
+const MAX_OWNED_POINTERS = 4;
+/** Postgres `integer`: the server refuses a larger id before querying for it. */
+const INT4_MAX = 2_147_483_647;
 const isObject = (v) => typeof v === 'object' && v !== null && !Array.isArray(v);
 /** Declarations the platform does not serve yet, each with what to do instead. */
 const PHASED = [
@@ -144,12 +155,30 @@ function parseManifest(manifest) {
             else
                 errors.push(`${at}.indexes.${path}: type must be one of ${INDEX_TYPES.join(', ')}`);
         }
+        const ownedModelVersions = [];
+        if (raw.ownedModelVersions !== undefined) {
+            const list = raw.ownedModelVersions;
+            if (!shared || raw.write !== 'own') {
+                errors.push(`${at}.ownedModelVersions: applies only to shared collections with write "own"`);
+            }
+            else if (!Array.isArray(list) ||
+                list.length < 1 ||
+                list.length > MAX_OWNED_POINTERS ||
+                !list.every((p) => typeof p === 'string' && OWNED_POINTER.test(p)) ||
+                new Set(list).size !== list.length) {
+                errors.push(`${at}.ownedModelVersions: must be 1 to ${MAX_OWNED_POINTERS} distinct pointers such as "/workflow/modelVersionId"`);
+            }
+            else {
+                ownedModelVersions.push(...list);
+            }
+        }
         const decl = {
             visibility: raw.visibility,
             counters: shared ? names(raw.counters) : [],
             marks: shared ? names(raw.marks) : [],
             indexes,
             showAuthor: shared && raw.showAuthor === true,
+            ownedModelVersions,
         };
         if (shared && (raw.write === 'own' || raw.write === 'none'))
             decl.write = raw.write;
@@ -893,6 +922,41 @@ export function createFakeStorage(options) {
             });
         }
     }
+    /**
+     * The collection's `ownedModelVersions` rule, as the server's
+     * `doc-store-ownership.ts` applies it: a pointer that resolves to nothing is
+     * allowed; every value found must be a positive `integer` id — all of them are
+     * checked before any ownership — and then the writer's own version. One code
+     * and message for every reason, so a refusal reveals nothing about whether a
+     * version exists.
+     */
+    function assertOwnedModelVersions(decl, data, viewer) {
+        if (decl.ownedModelVersions.length === 0)
+            return;
+        const notOwned = (pointer) => refuse('resource_not_owned', 'the model version at this field is not one the author owns', { pointer });
+        const claimed = [];
+        for (const pointer of decl.ownedModelVersions) {
+            let cur = data;
+            let found = true;
+            for (const seg of pointer.split('/').slice(1)) {
+                if (!isObject(cur) || !Object.prototype.hasOwnProperty.call(cur, seg)) {
+                    found = false;
+                    break;
+                }
+                cur = cur[seg];
+            }
+            if (!found)
+                continue;
+            if (typeof cur !== 'number' || !Number.isInteger(cur) || cur < 1 || cur > INT4_MAX)
+                throw notOwned(pointer);
+            claimed.push({ pointer, id: cur });
+        }
+        const owned = new Set(viewer.modelVersions ?? []);
+        for (const { pointer, id } of claimed) {
+            if (!owned.has(id))
+                throw notOwned(pointer);
+        }
+    }
     /** The server's refusals that are ITS fault: refunded without a rejection charge. */
     const isOurFault = (err) => !(err instanceof Refusal) ||
         (err.code === 'rate_limited' ? err.details?.reason === 'contention' : ['storage_disabled', 'moderation_unavailable', 'consent_unavailable'].includes(err.code));
@@ -1032,6 +1096,11 @@ export function createFakeStorage(options) {
                         throw invalid('ifVersion must be a non-negative integer');
                     deleteVersion = Number(raw);
                 }
+                // Every write that sets `data`, before the trust gate, the write budget and the
+                // moderation scan (and so before the store's own checks), as the server orders it.
+                const newData = created?.data ?? putIn?.data;
+                if (newData)
+                    assertOwnedModelVersions(decl, newData, viewer);
                 const write = (moderated, landed) => {
                     if (created) {
                         if (moderated)

package/dist/doc-store/index.d.ts

@@ -171,7 +171,7 @@ export interface DocumentStorage {
  * Every code the server documents for these routes. The type stays open
  * (`string & {}`) so a code a later server adds still reaches the caller.
  */
-export type StorageErrorCode = 'invalid_request' | 'index_not_declared' | 'unauthenticated' | 'sign_in_required' | 'insufficient_scope' | 'consent_required' | 'not_eligible' | 'not_author' | 'write_policy' | 'not_found' | 'collection_not_declared' | 'method_not_allowed' | 'version_conflict' | 'index_building' | 'cursor_expired' | 'too_large' | 'quota_exceeded' | 'content_rejected' | 'rate_limited' | 'internal_error' | 'storage_disabled' | 'moderation_unavailable' | 'consent_unavailable' | 'service_unavailable' | (string & {});
+export type StorageErrorCode = 'invalid_request' | 'index_not_declared' | 'unauthenticated' | 'sign_in_required' | 'insufficient_scope' | 'consent_required' | 'not_eligible' | 'not_author' | 'write_policy' | 'resource_not_owned' | 'not_found' | 'collection_not_declared' | 'method_not_allowed' | 'version_conflict' | 'index_building' | 'cursor_expired' | 'too_large' | 'quota_exceeded' | 'content_rejected' | 'rate_limited' | 'internal_error' | 'storage_disabled' | 'moderation_unavailable' | 'consent_unavailable' | 'service_unavailable' | (string & {});
 /**
  * A refusal from the document store, in its one envelope `{ code, message, error, details? }`.
  * Branch on `code`; `status` and `body` are {@link ApiError}'s, as sent.

package/dist/version.generated.d.ts

@@ -1,2 +1,2 @@
 /** This package's version, reported to the host as `sdkVersion` in `BLOCK_READY`. */
-export declare const VERSION = "0.15.0";
+export declare const VERSION = "0.16.0";

package/dist/version.generated.js

@@ -1,3 +1,3 @@
 /* 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.15.0";
+export const VERSION = "0.16.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@civitai/sdk",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "The Civitai SDK: an app holds a token and calls the Civitai API and the orchestrator; a block asks its host only to show host UI.",
   "license": "MIT",
   "type": "module",