Skip to content

Image Pipeline Playground

feat(shared/types): add asset batch and saved-event schemas

Mohammad Rajaei1de027ccd56c
diff --git a/backend/app/models/assets.py b/backend/app/models/assets.py
new file mode 100644
index 0000000..ac345b8
--- /dev/null
+++ b/backend/app/models/assets.py
@@ -0,0 +1,43 @@
+"""Schemas for registered image assets (desktop paths or staged uploads)."""
+
+from __future__ import annotations
+
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+AssetKind = Literal["external", "staged", "folder"]
+
+
+class AssetFile(BaseModel):
+ """One image in a batch. `path` is absolute on the local machine."""
+
+ name: str
+ path: str
+
+
+class AssetBatch(BaseModel):
+ id: str
+ kind: AssetKind
+ files: list[AssetFile] = Field(default_factory=list)
+ """Directory root when kind is folder, else parent of the first file."""
+ root: str | None = None
+
+
+class RegisterAssetsRequest(BaseModel):
+ """Register local filesystem paths without copying (desktop pickers)."""
+
+ paths: list[str] = Field(default_factory=list)
+ as_folder: bool = False
+ append_to: str | None = None
+
+
+class RegisterAssetsResponse(BaseModel):
+ batch: AssetBatch
+ count: int
+
+
+class AssetPreviewInfo(BaseModel):
+ batch_id: str
+ name: str
+ preview_url: str
diff --git a/backend/app/models/graph.py b/backend/app/models/graph.py
index 9ae9da8..2e8066b 100644
--- a/backend/app/models/graph.py
+++ b/backend/app/models/graph.py
@@ -60,6 +60,7 @@ class ExecutionEventType(StrEnum):
DONE = "done"
CANCELLED = "cancelled"
DOWNLOAD = "download"
+ SAVED = "saved"
class ExecutionEvent(BaseModel):
@@ -77,6 +78,7 @@ class ExecutionEvent(BaseModel):
data: dict[str, Any] | None = None
download_url: str | None = None
download_filename: str | None = None
+ saved_dir: str | None = None
class ParamField(BaseModel):
diff --git a/frontend/src/types/assets.ts b/frontend/src/types/assets.ts
new file mode 100644
index 0000000..992b9aa
--- /dev/null
+++ b/frontend/src/types/assets.ts
@@ -0,0 +1,53 @@
+export type AssetKind = 'external' | 'staged' | 'folder'
+
+export interface AssetFile {
+ name: string
+ path: string
+}
+
+export interface AssetBatch {
+ id: string
+ kind: AssetKind
+ files: AssetFile[]
+ root?: string | null
+}
+
+export interface RegisterAssetsResponse {
+ batch: AssetBatch
+ count: number
+}
+
+export interface UploadResponse {
+ path: string
+ kind: string
+ files: string[]
+ count: number
+ asset_batch_id: string
+}
+
+export interface DesktopOpenResult {
+ canceled: boolean
+ paths: string[]
+}
+
+export interface DesktopFolderResult {
+ canceled: boolean
+ path: string | null
+}
+
+export interface ImagePipesDesktop {
+ isDesktop: true
+ platform: string
+ openImages: () => Promise<DesktopOpenResult>
+ openFolder: () => Promise<DesktopFolderResult>
+ pickFolder: () => Promise<DesktopFolderResult>
+ revealInFolder: (targetPath: string) => Promise<void>
+}
+
+declare global {
+ interface Window {
+ imagePipesDesktop?: ImagePipesDesktop
+ }
+}
+
+export {}
diff --git a/frontend/src/types/graph.ts b/frontend/src/types/graph.ts
index b5a46ec..fdc3353 100644
--- a/frontend/src/types/graph.ts
+++ b/frontend/src/types/graph.ts
@@ -41,7 +41,7 @@ export interface GraphNodeData {
active?: boolean
/** Local previews for Load Images before execution */
localPreviewUrls?: string[]
- /** Server paths for each local preview (same order as localPreviewUrls) */
+ /** Absolute paths for each local preview (same order as localPreviewUrls) */
uploadedFiles?: string[]
[key: string]: unknown
}
@@ -67,6 +67,7 @@ export type ExecutionEventType =
| 'done'
| 'cancelled'
| 'download'
+ | 'saved'
export interface ExecutionEvent {
type: ExecutionEventType
@@ -83,4 +84,5 @@ export interface ExecutionEvent {
data?: Record<string, unknown> | null
download_url?: string | null
download_filename?: string | null
+ saved_dir?: string | null
}
diff --git a/frontend/src/types/index.ts b/frontend/src/types/index.ts
index 55ba9da..f376996 100644
--- a/frontend/src/types/index.ts
+++ b/frontend/src/types/index.ts
@@ -8,3 +8,13 @@ export type {
PortDirection,
PortSpec,
} from './graph'
+export type {
+ AssetBatch,
+ AssetFile,
+ AssetKind,
+ DesktopFolderResult,
+ DesktopOpenResult,
+ ImagePipesDesktop,
+ RegisterAssetsResponse,
+ UploadResponse,
+} from './assets'