rivet-design 0.26.1 → 0.26.2

package/dist/services/profiles/DesignProfiles.d.ts

@@ -5,7 +5,7 @@ import { IntegrationsClient } from '../IntegrationsClient';
 import { type ProfileContext as RecordedContext } from '../../types/design-profile';
 import type { TelemetryService } from '../TelemetryService';
 import { type GuidanceUpload, type GuidanceUploadUpdate, type GuidanceSelection } from '../../types/guidance';
-import type { DesignLibrarySnapshot, DesignLibrarySource, DesignReferenceRequest, DesignReferenceSearchRequest, DesignReferenceSearchResult } from '../../types/design-library';
+import type { DesignLibrarySnapshot, DesignReferenceRequest, DesignReferenceSearchRequest, DesignReferenceSearchResult } from '../../types/design-library';
 import { type ReferencePlanRequest, type ReferenceOnboardingAction } from '../../types/reference-onboarding';
 import { ProfileVariants } from './ProfileVariants';
 import { type ProfileVariantInput, type ProfileRuntime, type ProfilePreparationRequest as PreparationInput } from '../../types/design-profile';
@@ -93,10 +93,10 @@ export declare class DesignProfiles {
             revision: string;
             discoveryId: string;
             profile: {
-                url: string;
-                title: string;
                 id: string;
                 username: string;
+                title: string;
+                url: string;
             };
             provider: "pinterest" | "arena" | "cosmos" | "x";
             runtime: "claude" | "codex" | "cursor";
@@ -107,13 +107,13 @@ export declare class DesignProfiles {
             collections: {
                 includedCollectionIds: string[];
                 referenceCount: number;
+                id: string;
+                title: string;
                 description: string | null;
                 url: string | null;
-                title: string;
-                id: string;
-                children: string[];
                 total: number | null;
                 parentId: string | null;
+                children: string[];
             }[];
             collectionCount: number;
             referenceCount: number;
@@ -142,30 +142,29 @@ export declare class DesignProfiles {
                 isStale: boolean;
             } | undefined;
             sourceDigest: string;
-            title: string;
             id: string;
+            title: string;
             markdown: string;
             isEnabled: boolean;
             attachments?: {
-                path: string;
-                source: string;
                 hash: string;
                 mimeType: "image/png" | "image/jpeg" | "image/webp" | "image/gif";
                 bytes: number;
                 representation: "variant" | "image" | "video-cover" | "page";
+                source: string;
                 alt: string;
-                title?: string | undefined;
+                path: string;
                 page?: number | undefined;
+                title?: string | undefined;
             }[] | undefined;
             references?: ({
-                path: string;
                 kind: "directory";
+                path: string;
                 intent: string;
             } | {
-                url: string;
                 kind: "url" | "repository";
+                url: string;
                 intent: string;
-                digest?: string | undefined;
                 revision?: string | undefined;
                 files?: {
                     name: string;
@@ -173,6 +172,7 @@ export declare class DesignProfiles {
                     path?: string | undefined;
                     sha256?: string | undefined;
                 }[] | undefined;
+                digest?: string | undefined;
             })[] | undefined;
         }[];
         references: {
@@ -206,17 +206,22 @@ export declare class DesignProfiles {
             analyzed: number;
             indexed: number;
         };
-        results: Array<{
+        results: {
             id: string;
             key: string;
             title: string;
-            provider: import("../../types/design-profile").ProfileProvider;
-            url?: string;
+            provider: "variant" | "text" | "pinterest" | "arena" | "cosmos" | "x" | "image" | "pdf";
             description: string | null;
             imageCount: number;
-            sources: DesignLibrarySource[];
+            sources: {
+                id: string;
+                title: string;
+                provider: "variant" | "text" | "pinterest" | "arena" | "cosmos" | "x" | "image" | "pdf";
+                isIncluded: boolean;
+            }[];
             isIncluded: boolean;
-        }>;
+            url?: string | undefined;
+        }[];
     }>;
     saveReference(input: SavedReferenceInput): Promise<{
         analysis: "not_requested";
@@ -230,7 +235,32 @@ export declare class DesignProfiles {
             isIncluded: boolean;
             removedAt: string | null;
         };
-        references: import("../../types/design-profile").ProfileReference[];
+        references: {
+            provider: "variant" | "text" | "pinterest" | "arena" | "cosmos" | "x" | "image" | "pdf";
+            remoteId: string;
+            title: string;
+            text: string;
+            media: {
+                hash: string;
+                mimeType: "image/png" | "image/jpeg" | "image/webp" | "image/gif";
+                bytes: number;
+                representation: "variant" | "image" | "video-cover" | "page";
+                page?: number | undefined;
+            }[];
+            id: string;
+            revision: number;
+            url?: string | undefined;
+            remoteImages?: string[] | undefined;
+            remoteImageRepresentations?: ("image" | "video-cover")[] | undefined;
+            unsupportedReason?: string | undefined;
+            variant?: {
+                projectId: string;
+                sessionId: string;
+                variantId: string;
+                treeSha?: string | undefined;
+            } | undefined;
+            note?: string | undefined;
+        }[];
         profileId: string;
     }>;
     private suppliedReferenceInput;
@@ -244,33 +274,29 @@ export declare class DesignProfiles {
     }>;
     private withReadOnlyRecords;
     listGuidance(expectedAccountId?: string): Promise<{
-        title: string;
         id: string;
+        title: string;
         markdown: string;
         isEnabled: boolean;
-        verifier?: {
-            isStale: boolean;
-        } | undefined;
         attachments?: {
-            path: string;
-            source: string;
             hash: string;
             mimeType: "image/png" | "image/jpeg" | "image/webp" | "image/gif";
             bytes: number;
             representation: "variant" | "image" | "video-cover" | "page";
+            source: string;
             alt: string;
-            title?: string | undefined;
+            path: string;
             page?: number | undefined;
+            title?: string | undefined;
         }[] | undefined;
         references?: ({
-            path: string;
             kind: "directory";
+            path: string;
             intent: string;
         } | {
-            url: string;
             kind: "url" | "repository";
+            url: string;
             intent: string;
-            digest?: string | undefined;
             revision?: string | undefined;
             files?: {
                 name: string;
@@ -278,36 +304,36 @@ export declare class DesignProfiles {
                 path?: string | undefined;
                 sha256?: string | undefined;
             }[] | undefined;
+            digest?: string | undefined;
         })[] | undefined;
+        verifier?: {
+            isStale: boolean;
+        } | undefined;
     }[]>;
     getGuidance(id: string, expectedAccountId?: string): Promise<{
-        title: string;
         id: string;
+        title: string;
         markdown: string;
         isEnabled: boolean;
-        verifier?: {
-            isStale: boolean;
-        } | undefined;
         attachments?: {
-            path: string;
-            source: string;
             hash: string;
             mimeType: "image/png" | "image/jpeg" | "image/webp" | "image/gif";
             bytes: number;
             representation: "variant" | "image" | "video-cover" | "page";
+            source: string;
             alt: string;
-            title?: string | undefined;
+            path: string;
             page?: number | undefined;
+            title?: string | undefined;
         }[] | undefined;
         references?: ({
-            path: string;
             kind: "directory";
+            path: string;
             intent: string;
         } | {
-            url: string;
             kind: "url" | "repository";
+            url: string;
             intent: string;
-            digest?: string | undefined;
             revision?: string | undefined;
             files?: {
                 name: string;
@@ -315,42 +341,42 @@ export declare class DesignProfiles {
                 path?: string | undefined;
                 sha256?: string | undefined;
             }[] | undefined;
+            digest?: string | undefined;
         })[] | undefined;
+        verifier?: {
+            isStale: boolean;
+        } | undefined;
     }>;
     addGuidance(input: GuidanceUpload, expectedAccountId?: string): Promise<{
         guidanceWarning?: {
             code: "large_saved_context";
-            message: string;
             documentCount: number;
             byteCount: number;
+            message: string;
         } | undefined;
-        title: string;
         id: string;
+        title: string;
         markdown: string;
         isEnabled: boolean;
-        verifier?: {
-            isStale: boolean;
-        } | undefined;
         attachments?: {
-            path: string;
-            source: string;
             hash: string;
             mimeType: "image/png" | "image/jpeg" | "image/webp" | "image/gif";
             bytes: number;
             representation: "variant" | "image" | "video-cover" | "page";
+            source: string;
             alt: string;
-            title?: string | undefined;
+            path: string;
             page?: number | undefined;
+            title?: string | undefined;
         }[] | undefined;
         references?: ({
-            path: string;
             kind: "directory";
+            path: string;
             intent: string;
         } | {
-            url: string;
             kind: "url" | "repository";
+            url: string;
             intent: string;
-            digest?: string | undefined;
             revision?: string | undefined;
             files?: {
                 name: string;
@@ -358,44 +384,44 @@ export declare class DesignProfiles {
                 path?: string | undefined;
                 sha256?: string | undefined;
             }[] | undefined;
+            digest?: string | undefined;
         })[] | undefined;
+        verifier?: {
+            isStale: boolean;
+        } | undefined;
     }>;
     updateGuidance(input: GuidanceUploadUpdate & {
         id: string;
     }, expectedAccountId?: string): Promise<{
         guidanceWarning?: {
             code: "large_saved_context";
-            message: string;
             documentCount: number;
             byteCount: number;
+            message: string;
         } | undefined;
-        title: string;
         id: string;
+        title: string;
         markdown: string;
         isEnabled: boolean;
-        verifier?: {
-            isStale: boolean;
-        } | undefined;
         attachments?: {
-            path: string;
-            source: string;
             hash: string;
             mimeType: "image/png" | "image/jpeg" | "image/webp" | "image/gif";
             bytes: number;
             representation: "variant" | "image" | "video-cover" | "page";
+            source: string;
             alt: string;
-            title?: string | undefined;
+            path: string;
             page?: number | undefined;
+            title?: string | undefined;
         }[] | undefined;
         references?: ({
-            path: string;
             kind: "directory";
+            path: string;
             intent: string;
         } | {
-            url: string;
             kind: "url" | "repository";
+            url: string;
             intent: string;
-            digest?: string | undefined;
             revision?: string | undefined;
             files?: {
                 name: string;
@@ -403,42 +429,45 @@ export declare class DesignProfiles {
                 path?: string | undefined;
                 sha256?: string | undefined;
             }[] | undefined;
+            digest?: string | undefined;
         })[] | undefined;
+        verifier?: {
+            isStale: boolean;
+        } | undefined;
     }>;
     removeGuidance(id: string, expectedAccountId?: string): Promise<void>;
     private importGuidanceImages;
     resolveGuidance(input: GuidanceSelection, expectedAccountId?: string): Promise<{
         guidanceWarning?: {
             code: "large_saved_context";
-            message: string;
             documentCount: number;
             byteCount: number;
+            message: string;
         } | undefined;
         accountId: string;
         guidance: {
-            title: string;
             id: string;
+            title: string;
             markdown: string;
             attachments?: {
-                path: string;
-                source: string;
                 hash: string;
                 mimeType: "image/png" | "image/jpeg" | "image/webp" | "image/gif";
                 bytes: number;
                 representation: "variant" | "image" | "video-cover" | "page";
+                source: string;
                 alt: string;
-                title?: string | undefined;
+                path: string;
                 page?: number | undefined;
+                title?: string | undefined;
             }[] | undefined;
             references?: ({
-                path: string;
                 kind: "directory";
+                path: string;
                 intent: string;
             } | {
-                url: string;
                 kind: "url" | "repository";
+                url: string;
                 intent: string;
-                digest?: string | undefined;
                 revision?: string | undefined;
                 files?: {
                     name: string;
@@ -446,6 +475,7 @@ export declare class DesignProfiles {
                     path?: string | undefined;
                     sha256?: string | undefined;
                 }[] | undefined;
+                digest?: string | undefined;
             })[] | undefined;
         }[];
     }>;
@@ -459,23 +489,23 @@ export declare class DesignProfiles {
     }): Promise<{
         provider: "pinterest" | "arena" | "cosmos" | "x";
         scopeDisclosure: string;
-        id: string;
-        total: number;
+        profile: {
+            id: string;
+            username: string;
+            title: string;
+            url: string;
+        };
         collections: {
+            id: string;
+            title: string;
             description: string | null;
             url: string | null;
-            title: string;
-            id: string;
-            children: string[];
             total: number | null;
             parentId: string | null;
+            children: string[];
         }[];
-        profile: {
-            url: string;
-            title: string;
-            id: string;
-            username: string;
-        };
+        total: number;
+        id: string;
         createdAt: string;
         status?: undefined;
         authUrl?: undefined;
@@ -491,10 +521,10 @@ export declare class DesignProfiles {
         revision: string;
         discoveryId: string;
         profile: {
-            url: string;
-            title: string;
             id: string;
             username: string;
+            title: string;
+            url: string;
         };
         provider: "pinterest" | "arena" | "cosmos" | "x";
         runtime: "claude" | "codex" | "cursor";
@@ -505,13 +535,13 @@ export declare class DesignProfiles {
         collections: {
             includedCollectionIds: string[];
             referenceCount: number;
+            id: string;
+            title: string;
             description: string | null;
             url: string | null;
-            title: string;
-            id: string;
-            children: string[];
             total: number | null;
             parentId: string | null;
+            children: string[];
         }[];
         collectionCount: number;
         referenceCount: number;
@@ -530,10 +560,10 @@ export declare class DesignProfiles {
         revision: string;
         discoveryId: string;
         profile: {
-            url: string;
-            title: string;
             id: string;
             username: string;
+            title: string;
+            url: string;
         };
         provider: "pinterest" | "arena" | "cosmos" | "x";
         runtime: "claude" | "codex" | "cursor";
@@ -544,13 +574,13 @@ export declare class DesignProfiles {
         collections: {
             includedCollectionIds: string[];
             referenceCount: number;
+            id: string;
+            title: string;
             description: string | null;
             url: string | null;
-            title: string;
-            id: string;
-            children: string[];
             total: number | null;
             parentId: string | null;
+            children: string[];
         }[];
         collectionCount: number;
         referenceCount: number;
@@ -567,7 +597,7 @@ export declare class DesignProfiles {
     referenceOnboarding(action?: ReferenceOnboardingAction, provider?: ReferenceProvider): Promise<{
         providers: {
             provider: "pinterest" | "arena" | "cosmos" | "x";
-            state: "pending" | "complete" | "later" | "dismissed";
+            state: "pending" | "later" | "complete" | "dismissed";
             offeredAt: string | null;
             remindAt: string | null;
         }[];
@@ -591,10 +621,10 @@ export declare class DesignProfiles {
         revision: string;
         discoveryId: string;
         profile: {
-            url: string;
-            title: string;
             id: string;
             username: string;
+            title: string;
+            url: string;
         };
         provider: "pinterest" | "arena" | "cosmos" | "x";
         runtime: "claude" | "codex" | "cursor";
@@ -605,13 +635,13 @@ export declare class DesignProfiles {
         collections: {
             includedCollectionIds: string[];
             referenceCount: number;
+            id: string;
+            title: string;
             description: string | null;
             url: string | null;
-            title: string;
-            id: string;
-            children: string[];
             total: number | null;
             parentId: string | null;
+            children: string[];
         }[];
         collectionCount: number;
         referenceCount: number;
@@ -676,7 +706,7 @@ export declare class DesignProfiles {
         };
         referenceOnboarding: {
             provider: "pinterest" | "arena" | "cosmos" | "x";
-            state: "pending" | "complete" | "later" | "dismissed";
+            state: "pending" | "later" | "complete" | "dismissed";
             offeredAt: string | null;
             remindAt: string | null;
         }[];
@@ -757,7 +787,7 @@ export declare class DesignProfiles {
         };
         referenceOnboarding: {
             provider: "pinterest" | "arena" | "cosmos" | "x";
-            state: "pending" | "complete" | "later" | "dismissed";
+            state: "pending" | "later" | "complete" | "dismissed";
             offeredAt: string | null;
             remindAt: string | null;
         }[];
@@ -817,7 +847,7 @@ export declare class DesignProfiles {
         };
         referenceOnboarding: {
             provider: "pinterest" | "arena" | "cosmos" | "x";
-            state: "pending" | "complete" | "later" | "dismissed";
+            state: "pending" | "later" | "complete" | "dismissed";
             offeredAt: string | null;
             remindAt: string | null;
         }[];
@@ -839,7 +869,32 @@ export declare class DesignProfiles {
             isIncluded: boolean;
             removedAt: string | null;
         };
-        reference: import("../../types/design-profile").ProfileReference;
+        reference: {
+            provider: "variant" | "text" | "pinterest" | "arena" | "cosmos" | "x" | "image" | "pdf";
+            remoteId: string;
+            title: string;
+            text: string;
+            media: {
+                hash: string;
+                mimeType: "image/png" | "image/jpeg" | "image/webp" | "image/gif";
+                bytes: number;
+                representation: "variant" | "image" | "video-cover" | "page";
+                page?: number | undefined;
+            }[];
+            id: string;
+            revision: number;
+            url?: string | undefined;
+            remoteImages?: string[] | undefined;
+            remoteImageRepresentations?: ("image" | "video-cover")[] | undefined;
+            unsupportedReason?: string | undefined;
+            variant?: {
+                projectId: string;
+                sessionId: string;
+                variantId: string;
+                treeSha?: string | undefined;
+            } | undefined;
+            note?: string | undefined;
+        };
     }>;
     addImages({ title, files, runtime, }: {
         title: string;
@@ -967,7 +1022,7 @@ export declare class DesignProfiles {
         };
         referenceOnboarding: {
             provider: "pinterest" | "arena" | "cosmos" | "x";
-            state: "pending" | "complete" | "later" | "dismissed";
+            state: "pending" | "later" | "complete" | "dismissed";
             offeredAt: string | null;
             remindAt: string | null;
         }[];
@@ -1004,11 +1059,11 @@ export declare class DesignProfiles {
     }): Promise<void>;
     references(sourceId?: string): Promise<{
         observation: {
-            description: string;
+            referenceId: string;
             revision: number;
+            description: string;
             runtime: "claude" | "codex" | "cursor" | "user";
             evidence: "observation" | "preference";
-            referenceId: string;
             usage?: {
                 inputTokens?: number | undefined;
                 outputTokens?: number | undefined;
@@ -1016,12 +1071,10 @@ export declare class DesignProfiles {
                 allocation?: "equal-share" | undefined;
             } | undefined;
         } | null;
-        id: string;
-        revision: number;
-        title: string;
-        text: string;
         provider: "variant" | "text" | "pinterest" | "arena" | "cosmos" | "x" | "image" | "pdf";
         remoteId: string;
+        title: string;
+        text: string;
         media: {
             hash: string;
             mimeType: "image/png" | "image/jpeg" | "image/webp" | "image/gif";
@@ -1029,17 +1082,19 @@ export declare class DesignProfiles {
             representation: "variant" | "image" | "video-cover" | "page";
             page?: number | undefined;
         }[];
+        id: string;
+        revision: number;
+        url?: string | undefined;
+        remoteImages?: string[] | undefined;
+        remoteImageRepresentations?: ("image" | "video-cover")[] | undefined;
+        unsupportedReason?: string | undefined;
         variant?: {
             projectId: string;
             sessionId: string;
             variantId: string;
             treeSha?: string | undefined;
         } | undefined;
-        url?: string | undefined;
         note?: string | undefined;
-        remoteImages?: string[] | undefined;
-        remoteImageRepresentations?: ("image" | "video-cover")[] | undefined;
-        unsupportedReason?: string | undefined;
     }[]>;
     library(): Promise<DesignLibrarySnapshot>;
     search(input: DesignReferenceSearchRequest): Promise<DesignReferenceSearchResult>;
@@ -1068,25 +1123,25 @@ export declare class DesignProfiles {
     prepare(input: PreparationInput, accountId?: string | undefined): Promise<{
         profileId: string;
         accountId: string;
-        status: "timeout" | "off" | "selected" | "empty" | "unavailable";
         requestId: string;
+        status: "timeout" | "off" | "selected" | "empty" | "unavailable";
+        queries: string[];
+        candidateIds: string[];
         selected: {
-            reason: string;
-            revision: number;
             id: string;
+            revision: number;
+            reason: string;
             sourceTitles: string[];
+            title?: string | undefined;
+            url?: string | undefined;
+            mediaHashes?: string[] | undefined;
             variant?: {
                 projectId: string;
                 sessionId: string;
                 variantId: string;
                 treeSha?: string | undefined;
             } | undefined;
-            url?: string | undefined;
-            title?: string | undefined;
-            mediaHashes?: string[] | undefined;
         }[];
-        queries: string[];
-        candidateIds: string[];
         contextText: string;
         images: {
             path: string;
@@ -1094,12 +1149,6 @@ export declare class DesignProfiles {
             mimeType: "image/png" | "image/jpeg" | "image/webp" | "image/gif";
         }[];
         durationMs: number;
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-            allocation?: "equal-share" | undefined;
-        } | undefined;
         suppliedReferences?: {
             title: string;
             id: string;
@@ -1111,6 +1160,12 @@ export declare class DesignProfiles {
             } | undefined;
         }[] | undefined;
         failedUploadCount?: number | undefined;
+        usage?: {
+            inputTokens?: number | undefined;
+            outputTokens?: number | undefined;
+            cachedInputTokens?: number | undefined;
+            allocation?: "equal-share" | undefined;
+        } | undefined;
     }>;
     private saveSuppliedImages;
     close(): Promise<void>;